Functions
void	chiSolverCreate (ParameterBloc params)

void	chiSolverInitialize (int solver_handle)

void	chiSolverExecute (int solver_handle)

void	chiSolverStep (int solver_handle)

void	chiSolverAdvance (int solver_handle)

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

void	chiSolverGetName (int solver_handle)

void	chiSolverGetFieldFunctionList (int SolverHandle)

void	chiSolverGetInfo (int solver_handle, varying info)

void	chiSolverSetProperties (int handle, Table property_table)

MaterialHandle	chiPhysicsAddMaterial (char Name)

void	chiPhysicsMaterialAddProperty (int MaterialHandle, int PropertyIndex)

void	chiPhysicsMaterialSetProperty (int MaterialHandle, int PropertyIndex, int OperationIndex, varying Information)

Lua	chiPhysicsMaterialGetProperty (int MaterialHandle, int PropertyIndex)

handle	chiGetFieldFunctionHandleByName (string FFname)

void	chiExportFieldFunctionToVTK (int FFHandle, char BaseName)

void	chiExportMultiFieldFunctionToVTK (table listFFHandles, char BaseName)

Returns	chiPhysicsTransportXSCreate ()

void	chiPhysicsTransportXSSet (int XS_handle, int OperationIndex, varying Information)

void	chiPhysicsTransportXSGet (int XS_handle)

Returns	chiPhysicsTransportXSMakeCombined (table Combinations)

void	chiPhysicsTransportXSSetCombined (int XS_handle, table Combinations)

void	chiPhysicsTransportXSExportToChiTechFormat (int XS_handle, string file_name)

void	chiFieldOperationExecute (int handle)

Handle	chiSurfaceMeshCreate ()

void	chiSurfaceMeshExportToObj (int SurfaceHandle, char *FileName)

void	chiSurfaceMeshExportPolyFile (int SurfaceHandle, char *FileName)

void	chiSurfaceMeshExtractOpenEdgesToObj (int SurfaceHandle, char FileName)

success	chiSurfaceMeshImportFromOBJFile (int SurfaceHandle, string FileName, bool polyflag, table3 transform)

success	chiSurfaceMeshImportFromTriangleFiles (int SurfaceHandle, char *FileName, bool polyflag)

void	chiSurfaceMeshImportFromMshFiles ()

void	chiSurfaceMeshCheckCycles (int SurfaceHandle, int NumAngles)

void	chiComputeLoadBalancing (int SurfaceHandle, table Xcuts, table Ycuts)

void	chiMeshHandlerExportMeshToObj (char FileName, bool ExportByMaterial)

void	chiMeshHandlerExportMeshToVTK (char FileName)

void	chiMeshHandlerExportMeshToExodus (char FileName, bool suppress_nodesets, bool suppress_sidesets)

Handle	chiMeshHandlerCreate ()

void	chiMeshHandlerSetCurrent (int HandlerHandler)

void	chiFFInterpolationGetValue (int FFIHandle)

Handle	chiFFInterpolationCreate (int FFITypeIndex)

void	chiFFInterpolationExportPython (int FFIHandle, char BaseName)

Handle	chiFFInterpolationSetProperty (int FFIHandle, int PropertyIndex)

void	chiFFInterpolationInitialize (int FFIHandle)

void	chiFFInterpolationExecute (int FFIHandle)

Handle	chiLogicalVolumeCreate (int TypeIndex, varying Values)

Sense	chiLogicalVolumePointSense (int LVHandle, double Point_x, double Point_y, double Point_z)

void	chiVolumeMesherSetupOrthogonalBoundaries ()

void	chiVolumeMesherCreate (int Type, varying OtherArgs)

void	chiVolumeMesherSetProperty (int PropertyIndex, varying PropertyValue)

void	chiVolumeMesherSetKBAPartitioningPxPyPz (int Px, int Py, int Pz)

void	chiVolumeMesherSetKBACutsX ()

void	chiVolumeMesherSetKBACutsY ()

void	chiVolumeMesherSetKBACutsZ ()

void	chiVolumeMesherSetMatIDToAll (int material_id)

void	chiVolumeMesherExecute ()

void	chiSurfaceMesherExecute ()

