Modules
	Basic Options

Functions
Handle	chi_lua::chiFVDiffusionSolverCreate (string solver_name)

void	chi_lua::chiFVDiffusionSetBCProperty (int SolverHandle, string PropertyName, varying Values)

Handle	chi_lua::chiCFEMMGDiffusionSolverCreate ()

void	chi_lua::chiCFEMMGDiffusionSetBCProperty (int SolverHandle, string PropertyName, varying Values)

Handle	chi_lua::chiCFEMDiffusionSolverCreate ()

void	chi_lua::chiCFEMDiffusionSetBCProperty (int SolverHandle, string PropertyName, varying Values)

Handle	chi_lua::chiDiffusionCreateSolver ()

void	chi_lua::chiDiffusionSetProperty (int SolverHandle, string PropertyName, varying Values)

Success	chi_lua::chiDiffusionExecute (int SolverHandle)

Success	chi_lua::chiDiffusionInitialize (int SolverHandle)

Handle	chi_lua::chiDFEMDiffusionSolverCreate ()

void	chi_lua::chiDFEMDiffusionSetBCProperty (int SolverHandle, string PropertyName, varying Values)

Detailed Description

Function Documentation

◆ chiCFEMDiffusionSetBCProperty()

void chi_lua::chiCFEMDiffusionSetBCProperty	(	int	SolverHandle,
		string	PropertyName,
		varying	Values
	)

Sets a property of a Diffusion solver. Please also consult the whitepaper for the Diffusion solver (Diffusion Whitepaper)

Additional basic options can be set as indicated in Basic Options

Parameters

SolverHandle	int Handle to an existing diffusion solver.
PropertyName	string Name for a specific property.
Values	varying Number of inputs associated with the index.

_

PropertyName\n

"boundary_type"
Boundary type. Expects boundary index then BoundaryTypeName then type value.

chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)

BoundaryTypeName

reflecting
Reflecting boundary conditions. Synonymous with Neumann with a derivative of 0.0.

$-D \hat{n}\cdot \nabla \phi = 0$

dirichlet
Constant value boundary condition. Expects to be followed by a value associated with $\phi$ .

$\phi = f$

neumann
Constant derivative boundary condition. Expects to be followed by a constant representing

$-D \hat{n}\cdot \nabla \phi = f$

vacuum
Vacuum boundary conditions. More appropriate to neutron diffusion.

$\frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0$

robin
Robin boundary condition of the form

$a \phi + b D \hat{n}\cdot \nabla \phi = f$

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

Author: Jan

Definition at line 3078 of file lua_functions.c.

◆ chiCFEMDiffusionSolverCreate()

Handle chi_lua::chiCFEMDiffusionSolverCreate ( )

Creates a CFEM Diffusion solver.

Returns: Handle int Handle to the created 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

Definition at line 3021 of file lua_functions.c.

◆ chiCFEMMGDiffusionSetBCProperty()

void chi_lua::chiCFEMMGDiffusionSetBCProperty	(	int	SolverHandle,
		string	PropertyName,
		varying	Values
	)

Sets a property of a Diffusion solver. Please also consult the whitepaper for the Diffusion solver (Diffusion Whitepaper)

Additional basic options can be set as indicated in Basic Options

Parameters

SolverHandle	int Handle to an existing diffusion solver.
PropertyName	string Name for a specific property.
Values	varying Number of inputs associated with the index.

_

PropertyName\n

"boundary_type"
Boundary type. Expects boundary index then BoundaryTypeName then type value.

chiCFEMMGDiffusionSetBCProperty(solver,"boundary_type",bdID,"vacuum")

chi_lua::chiCFEMMGDiffusionSetBCProperty

void chiCFEMMGDiffusionSetBCProperty(int SolverHandle, string PropertyName, varying Values)

Definition: lua_functions.c:2993

BoundaryTypeName

reflecting
Reflecting boundary conditions. Synonymous with Neumann with a derivative of 0.0.

$-D \hat{n}\cdot \nabla \phi = 0$

