Functions
MaterialHandle	chi_lua::chiPhysicsAddMaterial (char Name)

void	chi_lua::chiPhysicsMaterialAddProperty (int MaterialHandle, int PropertyIndex)

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

Lua	chi_lua::chiPhysicsMaterialGetProperty (int MaterialHandle, int PropertyIndex)

Detailed Description

Function Documentation

◆ chiPhysicsAddMaterial()

MaterialHandle chi_lua::chiPhysicsAddMaterial ( char Name )

Adds a material to the problem. Materials are added to the global physics handler and is therefore accessible across all meshes and solvers.

Parameters

Name	char (Optional) Material name.

Returns: MaterialHandle int Handle to the created material.

_

Example\n

Example lua code:

materials = {}

materials[1] = chiPhysicsAddMaterial("Test Material");

chi_lua::chiPhysicsAddMaterial

MaterialHandle chiPhysicsAddMaterial(char Name)

Definition: lua_functions.c:369

Usage Examples:

Author: Jan

Definition at line 369 of file lua_functions.c.

◆ chiPhysicsMaterialAddProperty()

void chi_lua::chiPhysicsMaterialAddProperty	(	int	MaterialHandle,
		int	PropertyIndex
	)

Adds a material property to a material.

Parameters

MaterialHandle	int Index to the reference material.
PropertyIndex	int Property index.

_

PropertyIndex\n

SCALAR_VALUE
Simple scalar value property.

TRANSPORT_XSECTIONS
Multi-group transport cross-section supporting numerous features.

ISOTROPIC_MG_SOURCE
Isotropic Multigroup Source.

Developer Info

Checklist for adding a new material property:

Create your property class in its own header file. i.e. "physics/PhysicsMaterial/property_xx_myproperty.h"
Add the property to the physics namespace ("physics/chi_physics_namespace.h"). Make sure to derive from the base class.
Go define the integer to be associated with your new property in chi_physicsmaterial.h
Include the header file for your property in this file (i.e. at the top).
Add this property integer in the lua register (ChiLua/chi_lua_register.h). For testing you can just use the integer value but eventually you'd want to supply an easier way for users to enter it.
Add another else-if for your property. Just have a look at how the others were done, it should be intuitive enough.

_

Example\n

Example lua code:

chiPhysicsMaterialAddProperty(materials[i],TRANSPORT_XSECTIONS)

chi_lua::chiPhysicsMaterialAddProperty

void chiPhysicsMaterialAddProperty(int MaterialHandle, int PropertyIndex)

Definition: lua_functions.c:478

Usage Examples:

Author: Jan

Definition at line 478 of file lua_functions.c.

◆ chiPhysicsMaterialGetProperty()

Lua chi_lua::chiPhysicsMaterialGetProperty	(	int	MaterialHandle,
		int	PropertyIndex
	)

Returns a rich lua data-structure of the required property.

Parameters

MaterialHandle	int Index to the reference material.
PropertyIndex	int Property index. Or name of property.

Returns: Lua table of the desired property.

Usage Examples:

test/modules/Diffusion/Diffusion2D_1Poly_IP.lua

Definition at line 658 of file lua_functions.c.

◆ chiPhysicsMaterialSetProperty()

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

Sets a material property for a given material.

Parameters

MaterialHandle	int Index to the reference material.
PropertyIndex	int Property index. Or name of property.
OperationIndex	int Method used for setting the material property.
Information	varying Varying information depending on the operation.

_

PropertyIndex\n

SCALAR_VALUE = Basic Scalar value property.
TRANSPORT_XSECTIONS = Multi-group transport cross-section supporting numerous features.
ISOTROPIC_MG_SOURCE = Isotropic Multigroup Source.

OperationIndex\n

SINGLE_VALUE
Sets the property based on a single value. Requires a single value as additional information. As a simple example consider the case where the user would like to set a single constant thermal conductivity. This can be achieved with
FROM_ARRAY
Sets a property based on a Lua array indexed from 1 to N. Internally will be converted to 0 to N-1. This method can be used to set mutligroup cross-sections or sources.
SIMPLEXS0
Makes a simple material with no transfer matrix just $\sigma_t$ . Expects two values:

int number of groups ,
float $\sigma_t$ .

_

SIMPLEXS1
Makes a simple material with isotropic transfer matrix (L=0) and mostly down scattering but with a few of the last groups subject to up-scattering. Expects three values values:

int number of groups ( ),
float $\sigma_t$ ,
float scattering to total ratio ( )

_

CHI_XSFILE
Loads transport cross-sections from CHI type cross-section files. Expects to be followed by a filepath specifying the xs-file.

_

EXISTING
Supply handle to an existing cross-section and simply swap them out.

chiPhysicsMaterialSetProperty(materials[1],
                              TRANSPORT_XSECTIONS,
                              CHI_XSFILE,
                              "xs_3_170.cxs",
                              "2518")

_

Example 1

Simple temperature independent thermal conductivity:

materials = {}
materials[1] = chiPhysicsAddMaterial("Test Material");
chiPhysicsMaterialAddProperty(materials[0],THERMAL_CONDUCTIVITY)
chiPhysicsMaterialSetProperty(materials[0],THERMAL_CONDUCTIVITY,SINGLE_VALUE,13.7)

where the thermal conductivity has been set to 13.7.

Example 2

Isotropic Multigroup source set from a lua table/array (12 groups):

materials = {}
materials[1] = chiPhysicsAddMaterial("Test Material");
 
chiPhysicsMaterialAddProperty(materials[1],ISOTROPIC_MG_SOURCE)
 
num_groups = 12
src={}
for g=1,num_groups do
    src[g] = 0.0
end
chiPhysicsMaterialSetProperty(materials[1],ISOTROPIC_MG_SOURCE,FROM_ARRAY,src)

Developer Info

Checklist for adding a new material property:

Make sure you followed the steps depicted in the developer info section for the ChiLua::chiPhysicsMaterialAddProperty function.
Now under the "If user supplied name then find property index"-section add the appropriate code for setting the property index.
Add an else-if block for your property similar to the others. It should be intuitive if you look at the others.
Remember to add the filtering section if you need to support multiple type properties.

Usage Examples:

Author: Jan

Definition at line 645 of file lua_functions.c.

Functions

Detailed Description

Function Documentation

◆ chiPhysicsAddMaterial()

_

Example\n

Usage Examples:

◆ chiPhysicsMaterialAddProperty()

_

PropertyIndex\n

Developer Info

_

Example\n

Usage Examples:

◆ chiPhysicsMaterialGetProperty()

Usage Examples:

◆ chiPhysicsMaterialSetProperty()

_

PropertyIndex\n

OperationIndex\n

_

_

_

_

Example 1

Example 2

Developer Info

Usage Examples: