<!– MOOSE Documentation Stub: Remove this when content is added. –>

ParsedVectorFunction

under construction:Undocumented Class

The ParsedVectorFunction has not been documented. The content contained on this page includes the typical automatic 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, postprocessor names, or function names for vars.

    C++ Type:std::vector

    Options:

    Description:Constant numeric values, postprocessor names, or function 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.

  • varsVariables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

    C++ Type:std::vector

    Options:

    Description:Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

  • 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