#include <GlidePlaneBase.h>

Inheritance diagram for model::GlidePlaneBase:

Collaboration diagram for model::GlidePlaneBase:

Public Types
typedef Eigen::Matrix< double, 3, 1 >	VectorDimD
typedef Eigen::Matrix< double, 2, 1 >	VectorLowerDimD
typedef Eigen::Matrix< double, 3, 3 >	MatrixDim
typedef Eigen::Matrix< double, 2, 2 >	MatrixLowerDim
typedef Eigen::Matrix< long int, 3, 1 >	VectorDimI
typedef LatticeVector< 3 >	LatticeVectorType
typedef LatticeDirection< 3 >	LatticeDirectionType
typedef ReciprocalLatticeDirection< 3 >	ReciprocalLatticeDirectionType
Public Types inherited from model::ReciprocalLatticeDirection< 3 >
typedef LatticeGCD< dim >	LatticeGCDType
typedef LatticeVector< dim >	LatticeVectorType
typedef ReciprocalLatticeVector< dim >	ReciprocalLatticeVectorType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< long int, dim, 1 >	VectorDimI
typedef LatticeCore< dim >::IntScalarType	IntScalarType
Public Types inherited from model::ReciprocalLatticeVector< dim >
typedef Eigen::Matrix< long int, dim, 1 >	BaseType
typedef Lattice< dim >	LatticeType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< long int, dim, 1 >	VectorDimI
typedef Eigen::Matrix< double, dim, dim >	MatrixDimD
typedef ReciprocalLatticeVector< dim >	ReciprocalLatticeVectorType
typedef LatticeVector< dim >	LatticeVectorType
typedef LatticeDirection< dim >	LatticeDirectionType
typedef LatticeCore< dim >::VectorDimD	VectorDimD
typedef LatticeCore< dim >::MatrixDimD	MatrixDimD
typedef LatticeCore< dim >::VectorDimI	VectorDimI
typedef LatticeCore< dim >::MatrixDimI	MatrixDimI
Public Types inherited from model::ReciprocalLatticeVectorBase< dim >
typedef LatticeCore< dim >::IntScalarType	IntScalarType
typedef LatticeCore< dim >::VectorDimD	VectorDimD
typedef LatticeCore< dim >::MatrixDimD	MatrixDimD
typedef LatticeCore< dim >::VectorDimI	VectorDimI
typedef LatticeCore< dim >::MatrixDimI	MatrixDimI

Public Member Functions
	GlidePlaneBase (const LatticeVectorType &v1_in, const LatticeVectorType &v2_in, const std::shared_ptr< GammaSurface > &gammaSurface_in)
LatticeVectorType	snapToLattice (const VectorDimD &P) const
VectorDimD	snapToPlane (const VectorDimD &P) const
VectorLowerDimD	localSlipVector (const VectorDimD &b) const
double	misfitEnergy (const VectorDimD &b) const
MatrixLowerDim	localBasis () const
Public Member Functions inherited from model::ReciprocalLatticeDirection< 3 >
	ReciprocalLatticeDirection (const ReciprocalLatticeVectorType &v)
	ReciprocalLatticeDirection (const VectorDimI &v, const Lattice< dim > &lat)
	ReciprocalLatticeDirection (const LatticeVectorType &v1, const LatticeVectorType &v2)
	ReciprocalLatticeDirection (const ReciprocalLatticeVector< dim > &v)
Public Member Functions inherited from model::ReciprocalLatticeVector< dim >
BaseType &	base ()
const BaseType &	base () const
	ReciprocalLatticeVector (const LatticeType &lat)
	ReciprocalLatticeVector (const VectorDimD &d, const LatticeType &lat)
	ReciprocalLatticeVector (const VectorDimI &d, const LatticeType &lat)
