Mechanics of Defect Evolution Library
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
model::GlidePlaneNoiseBase< N > Struct Template Reference

#include <GlidePlaneNoiseBase.h>

Inheritance diagram for model::GlidePlaneNoiseBase< N >:
Collaboration diagram for model::GlidePlaneNoiseBase< N >:

Public Types

typedef NoiseTraitsBase::REAL_SCALAR REAL_SCALAR
typedef NoiseTraitsBase::COMPLEX COMPLEX
typedef NoiseTraitsBase::GridSizeType GridSizeType
typedef NoiseTraitsBase::GridSpacingType GridSpacingType
typedef NoiseTraits< N >::NoiseType NoiseType
typedef NoiseTraits< N >::NoiseContainerType NoiseContainerType
Public Types inherited from model::UniformPeriodicGrid< 2 >
typedef Eigen::Array< int, dim, 1 > ArrayDimI
typedef Eigen::Array< double, dim, 1 > ArrayDimD

Public Member Functions

std::vector< COMPLEX * > originalKCorrelations () const
std::vector< COMPLEX * > noisyKCorrelations (const std::vector< COMPLEX * > &okCorr, std::default_random_engine &generator, std::normal_distribution< REAL_SCALAR > &distribution) const
std::vector< REAL_SCALAR * > realNoise (const std::vector< COMPLEX * > &nkCorr) const
std::vector< std::vector< double > > averageNoiseCorrelation (const int &reps) const
std::vector< std::vector< double > > sampleAverageNoise (const int &reps) const
 GlidePlaneNoiseBase (const std::string &tag_in, const int &seed_in, const NoiseTraitsBase::GridSizeType &gridSize_in, const NoiseTraitsBase::GridSpacingType &gridSpacing_SI_in, const Eigen::Matrix< double, 2, 2 > &latticeBasis)
virtual ~GlidePlaneNoiseBase ()
void computeRealNoise ()
void computeRealNoiseStatistics (const PolycrystallineMaterialBase &mat) const
GridSizeType rowAndColIndices (const int &storageIndex) const
int storageIndex (const int &i, const int &j) const
void writeFieldSlice () const
const NoiseContainerType & noiseVector () const
NoiseContainerType & noiseVector ()
virtual std::array< COMPLEX, N > kCorrelations (const Eigen::Matrix< double, 3, 1 > &k, const Eigen::Matrix< int, 3, 1 > &kID) const
Public Member Functions inherited from model::UniformPeriodicGrid< 2 >
 UniformPeriodicGrid (const ArrayDimI &gridSize_in, const ArrayDimD &gridSpacing_in)
std::array< ArrayDimI, CTM::pow(2, dim)> posToCornerIdx (const ArrayDimD &localPos) const
std::array< ArrayDimI, CTM::pow(2, dim)> posToPeriodicCornerIdx (const ArrayDimD &localPos) const
ArrayDimD idxToPos (const ArrayDimI &idx) const
std::array< double, CTM::pow(2, dim)> posToWeights (const ArrayDimD &localPos) const
std::pair< std::array< ArrayDimI, CTM::pow(2, dim)>, std::array< double, CTM::pow(2, dim)> > posToPeriodicCornerIdxAndWeights (const ArrayDimD &localPos) const
std::pair< ArrayDimI, ArrayDimI > posToIdx (const ArrayDimD &localPos) const
std::pair< ArrayDimI, ArrayDimI > posToPeriodicIdx (const ArrayDimD &localPos) const
ArrayDimI idxToPeriodicIdx (const ArrayDimI &gi) const

Static Public Member Functions

static REAL_SCALAR Wk_Cai (REAL_SCALAR kx, REAL_SCALAR ky, REAL_SCALAR kz, REAL_SCALAR a)
static REAL_SCALAR Wk_Cai_squared (REAL_SCALAR kx, REAL_SCALAR ky, REAL_SCALAR kz, REAL_SCALAR a)
static REAL_SCALAR W_Cai (REAL_SCALAR r2, REAL_SCALAR a)
static REAL_SCALAR W_t_Cai (REAL_SCALAR r2, REAL_SCALAR a)
Static Public Member Functions inherited from model::UniformPeriodicGrid< 2 >
static std::array< ArrayDimI, CTM::pow(2, dim)> cornerIdx (const std::pair< ArrayDimI, ArrayDimI > &idx)

Public Attributes

const std::string tag
const int seed
const GridSizeType gridSize
const GridSpacingType gridSpacing
const GridSpacingType gridLength
const Eigen::Matrix< double, 2, 2 > invTransposeLatticeBasis
const int & NX
const int & NY
const int & NZ
const int NK
const int NR
const double & LX
const double & LY
const double & LZ
Public Attributes inherited from model::UniformPeriodicGrid< 2 >
const ArrayDimI gridSize
const ArrayDimD gridSpacing

Detailed Description

template<int N>
struct model::GlidePlaneNoiseBase< N >

