OOF2: The Manual

Name

XYTFunction (FuncThreeVectorFieldInit) — Initialize a three-vector field with a function of x and y.

Synopsis

FuncThreeVectorFieldInit(fx,fy,fz)

Details

  • Base class: ThreeVectorFieldInit
  • Parameters:

    fx
    The x component of the field as a function of x, y, and t Type: A string defining a function of x and y.
    fy
    The y component of the field as a function of x, y, and t Type: A string defining a function of x and y.
    fz
    The z component of the field as a function of x, y, and t Type: A string defining a function of x and y.

Description

FuncThreeVectorFieldInit objects are used as the initializer argument in the OOF.Mesh.Set_Field_Initializer command when assigning initial values to three-dimensional vector fields on a Mesh. The fx, fy, and fz parameters must be valid Python expression which depend on the variables x, y, and t. These functions will be used to initialize the x, y, and z components of 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 fx, fy, or fz:

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.