GrainSet< dim > Class Template Reference

#include <FloodFiller.h>

Public Member Functions
void	setGrainIndex (unsigned int _grain_index)
unsigned int	getGrainIndex () const
void	setOrderParameterIndex (unsigned int _order_parameter_index)
unsigned int	getOrderParameterIndex () const
void	addVertexList (std::vector< dealii::Point< dim > > _vertices)
std::vector< std::vector< dealii::Point< dim > > >	getVertexList () const

Detailed Description

template<int dim>
class GrainSet< dim >

This class holds information for a grain, including its index and the list of vertices in that grain.

Member Function Documentation

addVertexList()

template<int dim>

void GrainSet< dim >::addVertexList ( std::vector< dealii::Point< dim > >  _vertices )

inline

Adds the vertices of a new element to the list.

getGrainIndex()

template<int dim>

unsigned int GrainSet< dim >::getGrainIndex ( ) const

inline

Gets the grain index.

getOrderParameterIndex()

template<int dim>

unsigned int GrainSet< dim >::getOrderParameterIndex ( ) const

inline

Gets the order parameter index.

getVertexList()

template<int dim>

std::vector< std::vector< dealii::Point< dim > > > GrainSet< dim >::getVertexList ( ) const

inline

Gets the entire list of elements and the list of vertices per element.

setGrainIndex()

template<int dim>

void GrainSet< dim >::setGrainIndex ( unsigned int  _grain_index )

inline

Sets the grain index.

setOrderParameterIndex()

template<int dim>

void GrainSet< dim >::setOrderParameterIndex ( unsigned int  _order_parameter_index )

inline

Sets the order parameter index.

---

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

• /home/runner/work/phaseField/phaseField/include/grains/FloodFiller.h