PRISMS-PF  v2.1
Public Member Functions | Private Attributes | List of all members
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
 

Private Attributes

unsigned int grain_index
 
unsigned int order_parameter_index
 
std::vector< std::vector< dealii::Point< dim > > > list_of_vertices
 

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.

Definition at line 22 of file FloodFiller.h.

Member Function Documentation

◆ addVertexList()

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

Adds the vertices of a new element to the list.

Definition at line 48 of file FloodFiller.h.

◆ getGrainIndex()

unsigned int getGrainIndex ( ) const
inline

Gets the grain index.

Definition at line 33 of file FloodFiller.h.

◆ getOrderParameterIndex()

unsigned int getOrderParameterIndex ( ) const
inline

Gets the order parameter index.

Definition at line 43 of file FloodFiller.h.

◆ getVertexList()

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

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

Definition at line 53 of file FloodFiller.h.

◆ setGrainIndex()

void setGrainIndex ( unsigned int  _grain_index)
inline

Sets the grain index.

Definition at line 28 of file FloodFiller.h.

◆ setOrderParameterIndex()

void setOrderParameterIndex ( unsigned int  _order_parameter_index)
inline

Sets the order parameter index.

Definition at line 38 of file FloodFiller.h.

Member Data Documentation

◆ grain_index

unsigned int grain_index
private

The grain index.

Definition at line 53 of file FloodFiller.h.

◆ list_of_vertices

std::vector<std::vector<dealii::Point<dim> > > list_of_vertices
private

A vector of the elements in the grain containing a vector of the vertices for each element.

Definition at line 69 of file FloodFiller.h.

◆ order_parameter_index

unsigned int order_parameter_index
private

The variable index for the order parameter containing this grain.

Definition at line 64 of file FloodFiller.h.

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