https://mooseframework.inl.gov
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 Member Functions | Private Attributes | List of all members
FeatureVolumeVectorPostprocessor Class Reference

This VectorPostprocessor is intended to be used to calculate accurate volumes from the FeatureFloodCount and/or GrainTracker objects. More...

#include <FeatureVolumeVectorPostprocessor.h>

Inheritance diagram for FeatureVolumeVectorPostprocessor:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 
enum  TEST_TYPE
 

Public Member Functions

 FeatureVolumeVectorPostprocessor (const InputParameters &parameters)
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
Real getFeatureVolume (unsigned int feature_id) const
 Returns the volume for the given grain number. More...
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () 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)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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 initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (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)
 
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
 
std::string PPName () const
 
bool containsCompleteHistory () const
 
bool isDistributed () const
 
const std::set< std::string > & getVectorNames () const
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
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 hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
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
 
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 meshChanged ()
 
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::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, 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 sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static bool restricted (const std::set< BoundaryID > &ids)
 

Public Attributes

const ConsoleStream _console
 
 ALL
 
 ANY
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
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)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
VectorPostprocessorValue & declareVector (const std::string &vector_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)
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 

Static Protected Member Functions

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

Protected Attributes

const bool _single_feature_per_elem
 A Boolean indicating how the volume is calculated. More...
 
const bool _output_centroids
 
const FeatureFloodCount & _feature_counter
 A reference to the feature flood count object. More...
 
VectorPostprocessorValue & _var_num
 
VectorPostprocessorValue & _feature_volumes
 
VectorPostprocessorValue & _intersects_bounds
 
VectorPostprocessorValue & _intersects_specified_bounds
 
VectorPostprocessorValue & _percolated
 
bool _is_boundary_restricted
 Indicates whether the calculation should be run on volumes or area of a boundary. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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 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 _vpp_name
 
FEProblemBase & _vpp_fe_problem
 
const MooseEnum & _parallel_type
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

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

Private Member Functions

void accumulateVolumes (const Elem *elem, const std::vector< unsigned int > &var_to_features, std::size_t num_features)
 Add volume contributions to one or entries in the feature volume vector. More...
 
void accumulateBoundaryFaces (const Elem *elem, const std::vector< unsigned int > &var_to_features, std::size_t num_features, unsigned int side)
 When boundary is supplied as input, compute coverage of that boundary by each feature. More...
 
Real computeIntegral (std::size_t var_index) const
 Calculate the integral value of the passed in variable (index) More...
 
Real computeFaceIntegral (std::size_t var_index) const
 Calculate the integral on the face if boundary is supplied as input. More...
 

Private Attributes

const std::vector< MooseVariableFEBase * > & _vars
 
std::vector< const VariableValue * > _coupled_sln
 
MooseMesh & _mesh
 
Assembly & _assembly
 
const MooseArray< Point > & _q_point
 
const QBase *const & _qrule
 
const MooseArray< Real > & _JxW
 
const MooseArray< Real > & _coord
 
const QBase *const & _qrule_face
 
const MooseArray< Real > & _JxW_face
 
std::array< VectorPostprocessorValue *, 3 > _centroid
 

Detailed Description

This VectorPostprocessor is intended to be used to calculate accurate volumes from the FeatureFloodCount and/or GrainTracker objects.

It is a GeneralVectorPostProcessor instead of the more natural elemental kind so that dependency resolution will work properly when an AuxVariable is not depending on the FeatureFloodCount object. It obtains the coupled variables from the FeatureFloodCount object so that there's one less thing for the user of this class to worry about.

Definition at line 31 of file FeatureVolumeVectorPostprocessor.h.

Constructor & Destructor Documentation

◆ FeatureVolumeVectorPostprocessor()

FeatureVolumeVectorPostprocessor::FeatureVolumeVectorPostprocessor ( const InputParameters &  parameters)

Definition at line 47 of file FeatureVolumeVectorPostprocessor.C.

