#include <LatticePlane.h>

Collaboration diagram for model::LatticePlaneKey< dim >:

Public Types
typedef long int	LongIntType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< LongIntType, dim, 1 >	VectorDimI
typedef std::array< LongIntType, dim+2 >	ArrayType
typedef long int	LongIntType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< LongIntType, dim, 1 >	VectorDimI
typedef std::array< LongIntType, dim+2 >	ArrayType

Public Member Functions
	LatticePlaneKey (const VectorDimI &r, const LongIntType &h, const LongIntType &latticeID)
	LatticePlaneKey (const VectorDimD &P, const ReciprocalLatticeDirection< dim > &r)
	LatticePlaneKey (const LatticeVector< dim > &L, const ReciprocalLatticeDirection< dim > &r)
	LatticePlaneKey (const long int &hin, const ReciprocalLatticeDirection< dim > &r)
VectorDimI	reciprocalDirectionComponents () const
const LongIntType &	planeIndex () const
const LongIntType &	latticeID () const
bool	operator< (const LatticePlaneKey< dim > &other) const
	LatticePlaneKey (const VectorDimI &r, const LongIntType &h, const LongIntType &latticeID)
	LatticePlaneKey (const VectorDimD &P, const ReciprocalLatticeDirection< dim > &r)
	LatticePlaneKey (const LatticeVector< dim > &L, const ReciprocalLatticeDirection< dim > &r)
	LatticePlaneKey (const long int &hin, const ReciprocalLatticeDirection< dim > &r)
Eigen::Map< const VectorDimI >	reciprocalDirectionComponents () const
const LongIntType &	planeIndex () const
const LongIntType &	latticeID () const
bool	operator< (const LatticePlaneKey< dim > &other) const

Static Public Member Functions
static ArrayType	hr2array (const VectorDimI &r, const LongIntType &h, const LongIntType &latticeID)
static int	sgn (const LongIntType &val)
static ArrayType	correct_h_sign (VectorDimI r, LongIntType h, const LongIntType &latticeID)
static ArrayType	hr2array (const VectorDimI &r, const LongIntType &h, const LongIntType &latticeID)
static int	sgn (const LongIntType &val)
static ArrayType	correct_h_sign (VectorDimI r, LongIntType h, const LongIntType &latticeID)

Public Attributes
const ArrayType	array

Friends
template<class T>
T &	operator<< (T &os, const LatticePlaneKey< dim > &key)
template<class T>
T &	operator<< (T &os, const LatticePlaneKey< dim > &key)

Detailed Description

template<int dim>
struct model::LatticePlaneKey< dim >

Definition at line 19 of file Lattices/LatticePlane.h.

Member Typedef Documentation

◆ ArrayType [1/2]

template<int dim>

typedef std::array<LongIntType,dim+2> model::LatticePlaneKey< dim >::ArrayType

Definition at line 26 of file Lattices/LatticePlane.h.

◆ ArrayType [2/2]

template<int dim>

typedef std::array<LongIntType,dim+2> model::LatticePlaneKey< dim >::ArrayType

Definition at line 28 of file Lattices_NEW/LatticePlane.h.

◆ LongIntType [1/2]

template<int dim>

typedef long int model::LatticePlaneKey< dim >::LongIntType

Definition at line 23 of file Lattices/LatticePlane.h.

◆ LongIntType [2/2]

template<int dim>

typedef long int model::LatticePlaneKey< dim >::LongIntType

Definition at line 25 of file Lattices_NEW/LatticePlane.h.

◆ VectorDimD [1/2]

template<int dim>

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

Definition at line 24 of file Lattices/LatticePlane.h.

◆ VectorDimD [2/2]

template<int dim>

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

Definition at line 26 of file Lattices_NEW/LatticePlane.h.

◆ VectorDimI [1/2]

template<int dim>

typedef Eigen::Matrix<LongIntType,dim,1> model::LatticePlaneKey< dim >::VectorDimI

Definition at line 25 of file Lattices/LatticePlane.h.

◆ VectorDimI [2/2]

template<int dim>

typedef Eigen::Matrix<LongIntType,dim,1> model::LatticePlaneKey< dim >::VectorDimI

Definition at line 27 of file Lattices_NEW/LatticePlane.h.

Constructor & Destructor Documentation

◆ LatticePlaneKey() [1/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const VectorDimI &	r,
		const LongIntType &	h,
		const LongIntType &	latticeID )

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

◆ LatticePlaneKey() [2/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const VectorDimD &	P,
		const ReciprocalLatticeDirection< dim > &	r )

Definition at line 63 of file Lattices/LatticePlane.cpp.

◆ LatticePlaneKey() [3/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const LatticeVector< dim > &	L,
		const ReciprocalLatticeDirection< dim > &	r )

Definition at line 71 of file Lattices/LatticePlane.cpp.

◆ LatticePlaneKey() [4/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const long int &	hin,
		const ReciprocalLatticeDirection< dim > &	r )

Definition at line 79 of file Lattices/LatticePlane.cpp.

◆ LatticePlaneKey() [5/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const VectorDimI &	r,
		const LongIntType &	h,
		const LongIntType &	latticeID )

◆ LatticePlaneKey() [6/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const VectorDimD &	P,
		const ReciprocalLatticeDirection< dim > &	r )

