PRISMS-PF  v2.1
Public Member Functions | Protected Attributes | List of all members
SimplifiedGrainRepresentation< dim > Class Template Reference

#include <SimplifiedGrainRepresentation.h>

Public Member Functions

 SimplifiedGrainRepresentation (const GrainSet< dim > &grain_set)
 
dealii::Point< dim > getCenter () const
 
double getRadius () const
 
unsigned int getGrainId () const
 
void setGrainId (unsigned int id)
 
unsigned int getOrderParameterId () const
 
void setOrderParameterId (unsigned int id)
 
unsigned int getOldOrderParameterId () const
 
void setDistanceToNeighbor (double dist)
 
double getDistanceToNeighbor () const
 

Protected Attributes

dealii::Point< dim > center
 
double radius
 
unsigned int grain_id
 
unsigned int order_parameter_id
 
unsigned int old_order_parameter_id
 
double distance_to_neighbor_sharing_op
 

Detailed Description

template<int dim>
class SimplifiedGrainRepresentation< dim >

This class converts lists of grains and the vertices inside the grains to a simplified representation (currently spheres, other representations may be added later). Currently, assumptions are made that the elements are rectangular prisms. If not, a valid representation will still be made, but the centroid might be suboptimally placed.

Definition at line 14 of file SimplifiedGrainRepresentation.h.

Constructor & Destructor Documentation

◆ SimplifiedGrainRepresentation()

SimplifiedGrainRepresentation ( const GrainSet< dim > &  grain_set)

Constructor. Creates the simplified representation of a grain from its GrainSet. This sets all of the internal data members and is the only way to set the radius and center of the grain. The members order_parameter_id and old_order_parameter_id are initialized to the same value.

Definition at line 8 of file SimplifiedGrainRepresentation.cc.

Member Function Documentation

◆ getCenter()

dealii::Point< dim > getCenter ( ) const

Getter for the grain center/centroid.

Definition at line 62 of file SimplifiedGrainRepresentation.cc.

◆ getDistanceToNeighbor()

double getDistanceToNeighbor ( ) const

Getter for the distance from this grain to the nearest grain with the same order parameter

Definition at line 102 of file SimplifiedGrainRepresentation.cc.

◆ getGrainId()

unsigned int getGrainId ( ) const

Getter for the grain id.

Definition at line 72 of file SimplifiedGrainRepresentation.cc.

◆ getOldOrderParameterId()

unsigned int getOldOrderParameterId ( ) const

Getter for the old value of the order parameter id (used in the transferGrainIds method of the SimplifiedGrainManipulator class).

Definition at line 92 of file SimplifiedGrainRepresentation.cc.

◆ getOrderParameterId()

unsigned int getOrderParameterId ( ) const

Getter for the order parameter id.

Definition at line 82 of file SimplifiedGrainRepresentation.cc.

◆ getRadius()

double getRadius ( ) const

Getter for the grain radius.

Definition at line 67 of file SimplifiedGrainRepresentation.cc.

◆ setDistanceToNeighbor()

void setDistanceToNeighbor ( double  dist)

Setter for the distance from this grain to the nearest grain with the same order parameter.

Definition at line 97 of file SimplifiedGrainRepresentation.cc.

◆ setGrainId()

void setGrainId ( unsigned int  id)

Setter for the grain id.

Definition at line 77 of file SimplifiedGrainRepresentation.cc.

◆ setOrderParameterId()

void setOrderParameterId ( unsigned int  id)

Setter for the order parameter id.

Definition at line 87 of file SimplifiedGrainRepresentation.cc.

Member Data Documentation

◆ center

dealii::Point<dim> center
protected

The center of the circle/sphere that represents the grain.

Definition at line 78 of file SimplifiedGrainRepresentation.h.

◆ distance_to_neighbor_sharing_op

double distance_to_neighbor_sharing_op
protected

The distance from this grain to the nearest grain with the same order parameter. This value is used to determine the cutoff distance for tranfering the grain between order parameters.

Definition at line 107 of file SimplifiedGrainRepresentation.h.

◆ grain_id

unsigned int grain_id
protected

The id of grain, which is used to distinguish between grains and give them different properties.

Definition at line 89 of file SimplifiedGrainRepresentation.h.

◆ old_order_parameter_id

unsigned int old_order_parameter_id
protected

The variable index of the order parameter containing this grain before reassignment (which is performed outside this class).

Definition at line 100 of file SimplifiedGrainRepresentation.h.

◆ order_parameter_id

unsigned int order_parameter_id
protected

The variable index of the order parameter containing this grain.

Definition at line 94 of file SimplifiedGrainRepresentation.h.

◆ radius

double radius
protected

The radius of the circle/sphere that represents the grain.

Definition at line 83 of file SimplifiedGrainRepresentation.h.

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