void	chiSurfaceMesherSetProperty (int PropertyNumber, varying PropertyValue)

void	chiSurfaceMesherCreate (int SurfaceMesherType)

void	chiCountMeshInLogicalVolume ()

void	chiCutMesh (Vec3 PlanePoint, Vec3 PlaneNormal, double MergeTol, double GeneralTol)

void	chiUnpartitionedMeshUploadVertex (int handle, double x, double y, double z)

void	chiUnpartitionedMeshUploadCell (int handle, lua_table cell_table)

void	chiUnpartitionedMeshFinalizeEmpty (int handle)

void	chiCreateEmptyUnpartitionedMesh ()

void	chiDestroyUnpartitionedMesh (int handle)

Handle	chiUnpartitionedMeshFromVTU (char file_name, char field)

Handle	chiUnpartitionedMeshFromPVTU (char file_name, char field)

Handle	chiUnpartitionedMeshFromEnsightGold (char file_name, float scale)

Handle	chiUnpartitionedMeshFromWavefrontOBJ (char file_name)

Handle	chiUnpartitionedMeshFromMshFormat (char file_name)

Handle	chiUnpartitionedMeshFromExodusII (char file_name, float scale)

Two	chiMeshCreateUnpartitioned1DOrthoMesh (array_float x_nodes)

Two	chiMeshCreateUnpartitioned2DOrthoMesh (array_float x_nodes, array_float y_nodes)

Two	chiMeshCreateUnpartitioned3DOrthoMesh (array_float x_nodes, array_float y_nodes, array_float z_nodes)

void	chiDecomposeSurfaceMeshPxPy (mesh Surface, int Px, int Py)

void	chiMeshGeneratorExecute ()

void	chiMakeObject ()

void	chiMakeObjectType ()

void	chiMakeObject (ParameterBlock params)

void	chiMakeObjectType (string type, ParameterBlock params)

void	chiProgramTime ()

void	chiSleep ()

void	chiSleep (int time)

void	chiExit ()

void	chiExit (int return_code)

void	chiLogSetVerbosity (int int_level)

void	chiLog (int LogType, char LogMsg)

double	chiLogProcessEvent (string event_name, string event_operation_name)

void	chiLogPrintTimingGraph (int rank)

void	chiLocallyRefineSLDFESQAngularQuadrature (in handle, vec3 reference_direction, double cone_size, bool invert_logic)

void	chiCreateSLDFESQAngularQuadrature (int initial_refinement_level)

void	chiPrintToPythonSLDFESQAngularQuadrature (int handle, string file_name_prefix)

Returns	chiCreateLineQuadrature (int QuadratureType, int NumberOfPoints, bool VerboseFlag)

Returns	chiCreateCustomAngularQuadrature (array azimuthal_angles, array polar_angles, array weight)

Returns	chiCreateCylindricalProductQuadrature (int QuadratureType, varying values)

Returns	chiCreateSphericalProductQuadrature (int QuadratureType, varying values)

Table	chiGetProductQuadrature (int QuadHandle)

void	chiOptimizeAngularQuadratureForPolarSymmetry (in handle, double normalization)

Returns	chiCreateProductQuadrature (int QuadratureType, varying values)

void	chiLegendre (int N, double x)

void	chiLegendreDerivative (int N, double x)

void	chiYlm (int ell, int m, double theta, double varphi)

void	chiFunctionDimAToDimBEvaluate ()

Varying	chiFunctionDimAToDimBEvaluate (in handle, Varying params)

void	chiMPIBarrier ()

Handle	chiFVDiffusionSolverCreate (string solver_name)

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

Handle	chiCFEMMGDiffusionSolverCreate ()

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

Varying *	chiPRKGetParam (int handle, string param_name)

Varying *	chiPRKSetParam (int handle, string param_name, Varying value)

Handle	chiCFEMDiffusionSolverCreate ()

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

Handle	chiDiffusionCreateSolver ()

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

Success	chiDiffusionExecute (int SolverHandle)

Success	chiDiffusionInitialize (int SolverHandle)

Handle	chiDFEMDiffusionSolverCreate ()

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

void	chiLBSInitializeMaterials (int SolverIndex)

void	chiLBSAddPointSource (int SolverIndex, double Location_x, double Location_y, double Location_z, table Strength)

