#include <LatticeVector.h>

Inheritance diagram for model::LatticeVector< 3 >:

Collaboration diagram for model::LatticeVector< 3 >:

Public Types
typedef LatticeCore< 3 >::VectorDimD	VectorDimD
typedef LatticeCore< 3 >::MatrixDimD	MatrixDimD
typedef LatticeCore< 3 >::VectorDimI	VectorDimI
typedef LatticeCore< 3 >::MatrixDimI	MatrixDimI
typedef Lattice< dim >	LatticeType
typedef Eigen::Matrix< long int, dim, 1 >	BaseType
typedef LatticeVector< dim >	LatticeVectorType
typedef ReciprocalLatticeVector< dim >	ReciprocalLatticeVectorType
typedef ReciprocalLatticeDirection< dim >	ReciprocalLatticeDirectionType
Public Types inherited from model::LatticeVectorBase< 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 Types inherited from model::LatticeVectorBase< 3 >
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
	LatticeVector (const Lattice< 3 > &lat)
	LatticeVector (const VectorDimD &d, const Lattice< 3 > &lat)
template<typename OtherDerived>
	LatticeVector (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< 3 > &lat)
ReciprocalLatticeDirection< 3 >	cross (const LatticeVector< 3 > &other) const
BaseType &	base ()
LatticeVectorType	operator+ (const LatticeVectorType &other) const
LatticeVectorType &	operator+= (const LatticeVectorType &other)
LatticeVectorType	operator- (const LatticeVectorType &other) const
LatticeVectorType &	operator-= (const LatticeVectorType &other)
LatticeVectorType	operator* (const long int &scalar) const
long int	dot (const ReciprocalLatticeVectorType &other) const
VectorDimD	cartesian () const
Public Member Functions inherited from model::LatticeVectorBase< dim >
	LatticeVectorBase (const Lattice< dim > &lat)
	LatticeVectorBase (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	LatticeVectorBase (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
	LatticeVectorBase (const LatticeVectorBase< dim > &other)=default
	LatticeVectorBase (LatticeVectorBase< dim > &&other)=default
LatticeVectorBase< dim > &	operator= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim > &	operator= (LatticeVectorBase< dim > &&other)
LatticeVectorBase< dim >	operator+ (const LatticeVectorBase< dim > &other) const
LatticeVectorBase< dim > &	operator+= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim >	operator- (const LatticeVectorBase< dim > &other) const
LatticeVectorBase< dim > &	operator-= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim >	operator* (const IntScalarType &scalar) const
IntScalarType	dot (const ReciprocalLatticeVectorBase< dim > &other) const
VectorDimD	cartesian () const
Public Member Functions inherited from model::LatticeVectorBase< 3 >
	LatticeVectorBase (const Lattice< dim > &lat)
LatticeVectorBase< dim > &	operator= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim >	operator+ (const LatticeVectorBase< dim > &other) const
LatticeVectorBase< dim > &	operator+= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim >	operator- (const LatticeVectorBase< dim > &other) const
LatticeVectorBase< dim > &	operator-= (const LatticeVectorBase< dim > &other)
LatticeVectorBase< dim >	operator* (const IntScalarType &scalar) const
IntScalarType	dot (const ReciprocalLatticeVectorBase< dim > &other) const
VectorDimD	cartesian () const

Static Public Member Functions
static VectorDimI	d2contra (const VectorDimD &d, const LatticeType &lat)

Public Attributes
const LatticeType &	lattice
Public Attributes inherited from model::LatticeVectorBase< dim >
const Lattice< dim > &	lattice
Public Attributes inherited from model::LatticeVectorBase< 3 >
const Lattice< dim > &	lattice

Static Public Attributes
static constexpr double	roundTol

Detailed Description

Definition at line 94 of file Lattices_NEW/LatticeVector.h.

Member Typedef Documentation

◆ BaseType

typedef Eigen::Matrix<long int,dim,1> model::LatticeVector< dim >::BaseType

Definition at line 28 of file Lattices/LatticeVector.h.

◆ LatticeType

typedef Lattice<dim> model::LatticeVector< dim >::LatticeType

Definition at line 27 of file Lattices/LatticeVector.h.

◆ LatticeVectorType

typedef LatticeVector<dim> model::LatticeVector< dim >::LatticeVectorType

Definition at line 37 of file Lattices/LatticeVector.h.

◆ MatrixDimD

typedef LatticeCore<3>::MatrixDimD model::LatticeVector< 3 >::MatrixDimD

Definition at line 100 of file Lattices_NEW/LatticeVector.h.

◆ MatrixDimI

typedef LatticeCore<3>::MatrixDimI model::LatticeVector< 3 >::MatrixDimI

Definition at line 102 of file Lattices_NEW/LatticeVector.h.

◆ ReciprocalLatticeDirectionType

typedef ReciprocalLatticeDirection<dim> model::LatticeVector< dim >::ReciprocalLatticeDirectionType

Definition at line 39 of file Lattices/LatticeVector.h.

◆ ReciprocalLatticeVectorType

typedef ReciprocalLatticeVector<dim> model::LatticeVector< dim >::ReciprocalLatticeVectorType

Definition at line 38 of file Lattices/LatticeVector.h.

◆ VectorDimD

typedef LatticeCore<3>::VectorDimD model::LatticeVector< 3 >::VectorDimD

Definition at line 99 of file Lattices_NEW/LatticeVector.h.

◆ VectorDimI

typedef LatticeCore<3>::VectorDimI model::LatticeVector< 3 >::VectorDimI

Definition at line 101 of file Lattices_NEW/LatticeVector.h.

Constructor & Destructor Documentation

◆ LatticeVector() [1/3]

model::LatticeVector< 3 >::LatticeVector ( const Lattice< 3 > & lat )

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 142 of file Lattices_NEW/LatticeVector.cpp.

◆ LatticeVector() [2/3]

model::LatticeVector< 3 >::LatticeVector	(	const VectorDimD &	d,
		const Lattice< 3 > &	lat )

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 149 of file Lattices_NEW/LatticeVector.cpp.

◆ LatticeVector() [3/3]

template<typename OtherDerived>

model::LatticeVector< 3 >::LatticeVector	(	const Eigen::MatrixBase< OtherDerived > &	other,
		const Lattice< 3 > &	lat )

inline

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 113 of file Lattices_NEW/LatticeVector.h.

Member Function Documentation

◆ base()

LatticeVector< dim >::BaseType & model::LatticeVector< dim >::base ( )

Definition at line 30 of file Lattices/LatticeVector.cpp.

◆ cartesian()

LatticeVector< dim >::VectorDimD model::LatticeVector< dim >::cartesian ( ) const

Definition at line 55 of file Lattices/LatticeVector.cpp.

◆ cross()

ReciprocalLatticeDirection< 3 > model::LatticeVector< 3 >::cross ( const LatticeVector< 3 > & other ) const

Definition at line 157 of file Lattices_NEW/LatticeVector.cpp.

◆ d2contra()

LatticeVector< dim >::VectorDimI model::LatticeVector< dim >::d2contra	(	const VectorDimD &	d,
		const LatticeType &	lat )

static

Definition at line 56 of file Lattices/LatticeVector.cpp.

◆ dot()

long int model::LatticeVector< dim >::dot ( const ReciprocalLatticeVectorType & other ) const

Definition at line 53 of file Lattices/LatticeVector.cpp.

◆ operator*()

LatticeVector< dim > model::LatticeVector< dim >::operator* ( const long int & scalar ) const

Definition at line 52 of file Lattices/LatticeVector.cpp.

◆ operator+()

LatticeVector< dim >::LatticeVectorType model::LatticeVector< dim >::operator+ ( const LatticeVectorType & other ) const

Definition at line 48 of file Lattices/LatticeVector.cpp.

◆ operator+=()

LatticeVector< dim >::LatticeVectorType & model::LatticeVector< dim >::operator+= ( const LatticeVectorType & other )

Definition at line 49 of file Lattices/LatticeVector.cpp.

◆ operator-()

LatticeVector< dim >::LatticeVectorType model::LatticeVector< dim >::operator- ( const LatticeVectorType & other ) const

Definition at line 50 of file Lattices/LatticeVector.cpp.

◆ operator-=()

LatticeVector< dim >::LatticeVectorType & model::LatticeVector< dim >::operator-= ( const LatticeVectorType & other )

Definition at line 51 of file Lattices/LatticeVector.cpp.

Member Data Documentation

◆ lattice

const LatticeType& model::LatticeVector< dim >::lattice

Definition at line 41 of file Lattices/LatticeVector.h.

◆ roundTol

double model::LatticeVector< dim >::roundTol

staticconstexpr

Definition at line 33 of file Lattices/LatticeVector.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ LatticeType

◆ LatticeVectorType

◆ MatrixDimD

◆ MatrixDimI

◆ ReciprocalLatticeDirectionType

◆ ReciprocalLatticeVectorType

◆ VectorDimD

◆ VectorDimI

Constructor & Destructor Documentation

◆ LatticeVector() [1/3]

◆ LatticeVector() [2/3]

◆ LatticeVector() [3/3]

Member Function Documentation

◆ base()

◆ cartesian()

◆ cross()

◆ d2contra()

◆ dot()

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

Member Data Documentation

◆ lattice

◆ roundTol