model::LatticePlane Struct Reference

#include <LatticePlane.h>

Inheritance diagram for model::LatticePlane:

Collaboration diagram for model::LatticePlane:

Public Types
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef LatticeVector< dim >	LatticeVectorType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef LatticeVector< dim >	LatticeVectorType

Public Member Functions
	LatticePlane (const VectorDimD &P, const ReciprocalLatticeDirection< dim > &r)
	LatticePlane (const LatticeVector< dim > &L, const ReciprocalLatticeDirection< dim > &r)
	LatticePlane (const long int &hin, const ReciprocalLatticeDirection< dim > &r)
VectorDimD	planeOrigin () const
	LatticePlane (const VectorDimD &P, const ReciprocalLatticeDirection< dim > &r)
	LatticePlane (const LatticeVector< dim > &L, const ReciprocalLatticeDirection< dim > &r)
	LatticePlane (const long int &hin, const ReciprocalLatticeDirection< dim > &r)
VectorDimD	planeOrigin () const

Static Public Member Functions
static std::pair< bool, long int >	computeHeight (const ReciprocalLatticeDirection< dim > &r, const VectorDimD &P)
static std::pair< bool, long int >	computeHeight (const ReciprocalLatticeDirection< dim > &r, const LatticeVector< dim > &L)
static std::pair< bool, long int >	computeHeight (const ReciprocalLatticeDirection< dim > &r, const VectorDimD &P)
static std::pair< bool, long int >	computeHeight (const ReciprocalLatticeDirection< dim > &r, const LatticeVector< dim > &L)

Public Attributes
const LatticePlaneKey< dim >	key
const ReciprocalLatticeDirection< dim >	n
const LatticePlaneKey< dim >::LongIntType	planeIndex

Static Public Attributes
static constexpr int	dim =3

Detailed Description

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

Member Typedef Documentation

LatticeVectorType [1/2]

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

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

LatticeVectorType [2/2]

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

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

VectorDimD [1/2]

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

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

VectorDimD [2/2]

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

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

Constructor & Destructor Documentation

LatticePlane() [1/6]

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

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

LatticePlane() [2/6]

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

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

LatticePlane() [3/6]

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

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

LatticePlane() [4/6]

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

LatticePlane() [5/6]

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

LatticePlane() [6/6]

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

Member Function Documentation

computeHeight() [1/4]

std::pair< bool, long int > model::LatticePlane::computeHeight ( const ReciprocalLatticeDirection< dim > & r, const LatticeVector< dim > & L )

static

????

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

computeHeight() [2/4]

std::pair< bool, long int > model::LatticePlane::computeHeight ( const ReciprocalLatticeDirection< dim > & r, const LatticeVector< dim > & L )

static

computeHeight() [3/4]

std::pair< bool, long int > model::LatticePlane::computeHeight ( const ReciprocalLatticeDirection< dim > & r, const VectorDimD & P )

static

????

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

computeHeight() [4/4]

std::pair< bool, long int > model::LatticePlane::computeHeight ( const ReciprocalLatticeDirection< dim > & r, const VectorDimD & P )

static

planeOrigin() [1/2]

LatticePlane::VectorDimD model::LatticePlane::planeOrigin

(

)

const

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

planeOrigin() [2/2]

VectorDimD model::LatticePlane::planeOrigin

(

)

const

Member Data Documentation

dim

constexpr int model::LatticePlane::dim =3

staticconstexpr

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

key

const LatticePlaneKey< dim > model::LatticePlane::key

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

n

const ReciprocalLatticeDirection< dim > model::LatticePlane::n

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

planeIndex

const LatticePlaneKey< dim >::LongIntType model::LatticePlane::planeIndex

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

---

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

• Lattices/LatticePlane.h
• Lattices_NEW/LatticePlane.h
• Lattices/LatticePlane.cpp
• Lattices_NEW/LatticePlane.cpp