GrainTrackerInterface Class Reference

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

#include <GrainTrackerInterface.h>

Inheritance diagram for GrainTrackerInterface:

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)
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.
virtual unsigned int	getFeatureVar (unsigned int feature_id) const =0
	Return the variable index (typically order parameter) for the given feature.
virtual std::size_t	getNumberActiveGrains () const =0
	Returns the number of active grains current stored in the GrainTracker.
virtual std::size_t	getTotalFeatureCount () const =0
	Returns a number large enough to contain the largest ID for all grains in use.
virtual Point	getGrainCentroid (unsigned int grain_id) const =0
	Returns the centroid for the given grain number.
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.
virtual std::vector< unsigned int >	getNewGrainIDs () const
	This method returns all of the new ids generated in an invocation of the GrainTracker.

Static Public Member Functions
static InputParameters	validParams ()

Detailed Description

This class defines the interface for the GrainTracking objects.

Definition at line 20 of file GrainTrackerInterface.h.

Member Function Documentation

doesFeatureIntersectBoundary()

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 FauxGrainTracker, and GrainTracker.

getEntityValue()

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_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

Returns

the entity value

Implemented in FauxGrainTracker, and GrainTracker.

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

getFeatureVar()

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 FauxGrainTracker, and GrainTracker.

getGrainCentroid()

virtual Point GrainTrackerInterface::getGrainCentroid ( unsigned int  grain_id ) const

pure virtual

Returns the centroid for the given grain number.

Implemented in FauxGrainTracker, and GrainTracker.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), SingleGrainRigidBodyMotion::calculateAdvectionVelocity(), GrainAdvectionVelocity::computeQpProperties(), ComputeExternalGrainForceAndTorque::execute(), ComputeGrainForceAndTorque::execute(), ComputeExternalGrainForceAndTorque::executeJacobian(), ComputeGrainForceAndTorque::executeJacobian(), MultiGrainRigidBodyMotion::getUserObjectJacobian(), SingleGrainRigidBodyMotion::getUserObjectJacobian(), and GrainAdvectionAux::precalculateValue().

getNewGrainIDs()

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 79 of file GrainTrackerInterface.C.

{
  return std::vector<unsigned int>();
}

getNumberActiveGrains()

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 encountered in EBSD data sets).

Implemented in FauxGrainTracker, and GrainTracker.

getTotalFeatureCount()

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(), ComputeExternalGrainForceAndTorque::initialize(), ComputeGrainForceAndTorque::initialize(), EulerAngleUpdater::initialize(), RandomEulerAngleProvider::initialize(), and EulerAngleUpdaterCheck::initialize().

getVarToFeatureVector()

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 FauxGrainTracker, and GrainTracker.

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

validParams()

InputParameters GrainTrackerInterface::validParams ( )

static

Definition at line 14 of file GrainTrackerInterface.C.

{
  InputParameters params = FeatureFloodCount::validParams();
  params.addParam<int>("tracking_step", 0, "The timestep for when we should start tracking grains");
  params.addParam<unsigned short>(
      "halo_level", 2, "The thickness of the halo surrounding each feature.");
  params.addParam<bool>(
      "remap_grains", true, "Indicates whether remapping should be done or not (default: true)");
  params.addParam<bool>("tolerate_failure",
                        false,
                        "Allow the grain tracker to continue when it fails to find suitable grains "
                        "for remapping. This will allow the simulation to continue but it will "
                        "also allow non-physical grain coalescence. DO NOT USE for production "
                        "results!");
 
  params.addParam<unsigned short>(
      "reserve_op",
      0,
      "Indicates the number of reserved ops (variables that cannot be remapped to)");
  params.addParam<Real>("reserve_op_threshold",
                        0.95,
                        "Threshold for locating a new feature on the reserved op variable(s)");
  params.addParam<UserObjectName>("polycrystal_ic_uo", "Optional: Polycrystal IC object");
  params.addParam<bool>("error_on_grain_creation",
                        false,
                        "Terminate with an error if a grain is created "
                        "(does not include initial callback to start simulation)");
 
  params.addParam<unsigned short>("max_remap_recursion_depth",
                                  6,
                                  "The recursion depth allowed when searching for remapping "
                                  "candidates. Note: Setting this value high may result in very "
                                  "computationally expensive searches with little benefit. "
                                  "(Recommended level: 6)");
 
  params.addRangeCheckedParam<short>(
      "verbosity_level",
      1,
      "verbosity_level>=0 & verbosity_level<=3",
      "Level 0: Silent during normal operation, "
      "Level 1: Informational messages but no detailed grain structure printouts, "
      "Level 2: Verbose output including data structure dumps, "
      "Level 3: Debugging mode.");
 
  params.addRequiredCoupledVarWithAutoBuild(
      "variable", "var_name_base", "op_num", "Array of coupled variables");
 
  params.addParamNamesToGroup("tolerate_failure max_remap_recursion_depth", "Advanced");
 
  // Set suitable default parameters for grain tracking
  params.set<Real>("threshold") = 0.1; // flood out to a fairly low value for grain remapping
  params.set<Real>("connecting_threshold") =
      0.09; // connecting threshold should be just slightly lower than threshold
  params.set<bool>("use_single_map") =
      false; // This is needed to allow for arbitrary feature overlap during remapping
  params.set<bool>("condense_map_info") =
      true; // It's better to have all information in one map for normal visualization
  params.set<bool>("enable_var_coloring") =
      true; // Generally we need to see the variable (OP) indices
 
  params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_TIMESTEP_END};
  return params;
}

Referenced by FauxGrainTracker::validParams(), and GrainTracker::validParams().

---

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

• phase_field/include/postprocessors/GrainTrackerInterface.h
• phase_field/src/postprocessors/GrainTrackerInterface.C