void	chiLBSClearPointSources (int SolverIndex)

void	chiLBSInitializePointSources (int SolverIndex)

void	chiLBSWriteGroupsetAngularFlux (int SolverIndex, int GroupsetIndex, string file_base)

void	chiLBSReadGroupsetAngularFlux (int SolverIndex, int GroupsetIndex, string file_base)

void	chiLBSSetProperty (int SolverIndex, int PropertyIndex)

Pair	chiLBSGetScalarFieldFunctionList (int SolverIndex)

void	chiLBSCreateGroupset (int SolverIndex)

void	chiLBSCreateGroup (int SolverIndex, int GroupId)

void	chiLBSGroupsetAddGroups (int SolverIndex, int GroupsetIndex, int FromIndex, int ToIndex)

void	chiLBSGroupsetSetQuadrature (int SolverIndex, int GroupsetIndex, int QuadratureIndex)

void	chiLBSGroupsetSetAngleAggregationType (int SolverIndex, int GroupsetIndex, int AggregationType)

void	chiLBSGroupsetSetAngleAggDiv (int SolverIndex, int GroupsetIndex, int NumDiv)

void	chiLBSGroupsetSetGroupSubsets (int SolverIndex, int GroupsetIndex, int NumDiv)

void	chiLBSGroupsetSetIterativeMethod (int SolverIndex, int GroupsetIndex, int IterativeMethod)

void	chiLBSGroupsetSetResidualTolerance (int SolverIndex, int GroupsetIndex, float ResidualTol)

void	chiLBSGroupsetSetMaxIterations (int SolverIndex, int GroupsetIndex, int Numiter)

void	chiLBSGroupsetSetGMRESRestartIntvl (int SolverIndex, int GroupsetIndex, int Intvl)

void	chiLBSGroupsetSetEnableSweepLog (int SolverIndex, int GroupsetIndex, bool flag)

void	chiLBSGroupsetSetWGDSA (int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString)

void	chiLBSGroupsetSetTGDSA (int SolverIndex, int GroupsetIndex, int MaxIters, float ResTol, bool Verbose, char PETSCString)

double	chiLBSComputeFissionRate (int SolverIndex, string OldNewOption)

void	chiLBSWriteFluxMoments (int SolverIndex, string file_base)

void	chiLBSCreateAndWriteSourceMoments (int SolverIndex, string file_base)

void	chiLBSReadFluxMomentsAndMakeSourceMoments (int SolverIndex, string file_base, bool single_file_flag)

void	chiLBSReadSourceMoments (int SolverIndex, string file_base, bool single_file_flag)

void	chiLBSReadFluxMoments (int SolverIndex, string file_base, bool single_file_flag)

void	chiLBSSetPhiFromFieldFunction (int handle, Table specs)

void	chiAdjointSolverExportImportanceMapBinary ()

void	chiAdjointSolverComputeInnerProduct ()

void	chiAdjointSolverAddResponseFunction ()

handle	chiAdjointSolverReadFluxMomentsToBuffer (int SolverHandle, string FileBaseName)

void	chiAdjointSolverApplyFluxMomentBuffer (int SolverHandle, int BufferHandle)

void	chiAdjointSolverMakeExpRepFromP1Moments ()

The	chiLBSComputeLeakage (int SolverIndex, int GroupSetHandle, int BoundaryID)

void	chiLBSComputeBalance (int SolverIndex)

void	chiLBTSAdvanceTimeData (int SolverIndex)

void	chiLBSCreateTransientSolver (string SolverName)

void	chiLBTSSetProperty (int SolverIndex, string PropertyName)

void	chiLBTSGetProperty (int SolverIndex, string PropertyName)

Function Documentation

◆ chiAdjointSolverAddResponseFunction()

void chi_lua::chiAdjointSolverAddResponseFunction ( )

Definition at line 4224 of file lua_functions.c.

◆ chiAdjointSolverApplyFluxMomentBuffer()

void chi_lua::chiAdjointSolverApplyFluxMomentBuffer	(	int	SolverHandle,
		int	BufferHandle
	)

Applies buffered flux-moments data to the current phi-old.

Parameters

