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 _grain_id)
unsigned int	getOrderParameterId () const
void	setOrderParameterId (unsigned int _order_parameter_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.

Constructor & Destructor Documentation

SimplifiedGrainRepresentation()

template<int dim>

SimplifiedGrainRepresentation< dim >::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.

Member Function Documentation

getCenter()

template<int dim>

dealii::Point< dim > SimplifiedGrainRepresentation< dim >::getCenter

(

)

const

Getter for the grain center/centroid.

getDistanceToNeighbor()

template<int dim>

double SimplifiedGrainRepresentation< dim >::getDistanceToNeighbor

(

)

const

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

getGrainId()

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::getGrainId

(

)

const

Getter for the grain id.

getOldOrderParameterId()

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::getOldOrderParameterId

(

)

const

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

getOrderParameterId()

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::getOrderParameterId

(

)

const

Getter for the order parameter id.

getRadius()

template<int dim>

double SimplifiedGrainRepresentation< dim >::getRadius

(

)

const

Getter for the grain radius.

setDistanceToNeighbor()

template<int dim>

void SimplifiedGrainRepresentation< dim >::setDistanceToNeighbor

(

double

dist

)

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

setGrainId()

template<int dim>

void SimplifiedGrainRepresentation< dim >::setGrainId

(

unsigned int

_grain_id

)

Setter for the grain id.

setOrderParameterId()

template<int dim>

void SimplifiedGrainRepresentation< dim >::setOrderParameterId

(

unsigned int

_order_parameter_id

)

Setter for the order parameter id.

Member Data Documentation

center

template<int dim>

dealii::Point<dim> SimplifiedGrainRepresentation< dim >::center

protected

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

distance_to_neighbor_sharing_op

template<int dim>

double SimplifiedGrainRepresentation< dim >::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.

grain_id

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::grain_id

protected

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

old_order_parameter_id

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::old_order_parameter_id

protected

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

order_parameter_id

template<int dim>

unsigned int SimplifiedGrainRepresentation< dim >::order_parameter_id

protected

The variable index of the order parameter containing this grain.

radius

template<int dim>

double SimplifiedGrainRepresentation< dim >::radius

protected

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

---

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

• /home/runner/work/phaseField/phaseField/include/grains/SimplifiedGrainRepresentation.h
• /home/runner/work/phaseField/phaseField/src/grains/SimplifiedGrainRepresentation.cc