ParsedVectorFunction

under construction:Undocumented Class

The ParsedVectorFunction has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Functions/ParsedVectorFunction

Input Parameters

  • valsConstant numeric values or postprocessor names for vars.

    C++ Type:std::vector

    Options:

    Description:Constant numeric values or postprocessor names for vars.

  • value_y0y-component of function.

    Default:0

    C++ Type:std::string

    Options:

    Description:y-component of function.

  • value_x0x-component of function.

    Default:0

    C++ Type:std::string

    Options:

    Description:x-component of function.

  • varsThe constant variables (excluding t,x,y,z) in the forcing function.

    C++ Type:std::vector

    Options:

    Description:The constant variables (excluding t,x,y,z) in the forcing function.

  • value_z0z-component of function.

    Default:0

    C++ Type:std::string

    Options:

    Description:z-component of function.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References