#include <LatticeVector.h>

Inheritance diagram for model::LatticeVector< dim >:

Collaboration diagram for model::LatticeVector< dim >:

Public Types
typedef Lattice< dim >	LatticeType
typedef Eigen::Matrix< long int, dim, 1 >	BaseType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< long int, dim, 1 >	VectorDimI
typedef Eigen::Matrix< double, dim, dim >	MatrixDimD
typedef LatticeVector< dim >	LatticeVectorType
typedef ReciprocalLatticeVector< dim >	ReciprocalLatticeVectorType
typedef ReciprocalLatticeDirection< dim >	ReciprocalLatticeDirectionType
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< 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
BaseType &	base ()
const BaseType &	base () const
	LatticeVector (const LatticeType &lat)
	LatticeVector (const VectorDimD &d, const LatticeType &lat)
	LatticeVector (const VectorDimI &d, const LatticeType &lat)
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
ReciprocalLatticeDirectionType	cross (const LatticeVectorType &other) const
VectorDimD	cartesian () const
	LatticeVector (const Lattice< dim > &lat)
	LatticeVector (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	LatticeVector (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
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

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

Static Public Attributes
static constexpr double	roundTol =FLT_EPSILON

Detailed Description

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

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

Member Typedef Documentation

◆ BaseType

template<int dim>

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

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

◆ LatticeType

template<int dim>

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

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

◆ LatticeVectorType

template<int dim>

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

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

◆ MatrixDimD [1/2]

template<int dim>

typedef Eigen::Matrix<double,dim,dim> model::LatticeVector< dim >::MatrixDimD

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

◆ MatrixDimD [2/2]

template<int dim>

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

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

◆ MatrixDimI

template<int dim>

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

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

◆ ReciprocalLatticeDirectionType

template<int dim>

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

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

◆ ReciprocalLatticeVectorType

template<int dim>

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

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

◆ VectorDimD [1/2]

template<int dim>

typedef Eigen::Matrix< double,dim,1> model::LatticeVector< dim >::VectorDimD

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

◆ VectorDimD [2/2]

template<int dim>

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

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

◆ VectorDimI [1/2]

template<int dim>

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

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

◆ VectorDimI [2/2]

template<int dim>

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

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

Constructor & Destructor Documentation

◆ LatticeVector() [1/6]

template<int dim>

model::LatticeVector< dim >::LatticeVector ( const LatticeType & lat )

Parameters

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

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

◆ LatticeVector() [2/6]

template<int dim>

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

Parameters

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

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

◆ LatticeVector() [3/6]

template<int dim>

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

Parameters

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

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

◆ LatticeVector() [4/6]

template<int dim>

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

◆ LatticeVector() [5/6]

template<int dim>

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

◆ LatticeVector() [6/6]

template<int dim>

template<typename OtherDerived>

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

inline

Parameters

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

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

Member Function Documentation

◆ base() [1/2]

template<int dim>

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

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

◆ base() [2/2]

template<int dim>

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

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

◆ cartesian()

template<int dim>

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

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

◆ cross()

template<int dim>

LatticeVector< dim >::ReciprocalLatticeDirectionType model::LatticeVector< dim >::cross ( const LatticeVectorType & other ) const

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

◆ d2contra()

template<int dim>

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

static

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

◆ dot()

template<int dim>

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

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

◆ operator*()

template<int dim>

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

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

◆ operator+()

template<int dim>

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

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

◆ operator+=()

template<int dim>

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

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

◆ operator-()

template<int dim>

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

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

◆ operator-=()

template<int dim>

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

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

Member Data Documentation

◆ lattice

template<int dim>

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

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

◆ roundTol

template<int dim>

double model::LatticeVector< dim >::roundTol =FLT_EPSILON

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 [1/2]

◆ MatrixDimD [2/2]

◆ MatrixDimI

◆ ReciprocalLatticeDirectionType

◆ ReciprocalLatticeVectorType

◆ VectorDimD [1/2]

◆ VectorDimD [2/2]

◆ VectorDimI [1/2]

◆ VectorDimI [2/2]

Constructor & Destructor Documentation

◆ LatticeVector() [1/6]

◆ LatticeVector() [2/6]

◆ LatticeVector() [3/6]

◆ LatticeVector() [4/6]

◆ LatticeVector() [5/6]

◆ LatticeVector() [6/6]

Member Function Documentation

◆ base() [1/2]

◆ base() [2/2]

◆ cartesian()

◆ cross()

◆ d2contra()

◆ dot()

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

Member Data Documentation

◆ lattice

◆ roundTol