49  : GeneralVectorPostprocessor(parameters),
50  MooseVariableDependencyInterface(this),
51  BoundaryRestrictable(this, false),
52  _single_feature_per_elem(getParam<bool>("single_feature_per_element")),
53  _output_centroids(getParam<bool>("output_centroids")),
54  _feature_counter(getUserObject<FeatureFloodCount>("flood_counter")),
55  _var_num(declareVector("var_num")),
56  _feature_volumes(declareVector("feature_volumes")),
57  _intersects_bounds(declareVector("intersects_bounds")),
58  _intersects_specified_bounds(declareVector("intersects_specified_bounds")),
59  _percolated(declareVector("percolated")),
60  _vars(_feature_counter.getFECoupledVars()),
61  _mesh(_subproblem.mesh()),
62  _assembly(_subproblem.assembly(_tid, _sys.number())),
63  _q_point(_assembly.qPoints()),
64  _qrule(_assembly.qRule()),
65  _JxW(_assembly.JxW()),
66  _coord(_assembly.coordTransformation()),
67  _qrule_face(_assembly.qRuleFace()),
68  _JxW_face(_assembly.JxWFace())
69 {
70  addMooseVariableDependency(_vars);
71 
72  _is_boundary_restricted = boundaryRestricted();
73 
74  _coupled_sln.reserve(_vars.size());
75  for (auto & var : _feature_counter.getCoupledVars())
76  _coupled_sln.push_back(&var->sln());
77 
78  const std::array<std::string, 3> suffix = {{"x", "y", "z"}};
79  if (_output_centroids)
80  for (unsigned int i = 0; i < 3; ++i)
81  _centroid[i] = &declareVector("centroid_" + suffix[i]);
82 }
SubProblem::mesh
virtual MooseMesh & mesh()=0
FeatureVolumeVectorPostprocessor::_centroid
std::array< VectorPostprocessorValue *, 3 > _centroid
Definition: FeatureVolumeVectorPostprocessor.h:96
BoundaryRestrictable::boundaryRestricted
virtual bool boundaryRestricted() const
Assembly::qRuleFace
const libMesh::QBase *const & qRuleFace() const
FeatureVolumeVectorPostprocessor::_vars
const std::vector< MooseVariableFEBase * > & _vars
Definition: FeatureVolumeVectorPostprocessor.h:84
GeneralVectorPostprocessor::GeneralVectorPostprocessor
GeneralVectorPostprocessor(const InputParameters &parameters)
FeatureFloodCount::getCoupledVars
const std::vector< MooseVariable * > & getCoupledVars() const
Returns a const vector to the coupled variable pointers.
Definition: FeatureFloodCount.h:97
MooseVariableDependencyInterface::MooseVariableDependencyInterface
MooseVariableDependencyInterface(const MooseObject *)
Assembly::qPoints
const MooseArray< Point > & qPoints() const
FeatureVolumeVectorPostprocessor::_is_boundary_restricted
bool _is_boundary_restricted
Indicates whether the calculation should be run on volumes or area of a boundary. ...
Definition: FeatureVolumeVectorPostprocessor.h:64
FeatureVolumeVectorPostprocessor::_intersects_specified_bounds
VectorPostprocessorValue & _intersects_specified_bounds
Definition: FeatureVolumeVectorPostprocessor.h:60
Assembly::coordTransformation
const MooseArray< Real > & coordTransformation() const
FeatureVolumeVectorPostprocessor::_feature_counter
const FeatureFloodCount & _feature_counter
A reference to the feature flood count object.
Definition: FeatureVolumeVectorPostprocessor.h:55
FeatureVolumeVectorPostprocessor::_coupled_sln
std::vector< const VariableValue * > _coupled_sln
Definition: FeatureVolumeVectorPostprocessor.h:85
SystemBase::number
unsigned int number() const
GeneralVectorPostprocessor::declareVector
VectorPostprocessorValue & declareVector(const std::string &vector_name)
Assembly::JxW
const MooseArray< Real > & JxW() const
Assembly::JxWFace
const MooseArray< Real > & JxWFace() const
MooseVariableDependencyInterface::addMooseVariableDependency
void addMooseVariableDependency(MooseVariableFieldBase *var)
SubProblem::assembly
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num)=0
Assembly::qRule
const libMesh::QBase *const & qRule() const
GeneralVectorPostprocessor::parameters
const InputParameters & parameters() const
BoundaryRestrictable::BoundaryRestrictable
BoundaryRestrictable(const MooseObject *moose_object, bool nodal)
FeatureVolumeVectorPostprocessor::_single_feature_per_elem
const bool _single_feature_per_elem
A Boolean indicating how the volume is calculated.
Definition: FeatureVolumeVectorPostprocessor.h:51
FeatureFloodCount::getFECoupledVars
const std::vector< MooseVariableFEBase * > & getFECoupledVars() const
Returns a const vector to the coupled MooseVariableFEBase pointers.
Definition: FeatureFloodCount.h:100

