Other Interface Functions

initFinch(name = "unnamedProject", floatType::DataType=Float64)

This initializes the Finch state. The name of the project can be set here. T is the data type to be used for floating point data. T must be a subtype of AbstractFloat. Note that while this generally applies to data arrays relevant to the computation, some places may still use Float64, so the corresponding conversions should be defined.

finalizeFinch()

This closes all files and does any other finalization steps. It does not deallocate any data, so further processing can be done after calling this. However, using Finch functions may cause issues because files have been closed.

customOperator(name, handle)

Define a new symbolic operator to be used in PDE expressions. The name is the symbol that will be used in expressions. The function handle points to the operator's function.

customOperatorFile(filename)

Import a set of symbolic operators defined in a file. The file must contain certain elements. See an example.

VariableTransform

Two sets of variables and a function that transforms one into the other. This is built with the variableTransform function.

variableTransform(var1, var2, func)

Define a function that will transform var1 into var2. var1 and var2 can be variable entities or arrays of them. The function should transform numerical values from one to the other.

transformVariable(xform::VariableTransform)

Perform a variable transformation using a previously defined transform. This can be done, for example, in a postStepFunction or in a callback function for boundary conditions.

preStepFunction(fun)

Set a function to be called before each time step, or stage for multi-stage steppers.

postStepFunction(fun)

Set a function to be called after each time step, or stage for multi-stage steppers.

callbackFunction(fun; name="", args=[], body="")

Include a callback function that can be included in expressions such as the PDE or boundary conditions. A better way to do this is with the macro @callbackFunction before the function definition, which will extract the name, arguments, and body automatically.

exportCode(filename)

Export all generated code including the elemental calculation and assembly loop code for all variables if available.

importCode(filename)

Import elemental calculation and assembly loop code for all variables if possible. The "begin", "end", and "No code" comment lines must match a specific format to properly match them to the variables, so do not modify those lines from the exported code.

cachesim(use)

Toggle the cache simulator target. Set use=true to use the cachesim target. If not using cachesim, don't use this function.

cachesimSolve(var)

When using the cache simulator target, this is used instead of solve().