ParsedGradFunction

under construction:Undocumented Class

The ParsedGradFunction 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/ParsedGradFunction

Input Parameters

  • 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.

  • value0User defined function.

    Default:0

    C++ Type:std::string

    Options:

    Description:User defined function.

  • valsConstant numeric values or postprocessor names for vars.

    C++ Type:std::vector

    Options:

    Description:Constant numeric values or postprocessor names for vars.

  • grad_z0Partial with respect to z.

    Default:0

    C++ Type:std::string

    Options:

    Description:Partial with respect to z.

  • grad_y0Partial with respect to y.

    Default:0

    C++ Type:std::string

    Options:

    Description:Partial with respect to y.

  • grad_x0Partial with respect to x.

    Default:0

    C++ Type:std::string

    Options:

    Description:Partial with respect to x.

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