◆ LatticePlaneKey() [7/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const LatticeVector< dim > &	L,
		const ReciprocalLatticeDirection< dim > &	r )

◆ LatticePlaneKey() [8/8]

template<int dim>

model::LatticePlaneKey< dim >::LatticePlaneKey	(	const long int &	hin,
		const ReciprocalLatticeDirection< dim > &	r )

Member Function Documentation

◆ correct_h_sign() [1/2]

template<int dim>

LatticePlaneKey< dim >::ArrayType model::LatticePlaneKey< dim >::correct_h_sign	(	VectorDimI	r,
		LongIntType	h,
		const LongIntType &	latticeID )

static

Definition at line 35 of file Lattices/LatticePlane.cpp.

◆ correct_h_sign() [2/2]

template<int dim>

ArrayType model::LatticePlaneKey< dim >::correct_h_sign	(	VectorDimI	r,
		LongIntType	h,
		const LongIntType &	latticeID )

static

◆ hr2array() [1/2]

template<int dim>

LatticePlaneKey< dim >::ArrayType model::LatticePlaneKey< dim >::hr2array	(	const VectorDimI &	r,
		const LongIntType &	h,
		const LongIntType &	latticeID )

static

Definition at line 16 of file Lattices/LatticePlane.cpp.

◆ hr2array() [2/2]

template<int dim>

ArrayType model::LatticePlaneKey< dim >::hr2array	(	const VectorDimI &	r,
		const LongIntType &	h,
		const LongIntType &	latticeID )

static

◆ latticeID() [1/2]

template<int dim>

const LatticePlaneKey< dim >::LongIntType & model::LatticePlaneKey< dim >::latticeID ( ) const

Definition at line 99 of file Lattices/LatticePlane.cpp.

◆ latticeID() [2/2]

template<int dim>

const LongIntType & model::LatticePlaneKey< dim >::latticeID ( ) const

◆ operator<() [1/2]

template<int dim>

bool model::LatticePlaneKey< dim >::operator< ( const LatticePlaneKey< dim > & other ) const

Definition at line 105 of file Lattices/LatticePlane.cpp.

◆ operator<() [2/2]

template<int dim>

bool model::LatticePlaneKey< dim >::operator< ( const LatticePlaneKey< dim > & other ) const

◆ planeIndex() [1/2]

template<int dim>

const LatticePlaneKey< dim >::LongIntType & model::LatticePlaneKey< dim >::planeIndex ( ) const

Definition at line 93 of file Lattices/LatticePlane.cpp.

◆ planeIndex() [2/2]

template<int dim>

const LongIntType & model::LatticePlaneKey< dim >::planeIndex ( ) const

◆ reciprocalDirectionComponents() [1/2]

template<int dim>

Eigen::Map< const typename LatticePlaneKey< dim >::VectorDimI > model::LatticePlaneKey< dim >::reciprocalDirectionComponents ( ) const

Definition at line 87 of file Lattices/LatticePlane.cpp.

◆ reciprocalDirectionComponents() [2/2]

template<int dim>

Eigen::Map< const VectorDimI > model::LatticePlaneKey< dim >::reciprocalDirectionComponents ( ) const

◆ sgn() [1/2]

template<int dim>

int model::LatticePlaneKey< dim >::sgn ( const LongIntType & val )

static

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

◆ sgn() [2/2]

template<int dim>

int model::LatticePlaneKey< dim >::sgn ( const LongIntType & val )

static

◆ operator<< [1/2]

template<int dim>

template<class T>

T & operator<<	(	T &	os,
		const LatticePlaneKey< dim > &	key )

friend

Definition at line 47 of file Lattices/LatticePlane.h.

◆ operator<< [2/2]

template<int dim>

template<class T>

T & operator<<	(	T &	os,
		const LatticePlaneKey< dim > &	key )

friend

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

Member Data Documentation

◆ array

template<int dim>

const ArrayType model::LatticePlaneKey< dim >::array

Definition at line 32 of file Lattices/LatticePlane.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ArrayType [1/2]

◆ ArrayType [2/2]

◆ LongIntType [1/2]

◆ LongIntType [2/2]

◆ VectorDimD [1/2]

◆ VectorDimD [2/2]

◆ VectorDimI [1/2]

◆ VectorDimI [2/2]

Constructor & Destructor Documentation

◆ LatticePlaneKey() [1/8]

◆ LatticePlaneKey() [2/8]

◆ LatticePlaneKey() [3/8]

◆ LatticePlaneKey() [4/8]

◆ LatticePlaneKey() [5/8]

◆ LatticePlaneKey() [6/8]

◆ LatticePlaneKey() [7/8]

◆ LatticePlaneKey() [8/8]

Member Function Documentation

◆ correct_h_sign() [1/2]

◆ correct_h_sign() [2/2]

◆ hr2array() [1/2]

◆ hr2array() [2/2]

◆ latticeID() [1/2]

◆ latticeID() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ planeIndex() [1/2]

◆ planeIndex() [2/2]

◆ reciprocalDirectionComponents() [1/2]

◆ reciprocalDirectionComponents() [2/2]

◆ sgn() [1/2]

◆ sgn() [2/2]

Friends And Related Symbol Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ array