ParsedVectorFunction

construction:Undocumented Class

The ParsedVectorFunction 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.


# ParsedVectorFunction

!syntax description /Functions/ParsedVectorFunction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Functions/ParsedVectorFunction

!syntax inputs /Functions/ParsedVectorFunction

!syntax children /Functions/ParsedVectorFunction

Return a vector component values based on a string function.

Input Parameters

curl_x0x-component of curl of function.
Default:0
C++ Type:std::string
Options:
Description:x-component of curl of function.
curl_y0y-component of curl of function.
Default:0
C++ Type:std::string
Options:
Description:y-component of curl of function.
curl_z0z-component of curl of function.
Default:0
C++ Type:std::string
Options:
Description:z-component of curl of function.
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.
value_x0x-component of function.
Default:0
C++ Type:std::string
Options:
Description:x-component of function.
value_y0y-component of function.
Default:0
C++ Type:std::string
Options:
Description:y-component of function.
value_z0z-component of function.
Default:0
C++ Type:std::string
Options:
Description:z-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<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