SolverHandle	int Handle to the relevant solver.
BufferHandle	int The handle to the buffer-position to be applied.

Definition at line 4240 of file lua_functions.c.

◆ chiAdjointSolverComputeInnerProduct()

void chi_lua::chiAdjointSolverComputeInnerProduct ( )

Definition at line 4222 of file lua_functions.c.

◆ chiAdjointSolverExportImportanceMapBinary()

void chi_lua::chiAdjointSolverExportImportanceMapBinary ( )

Definition at line 4220 of file lua_functions.c.

◆ chiAdjointSolverMakeExpRepFromP1Moments()

void chi_lua::chiAdjointSolverMakeExpRepFromP1Moments ( )

Definition at line 4242 of file lua_functions.c.

◆ chiAdjointSolverReadFluxMomentsToBuffer()

handle chi_lua::chiAdjointSolverReadFluxMomentsToBuffer	(	int	SolverHandle,
		string	FileBaseName
	)

Reads flux-moments file to a buffer and returns a handle to that buffer.

Parameters

SolverHandle	int Handle to the relevant solver.
FileBaseName	string The base-name of the file(s) from which to read the flux moments.

Returns: handle int A handle that can be used with chiAdjointSolverApplyFluxMomentBuffer.

Definition at line 4234 of file lua_functions.c.

◆ chiCountMeshInLogicalVolume()

void chi_lua::chiCountMeshInLogicalVolume ( )

Counts the number of cells with a logical volume.

Definition at line 1890 of file lua_functions.c.

◆ chiCutMesh()

void chi_lua::chiCutMesh	(	Vec3	PlanePoint,
		Vec3	PlaneNormal,
		double	MergeTol,
		double	GeneralTol
	)

Cuts a mesh.

Parameters

PlanePoint	Vec3 A 3 element lua-table containing the reference point of the plane.
PlaneNormal	Vec3 A 3 element lua-table containing the plane normal. Will be normalized when applied.
MergeTol	double (Optional). Vertices within a distance MergeTol from the plane will be snapped to the plane. Default: 1.0e-3
GeneralTol	double (Optional). A general tolerance to be used for comparing whether two real values are equal. Default: 1.0e-10.

Definition at line 1904 of file lua_functions.c.

◆ chiExit() [1/2]

void chi_lua::chiExit ( )

Definition at line 2334 of file lua_functions.c.

◆ chiExit() [2/2]

void chi_lua::chiExit ( int return_code )

Gracefully exits ChiTech.

Parameters

return_code int Return code, defaults to 0 (Success).

Definition at line 2337 of file lua_functions.c.

◆ chiExportFieldFunctionToVTK()

void chi_lua::chiExportFieldFunctionToVTK	(	int	FFHandle,
		char	BaseName
	)

Exports a field function to VTK format.

Parameters

FFHandle	int Global handle to the field function.
BaseName	char Base name for the exported file.

Usage Examples:

Author: Jan

Definition at line 715 of file lua_functions.c.

◆ chiExportMultiFieldFunctionToVTK()

void chi_lua::chiExportMultiFieldFunctionToVTK	(	table	listFFHandles,
		char	BaseName
	)

Exports all the field functions in a list to VTK format.

Parameters

listFFHandles table Global handles or names to the field functions

BaseName char Base name for the exported file.

Usage Examples:

Author: Jan

Definition at line 761 of file lua_functions.c.

◆ chiFieldOperationExecute()

void chi_lua::chiFieldOperationExecute ( int handle )

Executes a field function operation.

Parameters

handle int Handle to the field function operation object.

Definition at line 958 of file lua_functions.c.

◆ chiFunctionDimAToDimBEvaluate() [1/2]

void chi_lua::chiFunctionDimAToDimBEvaluate ( )

Definition at line 2846 of file lua_functions.c.

◆ chiFunctionDimAToDimBEvaluate() [2/2]

Varying chi_lua::chiFunctionDimAToDimBEvaluate	(	in	handle,
		Varying	params
	)

Evaluates a function of base type FunctionXYZDimAToDimB.

Parameters

handle	int. Handle to the function to evaluate.
params	Varying. Table or individual arguments.

Returns: Varying Either a single number or a table of output values.

Definition at line 2852 of file lua_functions.c.

