Mechanics of Defect Evolution Library
Loading...
Searching...
No Matches
model::LatticeDirection< dim > Struct Template Reference

#include <LatticeDirection.h>

Inheritance diagram for model::LatticeDirection< dim >:
Collaboration diagram for model::LatticeDirection< dim >:

Public Types

typedef LatticeGCD< dim > LatticeGCDType
typedef LatticeVector< dim > LatticeVectorType
typedef ReciprocalLatticeVector< dim > ReciprocalLatticeVectorType
typedef Eigen::Matrix< double, dim, 1 > VectorDimD
typedef Eigen::Matrix< long int, dim, 1 > VectorDimI
typedef LatticeCore< dim >::IntScalarType IntScalarType
Public Types inherited from model::LatticeVector< dim >
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

 LatticeDirection (const LatticeVectorType &v)
 LatticeDirection (const VectorDimI &v, const Lattice< dim > &lat)
 LatticeDirection (const ReciprocalLatticeVectorType &r1, const ReciprocalLatticeVectorType &r2)
LatticeVectorType snapToLattice (const VectorDimD &dP) const
VectorDimD snapToDirection (const VectorDimD &dP) const
 LatticeDirection (const LatticeVector< dim > &v)
Public Member Functions inherited from model::LatticeVector< dim >
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

Additional Inherited Members

Static Public Member Functions inherited from model::LatticeVector< dim >
static VectorDimI d2contra (const VectorDimD &d, const LatticeType &lat)
Public Attributes inherited from model::LatticeVector< dim >
const LatticeType & lattice
Public Attributes inherited from model::LatticeVectorBase< dim >
const Lattice< dim > & lattice
Static Public Attributes inherited from model::LatticeVector< dim >
static constexpr double roundTol =FLT_EPSILON

Detailed Description

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

Definition at line 18 of file Lattices/LatticeDirection.h.

Member Typedef Documentation

◆ IntScalarType

template<int dim>
typedef LatticeCore<dim>::IntScalarType model::LatticeDirection< dim >::IntScalarType

Definition at line 17 of file Lattices_NEW/LatticeDirection.h.

◆ LatticeGCDType

template<int dim>
typedef LatticeGCD<dim> model::LatticeDirection< dim >::LatticeGCDType

Definition at line 20 of file Lattices/LatticeDirection.h.

◆ LatticeVectorType

template<int dim>
typedef LatticeVector<dim> model::LatticeDirection< dim >::LatticeVectorType

Definition at line 21 of file Lattices/LatticeDirection.h.

◆ ReciprocalLatticeVectorType

template<int dim>
typedef ReciprocalLatticeVector<dim> model::LatticeDirection< dim >::ReciprocalLatticeVectorType

Definition at line 22 of file Lattices/LatticeDirection.h.

◆ VectorDimD

template<int dim>
typedef Eigen::Matrix<double,dim,1> model::LatticeDirection< dim >::VectorDimD

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

◆ VectorDimI

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

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

Constructor & Destructor Documentation

◆ LatticeDirection() [1/4]

template<int dim>
model::LatticeDirection< dim >::LatticeDirection ( const LatticeVectorType & v)

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

◆ LatticeDirection() [2/4]

template<int dim>
model::LatticeDirection< dim >::LatticeDirection ( const VectorDimI & v,
const Lattice< dim > & lat )

Definition at line 22 of file Lattices/LatticeDirection.cpp.

◆ LatticeDirection() [3/4]

template<int dim>
model::LatticeDirection< dim >::LatticeDirection ( const ReciprocalLatticeVectorType & r1,
const ReciprocalLatticeVectorType & r2 )

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

◆ LatticeDirection() [4/4]

template<int dim>
model::LatticeDirection< dim >::LatticeDirection ( const LatticeVector< dim > & v)

Member Function Documentation

◆ snapToDirection()

template<int dim>
LatticeDirection< dim >::VectorDimD model::LatticeDirection< dim >::snapToDirection ( const VectorDimD & dP) const

Definition at line 46 of file Lattices/LatticeDirection.cpp.

◆ snapToLattice()

template<int dim>
LatticeDirection< dim >::LatticeVectorType model::LatticeDirection< dim >::snapToLattice ( const VectorDimD & dP) const
Parameters
[in]dPa cartesian input vector
Returns
the closest lattice vector corresponding to the projection of dP on *this LatticeDirection.

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


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