Member Function Documentation

◆ accumulateBoundaryFaces()

void FeatureVolumeVectorPostprocessor::accumulateBoundaryFaces ( const Elem *  elem,
const std::vector< unsigned int > &  var_to_features,
std::size_t  num_features,
unsigned int  side 
)
private

When boundary is supplied as input, compute coverage of that boundary by each feature.

Definition at line 241 of file FeatureVolumeVectorPostprocessor.C.

Referenced by execute().

246 {
247  unsigned int dominant_feature_id = FeatureFloodCount::invalid_id;
248  Real max_var_value = std::numeric_limits<Real>::lowest();
249 
250  for (MooseIndex(var_to_features) var_index = 0; var_index < var_to_features.size(); ++var_index)
251  {
252  // Only sample "active" variables
253  if (var_to_features[var_index] != FeatureFloodCount::invalid_id)
254  {
255  auto feature_id = var_to_features[var_index];
256  mooseAssert(feature_id < num_features, "Feature ID out of range");
257  auto integral_value = computeFaceIntegral(var_index);
258 
259  if (_single_feature_per_elem)
260  {
261  if (integral_value > max_var_value)
262  {
263  // Update the current dominant feature and associated value
264  max_var_value = integral_value;
265  dominant_feature_id = feature_id;
266  }
267  }
268  // Solution based boundary area/length calculation (integral value)
269  else
270  _feature_volumes[feature_id] += integral_value;
271  }
272  }
273 
274  // Accumulate the boundary area/length into the dominant feature. Do not use the integral value
275  if (_single_feature_per_elem && dominant_feature_id != FeatureFloodCount::invalid_id)
276  {
277  std::unique_ptr<const Elem> side_elem = elem->build_side_ptr(side);
278  _feature_volumes[dominant_feature_id] += _assembly.elementVolume(side_elem.get());
279  }
280 }
Assembly::elementVolume
Real elementVolume(const Elem *elem) const
FeatureFloodCount::invalid_id
static const unsigned int invalid_id
Definition: FeatureFloodCount.h:92
FeatureVolumeVectorPostprocessor::computeFaceIntegral
Real computeFaceIntegral(std::size_t var_index) const
Calculate the integral on the face if boundary is supplied as input.
Definition: FeatureVolumeVectorPostprocessor.C:283
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FeatureVolumeVectorPostprocessor::_single_feature_per_elem
const bool _single_feature_per_elem
A Boolean indicating how the volume is calculated.
Definition: FeatureVolumeVectorPostprocessor.h:51

◆ accumulateVolumes()

void FeatureVolumeVectorPostprocessor::accumulateVolumes ( const Elem *  elem,
const std::vector< unsigned int > &  var_to_features,
std::size_t  num_features 
)
private

Add volume contributions to one or entries in the feature volume vector.

Definition at line 191 of file FeatureVolumeVectorPostprocessor.C.

Referenced by execute().

195 {
196  unsigned int dominant_feature_id = FeatureFloodCount::invalid_id;
197  Real max_var_value = std::numeric_limits<Real>::lowest();
198 
199  for (MooseIndex(var_to_features) var_index = 0; var_index < var_to_features.size(); ++var_index)
200  {
201  // Only sample "active" variables
202  if (var_to_features[var_index] != FeatureFloodCount::invalid_id)
203  {
204  auto feature_id = var_to_features[var_index];
205  mooseAssert(feature_id < num_features, "Feature ID out of range");
206  auto integral_value = computeIntegral(var_index);
207 
208  // Compute volumes in a simplistic but domain conservative fashion
209  if (_single_feature_per_elem)
210  {
211  if (integral_value > max_var_value)
212  {
213  // Update the current dominant feature and associated value
214  max_var_value = integral_value;
215  dominant_feature_id = feature_id;
216  }
217  }
218  // Solution based volume calculation (integral value)
219  else
220  _feature_volumes[feature_id] += integral_value;
221  }
222  }
223 
224  // Accumulate the entire element volume into the dominant feature. Do not use the integral value
225  if (_single_feature_per_elem && dominant_feature_id != FeatureFloodCount::invalid_id)
226  _feature_volumes[dominant_feature_id] += _assembly.elementVolume(elem);
227 }
Assembly::elementVolume
Real elementVolume(const Elem *elem) const
FeatureFloodCount::invalid_id
static const unsigned int invalid_id
Definition: FeatureFloodCount.h:92
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FeatureVolumeVectorPostprocessor::_single_feature_per_elem
const bool _single_feature_per_elem
A Boolean indicating how the volume is calculated.
Definition: FeatureVolumeVectorPostprocessor.h:51
FeatureVolumeVectorPostprocessor::computeIntegral
Real computeIntegral(std::size_t var_index) const
Calculate the integral value of the passed in variable (index)
Definition: FeatureVolumeVectorPostprocessor.C:230

◆ computeFaceIntegral()

Real FeatureVolumeVectorPostprocessor::computeFaceIntegral ( std::size_t  var_index) const
private

Calculate the integral on the face if boundary is supplied as input.

Definition at line 283 of file FeatureVolumeVectorPostprocessor.C.

Referenced by accumulateBoundaryFaces().

284 {
285  Real sum = 0;
286  for (unsigned int qp = 0; qp < _qrule_face->n_points(); ++qp)
287  sum += _JxW_face[qp] * _coord[qp] * (*_coupled_sln[var_index])[qp];
288 
289  return sum;
290 }
FeatureVolumeVectorPostprocessor::_coupled_sln
std::vector< const VariableValue * > _coupled_sln
Definition: FeatureVolumeVectorPostprocessor.h:85
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ computeIntegral()

Real FeatureVolumeVectorPostprocessor::computeIntegral ( std::size_t  var_index) const
private

Calculate the integral value of the passed in variable (index)

Definition at line 230 of file FeatureVolumeVectorPostprocessor.C.

Referenced by accumulateVolumes().

231 {
232  Real sum = 0;
233 
234  for (unsigned int qp = 0; qp < _qrule->n_points(); ++qp)
235  sum += _JxW[qp] * _coord[qp] * (*_coupled_sln[var_index])[qp];
236 
237  return sum;
238 }
FeatureVolumeVectorPostprocessor::_coupled_sln
std::vector< const VariableValue * > _coupled_sln
Definition: FeatureVolumeVectorPostprocessor.h:85
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ execute()

void FeatureVolumeVectorPostprocessor::execute ( )
overridevirtual

Here we retrieve the var to features vector on the current element. We'll use that information to figure out which variables are non-zero (from a threshold perspective) then we can sum those values into appropriate grain index locations.

Implements GeneralVectorPostprocessor.

Definition at line 90 of file FeatureVolumeVectorPostprocessor.C.

