chi_physics.FieldFunctionGridBased

Example usage:

Create this object:

params = 
{
    param_name1 = value1,
    param_name2 = value2,
    --etc.
}
chi_physics.FieldFunctionGridBased.Create(params)

Required Input parameters

►name       Named to be associated with this field function

type=STRING. Named to be associated with this field function

►sdm_type       The spatial discretization type to be used

type=STRING. The spatial discretization type to be used

Allowable values: "FV", "PWLC", "PWLD", "LagrangeC", "LagrangeD"

Optional Input parameters

►coordinate_system       Coordinate system to apply to element mappings

type=STRING. Coordinate system to apply to element mappings

Default value: "cartesian"

Allowable values: "cartesian", "cylindrical", "spherical"

►initial_value       The initial value to assign to the field function

type=FLOAT. The initial value to assign to the field function

Default value: 0(double)

►num_components       The number of components to attach to the variable

type=INTEGER. The number of components to attach to the variable. Only effective when "type" is VectorN.

Default value: 1

Allowable values: >= 1

►quadrature_order       If supplied, will overwrite the default for the specific discretization-coordinate system combination

type=INTEGER. If supplied, will overwrite the default for the specific discretization-coordinate system combination.

Default value: 0

►unknown_type       The type of the variable for this field function

type=STRING. The type of the variable for this field function

Default value: "Scalar"

Allowable values: "Scalar", "Vector2", "Vector3", "VectorN"