#include <LatticePlaneBase.h>

Inheritance diagram for model::LatticePlaneBase:

Collaboration diagram for model::LatticePlaneBase:

Public Types
typedef Eigen::Matrix< double, 3, 1 >	VectorDimD
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
	LatticePlaneBase (const LatticeVectorType &v1_in, const LatticeVectorType &v2_in)
LatticeVectorType	snapToLattice (const Eigen::Matrix< double, 3, 1 > &P) const
VectorDimD	snapToPlane (const Eigen::Matrix< double, 3, 1 > &P) 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

Public Attributes
const std::pair< LatticeDirectionType, LatticeDirectionType >	primitiveVectors
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 Member Functions inherited from model::ReciprocalLatticeVector< dim >
static VectorDimI	d2cov (const VectorDimD &d, const LatticeType &lat)
Static Public Attributes inherited from model::ReciprocalLatticeVector< dim >
static constexpr double	roundTol =FLT_EPSILON

Detailed Description

Definition at line 18 of file LatticePlaneBase.h.

Member Typedef Documentation

◆ LatticeDirectionType

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

Definition at line 23 of file LatticePlaneBase.h.

◆ LatticeVectorType

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

Definition at line 22 of file LatticePlaneBase.h.

◆ ReciprocalLatticeDirectionType

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

Definition at line 24 of file LatticePlaneBase.h.

◆ VectorDimD

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

Definition at line 20 of file LatticePlaneBase.h.

◆ VectorDimI

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

Definition at line 21 of file LatticePlaneBase.h.

Constructor & Destructor Documentation

◆ LatticePlaneBase()

model::LatticePlaneBase::LatticePlaneBase	(	const LatticeVectorType &	v1_in,
		const LatticeVectorType &	v2_in )

Definition at line 18 of file LatticePlaneBase.cpp.

Member Function Documentation

◆ snapToLattice()

LatticePlaneBase::LatticeVectorType model::LatticePlaneBase::snapToLattice ( const Eigen::Matrix< double, 3, 1 > & P ) const

Definition at line 28 of file LatticePlaneBase.cpp.

◆ snapToPlane()

LatticePlaneBase::VectorDimD model::LatticePlaneBase::snapToPlane ( const Eigen::Matrix< double, 3, 1 > & P ) const

Definition at line 39 of file LatticePlaneBase.cpp.

Member Data Documentation

◆ primitiveVectors

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

Definition at line 26 of file LatticePlaneBase.h.

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members