ReciprocalLatticeVectorType	operator+ (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType &	operator+= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType	operator- (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType &	operator-= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType	operator* (const long int &scalar) const
long int	dot (const LatticeVectorType &other) const
LatticeDirectionType	cross (const ReciprocalLatticeVectorType &other) const
VectorDimD	cartesian () const
double	planeSpacing () const
VectorDimD	interplaneVector () const
long int	closestPlaneIndexOfPoint (const VectorDimD &P) const
long int	planeIndexOfPoint (const VectorDimD &P) const
long int	planeIndexOfPoint (const LatticeVector< dim > &P) const
	ReciprocalLatticeVector (const Lattice< dim > &lat)
	ReciprocalLatticeVector (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	ReciprocalLatticeVector (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
Public Member Functions inherited from model::ReciprocalLatticeVectorBase< dim >
	ReciprocalLatticeVectorBase (const Lattice< dim > &lat)
	ReciprocalLatticeVectorBase (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	ReciprocalLatticeVectorBase (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
	ReciprocalLatticeVectorBase (const ReciprocalLatticeVectorBase< dim > &other)=default
	ReciprocalLatticeVectorBase (ReciprocalLatticeVectorBase< dim > &&other)=default
ReciprocalLatticeVectorBase< dim > &	operator= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > &	operator= (ReciprocalLatticeVectorBase< dim > &&other)
ReciprocalLatticeVectorBase< dim >	operator+ (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > &	operator+= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim >	operator- (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > &	operator-= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim >	operator* (const IntScalarType &scalar) const
IntScalarType	dot (const LatticeVector< dim > &other) const
VectorDimD	cartesian () const
double	planeSpacing () const
VectorDimD	interplaneVector () const
IntScalarType	closestPlaneIndexOfPoint (const VectorDimD &P) const
IntScalarType	planeIndexOfPoint (const VectorDimD &P) const
IntScalarType	planeIndexOfPoint (const LatticeVector< dim > &P) const

Static Public Member Functions
static MatrixDim	getG2L (const VectorDimD &x, const VectorDimD &z)
Static Public Member Functions inherited from model::ReciprocalLatticeVector< dim >
static VectorDimI	d2cov (const VectorDimD &d, const LatticeType &lat)

Public Attributes
const std::pair< LatticeDirectionType, LatticeDirectionType >	primitiveVectors
const Eigen::Matrix3d	G2L
const std::shared_ptr< GammaSurface >	gammaSurface
Public Attributes inherited from model::ReciprocalLatticeVector< dim >
const LatticeType &	lattice
Public Attributes inherited from model::ReciprocalLatticeVectorBase< dim >
const Lattice< dim > &	lattice

Additional Inherited Members
Static Public Attributes inherited from model::ReciprocalLatticeVector< dim >
static constexpr double	roundTol =FLT_EPSILON

Detailed Description

Definition at line 19 of file GlidePlaneBase.h.

Member Typedef Documentation

◆ LatticeDirectionType

typedef LatticeDirection<3> model::GlidePlaneBase::LatticeDirectionType

Definition at line 27 of file GlidePlaneBase.h.

◆ LatticeVectorType

typedef LatticeVector<3> model::GlidePlaneBase::LatticeVectorType

Definition at line 26 of file GlidePlaneBase.h.

◆ MatrixDim

typedef Eigen::Matrix<double,3,3> model::GlidePlaneBase::MatrixDim

Definition at line 23 of file GlidePlaneBase.h.

◆ MatrixLowerDim

typedef Eigen::Matrix<double,2,2> model::GlidePlaneBase::MatrixLowerDim

Definition at line 24 of file GlidePlaneBase.h.

◆ ReciprocalLatticeDirectionType

typedef ReciprocalLatticeDirection<3> model::GlidePlaneBase::ReciprocalLatticeDirectionType

Definition at line 28 of file GlidePlaneBase.h.

◆ VectorDimD

typedef Eigen::Matrix<double,3,1> model::GlidePlaneBase::VectorDimD

Definition at line 21 of file GlidePlaneBase.h.

◆ VectorDimI

typedef Eigen::Matrix<long int,3,1> model::GlidePlaneBase::VectorDimI

Definition at line 25 of file GlidePlaneBase.h.

◆ VectorLowerDimD

typedef Eigen::Matrix<double,2,1> model::GlidePlaneBase::VectorLowerDimD

Definition at line 22 of file GlidePlaneBase.h.

Constructor & Destructor Documentation

◆ GlidePlaneBase()

model::GlidePlaneBase::GlidePlaneBase	(	const LatticeVectorType &	v1_in,
		const LatticeVectorType &	v2_in,
		const std::shared_ptr< GammaSurface > &	gammaSurface_in )

Definition at line 18 of file GlidePlaneBase.cpp.

Member Function Documentation

◆ getG2L()

GlidePlaneBase::MatrixDim model::GlidePlaneBase::getG2L	(	const VectorDimD &	x,
		const VectorDimD &	z )

static

Definition at line 48 of file GlidePlaneBase.cpp.

◆ localBasis()

GlidePlaneBase::MatrixLowerDim model::GlidePlaneBase::localBasis ( ) const

Definition at line 114 of file GlidePlaneBase.cpp.

◆ localSlipVector()

GlidePlaneBase::VectorLowerDimD model::GlidePlaneBase::localSlipVector ( const VectorDimD & b ) const

Definition at line 86 of file GlidePlaneBase.cpp.

◆ misfitEnergy()

double model::GlidePlaneBase::misfitEnergy ( const VectorDimD & b ) const

Definition at line 97 of file GlidePlaneBase.cpp.

◆ snapToLattice()

GlidePlaneBase::LatticeVectorType model::GlidePlaneBase::snapToLattice ( const VectorDimD & P ) const

Definition at line 28 of file GlidePlaneBase.cpp.

◆ snapToPlane()

GlidePlaneBase::VectorDimD model::GlidePlaneBase::snapToPlane ( const VectorDimD & P ) const

Definition at line 38 of file GlidePlaneBase.cpp.

Member Data Documentation

◆ G2L

const Eigen::Matrix3d model::GlidePlaneBase::G2L

Definition at line 31 of file GlidePlaneBase.h.

◆ gammaSurface

const std::shared_ptr<GammaSurface> model::GlidePlaneBase::gammaSurface

Definition at line 32 of file GlidePlaneBase.h.

◆ primitiveVectors

const std::pair<LatticeDirectionType,LatticeDirectionType> model::GlidePlaneBase::primitiveVectors

Definition at line 30 of file GlidePlaneBase.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members