Solvers

Modules
	Base class for all solvers

Functions
void	chi_lua::chiSolverCreate (ParameterBloc params)
void	chi_lua::chiSolverInitialize (int solver_handle)
void	chi_lua::chiSolverExecute (int solver_handle)
void	chi_lua::chiSolverStep (int solver_handle)
void	chi_lua::chiSolverAdvance (int solver_handle)
void	chi_lua::chiSolverSetBasicOption (int solver_handle, string option_name, varying option_value)
void	chi_lua::chiSolverGetName (int solver_handle)
void	chi_lua::chiSolverGetFieldFunctionList (int SolverHandle)
void	chi_lua::chiSolverGetInfo (int solver_handle, varying info)
void	chi_lua::chiSolverSetProperties (int handle, Table property_table)

Detailed Description

Function Documentation

chiSolverAdvance()

void chi_lua::chiSolverAdvance

(

int

solver_handle

)

Advances the time values of the solver at the given handle.

Parameters

solver_handle

int Handle to the solver.

Usage Examples:

test/framework/post_processors/solver_info_01.lua
test/framework/post_processors/solver_info_02.lua

Author

Jan

Definition at line 186 of file lua_functions.c.

chiSolverCreate()

void chi_lua::chiSolverCreate

(

ParameterBloc

params

)

Generic lua routine for the creation of solvers.

Parameters

params

ParameterBlock. A single block with at least one field "type", which contains a registered solver type. _

Example:

chiSolverCreate({type=cfem_diffusion.Solver})

Deprecated:

This function is deprecated and will be removed soon.

Definition at line 17 of file lua_functions.c.

chiSolverExecute()

void chi_lua::chiSolverExecute

(

int

solver_handle

)

Executes the solver at the given handle.

Parameters

solver_handle

int Handle to the solver.

Usage Examples:

test/framework/tutorials/tutorial_93_raytracing.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_3a_analytical_coef.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2b_RobinBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_3b_analytical_coef2.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2a_DirBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_1a_linear.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2a_DirBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3a_analytical_coef.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3b_analytical_coef2.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2b_RobinBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_1a_linear.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_1Monoenergetic.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_2Multigroup.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP2D_1a_QBlock.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP2D_1b_QBlock.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_3Poly_quad_mod.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_5PolyA_AniHeteroBndry.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_Balance.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_5Cycles2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4b_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_BalanceMG.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1a_Extruder.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6ASplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6BSplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_4_DSA_ortho_inf.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_4Cycles1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1b_Ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_parmetis.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1c_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1c_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1a_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1b_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1b_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1a_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/c5g7/c5g7.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_1b_Ortho.lua

Author

Jan

Definition at line 161 of file lua_functions.c.

chiSolverGetFieldFunctionList()

void chi_lua::chiSolverGetFieldFunctionList

(

int

SolverHandle

)

Obtains a named list of the field functions associated with a solver.

Parameters

SolverHandle

int A handle to the reference solver.

Usage Examples:

test/modules/CFEM_Diffusion/cDiffusion_2D_3a_analytical_coef.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2b_RobinBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_3b_analytical_coef2.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2a_DirBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_1a_linear.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2a_DirBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3a_analytical_coef.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3b_analytical_coef2.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2b_RobinBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_1a_linear.lua
test/modules/Diffusion/Diffusion1D_IP.lua
test/modules/Diffusion/Diffusion1D.lua
test/modules/Diffusion/Diffusion3D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_2Ortho.lua
test/modules/Diffusion/Diffusion3D_3Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_4VTU.lua
test/modules/Diffusion/Diffusion2D_2Unstructured.lua
test/modules/Diffusion/Diffusion1D_KBA.lua
test/modules/Diffusion/Diffusion2D_2Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_3Unstructured.lua

Definition at line 265 of file lua_functions.c.

chiSolverGetInfo()

void chi_lua::chiSolverGetInfo	(	int	solver_handle,
		varying	info
	)

Returns arbitrary info specific for each solver.

Parameters

solver_handle	int Handle to the solver.
info	varying A single string or a table of values to call the solver with.

Usage Examples:

test/framework/post_processors/solver_info_01.lua
test/framework/post_processors/solver_info_02.lua

Author

Jan

Definition at line 277 of file lua_functions.c.

chiSolverGetName()

void chi_lua::chiSolverGetName

(

int

solver_handle

)

Returns the text name of the solver.

Parameters

solver_handle

int Handle to the solver.

Usage Examples:

test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_2.lua

Author

Jan

Definition at line 235 of file lua_functions.c.

chiSolverInitialize()

void chi_lua::chiSolverInitialize

(

int

solver_handle

)

Initializes the solver at the given handle.

Parameters

solver_handle

int Handle to the solver.

Usage Examples:

test/framework/tutorials/tutorial_93_raytracing.lua
test/framework/post_processors/solver_info_01.lua
test/framework/post_processors/solver_info_02.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_3a_analytical_coef.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2b_RobinBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_3b_analytical_coef2.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2a_DirBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_1a_linear.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2a_DirBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3a_analytical_coef.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3b_analytical_coef2.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2b_RobinBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_1a_linear.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_1Monoenergetic.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_2Multigroup.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP2D_1a_QBlock.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP2D_1b_QBlock.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_3Poly_quad_mod.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_5PolyA_AniHeteroBndry.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_Balance.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_5Cycles2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4b_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_BalanceMG.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1a_Extruder.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6ASplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6BSplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_4_DSA_ortho_inf.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_4Cycles1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1b_Ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_parmetis.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1c_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1c_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1a_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1b_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1b_QBlock_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport2D_1a_QBlock.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/c5g7/c5g7.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_1b_Ortho.lua

Author

Jan

Definition at line 92 of file lua_functions.c.

chiSolverSetBasicOption()

void chi_lua::chiSolverSetBasicOption	(	int	solver_handle,
		string	option_name,
		varying	option_value
	)

Sets a basic option of a solver.

Parameters

solver_handle	int Handle to the reference solver.
option_name	string String-name of the option.
option_value	varying The value to assign to the option.

Deprecated:

This function is deprecated and will be removed soon.

Usage Examples:

test/modules/CFEM_Diffusion/cDiffusion_2D_2b_RobinBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_2a_DirBCs.lua
test/modules/CFEM_Diffusion/cDiffusion_2D_1a_linear.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2a_DirBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3b_analytical_coef2.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2b_RobinBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_1a_linear.lua
test/modules/Diffusion/Diffusion1D_IP.lua
test/modules/Diffusion/Diffusion1D.lua
test/modules/Diffusion/Diffusion3D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_2Ortho.lua
test/modules/Diffusion/Diffusion3D_3Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_4VTU.lua
test/modules/Diffusion/Diffusion2D_2Unstructured.lua
test/modules/Diffusion/Diffusion1D_KBA.lua
test/modules/Diffusion/Diffusion2D_2Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_3Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1c_response.lua

Author

Jan

Definition at line 222 of file lua_functions.c.

chiSolverSetProperties()

void chi_lua::chiSolverSetProperties	(	int	handle,
		Table	property_table
	)

Sets a property of a solver.

Parameters

handle	int Solver handle.
property_table	Table Table of properties to set. See solver specific documentation.

Definition at line 284 of file lua_functions.c.

chiSolverStep()

void chi_lua::chiSolverStep

(

int

solver_handle

)

Performs a single timestep for the solver at the given handle.

Parameters

solver_handle

int Handle to the solver.

Usage Examples:

test/framework/post_processors/solver_info_01.lua
test/framework/post_processors/solver_info_02.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_2.lua

Author

Jan

Definition at line 176 of file lua_functions.c.