Skip to content

Class TempLat::WaveNumber

template <size_t NDim>

ClassList > TempLat > WaveNumber

A class which allows for accessing (unscaled, dimensionless, index-valued) various expressions involving the fourier coordinates. More...

  • #include <wavenumber.h>

Public Functions

Type Name
WaveNumber (device::memory::host_ptr< MemoryToolBox< NDim > > toolBox)
void confirmSpace (device::Idx i, const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
DEVICE_INLINE_FUNCTION auto eval (const IDX &... idx) const
auto norm () const
auto norm2 () const
auto operator() (Tag< N > t) const
auto vectorGet (Tag< N > t) const

Public Static Functions

Type Name
constexpr size_t getVectorSize ()
std::string toString (device::Idx j)
std::string toString ()

Detailed Description

Unit test: ctest -R test-wavenumber

@vocab-summary The Fourier coordinate of the current site, as an expression. Exposes the individual components and norm() / norm2(). Throws if evaluated in configuration space.

Public Functions Documentation

function WaveNumber

inline TempLat::WaveNumber::WaveNumber (
    device::memory::host_ptr < MemoryToolBox < NDim > > toolBox
)

function confirmSpace

inline void TempLat::WaveNumber::confirmSpace (
    device::Idx i,
    const LayoutStruct < NDim > & newLayout,
    const SpaceStateType & spaceType
) const

function eval

template<typename... IDX>
inline DEVICE_INLINE_FUNCTION auto TempLat::WaveNumber::eval (
    const IDX &... idx
) const

function norm

inline auto TempLat::WaveNumber::norm () const

function norm2

inline auto TempLat::WaveNumber::norm2 () const

function operator()

template<int N>
inline auto TempLat::WaveNumber::operator() (
    Tag < N > t
) const

function vectorGet

template<int N>
inline auto TempLat::WaveNumber::vectorGet (
    Tag < N > t
) const

Public Static Functions Documentation

function getVectorSize

static inline constexpr size_t TempLat::WaveNumber::getVectorSize ()

function toString [1/2]

static inline std::string TempLat::WaveNumber::toString (
    device::Idx j
)

function toString [2/2]

static inline std::string TempLat::WaveNumber::toString ()

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