This class defines the interface for the GrainTracking objects. More...
#include <GrainTrackerInterface.h>
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... | |
Static Public Member Functions | |
static InputParameters | validParams () |
This class defines the interface for the GrainTracking objects.
Definition at line 20 of file GrainTrackerInterface.h.
|
pure virtual |
Returns a Boolean indicating whether this grain is in contact with any boundary of the domain.
Implemented in GrainTracker, and FauxGrainTracker.
|
pure virtual |
Accessor for retrieving either nodal or elemental information (unique grains or variable indicies)
entity_id | the node identifier for which to retrieve field data |
var_idx | when using multi-map mode, the map number from which to retrieve data. |
show_var_coloring | pass true to view variable index for a region, false for unique grain information |
Implemented in GrainTracker, and FauxGrainTracker.
Referenced by GrainAdvectionAux::precalculateValue(), EBSDReaderAvgDataAux::precalculateValue(), and EulerAngleProvider2RGBAux::precalculateValue().
|
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.
|
pure virtual |
Returns the centroid for the given grain number.
Implemented in GrainTracker, and FauxGrainTracker.
Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), SingleGrainRigidBodyMotion::calculateAdvectionVelocity(), GrainAdvectionVelocity::computeQpProperties(), ComputeGrainForceAndTorque::execute(), ComputeExternalGrainForceAndTorque::execute(), ComputeGrainForceAndTorque::executeJacobian(), ComputeExternalGrainForceAndTorque::executeJacobian(), MultiGrainRigidBodyMotion::getUserObjectJacobian(), SingleGrainRigidBodyMotion::getUserObjectJacobian(), and GrainAdvectionAux::precalculateValue().
|
virtual |
This method returns all of the new ids generated in an invocation of the GrainTracker.
Reimplemented in GrainTracker.
Definition at line 79 of file GrainTrackerInterface.C.
|
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 encountered in EBSD data sets).
Implemented in GrainTracker, and FauxGrainTracker.
|
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().
|
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().
|
static |
Definition at line 14 of file GrainTrackerInterface.C.
Referenced by GrainTracker::validParams(), and FauxGrainTracker::validParams().