91 {
92  const auto num_features = _feature_counter.getTotalFeatureCount();
93 
94  // Reset the variable index and intersect bounds vectors
95  _var_num.assign(num_features, -1); // Invalid
96  _intersects_bounds.assign(num_features, -1); // Invalid
97  _intersects_specified_bounds.assign(num_features, -1); // Invalid
98  _percolated.assign(num_features, -1); // Invalid
99  for (MooseIndex(num_features) feature_num = 0; feature_num < num_features; ++feature_num)
100  {
101  auto var_num = _feature_counter.getFeatureVar(feature_num);
102  if (var_num != FeatureFloodCount::invalid_id)
103  _var_num[feature_num] = var_num;
104 
105  _intersects_bounds[feature_num] =
106  static_cast<unsigned int>(_feature_counter.doesFeatureIntersectBoundary(feature_num));
107 
108  _intersects_specified_bounds[feature_num] = static_cast<unsigned int>(
109  _feature_counter.doesFeatureIntersectSpecifiedBoundary(feature_num));
110 
111  _percolated[feature_num] =
112  static_cast<unsigned int>(_feature_counter.isFeaturePercolated(feature_num));
113  }
114 
115  if (_output_centroids)
116  {
117  for (std::size_t i = 0; i < 3; ++i)
118  _centroid[i]->resize(num_features);
119  for (std::size_t feature_num = 0; feature_num < num_features; ++feature_num)
120  {
121  auto p = _feature_counter.featureCentroid(feature_num);
122  for (std::size_t i = 0; i < 3; ++i)
123  (*_centroid[i])[feature_num] = p(i);
124  }
125  }
126 
127  // Reset the volume vector
128  _feature_volumes.assign(num_features, 0);
129 
130  // Calculate coverage of a boundary if one has been supplied in the input file
131  if (_is_boundary_restricted)
132  {
133  const std::set<BoundaryID> supplied_bnd_ids = BoundaryRestrictable::boundaryIDs();
134  for (auto elem_it = _mesh.bndElemsBegin(), elem_end = _mesh.bndElemsEnd(); elem_it != elem_end;
135  ++elem_it)
136 
137  // loop over only boundaries supplied by user in boundary param
138  for (auto & supplied_bnd_id : supplied_bnd_ids)
139  if (((*elem_it)->_bnd_id) == supplied_bnd_id)
140  {
141  const auto & elem = (*elem_it)->_elem;
142  auto rank = processor_id();
143 
144  if (elem->processor_id() == rank)
145  {
146  _fe_problem.setCurrentSubdomainID(elem, 0);
147  _fe_problem.prepare(elem, 0);
148  _fe_problem.reinitElem(elem, 0);
149  _fe_problem.reinitElemFace(elem, (*elem_it)->_side, 0);
150 
151  const auto & var_to_features = _feature_counter.getVarToFeatureVector(elem->id());
152 
153  accumulateBoundaryFaces(elem, var_to_features, num_features, (*elem_it)->_side);
154  }
155  }
156  }
157  else // If no boundary is supplied, calculate volumes of features as normal
158  for (const auto & elem : _mesh.getMesh().active_local_element_ptr_range())
159  {
160  _fe_problem.setCurrentSubdomainID(elem, 0);
161  _fe_problem.prepare(elem, 0);
162  _fe_problem.reinitElem(elem, 0);
163 
170  const auto & var_to_features = _feature_counter.getVarToFeatureVector(elem->id());
171 
172  accumulateVolumes(elem, var_to_features, num_features);
173  }
174 }
MooseMesh::bndElemsEnd
virtual bnd_elem_iterator bndElemsEnd()
FeatureVolumeVectorPostprocessor::accumulateVolumes
void accumulateVolumes(const Elem *elem, const std::vector< unsigned int > &var_to_features, std::size_t num_features)
Add volume contributions to one or entries in the feature volume vector.
Definition: FeatureVolumeVectorPostprocessor.C:191
FeatureVolumeVectorPostprocessor::_centroid
std::array< VectorPostprocessorValue *, 3 > _centroid
Definition: FeatureVolumeVectorPostprocessor.h:96
FEProblemBase::prepare
virtual void prepare(const Elem *elem, const THREAD_ID tid) override
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
MooseMesh::bndElemsBegin
virtual bnd_elem_iterator bndElemsBegin()
FeatureFloodCount::getTotalFeatureCount
virtual std::size_t getTotalFeatureCount() const
Returns the total feature count (active and inactive ids, useful for sizing vectors) ...
Definition: FeatureFloodCount.C:813
FeatureVolumeVectorPostprocessor::accumulateBoundaryFaces
void accumulateBoundaryFaces(const Elem *elem, const std::vector< unsigned int > &var_to_features, std::size_t num_features, unsigned int side)
When boundary is supplied as input, compute coverage of that boundary by each feature.
Definition: FeatureVolumeVectorPostprocessor.C:241
FeatureFloodCount::isFeaturePercolated
virtual bool isFeaturePercolated(unsigned int feature_id) const
Returns a Boolean indicating whether this feature is percolated (e.g.
Definition: FeatureFloodCount.C:885
FeatureFloodCount::getFeatureVar
virtual unsigned int getFeatureVar(unsigned int feature_id) const
Returns the variable representing the passed in feature.
Definition: FeatureFloodCount.C:824
FeatureVolumeVectorPostprocessor::_is_boundary_restricted
bool _is_boundary_restricted
Indicates whether the calculation should be run on volumes or area of a boundary. ...
Definition: FeatureVolumeVectorPostprocessor.h:64
MooseMesh::getMesh
MeshBase & getMesh()
FEProblemBase::reinitElem
virtual void reinitElem(const Elem *elem, const THREAD_ID tid) override
FeatureVolumeVectorPostprocessor::_intersects_specified_bounds
VectorPostprocessorValue & _intersects_specified_bounds
Definition: FeatureVolumeVectorPostprocessor.h:60
FeatureVolumeVectorPostprocessor::_feature_counter
const FeatureFloodCount & _feature_counter
A reference to the feature flood count object.
Definition: FeatureVolumeVectorPostprocessor.h:55
FeatureFloodCount::invalid_id
static const unsigned int invalid_id
Definition: FeatureFloodCount.h:92
FEProblemBase::setCurrentSubdomainID
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override
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
GeneralVectorPostprocessor::_fe_problem
FEProblemBase & _fe_problem
FEProblemBase::reinitElemFace
void reinitElemFace(const Elem *elem, unsigned int side, BoundaryID, const THREAD_ID tid)
libMesh::ParallelObject::processor_id
processor_id_type processor_id() const
BoundaryRestrictable::boundaryIDs
virtual const std::set< BoundaryID > & boundaryIDs() const
FeatureFloodCount::doesFeatureIntersectBoundary
virtual bool doesFeatureIntersectBoundary(unsigned int feature_id) const
Returns a Boolean indicating whether this feature intersects any boundary.
Definition: FeatureFloodCount.C:843
FeatureFloodCount::featureCentroid
virtual Point featureCentroid(unsigned int feature_id) const
Returns the centroid of the designated feature (only supported without periodic boundaries) ...
Definition: FeatureFloodCount.C:909

◆ finalize()

void FeatureVolumeVectorPostprocessor::finalize ( )
overridevirtual

Reimplemented from GeneralVectorPostprocessor.

Definition at line 177 of file FeatureVolumeVectorPostprocessor.C.

178 {
179  // Do the parallel sum
180  _communicator.sum(_feature_volumes);
181 }
libMesh::ParallelObject::_communicator
const Parallel::Communicator & _communicator

◆ getFeatureVolume()

Real FeatureVolumeVectorPostprocessor::getFeatureVolume ( unsigned int  feature_id) const

Returns the volume for the given grain number.

Definition at line 184 of file FeatureVolumeVectorPostprocessor.C.

185 {
186  mooseAssert(feature_id < _feature_volumes.size(), "feature_id is out of range");
187  return _feature_volumes[feature_id];
188 }

◆ initialize()

void FeatureVolumeVectorPostprocessor::initialize ( )
overridevirtual

Implements GeneralVectorPostprocessor.

Definition at line 85 of file FeatureVolumeVectorPostprocessor.C.

86 {
87 }

◆ validParams()

InputParameters FeatureVolumeVectorPostprocessor::validParams ( )
static

Definition at line 25 of file FeatureVolumeVectorPostprocessor.C.

26 {
27  InputParameters params = GeneralVectorPostprocessor::validParams();
28  params += BoundaryRestrictable::validParams();
29 
30  params.addRequiredParam<UserObjectName>("flood_counter",
31  "The FeatureFloodCount UserObject to get values from.");
32  params.addParam<bool>("single_feature_per_element",
33  false,
34  "Set this Boolean if you wish to use an element based volume where"
35  " the dominant order parameter determines the feature that accumulates the "
36  "entire element volume");
37  params.addParam<bool>("output_centroids", false, "Set to true to output the feature centroids");
38  params.addClassDescription("This object is designed to pull information from the data structures "
39  "of a \"FeatureFloodCount\" or derived object (e.g. individual "
40  "feature volumes)");
41 
42  params.suppressParameter<bool>("contains_complete_history");
43 
44  return params;
45 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::suppressParameter
void suppressParameter(const std::string &name)
GeneralVectorPostprocessor::validParams
static InputParameters validParams()
BoundaryRestrictable::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _assembly

Assembly& FeatureVolumeVectorPostprocessor::_assembly
private

Definition at line 88 of file FeatureVolumeVectorPostprocessor.h.

Referenced by accumulateBoundaryFaces(), and accumulateVolumes().

◆ _centroid

std::array<VectorPostprocessorValue *, 3> FeatureVolumeVectorPostprocessor::_centroid
private

Definition at line 96 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute(), and FeatureVolumeVectorPostprocessor().

◆ _coord

const MooseArray<Real>& FeatureVolumeVectorPostprocessor::_coord
private

Definition at line 92 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeFaceIntegral(), and computeIntegral().

◆ _coupled_sln

std::vector<const VariableValue *> FeatureVolumeVectorPostprocessor::_coupled_sln
private

Definition at line 85 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeFaceIntegral(), computeIntegral(), and FeatureVolumeVectorPostprocessor().

◆ _feature_counter

const FeatureFloodCount& FeatureVolumeVectorPostprocessor::_feature_counter
protected

A reference to the feature flood count object.

Definition at line 55 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute(), and FeatureVolumeVectorPostprocessor().

◆ _feature_volumes

VectorPostprocessorValue& FeatureVolumeVectorPostprocessor::_feature_volumes
protected

Definition at line 58 of file FeatureVolumeVectorPostprocessor.h.

Referenced by accumulateBoundaryFaces(), accumulateVolumes(), execute(), finalize(), and getFeatureVolume().

◆ _intersects_bounds

VectorPostprocessorValue& FeatureVolumeVectorPostprocessor::_intersects_bounds
protected

Definition at line 59 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute().

◆ _intersects_specified_bounds

VectorPostprocessorValue& FeatureVolumeVectorPostprocessor::_intersects_specified_bounds
protected

Definition at line 60 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute().

◆ _is_boundary_restricted

bool FeatureVolumeVectorPostprocessor::_is_boundary_restricted
protected

Indicates whether the calculation should be run on volumes or area of a boundary.

Definition at line 64 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute(), and FeatureVolumeVectorPostprocessor().

◆ _JxW

const MooseArray<Real>& FeatureVolumeVectorPostprocessor::_JxW
private

Definition at line 91 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeIntegral().

◆ _JxW_face

const MooseArray<Real>& FeatureVolumeVectorPostprocessor::_JxW_face
private

Definition at line 94 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeFaceIntegral().

◆ _mesh

MooseMesh& FeatureVolumeVectorPostprocessor::_mesh
private

Definition at line 87 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute().

◆ _output_centroids

const bool FeatureVolumeVectorPostprocessor::_output_centroids
protected

Definition at line 52 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute(), and FeatureVolumeVectorPostprocessor().

◆ _percolated

VectorPostprocessorValue& FeatureVolumeVectorPostprocessor::_percolated
protected

Definition at line 61 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute().

◆ _q_point

const MooseArray<Point>& FeatureVolumeVectorPostprocessor::_q_point
private

Definition at line 89 of file FeatureVolumeVectorPostprocessor.h.

◆ _qrule

const QBase* const& FeatureVolumeVectorPostprocessor::_qrule
private

Definition at line 90 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeIntegral().

◆ _qrule_face

const QBase* const& FeatureVolumeVectorPostprocessor::_qrule_face
private

Definition at line 93 of file FeatureVolumeVectorPostprocessor.h.

Referenced by computeFaceIntegral().

◆ _single_feature_per_elem

const bool FeatureVolumeVectorPostprocessor::_single_feature_per_elem
protected

A Boolean indicating how the volume is calculated.

Definition at line 51 of file FeatureVolumeVectorPostprocessor.h.

Referenced by accumulateBoundaryFaces(), and accumulateVolumes().

◆ _var_num

VectorPostprocessorValue& FeatureVolumeVectorPostprocessor::_var_num
protected

Definition at line 57 of file FeatureVolumeVectorPostprocessor.h.

Referenced by execute().

◆ _vars

const std::vector<MooseVariableFEBase *>& FeatureVolumeVectorPostprocessor::_vars
private

Definition at line 84 of file FeatureVolumeVectorPostprocessor.h.

Referenced by FeatureVolumeVectorPostprocessor().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:46:42 for https://mooseframework.inl.gov by   doxygen 1.8.14