- solutionThe name of the SolutionUserObject
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The name of the SolutionUserObject
- variableThe name of the variable that this kernel operates on
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this kernel operates on
SolutionScalarAux
This AuxScalarKernel works in conjunction with a SolutionUserObject to set scalar variable values. These values can be scaled and/or added by utilizing the scale_factor or add_factor parameters.
Sets scalar variable by using information from a SolutionUserObject.
Input Parameters
- add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'
- execute_onLINEARThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- from_variableThe name of the variable to extract from the file
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable to extract from the file
- scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.