PercolationUserObject

Enhanced FeatureFloodCount that provides a list of clusters that touch a specified boundary

This object performs the work of FeatureFloodCount, which it inherits from. The flood_entity_type is hardcoded to ELEMENTAL. After the flood counting pass another pass is made over the internal datastructure containing the cluser IDs per element. Clusters in all elements adjacent to at least one of the selected boundaries are flagged as providing a percolated path to a surface.

This object is to be used in conjunction with PercolationAux which assigns the percolation status to an AuxVariable.

Input Parameters

  • boundariesSet of free surfaces. Clusters touching any of these are set as percolated.

    C++ Type:std::vector

    Description:Set of free surfaces. Clusters touching any of these are set as percolated.

  • variableThe variable(s) for which to find connected regions of interests, i.e. "features".

    C++ Type:std::vector

    Description:The variable(s) for which to find connected regions of interests, i.e. "features".

Required Parameters

  • enable_var_coloringFalseInstruct the Postprocessor to populate the variable index map.

    Default:False

    C++ Type:bool

    Description:Instruct the Postprocessor to populate the variable index map.

  • connecting_thresholdThe threshold for which an existing feature may be extended (defaults to "threshold")

    C++ Type:double

    Description:The threshold for which an existing feature may be extended (defaults to "threshold")

  • use_less_than_threshold_comparisonTrueControls whether features are defined to be less than or greater than the threshold value.

    Default:True

    C++ Type:bool

    Description:Controls whether features are defined to be less than or greater than the threshold value.

  • compute_var_to_feature_mapFalseInstruct the Postprocessor to compute the active vars to features map

    Default:False

    C++ Type:bool

    Description:Instruct the Postprocessor to compute the active vars to features map

  • threshold0.5The threshold value for which a new feature may be started

    Default:0.5

    C++ Type:double

    Description:The threshold value for which a new feature may be started

  • 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.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • compute_halo_mapsFalseInstruct the Postprocessor to communicate proper halo information to all ranks

    Default:False

    C++ Type:bool

    Description:Instruct the Postprocessor to communicate proper halo information to all ranks

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

  • use_single_mapTrueDetermine whether information is tracked per coupled variable or consolidated into one (default: true)

    Default:True

    C++ Type:bool

    Description:Determine whether information is tracked per coupled variable or consolidated into one (default: true)

  • 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).

  • condense_map_infoFalseDetermines whether we condense all the node values when in multimap mode (default: false)

    Default:False

    C++ Type:bool

    Description:Determines whether we condense all the node values when in multimap mode (default: false)

  • use_global_numberingTrueDetermine whether or not global numbers are used to label features on multiple maps (default: true)

    Default:True

    C++ Type:bool

    Description:Determine whether or not global numbers are used to label features on multiple maps (default: true)

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files