https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
FeatureFloodCount Class Reference

This object will mark nodes or elements of continuous regions all with a unique number for the purpose of counting or "coloring" unique regions in a solution. More...

#include <FeatureFloodCount.h>

Inheritance diagram for FeatureFloodCount:
[legend]

Classes

class  FeatureData
 

Public Types

enum class  FieldType {
  UNIQUE_REGION , VARIABLE_COLORING , GHOSTED_ENTITIES , HALOS ,
  CENTROID , ACTIVE_BOUNDS , INTERSECTS_SPECIFIED_BOUNDARY
}
 
enum class  Status : unsigned char { CLEAR = 0x0 , MARKED = 0x1 , DIRTY = 0x2 , INACTIVE = 0x4 }
 This enumeration is used to indicate status of the grains in the _unique_grains data structure. More...
 
enum class  BoundaryIntersection : unsigned char {
  NONE = 0x0 , ANY_BOUNDARY = 0x1 , PRIMARY_PERCOLATION_BOUNDARY = 0x2 , SECONDARY_PERCOLATION_BOUNDARY = 0x4 ,
  SPECIFIED_BOUNDARY = 0x8
}
 This enumeration is used to inidacate status of boundary intersections. More...
 
typedef DataFileName DataFileParameterType
 
typedef FunctorBase< Real > FunctorType
 
typedef Real ValueType
 
typedef typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type GradientType
 
typedef ValueType DotType
 
enum  TEST_TYPE
 

Public Member Functions

 FeatureFloodCount (const InputParameters &parameters)
 
virtual void initialSetup () override
 
virtual void meshChanged () override
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
virtual Real getValue () const override
 
std::size_t getNumberActiveFeatures () const
 Return the number of active features.
 
virtual std::size_t getTotalFeatureCount () const
 Returns the total feature count (active and inactive ids, useful for sizing vectors)
 
virtual bool doesFeatureIntersectBoundary (unsigned int feature_id) const
 Returns a Boolean indicating whether this feature intersects any boundary.
 
virtual bool doesFeatureIntersectSpecifiedBoundary (unsigned int feature_id) const
 Returns a Boolean indicating whether this feature intersects boundaries in a user-supplied list.
 
