#include <ReciprocalLatticeVector.h>

Inheritance diagram for gbLAB::ReciprocalLatticeVector< dim >:

Public Types
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
	ReciprocalLatticeVector (const Lattice< dim > &lat)

	ReciprocalLatticeVector (const VectorDimD &d, const Lattice< dim > &lat)

	ReciprocalLatticeVector (const VectorDimI &d, const Lattice< dim > &lat)

	ReciprocalLatticeVector (const ReciprocalLatticeVector< dim > &other)=default

	ReciprocalLatticeVector (ReciprocalLatticeVector< dim > &&other)=default

ReciprocalLatticeVector< dim > &	operator= (const ReciprocalLatticeVector< dim > &other)

ReciprocalLatticeVector< dim > &	operator= (ReciprocalLatticeVector< dim > &&other)

ReciprocalLatticeVector< dim >	operator+ (const ReciprocalLatticeVector< dim > &other) const

ReciprocalLatticeVector< dim > &	operator+= (const ReciprocalLatticeVector< dim > &other)

ReciprocalLatticeVector< dim >	operator- (const ReciprocalLatticeVector< dim > &other) const

ReciprocalLatticeVector< dim > &	operator-= (const ReciprocalLatticeVector< dim > &other)

ReciprocalLatticeVector< dim >	operator* (const IntScalarType &scalar) const

IntScalarType	dot (const LatticeVector< dim > &other) const

IntScalarType	dot (const LatticeDirection< dim > &other) const

VectorDimD	cartesian () const

IntScalarType	closestPlaneIndexOfPoint (const VectorDimD &P) const

IntScalarType	planeIndexOfPoint (const VectorDimD &P) const

IntScalarType	planeIndexOfPoint (const LatticeVector< dim > &P) const

template<int dm = dim>
std::enable_if< dm==2, LatticeDirection< dim > >::type	cross (const ReciprocalLatticeVector< dim > &other) const

template<int dm = dim>
std::enable_if< dm==2, LatticeDirection< dim > >::type	cross () const

template<int dm = dim>
std::enable_if< dm==3, LatticeDirection< dim > >::type	cross (const ReciprocalLatticeVector< dim > &other) const

template<int dm = dim>
std::enable_if< dm==3, LatticeDirection< dim > >::type	cross () const

Data Fields
const Lattice< dim > &	lattice

Private Types
typedef Eigen::Matrix< typename LatticeCore< dim >::IntScalarType, dim, 1 >	BaseType

Private Member Functions
BaseType &	base ()

const BaseType &	base () const

Detailed Description

template<int dim>
class gbLAB::ReciprocalLatticeVector< dim >

Examples: testCoincidentRotations.cpp, testGb.cpp, testGb3d.cpp, testGenerateGBs.cpp, testLattice.cpp, and testPlaneParallelLatticeDirections.cpp.

Definition at line 14 of file ReciprocalLatticeVector.h.

Member Typedef Documentation

◆ BaseType

template<int dim>

typedef Eigen::Matrix<typename LatticeCore<dim>::IntScalarType,dim,1> gbLAB::ReciprocalLatticeVector< dim >::BaseType

private

Definition at line 16 of file ReciprocalLatticeVector.h.

◆ IntScalarType

template<int dim>

typedef LatticeCore<dim>::IntScalarType gbLAB::ReciprocalLatticeVector< dim >::IntScalarType

Definition at line 22 of file ReciprocalLatticeVector.h.

◆ MatrixDimD

template<int dim>

typedef LatticeCore<dim>::MatrixDimD gbLAB::ReciprocalLatticeVector< dim >::MatrixDimD

Definition at line 24 of file ReciprocalLatticeVector.h.

◆ MatrixDimI

template<int dim>

typedef LatticeCore<dim>::MatrixDimI gbLAB::ReciprocalLatticeVector< dim >::MatrixDimI

Definition at line 26 of file ReciprocalLatticeVector.h.

◆ VectorDimD

template<int dim>

typedef LatticeCore<dim>::VectorDimD gbLAB::ReciprocalLatticeVector< dim >::VectorDimD

Definition at line 23 of file ReciprocalLatticeVector.h.

◆ VectorDimI

template<int dim>

typedef LatticeCore<dim>::VectorDimI gbLAB::ReciprocalLatticeVector< dim >::VectorDimI

Definition at line 25 of file ReciprocalLatticeVector.h.

Constructor & Destructor Documentation

◆ ReciprocalLatticeVector() [1/5]

template<int dim>

gbLAB::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector ( const Lattice< dim > & lat )

Definition at line 29 of file ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [2/5]

template<int dim>

gbLAB::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const VectorDimD &	d,
		const Lattice< dim > &	lat
	)

Definition at line 35 of file ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [3/5]

template<int dim>

gbLAB::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const VectorDimI &	d,
		const Lattice< dim > &	lat
	)

Definition at line 41 of file ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [4/5]

template<int dim>

gbLAB::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector ( const ReciprocalLatticeVector< dim > & other )

default

◆ ReciprocalLatticeVector() [5/5]

template<int dim>

gbLAB::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector ( ReciprocalLatticeVector< dim > && other )

default

Member Function Documentation

◆ base() [1/2]

template<int dim>

ReciprocalLatticeVector< dim >::BaseType & gbLAB::ReciprocalLatticeVector< dim >::base ( )

private

Definition at line 17 of file ReciprocalLatticeVector.cpp.

◆ base() [2/2]

template<int dim>

const ReciprocalLatticeVector< dim >::BaseType & gbLAB::ReciprocalLatticeVector< dim >::base ( ) const

private

Definition at line 23 of file ReciprocalLatticeVector.cpp.

◆ cartesian()

template<int dim>

ReciprocalLatticeVector< dim >::VectorDimD gbLAB::ReciprocalLatticeVector< dim >::cartesian ( ) const

Examples: testGb3d.cpp, testGenerateGBs.cpp, and testLattice.cpp.

Definition at line 118 of file ReciprocalLatticeVector.cpp.

◆ closestPlaneIndexOfPoint()

template<int dim>

ReciprocalLatticeVector< dim >::IntScalarType gbLAB::ReciprocalLatticeVector< dim >::closestPlaneIndexOfPoint ( const VectorDimD & P ) const

Definition at line 125 of file ReciprocalLatticeVector.cpp.

◆ cross() [1/4]

template<int dim>

template<int dm>

std::enable_if< dm==3, LatticeDirection< dim > >::type gbLAB::ReciprocalLatticeVector< dim >::cross ( ) const

Definition at line 180 of file ReciprocalLatticeVector.cpp.

◆ cross() [2/4]

template<int dim>

template<int dm = dim>

template LatticeDirection< 3 > gbLAB::ReciprocalLatticeVector< dim >::cross< 3 > ( ) const

◆ cross() [3/4]

template<int dim>

template<int dm>

std::enable_if< dm==3, LatticeDirection< dim > >::type gbLAB::ReciprocalLatticeVector< dim >::cross ( const ReciprocalLatticeVector< dim > & other ) const

Examples: testGb3d.cpp, testGenerateGBs.cpp, and testLattice.cpp.

Definition at line 171 of file ReciprocalLatticeVector.cpp.

◆ cross() [4/4]

template<int dim>

template<int dm = dim>

std::enable_if< dm==3, LatticeDirection< dim > >::type gbLAB::ReciprocalLatticeVector< dim >::cross ( const ReciprocalLatticeVector< dim > & other ) const