www.mooseframework.org
Public Member Functions | List of all members
GrainTrackerInterface Class Referenceabstract

This class defines the interface for the GrainTracking objects. More...

#include <GrainTrackerInterface.h>

Inheritance diagram for GrainTrackerInterface:
[legend]

Public Member Functions

virtual Real getEntityValue (dof_id_type entity_id, FeatureFloodCount::FieldType, std::size_t var_index=0) const =0
 Accessor for retrieving either nodal or elemental information (unique grains or variable indicies) More...
 
virtual const std::vector< unsigned int > & getVarToFeatureVector (dof_id_type elem_id) const =0
 Returns a list of active unique feature ids for a particular element. More...
 
virtual unsigned int getFeatureVar (unsigned int feature_id) const =0
 Return the variable index (typically order parameter) for the given feature. More...
 
virtual std::size_t getNumberActiveGrains () const =0
 Returns the number of active grains current stored in the GrainTracker. More...
 
virtual std::size_t getTotalFeatureCount () const =0
 Returns a number large enough to contain the largest ID for all grains in use. More...
 
virtual Point getGrainCentroid (unsigned int grain_id) const =0
 Returns the centroid for the given grain number. More...
 
virtual bool doesFeatureIntersectBoundary (unsigned int grain_id) const =0
 Returns a Boolean indicating whether this grain is in contact with any boundary of the domain. More...
 
virtual std::vector< unsigned int > getNewGrainIDs () const
 This method returns all of the new ids generated in an invocation of the GrainTracker. More...
 

Detailed Description

This class defines the interface for the GrainTracking objects.

Definition at line 23 of file GrainTrackerInterface.h.

Member Function Documentation

virtual bool GrainTrackerInterface::doesFeatureIntersectBoundary ( unsigned int  grain_id) const
pure virtual

Returns a Boolean indicating whether this grain is in contact with any boundary of the domain.

Implemented in GrainTracker, and FauxGrainTracker.

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

Accessor for retrieving either nodal or elemental information (unique grains or variable indicies)

Parameters
entity_idthe node identifier for which to retrieve field data
var_idxwhen using multi-map mode, the map number from which to retrieve data.
show_var_coloringpass true to view variable index for a region, false for unique grain information
Returns
the entity value

Implemented in GrainTracker, and FauxGrainTracker.

Referenced by GrainAdvectionAux::precalculateValue(), and EBSDReaderAvgDataAux::precalculateValue().

virtual unsigned int GrainTrackerInterface::getFeatureVar ( unsigned int  feature_id) const
pure virtual

Return the variable index (typically order parameter) for the given feature.

Returns "invalid_id" if the specified feature is inactive.

Implemented in GrainTracker, and FauxGrainTracker.

virtual Point GrainTrackerInterface::getGrainCentroid ( unsigned int  grain_id) const
pure virtual
std::vector< unsigned int > GrainTrackerInterface::getNewGrainIDs ( ) const
virtual

This method returns all of the new ids generated in an invocation of the GrainTracker.

Reimplemented in GrainTracker.

Definition at line 56 of file GrainTrackerInterface.C.

57 {
58  return std::vector<unsigned int>();
59 }
virtual std::size_t GrainTrackerInterface::getNumberActiveGrains ( ) const
pure virtual

Returns the number of active grains current stored in the GrainTracker.

This value is the same value reported when the GrainTracker (FeatureFloodObject) is used as a Postprocessor. Note: This value will count each piece of a split grain (often enountered in EBSD datasets).

Implemented in GrainTracker, and FauxGrainTracker.

virtual std::size_t GrainTrackerInterface::getTotalFeatureCount ( ) const
pure virtual

Returns a number large enough to contain the largest ID for all grains in use.

This method can be used to size a vector or other data structure to maintain information about all grains (active and inactive) in a simulation.

Implemented in FauxGrainTracker, and GrainTracker.

Referenced by GrainAdvectionVelocity::computeQpProperties(), RandomEulerAngleProvider::initialize(), ComputeGrainForceAndTorque::initialize(), ComputeExternalGrainForceAndTorque::initialize(), EulerAngleUpdaterCheck::initialize(), and EulerAngleUpdater::initialize().

virtual const std::vector<unsigned int>& GrainTrackerInterface::getVarToFeatureVector ( dof_id_type  elem_id) const
pure 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.

Implemented in GrainTracker, and FauxGrainTracker.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), SingleGrainRigidBodyMotion::calculateAdvectionVelocity(), ACSEDGPoly::computeDFDOP(), DeformedGrainMaterial::computeQpProperties(), GrainAdvectionVelocity::computeQpProperties(), ComputeGrainForceAndTorque::execute(), ComputeExternalGrainForceAndTorque::execute(), ComputeGrainForceAndTorque::executeJacobian(), and ComputeExternalGrainForceAndTorque::executeJacobian().


The documentation for this class was generated from the following files: