- vector_name_aThe name of the vector in the first vector post-processor to compare
C++ Type:std::string
Description:The name of the vector in the first vector post-processor to compare
- comparison_typeThe type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than
C++ Type:MooseEnum
Description:The type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than
- vectorpostprocessor_aThe first vector post-processor in the comparison
C++ Type:VectorPostprocessorName
Description:The first vector post-processor in the comparison
- vector_name_bThe name of the vector in the second vector post-processor to compare
C++ Type:std::string
Description:The name of the vector in the second vector post-processor to compare
- vectorpostprocessor_bThe second vector post-processor in the comparison
C++ Type:VectorPostprocessorName
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 "-1" (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
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, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
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, FINAL, CUSTOM.
Optional Parameters
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
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.
- outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
- 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.
- 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
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).
- force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Description:Forces the GeneralUserObject to be executed in PREAUX