◆ chiGetFieldFunctionHandleByName()

handle chi_lua::chiGetFieldFunctionHandleByName ( string FFname )

Gets a field-function handle by name.

Parameters

FFname string Name of the field function.

Returns: handle If the field-function was found and a handle identified the valid handle will be returned (i.e., a natural number >= 0). If the field-function by the given name was not found then the function will return null.

Usage Examples:

Definition at line 680 of file lua_functions.c.

◆ chiLBSCreateAndWriteSourceMoments()

void chi_lua::chiLBSCreateAndWriteSourceMoments	(	int	SolverIndex,
		string	file_base
	)

Creates scattered source-moments, based on a LBS solution, and writes them to file.

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"

Usage Examples:

test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part1.lua

Definition at line 4129 of file lua_functions.c.

◆ chiLBSCreateTransientSolver()

void chi_lua::chiLBSCreateTransientSolver ( string SolverName )

Creates a LBS-TransientSolver.

Parameters

SolverName string Optional. The text name of the solver. [Default="LBSTransientSolver"].

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: Zachary Hardy

Definition at line 4293 of file lua_functions.c.

◆ chiLBSReadFluxMoments()

void chi_lua::chiLBSReadFluxMoments	(	int	SolverIndex,
		string	file_base,
		bool	single_file_flag
	)

Reads flux-moments from a file to phi_old_local (the initial flux solution).

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"
single_file_flag	bool (Optional) Flag indicating that the file is a single stand-alone file. The file_base will then be used without adding the location-id, but still with the ".data" appended. Default: false. Usage Examples:

test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1c_response.lua

Definition at line 4180 of file lua_functions.c.

◆ chiLBSReadFluxMomentsAndMakeSourceMoments()

void chi_lua::chiLBSReadFluxMomentsAndMakeSourceMoments	(	int	SolverIndex,
		string	file_base,
		bool	single_file_flag
	)

Reads flux-moments from a file and creates a scattering source from these moments to be used instead of a regular material/boundary source.

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"
single_file_flag	bool (Optional) Flag indicating that the file is a single stand-alone file. The file_base will then be used without adding the location-id, but still with the ".data" appended. Default: false.

Definition at line 4145 of file lua_functions.c.

◆ chiLBSReadGroupsetAngularFlux()

void chi_lua::chiLBSReadGroupsetAngularFlux	(	int	SolverIndex,
		int	GroupsetIndex,
		string	file_base
	)

Reads the angular fluxes of a LBS groupset from a file.

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
GroupsetIndex	int Index to the groupset to which this function should apply
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"

Definition at line 3356 of file lua_functions.c.

◆ chiLBSReadSourceMoments()

void chi_lua::chiLBSReadSourceMoments	(	int	SolverIndex,
		string	file_base,
		bool	single_file_flag
	)

Reads the source-moments from a file to a specific ext_src_moments_local-vector to be used instead of a regular material/boundary source.

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"
single_file_flag	bool (Optional) Flag indicating that the file is a single stand-alone file. The file_base will then be used without adding the location-id, but still with the ".data" appended. Default: false. Usage Examples:

test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part2.lua

Definition at line 4162 of file lua_functions.c.

◆ chiLBSSetPhiFromFieldFunction()

void chi_lua::chiLBSSetPhiFromFieldFunction	(	int	handle,
		Table	specs
	)

Sets the internal phi vector to the value in the associated field function.

Parameters

handle	int Handle to the lbs-based object.
specs	Table Various options in a table. Detailed below.

_

Example usage

Example:

chiLBSSetPhiFromFieldFunction(phys1,
{
  which_phi = "old",  --Optional
  m_ids = {0,1,2,3},  --Optional Empty means all of them
  g_ids = {}          --Optional Empty means all of them
})

Table keys

which_phi
type=STRING Optional. Can be "old" or "new". Denotes which phi version to copy to. Default: "old".

m_ids
type=ARRAY Optional. Array of moment IDs. If this is empty all the moments will be copied. Default: {}.

g_ids
type=ARRAY Optional. Array of group IDs. If this is empty all the groups will be copied. Default: {}.

Definition at line 4217 of file lua_functions.c.

◆ chiLBSWriteFluxMoments()

