Mechanics of Defect Evolution Library
Loading...
Searching...
No Matches
model::ReciprocalLatticeVector< 3 > Class Reference

#include <ReciprocalLatticeVector.h>

Inheritance diagram for model::ReciprocalLatticeVector< 3 >:
Collaboration diagram for model::ReciprocalLatticeVector< 3 >:

Public Types

typedef LatticeCore< 3 >::VectorDimD VectorDimD
typedef LatticeCore< 3 >::MatrixDimD MatrixDimD
typedef LatticeCore< 3 >::VectorDimI VectorDimI
typedef LatticeCore< 3 >::MatrixDimI MatrixDimI
typedef Eigen::Matrix< long int, dim, 1 > BaseType
typedef Lattice< dim > LatticeType
typedef ReciprocalLatticeVector< dim > ReciprocalLatticeVectorType
typedef LatticeVector< dim > LatticeVectorType
typedef LatticeDirection< dim > LatticeDirectionType
Public Types inherited from model::ReciprocalLatticeVectorBase< 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 Types inherited from model::ReciprocalLatticeVectorBase< 3 >
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

 ReciprocalLatticeVector (const Lattice< 3 > &lat)
 ReciprocalLatticeVector (const VectorDimD &d, const Lattice< 3 > &lat)
template<typename OtherDerived>
 ReciprocalLatticeVector (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< 3 > &lat)
