Functions
void	chi_lua::chiFFInterpolationGetValue (int FFIHandle)

Handle	chi_lua::chiFFInterpolationCreate (int FFITypeIndex)

void	chi_lua::chiFFInterpolationExportPython (int FFIHandle, char BaseName)

Handle	chi_lua::chiFFInterpolationSetProperty (int FFIHandle, int PropertyIndex)

void	chi_lua::chiFFInterpolationInitialize (int FFIHandle)

void	chi_lua::chiFFInterpolationExecute (int FFIHandle)

Detailed Description

Function Documentation

◆ chiFFInterpolationCreate()

Handle chi_lua::chiFFInterpolationCreate ( int FFITypeIndex )

Creates a new field function interpolation.

Parameters

FFITypeIndex int Type of field function interpolation.

_

FFITypeIndex\n

POINT = A point probe.
SLICE = Two dimensional slice of the mesh.
LINE = Line defined by two points.
VOLUME = Volume either referring to the entire volume or that of a logical volume assigned to the interpolator.

Returns: Handle int Handle to the created interpolation.

Usage Examples:

Author: Jan

Definition at line 1248 of file lua_functions.c.

◆ chiFFInterpolationExecute()

void chi_lua::chiFFInterpolationExecute ( int FFIHandle )

Execute interpolator.

Parameters

FFIHandle int Handle to the field function interpolation.

Usage Examples:

Author: Jan

Definition at line 1524 of file lua_functions.c.

◆ chiFFInterpolationExportPython()

void chi_lua::chiFFInterpolationExportPython	(	int	FFIHandle,
		char	BaseName
	)

Export interpolation to python line,contour plot depending on the type of interpolation.

Parameters

FFIHandle	int Handle to the field function interpolation.
BaseName	char Base name to be used for exported files.

Usage Examples:

Author: Jan

Definition at line 1292 of file lua_functions.c.

◆ chiFFInterpolationGetValue()

void chi_lua::chiFFInterpolationGetValue ( int FFIHandle )

Gets the value(s) associated with an interpolation provided the interpolation type has an associated value.

Parameters

FFIHandle int Handle to the field function interpolation.

Note:

Currently only the POINT, LINE and VOLUME interpolation supports obtaining a value. For the POINT and VOLUME types a single value is returned. For the LINE type a table of tables is returned with the first index being the field function (in the order it was assigned) and the second index being the point index.

Usage Examples:

Author: Jan

Definition at line 1186 of file lua_functions.c.

◆ chiFFInterpolationInitialize()

void chi_lua::chiFFInterpolationInitialize ( int FFIHandle )

Initialize interpolator.

Parameters

FFIHandle int Handle to the field function interpolation.

Usage Examples:

Author: Jan

Definition at line 1473 of file lua_functions.c.

◆ chiFFInterpolationSetProperty()

Handle chi_lua::chiFFInterpolationSetProperty	(	int	FFIHandle,
		int	PropertyIndex
	)

Creates a new field function interpolation.

Parameters

FFIHandle	int Handle to the field function interpolation.
PropertyIndex	int Type of property to set.

_

PropertyIndex\n

ADD_FIELDFUNCTION = Add field function to interpolation.
SET_FIELDFUNCTIONS = Sets the field functions to interpolate using a lua table.
PROBEPOINT = Reference point for POINT type FFIs.
SLICE_POINT = Reference point for SLICE type FFIs.
SLICE_NORMAL = Normal of slice plane.
SLICE_TANGENT = Tangent vector of slice plane.
SLICE_BINORM = Binorm vector of slice plane.
LINE_FIRSTPOINT = Line start point.
LINE_SECONDPOINT = Line end point.
LINE_NUMBEROFPOINTS = Number of points to put in the line interpolator. Minimum 2.
LINE_CUSTOM_ARRAY = Adds custom array to line interpolator.
OPERATION = Some interpolations support operation types. See OpTypes.
LOGICAL_VOLUME = To be followed by a handle to a logical volume to be used by the interpolator.

OpTypes

Basic operations are volume sum, volume average or volume max. The volume sum is computed from

$Sum = \sum_k \sum_i u_i \int_V N_i .dV.$

The volume average is computed from

$Avg = \frac{\sum_k \sum_i u_i \int_V N_i .dV}{\sum_k \sum_i \int_V N_i .dV}$

The volume max is simply $max_{k,i}(u_i)$ .

OP_SUM
For volume interpolations, computes the volume integral.

OP_AVG
For volume interpolations, computes the volume average.
OP_MAX
For volume interpolations, computes the volume max.

A modified version of these operations are also available. Instead of OP_SUM, OP_AVG and OP_MAX, the user may supply OP_SUM_LUA, OP_AVG_LUA and OP_MAX_LUA which then needs to be followed by a string value LuaFunctionName of a lua function of the following form:

function LuaFunctionName(ff_value, mat_id)
 ret_val = 0.0;   --Or some computation
 return ret_val
end

This code will be called to return a value to be used instead of the field function .
Example:

xwing=2.0
function IntegrateMaterialVolume(ff_value,mat_id)
    return xwing
end
ffi2 = chiFFInterpolationCreate(VOLUME)
curffi = ffi2
chiFFInterpolationSetProperty(curffi,OPERATION,OP_SUM_LUA,"IntegrateMaterialVolume")
chiFFInterpolationSetProperty(curffi,LOGICAL_VOLUME,vol0)
chiFFInterpolationSetProperty(curffi,ADD_FIELDFUNCTION,fftemp)
 
chiFFInterpolationInitialize(curffi)
chiFFInterpolationExecute(curffi)
print(chiFFInterpolationGetValue(curffi))

The code above will return 2.0 times the volume of cells included in the logical volume vol0.

Returns: Handle int Handle to the created interpolation.

Usage Examples:

Author: Jan

Definition at line 1421 of file lua_functions.c.

Functions

Detailed Description

Function Documentation

◆ chiFFInterpolationCreate()

_

FFITypeIndex\n

Usage Examples:

◆ chiFFInterpolationExecute()

Usage Examples:

◆ chiFFInterpolationExportPython()

Usage Examples:

◆ chiFFInterpolationGetValue()

Note:

Usage Examples:

◆ chiFFInterpolationInitialize()

Usage Examples:

◆ chiFFInterpolationSetProperty()

_

PropertyIndex\n

OpTypes

Usage Examples: