OOF2: The Manual

Name

XYTFunction (FuncScalarFieldInit) — Initialize a scalar field with a function of x, y, and t.

Synopsis

FuncScalarFieldInit(function)

Details

  • Base class: ScalarFieldInit
  • Parameters:

    function
    A function of x, y, and t Type: A string defining a function of x, y, and t

Description

FuncScalarFieldInit objects are used as the initializer argument in the OOF.Mesh.Set_Field_Initializer command when assigning initial values to scalar Fields on a Mesh. The function parameter must be a valid Python expression which depends on the variables x y, and t. This function will be used to initialize the Field at each point in the Mesh.

[Note] Note

The variable t is set to the time at which the Fieldsare initialized, when OOF.Mesh.Apply_Field_Initializers or OOF.Mesh.Apply_Field_Initializers_at_Time is invoked. Just because an initializer is a function of time does not mean that the Field has the given time dependence.

Examples.  All of the following are legal values for function:

The functions are character strings, and must therefore be enclosed in quotation marks in OOF2 scripts. When entering functions in the GUI, the quotation marks should not be included.