void chi_lua::chiLBSWriteFluxMoments	(	int	SolverIndex,
		string	file_base
	)

Writes the flux-moments of a LBS solution to file (phi_old_local).

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"

Usage Examples:

test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3b_adjoint.lua

Definition at line 4116 of file lua_functions.c.

◆ chiLBSWriteGroupsetAngularFlux()

void chi_lua::chiLBSWriteGroupsetAngularFlux	(	int	SolverIndex,
		int	GroupsetIndex,
		string	file_base
	)

Writes the angular fluxes of a LBS groupset to file.

Parameters

SolverIndex	int Handle to the solver for which the group is to be created.
GroupsetIndex	int Index to the groupset to which this function should apply
file_base	string Path+Filename_base to use for the output. Each location will append its id to the back plus an extension ".data"

Definition at line 3343 of file lua_functions.c.

◆ chiLBTSAdvanceTimeData()

void chi_lua::chiLBTSAdvanceTimeData ( int SolverIndex )

Advances time dependent data to the next timestep.

Parameters

SolverIndex int Handle to the solver..

Usage Examples:

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: Zachary Hardy

Definition at line 4279 of file lua_functions.c.

◆ chiLBTSGetProperty()

void chi_lua::chiLBTSGetProperty	(	int	SolverIndex,
		string	PropertyName
	)

Gets a property of a LBS-TransientSolver or any derived class.

Parameters

SolverIndex	int Handle to the solver for which the set is to be created.
PropertyName	string String name for a specific property.

_

ProperyName

"TIMESTEP"
Returns the current timestep.

"TIMESTOP"
Returns the stop time.

"INHIBIT_ADVANCE"
Returns the flag.

"TIME"
Returns the simulation time before the latest timestep.

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: Zachary Hardy

Definition at line 4380 of file lua_functions.c.

◆ chiLBTSSetProperty()

void chi_lua::chiLBTSSetProperty	(	int	SolverIndex,
		string	PropertyName
	)

Sets a property of the LBS-TransientSolver or any derived class.

Parameters

SolverIndex	int Handle to the solver for which the set is to be created.
PropertyName	string String name for a specific property.

_

ProperyName

"TIMESTEP"
Expects to be followed by a floating point value representing the timestep.

"TIME"
Sets the current time. [Default=0.0]

"TIMESTOP"
Sets the termination time. [Default=0.1]

"MAX_TIMESTEPS"
Sets the maximum number of timesteps during a call to Execute. A negative value disable the logic to check for timestep-counters exceeding this amount. [Default=10]

"INHIBIT_ADVANCE"
Sets a flag that prevents the time from advancing. Can be used to reject a timestep. [Default=false]

"VERBOSITY_LEVEL"
Sets the verbosity level. Level 0, nothing gets printed. Level 1, basic info. [Default=1]

"TIMESTEP_METHOD"
Sets the time-stepping method. Can be "CRANK_NICHOLSON" or "BACKWARD_EULER". [Default="CRANK_NICHOLSON"]

"CALLBACK"
Sets the timestep callback function. [Default=Nothing]

"SCALE_FISSION_XS"
Sets a boolean flag to normalize the fission cross-sections by the k-eigenvalue. [Default=false]

"NORMALIZATION_METHOD"
Sets the initial data normalization data. Can be "TOTAL_POWER", "POWER_DENSITY", or "NONE". [Default="TOTAL_POWER"]

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: Zachary Hardy

Definition at line 4349 of file lua_functions.c.

◆ chiMakeObject() [1/2]

void chi_lua::chiMakeObject ( )

Definition at line 2307 of file lua_functions.c.

◆ chiMakeObject() [2/2]

void chi_lua::chiMakeObject ( ParameterBlock params )

Generic lua routine for the creation of objects.

Parameters

params ParameterBlock A single block tree that requires a parameter called chi_obj_type that indicates the type of object to make.

Definition at line 2314 of file lua_functions.c.

◆ chiMakeObjectType() [1/2]

void chi_lua::chiMakeObjectType ( )

Definition at line 2308 of file lua_functions.c.

◆ chiMakeObjectType() [2/2]

void chi_lua::chiMakeObjectType	(	string	type,
		ParameterBlock	params
	)

