ParsedGradFunction

construction:Undocumented Class

The ParsedGradFunction has not been documented. The content listed below should be used as a starting point for documenting the class, which 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.


# ParsedGradFunction

!syntax description /Functions/ParsedGradFunction

## Overview

!! Replace these lines with information regarding the ParsedGradFunction object.

## Example Input File Syntax

!! Describe and include an example of how to use the ParsedGradFunction object.

!syntax parameters /Functions/ParsedGradFunction

!syntax inputs /Functions/ParsedGradFunction

!syntax children /Functions/ParsedGradFunction

Defines a function and its gradient using input file parameters.

Input Parameters

grad_x0Partial with respect to x.
Default:0
C++ Type:std::string
Options:
Description:Partial with respect to x.
grad_y0Partial with respect to y.
Default:0
C++ Type:std::string
Options:
Description:Partial with respect to y.
grad_z0Partial with respect to z.
Default:0
C++ Type:std::string
Options:
Description:Partial with respect to z.
valsConstant numeric values, postprocessor names, or function names for vars.
C++ Type:std::vector<std::string>
Options:
Description:Constant numeric values, postprocessor names, or function names for vars.
value0User defined function.
Default:0
C++ Type:std::string
Options:
Description:User defined 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<std::string>
Options:
Description:Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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

Input Parameters