Chi-Tech
lua_functions.c
Go to the documentation of this file.
1namespace chi_lua
2{
3//framework/physics/SolverBase/lua/physics_solver_lua_utils.cc
4/**Generic lua routine for the creation of solvers.
5 * \param params ParameterBlock. A single block with at least one field
6 * \"type\", which contains a registered solver type.
7 * ## _
8 *
9 * Example:
10\code
11chiSolverCreate({type=cfem_diffusion.Solver})
12\endcode
13
14\ingroup doc_PhysicsSolver
15\deprecated This function is deprecated and will be removed soon.
16*/
17void chiSolverCreate(ParameterBloc params){}
18/** Initializes the solver at the given handle.
19
20\param solver_handle int Handle to the solver.
21
22\ingroup doc_PhysicsSolver
23### Usage Examples:
24\ref test_framework_tutorials_tutorial_93_raytracing_lua
25\ref test_framework_post_processors_solver_info_01_lua
26\ref test_framework_post_processors_solver_info_02_lua
27\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
28\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
29\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
30\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
31\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
32\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
33\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
34\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
35\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
36\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
37\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
38\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
39\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
40\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
41\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
42\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
43\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
44\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
45\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
46\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
47\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
48\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
49\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
50\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
51\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
52\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
53\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
54\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
55\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
56\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
57\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
58\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
59\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
60\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
61\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
62\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
63\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
64\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
65\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
66\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
67\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
68\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
69\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
70\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
71\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
72\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
73\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
74\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
75\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
76\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
77\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
78\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
79\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
80\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
81\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
82\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
83\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
84\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
85\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
86\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
87\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
88\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
89\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
90\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
91\author Jan*/
92void chiSolverInitialize(int solver_handle){}
93/** Executes the solver at the given handle.
94
95\param solver_handle int Handle to the solver.
96
97\ingroup doc_PhysicsSolver
98### Usage Examples:
99\ref test_framework_tutorials_tutorial_93_raytracing_lua
100\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
101\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
102\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
103\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
104\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
105\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
106\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
107\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
108\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
109\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
110\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
111\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
112\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
113\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
114\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
115\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
116\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
117\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
118\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
119\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
120\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
121\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
122\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
123\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
124\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
125\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
126\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
127\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
128\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
129\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
130\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
131\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
132\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
133\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
134\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
135\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
136\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
137\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
138\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
139\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
140\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
141\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
142\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
143\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
144\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
145\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
146\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
147\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
148\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
149\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
150\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
151\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
152\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
153\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
154\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
155\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
156\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
157\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
158\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
159\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
160\author Jan*/
161void chiSolverExecute(int solver_handle){}
162/** Performs a single timestep for the solver at the given handle.
163
164\param solver_handle int Handle to the solver.
165
166\ingroup doc_PhysicsSolver
167### Usage Examples:
168\ref test_framework_post_processors_solver_info_01_lua
169\ref test_framework_post_processors_solver_info_02_lua
170\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
171\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
172\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
173\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
174\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
175\author Jan*/
176void chiSolverStep(int solver_handle){}
177/** Advances the time values of the solver at the given handle.
178
179\param solver_handle int Handle to the solver.
180
181\ingroup doc_PhysicsSolver
182### Usage Examples:
183\ref test_framework_post_processors_solver_info_01_lua
184\ref test_framework_post_processors_solver_info_02_lua
185\author Jan*/
186void chiSolverAdvance(int solver_handle){}
187/** Sets a basic option of a solver.
188
189\param solver_handle int Handle to the reference solver.
190\param option_name string String-name of the option.
191\param option_value varying The value to assign to the option.
192
193\ingroup doc_PhysicsSolver
194\deprecated This function is deprecated and will be removed soon.
195### Usage Examples:
196\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
197\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
198\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
199\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
200\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
201\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
202\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
203\ref test_modules_Diffusion_Diffusion1D_IP_lua
204\ref test_modules_Diffusion_Diffusion1D_lua
205\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
206\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
207\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
208\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
209\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
210\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
211\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
212\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
213\ref test_modules_Diffusion_Diffusion1D_KBA_lua
214\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
215\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
216\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
217\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
218\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
219\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
220\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
221\author Jan*/
222void chiSolverSetBasicOption(int solver_handle, string option_name, varying option_value){}
223/** Returns the text name of the solver.
224
225\param solver_handle int Handle to the solver.
226
227\ingroup doc_PhysicsSolver
228### Usage Examples:
229\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
230\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
231\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
232\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
233\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
234\author Jan*/
235void chiSolverGetName(int solver_handle){}
236/**Obtains a named list of the field functions associated with a solver.
237
238\param SolverHandle int A handle to the reference solver.
239
240### Usage Examples:
241\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
242\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
243\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
244\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
245\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
246\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
247\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
248\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
249\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
250\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
251\ref test_modules_Diffusion_Diffusion1D_IP_lua
252\ref test_modules_Diffusion_Diffusion1D_lua
253\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
254\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
255\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
256\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
257\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
258\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
259\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
260\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
261\ref test_modules_Diffusion_Diffusion1D_KBA_lua
262\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
263\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
264\ingroup doc_PhysicsSolver */
265void chiSolverGetFieldFunctionList(int SolverHandle){}
266/** Returns arbitrary info specific for each solver.
267
268\param solver_handle int Handle to the solver.
269\param info varying A single string or a table of values to call the solver
270with.
271
272\ingroup doc_PhysicsSolver
273### Usage Examples:
274\ref test_framework_post_processors_solver_info_01_lua
275\ref test_framework_post_processors_solver_info_02_lua
276\author Jan*/
277void chiSolverGetInfo(int solver_handle, varying info){}
278/**Sets a property of a solver.
279\param handle int Solver handle.
280\param property_table Table Table of properties to set. See solver specific
281documentation.
282*
283\ingroup doc_PhysicsSolver*/
284void chiSolverSetProperties(int handle, Table property_table){}
285//framework/physics/lua/physics_addmaterial.cc
286/** Adds a material to the problem. Materials are added to the global
287 * physics handler and is therefore accessible across all meshes and solvers.
288 *
289\param Name char (Optional) Material name.
290
291\return MaterialHandle int Handle to the created material.
292
293
294##_
295
296### Example\n
297Example lua code:
298\code
299materials = {}
300materials[1] = chiPhysicsAddMaterial("Test Material");
301\endcode
302
303
304\ingroup LuaPhysicsMaterials
305### Usage Examples:
306\ref test_framework_tutorials_tutorial_93_raytracing_lua
307\ref test_modules_Diffusion_Diffusion1D_IP_lua
308\ref test_modules_Diffusion_Diffusion1D_lua
309\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
310\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
311\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
312\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
313\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
314\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
315\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
316\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
317\ref test_modules_Diffusion_Diffusion1D_KBA_lua
318\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
319\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
320\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
321\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
322\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
323\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
324\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
325\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
326\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
327\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
328\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
329\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
330\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
331\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
332\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
333\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
334\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
335\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
336\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
337\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
338\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
339\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
340\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
341\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
342\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
343\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
344\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
345\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
346\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
347\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
348\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
349\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
350\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
351\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
352\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
353\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
354\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
355\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
356\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
357\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
358\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
359\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
360\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
361\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
362\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
363\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
364\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
365\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
366\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
367\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
368\author Jan*/
369MaterialHandle chiPhysicsAddMaterial(char Name){}
370//framework/physics/lua/physics_materialproperties.cc
371/** Adds a material property to a material.
372 *
373\param MaterialHandle int Index to the reference material.
374\param PropertyIndex int Property index.
375
376##_
377
378###PropertyIndex\n
379
380SCALAR_VALUE\n
381 Simple scalar value property.\n\n
382
383TRANSPORT_XSECTIONS\n
384 Multi-group transport cross-section supporting numerous features.\n\n
385
386ISOTROPIC_MG_SOURCE\n
387 Isotropic Multigroup Source.\n\n
388
389### Developer Info
390Checklist for adding a new material property:
391 - Create your property class in its own header file. i.e.
392 "physics/PhysicsMaterial/property_xx_myproperty.h"
393 - Add the property to the physics namespace
394 ("physics/chi_physics_namespace.h"). Make sure to derive from the base
395 class.
396 - Go define the integer to be associated with your new property in
397 chi_physicsmaterial.h
398 - Include the header file for your property in this file (i.e. at the top).
399 - Add this property integer in the lua register (ChiLua/chi_lua_register.h).
400 For testing you can just use the integer value but eventually you'd want
401 to supply an easier way for users to enter it.
402 - Add another else-if for your property. Just have a look at how the others
403 were done, it should be intuitive enough.
404
405##_
406
407### Example\n
408Example lua code:
409\code
410chiPhysicsMaterialAddProperty(materials[i],TRANSPORT_XSECTIONS)
411\endcode
412
413\ingroup LuaPhysicsMaterials
414### Usage Examples:
415\ref test_framework_tutorials_tutorial_93_raytracing_lua
416\ref test_modules_Diffusion_Diffusion1D_IP_lua
417\ref test_modules_Diffusion_Diffusion1D_lua
418\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
419\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
420\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
421\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
422\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
423\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
424\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
425\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
426\ref test_modules_Diffusion_Diffusion1D_KBA_lua
427\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
428\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
429\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
430\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
431\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
432\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
433\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
434\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
435\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
436\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
437\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
438\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
439\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
440\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
441\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
442\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
443\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
444\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
445\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
446\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
447\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
448\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
449\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
450\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
451\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
452\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
453\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
454\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
455\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
456\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
457\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
458\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
459\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
460\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
461\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
462\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
463\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
464\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
465\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
466\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
467\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
468\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
469\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
470\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
471\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
472\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
473\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
474\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
475\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
476\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
477\author Jan*/
478void chiPhysicsMaterialAddProperty(int MaterialHandle, int PropertyIndex){}
479/** Sets a material property for a given material.
480 *
481\param MaterialHandle int Index to the reference material.
482\param PropertyIndex int Property index. Or name of property.
483\param OperationIndex int Method used for setting the material property.
484\param Information varying Varying information depending on the operation.
485
486##_
487
488###PropertyIndex\n
489SCALAR_VALUE = Basic Scalar value property.\n
490TRANSPORT_XSECTIONS = Multi-group transport cross-section supporting numerous
491 features.\n
492ISOTROPIC_MG_SOURCE = Isotropic Multigroup Source.\n
493
494###OperationIndex\n
495SINGLE_VALUE\n
496Sets the property based on a single value. Requires a single value as additional
497information. As a simple example consider the case where the user would like
498to set a single constant thermal conductivity. This can be achieved with \n
499FROM_ARRAY\n
500Sets a property based on a Lua array indexed from 1 to N. Internally
501will be converted to 0 to N-1. This method can be used to set mutligroup
502cross-sections or sources.
503\n
504SIMPLEXS0\n
505Makes a simple material with no transfer matrix just \f$\sigma_t \f$. Expects two
506values: \n
507 - int number of groups \f$G \f$,
508 - float \f$\sigma_t \f$.
509
510####_
511
512SIMPLEXS1\n
513Makes a simple material with isotropic transfer matrix (L=0)
514and mostly down scattering but with a few of the last groups
515subject to up-scattering. Expects three values
516values: \n
517 - int number of groups (\f$G \f$),
518 - float \f$\sigma_t \f$,
519 - float scattering to total ratio (\f$c \f$)
520
521####_
522
523CHI_XSFILE\n
524Loads transport cross-sections from CHI type cross-section files. Expects
525to be followed by a filepath specifying the xs-file.
526
527####_
528
529EXISTING\n
530Supply handle to an existing cross-section and simply swap them out.
531
532\code
533chiPhysicsMaterialSetProperty(materials[1],
534 TRANSPORT_XSECTIONS,
535 CHI_XSFILE,
536 "xs_3_170.cxs",
537 "2518")
538\endcode
539
540##_
541
542### Example 1
543Simple temperature independent thermal conductivity:
544\code
545materials = {}
546materials[1] = chiPhysicsAddMaterial("Test Material");
547chiPhysicsMaterialAddProperty(materials[0],THERMAL_CONDUCTIVITY)
548chiPhysicsMaterialSetProperty(materials[0],THERMAL_CONDUCTIVITY,SINGLE_VALUE,13.7)
549\endcode
550
551where the thermal conductivity has been set to 13.7.\n
552
553### Example 2
554Isotropic Multigroup source set from a lua table/array (12 groups):
555\code
556materials = {}
557materials[1] = chiPhysicsAddMaterial("Test Material");
558
559chiPhysicsMaterialAddProperty(materials[1],ISOTROPIC_MG_SOURCE)
560
561num_groups = 12
562src={}
563for g=1,num_groups do
564 src[g] = 0.0
565end
566chiPhysicsMaterialSetProperty(materials[1],ISOTROPIC_MG_SOURCE,FROM_ARRAY,src)
567\endcode
568
569### Developer Info
570Checklist for adding a new material property:
571 - Make sure you followed the steps depicted in the developer info section for
572 the ChiLua::chiPhysicsMaterialAddProperty function.
573 - Now under the "If user supplied name then find property index"-section
574 add the appropriate code for setting the property index.
575 - Add an else-if block for your property similar to the others. It should be
576 intuitive if you look at the others.
577 - Remember to add the filtering section if you need to support multiple type
578 properties.
579
580\ingroup LuaPhysicsMaterials
581### Usage Examples:
582\ref test_framework_tutorials_tutorial_93_raytracing_lua
583\ref test_modules_Diffusion_Diffusion1D_IP_lua
584\ref test_modules_Diffusion_Diffusion1D_lua
585\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
586\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
587\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
588\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
589\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
590\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
591\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
592\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
593\ref test_modules_Diffusion_Diffusion1D_KBA_lua
594\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
595\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
596\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
597\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
598\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
599\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
600\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
601\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
602\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
603\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
604\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
605\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
606\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
607\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
608\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
609\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
610\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
611\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
612\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
613\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
614\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
615\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
616\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
617\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
618\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
619\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
620\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
621\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
622\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
623\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
624\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
625\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
626\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
627\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
628\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
629\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
630\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
631\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
632\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
633\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
634\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
635\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
636\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
637\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
638\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
639\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
640\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
641\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
642\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
643\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
644\author Jan*/
645void chiPhysicsMaterialSetProperty(int MaterialHandle, int PropertyIndex, int OperationIndex, varying Information){}
646/** Returns a rich lua data-structure of the required property.
647 *
648\param MaterialHandle int Index to the reference material.
649\param PropertyIndex int Property index. Or name of property.
650
651
652\ingroup LuaPhysicsMaterials
653\return Lua table of the desired property.
654
655### Usage Examples:
656\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
657*/
658Lua chiPhysicsMaterialGetProperty(int MaterialHandle, int PropertyIndex){}
659//framework/physics/FieldFunction/lua/physics_getfieldfunclist.cc
660/**Gets a field-function handle by name.
661\param FFname string Name of the field function.
662
663\return handle If the field-function was found and a handle identified the valid
664 handle will be returned (i.e., a natural number >= 0). If the
665 field-function by the given name was not found then the function
666 will return null.
667
668\ingroup LuaFieldFunc
669### Usage Examples:
670\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
671\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
672\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
673\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
674\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
675\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
676\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
677\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
678\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
679 */
680handle chiGetFieldFunctionHandleByName(string FFname){}
681//framework/physics/FieldFunction/lua/physics_exportfieldfunc.cc
682/** Exports a field function to VTK format.
683 *
684\param FFHandle int Global handle to the field function.
685\param BaseName char Base name for the exported file.
686
687\ingroup LuaFieldFunc
688### Usage Examples:
689\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
690\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
691\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
692\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
693\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
694\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
695\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
696\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
697\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
698\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
699\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
700\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
701\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
702\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
703\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
704\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
705\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
706\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
707\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
708\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
709\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
710\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
711\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
712\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
713\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
714\author Jan*/
715void chiExportFieldFunctionToVTK(int FFHandle, char BaseName){}
716/** Exports all the field functions in a list to VTK format.
717 * *
718\param listFFHandles table Global handles or names to the field functions
719\param BaseName char Base name for the exported file.
720
721\ingroup LuaFieldFunc
722### Usage Examples:
723\ref test_framework_tutorials_tutorial_93_raytracing_lua
724\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
725\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
726\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
727\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
728\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
729\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
730\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
731\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
732\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
733\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
734\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
735\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
736\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
737\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
738\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
739\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
740\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
741\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
742\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
743\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
744\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
745\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
746\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
747\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
748\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
749\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
750\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
751\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
752\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
753\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
754\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
755\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
756\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
757\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
758\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
759\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
760\author Jan*/
761void chiExportMultiFieldFunctionToVTK(table listFFHandles, char BaseName){}
762//framework/physics/PhysicsMaterial/MultiGroupXS/lua/multigroup_xs_lua_utils.cc
763/**Creates a stand-alone transport cross section.
764 *
765 *
766
767
768\code
769xs_graphite_clean = chiPhysicsTransportXSCreate()
770chiPhysicsTransportXSSet(xs_grph_clean,
771 CHI_XSFILE,
772 "test/xs_graphite_pure.cxs")
773
774chiPhysicsMaterialSetProperty(materials[2],
775 TRANSPORT_XSECTIONS,
776 EXISTING,
777 xs_graphite_clean)
778\endcode
779 * \return Returns a handle to the cross section.
780 *
781\ingroup LuaTransportXSs
782### Usage Examples:
783\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
784\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
785\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
786\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
787\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
788\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
789\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
790\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
791 */
793/**Sets the properties of a transport cross section.
794
795 \param XS_handle int Handle to the cross section to be modified.
796 \param OperationIndex int Method used for setting the xs property.
797 \param Information varying Varying information depending on the operation.
798
799 ##_
800
801###OperationIndex
802SINGLE_VALUE\n
803Sets the property based on a single value. Requires a single value as additional
804information. As a simple example consider the case where the user would like
805to set a single constant thermal conductivity. This can be achieved with \n
806FROM_ARRAY\n
807Sets a property based on a Lua array indexed from 1 to N. Internally
808will be converted to 0 to N-1. This method can be used to set mutli-group
809cross sections or sources.
810\n
811SIMPLEXS0\n
812Makes a simple material with no transfer matrix just \f$\sigma_t \f$. Expects two
813values: \n
814 - int number of groups \f$G \f$,
815 - float \f$\sigma_t \f$.
816
817####_
818
819SIMPLEXS1\n
820Makes a simple material with isotropic transfer matrix (L=0)
821and mostly down scattering but with a few of the last groups
822subject to up-scattering. Expects three values
823values: \n
824 - int number of groups (\f$G \f$),
825 - float \f$\sigma_t \f$,
826 - float scattering to total ratio (\f$c \f$)
827
828####_
829
830CHI_XSFILE\n
831Loads transport cross sections from CHI type cross section files. Expects
832to be followed by a filepath specifying the xs-file.
833
834
835##_
836### Example
837Example lua code:
838\code
839graphite = chiPhysicsTransportXSCreate()
840chiPhysicsTransportXSSet(graphite,"xs_3_170.data","2518")
841\endcode
842 *
843 *
844\ingroup LuaTransportXSs
845### Usage Examples:
846\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
847\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
848\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
849\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
850\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
851\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
852\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
853\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
854*/
855void chiPhysicsTransportXSSet(int XS_handle, int OperationIndex, varying Information){}
856/**Obtains a lua table of all the cross section values.
857
858 \param XS_handle int Handle to the cross section to be modified.
859
860 ## _
861
862 To print the contents of the table, execute the following:
863\code
864xs = chiPhysicsTransportXSGet(xs_handle)
865for i,v in pairs(xs) do
866 print(i,v)
867end
868\endcode
869### Usage Examples:
870\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_materials_lua
871\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_materials_lua
872\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
873\ingroup LuaTransportXSs*/
874void chiPhysicsTransportXSGet(int XS_handle){}
875/**Makes a combined cross section from multiple other cross sections.
876
877 \param Combinations table A lua-table with each element another table
878 containing a handle to an existing xs and a
879 scalar multiplier.
880
881 ## _
882
883###Example:
884Example lua code:
885\code
886xs_1 = chiPhysicsTransportXSCreate()
887xs_2 = chiPhysicsTransportXSCreate()
888xs_3 = chiPhysicsTransportXSCreate()
889
890chiPhysicsTransportXSSet(xs_1,CHI_XSFILE,"test/xs_graphite_pure.cxs")
891chiPhysicsTransportXSSet(xs_2,CHI_XSFILE,"test/xs_3_170.cxs")
892chiPhysicsTransportXSSet(xs_3,CHI_XSFILE,"test/xs_air50RH.cxs")
893
894combo ={{xs_1, 0.5e5},
895 {xs_2, 0.4e3},
896 {xs_3, 0.3e2}}
897aerated_graphite = chiPhysicsTransportXSMakeCombined(combo)
898
899chiPhysicsMaterialSetProperty(materials[1],
900 TRANSPORT_XSECTIONS,
901 EXISTING,
902 aerated_graphite)
903\endcode
904
905 \return Returns a handle to another cross section object that contains the
906 desired combination.
907
908\ingroup LuaTransportXSs
909### Usage Examples:
910\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
911\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
912\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
913 */
914Returns chiPhysicsTransportXSMakeCombined(table Combinations){}
915/**Sets a combined cross section from multiple other cross sections. This
916 function can be called multiple times on the same cross section handle.
917
918 \param XS_handle int Handle to the cross section to be modified.
919 \param Combinations table A lua-table with each element another table
920 containing a handle to an existing xs and a
921 scalar multiplier.
922
923 ## _
924
925###Example:
926Example lua code:
927\code
928xs_1 = chiPhysicsTransportXSCreate()
929xs_2 = chiPhysicsTransportXSCreate()
930xs_3 = chiPhysicsTransportXSCreate()
931
932chiPhysicsTransportXSSet(xs_1,CHI_XSFILE,"test/xs_graphite_pure.cxs")
933chiPhysicsTransportXSSet(xs_2,CHI_XSFILE,"test/xs_3_170.cxs")
934chiPhysicsTransportXSSet(xs_3,CHI_XSFILE,"test/xs_air50RH.cxs")
935
936combo ={{xs_1, 0.5e5},
937 {xs_2, 0.4e3},
938 {xs_3, 0.3e2}}
939aerated_graphite = chiPhysicsTransportXSMakeCombined(combo)
940
941chiPhysicsTransportXSSetCombined(aerated_graphite,combo)
942\endcode
943 *
944\ingroup LuaTransportXSs
945 * */
946void chiPhysicsTransportXSSetCombined(int XS_handle, table Combinations){}
947/** Exports a cross section to ChiTech format.
948 *
949\param XS_handle int Handle to the cross section to be exported.
950\param file_name string The name of the file to which the XS is to be exported.
951
952\ingroup LuaTransportXSs
953 */
954void chiPhysicsTransportXSExportToChiTechFormat(int XS_handle, string file_name){}
955//framework/physics/FieldOperations/lua/field_ops_lua.cc
956/**Executes a field function operation.
957 * \param handle int Handle to the field function operation object.*/
958void chiFieldOperationExecute(int handle){}
959//framework/mesh/SurfaceMesh/lua/surfacemesh_create.cc
960/** \defgroup LuaSurfaceMesh Surface Meshes
961 * \ingroup LuaMesh
962*/
963/** Creates a new empty surface mesh.
964
965### Example
966Example usage:
967\code
968surfmesh = chiSurfaceMeshCreate()
969\endcode
970
971\return Handle int Handle to the created surface mesh.
972\ingroup LuaSurfaceMesh
973\author Jan*/
975//framework/mesh/SurfaceMesh/lua/surfacemesh_export.cc
976/** Exports mesh as a .obj format.
977 *
978\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
979\param FileName char* Path to the file to be exported.
980
981\ingroup LuaSurfaceMesh
982\author Jan*/
983void chiSurfaceMeshExportToObj(int SurfaceHandle, char* FileName){}
984/** Exports mesh as a .poly format.
985 *
986\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
987\param FileName char* Path and basename to the file to be exported.
988
989\ingroup LuaSurfaceMesh
990\author Jan*/
991void chiSurfaceMeshExportPolyFile(int SurfaceHandle, char* FileName){}
992//framework/mesh/SurfaceMesh/lua/surfacemesh_extractopenedges.cc
993/** Exports all open edges of a surface mesh to file. This is used mostly
994 * for graphical error checking.
995 *
996\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
997\param FileName char Filename to which the edges are to be exported.
998
999\ingroup LuaSurfaceMesh
1000\author Jan*/
1001void chiSurfaceMeshExtractOpenEdgesToObj(int SurfaceHandle, char FileName){}
1002//framework/mesh/SurfaceMesh/lua/surfacemesh_load.cc
1003/** Loads mesh data from a wavefront object.
1004 *
1005\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
1006\param FileName string Path to the file to be imported.
1007\param polyflag bool (Optional)Flag indicating whether triangles
1008 are to be read as polygons. [Default: true (read
1009 as polygons)].
1010\param transform table3 (Optional) Translation vector to move all the vertices.
1011 [Default: none].
1012
1013### Note:
1014If the intent of a surface mesh is to serve as a 3D logical volume then
1015the `polyFlag` parameter should be set to false.
1016
1017### Example
1018Example usage:
1019\code
1020-- Basic example
1021surfmesh1 = chiSurfaceMeshCreate()
1022chiSurfaceMeshImportFromOBJFile(surfmesh1, "MeshFile1.obj")
1023
1024-- Surface mesh used as Logical volume
1025lv_surfmesh1 = chiSurfaceMeshCreate()
1026chiSurfaceMeshImportFromOBJFile(lv_surfmesh1, "MeshFile3D.obj", false)
1027
1028lv1 = chiLogicalVolumeCreate(SURFACE, lv_surfmesh1)
1029
1030-- Surface mesh with transform
1031dx = 1.5
1032dy = -2.5
1033lv_surfmesh2 = chiSurfaceMeshCreate()
1034chiSurfaceMeshImportFromOBJFile(lv_surfmesh2, "MeshFile3D.obj", false, {dx,dy,0.0})
1035
1036lv2 = chiLogicalVolumeCreate(SURFACE, lv_surfmesh2)
1037\endcode
1038
1039\return success bool Return true if file was successfully loaded and false
1040 otherwise.
1041\ingroup LuaSurfaceMesh
1042\author Jan*/
1043success chiSurfaceMeshImportFromOBJFile(int SurfaceHandle, string FileName, bool polyflag, table3 transform){}
1044/** Loads mesh data from a wavefront object.
1045 *
1046\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
1047\param FileName char* Path to the file to be imported.
1048\param polyflag bool (Optional)Flag indicating whether triangles
1049 are to be read as polygons. [Default: true)
1050
1051\return success bool Return true if file was successfully loaded and false
1052 otherwise.
1053\ingroup LuaSurfaceMesh
1054\author Jan*/
1055success chiSurfaceMeshImportFromTriangleFiles(int SurfaceHandle, char* FileName, bool polyflag){}
1057//framework/mesh/SurfaceMesh/lua/surfacemesh_checkcyles.cc
1058/** Builds sweep ordering for a number of angles and checks whether any
1059 * cyclic dependencies are encountered.
1060 *
1061\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
1062\param NumAngles int Number of azimuthal angles to use for checking cycles.
1063
1064\ingroup LuaSurfaceMesh
1065\author Jan*/
1066void chiSurfaceMeshCheckCycles(int SurfaceHandle, int NumAngles){}
1067/** Computes load balancing parameters for given predictive x and y cuts
1068 * without actually performing cuts.
1069 *
1070\param SurfaceHandle int Handle to the surface on which the operation is to be performed.
1071\param Xcuts table Array of x-values associated with the xcuts.
1072\param Ycuts table Array of y-values associated with the ycuts.
1073
1074\ingroup LuaSurfaceMesh
1075\author Jan*/
1076void chiComputeLoadBalancing(int SurfaceHandle, table Xcuts, table Ycuts){}
1077//framework/mesh/MeshHandler/lua/meshhandler_exportmesh.cc
1078/**Exports the mesh to a wavefront.obj format.
1079\param FileName char Base name of the file to be used.
1080\param ExportByMaterial bool Default: False. Flag indicating whether to export
1081 the extruder's surface mesh by material.
1082\ingroup LuaMeshHandler
1083*/
1084void chiMeshHandlerExportMeshToObj(char FileName, bool ExportByMaterial){}
1085/**Exports the mesh to vtu format.
1086\param FileName char Base name of the file to be used.
1087\ingroup LuaMeshHandler
1088### Usage Examples:
1089\ref test_framework_chi_mesh_ReadWavefrontObj1_lua
1090\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleA_lua
1091\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleD_lua
1092\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleB_lua
1093\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleC_lua
1094\ref test_framework_chi_mesh_MeshGenerators_meshgen_extruder_KBA_lua
1095\ref test_framework_chi_mesh_LogicalVolume_lv_rcc_test1_lua
1096\ref test_framework_chi_mesh_LogicalVolume_lv_boolean_test1_lua
1097\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
1098\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
1099\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
1100\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
1101\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
1102\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
1103*/
1105/**Exports the mesh to exodus format (.e extensions).
1106\param FileName char Base name of the file to be used.
1107\param suppress_nodesets bool Optional. Flag to suppress exporting nodesets.
1108 Default = `false`.
1109\param suppress_sidesets bool Optional. Flag to suppress exporting sidesets.
1110 Default = `false`.
1111\ingroup LuaMeshHandler
1112*/
1113void chiMeshHandlerExportMeshToExodus(char FileName, bool suppress_nodesets, bool suppress_sidesets){}
1114//framework/mesh/MeshHandler/lua/meshhandler_lua.cc
1115/** Creates a mesh handler and sets it as "current".
1116
1117\return Handle int Handle to the created mesh handler.
1118\ingroup LuaMeshHandler
1119\author Jan*/
1121/** Sets the given mesh handler as "current".
1122
1123\param HandlerHandler int Handle to the mesh handler previously created
1124 with a call to chiMeshHandlerCreate.
1125
1126\ingroup LuaMeshHandler
1127\author Jan*/
1128void chiMeshHandlerSetCurrent(int HandlerHandler){}
1129//framework/mesh/FieldFunctionInterpolation/lua/ffinterpol_getvalue.cc
1130/** Gets the value(s) associated with an interpolation provided the
1131 * interpolation type has an associated value.
1132 *
1133\param FFIHandle int Handle to the field function interpolation.
1134
1135###Note:
1136Currently only the POINT, LINE and VOLUME interpolation supports obtaining a
1137value. For the POINT and VOLUME types a single value is returned. For the LINE
1138type a table of tables is returned with the first index being the field function
1139(in the order it was assigned) and the second index being the point index.
1140
1141\ingroup LuaFFInterpol
1142### Usage Examples:
1143\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1144\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1145\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1146\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1147\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1148\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1149\ref test_modules_Diffusion_Diffusion1D_IP_lua
1150\ref test_modules_Diffusion_Diffusion1D_lua
1151\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1152\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1153\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1154\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1155\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1156\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1157\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1158\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1159\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1160\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1161\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1162\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1163\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1164\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1165\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1166\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1167\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1168\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1169\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1170\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1171\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1172\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1173\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1174\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1175\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1176\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1177\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1178\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1179\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1180\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1181\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1182\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1183\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1184\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1185\author Jan*/
1186void chiFFInterpolationGetValue(int FFIHandle){}
1187//framework/mesh/FieldFunctionInterpolation/lua/ffinterpol_create.cc
1188/** Creates a new field function interpolation.
1189 *
1190\param FFITypeIndex int Type of field function interpolation.
1191
1192##_
1193
1194###FFITypeIndex\n
1195POINT = A point probe. \n
1196SLICE = Two dimensional slice of the mesh. \n
1197LINE = Line defined by two points.\n
1198VOLUME = Volume either referring to the entire volume or that of a
1199 logical volume assigned to the interpolator.\n
1200
1201\return Handle int Handle to the created interpolation.
1202\ingroup LuaFFInterpol
1203### Usage Examples:
1204\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1205\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1206\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1207\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1208\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1209\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1210\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1211\ref test_modules_Diffusion_Diffusion1D_IP_lua
1212\ref test_modules_Diffusion_Diffusion1D_lua
1213\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1214\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1215\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1216\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1217\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1218\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1219\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1220\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1221\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1222\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1223\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1224\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1225\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1226\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1227\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1228\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1229\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1230\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1231\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1232\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1233\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1234\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1235\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1236\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1237\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1238\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1239\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1240\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1241\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1242\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1243\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1244\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1245\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1246\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1247\author Jan*/
1248Handle chiFFInterpolationCreate(int FFITypeIndex){}
1249//framework/mesh/FieldFunctionInterpolation/lua/ffinterpol_export.cc
1250/** Export interpolation to python line,contour plot depending on the
1251 * type of interpolation.
1252 *
1253\param FFIHandle int Handle to the field function interpolation.
1254\param BaseName char Base name to be used for exported files.
1255
1256\ingroup LuaFFInterpol
1257### Usage Examples:
1258\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1259\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1260\ref test_modules_Diffusion_Diffusion1D_IP_lua
1261\ref test_modules_Diffusion_Diffusion1D_lua
1262\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1263\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1264\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1265\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1266\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1267\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1268\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1269\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1270\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1271\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1272\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1273\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1274\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1275\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1276\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1277\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1278\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1279\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1280\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1281\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1282\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1283\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1284\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1285\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1286\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1287\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1288\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1289\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1290\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1291\author Jan*/
1292void chiFFInterpolationExportPython(int FFIHandle, char BaseName){}
1293//framework/mesh/FieldFunctionInterpolation/lua/ffinterpol_setproperty.cc
1294/** Creates a new field function interpolation.
1295 *
1296\param FFIHandle int Handle to the field function interpolation.
1297\param PropertyIndex int Type of property to set.
1298
1299##_
1300
1301###PropertyIndex\n
1302ADD_FIELDFUNCTION = Add field function to interpolation.\n
1303SET_FIELDFUNCTIONS = Sets the field functions to interpolate using a lua
1304table.\n PROBEPOINT = Reference point for POINT type FFIs.\n
1305SLICE_POINT = Reference point for SLICE type FFIs.\n
1306SLICE_NORMAL = Normal of slice plane.\n
1307SLICE_TANGENT = Tangent vector of slice plane.\n
1308SLICE_BINORM = Binorm vector of slice plane.\n
1309LINE_FIRSTPOINT = Line start point.\n
1310LINE_SECONDPOINT = Line end point.\n
1311LINE_NUMBEROFPOINTS = Number of points to put in the line interpolator.
1312 Minimum 2.\n
1313LINE_CUSTOM_ARRAY = Adds custom array to line interpolator.\n
1314OPERATION = Some interpolations support operation types. See OpTypes.\n
1315LOGICAL_VOLUME = To be followed by a handle to a logical volume to be
1316 used by the interpolator.\n
1317
1318###OpTypes
1319Basic operations are volume sum, volume average or volume max. The volume
1320sum is computed from
1321\f[
1322Sum = \sum_k \sum_i u_i \int_V N_i .dV.
1323\f]
1324The volume average is computed from
1325\f[
1326Avg = \frac{\sum_k \sum_i u_i \int_V N_i .dV}{\sum_k \sum_i \int_V N_i .dV}
1327\f]
1328The volume max is simply \f$ max_{k,i}(u_i) \f$.\n\n
1329
1330OP_SUM\n
1331For volume interpolations, computes the volume integral.\n
1332\n
1333OP_AVG\n
1334For volume interpolations, computes the volume average.\n
1335OP_MAX\n
1336For volume interpolations, computes the volume max.\n
1337\n
1338A modified version of these operations are also available. Instead of OP_SUM,
1339OP_AVG and OP_MAX, the user may supply OP_SUM_LUA, OP_AVG_LUA and OP_MAX_LUA
1340which then needs to be followed by a string value `LuaFunctionName` of a lua
1341function of the following form:
1342
1343\code
1344function LuaFunctionName(ff_value, mat_id)
1345 ret_val = 0.0; --Or some computation
1346 return ret_val
1347end
1348\endcode
1349
1350This code will be called to return a value \f$ f(u_i) \f$ to be used instead of
1351the field function \f$ u_i \f$.\n
1352
1353Example:
1354\code
1355xwing=2.0
1356function IntegrateMaterialVolume(ff_value,mat_id)
1357 return xwing
1358end
1359ffi2 = chiFFInterpolationCreate(VOLUME)
1360curffi = ffi2
1361chiFFInterpolationSetProperty(curffi,OPERATION,OP_SUM_LUA,"IntegrateMaterialVolume")
1362chiFFInterpolationSetProperty(curffi,LOGICAL_VOLUME,vol0)
1363chiFFInterpolationSetProperty(curffi,ADD_FIELDFUNCTION,fftemp)
1364
1365chiFFInterpolationInitialize(curffi)
1366chiFFInterpolationExecute(curffi)
1367print(chiFFInterpolationGetValue(curffi))
1368\endcode
1369
1370The code above will return 2.0 times the volume of cells included in the logical
1371volume `vol0`.
1372
1373
1374\return Handle int Handle to the created interpolation.
1375\ingroup LuaFFInterpol
1376### Usage Examples:
1377\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1378\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1379\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1380\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1381\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1382\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1383\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1384\ref test_modules_Diffusion_Diffusion1D_IP_lua
1385\ref test_modules_Diffusion_Diffusion1D_lua
1386\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1387\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1388\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1389\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1390\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1391\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1392\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1393\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1394\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1395\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1396\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1397\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1398\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1399\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1400\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1401\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1402\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1403\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1404\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1405\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1406\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1407\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1408\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1409\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1410\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1411\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1412\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1413\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1414\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1415\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1416\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1417\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1418\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1419\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1420\author Jan*/
1421Handle chiFFInterpolationSetProperty(int FFIHandle, int PropertyIndex){}
1422//framework/mesh/FieldFunctionInterpolation/lua/ffinterpol_operations.cc
1423/** Initialize interpolator.
1424 *
1425\param FFIHandle int Handle to the field function interpolation.
1426
1427\ingroup LuaFFInterpol
1428### Usage Examples:
1429\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1430\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1431\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1432\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1433\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1434\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1435\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1436\ref test_modules_Diffusion_Diffusion1D_IP_lua
1437\ref test_modules_Diffusion_Diffusion1D_lua
1438\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1439\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1440\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1441\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1442\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1443\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1444\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1445\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1446\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1447\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1448\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1449\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1450\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1451\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1452\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1453\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1454\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1455\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1456\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1457\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1458\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1459\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1460\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1461\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1462\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1463\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1464\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1465\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1466\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1467\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1468\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1469\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1470\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1471\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1472\author Jan*/
1473void chiFFInterpolationInitialize(int FFIHandle){}
1474/** Execute interpolator.
1475 *
1476\param FFIHandle int Handle to the field function interpolation.
1477
1478\ingroup LuaFFInterpol
1479### Usage Examples:
1480\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1481\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1482\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1483\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1484\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1485\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1486\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1487\ref test_modules_Diffusion_Diffusion1D_IP_lua
1488\ref test_modules_Diffusion_Diffusion1D_lua
1489\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1490\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1491\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1492\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1493\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1494\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1495\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1496\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1497\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1498\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1499\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1500\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1501\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1502\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1503\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1504\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1505\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1506\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1507\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1508\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1509\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1510\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
1511\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1512\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1513\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1514\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1515\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1516\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1517\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1518\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1519\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1520\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1521\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1522\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1523\author Jan*/
1524void chiFFInterpolationExecute(int FFIHandle){}
1525//framework/mesh/MeshModifiers/lua/lua_meshmodifier_apply.cc
1526//framework/mesh/LogicalVolume/lua/logicvolume_lua.cc
1527/** Creates a logical volume.
1528
1529\param TypeIndex int Volume type.
1530\param Values varying Parameters.
1531
1532\warning This function is deprecated
1533
1534##_
1535
1536### TypeIndex
1537SPHERE_ORIGIN = Sphere at the origin. [Requires: R]\n
1538SPHERE = Sphere at user supplied location. [Requires: x,y,z,R]\n
1539RPP= Rectangular ParalleliPiped. [Requires: xmin,xmax,ymin,ymax,zmin,zmax]\n
1540RCC= Right Circular Cylinder. [Requires: x0,y0,z0, vx,vy,vz and R]\n
1541SURFACE= Logical volume determined from a surface mesh. [Requires: a handle
1542 to a surface mesh]\n
1543BOOLEAN= Boolean combination of other volumes.
1544 [Requires pairs of values: bool,volumeHandle]\n
1545
1546### Examples
1547Example usage:
1548\code
1549-- Sphere at origin radius 1.0
1550lv1 = chiLogicalVolumeCreate(SPHERE_ORIGIN, 1.0)
1551
1552-- Sphere centered at (0.1,0.2,0.3) with radius 1.0
1553lv2 = chiLogicalVolumeCreate(SPHERE, 0.1, 0.2, 0.3, 1.0)
1554
1555-- Rectangular parallelepiped
1556xmin = -1.0; xmax = 1.0
1557ymin = -2.0; ymax = 1.0
1558zmin = -1000.0, zmax = 1000.0
1559lv3 = chiLogicalVolumeCreate(RPP, xmin, xmax, ymin, ymax, zmin, zmax)
1560
1561-- Right Circular Cylinder
1562basex = 1.0; basey = 0.0; basez = 0.5
1563upvecx = 0.0; upvecy = 0.0; upvecz = 1.0
1564R = 1.0
1565lv4 = chiLogicalVolumeCreate(RPP, basex, basey, basez, upvecx, upvecy, upvecz,
1566R)
1567
1568-- Surface mesh
1569lv_surfmesh = chiSurfaceMeshCreate()
1570chiSurfaceMeshImportFromOBJFile(lv_surfmesh, "MeshFile3D.obj", false)
1571
1572lv5 = chiLogicalVolumeCreate(SURFACE, lv_surfmesh)
1573
1574-- Boolean combination
1575lv6 = chiLogicalVolumeCreate(BOOLEAN, {{true , lv5}, -- inside logical volume 5
1576 {false, lv1}, -- outside logical volume
15771 {false, lv2}}) -- outside logical volume 2 \endcode
1578
1579\return Handle int Handle to the created logical volume.
1580\ingroup LuaLogicVolumes
1581\author Jan*/
1582Handle chiLogicalVolumeCreate(int TypeIndex, varying Values){}
1583/**Evaluates whether a point is within the logical volume.
1584\param LVHandle int Handle to the logical volume.
1585\param Point_x double X-coordinate of the point.
1586\param Point_y double Y-coordinate of the point.
1587\param Point_z double Z-coordinate of the point.
1588
1589\return Sense true if inside the logical volume and false if outside.
1590\ingroup LuaLogicVolumes
1591### Usage Examples:
1592\ref test_framework_chi_mesh_LogicalVolume_lv_sphere_test1_lua
1593\ref test_framework_chi_mesh_LogicalVolume_lv_rpp_test1_lua
1594*/
1595Sense chiLogicalVolumePointSense(int LVHandle, double Point_x, double Point_y, double Point_z){}
1596//framework/mesh/VolumeMesher/lua/volumemesher_setuportho_bndries.cc
1597/** Sets boundary numbers on boundaries orthogonal to the cardinal directions
1598 * as xmax=0, xmin=1, ymax=2, ymin=3, zmax=4, zmin=5.
1599 *
1600\ingroup LuaVolumeMesher
1601### Usage Examples:
1602\ref test_framework_tutorials_tutorial_93_raytracing_lua
1603\ref test_modules_Diffusion_Diffusion1D_IP_lua
1604\ref test_modules_Diffusion_Diffusion1D_lua
1605\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1606\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1607\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1608\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1609\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1610\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1611\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1612\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1613\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1614\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_CFEM_lua
1615\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_DFEM_lua
1616 */
1618//framework/mesh/VolumeMesher/lua/volumemesher_create.cc
1619/** Creates a new volume mesher.
1620 *
1621\param Type int Volume Remesher type.
1622\param OtherArgs varying Additional arguments depending on `Type`.
1623
1624Remesher types:\n
1625 VOLUMEMESHER_EXTRUDER = Creates an extruded mesh from a 2D template mesh.
1626 Requires two additional arguments. `TemplateType` and `handle`. See below.\n
1627 VOLUMEMESHER_UNPARTITIONED = Create the mesh from the latest UnpartitionedMesh.
1628 Requires a single additional argument, `handle`, which is a handle to
1629 a valid unpartitioned mesh.\n
1630
1631##_
1632
1633###Extruder parameters
1634
1635When the mesher type is specified to be VOLUMEMESHER_EXTRUDER then two
1636additional arguments are required. `TemplateType` and `handle`.\n
1637
1638- `TemplateType` can for now only be
1639 `ExtruderTemplateType.UNPARTITIONED_MESH`.\n
1640- `handle` is a handle to the template mesh. When `TemplateType` is
1641 set to `ExtruderTemplateType.UNPARTITIONED_MESH` then the handle must point
1642 to a valid unpartitioned mesh.
1643
1644\ingroup LuaVolumeMesher
1645\author Jan*/
1646void chiVolumeMesherCreate(int Type, varying OtherArgs){}
1647//framework/mesh/VolumeMesher/lua/volumemesher_setproperty.cc
1648/** Sets a volume mesher property.
1649
1650\param PropertyIndex int Index of the property to change. See below
1651\param PropertyValue varying Value of the property.
1652
1653##_
1654
1655###PropertyIndex:
1656 FORCE_POLYGONS = <B>PropertyValue:[bool]</B> Forces the 2D Meshing to use
1657 polygon cells even if the underlying surface mesh is
1658 triangles. Expects a boolean value.\n
1659 MESH_GLOBAL = <B>PropertyValue:[bool]</B> Generate/Read the full mesh at each
1660 location. Expects a boolean value [Default=true].\n
1661 PARTITION_TYPE = <B>PartitionType</B>. See below.\n
1662 EXTRUSION_LAYER = <B>PropertyValue:[double,(int),(char)]</B> Adds a layer to
1663the extruder volume mesher if it exists. Expects 1 required parameter, the layer
1664height, followed by 2 optional parameters: number of subdivisions (defaults to
16651), and layer id (char)(defaults to nothing). Only supported if partition-type
1666is
1667 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```. \n
1668 CUTS_X = Adds a cut at the given x-value. Only supported if partition-type is
1669 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1670 CUTS_Y = Adds a cut at the given y-value. Only supported if partition-type is
1671 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1672 CUTS_Z = Adds a cut at the given z-value. Only supported if partition-type is
1673 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1674 PARTITION_X = <B>PropertyValue:[int]</B> Number of partitions in X.
1675 Only supported if partition-type is
1676 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1677 PARTITION_Y = <B>PropertyValue:[int]</B> Number of partitions in Y.
1678 Only supported if partition-type is
1679 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1680 PARTITION_Z = <B>PropertyValue:[int]</B> Number of partitions in Z.
1681 Only supported if partition-type is
1682 ```KBA_STYLE_XY``` or ```KBA_STYLE_XYZ```.\n
1683 MATID_FROMLOGICAL = <B>LogicalVolumeHandle:[int],Mat_id:[int],
1684 Sense:[bool](Optional, default:true)</B> Sets the material
1685 id of cells that meet the sense requirement for the given
1686 logical volume.\n
1687 BNDRYID_FROMLOGICAL = <B>LogicalVolumeHandle:[int],Bndry_name:[string],
1688 Sense:[bool](Optional, default:true)</B> Sets the cell
1689 boundary id to the specified value for cells
1690 that meet the sense requirement for the given
1691 logical volume.\n
1692 MATID_FROM_LUA_FUNCTION = <B>LuaFunctionName:[string]</B>. For each cell, will
1693 call a lua function that can change the material id.
1694 The lua function must have 4 parameters,
1695 the cell's centroid x,y,z values (doubles) and the
1696 current cell-material id (int). The function must
1697 return a material id.
1698 BNDRYID_FROM_LUA_FUNCTION = <B>LuaFunctionName:[string]</B>. For each boundary
1699 face, will call a lua function that can change the
1700 boundary id.
1701 The lua function must have 7 parameters,
1702 the face's centroid x,y,z values (doubles), the
1703 face's normal x,y,z values (double), and the
1704 current face-boundary id (int). The function must
1705 return a boundary id.
1706## _
1707
1708### PartitionType
1709Can be any of the following:
1710 - KBA_STYLE_XYZ
1711 - PARMETIS
1712
1713\ingroup LuaVolumeMesher
1714### Usage Examples:
1715\ref test_framework_chi_mesh_LogicalVolume_lv_rcc_test1_lua
1716\ref test_framework_chi_mesh_LogicalVolume_lv_boolean_test1_lua
1717\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
1718\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
1719\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
1720\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
1721\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1722\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
1723\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1724\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1725\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
1726\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1727\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1728\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
1729\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
1730\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
1731\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
1732\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
1733\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
1734\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
1735\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
1736\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
1737\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
1738\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
1739\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
1740\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_mesh_lua
1741\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
1742\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
1743\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
1744\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
1745\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
1746\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
1747\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
1748\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
1749\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
1750\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
1751\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
1752\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
1753\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
1754\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
1755\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
1756\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
1757\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
1758\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
1759\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
1760\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
1761\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
1762\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
1763\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
1764\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
1765\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
1766\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
1767\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_mesh_lua
1768\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
1769\author Jan*/
1770void chiVolumeMesherSetProperty(int PropertyIndex, varying PropertyValue){}
1771/**Sets the Px, Py and Pz partititioning parameters for a
1772 * KBA-type partitioning. This also fixes the process count required to
1773 * a total of Px*Py*Pz.
1774 *
1775\param Px int Number partitions in x.
1776\param Py int Number partitions in y.
1777\param Pz int Number partitions in z.
1778\ingroup LuaVolumeMesher
1779 */
1780void chiVolumeMesherSetKBAPartitioningPxPyPz(int Px, int Py, int Pz){}
1781/**Sets the x-cuts for KBA type partitioning with a lua array.
1782\ingroup LuaVolumeMesher
1783 */
1785/**Sets the y-cuts for KBA type partitioning with a lua array.
1786\ingroup LuaVolumeMesher
1787 */
1789/**Sets the z-cuts for KBA type partitioning with a lua array.
1790\ingroup LuaVolumeMesher
1791 */
1793//framework/mesh/VolumeMesher/lua/volumemesher_setallcell_ids.cc
1794/** Sets all cell-material id's to the supplied value.
1795\param material_id int The id.
1796\ingroup LuaVolumeMesher
1797### Usage Examples:
1798\ref test_framework_tutorials_tutorial_93_raytracing_lua
1799\ref test_framework_tutorials_fv_test2_lua
1800\ref test_framework_tutorials_pwlc_test1_lua
1801\ref test_framework_tutorials_pwlc_test2_lua
1802\ref test_framework_tutorials_tutorial_91a_pwld_lua
1803\ref test_framework_tutorials_fv_test1_lua
1804\ref test_framework_tutorials_tutorial_06_wdd_lua
1805\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
1806\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
1807\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
1808\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
1809\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
1810\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
1811\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
1812\ref test_modules_Diffusion_Diffusion1D_IP_lua
1813\ref test_modules_Diffusion_Diffusion1D_lua
1814\ref test_modules_Diffusion_Diffusion1D_KBA_lua
1815\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_CFEM_lua
1816\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_DFEM_lua
1817\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
1818\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_mesh_lua
1819\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
1820\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
1821\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
1822\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
1823\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
1824\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
1825\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
1826\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
1827\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
1828\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
1829\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
1830\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
1831\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
1832\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
1833\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
1834\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
1835\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
1836\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
1837\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
1838\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_mesh_lua
1839\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
1840\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
1841*/
1842void chiVolumeMesherSetMatIDToAll(int material_id){}
1843//framework/mesh/VolumeMesher/lua/volumemesher_execute.cc
1844/** Executes the volume meshing pipeline.
1845
1846\ingroup LuaVolumeMesher
1847\author Jan*/
1849//framework/mesh/SurfaceMesher/lua/surfmesher_execute.cc
1850/** Executes the surface meshing pipeline.
1851
1852\ingroup LuaSurfaceMesher
1853\author Jan*/
1855//framework/mesh/SurfaceMesher/lua/surfmesher_setproperty.cc
1856/** Sets a property of a surface mesher.
1857
1858\param PropertyNumber int Handle of the property to be set.
1859\param PropertyValue varying Value of the property.
1860
1861Properties:\n
1862 MAX_AREA = Area constraint.\n
1863
1864\ingroup LuaSurfaceMesher
1865\author Jan*/
1866void chiSurfaceMesherSetProperty(int PropertyNumber, varying PropertyValue){}
1867//framework/mesh/SurfaceMesher/lua/surfmesher_create.cc
1868/** Creates a surface preprocessor.
1869 *
1870\param SurfaceMesherType int Surface Remesher type. See SurfaceMesherType.
1871
1872## _
1873
1874###SurfaceMesherType:\n
1875SURFACEMESHER_PREDEFINED\n
1876 Makes no modification to the region surfaces.\n\n
1877
1878\code
1879chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
1880\endcode
1881
1882## _
1883
1884\ingroup LuaSurfaceMesher
1885\author Jan*/
1887//framework/mesh/MeshCutting/lua/countcells.cc
1888/**Counts the number of cells with a logical volume.
1889*/
1891//framework/mesh/MeshCutting/lua/cutmesh.cc
1892/**Cuts a mesh.
1893
1894 \param PlanePoint Vec3 A 3 element lua-table containing the reference
1895 point of the plane.
1896 \param PlaneNormal Vec3 A 3 element lua-table containing the plane
1897 normal. Will be normalized when applied.
1898 \param MergeTol double (Optional). Vertices within a distance MergeTol from
1899 the plane will be snapped to the plane. Default: 1.0e-3
1900 \param GeneralTol double (Optional). A general tolerance to be used for
1901 comparing whether two real values are equal.
1902 Default: 1.0e-10.
1903 */
1904void chiCutMesh(Vec3 PlanePoint, Vec3 PlaneNormal, double MergeTol, double GeneralTol){}
1905//framework/mesh/UnpartitionedMesh/lua/basic_operations.cc
1906/**Uploads a vertex.
1907 *
1908\param handle int Handle to mesh.
1909\param x double x-coordinate.
1910\param y double y-coordinate.
1911\param z double z-coordinate.
1912
1913## _
1914
1915###Example
1916Example usage
1917\code
1918chiUnpartitionedMeshUploadVertex(umesh, 0, 0, 0)
1919chiUnpartitionedMeshUploadVertex(umesh, 1, 0, 0)
1920chiUnpartitionedMeshUploadVertex(umesh, 1, 1, 0)
1921chiUnpartitionedMeshUploadVertex(umesh, 0, 1, 0)
1922\endcode
1923
1924\ingroup LuaUnpartitionedMesh
1925 */
1926void chiUnpartitionedMeshUploadVertex(int handle, double x, double y, double z){}
1927/**Uploads a cell
1928
1929\param handle int Handle to mesh.
1930\param cell_table lua_table A Lua-table containing fields of data. See
1931 cell_table below.
1932
1933## _
1934
1935###cell_table
1936A lua-table with the following fields:
1937- `type` <I>string</I>. The value of this field contains the cell's primary type.
1938 The value can be "SLAB", "POLYGON" or "POLYHEDRON".
1939- `sub_type` <I>string</I>. The value of this field constains the cell's
1940 secondary type. The value can be "SLAB", "POLYGON", "TRIANGLE",
1941 "QUADRILATERAL", "POLYHEDRON", "TETRAHEDRON" or "HEXAHEDRON".
1942- `num_faces` <I>int</I>. The value of this field represent the number of faces
1943 specified for this cell. Each face is contained in a field "faceX" where X is
1944 the face index.
1945- `material_id` <I>int</I>. (Optional) The value of this field holds a material
1946 identifier. If not provided, will be defaulted to -1.
1947- `faceX` <I>table</I>. A field holding a lua-table containing the vertex-ids
1948 of face X. There must be `num_faces` of these fields, i.e., "face0", "face1", etc.
1949
1950###Example
1951Example usage
1952\code
1953chiUnpartitionedMeshUploadVertex(umesh, 0, 0, 0)
1954chiUnpartitionedMeshUploadVertex(umesh, 1, 0, 0)
1955chiUnpartitionedMeshUploadVertex(umesh, 1, 1, 0)
1956chiUnpartitionedMeshUploadVertex(umesh, 0, 1, 0)
1957
1958chiUnpartitionedMeshUploadVertex(umesh, 0, 0, 1)
1959chiUnpartitionedMeshUploadVertex(umesh, 1, 0, 1)
1960chiUnpartitionedMeshUploadVertex(umesh, 1, 1, 1)
1961chiUnpartitionedMeshUploadVertex(umesh, 0, 1, 1)
1962
1963cell = {}
1964cell.type = "POLYHEDRON"
1965cell.sub_type = "HEXAHEDRON"
1966cell.num_faces = 6
1967cell.material_id = 0
1968cell.face0 = {1,2,6,5}
1969cell.face1 = {0,4,7,3}
1970cell.face2 = {2,3,7,6}
1971cell.face3 = {0,1,5,4}
1972cell.face4 = {4,5,6,7}
1973cell.face5 = {0,3,2,1}
1974
1975chiUnpartitionedMeshUploadCell(umesh, cell, true)
1976chiUnpartitionedMeshFinalizeEmpty(umesh)
1977\endcode
1978
1979\ingroup LuaUnpartitionedMesh
1980 */
1981void chiUnpartitionedMeshUploadCell(int handle, lua_table cell_table){}
1982/**Finalizes a mesh. This usually involves computing centroids and
1983 * establishing connectivity.
1984 *
1985\param handle int Handle to mesh.
1986
1987## _
1988
1989###Example
1990Example usage
1991\code
1992chiUnpartitionedMeshUploadVertex(umesh, 0, 0, 0)
1993chiUnpartitionedMeshUploadVertex(umesh, 1, 0, 0)
1994chiUnpartitionedMeshUploadVertex(umesh, 1, 1, 0)
1995chiUnpartitionedMeshUploadVertex(umesh, 0, 1, 0)
1996
1997chiUnpartitionedMeshUploadVertex(umesh, 0, 0, 1)
1998chiUnpartitionedMeshUploadVertex(umesh, 1, 0, 1)
1999chiUnpartitionedMeshUploadVertex(umesh, 1, 1, 1)
2000chiUnpartitionedMeshUploadVertex(umesh, 0, 1, 1)
2001
2002cell = {}
2003cell.type = "POLYHEDRON"
2004cell.sub_type = "HEXAHEDRON"
2005cell.num_faces = 6
2006cell.material_id = 0
2007cell.face0 = {1,2,6,5}
2008cell.face1 = {0,4,7,3}
2009cell.face2 = {2,3,7,6}
2010cell.face3 = {0,1,5,4}
2011cell.face4 = {4,5,6,7}
2012cell.face5 = {0,3,2,1}
2013
2014chiUnpartitionedMeshUploadCell(umesh, cell, true)
2015chiUnpartitionedMeshFinalizeEmpty(umesh)
2016\endcode
2017
2018\ingroup LuaUnpartitionedMesh
2019 */
2021//framework/mesh/UnpartitionedMesh/lua/create.cc
2022/**Creates an empty unpartitioned mesh. An empty unpartitioned mesh
2023 * is meant to be manipulated with calls to chiUnpartitionedMeshUploadVertex()
2024 * and chiUnpartitionedMeshUploadCell(). It essentially supports building a mesh
2025 * manually.
2026 *
2027##_
2028
2029###Example
2030Example usage
2031\code
2032umesh = chiCreateEmptyUnpartitionedMesh()
2033\endcode
2034
2035\ingroup LuaUnpartitionedMesh*/
2037/**Destroy an unpartitioned mesh. This routine should be called for
2038 * memory sensitive simulations because each process will have a full
2039 * copy of this data.
2040 *
2041\param handle int Handle to mesh.
2042
2043##_
2044
2045###Example
2046Example usage
2047\code
2048chiDestroyUnpartitionedMesh(umesh)
2049\endcode
2050
2051\ingroup LuaUnpartitionedMesh*/
2053/**Creates an unpartitioned mesh from VTK Unstructured mesh files.
2054
2055\param file_name char Filename of the .vtu file.
2056\param field char Name of the cell data field from which to read
2057 material and boundary identifiers (optional).
2058
2059\ingroup LuaUnpartitionedMesh
2060
2061##_
2062
2063### Example
2064An example mesh creation below:
2065\code
2066chiMeshHandlerCreate()
2067
2068umesh = chiUnpartitionedMeshFromVTU("ZMeshTest_0.vtu")
2069
2070chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2071chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2072
2073chiSurfaceMesherExecute()
2074chiVolumeMesherExecute()
2075\endcode
2076
2077
2078\return Handle A handle to the newly created UnpartitionedMesh*/
2079Handle chiUnpartitionedMeshFromVTU(char file_name, char field){}
2080/**Creates an unpartitioned mesh from VTK Partitioned Unstructured mesh files
2081 * (.pvtu).
2082
2083\param file_name char Filename of the .vtu file.
2084\param field char Name of the cell data field from which to read
2085 material and boundary identifiers (optional).
2086
2087\ingroup LuaUnpartitionedMesh
2088
2089##_
2090
2091### Example
2092An example mesh creation below:
2093\code
2094chiMeshHandlerCreate()
2095
2096umesh = chiUnpartitionedMeshFromPVTU("ZMeshTest_0.vtu")
2097
2098chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2099chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2100
2101chiSurfaceMesherExecute()
2102chiVolumeMesherExecute()
2103\endcode
2104
2105
2106\return Handle A handle to the newly created UnpartitionedMesh*/
2107Handle chiUnpartitionedMeshFromPVTU(char file_name, char field){}
2108/**Creates an unpartitioned mesh from starccm+ exported
2109Ensight Gold mesh files.
2110
2111\param file_name char Filename of the .case file.
2112\param scale float Scale to apply to the mesh
2113
2114\ingroup LuaUnpartitionedMesh
2115
2116##_
2117
2118### Example
2119An example mesh creation below:
2120\code
2121chiMeshHandlerCreate()
2122
2123umesh = chiUnpartitionedMeshFromEnsightGold("resources/TestObjects/Sphere.case")
2124
2125chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2126chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2127
2128chiSurfaceMesherExecute()
2129chiVolumeMesherExecute()
2130\endcode
2131
2132\return Handle A handle to the newly created UnpartitionedMesh*/
2133Handle chiUnpartitionedMeshFromEnsightGold(char file_name, float scale){}
2134/**Creates an unpartitioned mesh from a wavefront .obj file.
2135
2136\param file_name char Filename of the .case file.
2137
2138\ingroup LuaUnpartitionedMesh
2139
2140##_
2141
2142### Example
2143An example mesh creation below:
2144\code
2145chiMeshHandlerCreate()
2146
2147umesh = chiUnpartitionedMeshFromWavefrontOBJ("resources/TestObjects/TriangleMesh2x2.obj")
2148
2149chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2150chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2151
2152chiSurfaceMesherExecute()
2153chiVolumeMesherExecute()
2154\endcode
2155
2156\return Handle A handle to the newly created UnpartitionedMesh*/
2158/**Creates an unpartitioned mesh from a .msh file.
2159
2160\param file_name char Filename of the .msh file.
2161
2162\ingroup LuaUnpartitionedMesh
2163
2164##_
2165
2166### Example
2167An example mesh creation below:
2168\code
2169chiMeshHandlerCreate()
2170
2171umesh = chiUnpartitionedMeshFromMshFormat("File.msh")
2172
2173chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2174chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2175
2176chiSurfaceMesherExecute()
2177chiVolumeMesherExecute()
2178\endcode
2179
2180
2181\return Handle A handle to the newly created UnpartitionedMesh*/
2183/**Creates an unpartitioned mesh from ExodusII format.
2184
2185\param file_name char Filename of the .case file.
2186\param scale float Scale to apply to the mesh
2187
2188\ingroup LuaUnpartitionedMesh
2189
2190##_
2191
2192### Example
2193An example mesh creation below:
2194\code
2195chiMeshHandlerCreate()
2196
2197umesh = chiUnpartitionedMeshFromExodusII("resources/TestObjects/Mesh.e")
2198
2199chiSurfaceMesherCreate(SURFACEMESHER_PREDEFINED)
2200chiVolumeMesherCreate(VOLUMEMESHER_UNPARTITIONED, umesh)
2201
2202chiSurfaceMesherExecute()
2203chiVolumeMesherExecute()
2204\endcode
2205
2206\return Handle A handle to the newly created UnpartitionedMesh*/
2207Handle chiUnpartitionedMeshFromExodusII(char file_name, float scale){}
2208//framework/mesh/OrthoGrids/lua/lua_mesh_orthomacros.cc
2209/** Creates a 1D Mesh from an array of 1D vertices.
2210
2211\param x_nodes array_float An Array of floating point numbers denoting
2212 1D nodes along x-axis.
2213
2214\return Two handles: unpartitioned-mesh, region
2215
2216\ingroup LuaMeshMacros
2217
2218##_
2219
2220### Example
2221An example 1D mesh creation below:
2222\code
2223chiMeshHandlerCreate()
2224nodes={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2225chiMeshCreateUnpartitioned1DOrthoMesh(nodes)
2226chiVolumeMesherSetProperty(PARTITION_TYPE,PARMETIS)
2227chiVolumeMesherExecute();
2228\endcode
2229
2230 \author Nak*/
2232/** Creates a 2D Orthogonal Mesh from arrays of 1D vertices.
2233
2234\param x_nodes array_float An Array of floating point numbers denoting
2235 1D nodes along x-axis.
2236\param y_nodes array_float An Array of floating point numbers denoting
2237 1D nodes along y-axis.
2238
2239\return Two handles: unpartitioned-mesh, region
2240
2241\ingroup LuaMeshMacros
2242
2243##_
2244
2245### Example
2246An example 2D mesh creation below:
2247\code
2248chiMeshHandlerCreate()
2249nodesx={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2250nodesy={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2251chiMeshCreateUnpartitioned2DOrthoMesh(nodesx,nodesy)
2252chiVolumeMesherSetProperty(PARTITION_TYPE,PARMETIS)
2253chiVolumeMesherExecute();
2254\endcode
2255
2256 \author Nak*/
2257Two chiMeshCreateUnpartitioned2DOrthoMesh(array_float x_nodes, array_float y_nodes){}
2258/** Creates a 3D Orthogonal Mesh from arrays of 1D vertices. The
2259 * underlying mesher is an extruder.
2260
2261\param x_nodes array_float An Array of floating point numbers denoting
2262 1D nodes along x-axis.
2263\param y_nodes array_float An Array of floating point numbers denoting
2264 1D nodes along y-axis.
2265\param z_nodes array_float An Array of floating point numbers denoting
2266 1D nodes along z-axis.
2267
2268\return Two handles: unpartitioned-mesh, region
2269
2270\ingroup LuaMeshMacros
2271
2272##_
2273
2274### Example
2275An example 3D mesh creation below:
2276\code
2277chiMeshHandlerCreate()
2278nodesx={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2279nodesy={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2280nodesz={0.0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1.0}
2281chiMeshCreateUnpartitioned3DOrthoMesh(nodesx,nodesy,nodesz)
2282chiVolumeMesherSetProperty(PARTITION_TYPE,PARMETIS)
2283chiVolumeMesherExecute();
2284\endcode
2285
2286 \author Nak*/
2287Two chiMeshCreateUnpartitioned3DOrthoMesh(array_float x_nodes, array_float y_nodes, array_float z_nodes){}
2288//framework/mesh/DomainDecomposition/lua/decomp2ddomain.cc
2289/** \defgroup LuaDomainDecomposition Domain decomposition
2290 * \ingroup LuaMesh
2291*/
2292/** Decomposes a surface mesh into block px py elements.
2293 * \image html "InProgressImage.png" width=200px
2294 *
2295\param Surface mesh handler
2296\param Px int Number of divisions in x.
2297\param Py int Number of divisions in y.
2298
2299\ingroup LuaDomainDecomposition
2300\author Jan*/
2301void chiDecomposeSurfaceMeshPxPy(mesh Surface, int Px, int Py){}
2302//framework/mesh/MeshGenerator/lua/lua_meshgenerator_execute.cc
2305//framework/lua/lua_parse_table.cc
2306//framework/lua/lua_make_object.cc
2309/**Generic lua routine for the creation of objects.
2310 * \param params ParameterBlock A single block tree that requires a parameter
2311 * called chi_obj_type that indicates the type of object to make.
2312
2313*/
2314void chiMakeObject(ParameterBlock params){}
2315/**Generic lua routine for the creation of objects.
2316 * \param type string The type to create.
2317 * \param params ParameterBlock A single block tree.
2318
2319*/
2320void chiMakeObjectType(string type, ParameterBlock params){}
2321//framework/lua/chi_lua.cc
2322//framework/utils/lua/lua_chiProgramTimer.cc
2324/**Returns the program time as determined from the home location (involves a
2325* collective broadcast).*/
2326void chiProgramTime(){}
2327//framework/utils/lua/lua_chiSleep.cc
2328void chiSleep(){}
2329/**Makes the program sleep for the specified time in milliseconds.
2330* \param time int Time in milliseconds to sleep for.
2331* */
2332void chiSleep(int time){}
2333//framework/utils/lua/lua_chiExit.cc
2334void chiExit(){}
2335/**Gracefully exits ChiTech.
2336* \param return_code int Return code, defaults to 0 (Success).*/
2337void chiExit(int return_code){}
2338//framework/logging/lua/log.cc
2339/** Sets the verbosity level of the Logger.
2340 * This lua command will overwrite the currently set value.
2341
2342\param int_level int Integer denoting verbosity level. Can be 0,1 or 2
2343 [default:0]
2344
2345\ingroup LuaLogging
2346\author Jan*/
2347void chiLogSetVerbosity(int int_level){}
2348/**Logs a message depending on the log type specified.
2349
2350\param LogType int Can be any of the log types specified below.
2351\param LogMsg char Message or value to be output to the log.
2352
2353##_
2354
2355### LogType
2356LOG_0\n
2357Write a log only if location 0.\n
2358
2359LOG_0WARNING\n
2360Write a log only if location 0 and format it as a warning.\n
2361
2362LOG_0ERROR\n
2363Write a log only if location 0 and format it as an error.\n
2364
2365LOG_0VERBOSE_0\n
2366Same as LOG_0.\n
2367
2368LOG_0VERBOSE_1\n
2369Write a log only if location 0 and the verbosity level is greater
2370or equal to 1.\n
2371
2372LOG_0VERBOSE_2\n
2373Write a log only if location 0 and the verbosity level is greater
2374or equal to 1.\n
2375
2376LOG_ALL, LOG_ALLWARNING, LOG_ALLERROR,\n
2377LOG_ALLVERBOSE_0, LOG_ALLVERBOSE_1, LOG_ALLVERBOSE_2\n
2378Has the same meaning as their LOG_0 counterparts but instead applies to
2379all locations in the parallel context.
2380
2381\ingroup LuaLogging
2382\author Jan
2383### Usage Examples:
2384\ref test_framework_log_timingblock_test_lua
2385\ref test_framework_chi_mesh_ReadWavefrontObj1_lua
2386\ref test_framework_chi_mesh_LogicalVolume_lv_sphere_test1_lua
2387\ref test_framework_chi_mesh_LogicalVolume_lv_rpp_test1_lua
2388\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
2389\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
2390\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
2391\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
2392\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
2393\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
2394\ref test_modules_Diffusion_Diffusion1D_IP_lua
2395\ref test_modules_Diffusion_Diffusion1D_lua
2396\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
2397\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
2398\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
2399\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
2400\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
2401\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
2402\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
2403\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
2404\ref test_modules_Diffusion_Diffusion1D_KBA_lua
2405\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
2406\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
2407\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
2408\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
2409\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
2410\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
2411\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
2412\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
2413\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
2414\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
2415\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
2416\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
2417\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
2418\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
2419\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
2420\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
2421\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
2422\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
2423\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
2424\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
2425\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
2426\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
2427\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
2428\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
2429\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
2430\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
2431\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
2432\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
2433\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
2434\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
2435\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
2436\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
2437\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
2438\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
2439\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
2440\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
2441\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
2442\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
2443\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
2444\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
2445\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
2446\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
2447\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
2448\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
2449\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
2450\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
2451\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_materials_materials_lua
2452\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
2453\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
2454*/
2455void chiLog(int LogType, char LogMsg){}
2456/**Processes the sub-events of a repeating event and converts it to a
2457* meaningful value (floating-point).
2458*
2459\param event_name string Required. Name of the event.
2460\param event_operation_name string Required. What kind of operation to be
2461 applied. See `chi::ChiLog::EventOperation`
2462*
2463* \ingroup LuaLogging
2464\return double The processed value.
2465*/
2466double chiLogProcessEvent(string event_name, string event_operation_name){}
2467/**Prints the performance graph.
2468 * \params rank int Optional argument to print the graph for a specific rank.
2469 *
2470 * \ingroup LuaLogging
2471### Usage Examples:
2472\ref test_framework_log_timingblock_test_lua
2473\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
2474 * */
2476//framework/math/Quadratures/SLDFESQ/lua/locally_refine_sldfesq.cc
2477/** Applies a local refinement of angles.
2478\param handle int. Handle to the reference quadrature.
2479\param reference_direction vec3 Reference vector. \f$ \vec{r} \f$
2480\param cone_size double Cone size in radians. \f$ \theta \f$
2481\param invert_logic bool Optional[Default:false]. If supplied, interprets
2482 SQ-splitting as when \f$|\omega \cdot \vec{r}| < \sin(\theta) \f$. Otherwise,
2483 SQs will be split if \f$ \omega \cdot \vec{r} > \cos(\theta)\f$
2484
2485##_
2486
2487###Example:
2488Example with refinement level 2 and a triple directional refinement:
2489\code
2490pquad = chiCreateSLDFESQAngularQuadrature(2)
2491chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},45.0*math.pi/180,false)
2492chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},23.0*math.pi/180,false)
2493chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},12.0*math.pi/180,false)
2494\endcode
2495
2496\image html "SLDFESQr.png" width=500px
2497
2498Example with refinement level 2 and a triple planar refinement:
2499\code
2500pquad = chiCreateSLDFESQAngularQuadrature(2)
2501chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},22.50*math.pi/180,true)
2502chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},11.75*math.pi/180,true)
2503chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},5.000*math.pi/180,true)
2504\endcode
2505
2506\image html "SLDFESQp.png" width=500px
2507
2508\ingroup LuaSLDFESQ
2509\author Jan */
2510void chiLocallyRefineSLDFESQAngularQuadrature(in handle, vec3 reference_direction, double cone_size, bool invert_logic){}
2511//framework/math/Quadratures/SLDFESQ/lua/create_sldfesq_quadrature.cc
2512/** Creates a Simplified Linear Discontinuous Finite Element (SLDFE)
2513quadrature based on Spherical Quadrilaterals (SQ). Hence SLDFE-SQ.
2514\param initial_refinement_level int Initial refinement level, \f$n\f$ to
2515 be used. The total number of angles will be \f$ 8{\times}12(n+1)^2 \f$.
2516
2517##_
2518
2519###Example:
2520Example with refinement level 2.
2521\code
2522pquad = chiCreateSLDFESQAngularQuadrature(2)
2523\endcode
2524
2525\image html "SLDFESQBasen2.png" width=500px
2526With direction points:
2527\image html "SLDFESQBasen2Oct2.png" width=500px
2528
2529\ingroup LuaSLDFESQ
2530\author Jan */
2531void chiCreateSLDFESQAngularQuadrature(int initial_refinement_level){}
2532//framework/math/Quadratures/SLDFESQ/lua/print_sldfesq.cc
2533/** Outputs the quadrature information to python format.
2534\param handle int Handle to the reference quadrature.
2535\param file_name_prefix string Prefix to be used in front of file.
2536
2537##_
2538
2539###Example:
2540Example of printing a quadrature:
2541Example with refinement level 2 and a triple directional refinement:
2542\code
2543pquad = chiCreateSLDFESQAngularQuadrature(2)
2544chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},45.0*math.pi/180,false)
2545chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},23.0*math.pi/180,false)
2546chiLocallyRefineSLDFESQAngularQuadrature(pquad,{1,0,0},12.0*math.pi/180,false)
2547chiPrintToPythonSLDFESQAngularQuadrature(pquad,"YQuad_");
2548\endcode
2549
2550\image html "SLDFESQr.png" width=500px
2551
2552\ingroup LuaSLDFESQ
2553\author Jan */
2554void chiPrintToPythonSLDFESQAngularQuadrature(int handle, string file_name_prefix){}
2555//framework/math/Quadratures/lua/createlinequadrature.cc
2556/** Creates a quadrature.
2557 *
2558\param QuadratureType int Quadrature identifier.
2559\param NumberOfPoints int Number of quadrature points.
2560\param VerboseFlag bool As the name implies. Default: false.
2561
2562##_
2563
2564###QuadratureType:\n
2565 GAUSS_LEGENDRE = Gauss-Legendre quadrature.
2566 GAUSS_CHEBYSHEV = Gauss-Chebyshev quadrature.
2567
2568\return Returns a unique handle to the created quadrature rule
2569
2570\ingroup LuaQuadrature
2571\author Jan*/
2572Returns chiCreateLineQuadrature(int QuadratureType, int NumberOfPoints, bool VerboseFlag){}
2573//framework/math/Quadratures/lua/create_angular_quadrature.cc
2574/** Creates an angular quadrature.
2575 *
2576\param azimuthal_angles array A lua table with N entries each being an azimuthal
2577 angle.
2578\param polar_angles array A lua table with N entries each being a polar angle
2579 angle.
2580\param weight array A lua table with N entries each being a quadrature weight.
2581
2582
2583\return Returns a unique handle to the created angular quadrature
2584
2585\ingroup LuaQuadrature
2586\author Jan*/
2587Returns chiCreateCustomAngularQuadrature(array azimuthal_angles, array polar_angles, array weight){}
2588//framework/math/Quadratures/lua/create_curvilinear_product_quadrature.cc
2589/** Creates a curvilinear product quadrature suitable for cylindrical geometries.
2590
2591 \param QuadratureType int Quadrature identifier.
2592 \param values varying Varying options based on the quadrature type.
2593
2594 ##_
2595
2596 ###QuadratureType:\n
2597 GAUSS_LEGENDRE_CHEBYSHEV\n
2598 Gauss-Legendre quadrature for the polar angle and Gauss-Chebyshev quadrature
2599 for the azimuthal angle.
2600 Arguments for this quadrature type, in order:
2601 - Np : (int) number of polar angles
2602 - Na : (int) number of azimuthal angles (unique number at each polar level), or
2603 (table<int>) number of azimuthal angles (diverse number at each polar level)
2604 - verbose : (bool) verbosity flag (optional).
2605
2606 ###QuadratureType:\n
2607 GAUSS_LEGENDRE_LEGENDRE\n
2608 Gauss-Legendre quadrature for the polar angle and Gauss-Legendre quadrature
2609 for the azimuthal angle.
2610 Arguments for this quadrature type, in order:
2611 - Np : (int) number of polar angles
2612 - Na : (int) number of azimuthal angles (unique number at each polar level), or
2613 (table<int>) number of azimuthal angles (diverse number at each polar level)
2614 - verbose : (bool) verbosity flag (optional).
2615
2616
2617 \return Returns a unique handle to the created product quadrature rule
2618
2619 \ingroup LuaQuadrature
2620### Usage Examples:
2621\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
2622\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
2623 */
2624Returns chiCreateCylindricalProductQuadrature(int QuadratureType, varying values){}
2625/** Creates a curvilinear product quadrature suitable for spherical geometries.
2626
2627 \param QuadratureType int Quadrature identifier.
2628 \param values varying Varying options based on the quadrature type.
2629
2630 ##_
2631
2632 ###QuadratureType:\n
2633 GAUSS_CHEBYSHEV\n
2634 Gauss-Chebyshev quadrature for the polar angle and no quadrature
2635 for the azimuthal angle.
2636 Arguments for this quadrature type, in order:
2637 - Np : (int) number of polar angles
2638 - verbose : (bool) verbosity flag (optional).
2639
2640 ###QuadratureType:\n
2641 GAUSS_LEGENDRE\n
2642 Gauss-Legendre quadrature for the polar angle and no quadrature
2643 for the azimuthal angle.
2644 Arguments for this quadrature type, in order:
2645 - Np : (int) number of polar angles
2646 - verbose : (bool) verbosity flag (optional).
2647
2648
2649 \return Returns a unique handle to the created product quadrature rule
2650
2651 \ingroup LuaQuadrature
2652 */
2653Returns chiCreateSphericalProductQuadrature(int QuadratureType, varying values){}
2654//framework/math/Quadratures/lua/getprodquadrature.cc
2655/** Get the values of a product quadrature
2656
2657\param QuadHandle int Handle to an existing product quadrature.
2658
2659\return Table A lua table with each entry being another table with entries
2660 .weight .polar .azimuthal.
2661
2662\ingroup LuaQuadrature
2663\author Jan*/
2664Table chiGetProductQuadrature(int QuadHandle){}
2665//framework/math/Quadratures/lua/angular_quadrature_polaropt.cc
2666/**Optimizes the indicated angular quadrature for polar symmetry.
2667 *
2668\param handle int. Handle to the quadrature to be optimized.
2669\param normalization double. (Optional) The normalization to be applied to the
2670 modified quadrature. Any negative number will inhibit
2671 renormalization. [Default=-1.0]
2672
2673 ## _
2674
2675 ###Example:
2676 Example:
2677\code
2678pquad = chiCreateProductQuadrature(GAUSS_LEGENDRE_CHEBYSHEV,2, 1)
2679chiOptimizeAngularQuadratureForPolarSymmetry(pqaud, 4.0*math.pi)
2680\endcode
2681
2682\ingroup LuaQuadrature
2683### Usage Examples:
2684\ref test_framework_tutorials_tutorial_93_raytracing_lua
2685\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
2686\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
2687\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
2688\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
2689\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
2690\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
2691\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
2692\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
2693\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
2694\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
2695\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
2696\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
2697\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
2698\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
2699\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
2700\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
2701\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
2702\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
2703\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
2704\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
2705\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
2706\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
2707\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
2708\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
2709\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
2710\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
2711\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
2712\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
2713\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
2714\author Jan */
2715void chiOptimizeAngularQuadratureForPolarSymmetry(in handle, double normalization){}
2716//framework/math/Quadratures/lua/createprodquadrature.cc
2717/** Creates a Product-quadrature.
2718 *
2719\param QuadratureType int Quadrature identifier.
2720\param values varying Varying options based on the quadrature type.
2721
2722##_
2723
2724###QuadratureType:
2725GAUSS_LEGENDRE\n
2726 Gauss-Legendre quadrature for the polar angles and no quadrature rule
2727 for the azimuthal angle. Suitable only for 1D simulations. Expects
2728 to be followed by the number of angles Np. Optionally a verbosity flag
2729 can be added.\n\n
2730
2731GAUSS_LEGENDRE_LEGENDRE\n
2732 Gauss-Legendre quadrature for both the polar and azimuthal dimension.
2733 Expects to be followed by number of Azimuthal and Polar angles.
2734 Optionally a verbosity flag can be added.\n\n
2735
2736GAUSS_LEGENDRE_CHEBYSHEV\n
2737 Gauss-Legendre quadrature for the polar angle but Gauss-Chebyshev
2738 for the azimuthal angle.
2739 Expects to be followed by number of Azimuthal and Polar angles.
2740 Optionally a verbosity flag can be added.\n\n
2741
2742CUSTOM_QUADRATURE\n
2743 Expects to be followed by three lua tables. The first table is an array,
2744 of length Na, of the azimuthal angles (radians). The second table is an array,
2745 of length Np, of the polar angles (radians). The third table is an array, of
2746 length Na*Np, and contains the weight associated with each angle pair.
2747 Optionally a verbosity flag can be added.\n\n
2748
2749
2750\return Returns a unique handle to the created product quadrature rule
2751
2752\ingroup LuaQuadrature
2753### Usage Examples:
2754\ref test_framework_tutorials_tutorial_93_raytracing_lua
2755\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
2756\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
2757\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
2758\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
2759\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
2760\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
2761\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
2762\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
2763\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
2764\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
2765\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
2766\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
2767\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
2768\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
2769\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
2770\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
2771\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
2772\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
2773\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
2774\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
2775\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
2776\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
2777\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
2778\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
2779\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
2780\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
2781\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
2782\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
2783\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
2784\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
2785\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
2786\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
2787\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
2788\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
2789\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
2790\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
2791\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
2792\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
2793\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
2794\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
2795\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
2796\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
2797\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
2798\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
2799\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
2800\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
2801\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
2802\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
2803\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
2804\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
2805\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
2806\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
2807\author Jan*/
2808Returns chiCreateProductQuadrature(int QuadratureType, varying values){}
2809//framework/math/Quadratures/LegendrePoly/lua/legendre_lua.cc
2810/**Provides the function evaluation of Pn at value x.
2811
2812 \param N int The Legendre polynomial.
2813 \param x double The evaluation point.
2814
2815### Usage Examples:
2816\ref test_framework_chi_math_Quadrature_quadrature_test1_lua
2817\ref test_framework_chi_math_Quadrature_gold_quadrature_test1_lua_gold
2818 \ingroup LuaMath*/
2819void chiLegendre(int N, double x){}
2820/**Provides the function evaluation of the derivative of Pn at value x
2821
2822 \param N int The Legendre polynomial.
2823 \param x double The evaluation point.
2824
2825### Usage Examples:
2826\ref test_framework_chi_math_Quadrature_quadrature_test1_lua
2827\ref test_framework_chi_math_Quadrature_gold_quadrature_test1_lua_gold
2828 \ingroup LuaMath*/
2829void chiLegendreDerivative(int N, double x){}
2830/**Provides the function evaluation of the spherical harmonics.
2831
2832\param ell int The \f$ \ell \f$-th order of the harmonic.
2833\param m int The \f$ m \f$-th moment of the harmonic.
2834\param theta double Radian polar angle \f$ \theta \f$.
2835\param varphi double Radian azimuthal angle \f$ \varphi \f$.
2836
2837This code has a whitepaper associated with it
2838<a href="SphericalHarmonics.pdf" target="_blank"><b>Spherical Harmonics</b></a>
2839
2840### Usage Examples:
2841\ref test_framework_chi_math_Quadrature_quadrature_test1_lua
2842\ref test_framework_chi_math_Quadrature_gold_quadrature_test1_lua_gold
2843\ingroup LuaMath*/
2844void chiYlm(int ell, int m, double theta, double varphi){}
2845//framework/math/Functions/lua/lua_chi_math_function.cc
2847/**Evaluates a function of base type `FunctionXYZDimAToDimB`.
2848\param handle int. Handle to the function to evaluate.
2849\param params Varying. Table or individual arguments.
2850
2851\return Varying Either a single number or a table of output values.*/
2852Varying chiFunctionDimAToDimBEvaluate(in handle, Varying params){}
2853//framework/post_processors/lua/lua_PostProcessorGetValue.cc
2854//framework/post_processors/lua/lua_PrintPostProcessors.cc
2855//framework/post_processors/lua/lua_ExecutePostProcessors.cc
2856//framework/post_processors/lua/lua_PPPrinterSetOptions.cc
2857//framework/mpi/lua/mpi_barrier.cc
2858/** Blocks until all processes in the communicator have reached this routine.
2859
2860\ingroup chiMPI
2861### Usage Examples:
2862\ref test_framework_tutorials_tutorial_93_raytracing_lua
2863\ref test_framework_tutorials_fv_test2_lua
2864\ref test_framework_tutorials_pwlc_test1_lua
2865\ref test_framework_tutorials_pwlc_test2_lua
2866\ref test_framework_tutorials_tutorial_91a_pwld_lua
2867\ref test_framework_tutorials_fv_test1_lua
2868\ref test_framework_tutorials_tutorial_06_wdd_lua
2869\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_CFEM_lua
2870\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_DFEM_lua
2871\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
2872\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
2873\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
2874\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
2875\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
2876\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
2877\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
2878\author Jan*/
2880//modules/FVDiffusion/lua/create_solver.cc
2881/** Creates a Finite Volume Diffusion solver.
2882
2883\param solver_name string Optional. Text name for the solver.
2884 [Default:"FVDiffusionSolver"]
2885
2886\return Handle int Handle to the created solver.
2887\ingroup LuaDiffusion
2888*/
2889Handle chiFVDiffusionSolverCreate(string solver_name){}
2890//modules/FVDiffusion/lua/ds_lua_utils.cc
2891//modules/FVDiffusion/lua/setBCproperty.cc
2892/** Sets a property of a Diffusion solver. Please also consult the whitepaper
2893 * for the Diffusion solver (<a
2894 * href="../../whitepages/DiffusionSolver/DiffusionSolver.pdf">
2895 * Diffusion Whitepaper</a>)
2896
2897\n\n Additional basic options can be set as indicated in \ref LuaDiffusionBasicOptions
2898
2899\param SolverHandle int Handle to an existing diffusion solver.
2900\param PropertyName string Name for a specific property.
2901\param Values varying Number of inputs associated with the index.<br>
2902
2903##_
2904
2905###PropertyName\n
2906"boundary_type"\n
2907 Boundary type. Expects boundary index then <B>BoundaryTypeName</B>
2908 then type value.\n\n
2909
2910\code
2911chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)
2912\endcode
2913
2914### BoundaryTypeName
2915reflecting\n
2916 Reflecting boundary conditions. Synonymous with Neumann with a
2917 derivative of 0.0.
2918 \f[ -D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
2919
2920dirichlet\n
2921 Constant value boundary condition.
2922 Expects to be followed by a value \f$ f \f$ associated with \f$ \phi \f$.
2923 \f[ \phi = f \f]\n\n
2924
2925neumann\n
2926 Constant derivative boundary condition. Expects to be followed
2927 by a constant \f$ f \f$ representing
2928 \f[ -D \hat{n}\cdot \nabla \phi = f \f]\n\n
2929
2930vacuum\n
2931 Vacuum boundary conditions. More appropriate to neutron diffusion.
2932 \f[ \frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
2933
2934robin\n
2935 Robin boundary condition of the form
2936 \f[ a \phi + b D \hat{n}\cdot \nabla \phi = f \f]\n\n
2937
2938\ingroup LuaDiffusion
2939\author Jan*/
2940void chiFVDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values){}
2941//modules/MGDiffusion/lua/mgds_lua_utils.cc
2942//modules/MGDiffusion/lua/create_solver.cc
2943/** Creates a Multigroup CFEM Diffusion solver.
2944
2945\return Handle int Handle to the created solver.
2946\ingroup LuaDiffusion
2947*/
2949//modules/MGDiffusion/lua/setBCproperty.cc
2950/** Sets a property of a Diffusion solver. Please also consult the whitepaper
2951 * for the Diffusion solver (<a
2952 * href="../../whitepages/DiffusionSolver/DiffusionSolver.pdf">
2953 * Diffusion Whitepaper</a>)
2954
2955\n\n Additional basic options can be set as indicated in \ref LuaDiffusionBasicOptions
2956
2957\param SolverHandle int Handle to an existing diffusion solver.
2958\param PropertyName string Name for a specific property.
2959\param Values varying Number of inputs associated with the index.<br>
2960
2961##_
2962
2963###PropertyName\n
2964"boundary_type"\n
2965 Boundary type. Expects boundary index then <B>BoundaryTypeName</B>
2966 then type value.\n\n
2967
2968\code
2969chiCFEMMGDiffusionSetBCProperty(solver,"boundary_type",bdID,"vacuum")
2970\endcode
2971
2972### BoundaryTypeName
2973reflecting\n
2974 Reflecting boundary conditions. Synonymous with Neumann with a
2975 derivative of 0.0.
2976 \f[ -D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
2977
2978neumann\n
2979 Constant derivative boundary condition. Expects to be followed
2980 by a constant \f$ f \f$ representing
2981 \f[ -D \hat{n}\cdot \nabla \phi = f \f]\n\n
2982
2983vacuum\n
2984 Vacuum boundary conditions. More appropriate to neutron diffusion.
2985 \f[ \frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
2986
2987robin\n
2988 Robin boundary condition of the form
2989 \f[ a \phi + b D \hat{n}\cdot \nabla \phi = f \f]\n\n
2990
2991\ingroup LuaDiffusion
2992\author Jean*/
2993void chiCFEMMGDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values){}
2994//modules/PointReactorKinetics/lua/prk_lua_utils.cc
2995/**Gets a parameter from the prk::TransientSolver.
2996*
2997* \param handle int Handle of the solver.
2998* \param param_name string Name of the parameter to retrieve.
2999\return Varying*/
3000Varying*/ chiPRKGetParam(int handle, string param_name){}
3001/**Gets a parameter from the prk::TransientSolver.
3002*
3003* \param handle int Handle of the solver.
3004* \param param_name string Name of the parameter to retrieve.
3005* \param value Varying The value to be set to the parameter.
3006\return Varying*/
3007Varying*/ chiPRKSetParam(int handle, string param_name, Varying value){}
3008//modules/lua/chi_modules_lua.cc
3009//modules/CFEMDiffusion/lua/create_solver.cc
3010/** Creates a CFEM Diffusion solver.
3011
3012\return Handle int Handle to the created solver.
3013\ingroup LuaDiffusion
3014### Usage Examples:
3015\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
3016\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
3017\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
3018\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
3019\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
3020*/
3022//modules/CFEMDiffusion/lua/ds_lua_utils.cc
3023//modules/CFEMDiffusion/lua/setBCproperty.cc
3024/** Sets a property of a Diffusion solver. Please also consult the whitepaper
3025 * for the Diffusion solver (<a
3026 * href="../../whitepages/DiffusionSolver/DiffusionSolver.pdf">
3027 * Diffusion Whitepaper</a>)
3028
3029\n\n Additional basic options can be set as indicated in \ref LuaDiffusionBasicOptions
3030
3031\param SolverHandle int Handle to an existing diffusion solver.
3032\param PropertyName string Name for a specific property.
3033\param Values varying Number of inputs associated with the index.<br>
3034
3035##_
3036
3037###PropertyName\n
3038"boundary_type"\n
3039 Boundary type. Expects boundary index then <B>BoundaryTypeName</B>
3040 then type value.\n\n
3041
3042\code
3043chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)
3044\endcode
3045
3046### BoundaryTypeName
3047reflecting\n
3048 Reflecting boundary conditions. Synonymous with Neumann with a
3049 derivative of 0.0.
3050 \f[ -D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3051
3052dirichlet\n
3053 Constant value boundary condition.
3054 Expects to be followed by a value \f$ f \f$ associated with \f$ \phi \f$.
3055 \f[ \phi = f \f]\n\n
3056
3057neumann\n
3058 Constant derivative boundary condition. Expects to be followed
3059 by a constant \f$ f \f$ representing
3060 \f[ -D \hat{n}\cdot \nabla \phi = f \f]\n\n
3061
3062vacuum\n
3063 Vacuum boundary conditions. More appropriate to neutron diffusion.
3064 \f[ \frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3065
3066robin\n
3067 Robin boundary condition of the form
3068 \f[ a \phi + b D \hat{n}\cdot \nabla \phi = f \f]\n\n
3069
3070\ingroup LuaDiffusion
3071### Usage Examples:
3072\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
3073\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
3074\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
3075\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
3076\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
3077\author Jan*/
3078void chiCFEMDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values){}
3079//modules/DiffusionSolver/lua/diffusion_createsolver.cc
3080/** Creates a Diffusion solver.
3081
3082\return Handle int Handle to the created solver.
3083\ingroup LuaDiffusion
3084### Usage Examples:
3085\ref test_modules_Diffusion_Diffusion1D_IP_lua
3086\ref test_modules_Diffusion_Diffusion1D_lua
3087\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
3088\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
3089\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
3090\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
3091\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
3092\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
3093\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
3094\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
3095\ref test_modules_Diffusion_Diffusion1D_KBA_lua
3096\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
3097\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
3098\author Jan*/
3100//modules/DiffusionSolver/lua/diffusion_setproperty.cc
3101/** Sets a property of a Diffusion solver. Please also consult the whitepaper
3102 * for the Diffusion solver (<a
3103 * href="../../whitepages/DiffusionSolver/DiffusionSolver.pdf">
3104 * Diffusion Whitepaper</a>)
3105
3106\n\n Additional basic options can be set as indicated in \ref LuaDiffusionBasicOptions
3107
3108\param SolverHandle int Handle to an existing diffusion solver.
3109\param PropertyName string Name for a specific property.
3110\param Values varying Number of inputs associated with the index.<br>
3111
3112##_
3113
3114###PropertyName\n
3115"boundary_type"\n
3116 Boundary type. Expects boundary name (string) then <B>BoundaryTypeName</B>
3117 then type value.\n\n
3118
3119\code
3120chiDiffusionSetProperty(solver,"boundary_type",2,"dirichlet",1.0)
3121\endcode
3122
3123### BoundaryTypeName
3124reflecting\n
3125 Reflecting boundary conditions. Synonymous with Neumann with a
3126 derivative of 0.0.
3127 \f[ -D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3128
3129dirichlet\n
3130 Constant value boundary condition.
3131 Expects to be followed by a value \f$ f \f$ associated with \f$ \phi \f$.
3132 \f[ \phi = f \f]\n\n
3133
3134neumann\n
3135 Constant derivative boundary condition. Expects to be followed
3136 by a constant \f$ f \f$ representing
3137 \f[ -D \hat{n}\cdot \nabla \phi = f \f]\n\n
3138
3139vacuum\n
3140 Vacuum boundary conditions. More appropriate to neutron diffusion.
3141 \f[ \frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3142
3143robin\n
3144 Robin boundary condition of the form
3145 \f[ a \phi + b D \hat{n}\cdot \nabla \phi = f \f]\n\n
3146
3147\ingroup LuaDiffusion
3148### Usage Examples:
3149\ref test_modules_Diffusion_Diffusion1D_IP_lua
3150\ref test_modules_Diffusion_Diffusion1D_lua
3151\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
3152\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
3153\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
3154\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
3155\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
3156\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
3157\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
3158\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
3159\ref test_modules_Diffusion_Diffusion1D_KBA_lua
3160\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
3161\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
3162\author Jan*/
3163void chiDiffusionSetProperty(int SolverHandle, string PropertyName, varying Values){}
3164//modules/DiffusionSolver/lua/diffusion_execute.cc
3165/** Initialize the Diffusion solver.
3166 *
3167\param SolverHandle int Handle to an existing diffusion solver.
3168
3169\return Success bool Returns if initialization failed.
3170\ingroup LuaDiffusion
3171### Usage Examples:
3172\ref test_modules_Diffusion_Diffusion1D_IP_lua
3173\ref test_modules_Diffusion_Diffusion1D_lua
3174\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
3175\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
3176\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
3177\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
3178\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
3179\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
3180\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
3181\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
3182\ref test_modules_Diffusion_Diffusion1D_KBA_lua
3183\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
3184\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
3185\author Jan*/
3186Success chiDiffusionExecute(int SolverHandle){}
3187//modules/DiffusionSolver/lua/diffusion_maindoc_page.cc
3188//modules/DiffusionSolver/lua/diffusion_initialize.cc
3189/** Initialize the Diffusion solver.
3190 *
3191\param SolverHandle int Handle to an existing diffusion solver.
3192
3193\return Success bool Returns if initialization failed.
3194\ingroup LuaDiffusion
3195### Usage Examples:
3196\ref test_modules_Diffusion_Diffusion1D_IP_lua
3197\ref test_modules_Diffusion_Diffusion1D_lua
3198\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
3199\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
3200\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
3201\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
3202\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
3203\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
3204\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
3205\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
3206\ref test_modules_Diffusion_Diffusion1D_KBA_lua
3207\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
3208\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
3209\author Jan*/
3210Success chiDiffusionInitialize(int SolverHandle){}
3211//modules/DiffusionSolver/lua/diffusion_lua.cc
3212//modules/DFEMDiffusion/lua/create_solver.cc
3213/** Creates a DFEM Diffusion solver based on the interior penalty method.
3214
3215\return Handle int Handle to the created solver.
3216\ingroup LuaDiffusion
3217### Usage Examples:
3218\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
3219\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
3220\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
3221\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
3222\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
3223*/
3225//modules/DFEMDiffusion/lua/ip_lua_utils.cc
3226//modules/DFEMDiffusion/lua/setBCproperty.cc
3227/** Sets a property of a Diffusion solver. Please also consult the whitepaper
3228 * for the Diffusion solver (<a
3229 * href="../../whitepages/DiffusionSolver/DiffusionSolver.pdf">
3230 * Diffusion Whitepaper</a>)
3231
3232\n\n Additional basic options can be set as indicated in \ref LuaDiffusionBasicOptions
3233
3234\param SolverHandle int Handle to an existing diffusion solver.
3235\param PropertyName string Name for a specific property.
3236\param Values varying Number of inputs associated with the index.<br>
3237
3238##_
3239
3240###PropertyName\n
3241"boundary_type"\n
3242 Boundary type. Expects boundary index then <B>BoundaryTypeName</B>
3243 then type value.\n\n
3244
3245\code
3246chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)
3247\endcode
3248
3249### BoundaryTypeName
3250reflecting\n
3251 Reflecting boundary conditions. Synonymous with Neumann with a
3252 derivative of 0.0.
3253 \f[ -D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3254
3255dirichlet\n
3256 Constant value boundary condition.
3257 Expects to be followed by a value \f$ f \f$ associated with \f$ \phi \f$.
3258 \f[ \phi = f \f]\n\n
3259
3260neumann\n
3261 Constant derivative boundary condition. Expects to be followed
3262 by a constant \f$ f \f$ representing
3263 \f[ -D \hat{n}\cdot \nabla \phi = f \f]\n\n
3264
3265vacuum\n
3266 Vacuum boundary conditions. More appropriate to neutron diffusion.
3267 \f[ \frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0 \f]\n\n
3268
3269robin\n
3270 Robin boundary condition of the form
3271 \f[ a \phi + b D \hat{n}\cdot \nabla \phi = f \f]\n\n
3272
3273\ingroup LuaDiffusion
3274### Usage Examples:
3275\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
3276\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
3277\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
3278\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
3279\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
3280\author Jan*/
3281void chiDFEMDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values){}
3282//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_lua_utils.cc
3283//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_init_materials.cc
3284/**Initializes or reinitializes the materials. This normally happens
3285 * automatically during solver initialization but if the user wants to
3286 * swap/change XSs during the run then this will allow the material structures
3287 * to now deal with the new/changed materials.
3288 *
3289\param SolverIndex int Handle to the solver maintaining the information.
3290
3291\ingroup LBSLuaFunctions
3292### Usage Examples:
3293\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3294\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3295\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3296\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3297\author Jan*/
3298void chiLBSInitializeMaterials(int SolverIndex){}
3299//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_point_sources.cc
3300/**Adds a point source to an LBS solver.
3301\param SolverIndex int Handle to the solver.
3302\param Location_x double X-location.
3303\param Location_y double Y-location.
3304\param Location_z double Z-location.
3305\param Strength table Source strength as a multigroup vector.
3306
3307 \ingroup LBSLuaFunctions
3308### Usage Examples:
3309\ref test_framework_tutorials_tutorial_93_raytracing_lua
3310\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
3311\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
3312\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
3313\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
3314 */
3315void chiLBSAddPointSource(int SolverIndex, double Location_x, double Location_y, double Location_z, table Strength){}
3316/**Clears all the point sources from the solver. This is mostly
3317 * useful for adjoint response calculations.
3318\param SolverIndex int Handle to the solver.
3319
3320 \ingroup LBSLuaFunctions
3321 */
3322void chiLBSClearPointSources(int SolverIndex){}
3323/**Initializes the point sources. This is mostly
3324 * useful for adjoint response calculations.
3325\param SolverIndex int Handle to the solver.
3326
3327 \ingroup LBSLuaFunctions
3328 */
3329void chiLBSInitializePointSources(int SolverIndex){}
3330//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_io_angular_fluxes.cc
3331/**Writes the angular fluxes of a LBS groupset to file.
3332
3333\param SolverIndex int Handle to the solver for which the group
3334is to be created.
3335
3336\param GroupsetIndex int Index to the groupset to which this function should
3337 apply
3338
3339\param file_base string Path+Filename_base to use for the output. Each location
3340 will append its id to the back plus an extension ".data"
3341
3342*/
3343void chiLBSWriteGroupsetAngularFlux(int SolverIndex, int GroupsetIndex, string file_base){}
3344/**Reads the angular fluxes of a LBS groupset from a file.
3345
3346\param SolverIndex int Handle to the solver for which the group
3347is to be created.
3348
3349\param GroupsetIndex int Index to the groupset to which this function should
3350 apply
3351
3352\param file_base string Path+Filename_base to use for the output. Each location
3353 will append its id to the back plus an extension ".data"
3354
3355*/
3356void chiLBSReadGroupsetAngularFlux(int SolverIndex, int GroupsetIndex, string file_base){}
3357//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_setproperty.cc
3358/**Set LBS property.
3359\param SolverIndex int Handle to the solver for which the set is to be created.
3360\param PropertyIndex int Code for a specific property.
3361
3362
3363##_
3364
3365###PropertyIndex
3366DISCRETIZATION_METHOD\n
3367 Discretization method.\n\n
3368
3369BOUNDARY_CONDITION\n
3370 Boundary condition type. See BoundaryIdentify.\n\n
3371
3372SCATTERING_ORDER\n
3373 Defines the level of harmonic expansion for the scattering source.Default 1.
3374 Expects to be followed by an integer.\n\n
3375
3376SWEEP_EAGER_LIMIT\n
3377 The eager limit to be used in message size during sweep initialization.
3378 This expects to be followed by a size in bytes (Max 64,0000).Default 32,000.
3379 See note below.\n\n
3380
3381READ_RESTART_DATA\n
3382 Indicates the reading of restart data from restart file.
3383 The value can be followed by two
3384 optional strings. The first is the folder name which can be relative or
3385 absolute, and the second is the file base name. These are defaulted to
3386 "YRestart" and "restart" respectively.\n\n
3387
3388SAVE_ANGULAR_FLUX\n
3389Sets the flag for saving the angular flux. Expects to be followed by true/false.
3390[Default=false]\n\n
3391
3392USE_SOURCE_MOMENTS\n
3393 Flag for using a vector of source moments instead the regular material/boundary
3394 source. Default false. This expects
3395 to be followed by a boolean.\n\n
3396
3397VERBOSE_INNER_ITERATIONS\n
3398 Flag for printing inner iteration information. This is primarily used
3399 for printing information related to group-set-level iterative methods.
3400 Default true. Expects to be followed by a boolean.\n\n
3401
3402VERBOSE_OUTER_ITERATIONS\n
3403 Flag for printing outer iteration information. This is primarily used
3404 for printing information aggregated over group sets such as k-eigenvalue
3405 iterations. Default true. Expects to be followed by a boolean.\n\n
3406
3407USE_PRECURSORS\n
3408 Flag for using delayed neutron precursors. Default false. This expects
3409 to be followed by a boolean.\n\n
3410
3411\code
3412chiLBSSetProperty(phys1,READ_RESTART_DATA,"YRestart1")
3413\endcode
3414
3415WRITE_RESTART_DATA\n
3416 Indicates the writing of restart data to restart files.
3417 The value can be followed by two optional strings and a number
3418 optional strings. The first string is the folder name which can be relative or
3419 absolute, and the second string is the file base name. The number is the time
3420 interval (in minutes) for a restart write to be triggered (apart from GMRES
3421 restarts and the conclusion of groupset completions) .These are defaulted to
3422 "YRestart", "restart" and 30 minutes respectively.\n\n
3423
3424\code
3425chiLBSSetProperty(phys1,WRITE_RESTART_DATA,"YRestart1","restart",1)
3426\endcode
3427
3428###Discretization methods
3429 PWLD = Piecewise Linear Finite Element.\n
3430
3431###BoundaryIdentify
3432This value follows the argument BOUNDARY_CONDITION and identifies which
3433boundary is under consideration. Right now only boundaries aligned with
3434cartesian axes are considered. Followed by LBSBoundaryType.\n
3435XMAX = Right boundary \n
3436XMIN = Left boundary \n
3437YMAX = Front boundary \n
3438YMIN = Back boundary \n
3439ZMAX = Top boundary \n
3440ZMIN = Bottom boundary \n
3441
3442###LBSBoundaryType
3443Specifies the type of boundary. Depending on the type this argument needs
3444to be followed by one or more values. Note: By default all boundaries are
3445type VACUUM.\n
3446\n
3447LBSBoundaryTypes.VACUUM\n
3448Specifies a vaccuum boundary condition. It is not followed by any value.\n
3449\code
3450chiLBSSetProperty(phys1,BOUNDARY_CONDITION,XMIN,
3451 LBSBoundaryTypes.VACUUM);
3452\endcode
3453\n
3454LBSBoundaryTypes.INCIDENT_ISOTROPIC\n
3455Incident isotropic flux. This argument needs to be followed by a lua table
3456index 1 to G where G is the amount of energy groups. Note internally this
3457is mapped as 0 to G-1.\n
3458\code
3459bsrc={}
3460for g=1,num_groups do
3461 bsrc[g] = 0.0
3462end
3463bsrc[1] = 1.0
3464chiLBSSetProperty(phys1,BOUNDARY_CONDITION,XMIN,
3465 LBSBoundaryTypes.INCIDENT_ISOTROPIC, bsrc);
3466\endcode
3467\n
3468LBSBoundaryTypes.REFLECTING\n
3469Reflecting boundary condition. Beware, when opposing reflecting boundary
3470conditions are used this enduces a cyclic dependency which will increase the
3471iteration convergence behavior.\n
3472\code
3473chiLBSSetProperty(phys1,BOUNDARY_CONDITION,XMIN,
3474 LBSBoundaryTypes.REFLECTING);
3475\endcode
3476\n
3477LBSBoundaryTypes.INCIDENT_ANISTROPIC_HETEROGENEOUS\n
3478Expects to be followed by the name of a lua function. The lua function will get
3479called with the following parameters:
3480```
3481size_t cell_global_id,
3482int cell_material_id,
3483unsigned int face_index,
3484unsigned int face_node_index,
3485const chi_mesh::Vector3& face_node_location,
3486const chi_mesh::Vector3& face_node_normal,
3487const std::vector<int>& quadrature_angle_indices,
3488const std::vector<chi_mesh::Vector3>& quadrature_angle_vectors,
3489const std::vector<std::pair<double,double>>& quadrature_phi_theta_angles,
3490const std::vector<int>& group_indices,
3491double evaluation_time;
3492```
3493and must return a 1D array of data-values ordered first by angle index, then
3494by group index, e.g., n0g0, n0g1, n0g2, n1g0, n1g1, n1g2, etc.
3495
3496Example lua function:
3497\code
3498function luaBoundaryFunctionA(cell_global_id,
3499 material_id,
3500 location,
3501 normal,
3502 quadrature_angle_indices,
3503 quadrature_angle_vectors,
3504 quadrature_phi_theta_angles,
3505 group_indices)
3506 num_angles = rawlen(quadrature_angle_vectors)
3507 num_groups = rawlen(group_indices)
3508 psi = {}
3509 dof_count = 0
3510
3511 for ni=1,num_angles do
3512 omega = quadrature_angle_vectors[ni]
3513 phi_theta = quadrature_phi_theta_angles[ni]
3514 for gi=1,num_groups do
3515 g = group_indices[gi]
3516
3517 value = 1.0
3518
3519 dof_count = dof_count + 1
3520 psi[dof_count] = value
3521 end
3522 end
3523
3524 return psi
3525end
3526
3527chiLBSSetProperty(phys1,BOUNDARY_CONDITION,XMIN,
3528 LBSBoundaryTypes.INCIDENT_ANISTROPIC_HETEROGENEOUS,
3529 "luaBoundaryFunctionA");
3530\endcode
3531
3532
3533###Note on the Eager limit
3534The eager limit is the message size limit before which non-blocking MPI send
3535calls will execute without waiting for a matching receive call. The limit is
3536platform dependent but in general 64 kb. Some systems have 32 kb as a limit
3537and therefore we use that as a default limit in ChiTech. There is a fine
3538interplay between message size and the shear amount of messages that will be
3539sent. In general smaller messages tend to be more efficient, however, when
3540there are too many small messages being sent around the communication system
3541on the given platform will start to suffer. One can gain a small amount of
3542parallel efficiency by lowering this limit, however, there is a point where
3543the parallel efficiency will actually get worse so use with caution.
3544
3545### Usage Examples:
3546\ref test_framework_tutorials_tutorial_93_raytracing_lua
3547\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3548\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3549\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3550\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3551\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3552\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3553\ingroup LBSLuaFunctions*/
3554void chiLBSSetProperty(int SolverIndex, int PropertyIndex){}
3555//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_getfieldfuncs.cc
3556/**Obtains a list of field functions, related only to scalar flux,
3557from the transport solver.
3558
3559\param SolverIndex int Handle to the solver for which the list is to be
3560obtained.
3561
3562\return Pair Table and count. Returns an array of handles and the amount of
3563### Usage Examples:
3564\ref test_framework_tutorials_tutorial_93_raytracing_lua
3565\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3566\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
3567\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1a_QBlock_lua
3568\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP2D_1b_QBlock_lua
3569\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
3570\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
3571\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
3572\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
3573\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
3574\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
3575\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
3576\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
3577\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
3578\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
3579\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
3580\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
3581\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
3582\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
3583\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
3584\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
3585\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
3586\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
3587\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
3588\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
3589\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
3590\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
3591\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
3592\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
3593\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_CBC_lua
3594\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1c_QBlock_lua
3595\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_CBC_lua
3596\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_lua
3597\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1b_QBlock_CBC_lua
3598\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport2D_1a_QBlock_lua
3599\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
3600\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
3601\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
3602elements in it (indexed from 1). \ingroup LBSLuaFunctions \author Jan*/
3604//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_groupset_ops.cc
3605/**Create a groupset.
3606\param SolverIndex int Handle to the solver for which the set is to be created.
3607
3608##_
3609
3610Example:
3611\code
3612gs0 = chiLBSCreateGroupset(phys1)
3613\endcode
3614
3615\ingroup LuaLBSGroupsets
3616### Usage Examples:
3617\ref test_framework_tutorials_tutorial_93_raytracing_lua
3618\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3619\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3620\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3621\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3622\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3623\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3624*/
3625void chiLBSCreateGroupset(int SolverIndex){}
3626/**Create a group.
3627\param SolverIndex int Handle to the solver for which the group
3628is to be created.
3629\param GroupId int Optional. If not supplied the next logical number
3630 is assigned.
3631
3632##_
3633
3634Example:
3635\code
3636--========== Groups
3637grp = {}
3638for g=1,num_groups do
3639 grp[g] = chiLBSCreateGroup(phys1)
3640end
3641\endcode
3642
3643\ingroup LuaLBSGroupsets
3644### Usage Examples:
3645\ref test_framework_tutorials_tutorial_93_raytracing_lua
3646\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3647\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3648\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3649\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3650\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3651\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3652*/
3653void chiLBSCreateGroup(int SolverIndex, int GroupId){}
3654/**Adds a block of groups to a groupset.
3655\param SolverIndex int Handle to the solver for which the group
3656is to be created.
3657\param GroupsetIndex int Handle to the groupset to which the group is
3658 to be added.
3659\param FromIndex int From which group.
3660\param ToIndex int To which group.
3661
3662##_
3663
3664Example:
3665\code
3666grp = {}
3667for g=1,num_groups do
3668 grp[g] = chiLBSCreateGroup(phys1)
3669end
3670
3671chiLBSGroupsetAddGroups(phys1,cur_gs,0,15)
3672\endcode
3673
3674
3675\ingroup LuaLBSGroupsets
3676### Usage Examples:
3677\ref test_framework_tutorials_tutorial_93_raytracing_lua
3678\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3679\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3680\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3681\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3682\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3683\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3684*/
3685void chiLBSGroupsetAddGroups(int SolverIndex, int GroupsetIndex, int FromIndex, int ToIndex){}
3686/**Sets the product quadrature used for the groupset
3687\param SolverIndex int Handle to the solver for which the group
3688is to be created.
3689\param GroupsetIndex int Handle to the groupset to which the group is
3690 to be added.
3691\param QuadratureIndex int Handle to the quadrature to be set for this
3692 groupset.
3693
3694
3695##_
3696
3697Example:
3698\code
3699pquad0 = chiCreateProductQuadrature(GAUSS_LEGENDRE_CHEBYSHEV,2, 2)
3700
3701chiLBSGroupsetSetQuadrature(phys1,cur_gs,pquad0)
3702\endcode
3703
3704\ingroup LuaLBSGroupsets
3705### Usage Examples:
3706\ref test_framework_tutorials_tutorial_93_raytracing_lua
3707\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3708\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3709\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3710\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3711\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3712\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3713*/
3714void chiLBSGroupsetSetQuadrature(int SolverIndex, int GroupsetIndex, int QuadratureIndex){}
3715/**Sets the the type of angle aggregation to use for this groupset.
3716\param SolverIndex int Handle to the solver for which the group
3717is to be created.
3718
3719\param GroupsetIndex int Index to the groupset to which this function should
3720 apply
3721\param AggregationType int See AggregationType.
3722
3723##_
3724
3725###AggregationType
3726LBSGroupset.ANGLE_AGG_POLAR\n
3727 Use Polar angle aggregation. This is the default.\n\n
3728
3729LBSGroupset.ANGLE_AGG_SINGLE\n
3730 Use Single angle aggregation.\n\n
3731
3732LBSGroupset.ANGLE_AGG_AZIMUTHAL\n
3733 Use Azimuthal angle aggregation.\n\n
3734
3735Example:
3736\code
3737chiLBSGroupsetSetAngleAggregationType(phys1,cur_gs,LBSGroupset.ANGLE_AGG_POLAR)
3738\endcode
3739
3740\ingroup LuaLBSGroupsets
3741### Usage Examples:
3742\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3743*/
3744void chiLBSGroupsetSetAngleAggregationType(int SolverIndex, int GroupsetIndex, int AggregationType){}
3745/**Sets the angle aggregation divisions
3746\param SolverIndex int Handle to the solver for which the group
3747is to be created.
3748\param GroupsetIndex int Handle to the groupset to which the group is
3749 to be added.
3750\param NumDiv int Number of divisions to use for the angle aggregation.
3751
3752Note: by default polar aggregation will combine all polar angles in a hemisphere
3753 for a given azimuthal angleset. Therefore if there are 24 polar angles and
3754 4 azimuthal angles the default polar aggregation will create 8 anglesets
3755 (2 per quadrant to allow top and bottom hemisphere) and each angleset will have the
3756 12 polar angles associated with a hemisphere. When the number of divisions is
3757 greater than 1 then the polar angles will be split into divisions. For example
3758 if the number of divisions is 2 then more angleset will be created, this time
3759 having 6 polar angles per angleset.
3760
3761##_
3762
3763Example:
3764\code
3765chiLBSGroupsetSetAngleAggDiv(phys1,cur_gs,1)
3766\endcode
3767
3768\ingroup LuaLBSGroupsets
3769### Usage Examples:
3770\ref test_framework_tutorials_tutorial_93_raytracing_lua
3771\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3772\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3773\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3774\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3775\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3776*/
3777void chiLBSGroupsetSetAngleAggDiv(int SolverIndex, int GroupsetIndex, int NumDiv){}
3778/**Sets the number of group-subsets to use for groupset. Default 1.
3779\param SolverIndex int Handle to the solver for which the group
3780is to be created.
3781
3782\param GroupsetIndex int Index to the groupset to which this function should
3783 apply
3784\param NumDiv int Number of divisions of the groupset to use.
3785
3786##_
3787
3788Example:
3789\code
3790chiLBSGroupsetSetGroupSubsets(phys1,cur_gs,1)
3791\endcode
3792
3793\ingroup LuaLBSGroupsets
3794### Usage Examples:
3795\ref test_framework_tutorials_tutorial_93_raytracing_lua
3796\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3797\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3798\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3799\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3800\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3801*/
3802void chiLBSGroupsetSetGroupSubsets(int SolverIndex, int GroupsetIndex, int NumDiv){}
3803/**Sets the number of group-subsets to use for groupset. Default 1.
3804\param SolverIndex int Handle to the solver for which the group
3805is to be created.
3806
3807\param GroupsetIndex int Index to the groupset to which this function should
3808 apply
3809\param IterativeMethod int Iteritve method identifier.
3810
3811##_
3812
3813### IterativeMethod
3814NPT_CLASSICRICHARDSON\n
3815Standard source iteration, without using PETSc.\n\n
3816
3817NPT_CLASSICRICHARDSON_CYCLES\n
3818Standard source iteration, without using PETSc,
3819with cyclic dependency convergence.\n\n
3820
3821NPT_GMRES\n
3822Legacy Generalized Minimal Residual formulation for iterations.\n\n
3823
3824NPT_GMRES_CYCLES\n
3825Legacy Generalized Minimal Residual formulation for iterations with cyclic
3826dependency convergence.\n\n
3827
3828
3829KRYLOV_RICHARDSON\n
3830Richardson iteration.\n\n
3831
3832KRYLOV_RICHARDSON_CYCLES\n
3833Richardson iteration with cyclic dependency convergence.\n\n
3834
3835KRYLOV_GMRES\n
3836Generalized Minimal Residual method.\n\n
3837
3838KRYLOV_GMRES_CYCLES\n
3839Generalized Minimal Residual method with cyclic dependency convergence.\n\n
3840
3841KRYLOV_BICGSTAB\n
3842Biconjugate Gradient Stabilized method.\n\n
3843
3844KRYLOV_BICGSTAB_CYCLES\n
3845Biconjugate Gradient Stabilized method with cyclic dependency convergence.\n\n
3846
3847
3848##_
3849
3850### Notes on selecting iterative methods
3851The iterative methods NPT_CLASSICRICHARDSON, NPT_CLASSICRICHARDSON_CYCLES,
3852NPT_GMRES and NPT_GMRES_CYCLES are considered legacy. The NPT_GMRES and
3853NPT_GMRES_CYCLES are now considered deprecated with the inclusion of the
3854generalized Krylov iteration method-class (which supports all the options
3855prepended with KRYLOV_).
3856
3857RICHARDSON is probably the least memory consuming but has the poorest
3858convergence rate.
3859
3860GMRES generally has the best convergence rate but it builds a basis
3861comprising multiple solutions vectors, the amount of which is controlled via
3862the gmres-restart parameter, which can dramatically increase memory consumption.
3863GMRES restarts, i.e. the amount of iterations before the basis is destroyed and
3864restarted, influences both memory consumptions and convergence behavior, e.g.,
3865lower restart numbers generally lowers memory consumption but increases the
3866amount of iteration required to convergence.
3867
3868The required memory and the computational time for one iteration with BiCGStab
3869is constant, i.e., the time and memory requirements do not increase with the
3870number of iterations as they do for restarted GMRES. BiCGStab uses approximately
3871the same amount of memory as GMRES uses for two iterations. Therefore, BiCGStab
3872typically uses less memory than GMRES. The convergence behavior of BiCGStab is
3873often more irregular than that of GMRES. Intermediate residuals can even be
3874orders of magnitude larger than the initial residual, which can affect the
3875numerical accuracy as well as the rate of convergence. If the algorithm detects
3876poor accuracy in the residual or the risk of stagnation, it restarts the
3877iterations with the current solution as the initial guess. In contrast to GMRES,
3878BiCGStab uses two matrix-vector multiplications each iteration (requiring two
3879transport sweeps). Also, when using the left-preconditioned BiCGStab, an
3880additional preconditioning step is required each iteration. That is,
3881left-preconditioned BiCGStab requires a total of three preconditioning steps in
3882each iteration. We generally apply Within-group Diffusion Synthetic Acceleration
3883(WGDSA) and Two-Grid Acceleration (TGDSA) as left-preconditioners and therefore
3884the total cost of these pre-conditioners will increase when using BiCGStab. Use
3885BiCGStab when you are running problem with a high scattering order (i.e., L is
3886large) because this will dramatically increase the GMRES basis.
3887
3888Example:
3889\code
3890chiLBSGroupsetSetIterativeMethod(phys1,cur_gs,NPT_CLASSICRICHARDSON)
3891chiLBSGroupsetSetIterativeMethod(phys1,cur_gs,NPT_GMRES)
3892\endcode
3893
3894\ingroup LuaLBSGroupsets
3895### Usage Examples:
3896\ref test_framework_tutorials_tutorial_93_raytracing_lua
3897\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3898\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3899\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3900\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3901\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3902\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3903\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
3904*/
3905void chiLBSGroupsetSetIterativeMethod(int SolverIndex, int GroupsetIndex, int IterativeMethod){}
3906/**Sets the residual tolerance for the iterative method of the groupset.
3907 *
3908\param SolverIndex int Handle to the solver for which the group
3909is to be created.
3910
3911\param GroupsetIndex int Index to the groupset to which this function should
3912 apply
3913\param ResidualTol float residual tolerance (default 1.0e-6)
3914
3915Note this tolerance also gets used for classic-richardson pointwise convergence
3916tolerance.
3917
3918##_
3919
3920Example:
3921\code
3922chiLBSGroupsetSetResidualTolerance(phys1,cur_gs,1.0e-4)
3923\endcode
3924
3925\ingroup LuaLBSGroupsets
3926### Usage Examples:
3927\ref test_framework_tutorials_tutorial_93_raytracing_lua
3928\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3929\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3930\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3931\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3932\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3933\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3934*/
3935void chiLBSGroupsetSetResidualTolerance(int SolverIndex, int GroupsetIndex, float ResidualTol){}
3936/**Sets the maximum number of iterations for the groupset iterative method.
3937\param SolverIndex int Handle to the solver for which the group
3938is to be created.
3939
3940\param GroupsetIndex int Index to the groupset to which this function should
3941 apply
3942\param Numiter int Maximum number of iterations. Default 1000.
3943
3944##_
3945
3946Example:
3947\code
3948chiLBSGroupsetSetMaxIterations(phys1,cur_gs,200)
3949\endcode
3950
3951\ingroup LuaLBSGroupsets
3952### Usage Examples:
3953\ref test_framework_tutorials_tutorial_93_raytracing_lua
3954\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3955\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3956\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3957\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3958\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3959\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3960\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_c5g7_lua
3961*/
3962void chiLBSGroupsetSetMaxIterations(int SolverIndex, int GroupsetIndex, int Numiter){}
3963/**Sets the restart interval for GMRES if applied to the groupset.
3964\param SolverIndex int Handle to the solver for which the group
3965is to be created.
3966
3967\param GroupsetIndex int Index to the groupset to which this function should
3968 apply
3969\param Intvl int Interval to use for GMRES restarts. Default 30.
3970
3971##_
3972
3973Example:
3974\code
3975chiLBSGroupsetSetGMRESRestartIntvl(phys1,cur_gs,15)
3976\endcode
3977
3978\ingroup LuaLBSGroupsets
3979### Usage Examples:
3980\ref test_framework_tutorials_tutorial_93_raytracing_lua
3981\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
3982\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
3983\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
3984\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
3985\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
3986\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
3987*/
3988void chiLBSGroupsetSetGMRESRestartIntvl(int SolverIndex, int GroupsetIndex, int Intvl){}
3989/**Enables or disables the printing of a sweep log.
3990\param SolverIndex int Handle to the solver for which the group
3991is to be created.
3992
3993\param GroupsetIndex int Index to the groupset to which this function should
3994 apply
3995\param flag bool Flag indicating whether to print sweep log. Default false.
3996
3997##_
3998
3999Example:
4000\code
4001chiLBSGroupsetSetEnableSweepLog(phys1,cur_gs,true)
4002\endcode
4003
4004\ingroup LuaLBSGroupsets
4005*/
4006void chiLBSGroupsetSetEnableSweepLog(int SolverIndex, int GroupsetIndex, bool flag){}
4007/**Sets the Within-Group Diffusion Synthetic Acceleration parameters
4008 * for this groupset. If this call is being made then it is assumed
4009 * WGDSA is being applied.
4010 *
4011\param SolverIndex int Handle to the solver for which the group
4012is to be created.
4013
4014\param GroupsetIndex int Index to the groupset to which this function should
4015 apply
4016\param MaxIters int Maximum amount of iterations to use for WGDSA solvers.
4017 Default 30.
4018\param ResTol float Residual tolerance to use for the WGDSA solve.
4019
4020\param Verbose bool Optional flag indicating verbose output of WGDSA.
4021 Default false.
4022\param PETSCString char Optional. Options string to be inserted
4023 during initialization.
4024
4025
4026
4027##_
4028
4029Example:
4030\code
4031petsc_options = " -pc_hypre_boomeramg_strong_threshold 0.8"
4032petsc_options = petsc_options .. " -pc_hypre_boomeramg_max_levels 25"
4033chiLBSGroupsetSetWGDSA(phys1,cur_gs,30,1.0e-4,false,petsc_options)
4034\endcode
4035
4036\ingroup LuaLBSGroupsets
4037### Usage Examples:
4038\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4039\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4040\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4041\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4042\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4043*/
4044void chiLBSGroupsetSetWGDSA(int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString){}
4045/**Sets the Two-Grid Diffusion Synthetic Acceleration parameters
4046 * for this groupset. If this call is being made then it is assumed
4047 * TGDSA is being applied.
4048 *
4049\param SolverIndex int Handle to the solver for which the group
4050is to be created.
4051
4052\param GroupsetIndex int Index to the groupset to which this function should
4053 apply
4054\param MaxIters int Maximum amount of iterations to use for TGDSA solvers.
4055 Default 30.
4056\param ResTol float Residual tolerance to use for the TGDSA solve.
4057
4058\param Verbose bool Optional flag indicating verbose output of TGDSA.
4059 Default false.
4060\param PETSCString char Optional. Options string to be inserted
4061 during initialization.
4062
4063
4064
4065##_
4066
4067Example:
4068\code
4069petsc_options = " -pc_hypre_boomeramg_strong_threshold 0.8"
4070petsc_options = petsc_options .. " -pc_hypre_boomeramg_max_levels 25"
4071chiLBSGroupsetSetTGDSA(phys1,cur_gs,30,1.0e-4,false,petsc_options)
4072\endcode
4073
4074\ingroup LuaLBSGroupsets
4075### Usage Examples:
4076\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4077\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4078\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4079\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4080\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4081*/
4082void chiLBSGroupsetSetTGDSA(int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString){}
4083//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_compute_fissrates.cc
4084/**Computes and returns the fission rate.
4085 *
4086\param SolverIndex int Handle to the solver maintaining the information.
4087\param OldNewOption string "NEW" or "OLD". For steady state solvers, the
4088 "OLD" option would give the fission rate for
4089 the previous iterate. [Default="NEW"]
4090
4091\return double The fission rate.
4092
4093\ingroup LBSLuaFunctions
4094### Usage Examples:
4095\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4096\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4097\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4098\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4099\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4100\author Jan*/
4101double chiLBSComputeFissionRate(int SolverIndex, string OldNewOption){}
4102//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_io_flux_moments.cc
4103/**Writes the flux-moments of a LBS solution to file (phi_old_local).
4104
4105\param SolverIndex int Handle to the solver for which the group
4106is to be created.
4107
4108\param file_base string Path+Filename_base to use for the output. Each location
4109 will append its id to the back plus an extension ".data"
4110
4111### Usage Examples:
4112\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
4113\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
4114\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
4115*/
4116void chiLBSWriteFluxMoments(int SolverIndex, string file_base){}
4117/**Creates scattered source-moments, based on a LBS solution, and writes them
4118 * to file.
4119
4120\param SolverIndex int Handle to the solver for which the group
4121is to be created.
4122
4123\param file_base string Path+Filename_base to use for the output. Each location
4124 will append its id to the back plus an extension ".data"
4125
4126### Usage Examples:
4127\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
4128*/
4129void chiLBSCreateAndWriteSourceMoments(int SolverIndex, string file_base){}
4130/**Reads flux-moments from a file and creates a scattering source from these
4131 * moments to be used instead of a regular material/boundary source.
4132
4133\param SolverIndex int Handle to the solver for which the group
4134is to be created.
4135
4136\param file_base string Path+Filename_base to use for the output. Each location
4137 will append its id to the back plus an extension ".data"
4138
4139\param single_file_flag bool (Optional) Flag indicating that the file is a
4140 single stand-alone file. The file_base will then
4141 be used without adding the location-id, but still
4142 with the ".data" appended. Default: false.
4143
4144*/
4145void chiLBSReadFluxMomentsAndMakeSourceMoments(int SolverIndex, string file_base, bool single_file_flag){}
4146/**Reads the source-moments from a file to a specific ext_src_moments_local-vector
4147 * to be used instead of a regular material/boundary source.
4148
4149\param SolverIndex int Handle to the solver for which the group
4150is to be created.
4151
4152\param file_base string Path+Filename_base to use for the output. Each location
4153 will append its id to the back plus an extension ".data"
4154
4155\param single_file_flag bool (Optional) Flag indicating that the file is a
4156 single stand-alone file. The file_base will then
4157 be used without adding the location-id, but still
4158 with the ".data" appended. Default: false.
4159### Usage Examples:
4160\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
4161*/
4162void chiLBSReadSourceMoments(int SolverIndex, string file_base, bool single_file_flag){}
4163/**Reads flux-moments from a file to phi_old_local (the initial flux solution).
4164
4165\param SolverIndex int Handle to the solver for which the group
4166is to be created.
4167
4168\param file_base string Path+Filename_base to use for the output. Each location
4169 will append its id to the back plus an extension ".data"
4170
4171\param single_file_flag bool (Optional) Flag indicating that the file is a
4172 single stand-alone file. The file_base will then
4173 be used without adding the location-id, but still
4174 with the ".data" appended. Default: false.
4175### Usage Examples:
4176\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
4177\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
4178\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
4179*/
4180void chiLBSReadFluxMoments(int SolverIndex, string file_base, bool single_file_flag){}
4181//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_lua_setphi_from_ff.cc
4182/**Sets the internal phi vector to the value in the associated
4183field function.
4184\param handle int Handle to the lbs-based object.
4185\param specs Table Various options in a table. Detailed below.
4186
4187##_
4188
4189### Example usage
4190Example:
4191\code
4192chiLBSSetPhiFromFieldFunction(phys1,
4193{
4194 which_phi = "old", --Optional
4195 m_ids = {0,1,2,3}, --Optional Empty means all of them
4196 g_ids = {} --Optional Empty means all of them
4197})
4198\endcode
4199
4200### Table keys
4201`which_phi`\n
4202<I>type=</I><span style="color: blue;"><TT>STRING</TT></span>
4203Optional. Can be "old" or "new". Denotes which phi version to copy to.
4204Default: `"old"`.\n\n
4205
4206`m_ids`\n
4207<I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>
4208Optional. Array of moment IDs. If this is empty all the moments will be copied.
4209Default: `{}`.\n\n
4210
4211`g_ids`\n
4212<I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>
4213Optional. Array of group IDs. If this is empty all the groups will be copied.
4214Default: `{}`.\n\n
4215
4216*/
4217void chiLBSSetPhiFromFieldFunction(int handle, Table specs){}
4218//modules/LinearBoltzmannSolvers/A_LBSSolver/lua/lbs_lua_setoptions.cc
4219//modules/LinearBoltzmannSolvers/C_DiscreteOrdinatesAdjointSolver/lua/lbsadj_lua_export_impmap_binary.cc
4221//modules/LinearBoltzmannSolvers/C_DiscreteOrdinatesAdjointSolver/lua/lbsadj_lua_innerprod.cc
4223//modules/LinearBoltzmannSolvers/C_DiscreteOrdinatesAdjointSolver/lua/lbsadj_lua_addresponsefunc.cc
4225//modules/LinearBoltzmannSolvers/C_DiscreteOrdinatesAdjointSolver/lua/lbsadj_lua_buffers.cc
4226/**Reads flux-moments file to a buffer and returns a handle to that buffer.
4227
4228\param SolverHandle int Handle to the relevant solver.
4229\param FileBaseName string The base-name of the file(s) from which to read
4230 the flux moments.
4231
4232\return handle int A handle that can be used with
4233 `chiAdjointSolverApplyFluxMomentBuffer`.*/
4234handle chiAdjointSolverReadFluxMomentsToBuffer(int SolverHandle, string FileBaseName){}
4235/**Applies buffered flux-moments data to the current phi-old.
4236
4237\param SolverHandle int Handle to the relevant solver.
4238\param BufferHandle int The handle to the buffer-position to be applied.
4239 */
4240void chiAdjointSolverApplyFluxMomentBuffer(int SolverHandle, int BufferHandle){}
4241//modules/LinearBoltzmannSolvers/C_DiscreteOrdinatesAdjointSolver/lua/lbsadj_lua_makeexprepfromP1.cc
4243//modules/LinearBoltzmannSolvers/B_DiscreteOrdinatesSolver/lua/lbs_compute_leakage.cc
4244/**Computes the leakage for the specified groupset and boundary id.
4245 *
4246\param SolverIndex int Handle to the solver.
4247\param GroupSetHandle int Handle to the groupset.
4248\param BoundaryID int Id of the boundary for which leakage is to be computed.
4249
4250\return The leakage on a per group basis.
4251
4252\ingroup LBSLuaFunctions
4253\author Jan*/
4254The chiLBSComputeLeakage(int SolverIndex, int GroupSetHandle, int BoundaryID){}
4255//modules/LinearBoltzmannSolvers/B_DiscreteOrdinatesSolver/lua/lbs_compute_balance.cc
4256/**Computes balance tables and prints it to the console.
4257 *
4258\param SolverIndex int Handle to the solver for which the list is to be
4259obtained.
4260
4261\ingroup LBSLuaFunctions
4262### Usage Examples:
4263\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
4264\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
4265\author Jan*/
4266void chiLBSComputeBalance(int SolverIndex){}
4267//modules/LinearBoltzmannSolvers/D_DO_Transient/lua/lbts_lua_advancetimedata.cc
4268/**Advances time dependent data to the next timestep.
4269
4270\param SolverIndex int Handle to the solver..
4271
4272
4273### Usage Examples:
4274\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4275\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4276\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4277\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4278\author Zachary Hardy*/
4279void chiLBTSAdvanceTimeData(int SolverIndex){}
4280//modules/LinearBoltzmannSolvers/D_DO_Transient/lua/lbts_lua_create_solver.cc
4281/**Creates a LBS-TransientSolver.
4282
4283\param SolverName string Optional. The text name of the solver.
4284 [Default="LBSTransientSolver"].
4285
4286### Usage Examples:
4287\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4288\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4289\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4290\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4291\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4292\author Zachary Hardy*/
4293void chiLBSCreateTransientSolver(string SolverName){}
4294//modules/LinearBoltzmannSolvers/D_DO_Transient/lua/lbts_lua_utils.cc
4295//modules/LinearBoltzmannSolvers/D_DO_Transient/lua/lbts_lua_setproperty.cc
4296/**Sets a property of the LBS-TransientSolver or any derived class.
4297
4298\param SolverIndex int Handle to the solver for which the set is to be created.
4299\param PropertyName string String name for a specific property.
4300
4301
4302##_
4303
4304##ProperyName
4305"TIMESTEP"\n
4306Expects to be followed by a floating point value representing the timestep.\n\n
4307
4308"TIME"\n
4309Sets the current time. [Default=0.0]\n\n
4310
4311"TIMESTOP"\n
4312Sets the termination time. [Default=0.1]\n\n
4313
4314"MAX_TIMESTEPS"\n
4315Sets the maximum number of timesteps during a call to Execute. A negative
4316value disable the logic to check for timestep-counters exceeding this amount.
4317[Default=10]\n\n
4318
4319"INHIBIT_ADVANCE"\n
4320Sets a flag that prevents the time from advancing. Can be used to reject a
4321timestep. [Default=false]\n\n
4322
4323"VERBOSITY_LEVEL"\n
4324Sets the verbosity level. Level 0, nothing gets printed. Level 1, basic info.
4325 [Default=1]\n\n
4326
4327"TIMESTEP_METHOD"\n
4328Sets the time-stepping method. Can be "CRANK_NICHOLSON" or "BACKWARD_EULER".
4329[Default="CRANK_NICHOLSON"]\n\n
4330
4331"CALLBACK"\n
4332Sets the timestep callback function. [Default=Nothing]\n\n
4333
4334"SCALE_FISSION_XS"\n
4335Sets a boolean flag to normalize the fission cross-sections by the
4336k-eigenvalue. [Default=false]\n\n
4337
4338"NORMALIZATION_METHOD"\n
4339Sets the initial data normalization data. Can be "TOTAL_POWER",
4340"POWER_DENSITY", or "NONE". [Default="TOTAL_POWER"]\n\n
4341
4342### Usage Examples:
4343\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4344\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4345\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4346\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4347\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4348\author Zachary Hardy*/
4349void chiLBTSSetProperty(int SolverIndex, string PropertyName){}
4350//modules/LinearBoltzmannSolvers/D_DO_Transient/lua/lbts_lua_getproperty.cc
4351/**Gets a property of a LBS-TransientSolver or any derived class.
4352
4353\param SolverIndex int Handle to the solver for which the set is to be created.
4354\param PropertyName string String name for a specific property.
4355
4356
4357##_
4358
4359##ProperyName
4360"TIMESTEP"\n
4361Returns the current timestep.\n\n
4362
4363"TIMESTOP"\n
4364Returns the stop time.\n\n
4365
4366"INHIBIT_ADVANCE"\n
4367Returns the flag.\n\n
4368
4369"TIME"\n
4370Returns the simulation time before the latest timestep.\n\n
4371
4372
4373### Usage Examples:
4374\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
4375\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
4376\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
4377\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
4378\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
4379\author Zachary Hardy*/
4380void chiLBTSGetProperty(int SolverIndex, string PropertyName){}
4381}//namespace chi_lua
void chiLBSComputeBalance(int SolverIndex)
void chiLBSSetProperty(int SolverIndex, int PropertyIndex)
void chiLBSInitializePointSources(int SolverIndex)
void chiLBSClearPointSources(int SolverIndex)
void chiLBSAddPointSource(int SolverIndex, double Location_x, double Location_y, double Location_z, table Strength)
double chiLBSComputeFissionRate(int SolverIndex, string OldNewOption)
void chiLBSInitializeMaterials(int SolverIndex)
Pair chiLBSGetScalarFieldFunctionList(int SolverIndex)
The chiLBSComputeLeakage(int SolverIndex, int GroupSetHandle, int BoundaryID)
Handle chiCFEMMGDiffusionSolverCreate()
Handle chiCFEMDiffusionSolverCreate()
void chiDFEMDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values)
Success chiDiffusionInitialize(int SolverHandle)
void chiCFEMDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values)
void chiDiffusionSetProperty(int SolverHandle, string PropertyName, varying Values)
void chiCFEMMGDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values)
Handle chiFVDiffusionSolverCreate(string solver_name)
void chiFVDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values)
Handle chiDFEMDiffusionSolverCreate()
Handle chiDiffusionCreateSolver()
Success chiDiffusionExecute(int SolverHandle)
void chiDecomposeSurfaceMeshPxPy(mesh Surface, int Px, int Py)
void chiFFInterpolationExportPython(int FFIHandle, char BaseName)
Handle chiFFInterpolationCreate(int FFITypeIndex)
void chiFFInterpolationExecute(int FFIHandle)
void chiFFInterpolationGetValue(int FFIHandle)
void chiFFInterpolationInitialize(int FFIHandle)
Handle chiFFInterpolationSetProperty(int FFIHandle, int PropertyIndex)
void chiLBSGroupsetAddGroups(int SolverIndex, int GroupsetIndex, int FromIndex, int ToIndex)
void chiLBSGroupsetSetEnableSweepLog(int SolverIndex, int GroupsetIndex, bool flag)
void chiLBSGroupsetSetQuadrature(int SolverIndex, int GroupsetIndex, int QuadratureIndex)
void chiLBSGroupsetSetTGDSA(int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString)
void chiLBSCreateGroup(int SolverIndex, int GroupId)
void chiLBSGroupsetSetMaxIterations(int SolverIndex, int GroupsetIndex, int Numiter)
void chiLBSGroupsetSetAngleAggDiv(int SolverIndex, int GroupsetIndex, int NumDiv)
void chiLBSGroupsetSetAngleAggregationType(int SolverIndex, int GroupsetIndex, int AggregationType)
void chiLBSGroupsetSetGroupSubsets(int SolverIndex, int GroupsetIndex, int NumDiv)
void chiLBSGroupsetSetResidualTolerance(int SolverIndex, int GroupsetIndex, float ResidualTol)
void chiLBSGroupsetSetWGDSA(int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString)
void chiLBSGroupsetSetIterativeMethod(int SolverIndex, int GroupsetIndex, int IterativeMethod)
void chiLBSCreateGroupset(int SolverIndex)
void chiLBSGroupsetSetGMRESRestartIntvl(int SolverIndex, int GroupsetIndex, int Intvl)
double chiLogProcessEvent(string event_name, string event_operation_name)
void chiLog(int LogType, char LogMsg)
void chiLogSetVerbosity(int int_level)
void chiLogPrintTimingGraph(int rank)
Sense chiLogicalVolumePointSense(int LVHandle, double Point_x, double Point_y, double Point_z)
Handle chiLogicalVolumeCreate(int TypeIndex, varying Values)
void chiLegendre(int N, double x)
void chiYlm(int ell, int m, double theta, double varphi)
void chiLegendreDerivative(int N, double x)
Handle chiMeshHandlerCreate()
void chiMeshHandlerExportMeshToObj(char FileName, bool ExportByMaterial)
void chiMeshHandlerSetCurrent(int HandlerHandler)
void chiMeshHandlerExportMeshToExodus(char FileName, bool suppress_nodesets, bool suppress_sidesets)
void chiMeshHandlerExportMeshToVTK(char FileName)
Two chiMeshCreateUnpartitioned3DOrthoMesh(array_float x_nodes, array_float y_nodes, array_float z_nodes)
Two chiMeshCreateUnpartitioned2DOrthoMesh(array_float x_nodes, array_float y_nodes)
Two chiMeshCreateUnpartitioned1DOrthoMesh(array_float x_nodes)
MaterialHandle chiPhysicsAddMaterial(char Name)
void chiPhysicsMaterialAddProperty(int MaterialHandle, int PropertyIndex)
Lua chiPhysicsMaterialGetProperty(int MaterialHandle, int PropertyIndex)
void chiPhysicsMaterialSetProperty(int MaterialHandle, int PropertyIndex, int OperationIndex, varying Information)
Returns chiCreateSphericalProductQuadrature(int QuadratureType, varying values)
Returns chiCreateCylindricalProductQuadrature(int QuadratureType, varying values)
Returns chiCreateProductQuadrature(int QuadratureType, varying values)
void chiOptimizeAngularQuadratureForPolarSymmetry(in handle, double normalization)
Table chiGetProductQuadrature(int QuadHandle)
Returns chiCreateLineQuadrature(int QuadratureType, int NumberOfPoints, bool VerboseFlag)
Returns chiCreateCustomAngularQuadrature(array azimuthal_angles, array polar_angles, array weight)
void chiPrintToPythonSLDFESQAngularQuadrature(int handle, string file_name_prefix)
void chiCreateSLDFESQAngularQuadrature(int initial_refinement_level)
void chiLocallyRefineSLDFESQAngularQuadrature(in handle, vec3 reference_direction, double cone_size, bool invert_logic)
Handle chiSurfaceMeshCreate()
success chiSurfaceMeshImportFromOBJFile(int SurfaceHandle, string FileName, bool polyflag, table3 transform)
void chiSurfaceMeshCheckCycles(int SurfaceHandle, int NumAngles)
void chiSurfaceMeshExtractOpenEdgesToObj(int SurfaceHandle, char FileName)
void chiSurfaceMeshExportToObj(int SurfaceHandle, char *FileName)
void chiSurfaceMeshExportPolyFile(int SurfaceHandle, char *FileName)
success chiSurfaceMeshImportFromTriangleFiles(int SurfaceHandle, char *FileName, bool polyflag)
void chiComputeLoadBalancing(int SurfaceHandle, table Xcuts, table Ycuts)
void chiSurfaceMesherCreate(int SurfaceMesherType)
void chiSurfaceMesherSetProperty(int PropertyNumber, varying PropertyValue)
void chiSurfaceMesherExecute()
void chiPhysicsTransportXSExportToChiTechFormat(int XS_handle, string file_name)
void chiPhysicsTransportXSSetCombined(int XS_handle, table Combinations)
void chiPhysicsTransportXSSet(int XS_handle, int OperationIndex, varying Information)
Returns chiPhysicsTransportXSCreate()
void chiPhysicsTransportXSGet(int XS_handle)
Returns chiPhysicsTransportXSMakeCombined(table Combinations)
Handle chiUnpartitionedMeshFromWavefrontOBJ(char file_name)
void chiUnpartitionedMeshUploadVertex(int handle, double x, double y, double z)
Handle chiUnpartitionedMeshFromMshFormat(char file_name)
void chiUnpartitionedMeshFinalizeEmpty(int handle)
void chiCreateEmptyUnpartitionedMesh()
Handle chiUnpartitionedMeshFromExodusII(char file_name, float scale)
Handle chiUnpartitionedMeshFromVTU(char file_name, char field)
void chiUnpartitionedMeshUploadCell(int handle, lua_table cell_table)
void chiDestroyUnpartitionedMesh(int handle)
Handle chiUnpartitionedMeshFromPVTU(char file_name, char field)
Handle chiUnpartitionedMeshFromEnsightGold(char file_name, float scale)
void chiVolumeMesherSetKBACutsX()
void chiVolumeMesherSetProperty(int PropertyIndex, varying PropertyValue)
void chiVolumeMesherSetKBAPartitioningPxPyPz(int Px, int Py, int Pz)
void chiVolumeMesherSetMatIDToAll(int material_id)
void chiVolumeMesherCreate(int Type, varying OtherArgs)
void chiVolumeMesherExecute()
void chiVolumeMesherSetKBACutsZ()
void chiVolumeMesherSetKBACutsY()
void chiVolumeMesherSetupOrthogonalBoundaries()
void chiMPIBarrier()
void chiSolverGetInfo(int solver_handle, varying info)
void chiSolverSetBasicOption(int solver_handle, string option_name, varying option_value)
void chiSolverExecute(int solver_handle)
void chiSolverStep(int solver_handle)
void chiSolverGetName(int solver_handle)
void chiSolverSetProperties(int handle, Table property_table)
void chiSolverInitialize(int solver_handle)
Definition: lua_functions.c:92
void chiSolverCreate(ParameterBloc params)
Definition: lua_functions.c:17
void chiSolverAdvance(int solver_handle)
void chiSolverGetFieldFunctionList(int SolverHandle)
void chiSurfaceMeshImportFromMshFiles()
Varying * chiPRKSetParam(int handle, string param_name, Varying value)
void chiLBTSGetProperty(int SolverIndex, string PropertyName)
void chiLBSReadFluxMomentsAndMakeSourceMoments(int SolverIndex, string file_base, bool single_file_flag)
void chiLBSWriteFluxMoments(int SolverIndex, string file_base)
void chiLBSSetPhiFromFieldFunction(int handle, Table specs)
void chiAdjointSolverExportImportanceMapBinary()
Varying * chiPRKGetParam(int handle, string param_name)
void chiFieldOperationExecute(int handle)
void chiFunctionDimAToDimBEvaluate()
void chiMakeObjectType()
void chiLBSCreateTransientSolver(string SolverName)
void chiCutMesh(Vec3 PlanePoint, Vec3 PlaneNormal, double MergeTol, double GeneralTol)
void chiAdjointSolverAddResponseFunction()
void chiCountMeshInLogicalVolume()
void chiProgramTime()
handle chiAdjointSolverReadFluxMomentsToBuffer(int SolverHandle, string FileBaseName)
void chiLBSWriteGroupsetAngularFlux(int SolverIndex, int GroupsetIndex, string file_base)
void chiMakeObject()
void chiLBSReadFluxMoments(int SolverIndex, string file_base, bool single_file_flag)
void chiLBSReadGroupsetAngularFlux(int SolverIndex, int GroupsetIndex, string file_base)
handle chiGetFieldFunctionHandleByName(string FFname)
void chiAdjointSolverMakeExpRepFromP1Moments()
void chiExportMultiFieldFunctionToVTK(table listFFHandles, char BaseName)
void chiAdjointSolverApplyFluxMomentBuffer(int SolverHandle, int BufferHandle)
void chiLBTSAdvanceTimeData(int SolverIndex)
void chiSleep()
void chiAdjointSolverComputeInnerProduct()
void chiLBSReadSourceMoments(int SolverIndex, string file_base, bool single_file_flag)
void chiLBTSSetProperty(int SolverIndex, string PropertyName)
void chiExportFieldFunctionToVTK(int FFHandle, char BaseName)
void chiMeshGeneratorExecute()
void chiExit()
void chiLBSCreateAndWriteSourceMoments(int SolverIndex, string file_base)