virtual bool isFeaturePercolated (unsigned int feature_id) const
 Returns a Boolean indicating whether this feature is percolated (e.g.
 
virtual Point featureCentroid (unsigned int feature_id) const
 Returns the centroid of the designated feature (only supported without periodic boundaries)
 
virtual const std::vector< unsigned int > & getVarToFeatureVector (dof_id_type elem_id) const
 Returns a list of active unique feature ids for a particular element.
 
virtual unsigned int getFeatureVar (unsigned int feature_id) const
 Returns the variable representing the passed in feature.
 
std::size_t numCoupledVars () const
 Returns the number of coupled varaibles.
 
const std::vector< MooseVariable * > & getCoupledVars () const
 Returns a const vector to the coupled variable pointers.
 
const std::vector< MooseVariableFEBase * > & getFECoupledVars () const
 Returns a const vector to the coupled MooseVariableFEBase pointers.
 
virtual Real getEntityValue (dof_id_type entity_id, FieldType field_type, std::size_t var_index=0) const
 
bool isElemental () const
 
const std::vector< FeatureData > & getFeatures () const
 Return a constant reference to the vector of all discovered features.
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
std::set< UserObjectName > getDependObjects () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool needThreadedCopy () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void timestepSetup ()
 
virtual void timestepSetup () override
 
virtual void jacobianSetup ()
 
virtual void jacobianSetup () override
 
virtual void residualSetup ()
 
virtual void residualSetup () override
 
virtual void customSetup (const ExecFlagType &)
 
virtual void customSetup (const ExecFlagType &exec_type) override
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const std::vector< MooseVariableScalar * > & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyByName (const std::string &prop_name_in)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOldByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialProperty (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOld (const std::string &name)
 
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlder (const std::string &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase * > > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
virtual bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
const PostprocessorValue & getCurrentValue () const
 
const std::string & PPName () const
 
virtual bool hasBlocks (SubdomainID) const override
 
bool supportsFaceArg () const override final
 
bool supportsElemSideQpArg () const override final
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
FunctorReturnType< Real, FET >::type genericEvaluate (const Space &r, const State &state) const
 
const MooseFunctorName & functorName () const
 
void setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
 
virtual bool isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
 
virtual bool isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
 
bool isInternalFace (const FaceInfo &) const
 
virtual bool isConstant () const
 
virtual bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
void checkFace (const Moose::FaceArg &face) const
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialProperty (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasKokkosMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const std::vector< MooseVariableFieldBase * > & getCoupledMooseVars () const
 
const std::vector< MooseVariable * > & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable * > & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable * > & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorTagVectorGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorTagVectorGradientsByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorDofValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorTagVectorGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorTagVectorGradients (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorNodalValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorTagVectorDofValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledValues (const std::string &var_name) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradients (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValues (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValues (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOld (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOlder (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledDofValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledDots (const std::string &var_name) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosCoupledNodalDots (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValues (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradients (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValues (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValues (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradientsOld (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValuesOld (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableGradient kokkosCoupledVectorGradientsOlder (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDofValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorDots (const std::string &var_name) const
 
Moose::Kokkos::VectorVariableValue kokkosCoupledVectorNodalDots (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagDofValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagDofValuesByName (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagDofValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledVectorTagDofValues (const std::string &var_name, const std::string &tag_param_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValues (const std::string &var_name) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradients (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValues (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValue (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValues (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValuesOld (const std::string &var_name) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradientsOld (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValuesOld (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValueOld (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValuesOld (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableGradient kokkosADCoupledGradientsOlder (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValueOlder (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDofValuesOlder (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledDots (const std::string &var_name) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::ADVariableValue kokkosADCoupledNodalDots (const std::string &var_name) const
 
Moose::Kokkos::Scalar< const Real > kokkosCoupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
Moose::Kokkos::VariableValue kokkosZeroValue () const
 
Moose::Kokkos::VariableGradient kokkosZeroGradient () const
 
Moose::Kokkos::VariableValue kokkosZeroNodalValue () const
 
const std::set< MooseVariableFieldBase * > & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase * > checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
virtual std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 
static bool restricted (const std::set< BoundaryID > &ids)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 
 ALL
 
 ANY
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 
static const std::size_t invalid_size_t = std::numeric_limits<std::size_t>::max()
 
static const unsigned int invalid_id = std::numeric_limits<unsigned int>::max()
 
static const processor_id_type invalid_proc_id
 

Protected Member Functions

template<typename T >
bool isBoundaryEntity (const T *entity) const
 Returns a Boolean indicating whether the entity is on one of the desired boundaries.
 
virtual void updateFieldInfo ()
 This method is used to populate any of the data structures used for storing field data (nodal or elemental).
 
bool flood (const DofObject *dof_object, std::size_t current_index)
 This method will check if the current entity is above the supplied threshold and "mark" it.
 
virtual Real getThreshold (std::size_t current_index) const
 Return the starting comparison threshold to use when inspecting an entity during the flood stage.
 
virtual Real getConnectingThreshold (std::size_t current_index) const
 Return the "connecting" comparison threshold to use when inspecting an entity during the flood stage.
 
bool compareValueWithThreshold (Real entity_value, Real threshold) const
 This method is used to determine whether the current entity value is part of a feature or not.
 
virtual bool isNewFeatureOrConnectedRegion (const DofObject *dof_object, std::size_t &current_index, FeatureData *&feature, Status &status, unsigned int &new_id)
 Method called during the recursive flood routine that should return whether or not the current entity is part of the current feature (if one is being explored), or if it's the start of a new feature.
 
void expandPointHalos ()
 This method takes all of the partial features and expands the local, ghosted, and halo sets around those regions to account for the diffuse interface.
 
void expandEdgeHalos (unsigned int num_layers_to_expand)
 This method expands the existing halo set by some width determined by the passed in value.
 
template<typename T >
void visitNeighborsHelper (const T *curr_entity, std::vector< const T * > neighbor_entities, FeatureData *feature, bool expand_halos_only, bool topological_neighbor, bool disjoint_only)
 The actual logic for visiting neighbors is abstracted out here.
 
virtual void prepareDataForTransfer ()
 This routine uses the local flooded data to build up the local feature data structures (_partial feature_sets).
 
void serialize (std::string &serialized_buffer, unsigned int var_num=invalid_id)
 This routines packs the _partial_feature_sets data into a structure suitable for parallel communication operations.
 
void deserialize (std::vector< std::string > &serialized_buffers, unsigned int var_num=invalid_id)
 This routine takes the vector of byte buffers (one for each processor), deserializes them into a series of FeatureSet objects, and appends them to the _feature_sets data structure.
 
virtual void mergeSets ()
 This routine is called on the primary rank only and stitches together the partial feature pieces seen on any processor.
 
virtual void consolidateMergedFeatures (std::vector< std::list< FeatureData > > *saved_data=nullptr)
 This method consolidates all of the merged information from _partial_feature_sets into the _feature_sets vectors.
 
virtual bool areFeaturesMergeable (const FeatureData &f1, const FeatureData &f2) const
 Method for determining whether two features are mergeable.
 
virtual processor_id_type numberOfDistributedMergeHelpers () const
 Returns a number indicating the number of merge helpers when running in parallel based on certain implementer decided criteria.
 
void communicateAndMerge ()
 This routine handles all of the serialization, communication and deserialization of the data structures containing FeatureData objects.
 
virtual void restoreOriginalDataStructures (std::vector< std::list< FeatureData > > &)
 
void sortAndLabel ()
 Sort and assign ids to features based on their position in the container after sorting.
 
void scatterAndUpdateRanks ()
 Calls buildLocalToGlobalIndices to build the individual local to global indicies for each rank and scatters that information to all ranks.
 
virtual void buildLocalToGlobalIndices (std::vector< std::size_t > &local_to_global_all, std::vector< int > &counts) const
 This routine populates a stacked vector of local to global indices per rank and the associated count vector for scattering the vector to the ranks.
 
void buildFeatureIdToLocalIndices (unsigned int max_id)
 This method builds a lookup map for retrieving the right local feature (by index) given a global index or id.
 
virtual void clearDataStructures ()
 Helper routine for clearing up data structures during initialize and prior to parallel communication.
 
void updateBoundaryIntersections (FeatureData &feature) const
 Update the feature's attributes to indicate boundary intersections.
 
void appendPeriodicNeighborNodes (FeatureData &feature) const
 This routine adds the periodic node information to our data structure prior to packing the data this makes those periodic neighbors appear much like ghosted nodes in a multiprocessor setting.
 
void updateRegionOffsets ()
 This routine updates the _region_offsets variable which is useful for quickly determining the proper global number for a feature when using multimap mode.
 
std::string deduceFunctorName (const std::string &name) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
virtual void getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned int > coupledIndices (const std::string &var_name) const
 
virtual const VariableValue & coupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue * > coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > * > coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > * > coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > * > coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValue & coupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue * > adCoupledValues (const std::string &var_name) const
 
const ADVariableValue & adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue * > adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue * > coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue * > coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue * > coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue * > coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient * > coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient * > coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient * > coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient * > coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValue & coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue * > coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue * > coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue * > coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValue & coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue * > coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariable & writableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValue & writableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValue & coupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue * > coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValue & coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient * > coupledGradients (const std::string &var_name) const
 
const ADVariableGradient & adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradient & adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient * > adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > * > coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > * > coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > * > coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradient & adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecond & adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecond & adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient * > coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradient & coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurl & adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledDots (const std::string &var_name) const
 
virtual const VariableValue & coupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue * > adCoupledDots (const std::string &var_name) const
 
const ADVariableValue & adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::type & adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue * > coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValue & coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValue & adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adZeroValue () const
 
const ADVariableGradient & adZeroGradient () const
 
const ADVariableSecond & adZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBase * getFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp)
 
std::vector< const MooseVariableFieldBase * > getFieldVars (const std::string &var_name) const
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
std::vector< const T * > getVarsHelper (const std::string &var_name) const
 
MooseVariable * getVar (const std::string &var_name, unsigned int comp)
 
const MooseVariable * getVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundaryNodes () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundarySides () const
 
KOKKOS_FUNCTION ContiguousNodeID kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION auto kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) const
 
void visitNodalNeighbors (const Node *node, FeatureData *feature, bool expand_halos_only)
 These two routines are utility routines used by the flood routine and by derived classes for visiting neighbors.
 
void visitElementalNeighbors (const Elem *elem, FeatureData *feature, bool expand_halos_only, bool disjoint_only)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

std::vector< MooseVariableFEBase * > _fe_vars
 The vector of coupled in variables.
 
std::vector< MooseVariable * > _vars
 The vector of coupled in variables cast to MooseVariable.
 
const DofMap & _dof_map
 Reference to the dof_map containing the coupled variables.
 
const Real _threshold
 The threshold above (or below) where an entity may begin a new region (feature)
 
Real _step_threshold
 
const Real _connecting_threshold
 The threshold above (or below) which neighboring entities are flooded (where regions can be extended but not started)
 
Real _step_connecting_threshold
 
MooseMesh & _mesh
 A reference to the mesh.
 
unsigned long _var_number
 This variable is used to build the periodic node map.
 
const bool _single_map_mode
 This variable is used to indicate whether or not multiple maps are used during flooding.
 
const bool _condense_map_info
 
const bool _global_numbering
 This variable is used to indicate whether or not we identify features with unique numbers on multiple maps.
 
const bool _var_index_mode
 This variable is used to indicate whether the maps will contain unique region information or just the variable numbers owning those regions.
 
const bool _compute_halo_maps
 Indicates whether or not to communicate halo map information with all ranks.
 
const bool _compute_var_to_feature_map
 Indicates whether or not the var to feature map is populated.
 
const bool _use_less_than_threshold_comparison
 Use less-than when comparing values against the threshold value.
 
const std::size_t _n_vars
 
const std::size_t _maps_size
 Convenience variable holding the size of all the datastructures size by the number of maps.
 
const processor_id_type _n_procs
 Convenience variable holding the number of processors in this simulation.
 
std::vector< std::set< dof_id_type > > _entities_visited
 This variable keeps track of which nodes have been visited during execution.
 
std::vector< std::map< dof_id_type, int > > _var_index_maps
 This map keeps track of which variables own which nodes.
 
std::unordered_map< dof_id_type, std::vector< const Elem * > > _nodes_to_elem_map
 The data structure used to find neighboring elements give a node ID.
 
std::vector< unsigned int > _feature_counts_per_map
 The number of features seen by this object per map.
 
unsigned int _feature_count
 The number of features seen by this object (same as summing _feature_counts_per_map)
 
std::vector< std::list< FeatureData > > _partial_feature_sets
 The data structure used to hold partial and communicated feature data, during the discovery and merging phases.
 
std::vector< FeatureData > & _feature_sets
 The data structure used to hold the globally unique features.
 
std::vector< FeatureData > _volatile_feature_sets
 Derived objects (e.g.
 
std::vector< std::map< dof_id_type, int > > _feature_maps
 The feature maps contain the raw flooded node information and eventually the unique grain numbers.
 
std::vector< std::size_t > _local_to_global_feature_map
 The vector recording the local to global feature indices.
 
std::vector< std::size_t > _feature_id_to_local_index
 The vector recording the grain_id to local index (several indices will contain invalid_size_t)
 
libMesh::PeriodicBoundaries * _pbs
 A pointer to the periodic boundary constraints object.
 
std::unique_ptr< libMesh::PointLocatorBase > _point_locator
 
const PostprocessorValue & _element_average_value
 Average value of the domain which can optionally be used to find features in a field.
 
std::map< dof_id_type, int > _ghosted_entity_ids
 The map for holding reconstructed ghosted element information.
 
std::vector< std::map< dof_id_type, int > > _halo_ids
 The data structure for looking up halos around features.
 
std::multimap< dof_id_type, dof_id_type > _periodic_node_map
 The data structure which is a list of nodes that are constrained to other nodes based on the imposed periodic boundary conditions.
 
std::unordered_set< dof_id_type > _all_boundary_entity_ids
 The set of entities on the boundary of the domain used for determining if features intersect any boundary.
 
std::map< dof_id_type, std::vector< unsigned int > > _entity_var_to_features
 
std::vector< unsigned int > _empty_var_to_features
 
std::vector< BoundaryID > _primary_perc_bnds
 
std::vector< BoundaryID > _secondary_perc_bnds
 
std::vector< BoundaryID > _specified_bnds
 
const bool _is_elemental
 Determines if the flood counter is elements or not (nodes)
 
bool _is_boundary_restricted
 Indicates that this object should only run on one or more boundaries.
 
ConstBndElemRange * _bnd_elem_range
 Boundary element range pointer.
 
const bool _is_primary
 Convenience variable for testing primary rank.
 
const Moose::CoordinateSystemType & _coord_sys
 
const THREAD_ID _tid
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
Assembly & _assembly
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const bool _is_kokkos_object
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const std::string & _pp_name
 
const PostprocessorValue & _current_value
 
const Parallel::Communicator & _communicator
 
const InputParameters & _c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase & _c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _coupled_vars
 
std::vector< MooseVariableFieldBase * > _coupled_moose_vars
 
std::vector< MooseVariable * > _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable * > _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable * > _coupled_array_moose_vars
 
std::vector< MooseVariableField< Real > * > _coupled_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue > _ad_default_gradient
 
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue > _ad_default_second
 
MooseArray< ADRealVectorValue > _ad_default_curl
 
const VariableValue & _zero
 
const VariablePhiValue & _phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient & _grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient & _grad_phi_zero
 
const VariableSecond & _second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond & _second_phi_zero
 
const VectorVariableValue & _vector_zero
 
const VectorVariableCurl & _vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Private Types

typedef Moose::ElemArg ElemArg
 
typedef Moose::ElemQpArg ElemQpArg
 
typedef Moose::ElemSideQpArg ElemSideQpArg
 
typedef Moose::FaceArg FaceArg
 
typedef Moose::ElemPointArg ElemPointArg
 
typedef Moose::NodeArg NodeArg
 
enum  FuncAge
 
enum  VarType
 

Private Member Functions

const Moose::Functor< T > * defaultFunctor (const std::string &name)
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
bool reportersAdded () const
 
void possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
 
virtual std::string meshPropertyPrefix (const std::string &data_name) const
 
const RestartableDataValue & getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const VariableValue * getDefaultValue (const std::string &var_name) const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
void checkVar (const std::string &var_name) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
Moose::MaterialDataType getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const
 
unsigned int getMaxQps () const
 
void addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)
 
const PostprocessorValue & declareValue (const MooseObject &moose_object)
 
ValueType evaluate (const ElemArg &elem, const Moose::StateArg &state) const override final
 
ValueType evaluate (const FaceArg &face, const Moose::StateArg &state) const override final
 
ValueType evaluate (const ElemQpArg &qp, const Moose::StateArg &state) const override final
 
ValueType evaluate (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final
 
ValueType evaluate (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
 
ValueType evaluate (const NodeArg &node, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const ElemArg &elem, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const FaceArg &face, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const ElemQpArg &qp, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
 
GradientType evaluateGradient (const NodeArg &node, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const ElemArg &elem, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const FaceArg &face, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const ElemQpArg &qp, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
 
DotType evaluateDot (const NodeArg &node, const Moose::StateArg &state) const override final
 
void evaluateDotWarning () const
 
virtual bool isADObject () const override
 
void clearCacheData ()
 
ValueType queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Real > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
 
ValueType queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const OutputTools< T >::VariableValue & vectorTagValueHelper (const std::string &var_names, TagID tag, unsigned int index=0) const
 
const OutputTools< T >::VariableValue & vectorTagValueHelper (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const OutputTools< T >::VariableValue & vectorTagDofValueHelper (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const OutputTools< T >::VariableValue & vectorTagDofValueHelper (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
void requestStates (const std::string &var_name, const TagName &tag_name, const unsigned int comp)
 
void checkFuncType (const std::string var_name, VarType t, FuncAge age) const
 
const VectorVariableValue * getDefaultVectorValue (const std::string &var_name) const
 
const ArrayVariableValue * getDefaultArrayValue (const std::string &var_name) const
 
const T & getDefaultNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const RealVectorValue & getDefaultNodalValue (const std::string &var_name, unsigned int) const
 
const RealEigenVector & getDefaultNodalValue (const std::string &var_name, unsigned int) const
 
const Moose::Functor< T > & getDefaultFunctor (const std::string &var_name) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagVariables (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagVectorVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const
 
Moose::Kokkos::Variable kokkosCoupledVectorTagVectorVariables (const std::string &var_name, const std::string &tag_name) const
 
Moose::Kokkos::Variable kokkosZeroVariable () const
 
std::set< MooseVariableFieldBase * > checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void initializeBoundaryRestrictable ()
 
void initializeKokkosBoundaryRestrictable ()
 

Static Private Member Functions

template<class T >
static void sort (std::set< T > &)
 
template<class T >
static void sort (std::vector< T > &container)
 
template<class T >
static void reserve (std::set< T > &, std::size_t)
 
template<class T >
static void reserve (std::vector< T > &container, std::size_t size)
 
template<class T >
static bool contains (std::set< T > &container, const T &item)
 
template<class T >
static bool contains (std::vector< T > &container, const T &item)
 
static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

std::deque< const DofObject * > _entity_queue
 The data structure for maintaining entities to flood during discovery.
 
UserObject * _primary_thread_copy
 
std::set< std::string > _supplied_uo
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
const InputParameters & _ri_params
 
FEProblemBase & _ri_fe_problem_base
 
const ReporterData & _ri_reporter_data
 
const MooseObject & _ri_moose_object
 
const InputParameters & _dni_params
 
FEProblemBase & _dni_feproblem
 
const MooseObject *const _dni_moose_object_ptr
 
const InputParameters & _si_params
 
FEProblemBase & _si_feproblem
 
THREAD_ID _si_tid
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const InputParameters & _sc_parameters
 
const std::string & _sc_name
 
const bool _sc_is_implicit
 
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _coupled_scalar_vars
 
std::unordered_map< std::string, std::unique_ptr< VariableValue > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< ADVariableValue > > _dual_default_value
 
std::vector< MooseVariableScalar * > _coupled_moose_scalar_vars
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _sc_coupled_vars
 
std::set< TagID > _sc_coupleable_vector_tags
 
std::set< TagID > _sc_coupleable_matrix_tags
 
const MooseObject & _mi_moose_object
 
const bool _mi_boundary_restricted
 
const std::set< SubdomainID > & _mi_block_ids
 
const std::set< BoundaryID > & _mi_boundary_ids
 
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > > _optional_property_proxies
 
const std::string _ti_name
 
const MooseObject & _pp_moose_object
 
MooseApp & _oi_moose_app
 
OutputWarehouse & _oi_output_warehouse
 
std::set< OutputName > _oi_outputs
 
const InputParameters & _fi_params
 
const std::string _fi_name
 
SubProblem *const _fi_subproblem
 
const THREAD_ID _fi_tid
 
std::vector< std::unique_ptr< Moose::Functor< Real > > > _default_real_functors
 
std::vector< std::unique_ptr< Moose::Functor< ADReal > > > _default_ad_real_functors
 
std::set< ExecFlagType > _clearance_schedule
 
bool _always_evaluate
 
dof_id_type _current_qp_map_key
 
std::vector< std::pair< bool, ValueType > > * _current_qp_map_value
 
std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > > _qp_to_value
 
dof_id_type _current_side_qp_map_key
 
std::vector< std::vector< std::pair< bool, ValueType > > > * _current_side_qp_map_value
 
std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > > _side_qp_to_value
 
std::map< ElemArg, ValueType > _elem_arg_to_value
 
std::map< FaceArg, ValueType > _face_arg_to_value
 
std::map< NodeArg, ValueType > _node_arg_to_value
 
MooseFunctorName _functor_name
 
unsigned int _coupleable_max_qps
 
std::unordered_map< std::string, std::vector< unsigned int > > _optional_var_index
 
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _c_coupled_scalar_vars
 
std::set< TagID > _fe_coupleable_vector_tags
 
std::set< TagID > _fe_coupleable_matrix_tags
 
const bool _is_fv
 
const MooseObject *const _obj
 
const std::set< std::string > _older_state_tags
 
std::vector< std::set< MooseWritableVariable * > > _writable_coupled_variables
 
const Real _kokkos_default_value_zero
 
std::set< MooseVariableFieldBase * > _moose_variable_dependencies
 
std::vector< libMesh::dof_id_type > _dof_indices
 
FEProblemBase * _bnd_feproblem
 
MooseMesh * _bnd_mesh
 
std::set< BoundaryID > _bnd_ids
 
std::vector< BoundaryID > _vec_ids
 
std::vector< BoundaryName > _boundary_names
 
const bool _bnd_dual_restrictable
 
const std::set< SubdomainID > _empty_block_ids
 
const std::set< SubdomainID > & _block_ids
 
THREAD_ID _bnd_tid
 
const MaterialData & _bnd_material_data
 
bool _bnd_nodal
 
const MooseObject & _moose_object
 
Moose::Kokkos::Array< ContiguousNodeID > _kokkos_node_ids
 
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > > _kokkos_element_side_ids
 

Detailed Description

This object will mark nodes or elements of continuous regions all with a unique number for the purpose of counting or "coloring" unique regions in a solution.

It is designed to work with either a single variable, or multiple variables.

Note: When inspecting multiple variables, those variables must not have regions of interest that overlap or they will not be correctly colored.

Definition at line 40 of file FeatureFloodCount.h.

Member Enumeration Documentation

◆ BoundaryIntersection

enum class FeatureFloodCount::BoundaryIntersection : unsigned char
strong

This enumeration is used to inidacate status of boundary intersections.

Enumerator
NONE 
ANY_BOUNDARY 
PRIMARY_PERCOLATION_BOUNDARY 
SECONDARY_PERCOLATION_BOUNDARY 
SPECIFIED_BOUNDARY 

Definition at line 129 of file FeatureFloodCount.h.

130 {
131 NONE = 0x0,
132 ANY_BOUNDARY = 0x1,
133 PRIMARY_PERCOLATION_BOUNDARY = 0x2,
134 SECONDARY_PERCOLATION_BOUNDARY = 0x4,
135 SPECIFIED_BOUNDARY = 0x8
136 };

◆ FieldType

enum class FeatureFloodCount::FieldType
strong
Enumerator
UNIQUE_REGION 
VARIABLE_COLORING 
GHOSTED_ENTITIES 
HALOS 
CENTROID 
ACTIVE_BOUNDS 
INTERSECTS_SPECIFIED_BOUNDARY 

Definition at line 102 of file FeatureFloodCount.h.

103 {
104 UNIQUE_REGION,
105 VARIABLE_COLORING,
106 GHOSTED_ENTITIES,
107 HALOS,
108 CENTROID,
109 ACTIVE_BOUNDS,
110 INTERSECTS_SPECIFIED_BOUNDARY,
111 };

◆ Status

enum class FeatureFloodCount::Status : unsigned char
strong

This enumeration is used to indicate status of the grains in the _unique_grains data structure.

Enumerator
CLEAR 
MARKED 
DIRTY 
INACTIVE 

Definition at line 120 of file FeatureFloodCount.h.

121 {
122 CLEAR = 0x0,
123 MARKED = 0x1,
124 DIRTY = 0x2,
125 INACTIVE = 0x4
126 };

Constructor & Destructor Documentation

◆ FeatureFloodCount()

FeatureFloodCount::FeatureFloodCount ( const InputParameters &  parameters)

Definition at line 189 of file FeatureFloodCount.C.

190 : GeneralPostprocessor(parameters),
191 Coupleable(this, false),
192 MooseVariableDependencyInterface(this),
193 BoundaryRestrictable(this, false),
194 _fe_vars(getCoupledMooseVars()),
195 _vars(getCoupledStandardMooseVars()),
196 _dof_map(_vars[0]->dofMap()),
197 _threshold(getParam<Real>("threshold")),
198 _connecting_threshold(isParamValid("connecting_threshold")
199 ? getParam<Real>("connecting_threshold")
200 : getParam<Real>("threshold")),
201 _mesh(_subproblem.mesh()),
202 _var_number(_fe_vars[0]->number()),
203 _single_map_mode(getParam<bool>("use_single_map")),
204 _condense_map_info(getParam<bool>("condense_map_info")),
205 _global_numbering(getParam<bool>("use_global_numbering")),
206 _var_index_mode(getParam<bool>("enable_var_coloring")),
207 _compute_halo_maps(getParam<bool>("compute_halo_maps")),
208 _compute_var_to_feature_map(getParam<bool>("compute_var_to_feature_map")),
209 _use_less_than_threshold_comparison(getParam<bool>("use_less_than_threshold_comparison")),
210 _n_vars(_fe_vars.size()),
211 _maps_size(_single_map_mode ? 1 : _fe_vars.size()),
212 _n_procs(_app.n_processors()),
213 _feature_counts_per_map(_maps_size),
214 _feature_count(0),
215 _partial_feature_sets(_maps_size),
216 _feature_sets(getParam<bool>("restartable_required")
217 ? declareRestartableData<std::vector<FeatureData>>("feature_sets")
218 : _volatile_feature_sets),
219 _feature_maps(_maps_size),
220 _pbs(nullptr),
221 _element_average_value(parameters.isParamValid("elem_avg_value")
222 ? getPostprocessorValue("elem_avg_value")
223 : _real_zero),
224 _halo_ids(_maps_size),
225 _is_elemental(getParam<MooseEnum>("flood_entity_type") == "ELEMENTAL"),
226 _is_primary(processor_id() == 0)
227{
228 if (_var_index_mode)
229 _var_index_maps.resize(_maps_size);
230
231 addMooseVariableDependency(_fe_vars);
232
233 _is_boundary_restricted = boundaryRestricted();
234
235 if (_subproblem.isTransient())
236 {
237 // tell MOOSE that we are going to need old and older DoF values
238 for (auto & var : _vars)
239 {
240 var->dofValuesOld();
241 var->dofValuesOlder();
242 }
243 }
244
245 if (parameters.isParamValid("primary_percolation_boundaries"))
246 _primary_perc_bnds = _mesh.getBoundaryIDs(
247 parameters.get<std::vector<BoundaryName>>("primary_percolation_boundaries"));
248 if (parameters.isParamValid("secondary_percolation_boundaries"))
249 _secondary_perc_bnds = _mesh.getBoundaryIDs(
250 parameters.get<std::vector<BoundaryName>>("secondary_percolation_boundaries"));
251
252 if (_primary_perc_bnds.empty() != _secondary_perc_bnds.empty())
253 paramError("primary_percolation_boundaries",
254 "primary_percolation_boundaries and secondary_percolation_boundaries must both be "
255 "supplied when checking for percolation");
256
257 if (parameters.isParamValid("specified_boundaries"))
258 _specified_bnds =
259 _mesh.getBoundaryIDs(parameters.get<std::vector<BoundaryName>>("specified_boundaries"));
260}
BoundaryRestrictable::boundaryRestricted
virtual bool boundaryRestricted() const
Coupleable::getCoupledMooseVars
const std::vector< MooseVariableFieldBase * > & getCoupledMooseVars() const
Coupleable::getCoupledStandardMooseVars
const std::vector< MooseVariable * > & getCoupledStandardMooseVars() const
FeatureFloodCount::_volatile_feature_sets
std::vector< FeatureData > _volatile_feature_sets
Derived objects (e.g.
Definition FeatureFloodCount.h:655
FeatureFloodCount::_is_elemental
const bool _is_elemental
Determines if the flood counter is elements or not (nodes)
Definition FeatureFloodCount.h:707
FeatureFloodCount::_is_primary
const bool _is_primary
Convenience variable for testing primary rank.
Definition FeatureFloodCount.h:716
FeatureFloodCount::_var_index_mode
const bool _var_index_mode
This variable is used to indicate whether the maps will contain unique region information or just the...
Definition FeatureFloodCount.h:585
FeatureFloodCount::_vars
std::vector< MooseVariable * > _vars
The vector of coupled in variables cast to MooseVariable.
Definition FeatureFloodCount.h:550
FeatureFloodCount::_dof_map
const DofMap & _dof_map
Reference to the dof_map containing the coupled variables.
Definition FeatureFloodCount.h:553
FeatureFloodCount::_global_numbering
const bool _global_numbering
This variable is used to indicate whether or not we identify features with unique numbers on multiple...
Definition FeatureFloodCount.h:581
FeatureFloodCount::_n_procs
const processor_id_type _n_procs
Convenience variable holding the number of processors in this simulation.
Definition FeatureFloodCount.h:607
FeatureFloodCount::_specified_bnds
std::vector< BoundaryID > _specified_bnds
Definition FeatureFloodCount.h:704
FeatureFloodCount::_element_average_value
const PostprocessorValue & _element_average_value
Average value of the domain which can optionally be used to find features in a field.
Definition FeatureFloodCount.h:676
FeatureFloodCount::_feature_count
unsigned int _feature_count
The number of features seen by this object (same as summing _feature_counts_per_map)
Definition FeatureFloodCount.h:632
FeatureFloodCount::_feature_counts_per_map
std::vector< unsigned int > _feature_counts_per_map
The number of features seen by this object per map.
Definition FeatureFloodCount.h:629
FeatureFloodCount::_feature_maps
std::vector< std::map< dof_id_type, int > > _feature_maps
The feature maps contain the raw flooded node information and eventually the unique grain numbers.
Definition FeatureFloodCount.h:662
FeatureFloodCount::_halo_ids
std::vector< std::map< dof_id_type, int > > _halo_ids
The data structure for looking up halos around features.
Definition FeatureFloodCount.h:685
FeatureFloodCount::_var_number
unsigned long _var_number
This variable is used to build the periodic node map.
Definition FeatureFloodCount.h:572
FeatureFloodCount::_secondary_perc_bnds
std::vector< BoundaryID > _secondary_perc_bnds
Definition FeatureFloodCount.h:702
FeatureFloodCount::_maps_size
const std::size_t _maps_size
Convenience variable holding the size of all the datastructures size by the number of maps.
Definition FeatureFloodCount.h:604
FeatureFloodCount::_var_index_maps
std::vector< std::map< dof_id_type, int > > _var_index_maps
This map keeps track of which variables own which nodes.
Definition FeatureFloodCount.h:623
FeatureFloodCount::_use_less_than_threshold_comparison
const bool _use_less_than_threshold_comparison
Use less-than when comparing values against the threshold value.
Definition FeatureFloodCount.h:598
FeatureFloodCount::_pbs
libMesh::PeriodicBoundaries * _pbs
A pointer to the periodic boundary constraints object.
Definition FeatureFloodCount.h:671
FeatureFloodCount::_condense_map_info
const bool _condense_map_info
Definition FeatureFloodCount.h:577
FeatureFloodCount::_single_map_mode
const bool _single_map_mode
This variable is used to indicate whether or not multiple maps are used during flooding.
Definition FeatureFloodCount.h:575
FeatureFloodCount::_fe_vars
std::vector< MooseVariableFEBase * > _fe_vars
The vector of coupled in variables.
Definition FeatureFloodCount.h:548
FeatureFloodCount::_is_boundary_restricted
bool _is_boundary_restricted
Indicates that this object should only run on one or more boundaries.
Definition FeatureFloodCount.h:710
FeatureFloodCount::_partial_feature_sets
std::vector< std::list< FeatureData > > _partial_feature_sets
The data structure used to hold partial and communicated feature data, during the discovery and mergi...
Definition FeatureFloodCount.h:639
FeatureFloodCount::_feature_sets
std::vector< FeatureData > & _feature_sets
The data structure used to hold the globally unique features.
Definition FeatureFloodCount.h:646
FeatureFloodCount::_n_vars
const std::size_t _n_vars
Definition FeatureFloodCount.h:601
FeatureFloodCount::_compute_halo_maps
const bool _compute_halo_maps
Indicates whether or not to communicate halo map information with all ranks.
Definition FeatureFloodCount.h:588
FeatureFloodCount::_threshold
const Real _threshold
The threshold above (or below) where an entity may begin a new region (feature)
Definition FeatureFloodCount.h:556
FeatureFloodCount::_compute_var_to_feature_map
const bool _compute_var_to_feature_map
Indicates whether or not the var to feature map is populated.
Definition FeatureFloodCount.h:591
FeatureFloodCount::_mesh
MooseMesh & _mesh
A reference to the mesh.
Definition FeatureFloodCount.h:565
FeatureFloodCount::_connecting_threshold
const Real _connecting_threshold
The threshold above (or below) which neighboring entities are flooded (where regions can be extended ...
Definition FeatureFloodCount.h:561
FeatureFloodCount::_primary_perc_bnds
std::vector< BoundaryID > _primary_perc_bnds
Definition FeatureFloodCount.h:701
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::isParamValid
bool isParamValid(const std::string &name) const
GeneralPostprocessor::parameters
const InputParameters & parameters() const
GeneralPostprocessor::paramError
void paramError(const std::string &param, Args... args) const
GeneralPostprocessor::getParam
const T & getParam(const std::string &name) const
GeneralPostprocessor::isParamValid
bool isParamValid(const std::string &name) const
MooseMesh::getBoundaryIDs
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
MooseVariableDependencyInterface::addMooseVariableDependency
void addMooseVariableDependency(MooseVariableFieldBase *var)
GeneralPostprocessor::getPostprocessorValue
const PostprocessorValue & getPostprocessorValue(const std::string &param_name, const unsigned int index=0) const
GeneralPostprocessor::declareRestartableData
T & declareRestartableData(const std::string &data_name, Args &&... args)
GeneralPostprocessor::_real_zero
const Real & _real_zero
SubProblem::isTransient
virtual bool isTransient() const=0
GeneralPostprocessor::_subproblem
SubProblem & _subproblem
libMesh::ParallelObject::processor_id
processor_id_type processor_id() const
libMesh::ParallelObject::n_processors
processor_id_type n_processors() const
mesh
MeshBase & mesh
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ appendPeriodicNeighborNodes()

void FeatureFloodCount::appendPeriodicNeighborNodes ( FeatureData &  feature) const
protected

This routine adds the periodic node information to our data structure prior to packing the data this makes those periodic neighbors appear much like ghosted nodes in a multiprocessor setting.

Definition at line 1821 of file FeatureFloodCount.C.

1822{
1823 if (_is_elemental)
1824 {
1825 for (auto entity : feature._local_ids)
1826 {
1827 Elem * elem = _mesh.elemPtr(entity);
1828
1829 for (const auto node_n : make_range(elem->n_nodes()))
1830 {
1831 auto iters = _periodic_node_map.equal_range(elem->node_id(node_n));
1832
1833 for (auto it = iters.first; it != iters.second; ++it)
1834 {
1835 feature._periodic_nodes.insert(feature._periodic_nodes.end(), it->first);
1836 feature._periodic_nodes.insert(feature._periodic_nodes.end(), it->second);
1837 }
1838 }
1839 }
1840 }
1841 else
1842 {
1843 for (auto entity : feature._local_ids)
1844 {
1845 auto iters = _periodic_node_map.equal_range(entity);
1846
1847 for (auto it = iters.first; it != iters.second; ++it)
1848 {
1849 feature._periodic_nodes.insert(feature._periodic_nodes.end(), it->first);
1850 feature._periodic_nodes.insert(feature._periodic_nodes.end(), it->second);
1851 }
1852 }
1853 }
1854
1855 // TODO: Remove duplicates
1856}
FeatureFloodCount::_periodic_node_map
std::multimap< dof_id_type, dof_id_type > _periodic_node_map
The data structure which is a list of nodes that are constrained to other nodes based on the imposed ...
Definition FeatureFloodCount.h:691
MooseMesh::elemPtr
virtual Elem * elemPtr(const dof_id_type i)
libMesh::make_range
IntRange< T > make_range(T beg, T end)
n_nodes
const dof_id_type n_nodes

Referenced by prepareDataForTransfer().

◆ areFeaturesMergeable()

bool FeatureFloodCount::areFeaturesMergeable ( const FeatureData &  f1,
const FeatureData &  f2 
) const
protectedvirtual

Method for determining whether two features are mergeable.

This routine exists because derived classes may need to override this function rather than use the mergeable method in the FeatureData object.

Reimplemented in PolycrystalUserObjectBase.

Definition at line 1276 of file FeatureFloodCount.C.

1277{
1278 return f1.mergeable(f2);
1279}

Referenced by mergeSets().

◆ buildFeatureIdToLocalIndices()

void FeatureFloodCount::buildFeatureIdToLocalIndices ( unsigned int  max_id)
protected

This method builds a lookup map for retrieving the right local feature (by index) given a global index or id.

max_id is passed to size the vector properly and may or may not be a globally consistent number. The assumption is that any id that is later queried from this object that is higher simply doesn't exist on the local processor.

Definition at line 660 of file FeatureFloodCount.C.

661{
662 _feature_id_to_local_index.assign(max_id + 1, invalid_size_t);
663 for (const auto feature_index : index_range(_feature_sets))
664 {
665 if (_feature_sets[feature_index]._status != Status::INACTIVE)
666 {
667 mooseAssert(_feature_sets[feature_index]._id <= max_id,
668 "Feature ID out of range(" << _feature_sets[feature_index]._id << ')');
669 _feature_id_to_local_index[_feature_sets[feature_index]._id] = feature_index;
670 }
671 }
672}
FeatureFloodCount::_feature_id_to_local_index
std::vector< std::size_t > _feature_id_to_local_index
The vector recording the grain_id to local index (several indices will contain invalid_size_t)
Definition FeatureFloodCount.h:668
FeatureFloodCount::invalid_size_t
static const std::size_t invalid_size_t
Definition FeatureFloodCount.h:91
libMesh::index_range
auto index_range(const T &sizable)

Referenced by GrainTracker::assignGrains(), scatterAndUpdateRanks(), and GrainTracker::trackGrains().

◆ buildLocalToGlobalIndices()

void FeatureFloodCount::buildLocalToGlobalIndices ( std::vector< std::size_t > &  local_to_global_all,
std::vector< int > &  counts 
) const
protectedvirtual

This routine populates a stacked vector of local to global indices per rank and the associated count vector for scattering the vector to the ranks.

The individual vectors can be different sizes. The ith vector will be distributed to the ith processor including the primary rank. e.g. [ ... n_0 ] [ ... n_1 ] ... [ ... n_m ]

It is intended to be overridden in derived classes.

Definition at line 614 of file FeatureFloodCount.C.

616{
617 mooseAssert(_is_primary, "This method must only be called on the root processor");
618
619 counts.assign(_n_procs, 0);
620 // Now size the individual counts vectors based on the largest index seen per processor
621 for (const auto & feature : _feature_sets)
622 for (const auto & local_index_pair : feature._orig_ids)
623 {
624 // local_index_pair.first = ranks, local_index_pair.second = local_index
625 mooseAssert(local_index_pair.first < _n_procs, "Processor ID is out of range");
626 if (local_index_pair.second >= static_cast<std::size_t>(counts[local_index_pair.first]))
627 counts[local_index_pair.first] = local_index_pair.second + 1;
628 }
629
630 // Build the offsets vector
631 unsigned int globalsize = 0;
632 std::vector<int> offsets(_n_procs); // Type is signed for use with the MPI API
633 for (const auto i : index_range(offsets))
634 {
635 offsets[i] = globalsize;
636 globalsize += counts[i];
637 }
638
639 // Finally populate the primary vector
640 local_to_global_all.resize(globalsize, FeatureFloodCount::invalid_size_t);
641 for (const auto & feature : _feature_sets)
642 {
643 // Get the local indices from the feature and build a map
644 for (const auto & local_index_pair : feature._orig_ids)
645 {
646 auto rank = local_index_pair.first;
647 mooseAssert(rank < _n_procs, rank << ", " << _n_procs);
648
649 auto local_index = local_index_pair.second;
650 auto stacked_local_index = offsets[rank] + local_index;
651
652 mooseAssert(stacked_local_index < globalsize,
653 "Global index: " << stacked_local_index << " is out of range");
654 local_to_global_all[stacked_local_index] = feature._id;
655 }
656 }
657}
for
for(PetscInt i=0;i< nvars;++i)

Referenced by scatterAndUpdateRanks().

◆ clearDataStructures()

void FeatureFloodCount::clearDataStructures ( )
protectedvirtual

Helper routine for clearing up data structures during initialize and prior to parallel communication.

Definition at line 316 of file FeatureFloodCount.C.

317{
318}

Referenced by communicateAndMerge().

◆ communicateAndMerge()

void FeatureFloodCount::communicateAndMerge ( )
protected

This routine handles all of the serialization, communication and deserialization of the data structures containing FeatureData objects.

The libMesh packed range routines handle the communication of the individual string buffers. Here we need to create a container to hold our type to serialize. It'll always be size one because we are sending a single byte stream of all the data to other processors. The stream need not be the same size on all processors.

Additionally we need to create a different container to hold the received byte buffers. The container type need not match the send container type. However, We do know the number of incoming buffers (num processors) so we'll go ahead and use a vector.

When we distribute merge work, we are reducing computational work by adding more communication. Each of the first _n_vars processors will receive one variable worth of information to merge. After each of those processors has merged that information, it'll be sent to the primary processor where final consolidation will occur.

Send the data from all processors to the first 'n_merging_procs' processors to create a complete global feature maps for each variable.

A call to gather_packed_range seems to populate the receiving buffer on all processors, not just the receiving buffer on the actual receiving processor. If we plan to call this function repeatedly, we must clear the buffers each time on all non-receiving processors. On the actual receiving processor, we'll save off the buffer for use later.

The FeatureFloodCount and derived objects rely on having the original data structures intact on all non-zero ranks. This is because local-only information (local entities) is never communicated and thus must remain intact. However, the distributed merging will destroy that information. The easiest thing to do is to swap out the data structure while we perform the distributed merge work.

Send the data from the merging processors to the root to create a complete global feature map.

Send the data from all processors to the root to create a complete global feature map.

Definition at line 403 of file FeatureFloodCount.C.

404{
405 TIME_SECTION("communicateAndMerge", 3, "Communicating and Merging");
406
407 // First we need to transform the raw data into a usable data structure
408 prepareDataForTransfer();
409
417 std::vector<std::string> send_buffers(1);
418
425 std::vector<std::string> recv_buffers, deserialize_buffers;
426
433 const auto n_merging_procs = numberOfDistributedMergeHelpers();
434
435 if (n_merging_procs > 1)
436 {
437 auto rank = processor_id();
438 bool is_merging_processor = rank < n_merging_procs;
439
440 if (is_merging_processor)
441 recv_buffers.reserve(_app.n_processors());
442
443 for (const auto i : make_range(n_merging_procs))
444 {
445 serialize(send_buffers[0], i);
446
451 _communicator.gather_packed_range(i,
452 (void *)(nullptr),
453 send_buffers.begin(),
454 send_buffers.end(),
455 std::back_inserter(recv_buffers));
456
463 if (rank == i)
464 recv_buffers.swap(deserialize_buffers);
465 else
466 recv_buffers.clear();
467 }
468
469 // Setup a new communicator for doing merging communication operations
470 Parallel::Communicator merge_comm;
471
472 _communicator.split(is_merging_processor ? 0 : MPI_UNDEFINED, rank, merge_comm);
473
474 if (is_merging_processor)
475 {
483 std::vector<std::list<FeatureData>> tmp_data(_partial_feature_sets.size());
484 tmp_data.swap(_partial_feature_sets);
485
486 deserialize(deserialize_buffers, processor_id());
487
488 send_buffers[0].clear();
489 recv_buffers.clear();
490 deserialize_buffers.clear();
491
492 // Merge one variable's worth of data
493 mergeSets();
494
495 // Now we need to serialize again to send to the primary (only the processors who did work)
496 serialize(send_buffers[0]);
497
498 // Free up as much memory as possible here before we do global communication
499 clearDataStructures();
500
505 merge_comm.gather_packed_range(0,
506 (void *)(nullptr),
507 send_buffers.begin(),
508 send_buffers.end(),
509 std::back_inserter(recv_buffers));
510
511 if (_is_primary)
512 {
513 // The root process now needs to deserialize all of the data
514 deserialize(recv_buffers);
515
516 send_buffers[0].clear();
517 recv_buffers.clear();
518
519 consolidateMergedFeatures(&tmp_data);
520 }
521 else
522 // Restore our original data on non-zero ranks
523 tmp_data.swap(_partial_feature_sets);
524 }
525 }
526
527 // Serialized merging (primary does all the work)
528 else
529 {
530 if (_is_primary)
531 recv_buffers.reserve(_app.n_processors());
532
533 serialize(send_buffers[0]);
534
535 // Free up as much memory as possible here before we do global communication
536 clearDataStructures();
537
542 _communicator.gather_packed_range(0,
543 (void *)(nullptr),
544 send_buffers.begin(),
545 send_buffers.end(),
546 std::back_inserter(recv_buffers));
547
548 if (_is_primary)
549 {
550 // The root process now needs to deserialize all of the data
551 deserialize(recv_buffers);
552 recv_buffers.clear();
553
554 mergeSets();
555
556 consolidateMergedFeatures();
557 }
558 }
559
560 if (!_is_primary)
561 restoreOriginalDataStructures(_partial_feature_sets);
562
563 // Make sure that feature count is communicated to all ranks
564 _communicator.broadcast(_feature_count);
565}
FeatureFloodCount::clearDataStructures
virtual void clearDataStructures()
Helper routine for clearing up data structures during initialize and prior to parallel communication.
Definition FeatureFloodCount.C:316
FeatureFloodCount::prepareDataForTransfer
virtual void prepareDataForTransfer()
This routine uses the local flooded data to build up the local feature data structures (_partial feat...
Definition FeatureFloodCount.C:1034
FeatureFloodCount::mergeSets
virtual void mergeSets()
This routine is called on the primary rank only and stitches together the partial feature pieces seen...
Definition FeatureFloodCount.C:1138
FeatureFloodCount::serialize
void serialize(std::string &serialized_buffer, unsigned int var_num=invalid_id)
This routines packs the _partial_feature_sets data into a structure suitable for parallel communicati...
Definition FeatureFloodCount.C:1084
FeatureFloodCount::numberOfDistributedMergeHelpers
virtual processor_id_type numberOfDistributedMergeHelpers() const
Returns a number indicating the number of merge helpers when running in parallel based on certain imp...
Definition FeatureFloodCount.C:397
FeatureFloodCount::deserialize
void deserialize(std::vector< std::string > &serialized_buffers, unsigned int var_num=invalid_id)
This routine takes the vector of byte buffers (one for each processor), deserializes them into a seri...
Definition FeatureFloodCount.C:1103
FeatureFloodCount::restoreOriginalDataStructures
virtual void restoreOriginalDataStructures(std::vector< std::list< FeatureData > > &)
Definition FeatureFloodCount.h:487
FeatureFloodCount::consolidateMergedFeatures
virtual void consolidateMergedFeatures(std::vector< std::list< FeatureData > > *saved_data=nullptr)
This method consolidates all of the merged information from _partial_feature_sets into the _feature_s...
Definition FeatureFloodCount.C:1193
libMesh::Parallel::Communicator::split
void split(int color, int key, Communicator &target) const
libMesh::Parallel::Communicator::gather_packed_range
void gather_packed_range(const unsigned int root_id, Context *context, Iter range_begin, const Iter range_end, OutputIter out, std::size_t approx_buffer_size=1000000) const
libMesh::Parallel::Communicator::broadcast
void broadcast(T &data, const unsigned int root_id=0, const bool identical_sizes=false) const
libMesh::ParallelObject::_communicator
const Parallel::Communicator & _communicator

Referenced by finalize(), and GrainTracker::finalize().

◆ compareValueWithThreshold()

bool FeatureFloodCount::compareValueWithThreshold ( Real  entity_value,
Real  threshold 
) const
protected

This method is used to determine whether the current entity value is part of a feature or not.

Comparisons can either be greater than or less than the threshold which is controlled via input parameter.

Definition at line 1453 of file FeatureFloodCount.C.

1454{
1455 return ((_use_less_than_threshold_comparison && (entity_value >= threshold)) ||
1456 (!_use_less_than_threshold_comparison && (entity_value <= threshold)));
1457}

Referenced by isNewFeatureOrConnectedRegion().

◆ consolidateMergedFeatures()

void FeatureFloodCount::consolidateMergedFeatures ( std::vector< std::list< FeatureData > > *  saved_data = nullptr)
protectedvirtual

This method consolidates all of the merged information from _partial_feature_sets into the _feature_sets vectors.

Now that the merges are complete we need to adjust the centroid, and halos. Additionally, To make several of the sorting and tracking algorithms more straightforward, we will move the features into a flat vector. Finally we can count the final number of features and find the max local index seen on any processor

Note: This is all occurring on rank 0 only!

IMPORTANT: FeatureFloodCount::_feature_count is set on rank 0 at this point but we can't broadcast it here because this routine is not collective.

Definition at line 1193 of file FeatureFloodCount.C.

1194{
1195 TIME_SECTION("consolidateMergedFeatures", 3, "Consolidating Merged Features");
1196
1205 mooseAssert(_is_primary,
1206 "cosolidateMergedFeatures() may only be called on the primary processor");
1207 mooseAssert(saved_data == nullptr || saved_data->size() == _partial_feature_sets.size(),
1208 "Data structure size mismatch");
1209
1210 // Offset where the current set of features with the same variable id starts in the flat vector
1211 unsigned int feature_offset = 0;
1212 // Set the member feature count to zero and start counting the actual features
1213 _feature_count = 0;
1214 for (const auto map_num : index_range(_partial_feature_sets))
1215 {
1216 for (auto & feature : _partial_feature_sets[map_num])
1217 {
1218 if (saved_data)
1219 {
1220 for (auto it = (*saved_data)[map_num].begin(); it != (*saved_data)[map_num].end();
1221 /* no increment */)
1222 {
1223 if (feature.canConsolidate(*it))
1224 {
1225 feature.consolidate(std::move(*it));
1226 it = (*saved_data)[map_num].erase(it); // increment
1227 }
1228 else
1229 ++it;
1230 }
1231 }
1232
1233 // If after merging we still have an inactive feature, discard it
1234 if (feature._status == Status::CLEAR)
1235 {
1236 // First we need to calculate the centroid now that we are doing merging all partial
1237 // features
1238 if (feature._vol_count != 0)
1239 feature._centroid /= feature._vol_count;
1240
1241 _feature_sets.emplace_back(std::move(feature));
1242 ++_feature_count;
1243 }
1244 }
1245
1246 // Record the feature numbers just for the current map
1247 _feature_counts_per_map[map_num] = _feature_count - feature_offset;
1248
1249 // Now update the running feature count so we can calculate the next map's contribution
1250 feature_offset = _feature_count;
1251
1252 // Clean up the "moved" objects
1253 _partial_feature_sets[map_num].clear();
1254 if (saved_data)
1255 (*saved_data)[map_num].clear();
1256 }
1257
1258 // We may have resided our data structures for the communicateAndMerge step. We'll restore the
1259 // original size here just in case we need to loop over the assumed size (i.e. _maps_size)
1260 // elsewhere in this or derived objects.
1261 if (_partial_feature_sets.size() != _maps_size)
1262 {
1263 _partial_feature_sets.resize(_maps_size);
1264
1265 _feature_counts_per_map[0] = _feature_count;
1266 _feature_counts_per_map.resize(_maps_size);
1267 }
1268
1273}

Referenced by communicateAndMerge().

◆ contains() [1/2]

template<class T >
static bool FeatureFloodCount::contains ( std::set< T > &  container,
const T &  item 
)
inlinestaticprivate

Definition at line 744 of file FeatureFloodCount.h.

745 {
746 return container.find(item) != container.end();
747 }

Referenced by visitNeighborsHelper().

◆ contains() [2/2]

template<class T >
static bool FeatureFloodCount::contains ( std::vector< T > &  container,
const T &  item 
)
inlinestaticprivate

Definition at line 750 of file FeatureFloodCount.h.

751 {
752 for (const auto & cont_item : container)
753 if (item == cont_item)
754 return true;
755 return false;
756 }
libMesh::if
if(subdm)

◆ deserialize()

void FeatureFloodCount::deserialize ( std::vector< std::string > &  serialized_buffers,
unsigned int  var_num = invalid_id 
)
protected

This routine takes the vector of byte buffers (one for each processor), deserializes them into a series of FeatureSet objects, and appends them to the _feature_sets data structure.

Note: It is assumed that local processor information may already be stored in the _feature_sets data structure so it is not cleared before insertion.

Usually we have the local processor data already in the _partial_feature_sets data structure. However, if we are doing distributed merge work, we also need to preserve all of the original data for use in later stages of the algorithm so it'll have been swapped out with clean buffers. This leaves us a choice, either we just duplicate the Features from the original data structure after we've swapped out the buffer, or we go ahead and unpack data that we would normally already have. So during distributed merging, that's exactly what we'll do. Later however when the primary is doing the final consolidating, we'll opt to just skip the local unpacking. To tell the difference, between these two modes, we just need to see if a var_num was passed in.

Definition at line 1103 of file FeatureFloodCount.C.

1104{
1105 // The input string stream used for deserialization
1106 std::istringstream iss;
1107
1108 auto rank = processor_id();
1109
1110 for (const auto proc_id : index_range(serialized_buffers))
1111 {
1123 if (var_num == invalid_id && proc_id == rank)
1124 continue;
1125
1126 iss.str(serialized_buffers[proc_id]); // populate the stream with a new buffer
1127 iss.clear(); // reset the string stream state
1128
1129 // Load the gathered data into the data structure.
1130 if (var_num == invalid_id)
1131 dataLoad(iss, _partial_feature_sets, this);
1132 else
1133 dataLoad(iss, _partial_feature_sets[var_num], this);
1134 }
1135}
dataLoad
void dataLoad(std::istream &stream, FeatureFloodCount::FeatureData &feature, void *context)
Definition FeatureFloodCount.C:63
FeatureFloodCount::invalid_id
static const unsigned int invalid_id
Definition FeatureFloodCount.h:92

Referenced by communicateAndMerge().

◆ doesFeatureIntersectBoundary()

bool FeatureFloodCount::doesFeatureIntersectBoundary ( unsigned int  feature_id) const
virtual

Returns a Boolean indicating whether this feature intersects any boundary.

Reimplemented in FauxGrainTracker, and GrainTracker.

Definition at line 843 of file FeatureFloodCount.C.

844{
845 // Some processors don't contain the largest feature id, in that case we just return invalid_id
846 if (feature_id >= _feature_id_to_local_index.size())
847 return false;
848
849 auto local_index = _feature_id_to_local_index[feature_id];
850
851 if (local_index != invalid_size_t)
852 {
853 mooseAssert(local_index < _feature_sets.size(), "local_index out of bounds");
854 return _feature_sets[local_index]._status != Status::INACTIVE
855 ? _feature_sets[local_index]._boundary_intersection != BoundaryIntersection::NONE
856 : false;
857 }
858
859 return false;
860}

Referenced by FeatureVolumeVectorPostprocessor::execute().

◆ doesFeatureIntersectSpecifiedBoundary()

bool FeatureFloodCount::doesFeatureIntersectSpecifiedBoundary ( unsigned int  feature_id) const
virtual

Returns a Boolean indicating whether this feature intersects boundaries in a user-supplied list.

Reimplemented in GrainTracker.

Definition at line 863 of file FeatureFloodCount.C.

864{
865 // Some processors don't contain the largest feature id, in that case we just return invalid_id
866 if (feature_id >= _feature_id_to_local_index.size())
867 return false;
868
869 auto local_index = _feature_id_to_local_index[feature_id];
870
871 if (local_index != invalid_size_t)
872 {
873 mooseAssert(local_index < _feature_sets.size(), "local_index out of bounds");
874 return _feature_sets[local_index]._status != Status::INACTIVE
875 ? ((_feature_sets[local_index]._boundary_intersection &
876 BoundaryIntersection::SPECIFIED_BOUNDARY) ==
877 BoundaryIntersection::SPECIFIED_BOUNDARY)
878 : false;
879 }
880
881 return false;
882}

Referenced by FeatureVolumeVectorPostprocessor::execute(), and getEntityValue().

◆ execute()

void FeatureFloodCount::execute ( )
overridevirtual

Implements GeneralPostprocessor.

Reimplemented in FauxGrainTracker, GrainTracker, FauxPolycrystalVoronoi, and PolycrystalUserObjectBase.

Definition at line 344 of file FeatureFloodCount.C.

345{
346 TIME_SECTION("execute", 3, "Flooding Features");
347
348 // Iterate only over boundaries if restricted
349 if (_is_boundary_restricted)
350 {
351 mooseInfo("Using EXPERIMENTAL boundary restricted FeatureFloodCount object!\n");
352
353 // Set the boundary range pointer for use during flooding
354 _bnd_elem_range = _mesh.getBoundaryElementRange();
355
356 auto rank = processor_id();
357
358 for (const auto & belem : *_bnd_elem_range)
359 {
360 const Elem * elem = belem->_elem;
361 BoundaryID boundary_id = belem->_bnd_id;
362
363 if (elem->processor_id() == rank)
364 {
365 if (hasBoundary(boundary_id))
366 for (const auto var_num : index_range(_vars))
367 flood(elem, var_num);
368 }
369 }
370 }
371 else // Normal volumetric operation
372 {
373 for (const auto & current_elem : _mesh.getMesh().active_local_element_ptr_range())
374 {
375 // Loop over elements or nodes
376 if (_is_elemental)
377 {
378 for (const auto var_num : index_range(_vars))
379 flood(current_elem, var_num);
380 }
381 else
382 {
383 auto n_nodes = current_elem->n_vertices();
384 for (const auto i : make_range(n_nodes))
385 {
386 const Node * current_node = current_elem->node_ptr(i);
387
388 for (const auto var_num : index_range(_vars))
389 flood(current_node, var_num);
390 }
391 }
392 }
393 }
394}
BoundaryID
boundary_id_type BoundaryID
BoundaryRestrictable::hasBoundary
bool hasBoundary(const BoundaryName &name) const
FeatureFloodCount::flood
bool flood(const DofObject *dof_object, std::size_t current_index)
This method will check if the current entity is above the supplied threshold and "mark" it.
Definition FeatureFloodCount.C:1327
FeatureFloodCount::_bnd_elem_range
ConstBndElemRange * _bnd_elem_range
Boundary element range pointer.
Definition FeatureFloodCount.h:713
GeneralPostprocessor::mooseInfo
void mooseInfo(Args &&... args) const
MooseMesh::getBoundaryElementRange
libMesh::StoredRange< MooseMesh::const_bnd_elem_iterator, const BndElement * > * getBoundaryElementRange()
SCM::getMesh
T & getMesh(MooseMesh &mesh)
function to cast mesh
Definition SCM.h:35

Referenced by GrainTracker::execute().

◆ expandEdgeHalos()

void FeatureFloodCount::expandEdgeHalos ( unsigned int  num_layers_to_expand)
protected

This method expands the existing halo set by some width determined by the passed in value.

This method does NOT mask off any local IDs.

Create a copy of the halo set so that as we insert new ids into the set we don't continue to iterate on those new ids.

We have to handle disjoint halo IDs slightly differently. Once you are disjoint, you can't go back so make sure that we keep placing these IDs in the disjoint set.

Definition at line 1562 of file FeatureFloodCount.C.

1563{
1564 if (num_layers_to_expand == 0)
1565 return;
1566
1567 TIME_SECTION("expandEdgeHalos", 3, "Expanding Edge Halos");
1568
1569 for (auto & list_ref : _partial_feature_sets)
1570 {
1571 for (auto & feature : list_ref)
1572 {
1573 for (unsigned short halo_level = 0; halo_level < num_layers_to_expand; ++halo_level)
1574 {
1579 FeatureData::container_type orig_halo_ids(feature._halo_ids);
1580 for (auto entity : orig_halo_ids)
1581 {
1582 if (_is_elemental)
1583 visitElementalNeighbors(_mesh.elemPtr(entity),
1584 &feature,
1585 /*expand_halos_only =*/true,
1586 /*disjoint_only =*/false);
1587 else
1588 visitNodalNeighbors(_mesh.nodePtr(entity),
1589 &feature,
1590 /*expand_halos_only =*/true);
1591 }
1592
1597 FeatureData::container_type disjoint_orig_halo_ids(feature._disjoint_halo_ids);
1598 for (auto entity : disjoint_orig_halo_ids)
1599 {
1600 if (_is_elemental)
1601 visitElementalNeighbors(_mesh.elemPtr(entity),
1602
1603 &feature,
1604 /*expand_halos_only =*/true,
1605 /*disjoint_only =*/true);
1606 else
1607 visitNodalNeighbors(_mesh.nodePtr(entity),
1608
1609 &feature,
1610 /*expand_halos_only =*/true);
1611 }
1612 }
1613 }
1614 }
1615}
FeatureFloodCount::FeatureData::container_type
std::vector< dof_id_type > container_type
The primary underlying container type used to hold the data in each FeatureData.
Definition FeatureFloodCount.h:150
FeatureFloodCount::visitNodalNeighbors
void visitNodalNeighbors(const Node *node, FeatureData *feature, bool expand_halos_only)
These two routines are utility routines used by the flood routine and by derived classes for visiting...
Definition FeatureFloodCount.C:1703
FeatureFloodCount::visitElementalNeighbors
void visitElementalNeighbors(const Elem *elem, FeatureData *feature, bool expand_halos_only, bool disjoint_only)
Definition FeatureFloodCount.C:1618
MooseMesh::nodePtr
virtual const Node * nodePtr(const dof_id_type i) const

Referenced by GrainTracker::finalize(), and PolycrystalUserObjectBase::finalize().

◆ expandPointHalos()

void FeatureFloodCount::expandPointHalos ( )
protected

This method takes all of the partial features and expands the local, ghosted, and halo sets around those regions to account for the diffuse interface.

Rather than using any kind of recursion here, we simply expand the region by all "point" neighbors from the actual grain cells since all point neighbors will contain contributions to the region.

To expand the feature element region to the actual flooded region (nodal basis) we need to add in all point neighbors of the current local region for each feature. This is because the elemental variable influence spreads from the elemental data out exactly one element from every mesh point.

Definition at line 1500 of file FeatureFloodCount.C.

1501{
1502 const auto & node_to_elem_map = _mesh.nodeToElemMap();
1503 FeatureData::container_type expanded_local_ids;
1504 auto my_processor_id = processor_id();
1505
1512 for (auto & list_ref : _partial_feature_sets)
1513 {
1514 for (auto & feature : list_ref)
1515 {
1516 expanded_local_ids.clear();
1517
1518 for (auto entity : feature._local_ids)
1519 {
1520 const Elem * elem = _mesh.elemPtr(entity);
1521 mooseAssert(elem, "elem pointer is NULL");
1522
1523 // Get the nodes on a current element so that we can add in point neighbors
1524 auto n_nodes = elem->n_vertices();
1525 for (const auto i : make_range(n_nodes))
1526 {
1527 const Node * current_node = elem->node_ptr(i);
1528
1529 auto elem_vector_it = node_to_elem_map.find(current_node->id());
1530 if (elem_vector_it == node_to_elem_map.end())
1531 mooseError("Error in node to elem map");
1532
1533 const auto & elem_vector = elem_vector_it->second;
1534
1535 std::copy(elem_vector.begin(),
1536 elem_vector.end(),
1537 std::insert_iterator<FeatureData::container_type>(expanded_local_ids,
1538 expanded_local_ids.end()));
1539
1540 // Now see which elements need to go into the ghosted set
1541 for (auto entity : elem_vector)
1542 {
1543 const Elem * neighbor = _mesh.elemPtr(entity);
1544 mooseAssert(neighbor, "neighbor pointer is NULL");
1545
1546 if (neighbor->processor_id() != my_processor_id)
1547 feature._ghosted_ids.insert(feature._ghosted_ids.end(), elem->id());
1548 }
1549 }
1550 }
1551
1552 // Replace the existing local ids with the expanded local ids
1553 feature._local_ids.swap(expanded_local_ids);
1554
1555 // Copy the expanded local_ids into the halo_ids container
1556 feature._halo_ids = feature._local_ids;
1557 }
1558 }
1559}
GeneralPostprocessor::mooseError
void mooseError(Args &&... args) const
MooseMesh::nodeToElemMap
const std::unordered_map< dof_id_type, std::vector< dof_id_type > > & nodeToElemMap()

◆ featureCentroid()

Point FeatureFloodCount::featureCentroid ( unsigned int  feature_id) const
virtual

Returns the centroid of the designated feature (only supported without periodic boundaries)

Definition at line 909 of file FeatureFloodCount.C.

910{
911 if (feature_id >= _feature_id_to_local_index.size())
912 return invalid_id;
913
914 auto local_index = _feature_id_to_local_index[feature_id];
915
916 Real invalid_coord = std::numeric_limits<Real>::max();
917 Point p(invalid_coord, invalid_coord, invalid_coord);
918 if (local_index != invalid_size_t)
919 {
920 mooseAssert(local_index < _feature_sets.size(), "local_index out of bounds");
921 p = _feature_sets[local_index]._centroid;
922 }
923 return p;
924}
p
const Real p
Definition GasLiquidMassTransferTest.C:18

Referenced by FeatureVolumeVectorPostprocessor::execute().

◆ finalize()

void FeatureFloodCount::finalize ( )
overridevirtual

Reimplemented from GeneralPostprocessor.

Reimplemented in FauxGrainTracker, GrainTracker, FauxPolycrystalVoronoi, and PolycrystalUserObjectBase.

Definition at line 675 of file FeatureFloodCount.C.

676{
677 TIME_SECTION("finalize", 3, "Finalizing Feature Identification");
678
679 // Gather all information on processor zero and merge
680 communicateAndMerge();
681
682 // Sort and label the features
683 if (_is_primary)
684 sortAndLabel();
685
686 // Send out the local to global mappings
687 scatterAndUpdateRanks();
688
689 // Populate _feature_maps and _var_index_maps
690 updateFieldInfo();
691}
FeatureFloodCount::scatterAndUpdateRanks
void scatterAndUpdateRanks()
Calls buildLocalToGlobalIndices to build the individual local to global indicies for each rank and sc...
Definition FeatureFloodCount.C:710
FeatureFloodCount::communicateAndMerge
void communicateAndMerge()
This routine handles all of the serialization, communication and deserialization of the data structur...
Definition FeatureFloodCount.C:403
FeatureFloodCount::sortAndLabel
void sortAndLabel()
Sort and assign ids to features based on their position in the container after sorting.
Definition FeatureFloodCount.C:568
FeatureFloodCount::updateFieldInfo
virtual void updateFieldInfo()
This method is used to populate any of the data structures used for storing field data (nodal or elem...
Definition FeatureFloodCount.C:1282

Referenced by PolycrystalUserObjectBase::finalize().

◆ flood()

bool FeatureFloodCount::flood ( const DofObject *  dof_object,
std::size_t  current_index 
)
protected

This method will check if the current entity is above the supplied threshold and "mark" it.

It will then inspect neighboring entities that are above the connecting threshold and add them to the current feature.

Returns
Boolean indicating whether a new feature was found while exploring the current entity.

If we reach this point (i.e. we haven't continued to the next queue entry), we've found a new mesh entity that's part of a feature. We need to mark the entity as visited at this point (and not before!) to avoid infinite recursion. If you mark the node too early you risk not coloring in a whole feature any time a "connecting threshold" is used since we may have already visited this entity earlier but it was in-between two thresholds.

See if this particular entity cell contributes to the centroid calculation. We only deal with elemental floods and only count it if it's owned by the current processor to avoid skewing the result.

Definition at line 1327 of file FeatureFloodCount.C.

1329{
1330 // if (dof_object == nullptr || dof_object == libMesh::remote_elem)
1331 // return false;
1332 mooseAssert(dof_object, "DOF object is nullptr");
1333 mooseAssert(_entity_queue.empty(), "Entity queue is not empty when starting a feature");
1334
1335 // Kick off the exploration of a new feature
1336 _entity_queue.push_front(dof_object);
1337
1338 bool return_value = false;
1339 FeatureData * feature = nullptr;
1340 while (!_entity_queue.empty())
1341 {
1342 const DofObject * curr_dof_object = _entity_queue.back();
1343 const Elem * elem = _is_elemental ? static_cast<const Elem *>(curr_dof_object) : nullptr;
1344 _entity_queue.pop_back();
1345
1346 // Retrieve the id of the current entity
1347 auto entity_id = curr_dof_object->id();
1348
1349 // Has this entity already been marked? - if so move along
1350 if (current_index != invalid_size_t &&
1351 _entities_visited[current_index].find(entity_id) != _entities_visited[current_index].end())
1352 continue;
1353
1354 // Are we outside of the range we should be working in?
1355 if (_is_elemental && !_dof_map.is_evaluable(*elem))
1356 continue;
1357
1358 // See if the current entity either starts a new feature or continues an existing feature
1359 auto new_id = invalid_id; // Writable reference to hold an optional id;
1360 Status status =
1361 Status::INACTIVE; // Status is inactive until we find an entity above the starting threshold
1362
1363 // Make sure that the Assembly object has the right element and subdomain information set
1364 // since we are moving through the mesh in a manual fashion.
1365 if (_is_elemental)
1366 _fe_problem.setCurrentSubdomainID(elem, 0);
1367
1368 if (!isNewFeatureOrConnectedRegion(curr_dof_object, current_index, feature, status, new_id))
1369 {
1370 // If we have an active feature, we just found a halo entity
1371 if (feature)
1372 feature->_halo_ids.insert(feature->_halo_ids.end(), entity_id);
1373 continue;
1374 }
1375
1376 mooseAssert(current_index != invalid_size_t, "current_index is invalid");
1377
1386 return_value = true;
1387 _entities_visited[current_index].insert(entity_id);
1388
1389 auto map_num = _single_map_mode ? decltype(current_index)(0) : current_index;
1390
1391 // New Feature (we need to create it and add it to our data structure)
1392 if (!feature)
1393 {
1394 _partial_feature_sets[map_num].emplace_back(
1395 current_index, _feature_count++, processor_id(), status);
1396
1397 // Get a handle to the feature we will update (always the last feature in the data structure)
1398 feature = &_partial_feature_sets[map_num].back();
1399
1400 // If new_id is valid, we'll set it in the feature here.
1401 if (new_id != invalid_id)
1402 feature->_id = new_id;
1403 }
1404
1405 // Insert the current entity into the local ids data structure
1406 feature->_local_ids.insert(feature->_local_ids.end(), entity_id);
1407
1413 if (_is_elemental && processor_id() == curr_dof_object->processor_id())
1414 {
1415 // Keep track of how many elements participate in the centroid averaging
1416 feature->_vol_count++;
1417
1418 // Sum the centroid values for now, we'll average them later
1419 feature->_centroid += elem->vertex_average();
1420
1421 // // Does the volume intersect the boundary?
1422 // if (_all_boundary_entity_ids.find(elem->id()) != _all_boundary_entity_ids.end())
1423 // feature->_intersects_boundary = true;
1424 }
1425
1426 if (_is_elemental)
1427 visitElementalNeighbors(elem,
1428 feature,
1429 /*expand_halos_only =*/false,
1430 /*disjoint_only =*/false);
1431 else
1432 visitNodalNeighbors(static_cast<const Node *>(curr_dof_object),
1433 feature,
1434 /*expand_halos_only =*/false);
1435 }
1436
1437 return return_value;
1438}
FEProblemBase::setCurrentSubdomainID
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override
FeatureFloodCount::_entities_visited
std::vector< std::set< dof_id_type > > _entities_visited
This variable keeps track of which nodes have been visited during execution.
Definition FeatureFloodCount.h:615
FeatureFloodCount::_entity_queue
std::deque< const DofObject * > _entity_queue
The data structure for maintaining entities to flood during discovery.
Definition FeatureFloodCount.h:759
FeatureFloodCount::isNewFeatureOrConnectedRegion
virtual bool isNewFeatureOrConnectedRegion(const DofObject *dof_object, std::size_t &current_index, FeatureData *&feature, Status &status, unsigned int &new_id)
Method called during the recursive flood routine that should return whether or not the current entity...
Definition FeatureFloodCount.C:1460
FeatureFloodCount::Status
Status
This enumeration is used to indicate status of the grains in the _unique_grains data structure.
Definition FeatureFloodCount.h:121
GeneralPostprocessor::_fe_problem
FEProblemBase & _fe_problem
Moose::Kokkos::Utils::find
KOKKOS_INLINE_FUNCTION const T * find(const T &target, const T *const begin, const T *const end)
TIMPI::status
MPI_Status status

Referenced by execute(), and PolycrystalUserObjectBase::execute().

◆ getConnectingThreshold()

Real FeatureFloodCount::getConnectingThreshold ( std::size_t  current_index) const
protectedvirtual

Return the "connecting" comparison threshold to use when inspecting an entity during the flood stage.

Definition at line 1447 of file FeatureFloodCount.C.

1448{
1449 return _step_connecting_threshold;
1450}

Referenced by isNewFeatureOrConnectedRegion().

◆ getCoupledVars()

const std::vector< MooseVariable * > & FeatureFloodCount::getCoupledVars ( ) const
inline

Returns a const vector to the coupled variable pointers.

Definition at line 97 of file FeatureFloodCount.h.

97{ return _vars; }

Referenced by AverageGrainVolume::AverageGrainVolume(), and FeatureVolumeVectorPostprocessor::FeatureVolumeVectorPostprocessor().

◆ getEntityValue()

Real FeatureFloodCount::getEntityValue ( dof_id_type  entity_id,
FieldType  field_type,
std::size_t  var_index = 0 
) const
virtual

Reimplemented in FauxGrainTracker, and GrainTracker.

Definition at line 927 of file FeatureFloodCount.C.

930{
931 auto use_default = false;
932 if (var_index == invalid_size_t)
933 {
934 use_default = true;
935 var_index = 0;
936 }
937
938 mooseAssert(var_index < _maps_size, "Index out of range");
939
940 switch (field_type)
941 {
942 case FieldType::UNIQUE_REGION:
943 {
944 const auto entity_it = _feature_maps[var_index].find(entity_id);
945
946 if (entity_it != _feature_maps[var_index].end())
947 return entity_it->second; // + _region_offsets[var_index];
948 else
949 return -1;
950 }
951
952 case FieldType::VARIABLE_COLORING:
953 {
954 mooseAssert(
955 _var_index_mode,
956 "\"enable_var_coloring\" must be set to true to pull back the VARIABLE_COLORING field");
957
958 const auto entity_it = _var_index_maps[var_index].find(entity_id);
959
960 if (entity_it != _var_index_maps[var_index].end())
961 return entity_it->second;
962 else
963 return -1;
964 }
965
966 case FieldType::GHOSTED_ENTITIES:
967 {
968 const auto entity_it = _ghosted_entity_ids.find(entity_id);
969
970 if (entity_it != _ghosted_entity_ids.end())
971 return entity_it->second;
972 else
973 return -1;
974 }
975
976 case FieldType::HALOS:
977 {
978 if (!use_default)
979 {
980 const auto entity_it = _halo_ids[var_index].find(entity_id);
981 if (entity_it != _halo_ids[var_index].end())
982 return entity_it->second;
983 }
984 else
985 {
986 // Showing halos in reverse order for backwards compatibility
987 for (auto map_num = _maps_size;
988 map_num-- /* don't compare greater than zero for unsigned */;)
989 {
990 const auto entity_it = _halo_ids[map_num].find(entity_id);
991
992 if (entity_it != _halo_ids[map_num].end())
993 return entity_it->second;
994 }
995 }
996 return -1;
997 }
998
999 case FieldType::CENTROID:
1000 {
1001 if (_periodic_node_map.size())
1002 mooseDoOnce(mooseWarning(
1003 "Centroids are not correct when using periodic boundaries, contact the MOOSE team"));
1004
1005 // If this element contains the centroid of one of features, return one
1006 const auto * elem_ptr = _mesh.elemPtr(entity_id);
1007
1008 for (const auto & feature : _feature_sets)
1009 {
1010 if (feature._status == Status::INACTIVE)
1011 continue;
1012
1013 if (elem_ptr->contains_point(feature._centroid))
1014 return 1;
1015 }
1016
1017 return 0;
1018 }
1019
1020 case FieldType::INTERSECTS_SPECIFIED_BOUNDARY:
1021 {
1022 auto ids = getVarToFeatureVector(entity_id);
1023 if (ids.size() != 0)
1024 return doesFeatureIntersectSpecifiedBoundary(ids[0]);
1025 return 0;
1026 }
1027
1028 default:
1029 return 0;
1030 }
1031}
FeatureFloodCount::doesFeatureIntersectSpecifiedBoundary
virtual bool doesFeatureIntersectSpecifiedBoundary(unsigned int feature_id) const
Returns a Boolean indicating whether this feature intersects boundaries in a user-supplied list.
Definition FeatureFloodCount.C:863
FeatureFloodCount::getVarToFeatureVector
virtual const std::vector< unsigned int > & getVarToFeatureVector(dof_id_type elem_id) const
Returns a list of active unique feature ids for a particular element.
Definition FeatureFloodCount.C:694
FeatureFloodCount::_ghosted_entity_ids
std::map< dof_id_type, int > _ghosted_entity_ids
The map for holding reconstructed ghosted element information.
Definition FeatureFloodCount.h:679
GeneralPostprocessor::mooseWarning
void mooseWarning(Args &&... args) const

Referenced by GrainTracker::getEntityValue(), and FeatureFloodCountAux::precalculateValue().

◆ getFeatures()

const std::vector< FeatureData > & FeatureFloodCount::getFeatures ( ) const
inline

Return a constant reference to the vector of all discovered features.

Definition at line 328 of file FeatureFloodCount.h.

328{ return _feature_sets; }

Referenced by GrainTracker::prepopulateState().

◆ getFeatureVar()

unsigned int FeatureFloodCount::getFeatureVar ( unsigned int  feature_id) const
virtual

Returns the variable representing the passed in feature.

Reimplemented in FauxGrainTracker, and GrainTracker.

Definition at line 824 of file FeatureFloodCount.C.

825{
826 // Some processors don't contain the largest feature id, in that case we just return invalid_id
827 if (feature_id >= _feature_id_to_local_index.size())
828 return invalid_id;
829
830 auto local_index = _feature_id_to_local_index[feature_id];
831 if (local_index != invalid_size_t)
832 {
833 mooseAssert(local_index < _feature_sets.size(), "local_index out of bounds");
834 return _feature_sets[local_index]._status != Status::INACTIVE
835 ? _feature_sets[local_index]._var_index
836 : invalid_id;
837 }
838
839 return invalid_id;
840}

Referenced by FeatureVolumeVectorPostprocessor::execute(), and GrainTracker::getFeatureVar().

◆ getFECoupledVars()

const std::vector< MooseVariableFEBase * > & FeatureFloodCount::getFECoupledVars ( ) const
inline

Returns a const vector to the coupled MooseVariableFEBase pointers.

Definition at line 100 of file FeatureFloodCount.h.

100{ return _fe_vars; }

Referenced by AverageGrainVolume::AverageGrainVolume().

◆ getNumberActiveFeatures()

std::size_t FeatureFloodCount::getNumberActiveFeatures ( ) const

Return the number of active features.

Definition at line 806 of file FeatureFloodCount.C.

807{
808 // Note: This value is parallel consistent, see FeatureFloodCount::communicateAndMerge()
809 return _feature_count;
810}

Referenced by AverageGrainVolume::getValue().

◆ getThreshold()

Real FeatureFloodCount::getThreshold ( std::size_t  current_index) const
protectedvirtual

Return the starting comparison threshold to use when inspecting an entity during the flood stage.

Reimplemented in GrainTracker.

Definition at line 1441 of file FeatureFloodCount.C.

1442{
1443 return _step_threshold;
1444}

Referenced by isNewFeatureOrConnectedRegion().

◆ getTotalFeatureCount()

std::size_t FeatureFloodCount::getTotalFeatureCount ( ) const
virtual

Returns the total feature count (active and inactive ids, useful for sizing vectors)

Since the FeatureFloodCount object doesn't maintain any information about features between invocations. The maximum id in use is simply the number of features.

Reimplemented in FauxGrainTracker, and GrainTracker.

Definition at line 813 of file FeatureFloodCount.C.

814{
820 return _feature_count;
821}

Referenced by FeatureVolumeVectorPostprocessor::execute(), and AverageGrainVolume::initialize().

◆ getValue()

Real FeatureFloodCount::getValue ( ) const
overridevirtual

Implements GeneralPostprocessor.

Reimplemented in FauxGrainTracker.

Definition at line 800 of file FeatureFloodCount.C.

801{
802 return static_cast<Real>(_feature_count);
803}

◆ getVarToFeatureVector()

const std::vector< unsigned int > & FeatureFloodCount::getVarToFeatureVector ( dof_id_type  elem_id) const
virtual

Returns a list of active unique feature ids for a particular element.

The vector is indexed by variable number with each entry containing either an invalid size_t type (no feature active at that location) or a feature id if the variable is non-zero at that location.

Reimplemented in FauxGrainTracker, and GrainTracker.

Definition at line 694 of file FeatureFloodCount.C.

695{
696 mooseDoOnce(if (!_compute_var_to_feature_map) mooseError(
697 "Please set \"compute_var_to_feature_map = true\" to use this interface method"));
698
699 const auto pos = _entity_var_to_features.find(elem_id);
700 if (pos != _entity_var_to_features.end())
701 {
702 mooseAssert(pos->second.size() == _n_vars, "Variable to feature vector not sized properly");
703 return pos->second;
704 }
705 else
706 return _empty_var_to_features;
707}
FeatureFloodCount::_entity_var_to_features
std::map< dof_id_type, std::vector< unsigned int > > _entity_var_to_features
Definition FeatureFloodCount.h:697
FeatureFloodCount::_empty_var_to_features
std::vector< unsigned int > _empty_var_to_features
Definition FeatureFloodCount.h:699

Referenced by AverageGrainVolume::execute(), FeatureVolumeVectorPostprocessor::execute(), getEntityValue(), GrainTracker::getVarToFeatureVector(), and FeatureFloodCountAux::precalculateValue().

◆ initialize()

void FeatureFloodCount::initialize ( )
overridevirtual

Implements GeneralPostprocessor.

Reimplemented in FauxGrainTracker, GrainTracker, FauxPolycrystalVoronoi, and PolycrystalUserObjectBase.

Definition at line 284 of file FeatureFloodCount.C.

285{
286 // Clear the feature marking maps and region counters and other data structures
287 for (const auto map_num : make_range(_maps_size))
288 {
289 _feature_maps[map_num].clear();
290 _partial_feature_sets[map_num].clear();
291
292 if (_var_index_mode)
293 _var_index_maps[map_num].clear();
294
295 _halo_ids[map_num].clear();
296 }
297
298 _feature_sets.clear();
299
300 // Calculate the thresholds for this iteration
301 _step_threshold = _element_average_value + _threshold;
302 _step_connecting_threshold = _element_average_value + _connecting_threshold;
303
304 _ghosted_entity_ids.clear();
305
306 // Reset the feature count and max local size
307 _feature_count = 0;
308
309 _entity_var_to_features.clear();
310
311 for (auto & map_ref : _entities_visited)
312 map_ref.clear();
313}
clear
sideset clear()

Referenced by GrainTracker::initialize(), and PolycrystalUserObjectBase::initialize().

◆ initialSetup()

void FeatureFloodCount::initialSetup ( )
overridevirtual

Size the empty var to features vector to the number of coupled variables. This empty vector (but properly sized) vector is returned for elements that are queried but are not in the structure (which also shouldn't happen). The user is warned in this case but this helps avoid extra bounds checking in user code and avoids segfaults.

Reimplemented from GeneralPostprocessor.

Reimplemented in FauxPolycrystalVoronoi, and PolycrystalUserObjectBase.

Definition at line 263 of file FeatureFloodCount.C.

264{
265 // We need one map per coupled variable for normal runs to support overlapping features
266 _entities_visited.resize(_vars.size());
267
268 // Get a pointer to the PeriodicBoundaries buried in libMesh
269 _pbs = _sys.dofMap().get_periodic_boundaries();
270
271 meshChanged();
272
280 _empty_var_to_features.resize(_n_vars, invalid_id);
281}
FeatureFloodCount::meshChanged
virtual void meshChanged() override
Definition FeatureFloodCount.C:321
SystemBase::dofMap
virtual libMesh::DofMap & dofMap()
libMesh::DofMap::get_periodic_boundaries
PeriodicBoundaries * get_periodic_boundaries()

Referenced by PolycrystalUserObjectBase::initialSetup().

◆ isBoundaryEntity()

template<typename T >
bool FeatureFloodCount::isBoundaryEntity ( const T *  entity) const
protected

Returns a Boolean indicating whether the entity is on one of the desired boundaries.

Definition at line 1860 of file FeatureFloodCount.C.

1861{
1862 mooseAssert(_bnd_elem_range, "Boundary Element Range is nullptr");
1863
1864 if (entity)
1865 for (const auto & belem : *_bnd_elem_range)
1866 // Only works for Elements
1867 if (belem->_elem->id() == entity->id() && hasBoundary(belem->_bnd_id))
1868 return true;
1869
1870 return false;
1871}

Referenced by visitNeighborsHelper().

◆ isElemental()

bool FeatureFloodCount::isElemental ( ) const
inline

Definition at line 117 of file FeatureFloodCount.h.

117{ return _is_elemental; }

Referenced by FeatureFloodCountAux::FeatureFloodCountAux().

◆ isFeaturePercolated()

bool FeatureFloodCount::isFeaturePercolated ( unsigned int  feature_id) const
virtual

Returns a Boolean indicating whether this feature is percolated (e.g.

intersects at least two different boundaries from sets supplied by the user)

Reimplemented in GrainTracker.

Definition at line 885 of file FeatureFloodCount.C.

886{
887 // Some processors don't contain the largest feature id, in that case we just return invalid_id
888 if (feature_id >= _feature_id_to_local_index.size())
889 return false;
890
891 auto local_index = _feature_id_to_local_index[feature_id];
892
893 if (local_index != invalid_size_t)
894 {
895 mooseAssert(local_index < _feature_sets.size(), "local_index out of bounds");
896 bool primary = ((_feature_sets[local_index]._boundary_intersection &
897 BoundaryIntersection::PRIMARY_PERCOLATION_BOUNDARY) ==
898 BoundaryIntersection::PRIMARY_PERCOLATION_BOUNDARY);
899 bool secondary = ((_feature_sets[local_index]._boundary_intersection &
900 BoundaryIntersection::SECONDARY_PERCOLATION_BOUNDARY) ==
901 BoundaryIntersection::SECONDARY_PERCOLATION_BOUNDARY);
902 return _feature_sets[local_index]._status != Status::INACTIVE ? (primary && secondary) : false;
903 }
904
905 return false;
906}

Referenced by FeatureVolumeVectorPostprocessor::execute().

◆ isNewFeatureOrConnectedRegion()

bool FeatureFloodCount::isNewFeatureOrConnectedRegion ( const DofObject *  dof_object,
std::size_t &  current_index,
FeatureData *&  feature,
Status &  status,
unsigned int &  new_id 
)
protectedvirtual

Method called during the recursive flood routine that should return whether or not the current entity is part of the current feature (if one is being explored), or if it's the start of a new feature.

If the value is only above the connecting threshold, it's still part of a feature but possibly part of one that we'll discard if there is never any starting threshold encountered.

Reimplemented in PolycrystalUserObjectBase.

Definition at line 1460 of file FeatureFloodCount.C.

1465{
1466 // Get the value of the current variable for the current entity
1467 Real entity_value;
1468 if (_is_elemental)
1469 {
1470 const Elem * elem = static_cast<const Elem *>(dof_object);
1471 std::vector<Point> centroid(1, elem->vertex_average());
1472 _subproblem.reinitElemPhys(elem, centroid, 0);
1473 entity_value = _vars[current_index]->sln()[0];
1474 }
1475 else
1476 entity_value = _vars[current_index]->getNodalValue(*static_cast<const Node *>(dof_object));
1477
1478 // If the value compares against our starting threshold, this is definitely part of a feature
1479 // we'll keep
1480 if (compareValueWithThreshold(entity_value, getThreshold(current_index)))
1481 {
1482 Status * status_ptr = &status;
1483
1484 if (feature)
1485 status_ptr = &feature->_status;
1486
1487 // Update an existing feature's status or clear the flag on the passed in status
1488 *status_ptr &= ~Status::INACTIVE;
1489 return true;
1490 }
1491
1496 return compareValueWithThreshold(entity_value, getConnectingThreshold(current_index));
1497}
FeatureFloodCount::compareValueWithThreshold
bool compareValueWithThreshold(Real entity_value, Real threshold) const
This method is used to determine whether the current entity value is part of a feature or not.
Definition FeatureFloodCount.C:1453
FeatureFloodCount::getThreshold
virtual Real getThreshold(std::size_t current_index) const
Return the starting comparison threshold to use when inspecting an entity during the flood stage.
Definition FeatureFloodCount.C:1441
FeatureFloodCount::getConnectingThreshold
virtual Real getConnectingThreshold(std::size_t current_index) const
Return the "connecting" comparison threshold to use when inspecting an entity during the flood stage.
Definition FeatureFloodCount.C:1447
SubProblem::reinitElemPhys
virtual void reinitElemPhys(const Elem *elem, const std::vector< Point > &phys_points_in_elem, const THREAD_ID tid)=0

Referenced by flood().

◆ mergeSets()

void FeatureFloodCount::mergeSets ( )
protectedvirtual

This routine is called on the primary rank only and stitches together the partial feature pieces seen on any processor.

Insert the new entity at the end of the list so that it may be checked against all other partial features again.

Now remove both halves the merged features: it2 contains the "moved" feature cell just inserted at the back of the list, it1 contains the mostly empty other half. We have to be careful about the order in which these two elements are deleted. We delete it2 first since we don't care where its iterator points after the deletion. We are going to break out of this loop anyway. If we delete it1 first, it may end up pointing at the same location as it2 which after the second deletion would cause both of the iterators to be invalidated.

Reimplemented in PolycrystalUserObjectBase.

Definition at line 1138 of file FeatureFloodCount.C.

1139{
1140 TIME_SECTION("mergeSets", 3, "Merging Sets");
1141
1142 // When working with _distribute_merge_work all of the maps will be empty except for one
1143 for (const auto map_num : make_range(_maps_size))
1144 {
1145 for (auto it1 = _partial_feature_sets[map_num].begin();
1146 it1 != _partial_feature_sets[map_num].end();
1147 /* No increment on it1 */)
1148 {
1149 bool merge_occured = false;
1150 for (auto it2 = _partial_feature_sets[map_num].begin();
1151 it2 != _partial_feature_sets[map_num].end();
1152 ++it2)
1153 {
1154 if (it1 != it2 && areFeaturesMergeable(*it1, *it2))
1155 {
1156 it2->merge(std::move(*it1));
1157
1162 _partial_feature_sets[map_num].emplace_back(std::move(*it2));
1163
1173 _partial_feature_sets[map_num].erase(it2);
1174 it1 = _partial_feature_sets[map_num].erase(it1); // it1 is incremented here!
1175
1176 // A merge occurred, this is used to determine whether or not we increment the outer
1177 // iterator
1178 merge_occured = true;
1179
1180 // We need to start the list comparison over for the new it1 so break here
1181 break;
1182 }
1183 } // it2 loop
1184
1185 if (!merge_occured) // No merges so we need to manually increment the outer iterator
1186 ++it1;
1187
1188 } // it1 loop
1189 } // map loop
1190}
FeatureFloodCount::areFeaturesMergeable
virtual bool areFeaturesMergeable(const FeatureData &f1, const FeatureData &f2) const
Method for determining whether two features are mergeable.
Definition FeatureFloodCount.C:1276

Referenced by communicateAndMerge().

◆ meshChanged()

void FeatureFloodCount::meshChanged ( )
overridevirtual

We need to build a set containing all of the boundary entities to compare against. This will be elements for elemental flooding. Volumes for nodal flooding is not supported

Reimplemented from GeneralPostprocessor.

Reimplemented in GrainTracker, and FauxPolycrystalVoronoi.

Definition at line 321 of file FeatureFloodCount.C.

322{
323 _point_locator = _mesh.getMesh().sub_point_locator();
324
325 _mesh.buildPeriodicNodeMap(_periodic_node_map, _var_number, _pbs);
326
327 // Build a new node to element map
328 _nodes_to_elem_map.clear();
329 MeshTools::build_nodes_to_elem_map(_mesh.getMesh(), _nodes_to_elem_map);
330
336 _all_boundary_entity_ids.clear();
337 if (_is_elemental)
338 for (auto elem_it = _mesh.bndElemsBegin(), elem_end = _mesh.bndElemsEnd(); elem_it != elem_end;
339 ++elem_it)
340 _all_boundary_entity_ids.insert((*elem_it)->_elem->id());
341}
FeatureFloodCount::_all_boundary_entity_ids
std::unordered_set< dof_id_type > _all_boundary_entity_ids
The set of entities on the boundary of the domain used for determining if features intersect any boun...
Definition FeatureFloodCount.h:695
FeatureFloodCount::_nodes_to_elem_map
std::unordered_map< dof_id_type, std::vector< const Elem * > > _nodes_to_elem_map
The data structure used to find neighboring elements give a node ID.
Definition FeatureFloodCount.h:626
FeatureFloodCount::_point_locator
std::unique_ptr< libMesh::PointLocatorBase > _point_locator
Definition FeatureFloodCount.h:673
MooseMesh::getMesh
MeshBase & getMesh()
MooseMesh::bndElemsBegin
virtual bnd_elem_iterator bndElemsBegin()
MooseMesh::buildPeriodicNodeMap
void buildPeriodicNodeMap(std::multimap< dof_id_type, dof_id_type > &periodic_node_map, unsigned int var_number, libMesh::PeriodicBoundaries *pbs) const
MooseMesh::bndElemsEnd
virtual bnd_elem_iterator bndElemsEnd()

Referenced by initialSetup(), and GrainTracker::meshChanged().

◆ numberOfDistributedMergeHelpers()

processor_id_type FeatureFloodCount::numberOfDistributedMergeHelpers ( ) const
protectedvirtual

Returns a number indicating the number of merge helpers when running in parallel based on certain implementer decided criteria.

This is a communication versus computation trade-off that we are almost always willing to make except for small problems. The decision however may be more complicated for some derived classes.

Reimplemented in PolycrystalUserObjectBase.

Definition at line 397 of file FeatureFloodCount.C.

398{
399 return _app.n_processors() >= _maps_size ? _maps_size : 1;
400}

Referenced by communicateAndMerge().

◆ numCoupledVars()

std::size_t FeatureFloodCount::numCoupledVars ( ) const
inline

Returns the number of coupled varaibles.

Definition at line 87 of file FeatureFloodCount.h.

87{ return _n_vars; }

◆ prepareDataForTransfer()

void FeatureFloodCount::prepareDataForTransfer ( )
protectedvirtual

This routine uses the local flooded data to build up the local feature data structures (_partial feature_sets).

This routine does not perform any communication so the _partial_feature_sets data structure will only contain information from the local processor after calling this routine. Any existing data in the _partial_feature_sets structure is destroyed by calling this routine.

_partial_feature_sets layout: The outer vector is sized to one when _single_map_mode == true, otherwise it is sized for the number of coupled variables. The inner list represents the flooded regions (local only after this call but fully populated after parallel communication and stitching).

If using a vector container, we need to sort all of the data structures for later operations such as checking for intersection and merging. The following "sort" function does nothing when invoked on a std::set.

Save off the min entity id present in the feature to uniquely identify the feature regardless of n_procs

Reimplemented in PolycrystalUserObjectBase.

Definition at line 1034 of file FeatureFloodCount.C.

1035{
1036 TIME_SECTION("prepareDataForTransfer", 3, "Preparing Data For Transfer");
1037
1038 MeshBase & mesh = _mesh.getMesh();
1039
1040 FeatureData::container_type local_ids_no_ghost, set_difference;
1041
1042 for (auto & list_ref : _partial_feature_sets)
1043 {
1044 for (auto & feature : list_ref)
1045 {
1046 // See if the feature intersects a boundary or perhaps one of the percolation boundaries.
1047 updateBoundaryIntersections(feature);
1048
1049 // Periodic node ids
1050 appendPeriodicNeighborNodes(feature);
1051
1057 FeatureFloodCount::sort(feature._ghosted_ids);
1058 FeatureFloodCount::sort(feature._local_ids);
1059 FeatureFloodCount::sort(feature._halo_ids);
1060 FeatureFloodCount::sort(feature._disjoint_halo_ids);
1061 FeatureFloodCount::sort(feature._periodic_nodes);
1062
1063 // Now extend the bounding box by the halo region
1064 if (_is_elemental)
1065 feature.updateBBoxExtremes(mesh);
1066 else
1067 {
1068 for (auto & halo_id : feature._halo_ids)
1069 updateBBoxExtremesHelper(feature._bboxes[0], mesh.point(halo_id));
1070 }
1071
1072 mooseAssert(!feature._local_ids.empty(), "local entity ids cannot be empty");
1073
1078 feature._min_entity_id = *feature._local_ids.begin();
1079 }
1080 }
1081}
updateBBoxExtremesHelper
void updateBBoxExtremesHelper(BoundingBox &bbox, const Point &node)
Definition FeatureFloodCount.C:2251
FeatureFloodCount::appendPeriodicNeighborNodes
void appendPeriodicNeighborNodes(FeatureData &feature) const
This routine adds the periodic node information to our data structure prior to packing the data this ...
Definition FeatureFloodCount.C:1821
FeatureFloodCount::sort
static void sort(std::set< T > &)
Definition FeatureFloodCount.h:720
FeatureFloodCount::updateBoundaryIntersections
void updateBoundaryIntersections(FeatureData &feature) const
Update the feature's attributes to indicate boundary intersections.
Definition FeatureFloodCount.C:1774

Referenced by communicateAndMerge(), and PolycrystalUserObjectBase::prepareDataForTransfer().

◆ reserve() [1/2]

template<class T >
static void FeatureFloodCount::reserve ( std::set< T > &  ,
std::size_t   
)
inlinestaticprivate

Definition at line 732 of file FeatureFloodCount.h.

733 {
734 // Sets are trees, no reservations necessary
735 }

Referenced by FeatureFloodCount::FeatureData::consolidate(), FeatureFloodCount::FeatureData::merge(), and FeatureFloodCount::FeatureData::updateBBoxExtremes().

◆ reserve() [2/2]

template<class T >
static void FeatureFloodCount::reserve ( std::vector< T > &  container,
std::size_t  size 
)
inlinestaticprivate

Definition at line 738 of file FeatureFloodCount.h.

739 {
740 container.reserve(size);
741 }

◆ restoreOriginalDataStructures()

virtual void FeatureFloodCount::restoreOriginalDataStructures ( std::vector< std::list< FeatureData > > &  )
inlineprotectedvirtual

Reimplemented in PolycrystalUserObjectBase.

Definition at line 487 of file FeatureFloodCount.h.

487{}

Referenced by communicateAndMerge().

◆ scatterAndUpdateRanks()

void FeatureFloodCount::scatterAndUpdateRanks ( )
protected

Calls buildLocalToGlobalIndices to build the individual local to global indicies for each rank and scatters that information to all ranks.

Finally, the non-primary ranks update their own data structures to reflect the global mappings.

On non-root processors we can't maintain the full _feature_sets data structure since we don't have all of the global information. We'll move the items from the partial feature sets into a flat structure maintaining order and update the internal IDs with the proper global ID.

Important: Make sure we clear the local status if we received a valid global index for this feature. It's possible that we have a status of INVALID on the local processor because there was never any starting threshold found. However, the root processor wouldn't have sent an index if it didn't find a starting threshold connected to our local piece.

Definition at line 710 of file FeatureFloodCount.C.

711{
712 // local to global map (one per processor)
713 std::vector<int> counts;
714 std::vector<std::size_t> local_to_global_all;
715 if (_is_primary)
716 buildLocalToGlobalIndices(local_to_global_all, counts);
717
718 // Scatter local_to_global indices to all processors and store in class member variable
719 _communicator.scatter(local_to_global_all, counts, _local_to_global_feature_map);
720
721 std::size_t largest_global_index = std::numeric_limits<std::size_t>::lowest();
722 if (!_is_primary)
723 {
724 _feature_sets.resize(_local_to_global_feature_map.size());
725
732 for (auto & list_ref : _partial_feature_sets)
733 {
734 for (auto & feature : list_ref)
735 {
736 mooseAssert(feature._orig_ids.size() == 1, "feature._orig_ids length doesn't make sense");
737
738 auto global_index = FeatureFloodCount::invalid_size_t;
739 auto local_index = feature._orig_ids.begin()->second;
740
741 if (local_index < _local_to_global_feature_map.size())
742 global_index = _local_to_global_feature_map[local_index];
743
744 if (global_index != FeatureFloodCount::invalid_size_t)
745 {
746 if (global_index > largest_global_index)
747 largest_global_index = global_index;
748
749 // Set the correct global index
750 feature._id = global_index;
751
759 feature._status &= ~Status::INACTIVE;
760
761 // Move the feature into the correct place
762 _feature_sets[local_index] = std::move(feature);
763 }
764 }
765 }
766 }
767 else
768 {
769 for (auto global_index : local_to_global_all)
770 if (global_index != FeatureFloodCount::invalid_size_t && global_index > largest_global_index)
771 largest_global_index = global_index;
772 }
773
774 // communicate the boundary intersection state
775 std::vector<std::pair<unsigned int, int>> intersection_state;
776 for (auto & feature : _feature_sets)
777 intersection_state.emplace_back(feature._id, static_cast<int>(feature._boundary_intersection));
778
779 // gather on root
780 _communicator.gather(0, intersection_state);
781
782 // consolidate
783 std::map<unsigned int, int> consolidated_intersection_state;
784 if (_is_primary)
785 for (const auto & [id, state] : intersection_state)
786 consolidated_intersection_state[id] |= state;
787
788 // broadcast result
789 _communicator.broadcast(consolidated_intersection_state, 0);
790
791 // apply broadcast changes
792 for (auto & feature : _feature_sets)
793 feature._boundary_intersection |=
794 static_cast<BoundaryIntersection>(consolidated_intersection_state[feature._id]);
795
796 buildFeatureIdToLocalIndices(largest_global_index);
797}
int
void ErrorVector unsigned int
FeatureFloodCount
This object will mark nodes or elements of continuous regions all with a unique number for the purpos...
Definition FeatureFloodCount.h:44
FeatureFloodCount::buildFeatureIdToLocalIndices
void buildFeatureIdToLocalIndices(unsigned int max_id)
This method builds a lookup map for retrieving the right local feature (by index) given a global inde...
Definition FeatureFloodCount.C:660
FeatureFloodCount::_local_to_global_feature_map
std::vector< std::size_t > _local_to_global_feature_map
The vector recording the local to global feature indices.
Definition FeatureFloodCount.h:665
FeatureFloodCount::buildLocalToGlobalIndices
virtual void buildLocalToGlobalIndices(std::vector< std::size_t > &local_to_global_all, std::vector< int > &counts) const
This routine populates a stacked vector of local to global indices per rank and the associated count ...
Definition FeatureFloodCount.C:614
FeatureFloodCount::BoundaryIntersection
BoundaryIntersection
This enumeration is used to inidacate status of boundary intersections.
Definition FeatureFloodCount.h:130
libMesh::Parallel::Communicator::scatter
void scatter(const std::vector< T, A > &data, T &recv, const unsigned int root_id=0) const
libMesh::Parallel::Communicator::gather
void gather(const unsigned int root_id, const T &send_data, std::vector< T, A > &recv) const

Referenced by GrainTracker::assignGrains(), finalize(), and GrainTracker::trackGrains().

◆ serialize()

void FeatureFloodCount::serialize ( std::string &  serialized_buffer,
unsigned int  var_num = invalid_id 
)
protected

This routines packs the _partial_feature_sets data into a structure suitable for parallel communication operations.

Definition at line 1084 of file FeatureFloodCount.C.

1085{
1086 // stream for serializing the _partial_feature_sets data structure to a byte stream
1087 std::ostringstream oss;
1088
1089 mooseAssert(var_num == invalid_id || var_num < _partial_feature_sets.size(),
1090 "var_num out of range");
1091
1092 // Serialize everything
1093 if (var_num == invalid_id)
1094 dataStore(oss, _partial_feature_sets, this);
1095 else
1096 dataStore(oss, _partial_feature_sets[var_num], this);
1097
1098 // Populate the passed in string pointer with the string stream's buffer contents
1099 serialized_buffer.assign(oss.str());
1100}
dataStore
void dataStore(std::ostream &stream, FeatureFloodCount::FeatureData &feature, void *context)
Definition FeatureFloodCount.C:32

Referenced by communicateAndMerge().

◆ sort() [1/2]

template<class T >
static void FeatureFloodCount::sort ( std::set< T > &  )
inlinestaticprivate

Definition at line 720 of file FeatureFloodCount.h.

721 {
722 // Sets are already sorted, do nothing
723 }

Referenced by prepareDataForTransfer().

◆ sort() [2/2]

template<class T >
static void FeatureFloodCount::sort ( std::vector< T > &  container)
inlinestaticprivate

Definition at line 726 of file FeatureFloodCount.h.

727 {
728 std::sort(container.begin(), container.end());
729 }

◆ sortAndLabel()

void FeatureFloodCount::sortAndLabel ( )
protected

Sort and assign ids to features based on their position in the container after sorting.

Perform a sort to give a parallel unique sorting to the identified features. We use the "min_entity_id" inside each feature to assign it's position in the sorted vector.

Sanity check. Now that we've sorted the flattened vector of features we need to make sure that the counts vector still lines up appropriately with each feature's _var_index.

Definition at line 568 of file FeatureFloodCount.C.

569{
570 mooseAssert(_is_primary, "sortAndLabel can only be called on the primary");
571
577 std::sort(_feature_sets.begin(), _feature_sets.end());
578
579#ifndef NDEBUG
585 unsigned int feature_offset = 0;
586 for (const auto map_num : make_range(_maps_size))
587 {
588 // Skip empty map checks
589 if (_feature_counts_per_map[map_num] == 0)
590 continue;
591
592 // Check the begin and end of the current range
593 auto range_front = feature_offset;
594 auto range_back = feature_offset + _feature_counts_per_map[map_num] - 1;
595
596 mooseAssert(range_front <= range_back && range_back < _feature_count,
597 "Indexing error in feature sets");
598
599 if (!_single_map_mode && (_feature_sets[range_front]._var_index != map_num ||
600 _feature_sets[range_back]._var_index != map_num))
601 mooseError("Error in _feature_sets sorting, map index: ", map_num);
602
603 feature_offset += _feature_counts_per_map[map_num];
604 }
605#endif
606
607 // Label the features with an ID based on the sorting (processor number independent value)
608 for (const auto i : index_range(_feature_sets))
609 if (_feature_sets[i]._id == invalid_id)
610 _feature_sets[i]._id = i;
611}

Referenced by GrainTracker::assignGrains(), and finalize().

◆ updateBoundaryIntersections()

void FeatureFloodCount::updateBoundaryIntersections ( FeatureData &  feature) const
protected

Update the feature's attributes to indicate boundary intersections.

Definition at line 1774 of file FeatureFloodCount.C.

1775{
1776 if (_is_elemental)
1777 {
1778 for (auto entity : feature._local_ids)
1779 {
1780 // See if this feature is on a boundary if we haven't already figured that out
1781 if ((feature._boundary_intersection & BoundaryIntersection::ANY_BOUNDARY) ==
1782 BoundaryIntersection::NONE)
1783 {
1784 Elem * elem = _mesh.elemPtr(entity);
1785 if (elem && elem->on_boundary())
1786 feature._boundary_intersection |= BoundaryIntersection::ANY_BOUNDARY;
1787 }
1788
1789 // Now see if the feature touches the primary and/or secondary boundary IDs if we haven't
1790 // figured that out already
1791 if ((feature._boundary_intersection & BoundaryIntersection::PRIMARY_PERCOLATION_BOUNDARY) ==
1792 BoundaryIntersection::NONE)
1793 {
1794 for (auto primary_id : _primary_perc_bnds)
1795 if (_mesh.isBoundaryElem(entity, primary_id))
1796 feature._boundary_intersection |= BoundaryIntersection::PRIMARY_PERCOLATION_BOUNDARY;
1797 }
1798
1799 if ((feature._boundary_intersection & BoundaryIntersection::SECONDARY_PERCOLATION_BOUNDARY) ==
1800 BoundaryIntersection::NONE)
1801 {
1802 for (auto secondary_id : _secondary_perc_bnds)
1803 if (_mesh.isBoundaryElem(entity, secondary_id))
1804 feature._boundary_intersection |= BoundaryIntersection::SECONDARY_PERCOLATION_BOUNDARY;
1805 }
1806
1807 // See if the feature contacts any of the user-specified boundaries if we haven't
1808 // done so already
1809 if ((feature._boundary_intersection & BoundaryIntersection::SPECIFIED_BOUNDARY) ==
1810 BoundaryIntersection::NONE)
1811 {
1812 for (auto specified_id : _specified_bnds)
1813 if (_mesh.isBoundaryElem(entity, specified_id))
1814 feature._boundary_intersection |= BoundaryIntersection::SPECIFIED_BOUNDARY;
1815 }
1816 }
1817 }
1818}

Referenced by prepareDataForTransfer().

◆ updateFieldInfo()

void FeatureFloodCount::updateFieldInfo ( )
protectedvirtual

This method is used to populate any of the data structures used for storing field data (nodal or elemental).

It is called at the end of finalize and can make use of any of the data structures created during the execution of this postprocessor.

Reimplemented in GrainTracker.

Definition at line 1282 of file FeatureFloodCount.C.

1283{
1284 for (const auto i : index_range(_feature_sets))
1285 {
1286 auto & feature = _feature_sets[i];
1287
1288 // If the developer has requested _condense_map_info we'll make sure we only update the zeroth
1289 // map
1290 auto map_index = (_single_map_mode || _condense_map_info) ? decltype(feature._var_index)(0)
1291 : feature._var_index;
1292
1293 // Loop over the entity ids of this feature and update our local map
1294 for (auto entity : feature._local_ids)
1295 {
1296 _feature_maps[map_index][entity] = static_cast<int>(feature._id);
1297
1298 if (_var_index_mode)
1299 _var_index_maps[map_index][entity] = feature._var_index;
1300
1301 // Fill in the data structure that keeps track of all features per elem
1302 if (_compute_var_to_feature_map)
1303 {
1304 auto insert_pair = moose_try_emplace(
1305 _entity_var_to_features, entity, std::vector<unsigned int>(_n_vars, invalid_id));
1306 auto & vec_ref = insert_pair.first->second;
1307 vec_ref[feature._var_index] = feature._id;
1308 }
1309 }
1310
1311 if (_compute_halo_maps)
1312 // Loop over the halo ids to update cells with halo information
1313 for (auto entity : feature._halo_ids)
1314 _halo_ids[map_index][entity] = static_cast<int>(feature._id);
1315
1316 // Loop over the ghosted ids to update cells with ghost information
1317 for (auto entity : feature._ghosted_ids)
1318 _ghosted_entity_ids[entity] = 1;
1319
1320 // TODO: Fixme
1321 if (!_global_numbering)
1322 mooseError("Local numbering currently disabled");
1323 }
1324}
moose_try_emplace
std::pair< typename M::iterator, bool > moose_try_emplace(M &m, const typename M::key_type &k, Args &&... args)

Referenced by finalize().

◆ updateRegionOffsets()

void FeatureFloodCount::updateRegionOffsets ( )
protected

This routine updates the _region_offsets variable which is useful for quickly determining the proper global number for a feature when using multimap mode.

◆ validParams()

InputParameters FeatureFloodCount::validParams ( )
static

The FeatureFloodCount and derived objects should not to operate on the displaced mesh. These objects consume variable values from the nonlinear system and use a lot of raw geometric element information from the mesh. If you use the displaced system with EBSD information for instance, you'll have difficulties reconciling the difference between the coordinates from the EBSD data file and the potential displacements applied via boundary conditions.

Definition at line 99 of file FeatureFloodCount.C.

100{
101 InputParameters params = GeneralPostprocessor::validParams();
102 params += BoundaryRestrictable::validParams();
103
104 params.addRequiredCoupledVar(
105 "variable",
106 "The variable(s) for which to find connected regions of interests, i.e. \"features\".");
107 params.addParam<Real>(
108 "threshold", 0.5, "The threshold value for which a new feature may be started");
109 params.addParam<Real>(
110 "connecting_threshold",
111 "The threshold for which an existing feature may be extended (defaults to \"threshold\")");
112 params.addParam<bool>("use_single_map",
113 true,
114 "Determine whether information is tracked per "
115 "coupled variable or consolidated into one "
116 "(default: true)");
117 params.addParam<bool>(
118 "condense_map_info",
119 false,
120 "Determines whether we condense all the node values when in multimap mode (default: false)");
121 params.addParam<bool>("use_global_numbering",
122 true,
123 "Determine whether or not global numbers are "
124 "used to label features on multiple maps "
125 "(default: true)");
126 params.addParam<bool>("enable_var_coloring",
127 false,
128 "Instruct the Postprocessor to populate the variable index map.");
129 params.addParam<bool>(
130 "compute_halo_maps",
131 false,
132 "Instruct the Postprocessor to communicate proper halo information to all ranks");
133 params.addParam<bool>("compute_var_to_feature_map",
134 false,
135 "Instruct the Postprocessor to compute the active vars to features map");
136 params.addParam<bool>(
137 "use_less_than_threshold_comparison",
138 true,
139 "Controls whether features are defined to be less than or greater than the threshold value.");
140
141 params.addParam<std::vector<BoundaryName>>(
142 "primary_percolation_boundaries",
143 "A list of boundaries used in conjunction with the corresponding "
144 "\"secondary_percolation_boundaries\" parameter for determining if a feature creates a path "
145 "connecting any pair of boundaries");
146 params.addParam<std::vector<BoundaryName>>(
147 "secondary_percolation_boundaries",
148 "Paired boundaries with \"primaryary_percolation_boundaries\" parameter");
149 params.addParam<std::vector<BoundaryName>>(
150 "specified_boundaries",
151 "An optional list of boundaries; if supplied, each feature is checked to determine whether "
152 "it intersects any of the specified boundaries in this list.");
153
161 params.set<bool>("use_displaced_mesh") = false;
162
163 // The FeatureFloodCount object does not require that any state (restartable information) is
164 // maintained. This Boolean is set to false so that we don't ask MOOSE to save a potentially
165 // large data structure for no reason. It is set for true in at least one derived class
166 // (GrainTracker).
167 params.addPrivateParam<bool>("restartable_required", false);
168
169 params.addParamNamesToGroup(
170 "use_single_map condense_map_info use_global_numbering primary_percolation_boundaries",
171 "Advanced");
172
173 MooseEnum flood_type("NODAL ELEMENTAL", "ELEMENTAL");
174 params.addParam<MooseEnum>("flood_entity_type",
175 flood_type,
176 "Determines whether the flood algorithm runs on nodes or elements");
177
178 params.addClassDescription("The object is able to find and count \"connected components\" in any "
179 "solution field or number of solution fields. A primary example would "
180 "be to count \"bubbles\".");
181
182 params.addRelationshipManager("ElementSideNeighborLayers",
183 Moose::RelationshipManagerType::GEOMETRIC |
184 Moose::RelationshipManagerType::ALGEBRAIC);
185
186 return params;
187}
BoundaryRestrictable::validParams
static InputParameters validParams()
GeneralPostprocessor::validParams
static InputParameters validParams()
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
InputParameters::addRequiredCoupledVar
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addPrivateParam
void addPrivateParam(const std::string &name, const T &value)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRelationshipManager
void addRelationshipManager(const std::string &name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback input_parameter_callback=nullptr)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)

Referenced by GrainTracker::validParams(), GrainTrackerInterface::validParams(), and PolycrystalUserObjectBase::validParams().

◆ visitElementalNeighbors()

void FeatureFloodCount::visitElementalNeighbors ( const Elem *  elem,
FeatureData *  feature,
bool  expand_halos_only,
bool  disjoint_only 
)
protected

Retrieve only the active neighbors for each side of this element, append them to the list of active neighbors

In general, {evaluable elements} >= {local elements} U {algebraic ghosting elements}. That is, the number of evaluable elements does NOT necessarily equal to the number of local and algebraic ghosting elements. The neighbors of evaluable elements can be remote even though we have two layers of geometric ghosting elements.

If the current element (passed into this method) doesn't have a connected neighbor but does have a topological neighbor, this might be a new disjoint region that we'll need to represent with a separate bounding box. To find out for sure, we'll need see if the new neighbors are present in any of the halo or disjoint halo sets. If they are not present, this is a new region.

In general, {evaluable elements} >= {local elements} U {algebraic ghosting elements}. That is, the number of evaluable elements does NOT necessarily equal to the number of local and algebraic ghosting elements. The neighbors of evaluable elements can be remote even though we have two layers of geometric ghosting elements.

This neighbor is NULL which means we need to expand the bounding box here in case this grain is up against multiple domain edges so we don't end up with a degenerate bounding box.

Definition at line 1618 of file FeatureFloodCount.C.

1622{
1623 mooseAssert(elem, "Elem is NULL");
1624
1625 std::vector<const Elem *> all_active_neighbors;
1626 MeshBase & mesh = _mesh.getMesh();
1627
1628 // Loop over all neighbors (at the the same level as the current element)
1629 for (const auto i : make_range(elem->n_neighbors()))
1630 {
1631 const Elem * neighbor_ancestor = nullptr;
1632 bool topological_neighbor = false;
1633
1638 neighbor_ancestor = elem->neighbor_ptr(i);
1639
1640 if (neighbor_ancestor)
1641 {
1648 if (neighbor_ancestor->is_remote())
1649 continue;
1650
1651 neighbor_ancestor->active_family_tree_by_neighbor(all_active_neighbors, elem, false);
1652 }
1653 else
1654 {
1655 neighbor_ancestor = elem->topological_neighbor(i, mesh, *_point_locator, _pbs);
1656
1664 if (neighbor_ancestor)
1665 {
1672 if (neighbor_ancestor->is_remote())
1673 continue;
1674
1675 neighbor_ancestor->active_family_tree_by_topological_neighbor(
1676 all_active_neighbors, elem, mesh, *_point_locator, _pbs, false);
1677
1678 topological_neighbor = true;
1679 }
1680 else
1681 {
1687 updateBBoxExtremesHelper(feature->_bboxes[0], *elem);
1688 }
1689 }
1690
1691 visitNeighborsHelper(elem,
1692 all_active_neighbors,
1693 feature,
1694 expand_halos_only,
1695 topological_neighbor,
1696 disjoint_only);
1697
1698 all_active_neighbors.clear();
1699 }
1700}
FeatureFloodCount::visitNeighborsHelper
void visitNeighborsHelper(const T *curr_entity, std::vector< const T * > neighbor_entities, FeatureData *feature, bool expand_halos_only, bool topological_neighbor, bool disjoint_only)
The actual logic for visiting neighbors is abstracted out here.
Definition FeatureFloodCount.C:1717

Referenced by expandEdgeHalos(), and flood().

◆ visitNeighborsHelper()

template<typename T >
void FeatureFloodCount::visitNeighborsHelper ( const T *  curr_entity,
std::vector< const T * >  neighbor_entities,
FeatureData *  feature,
bool  expand_halos_only,
bool  topological_neighbor,
bool  disjoint_only 
)
protected

The actual logic for visiting neighbors is abstracted out here.

This method is templated to handle the Nodal and Elemental cases together.

Only recurse where we own this entity and it's a topologically connected entity. We shouldn't even attempt to flood to the periodic boundary because we won't have solution information and if we are using DistributedMesh we probably won't have geometric information either.

When we only recurse on entities we own, we can never get more than one away from a local entity which should be in the ghosted zone.

Premark neighboring entities with a halo mark. These entities may or may not end up being part of the feature. We will not update the _entities_visited data structure here.

Definition at line 1717 of file FeatureFloodCount.C.

1723{
1724 // Loop over all active element neighbors
1725 for (const auto neighbor : neighbor_entities)
1726 {
1727 if (neighbor && (!_is_boundary_restricted || isBoundaryEntity(neighbor)))
1728 {
1729 if (expand_halos_only)
1730 {
1731 auto entity_id = neighbor->id();
1732
1733 if (topological_neighbor || disjoint_only)
1734 feature->_disjoint_halo_ids.insert(feature->_disjoint_halo_ids.end(), entity_id);
1735 else if (!FeatureFloodCount::contains(feature->_local_ids, entity_id))
1736 feature->_halo_ids.insert(feature->_halo_ids.end(), entity_id);
1737 }
1738 else
1739 {
1740 auto my_processor_id = processor_id();
1741
1742 if (!topological_neighbor && neighbor->processor_id() != my_processor_id)
1743 feature->_ghosted_ids.insert(feature->_ghosted_ids.end(), curr_entity->id());
1744
1754 if (curr_entity->processor_id() == my_processor_id ||
1755 neighbor->processor_id() == my_processor_id)
1756 {
1763 if (topological_neighbor || disjoint_only)
1764 feature->_disjoint_halo_ids.insert(feature->_disjoint_halo_ids.end(), neighbor->id());
1765 else
1766 _entity_queue.push_front(neighbor);
1767 }
1768 }
1769 }
1770 }
1771}
FeatureFloodCount::isBoundaryEntity
bool isBoundaryEntity(const T *entity) const
Returns a Boolean indicating whether the entity is on one of the desired boundaries.
Definition FeatureFloodCount.C:1860
FeatureFloodCount::contains
static bool contains(std::set< T > &container, const T &item)
Definition FeatureFloodCount.h:744

Referenced by visitElementalNeighbors(), and visitNodalNeighbors().

◆ visitNodalNeighbors()

void FeatureFloodCount::visitNodalNeighbors ( const Node *  node,
FeatureData *  feature,
bool  expand_halos_only 
)
protected

These two routines are utility routines used by the flood routine and by derived classes for visiting neighbors.

Since the logic is different for the elemental versus nodal case it's easier to split them up.

Definition at line 1703 of file FeatureFloodCount.C.

1706{
1707 mooseAssert(node, "Node is NULL");
1708
1709 std::vector<const Node *> all_active_neighbors;
1710 MeshTools::find_nodal_neighbors(_mesh.getMesh(), *node, _nodes_to_elem_map, all_active_neighbors);
1711
1712 visitNeighborsHelper(node, all_active_neighbors, feature, expand_halos_only, false, false);
1713}

Referenced by expandEdgeHalos(), and flood().

Member Data Documentation

◆ _all_boundary_entity_ids

std::unordered_set<dof_id_type> FeatureFloodCount::_all_boundary_entity_ids
protected

The set of entities on the boundary of the domain used for determining if features intersect any boundary.

Definition at line 695 of file FeatureFloodCount.h.

Referenced by meshChanged().

◆ _bnd_elem_range

ConstBndElemRange* FeatureFloodCount::_bnd_elem_range
protected

Boundary element range pointer.

Definition at line 713 of file FeatureFloodCount.h.

Referenced by execute(), and isBoundaryEntity().

◆ _compute_halo_maps

const bool FeatureFloodCount::_compute_halo_maps
protected

Indicates whether or not to communicate halo map information with all ranks.

Definition at line 588 of file FeatureFloodCount.h.

Referenced by GrainTracker::communicateHaloMap(), GrainTracker::meshChanged(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _compute_var_to_feature_map

const bool FeatureFloodCount::_compute_var_to_feature_map
protected

Indicates whether or not the var to feature map is populated.

Definition at line 591 of file FeatureFloodCount.h.

Referenced by getVarToFeatureVector(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _condense_map_info

const bool FeatureFloodCount::_condense_map_info
protected

Definition at line 577 of file FeatureFloodCount.h.

Referenced by updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _connecting_threshold

const Real FeatureFloodCount::_connecting_threshold
protected

The threshold above (or below) which neighboring entities are flooded (where regions can be extended but not started)

Definition at line 561 of file FeatureFloodCount.h.

Referenced by initialize().

◆ _dof_map

const DofMap& FeatureFloodCount::_dof_map
protected

Reference to the dof_map containing the coupled variables.

Definition at line 553 of file FeatureFloodCount.h.

Referenced by flood().

◆ _element_average_value

const PostprocessorValue& FeatureFloodCount::_element_average_value
protected

Average value of the domain which can optionally be used to find features in a field.

Definition at line 676 of file FeatureFloodCount.h.

Referenced by initialize().

◆ _empty_var_to_features

std::vector<unsigned int> FeatureFloodCount::_empty_var_to_features
protected

Definition at line 699 of file FeatureFloodCount.h.

Referenced by getVarToFeatureVector(), and initialSetup().

◆ _entities_visited

std::vector<std::set<dof_id_type> > FeatureFloodCount::_entities_visited
protected

This variable keeps track of which nodes have been visited during execution.

We don't use the _feature_map for this since we don't want to explicitly store data for all the unmarked nodes in a serialized datastructures. This keeps our overhead down since this variable never needs to be communicated.

Definition at line 615 of file FeatureFloodCount.h.

Referenced by PolycrystalUserObjectBase::execute(), flood(), initialize(), initialSetup(), and PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion().

◆ _entity_queue

std::deque<const DofObject *> FeatureFloodCount::_entity_queue
private

The data structure for maintaining entities to flood during discovery.

Definition at line 759 of file FeatureFloodCount.h.

Referenced by flood(), and visitNeighborsHelper().

◆ _entity_var_to_features

std::map<dof_id_type, std::vector<unsigned int> > FeatureFloodCount::_entity_var_to_features
protected

Definition at line 697 of file FeatureFloodCount.h.

Referenced by getVarToFeatureVector(), initialize(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _fe_vars

std::vector<MooseVariableFEBase *> FeatureFloodCount::_fe_vars
protected

The vector of coupled in variables.

Definition at line 548 of file FeatureFloodCount.h.

Referenced by GrainTracker::centroidRegionDistance(), FeatureFloodCount(), and getFECoupledVars().

◆ _feature_count

unsigned int FeatureFloodCount::_feature_count
protected

The number of features seen by this object (same as summing _feature_counts_per_map)

Definition at line 632 of file FeatureFloodCount.h.

Referenced by PolycrystalUserObjectBase::assignOpsToGrains(), PolycrystalUserObjectBase::buildGrainAdjacencyMatrix(), PolycrystalUserObjectBase::colorGraph(), communicateAndMerge(), consolidateMergedFeatures(), PolycrystalUserObjectBase::finalize(), flood(), getNumberActiveFeatures(), GrainTracker::getNumberActiveGrains(), getTotalFeatureCount(), getValue(), initialize(), PolycrystalUserObjectBase::isGraphValid(), GrainTracker::prepopulateState(), and sortAndLabel().

◆ _feature_counts_per_map

std::vector<unsigned int> FeatureFloodCount::_feature_counts_per_map
protected

The number of features seen by this object per map.

Definition at line 629 of file FeatureFloodCount.h.

Referenced by consolidateMergedFeatures(), PolycrystalUserObjectBase::prepareDataForTransfer(), sortAndLabel(), and GrainTracker::trackGrains().

◆ _feature_id_to_local_index

std::vector<std::size_t> FeatureFloodCount::_feature_id_to_local_index
protected

The vector recording the grain_id to local index (several indices will contain invalid_size_t)

Definition at line 668 of file FeatureFloodCount.h.

Referenced by GrainTracker::broadcastAndUpdateGrainData(), buildFeatureIdToLocalIndices(), doesFeatureIntersectBoundary(), GrainTracker::doesFeatureIntersectBoundary(), doesFeatureIntersectSpecifiedBoundary(), GrainTracker::doesFeatureIntersectSpecifiedBoundary(), featureCentroid(), getFeatureVar(), GrainTracker::getGrainCentroid(), isFeaturePercolated(), GrainTracker::isFeaturePercolated(), and GrainTracker::newGrainCreated().

◆ _feature_maps

std::vector<std::map<dof_id_type, int> > FeatureFloodCount::_feature_maps
protected

The feature maps contain the raw flooded node information and eventually the unique grain numbers.

We have a vector of them so we can create one per variable if that level of detail is desired.

Definition at line 662 of file FeatureFloodCount.h.

Referenced by getEntityValue(), initialize(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _feature_sets

std::vector<FeatureData>& FeatureFloodCount::_feature_sets
protected

The data structure used to hold the globally unique features.

The sorting of the vector is implementation defined and may not correspond to anything useful. The ID of each feature should be queried from the FeatureData objects.

Definition at line 646 of file FeatureFloodCount.h.

Referenced by GrainTracker::assignGrains(), PolycrystalUserObjectBase::assignOpsToGrains(), GrainTracker::attemptGrainRenumber(), GrainTracker::broadcastAndUpdateGrainData(), buildFeatureIdToLocalIndices(), PolycrystalUserObjectBase::buildGrainAdjacencyMatrix(), buildLocalToGlobalIndices(), GrainTracker::communicateHaloMap(), GrainTracker::computeMinDistancesFromGrain(), consolidateMergedFeatures(), doesFeatureIntersectBoundary(), GrainTracker::doesFeatureIntersectBoundary(), doesFeatureIntersectSpecifiedBoundary(), GrainTracker::doesFeatureIntersectSpecifiedBoundary(), featureCentroid(), PolycrystalUserObjectBase::finalize(), getEntityValue(), getFeatures(), getFeatureVar(), GrainTracker::getGrainCentroid(), initialize(), GrainTracker::initialize(), isFeaturePercolated(), GrainTracker::isFeaturePercolated(), GrainTracker::newGrainCreated(), GrainTracker::prepopulateState(), GrainTracker::remapGrains(), scatterAndUpdateRanks(), sortAndLabel(), GrainTracker::trackGrains(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _ghosted_entity_ids

std::map<dof_id_type, int> FeatureFloodCount::_ghosted_entity_ids
protected

The map for holding reconstructed ghosted element information.

Definition at line 679 of file FeatureFloodCount.h.

Referenced by getEntityValue(), initialize(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _global_numbering

const bool FeatureFloodCount::_global_numbering
protected

This variable is used to indicate whether or not we identify features with unique numbers on multiple maps.

Definition at line 581 of file FeatureFloodCount.h.

Referenced by updateFieldInfo().

◆ _halo_ids

std::vector<std::map<dof_id_type, int> > FeatureFloodCount::_halo_ids
protected

The data structure for looking up halos around features.

The outer vector is for splitting out the information per variable. The inner map holds the actual halo information

Definition at line 685 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount::FeatureData::clear(), GrainTracker::communicateHaloMap(), getEntityValue(), FeatureFloodCount::FeatureData::halosIntersect(), initialize(), FeatureFloodCount::FeatureData::merge(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _is_boundary_restricted

bool FeatureFloodCount::_is_boundary_restricted
protected

Indicates that this object should only run on one or more boundaries.

Definition at line 710 of file FeatureFloodCount.h.

Referenced by execute(), FeatureFloodCount(), and visitNeighborsHelper().

◆ _is_elemental

const bool FeatureFloodCount::_is_elemental
protected

Determines if the flood counter is elements or not (nodes)

Definition at line 707 of file FeatureFloodCount.h.

Referenced by appendPeriodicNeighborNodes(), GrainTracker::communicateHaloMap(), FauxGrainTracker::execute(), execute(), PolycrystalUserObjectBase::execute(), expandEdgeHalos(), FauxGrainTracker::finalize(), flood(), FauxGrainTracker::initialize(), isElemental(), isNewFeatureOrConnectedRegion(), PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), meshChanged(), prepareDataForTransfer(), GrainTracker::swapSolutionValues(), updateBoundaryIntersections(), and GrainTracker::updateFieldInfo().

◆ _is_primary

const bool FeatureFloodCount::_is_primary
protected

Convenience variable for testing primary rank.

Definition at line 716 of file FeatureFloodCount.h.

Referenced by GrainTracker::assignGrains(), PolycrystalUserObjectBase::assignOpsToGrains(), GrainTracker::broadcastAndUpdateGrainData(), PolycrystalUserObjectBase::buildGrainAdjacencyMatrix(), buildLocalToGlobalIndices(), communicateAndMerge(), GrainTracker::communicateHaloMap(), consolidateMergedFeatures(), finalize(), PolycrystalUserObjectBase::finalize(), GrainTracker::newGrainCreated(), GrainTracker::prepopulateState(), GrainTracker::remapGrains(), scatterAndUpdateRanks(), sortAndLabel(), and GrainTracker::trackGrains().

◆ _local_to_global_feature_map

std::vector<std::size_t> FeatureFloodCount::_local_to_global_feature_map
protected

The vector recording the local to global feature indices.

Definition at line 665 of file FeatureFloodCount.h.

Referenced by scatterAndUpdateRanks().

◆ _maps_size

const std::size_t FeatureFloodCount::_maps_size
protected

Convenience variable holding the size of all the datastructures size by the number of maps.

Definition at line 604 of file FeatureFloodCount.h.

Referenced by consolidateMergedFeatures(), FeatureFloodCount(), getEntityValue(), initialize(), mergeSets(), numberOfDistributedMergeHelpers(), PolycrystalUserObjectBase::restoreOriginalDataStructures(), sortAndLabel(), GrainTracker::trackGrains(), and GrainTracker::updateFieldInfo().

◆ _mesh

MooseMesh& FeatureFloodCount::_mesh
protected

A reference to the mesh.

Definition at line 565 of file FeatureFloodCount.h.

Referenced by appendPeriodicNeighborNodes(), PolycrystalVoronoi::buildSearchTree(), GrainTracker::centroidRegionDistance(), GrainTracker::communicateHaloMap(), PolycrystalCircles::computeDiffuseInterface(), FauxGrainTracker::execute(), execute(), expandEdgeHalos(), expandPointHalos(), FeatureFloodCount(), PolycrystalVoronoi::findCenterPoint(), PolycrystalVoronoi::findNormalVector(), FauxGrainTracker::getEntityValue(), getEntityValue(), PolycrystalCircles::getGrainsBasedOnPoint(), PolycrystalVoronoi::getGrainsBasedOnPoint(), FauxPolycrystalVoronoi::initialSetup(), PolycrystalUserObjectBase::initialSetup(), PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), meshChanged(), GrainTracker::meshChanged(), PolycrystalHex::precomputeGrainStructure(), PolycrystalVoronoi::precomputeGrainStructure(), prepareDataForTransfer(), GrainTracker::swapSolutionValues(), updateBoundaryIntersections(), GrainTracker::updateFieldInfo(), visitElementalNeighbors(), and visitNodalNeighbors().

◆ _n_procs

const processor_id_type FeatureFloodCount::_n_procs
protected

Convenience variable holding the number of processors in this simulation.

Definition at line 607 of file FeatureFloodCount.h.

Referenced by buildLocalToGlobalIndices(), and GrainTracker::communicateHaloMap().

◆ _n_vars

const std::size_t FeatureFloodCount::_n_vars
protected

Definition at line 601 of file FeatureFloodCount.h.

Referenced by getVarToFeatureVector(), initialSetup(), numCoupledVars(), GrainTracker::remapGrains(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _nodes_to_elem_map

std::unordered_map<dof_id_type, std::vector<const Elem *> > FeatureFloodCount::_nodes_to_elem_map
protected

The data structure used to find neighboring elements give a node ID.

Definition at line 626 of file FeatureFloodCount.h.

Referenced by meshChanged(), and visitNodalNeighbors().

◆ _partial_feature_sets

std::vector<std::list<FeatureData> > FeatureFloodCount::_partial_feature_sets
protected

The data structure used to hold partial and communicated feature data, during the discovery and merging phases.

The outer vector is indexed by map number (often variable number). The inner list is an unordered list of partially discovered features.

Definition at line 639 of file FeatureFloodCount.h.

Referenced by communicateAndMerge(), consolidateMergedFeatures(), deserialize(), expandEdgeHalos(), expandPointHalos(), flood(), initialize(), mergeSets(), PolycrystalUserObjectBase::mergeSets(), prepareDataForTransfer(), PolycrystalUserObjectBase::prepareDataForTransfer(), GrainTracker::prepopulateState(), scatterAndUpdateRanks(), and serialize().

◆ _pbs

libMesh::PeriodicBoundaries* FeatureFloodCount::_pbs
protected

A pointer to the periodic boundary constraints object.

Definition at line 671 of file FeatureFloodCount.h.

Referenced by initialSetup(), PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), meshChanged(), and visitElementalNeighbors().

◆ _periodic_node_map

std::multimap<dof_id_type, dof_id_type> FeatureFloodCount::_periodic_node_map
protected

The data structure which is a list of nodes that are constrained to other nodes based on the imposed periodic boundary conditions.

Definition at line 691 of file FeatureFloodCount.h.

Referenced by appendPeriodicNeighborNodes(), FauxGrainTracker::getEntityValue(), getEntityValue(), and meshChanged().

◆ _point_locator

std::unique_ptr<libMesh::PointLocatorBase> FeatureFloodCount::_point_locator
protected

Definition at line 673 of file FeatureFloodCount.h.

Referenced by PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), meshChanged(), and visitElementalNeighbors().

◆ _primary_perc_bnds

std::vector<BoundaryID> FeatureFloodCount::_primary_perc_bnds
protected

Definition at line 701 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount(), and updateBoundaryIntersections().

◆ _secondary_perc_bnds

std::vector<BoundaryID> FeatureFloodCount::_secondary_perc_bnds
protected

Definition at line 702 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount(), and updateBoundaryIntersections().

◆ _single_map_mode

const bool FeatureFloodCount::_single_map_mode
protected

This variable is used to indicate whether or not multiple maps are used during flooding.

Definition at line 575 of file FeatureFloodCount.h.

Referenced by flood(), PolycrystalUserObjectBase::PolycrystalUserObjectBase(), sortAndLabel(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _specified_bnds

std::vector<BoundaryID> FeatureFloodCount::_specified_bnds
protected

Definition at line 704 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount(), and updateBoundaryIntersections().

◆ _step_connecting_threshold

Real FeatureFloodCount::_step_connecting_threshold
protected

Definition at line 562 of file FeatureFloodCount.h.

Referenced by getConnectingThreshold(), and initialize().

◆ _step_threshold

Real FeatureFloodCount::_step_threshold
protected

Definition at line 557 of file FeatureFloodCount.h.

Referenced by getThreshold(), GrainTracker::getThreshold(), and initialize().

◆ _threshold

const Real FeatureFloodCount::_threshold
protected

The threshold above (or below) where an entity may begin a new region (feature)

Definition at line 556 of file FeatureFloodCount.h.

Referenced by FauxGrainTracker::execute(), and initialize().

◆ _use_less_than_threshold_comparison

const bool FeatureFloodCount::_use_less_than_threshold_comparison
protected

Use less-than when comparing values against the threshold value.

True by default. If false, then greater-than comparison is used instead.

Definition at line 598 of file FeatureFloodCount.h.

Referenced by compareValueWithThreshold(), and FauxGrainTracker::execute().

◆ _var_index_maps

std::vector<std::map<dof_id_type, int> > FeatureFloodCount::_var_index_maps
protected

This map keeps track of which variables own which nodes.

We need a vector of them for multimap mode where multiple variables can own a single mode.

Note: This map is only populated when "show_var_coloring" is set to true.

Definition at line 623 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount(), getEntityValue(), initialize(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _var_index_mode

const bool FeatureFloodCount::_var_index_mode
protected

This variable is used to indicate whether the maps will contain unique region information or just the variable numbers owning those regions.

Definition at line 585 of file FeatureFloodCount.h.

Referenced by FeatureFloodCount(), getEntityValue(), initialize(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ _var_number

unsigned long FeatureFloodCount::_var_number
protected

This variable is used to build the periodic node map.

Assumption: We are going to assume that either all variables are periodic or none are. This assumption can be relaxed at a later time if necessary.

Definition at line 572 of file FeatureFloodCount.h.

Referenced by meshChanged().

◆ _vars

std::vector<MooseVariable *> FeatureFloodCount::_vars
protected

The vector of coupled in variables cast to MooseVariable.

Definition at line 550 of file FeatureFloodCount.h.

Referenced by PolycrystalUserObjectBase::assignOpsToGrains(), GrainTracker::attemptGrainRenumber(), PolycrystalVoronoi::buildSearchTree(), PolycrystalCircles::computeDiffuseInterface(), FauxGrainTracker::execute(), execute(), FeatureFloodCount(), FauxGrainTracker::finalize(), PolycrystalVoronoi::findCenterPoint(), PolycrystalVoronoi::findNormalVector(), getCoupledVars(), FauxGrainTracker::getEntityValue(), PolycrystalCircles::getGrainsBasedOnPoint(), PolycrystalVoronoi::getGrainsBasedOnPoint(), initialSetup(), FauxPolycrystalVoronoi::initialSetup(), PolycrystalUserObjectBase::initialSetup(), isNewFeatureOrConnectedRegion(), PolycrystalHex::precomputeGrainStructure(), GrainTracker::swapSolutionValuesHelper(), and GrainTracker::updateFieldInfo().

◆ _volatile_feature_sets

std::vector<FeatureData> FeatureFloodCount::_volatile_feature_sets
protected

Derived objects (e.g.

the GrainTracker) may require restartable data to track information across time steps. The FeatureFloodCounter however does not. This container is here so that we have the flexabilty to switch between volatile and non-volatile storage. The _feature_sets data structure can conditionally refer to this structure or a MOOSE-provided structure, which is backed up.

Definition at line 655 of file FeatureFloodCount.h.

◆ invalid_id

const unsigned int FeatureFloodCount::invalid_id = std::numeric_limits<unsigned int>::max()
static

Definition at line 92 of file FeatureFloodCount.h.

Referenced by FeatureVolumeVectorPostprocessor::accumulateBoundaryFaces(), FeatureVolumeVectorPostprocessor::accumulateVolumes(), AverageGrainVolume::accumulateVolumes(), GrainTracker::assignGrains(), MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), SingleGrainRigidBodyMotion::calculateAdvectionVelocity(), ComputePolycrystalElasticityTensor::computeQpElasticityTensor(), DeformedGrainMaterial::computeQpProperties(), ComputeGBMisorientationType::computeQpProperties(), deserialize(), FauxGrainTracker::execute(), FeatureVolumeVectorPostprocessor::execute(), FauxGrainTracker::FauxGrainTracker(), featureCentroid(), flood(), getFeatureVar(), GrainTracker::getNextUniqueID(), GrainTracker::getTotalFeatureCount(), MultiGrainRigidBodyMotion::getUserObjectJacobian(), SingleGrainRigidBodyMotion::getUserObjectJacobian(), PolycrystalCircles::getVariableValue(), PolycrystalVoronoi::getVariableValue(), initialSetup(), PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), FeatureFloodCount::FeatureData::operator<(), serialize(), sortAndLabel(), GrainTracker::trackGrains(), updateFieldInfo(), and GrainTracker::updateFieldInfo().

◆ invalid_proc_id

const processor_id_type FeatureFloodCount::invalid_proc_id
static
Initial value:
=
std::numeric_limits<processor_id_type>::max()

Definition at line 93 of file FeatureFloodCount.h.

Referenced by PolycrystalUserObjectBase::numberOfDistributedMergeHelpers().

◆ invalid_size_t

const std::size_t FeatureFloodCount::invalid_size_t = std::numeric_limits<std::size_t>::max()
static

Constants used for invalid indices set to the max value of std::size_t type

Definition at line 91 of file FeatureFloodCount.h.

Referenced by GrainTracker::broadcastAndUpdateGrainData(), buildFeatureIdToLocalIndices(), buildLocalToGlobalIndices(), doesFeatureIntersectBoundary(), GrainTracker::doesFeatureIntersectBoundary(), doesFeatureIntersectSpecifiedBoundary(), GrainTracker::doesFeatureIntersectSpecifiedBoundary(), PolycrystalUserObjectBase::execute(), featureCentroid(), flood(), FauxGrainTracker::getEntityValue(), getEntityValue(), getFeatureVar(), GrainTracker::getGrainCentroid(), isFeaturePercolated(), GrainTracker::isFeaturePercolated(), PolycrystalUserObjectBase::isNewFeatureOrConnectedRegion(), GrainTracker::newGrainCreated(), PolycrystalUserObjectBase::prepareDataForTransfer(), scatterAndUpdateRanks(), and GrainTracker::trackGrains().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:43 for https://mooseframework.inl.gov by doxygen 1.9.8