Definition at line 29 of file GlidePlaneNoiseBase.h.

Member Typedef Documentation

◆ COMPLEX

template<int N>
typedef NoiseTraitsBase::COMPLEX model::GlidePlaneNoiseBase< N >::COMPLEX

Definition at line 33 of file GlidePlaneNoiseBase.h.

◆ GridSizeType

template<int N>
typedef NoiseTraitsBase::GridSizeType model::GlidePlaneNoiseBase< N >::GridSizeType

Definition at line 34 of file GlidePlaneNoiseBase.h.

◆ GridSpacingType

template<int N>
typedef NoiseTraitsBase::GridSpacingType model::GlidePlaneNoiseBase< N >::GridSpacingType

Definition at line 35 of file GlidePlaneNoiseBase.h.

◆ NoiseContainerType

template<int N>
typedef NoiseTraits<N>::NoiseContainerType model::GlidePlaneNoiseBase< N >::NoiseContainerType

Definition at line 37 of file GlidePlaneNoiseBase.h.

◆ NoiseType

template<int N>
typedef NoiseTraits<N>::NoiseType model::GlidePlaneNoiseBase< N >::NoiseType

Definition at line 36 of file GlidePlaneNoiseBase.h.

◆ REAL_SCALAR

template<int N>
typedef NoiseTraitsBase::REAL_SCALAR model::GlidePlaneNoiseBase< N >::REAL_SCALAR

Definition at line 32 of file GlidePlaneNoiseBase.h.

Constructor & Destructor Documentation

◆ GlidePlaneNoiseBase()

template<int N>
model::GlidePlaneNoiseBase< N >::GlidePlaneNoiseBase ( const std::string & tag_in,
const int & seed_in,
const NoiseTraitsBase::GridSizeType & gridSize_in,
const NoiseTraitsBase::GridSpacingType & gridSpacing_SI_in,
const Eigen::Matrix< double, 2, 2 > & latticeBasis )

Definition at line 64 of file GlidePlaneNoiseBase.cpp.

◆ ~GlidePlaneNoiseBase()

template<int N>
virtual model::GlidePlaneNoiseBase< N >::~GlidePlaneNoiseBase ( )
inlinevirtual

Definition at line 85 of file GlidePlaneNoiseBase.h.

Member Function Documentation

◆ averageNoiseCorrelation()

template<int N>
std::vector< std::vector< double > > model::GlidePlaneNoiseBase< N >::averageNoiseCorrelation ( const int & reps) const

Definition at line 253 of file GlidePlaneNoiseBase.cpp.

◆ computeRealNoise()

template<int N>
void model::GlidePlaneNoiseBase< N >::computeRealNoise ( )

Definition at line 216 of file GlidePlaneNoiseBase.cpp.

◆ computeRealNoiseStatistics()

template<int N>
void model::GlidePlaneNoiseBase< N >::computeRealNoiseStatistics ( const PolycrystallineMaterialBase & mat) const

Definition at line 358 of file GlidePlaneNoiseBase.cpp.

◆ kCorrelations()

template<int N>
virtual std::array< COMPLEX, N > model::GlidePlaneNoiseBase< N >::kCorrelations ( const Eigen::Matrix< double, 3, 1 > & k,
const Eigen::Matrix< int, 3, 1 > & kID ) const
inlinevirtual

Reimplemented in model::AnalyticalSolidSolutionNoise, model::MDSolidSolutionNoise, and model::MDStackingFaultNoise.

Definition at line 94 of file GlidePlaneNoiseBase.h.

◆ noiseVector() [1/2]

template<int N>
GlidePlaneNoiseBase< N >::NoiseContainerType & model::GlidePlaneNoiseBase< N >::noiseVector ( )

Definition at line 94 of file GlidePlaneNoiseBase.cpp.

◆ noiseVector() [2/2]

template<int N>
const GlidePlaneNoiseBase< N >::NoiseContainerType & model::GlidePlaneNoiseBase< N >::noiseVector ( ) const

Definition at line 88 of file GlidePlaneNoiseBase.cpp.

◆ noisyKCorrelations()

template<int N>
std::vector< typename GlidePlaneNoiseBase< N >::COMPLEX * > model::GlidePlaneNoiseBase< N >::noisyKCorrelations ( const std::vector< COMPLEX * > & okCorr,
std::default_random_engine & generator,
std::normal_distribution< REAL_SCALAR > & distribution ) const

Definition at line 161 of file GlidePlaneNoiseBase.cpp.

◆ originalKCorrelations()

template<int N>
std::vector< typename GlidePlaneNoiseBase< N >::COMPLEX * > model::GlidePlaneNoiseBase< N >::originalKCorrelations ( ) const

Definition at line 110 of file GlidePlaneNoiseBase.cpp.

◆ realNoise()

template<int N>
std::vector< typename GlidePlaneNoiseBase< N >::REAL_SCALAR * > model::GlidePlaneNoiseBase< N >::realNoise ( const std::vector< COMPLEX * > & nkCorr) const

