- functionThe function which supplies the postprocessor value.
C++ Type:FunctionName
Controllable:No
Description:The function which supplies the postprocessor value.
FunctionValuePostprocessor
Computes the value of a supplied function at a single point (scalable)
If FunctionValuePostprocessor uses something like a ParsedFunction, it may have indirect dependencies on other user objects/postprocessors, since ParsedFunction supports postprocessor values. If this is the case, the "indirect_dependencies" parameter should be used to supply these indirect dependencies, otherwise these dependencies may execute after this postprocessor, and this postprocessor may have inaccurate values.
This object allows to supply postprocessors as arguments to the time and space arguments of the function. Use the "time" to specify the postprocessor passed to the time argument. Use the "point" to specify postprocessors passed to the space argument.
Input Parameters
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
- indirect_dependenciesIf the evaluated function depends on other postprocessors they must be listed here to ensure proper dependency resolution
C++ Type:std::vector<PostprocessorName>
Controllable:No
Description:If the evaluated function depends on other postprocessors they must be listed here to ensure proper dependency resolution
- pointA set of three PostprocessorNames or constant values (or any mixture thereof) that will be passed to the function in the space argument
C++ Type:std::vector<PostprocessorName>
Controllable:No
Description:A set of three PostprocessorNames or constant values (or any mixture thereof) that will be passed to the function in the space argument
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- scale_factor1A scale factor to be applied to the function
Default:1
C++ Type:double
Controllable:Yes
Description:A scale factor to be applied to the function
- timeThe PostprocessorName or constant value that will be passed to the function in the time argument.
C++ Type:PostprocessorName
Controllable:No
Description:The PostprocessorName or constant value that will be passed to the function in the time argument.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
- 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
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.