Skip to content

Class TempLat::DimensionCountRecorder

template <size_t NDim>

ClassList > TempLat > DimensionCountRecorder

A super class which records the number of dimensions on any call to confirmSpace. More...

  • #include <dimensioncountrecorder.h>

Inherited by the following classes: TempLat::BDPhaseHelper, TempLat::RandomGaussianFieldHelper

Public Functions

Type Name
DimensionCountRecorder (SpaceStateType spaceType)
void confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
When making sure everyone is in configuration or fourier space, steal the number of dimensions, which we need in the coordinate manipulating objects..
DEVICE_FORCEINLINE_FUNCTION const LayoutStruct< NDim > & getCurrentLayout () const
SpaceStateType getCurrentSpaceType () const
std::string toString () const

Public Static Functions

Type Name
constexpr device::Idx getNDimensions ()

Detailed Description

The constructor takes one argument, which is used by the derived classes which insist on a single space only: WaveNumber and SpatialCoordinate.

Unit test: ctest -R test-dimensioncountrecorder

Public Functions Documentation

function DimensionCountRecorder

inline TempLat::DimensionCountRecorder::DimensionCountRecorder (
    SpaceStateType spaceType
)

function confirmSpace

When making sure everyone is in configuration or fourier space, steal the number of dimensions, which we need in the coordinate manipulating objects.. 

inline void TempLat::DimensionCountRecorder::confirmSpace (
    const LayoutStruct < NDim > & newLayout,
    const SpaceStateType & spaceType
) const

function getCurrentLayout

inline DEVICE_FORCEINLINE_FUNCTION const LayoutStruct < NDim > & TempLat::DimensionCountRecorder::getCurrentLayout () const

function getCurrentSpaceType

inline SpaceStateType TempLat::DimensionCountRecorder::getCurrentSpaceType () const

function toString

inline std::string TempLat::DimensionCountRecorder::toString () const

Public Static Functions Documentation

function getNDimensions

static inline constexpr device::Idx TempLat::DimensionCountRecorder::getNDimensions ()

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/algebra/coordinates/dimensioncountrecorder.h