neumann
Constant derivative boundary condition. Expects to be followed by a constant representing

$-D \hat{n}\cdot \nabla \phi = f$

vacuum
Vacuum boundary conditions. More appropriate to neutron diffusion.

$\frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0$

robin
Robin boundary condition of the form

$a \phi + b D \hat{n}\cdot \nabla \phi = f$

Author: Jean

Definition at line 2993 of file lua_functions.c.

◆ chiCFEMMGDiffusionSolverCreate()

Handle chi_lua::chiCFEMMGDiffusionSolverCreate ( )

Creates a Multigroup CFEM Diffusion solver.

Returns: Handle int Handle to the created solver.

Definition at line 2948 of file lua_functions.c.

◆ chiDFEMDiffusionSetBCProperty()

void chi_lua::chiDFEMDiffusionSetBCProperty	(	int	SolverHandle,
		string	PropertyName,
		varying	Values
	)

Sets a property of a Diffusion solver. Please also consult the whitepaper for the Diffusion solver (Diffusion Whitepaper)

Additional basic options can be set as indicated in Basic Options

Parameters

SolverHandle	int Handle to an existing diffusion solver.
PropertyName	string Name for a specific property.
Values	varying Number of inputs associated with the index.

_

PropertyName\n

"boundary_type"
Boundary type. Expects boundary index then BoundaryTypeName then type value.

chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)

BoundaryTypeName

reflecting
Reflecting boundary conditions. Synonymous with Neumann with a derivative of 0.0.

$-D \hat{n}\cdot \nabla \phi = 0$

dirichlet
Constant value boundary condition. Expects to be followed by a value associated with $\phi$ .

$\phi = f$

neumann
Constant derivative boundary condition. Expects to be followed by a constant representing

$-D \hat{n}\cdot \nabla \phi = f$

vacuum
Vacuum boundary conditions. More appropriate to neutron diffusion.

$\frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0$

robin
Robin boundary condition of the form

$a \phi + b D \hat{n}\cdot \nabla \phi = f$

Usage Examples:

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

Author: Jan

Definition at line 3281 of file lua_functions.c.

◆ chiDFEMDiffusionSolverCreate()

Handle chi_lua::chiDFEMDiffusionSolverCreate ( )

Creates a DFEM Diffusion solver based on the interior penalty method.

Returns: Handle int Handle to the created solver.

Usage Examples:

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

Definition at line 3224 of file lua_functions.c.

◆ chiDiffusionCreateSolver()

Handle chi_lua::chiDiffusionCreateSolver ( )

Creates a Diffusion solver.

Returns: Handle int Handle to the created solver.

Usage Examples:

Author: Jan

Definition at line 3099 of file lua_functions.c.

◆ chiDiffusionExecute()

Success chi_lua::chiDiffusionExecute ( int SolverHandle )

Initialize the Diffusion solver.

Parameters

SolverHandle int Handle to an existing diffusion solver.

Returns: Success bool Returns if initialization failed.

Usage Examples:

Author: Jan

Definition at line 3186 of file lua_functions.c.

◆ chiDiffusionInitialize()

Success chi_lua::chiDiffusionInitialize ( int SolverHandle )

Initialize the Diffusion solver.

Parameters

SolverHandle int Handle to an existing diffusion solver.

Returns: Success bool Returns if initialization failed.

Usage Examples:

Author: Jan

Definition at line 3210 of file lua_functions.c.

◆ chiDiffusionSetProperty()

void chi_lua::chiDiffusionSetProperty	(	int	SolverHandle,
		string	PropertyName,
		varying	Values
	)

Sets a property of a Diffusion solver. Please also consult the whitepaper for the Diffusion solver (Diffusion Whitepaper)

Additional basic options can be set as indicated in Basic Options

Parameters

SolverHandle	int Handle to an existing diffusion solver.
PropertyName	string Name for a specific property.
Values	varying Number of inputs associated with the index.

_

PropertyName\n

"boundary_type"
Boundary type. Expects boundary name (string) then BoundaryTypeName then type value.

