oILAB
Loading...
Searching...
No Matches
Public Types | Public Member Functions
gbLAB::ReciprocalLatticeDirection< dim > Struct Template Reference

#include <ReciprocalLatticeDirection.h>

+ Inheritance diagram for gbLAB::ReciprocalLatticeDirection< dim >:

Public Types

typedef LatticeCore< dim >::IntScalarType IntScalarType
 
typedef LatticeCore< dim >::VectorDimD VectorDimD
 
typedef LatticeCore< dim >::VectorDimI VectorDimI
 

Public Member Functions

 ReciprocalLatticeDirection (const ReciprocalLatticeDirection< dim > &other)=default
 
 ReciprocalLatticeDirection (const ReciprocalLatticeVector< dim > &v)
 
 ReciprocalLatticeDirection (const VectorDimI &v, const Lattice< dim > &lat)
 
double planeSpacing () const
 Returns the spacing between two consecutive lattice planes.
 
int stacking () const
 Returns the number of planes in the stacking sequence.
 
const ReciprocalLatticeVector< dim > & reciprocalLatticeVector () const
 Returns a constant reference to the base class (ReciprocalLatticeVector)
 

Additional Inherited Members

- Protected Types inherited from gbLAB::ReciprocalLatticeVector< 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
 
- Protected Member Functions inherited from gbLAB::ReciprocalLatticeVector< dim >
 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
 
- Protected Attributes inherited from gbLAB::ReciprocalLatticeVector< dim >
const Lattice< dim > & lattice
 

Detailed Description

template<int dim>
struct gbLAB::ReciprocalLatticeDirection< dim >
Examples
testGb.cpp, testLattice.cpp, and testPlaneParallelLatticeDirections.cpp.

Definition at line 15 of file ReciprocalLatticeDirection.h.

Member Typedef Documentation

◆ IntScalarType

template<int dim>
typedef LatticeCore<dim>::IntScalarType gbLAB::ReciprocalLatticeDirection< dim >::IntScalarType

Definition at line 18 of file ReciprocalLatticeDirection.h.

◆ VectorDimD

template<int dim>
typedef LatticeCore<dim>::VectorDimD gbLAB::ReciprocalLatticeDirection< dim >::VectorDimD

Definition at line 19 of file ReciprocalLatticeDirection.h.

◆ VectorDimI

template<int dim>
typedef LatticeCore<dim>::VectorDimI gbLAB::ReciprocalLatticeDirection< dim >::VectorDimI

Definition at line 20 of file ReciprocalLatticeDirection.h.

Constructor & Destructor Documentation

◆ ReciprocalLatticeDirection() [1/3]

template<int dim>
gbLAB::ReciprocalLatticeDirection< dim >::ReciprocalLatticeDirection ( const ReciprocalLatticeDirection< dim > &  other)
default

◆ ReciprocalLatticeDirection() [2/3]

template<int dim>
gbLAB::ReciprocalLatticeDirection< dim >::ReciprocalLatticeDirection ( const ReciprocalLatticeVector< dim > &  v)

Definition at line 15 of file ReciprocalLatticeDirection.cpp.

◆ ReciprocalLatticeDirection() [3/3]

template<int dim>
gbLAB::ReciprocalLatticeDirection< dim >::ReciprocalLatticeDirection ( const VectorDimI &  v,
const Lattice< dim > &  lat 
)

Definition at line 21 of file ReciprocalLatticeDirection.cpp.

Member Function Documentation

◆ planeSpacing()

template<int dim>
double gbLAB::ReciprocalLatticeDirection< dim >::planeSpacing ( ) const

Returns the spacing between two consecutive lattice planes.

Returns
(double) spacing between two consecutive lattice planes

Definition at line 34 of file ReciprocalLatticeDirection.cpp.

◆ reciprocalLatticeVector()

template<int dim>
const ReciprocalLatticeVector< dim > & gbLAB::ReciprocalLatticeDirection< dim >::reciprocalLatticeVector ( ) const
inline

Returns a constant reference to the base class (ReciprocalLatticeVector)

Examples
testGb.cpp, and testLattice.cpp.

Definition at line 47 of file ReciprocalLatticeDirection.h.

◆ stacking()

template<int dim>
int gbLAB::ReciprocalLatticeDirection< dim >::stacking ( ) const

Returns the number of planes in the stacking sequence.

Returns
(integer) number of planes in the staking sequence
Examples
testLattice.cpp.

Definition at line 40 of file ReciprocalLatticeDirection.cpp.

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