Generic lua routine for the creation of objects.

Parameters

type	string The type to create.
params	ParameterBlock A single block tree.

Definition at line 2320 of file lua_functions.c.

◆ chiMeshGeneratorExecute()

void chi_lua::chiMeshGeneratorExecute ( )

Definition at line 2303 of file lua_functions.c.

◆ chiPRKGetParam()

Varying * chi_lua::chiPRKGetParam	(	int	handle,
		string	param_name
	)

Gets a parameter from the prk::TransientSolver.

Parameters

handle	int Handle of the solver.
param_name	string Name of the parameter to retrieve.

Returns: Varying

Definition at line 3000 of file lua_functions.c.

◆ chiPRKSetParam()

Varying * chi_lua::chiPRKSetParam	(	int	handle,
		string	param_name,
		Varying	value
	)

Gets a parameter from the prk::TransientSolver.

Parameters

handle	int Handle of the solver.
param_name	string Name of the parameter to retrieve.
value	Varying The value to be set to the parameter.

Returns: Varying

Definition at line 3007 of file lua_functions.c.

◆ chiProgramTime()

void chi_lua::chiProgramTime ( )

Returns the program time as determined from the home location (involves a collective broadcast).

Definition at line 2323 of file lua_functions.c.

◆ chiSleep() [1/2]

void chi_lua::chiSleep ( )

Definition at line 2328 of file lua_functions.c.

◆ chiSleep() [2/2]

void chi_lua::chiSleep ( int time )

Makes the program sleep for the specified time in milliseconds.

Parameters

time	int Time in milliseconds to sleep for.

Definition at line 2332 of file lua_functions.c.

◆ chiSurfaceMeshImportFromMshFiles()

void chi_lua::chiSurfaceMeshImportFromMshFiles ( )

Definition at line 1056 of file lua_functions.c.

listFFHandles	table Global handles or names to the field functions
BaseName	char Base name for the exported file.

Functions

Function Documentation

◆ chiAdjointSolverAddResponseFunction()

◆ chiAdjointSolverApplyFluxMomentBuffer()

◆ chiAdjointSolverComputeInnerProduct()

◆ chiAdjointSolverExportImportanceMapBinary()

◆ chiAdjointSolverMakeExpRepFromP1Moments()

◆ chiAdjointSolverReadFluxMomentsToBuffer()

◆ chiCountMeshInLogicalVolume()

◆ chiCutMesh()

◆ chiExit() [1/2]

◆ chiExit() [2/2]

◆ chiExportFieldFunctionToVTK()

Usage Examples:

◆ chiExportMultiFieldFunctionToVTK()

Usage Examples:

◆ chiFieldOperationExecute()

◆ chiFunctionDimAToDimBEvaluate() [1/2]

◆ chiFunctionDimAToDimBEvaluate() [2/2]

◆ chiGetFieldFunctionHandleByName()

Usage Examples:

◆ chiLBSCreateAndWriteSourceMoments()

Usage Examples:

◆ chiLBSCreateTransientSolver()

Usage Examples:

◆ chiLBSReadFluxMoments()

Usage Examples:

◆ chiLBSReadFluxMomentsAndMakeSourceMoments()

◆ chiLBSReadGroupsetAngularFlux()

◆ chiLBSReadSourceMoments()

Usage Examples:

◆ chiLBSSetPhiFromFieldFunction()

_

Example usage

Table keys

◆ chiLBSWriteFluxMoments()

Usage Examples:

◆ chiLBSWriteGroupsetAngularFlux()

◆ chiLBTSAdvanceTimeData()

Usage Examples:

◆ chiLBTSGetProperty()

_

ProperyName

Usage Examples:

◆ chiLBTSSetProperty()

_

ProperyName

Usage Examples:

◆ chiMakeObject() [1/2]

◆ chiMakeObject() [2/2]

◆ chiMakeObjectType() [1/2]

◆ chiMakeObjectType() [2/2]

◆ chiMeshGeneratorExecute()

◆ chiPRKGetParam()

◆ chiPRKSetParam()

◆ chiProgramTime()

◆ chiSleep() [1/2]

◆ chiSleep() [2/2]

◆ chiSurfaceMeshImportFromMshFiles()