chiDiffusionSetProperty(solver,"boundary_type",2,"dirichlet",1.0)

chi_lua::chiDiffusionSetProperty

void chiDiffusionSetProperty(int SolverHandle, string PropertyName, varying Values)

Definition: lua_functions.c:3163

BoundaryTypeName

reflecting
Reflecting boundary conditions. Synonymous with Neumann with a derivative of 0.0.

$-D \hat{n}\cdot \nabla \phi = 0$

dirichlet
Constant value boundary condition. Expects to be followed by a value associated with $\phi$ .

$\phi = f$

neumann
Constant derivative boundary condition. Expects to be followed by a constant representing

$-D \hat{n}\cdot \nabla \phi = f$

vacuum
Vacuum boundary conditions. More appropriate to neutron diffusion.

$\frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0$

robin
Robin boundary condition of the form

$a \phi + b D \hat{n}\cdot \nabla \phi = f$

Usage Examples:

Author: Jan

Definition at line 3163 of file lua_functions.c.

◆ chiFVDiffusionSetBCProperty()

void chi_lua::chiFVDiffusionSetBCProperty	(	int	SolverHandle,
		string	PropertyName,
		varying	Values
	)

Sets a property of a Diffusion solver. Please also consult the whitepaper for the Diffusion solver (Diffusion Whitepaper)

Additional basic options can be set as indicated in Basic Options

Parameters

SolverHandle	int Handle to an existing diffusion solver.
PropertyName	string Name for a specific property.
Values	varying Number of inputs associated with the index.

_

PropertyName\n

"boundary_type"
Boundary type. Expects boundary index then BoundaryTypeName then type value.

chiDiffusionsetBCproperty(solver,"boundary_type",2,"dirichlet",1.0)

BoundaryTypeName

reflecting
Reflecting boundary conditions. Synonymous with Neumann with a derivative of 0.0.

$-D \hat{n}\cdot \nabla \phi = 0$

dirichlet
Constant value boundary condition. Expects to be followed by a value associated with $\phi$ .

$\phi = f$

neumann
Constant derivative boundary condition. Expects to be followed by a constant representing

$-D \hat{n}\cdot \nabla \phi = f$

vacuum
Vacuum boundary conditions. More appropriate to neutron diffusion.

$\frac{1}{4}\phi + \frac{1}{2} D \hat{n}\cdot \nabla \phi = 0$

robin
Robin boundary condition of the form

$a \phi + b D \hat{n}\cdot \nabla \phi = f$

Author: Jan

Definition at line 2940 of file lua_functions.c.

◆ chiFVDiffusionSolverCreate()

Handle chi_lua::chiFVDiffusionSolverCreate ( string solver_name )

Creates a Finite Volume Diffusion solver.

Parameters

solver_name string Optional. Text name for the solver. [Default:"FVDiffusionSolver"]

Returns: Handle int Handle to the created solver.

Definition at line 2889 of file lua_functions.c.

Modules

Functions

Detailed Description

Function Documentation

◆ chiCFEMDiffusionSetBCProperty()

_

PropertyName\n

BoundaryTypeName

Usage Examples:

◆ chiCFEMDiffusionSolverCreate()

Usage Examples:

◆ chiCFEMMGDiffusionSetBCProperty()

_

PropertyName\n

BoundaryTypeName

◆ chiCFEMMGDiffusionSolverCreate()

◆ chiDFEMDiffusionSetBCProperty()

_

PropertyName\n

BoundaryTypeName

Usage Examples:

◆ chiDFEMDiffusionSolverCreate()

Usage Examples:

◆ chiDiffusionCreateSolver()

Usage Examples:

◆ chiDiffusionExecute()

Usage Examples:

◆ chiDiffusionInitialize()

Usage Examples:

◆ chiDiffusionSetProperty()

_

PropertyName\n

BoundaryTypeName

Usage Examples:

◆ chiFVDiffusionSetBCProperty()

_

PropertyName\n

BoundaryTypeName

◆ chiFVDiffusionSolverCreate()