- solutionThe SolutionUserObject to extract data from.
C++ Type:UserObjectName
Description:The SolutionUserObject to extract data from.
SolutionFunction
under construction:Undocumented Class
The SolutionFunction 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/SolutionFunction
Input Parameters
- from_variableThe name of the variable in the file that is to be extracted
C++ Type:std::string
Description:The name of the variable in the file that is to be extracted
- scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
Default:1
C++ Type:double
Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
- add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
Default:0
C++ Type:double
Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.