PostprocessorComparison

Compares two post-processors and produces a boolean value

This post-processor is used to compare two post-processor (or constant) values. It returns a value of 1 for "true" and 0 for "false". There are a number of different options for the parameter comparison_type. Denoting the first value as a and the second as b, these options are as follows:

ValueTest
equalsa == b?
greater_thana > b?
greater_than_equalsa >= b?
less_thana < b?
less_than_equalsa <= b?

All tests use a "fuzzy" comparison; see the corresponding functions in MooseUtils Namespace.

Input Parameters

  • comparison_typeThe type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than

    C++ Type:MooseEnum

    Options:equals greater_than_equals less_than_equals greater_than less_than

    Description:The type of comparison to perform. Options are: equals greater_than_equals less_than_equals greater_than less_than

  • value_aThe first post-processor or value in the comparison

    C++ Type:PostprocessorName

    Options:

    Description:The first post-processor or value in the comparison

  • value_bThe second post-processor or value in the comparison

    C++ Type:PostprocessorName

    Options:

    Description:The second post-processor or value in the comparison

Required 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, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    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.

  • absolute_tolerance1e-12Absolute tolerance used in comparisons

    Default:1e-12

    C++ Type:double

    Options:

    Description:Absolute tolerance used in comparisons

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    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

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files

References