LatticeDirection< 3 > cross (const ReciprocalLatticeVectorBase< 3 > &other) const
BaseType & base ()
ReciprocalLatticeVectorType operator+ (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType & operator+= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType operator- (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType & operator-= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType operator* (const long int &scalar) const
long int dot (const LatticeVectorType &other) const
VectorDimD cartesian () const
double planeSpacing () const
VectorDimD interplaneVector () const
long int closestPlaneIndexOfPoint (const VectorDimD &P) const
long int planeIndexOfPoint (const VectorDimD &P) const
Public Member Functions inherited from model::ReciprocalLatticeVectorBase< dim >
 ReciprocalLatticeVectorBase (const Lattice< dim > &lat)
 ReciprocalLatticeVectorBase (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
 ReciprocalLatticeVectorBase (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
 ReciprocalLatticeVectorBase (const ReciprocalLatticeVectorBase< dim > &other)=default
 ReciprocalLatticeVectorBase (ReciprocalLatticeVectorBase< dim > &&other)=default
ReciprocalLatticeVectorBase< dim > & operator= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > & operator= (ReciprocalLatticeVectorBase< dim > &&other)
ReciprocalLatticeVectorBase< dim > operator+ (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > & operator+= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > operator- (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > & operator-= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > operator* (const IntScalarType &scalar) const
IntScalarType dot (const LatticeVector< dim > &other) const
VectorDimD cartesian () const
double planeSpacing () const
VectorDimD interplaneVector () const
IntScalarType closestPlaneIndexOfPoint (const VectorDimD &P) const
IntScalarType planeIndexOfPoint (const VectorDimD &P) const
IntScalarType planeIndexOfPoint (const LatticeVector< dim > &P) const
Public Member Functions inherited from model::ReciprocalLatticeVectorBase< 3 >
 ReciprocalLatticeVectorBase (const Lattice< dim > &lat)
ReciprocalLatticeVectorBase< dim > & operator= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > operator+ (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > & operator+= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > operator- (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > & operator-= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > operator* (const IntScalarType &scalar) const
IntScalarType dot (const LatticeVector< dim > &other) const
VectorDimD cartesian () const
double planeSpacing () const
VectorDimD interplaneVector () const
IntScalarType closestPlaneIndexOfPoint (const VectorDimD &P) const
IntScalarType planeIndexOfPoint (const VectorDimD &P) const

Static Public Member Functions

static VectorDimI d2cov (const VectorDimD &d, const LatticeType &lat)

Public Attributes

const LatticeType & lattice
Public Attributes inherited from model::ReciprocalLatticeVectorBase< dim >
const Lattice< dim > & lattice
Public Attributes inherited from model::ReciprocalLatticeVectorBase< 3 >
const Lattice< dim > & lattice

Static Public Attributes

static constexpr double roundTol

Detailed Description

Definition at line 92 of file Lattices_NEW/ReciprocalLatticeVector.h.

Member Typedef Documentation

◆ BaseType

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

Definition at line 29 of file Lattices/ReciprocalLatticeVector.h.

◆ LatticeDirectionType

typedef LatticeDirection<dim> model::ReciprocalLatticeVector< dim >::LatticeDirectionType

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

◆ LatticeType

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

Definition at line 30 of file Lattices/ReciprocalLatticeVector.h.

◆ LatticeVectorType

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

Definition at line 40 of file Lattices/ReciprocalLatticeVector.h.

◆ MatrixDimD

typedef LatticeCore<3>::MatrixDimD model::ReciprocalLatticeVector< 3 >::MatrixDimD

Definition at line 99 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ MatrixDimI

typedef LatticeCore<3>::MatrixDimI model::ReciprocalLatticeVector< 3 >::MatrixDimI

Definition at line 101 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ ReciprocalLatticeVectorType

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

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

◆ VectorDimD

typedef LatticeCore<3>::VectorDimD model::ReciprocalLatticeVector< 3 >::VectorDimD

Definition at line 98 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ VectorDimI

typedef LatticeCore<3>::VectorDimI model::ReciprocalLatticeVector< 3 >::VectorDimI

Definition at line 100 of file Lattices_NEW/ReciprocalLatticeVector.h.

Constructor & Destructor Documentation

◆ ReciprocalLatticeVector() [1/3]

model::ReciprocalLatticeVector< 3 >::ReciprocalLatticeVector ( const Lattice< 3 > & lat)
Parameters
[in]dvector in real space Constructs *this by mapping d to the lattice

Definition at line 202 of file Lattices_NEW/ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [2/3]

model::ReciprocalLatticeVector< 3 >::ReciprocalLatticeVector ( const VectorDimD & d,
const Lattice< 3 > & lat )
Parameters
[in]dvector in real space Constructs *this by mapping d to the lattice

Definition at line 209 of file Lattices_NEW/ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [3/3]

template<typename OtherDerived>
model::ReciprocalLatticeVector< 3 >::ReciprocalLatticeVector ( const Eigen::MatrixBase< OtherDerived > & other,
const Lattice< 3 > & lat )
inline
Parameters
[in]dvector in real space Constructs *this by mapping d to the lattice

Definition at line 108 of file Lattices_NEW/ReciprocalLatticeVector.h.

Member Function Documentation

◆ base()

◆ cartesian()

◆ closestPlaneIndexOfPoint()

long int model::ReciprocalLatticeVector< dim >::closestPlaneIndexOfPoint ( const VectorDimD & P) const

Definition at line 59 of file Lattices/ReciprocalLatticeVector.cpp.

◆ cross()

LatticeDirection< 3 > model::ReciprocalLatticeVector< 3 >::cross ( const ReciprocalLatticeVectorBase< 3 > & other) const

Definition at line 217 of file Lattices_NEW/ReciprocalLatticeVector.cpp.

◆ d2cov()

ReciprocalLatticeVector< dim >::VectorDimI model::ReciprocalLatticeVector< dim >::d2cov ( const VectorDimD & d,
const LatticeType & lat )
static

Definition at line 56 of file Lattices/ReciprocalLatticeVector.cpp.

◆ dot()

long int model::ReciprocalLatticeVector< dim >::dot ( const LatticeVectorType & other) const

Definition at line 53 of file Lattices/ReciprocalLatticeVector.cpp.

◆ interplaneVector()

ReciprocalLatticeVector< dim >::VectorDimD model::ReciprocalLatticeVector< dim >::interplaneVector ( ) const

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

◆ operator*()

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

Definition at line 52 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ planeIndexOfPoint()

long int model::ReciprocalLatticeVector< dim >::planeIndexOfPoint ( const VectorDimD & P) const

Definition at line 60 of file Lattices/ReciprocalLatticeVector.cpp.

◆ planeSpacing()

double model::ReciprocalLatticeVector< dim >::planeSpacing ( ) const

Definition at line 57 of file Lattices/ReciprocalLatticeVector.cpp.

Member Data Documentation

◆ lattice

Definition at line 43 of file Lattices/ReciprocalLatticeVector.h.

◆ roundTol

double model::ReciprocalLatticeVector< dim >::roundTol
staticconstexpr

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


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