Skip to content

Class TempLat::SpatialCoordinate

template <size_t NDim>

ClassList > TempLat > SpatialCoordinate

A class which implements spatial coordinates. More...

  • #include <spatialcoordinate.h>

Public Functions

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

Public Static Functions

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

Detailed Description

Unit test: ctest -R test-spatialcoordinate

@vocab-summary The position of the current site, as an expression. Throws if evaluated in Fourier space. @vocab-tags Field

Public Functions Documentation

function SpatialCoordinate

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

function confirmGhostsUpToDate

template<int N>
inline device::Idx TempLat::SpatialCoordinate::confirmGhostsUpToDate (
    Tag < N > i
) const

function confirmSpace

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

function doWeNeedGhosts

inline void TempLat::SpatialCoordinate::doWeNeedGhosts (
    device::Idx i
) const

function eval

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

function getToolBox

inline auto TempLat::SpatialCoordinate::getToolBox () const

function operator()

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

function vectorGet

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

Public Static Functions Documentation

function getVectorSize

static inline constexpr device::Idx TempLat::SpatialCoordinate::getVectorSize ()

function toString [1/2]

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

function toString [2/2]

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

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