Definition at line 193 of file GlidePlaneNoiseBase.cpp.

◆ rowAndColIndices()

template<int N>
GridSizeType model::GlidePlaneNoiseBase< N >::rowAndColIndices ( const int & storageIndex) const

◆ sampleAverageNoise()

template<int N>
std::vector< std::vector< double > > model::GlidePlaneNoiseBase< N >::sampleAverageNoise ( const int & reps) const

Definition at line 315 of file GlidePlaneNoiseBase.cpp.

◆ storageIndex()

template<int N>
int model::GlidePlaneNoiseBase< N >::storageIndex ( const int & i,
const int & j ) const
Parameters
[in]localPosthe position vector on the grid
Returns
The grid index periodically wrapped within the gridSize bounds

Definition at line 100 of file GlidePlaneNoiseBase.cpp.

◆ W_Cai()

template<int N>
GlidePlaneNoiseBase< N >::REAL_SCALAR model::GlidePlaneNoiseBase< N >::W_Cai ( REAL_SCALAR r2,
REAL_SCALAR a )
static

Definition at line 52 of file GlidePlaneNoiseBase.cpp.

◆ W_t_Cai()

template<int N>
GlidePlaneNoiseBase< N >::REAL_SCALAR model::GlidePlaneNoiseBase< N >::W_t_Cai ( REAL_SCALAR r2,
REAL_SCALAR a )
static

Definition at line 58 of file GlidePlaneNoiseBase.cpp.

◆ Wk_Cai()

template<int N>
GlidePlaneNoiseBase< N >::REAL_SCALAR model::GlidePlaneNoiseBase< N >::Wk_Cai ( REAL_SCALAR kx,
REAL_SCALAR ky,
REAL_SCALAR kz,
REAL_SCALAR a )
static

Definition at line 21 of file GlidePlaneNoiseBase.cpp.

◆ Wk_Cai_squared()

template<int N>
GlidePlaneNoiseBase< N >::REAL_SCALAR model::GlidePlaneNoiseBase< N >::Wk_Cai_squared ( REAL_SCALAR kx,
REAL_SCALAR ky,
REAL_SCALAR kz,
REAL_SCALAR a )
static

Definition at line 36 of file GlidePlaneNoiseBase.cpp.

◆ writeFieldSlice()

template<int N>
void model::GlidePlaneNoiseBase< N >::writeFieldSlice ( ) const

Member Data Documentation

◆ gridLength

template<int N>
const GridSpacingType model::GlidePlaneNoiseBase< N >::gridLength

Definition at line 63 of file GlidePlaneNoiseBase.h.

◆ gridSize

template<int N>
const GridSizeType model::GlidePlaneNoiseBase< N >::gridSize

Definition at line 61 of file GlidePlaneNoiseBase.h.

◆ gridSpacing

template<int N>
const GridSpacingType model::GlidePlaneNoiseBase< N >::gridSpacing

Definition at line 62 of file GlidePlaneNoiseBase.h.

◆ invTransposeLatticeBasis

template<int N>
const Eigen::Matrix<double,2,2> model::GlidePlaneNoiseBase< N >::invTransposeLatticeBasis

Definition at line 64 of file GlidePlaneNoiseBase.h.

◆ LX

template<int N>
const double& model::GlidePlaneNoiseBase< N >::LX

Definition at line 70 of file GlidePlaneNoiseBase.h.

◆ LY

template<int N>
const double& model::GlidePlaneNoiseBase< N >::LY

Definition at line 71 of file GlidePlaneNoiseBase.h.

◆ LZ

template<int N>
const double& model::GlidePlaneNoiseBase< N >::LZ

Definition at line 72 of file GlidePlaneNoiseBase.h.

◆ NK

template<int N>
const int model::GlidePlaneNoiseBase< N >::NK

Definition at line 68 of file GlidePlaneNoiseBase.h.

◆ NR

template<int N>
const int model::GlidePlaneNoiseBase< N >::NR

Definition at line 69 of file GlidePlaneNoiseBase.h.

◆ NX

template<int N>
const int& model::GlidePlaneNoiseBase< N >::NX

Definition at line 65 of file GlidePlaneNoiseBase.h.

◆ NY

template<int N>
const int& model::GlidePlaneNoiseBase< N >::NY

Definition at line 66 of file GlidePlaneNoiseBase.h.

◆ NZ

template<int N>
const int& model::GlidePlaneNoiseBase< N >::NZ

Definition at line 67 of file GlidePlaneNoiseBase.h.

◆ seed

template<int N>
const int model::GlidePlaneNoiseBase< N >::seed

Definition at line 60 of file GlidePlaneNoiseBase.h.

◆ tag

template<int N>
const std::string model::GlidePlaneNoiseBase< N >::tag

Definition at line 59 of file GlidePlaneNoiseBase.h.

The documentation for this struct was generated from the following files:
Generated by doxygen 1.15.0