- comparison_typeThe type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than
C++ Type:MooseEnum
Controllable:No
Description:The type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than
- vector_name_aThe name of the vector in the first vector post-processor to compare
C++ Type:std::string
Controllable:No
Description:The name of the vector in the first vector post-processor to compare
- vector_name_bThe name of the vector in the second vector post-processor to compare
C++ Type:std::string
Controllable:No
Description:The name of the vector in the second vector post-processor to compare
- vectorpostprocessor_aThe first vector post-processor in the comparison
C++ Type:VectorPostprocessorName
Controllable:No
Description:The first vector post-processor in the comparison
- vectorpostprocessor_bThe second vector post-processor in the comparison
C++ Type:VectorPostprocessorName
Controllable:No
Description:The second vector post-processor in the comparison
VectorPostprocessorComparison
Compares two vector post-processors of equal size and produces a boolean value
This post-processor is used to compare two vector post-processor vectors that have the same length. It returns a value of 1 (denoting "true") if the comparison tests between all pairs of elements between the vectors are true. Else it returns a value of 0 (denoting "false"). There are a number of different options for the parameter comparison_type. Denoting the first vector as a and the second as b, these options are as follows:
| Value | Test |
|---|---|
equals | a == b? |
greater_than | a > b? |
greater_than_equals | a >= b? |
less_than | a < b? |
less_than_equals | a <= b? |
All tests use a "fuzzy" comparison; see the corresponding functions in MooseUtils Namespace.
Input Parameters
- absolute_tolerance1e-12Absolute tolerance used in comparisons
Default:1e-12
C++ Type:double
Controllable:No
Description:Absolute tolerance used in comparisons
- 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.
- 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.
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.