model::GrainBoundary< dim > Class Template Reference

#include <GrainBoundary.h>

Inheritance diagram for model::GrainBoundary< dim >:

Collaboration diagram for model::GrainBoundary< dim >:

Public Member Functions
	GrainBoundary (const MeshRegionBoundaryType &regionbnd_in, const std::shared_ptr< Polyhedron< dim, dim-1 > > &face_in, const Grain< dim > &grainFirst, const Grain< dim > &grainSecond)
const GrainContainerType &	grains () const
const Grain< dim > &	grain (const size_t &k) const
const OutNormalContainerType &	outNormals () const
const VectorDimD &	outNormal (const size_t &k) const
const VectorDimD &	crystallographicRotationAxis () const
const VectorDimD &	rotationAxis () const
double	rotationAngle () const
std::string	tag () const
Public Member Functions inherited from model::MeshPlane< dim >
	MeshPlane (const SimplicialMesh< dim > &mesh, const size_t &rID, const VectorDim &p, const VectorDim &n)
	MeshPlane (const Polyhedron< dim, dim-1 > &face, const size_t &rID1, const size_t &rID2)
Public Member Functions inherited from model::StaticID< MeshPlane< dim > >
	StaticID ()
Public Member Functions inherited from model::Plane< dim >
	Plane (const VectorDim &p, const VectorDim &n)
bool	contains (const VectorDim &P0) const
bool	isAbove (const VectorDim &P0) const
bool	isBelow (const VectorDim &P0) const
VectorDim	snapToPlane (const VectorDim &P0) const
double	distanceTo (const VectorDim &P0) const
double	signedDistanceTo (const VectorDim &P0) const
VectorLowerDim	localPosition (const VectorDim &point) const
VectorDim	globalPosition (const VectorLowerDim &point) const
VectorLowerDim	localDirection (const VectorDim &dir) const
VectorDim	globalDirection (const VectorLowerDim &dir) const

Public Attributes
const MeshRegionBoundaryType &	regionBoundary
const std::shared_ptr< Polyhedron< dim, dim-1 > > &	face
const std::pair< int, int > &	grainBndID
Public Attributes inherited from model::MeshPlane< dim >
const std::pair< int, int >	regionIDs
const BoundingMeshSegments< dim >	meshIntersections
Public Attributes inherited from model::StaticID< MeshPlane< dim > >
const size_t	sID
	The static ID of this.
Public Attributes inherited from model::Plane< dim >
const VectorDim	P
const VectorDim	unitNormal
const MatrixDim	L2G

Static Public Attributes
static bool	use_GBdislocations

Additional Inherited Members
Public Types inherited from model::MeshPlane< dim >
typedef std::array< long int, dim+3 >	MeshPlaneKeyType
typedef Eigen::Matrix< double, dim, 1 >	VectorDim
typedef Eigen::Matrix< double, dim-1, 1 >	VectorLowerDim
typedef Eigen::Matrix< double, dim, dim >	MatrixDim
typedef std::pair< VectorDim, const Simplex< dim, 1 > *const >	RootType
typedef std::deque< RootType >	RootContainerType
Public Types inherited from model::Plane< dim >
typedef Eigen::Matrix< double, dim, 1 >	VectorDim
typedef Eigen::Matrix< double, dim-1, 1 >	VectorLowerDim
typedef Eigen::Matrix< double, dim, dim >	MatrixDim
Static Public Member Functions inherited from model::MeshPlane< dim >
static BoundingMeshSegments< dim >	getFaceBoundary (const Polyhedron< dim, dim-1 > &face)
static void	checkPlaneIntersections (const BoundingMeshSegments< dim > &temp)
Static Public Member Functions inherited from model::StaticID< MeshPlane< dim > >
static size_t	nextID ()
static size_t &	get_count ()
static void	set_count (const size_t &newCount)
static void	force_count (const size_t &newCount)
static void	set_increment (const size_t &newIncrement)
Static Public Member Functions inherited from model::Plane< dim >
static MatrixDim	getL2G (const VectorDim &z)

Detailed Description

template<int dim>
class model::GrainBoundary< dim >

Definition at line 33 of file GrainBoundary.h.

Constructor & Destructor Documentation

GrainBoundary()

template<int dim>

model::GrainBoundary< dim >::GrainBoundary	(	const MeshRegionBoundaryType &	regionbnd_in,
		const std::shared_ptr< Polyhedron< dim, dim-1 > > &	face_in,
		const Grain< dim > &	grainFirst,
		const Grain< dim > &	grainSecond )

Definition at line 69 of file GrainBoundary.cpp.

Member Function Documentation

crystallographicRotationAxis()

template<int dim>

const GrainBoundary< dim >::VectorDimD & model::GrainBoundary< dim >::crystallographicRotationAxis

(

)

const

Definition at line 141 of file GrainBoundary.cpp.

grain()

template<int dim>

const Grain< dim > & model::GrainBoundary< dim >::grain

(

const size_t &

k

)

const

Definition at line 123 of file GrainBoundary.cpp.

grains()

template<int dim>

const GrainBoundary< dim >::GrainContainerType & model::GrainBoundary< dim >::grains

(

)

const

Definition at line 117 of file GrainBoundary.cpp.

outNormal()

template<int dim>

const GrainBoundary< dim >::VectorDimD & model::GrainBoundary< dim >::outNormal

(

const size_t &

k

)

const

Definition at line 135 of file GrainBoundary.cpp.

outNormals()

template<int dim>

const GrainBoundary< dim >::OutNormalContainerType & model::GrainBoundary< dim >::outNormals

(

)

const

Definition at line 129 of file GrainBoundary.cpp.

rotationAngle()

template<int dim>

double model::GrainBoundary< dim >::rotationAngle

(

)

const

Definition at line 153 of file GrainBoundary.cpp.

rotationAxis()

template<int dim>

const GrainBoundary< dim >::VectorDimD & model::GrainBoundary< dim >::rotationAxis

(

)

const

Definition at line 147 of file GrainBoundary.cpp.

tag()

template<int dim>

std::string model::GrainBoundary< dim >::tag

(

)

const

Definition at line 159 of file GrainBoundary.cpp.

Member Data Documentation

face

template<int dim>

const std::shared_ptr<Polyhedron<dim,dim-1> >& model::GrainBoundary< dim >::face

Definition at line 60 of file GrainBoundary.h.

grainBndID

template<int dim>

const std::pair<int,int>& model::GrainBoundary< dim >::grainBndID

Definition at line 61 of file GrainBoundary.h.

regionBoundary

template<int dim>

const MeshRegionBoundaryType& model::GrainBoundary< dim >::regionBoundary

Definition at line 59 of file GrainBoundary.h.

use_GBdislocations

template<int dim>

bool model::GrainBoundary< dim >::use_GBdislocations

static

Definition at line 58 of file GrainBoundary.h.

---

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

• Grain.h
• GrainBoundary.h
• GrainBoundary.cpp