Skip to content

Class TempLat::SpaceStateInterface

template <size_t NDim>

ClassList > TempLat > SpaceStateInterface

An interface class which all getter-like objects inherit from, so we can access their confirm(Config/Fourier)Space methods by their virtualness. More...

  • #include <spacestateinterface.h>

Public Functions

Type Name
virtual void confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) = 0
A preparation function: pass this call to all the members in the tree / chain, make sure everyone is in configuration or fourier space, and everyone has the actual same layout.
virtual device::memory::host_ptr< MemoryToolBox< 3 > > getToolBox () = 0
A preparation function: pass this call to all the members in the tree / chain. We only want to update ghost cells on those fields where this expression tree actually uses a spatially shifted view (which needs ghost cells). So only such views have permission to toggle the value of the detector to true. The Fields on the receiving end of this chain, then update ghosts.

Public Static Functions

Type Name
std::string SpaceTypeString (SpaceStateType st)
std::string SpaceTypetoCanonicalCharacter (SpaceStateType st)

Detailed Description

Unit test: ctest -R test-spacestateinterface

Public Functions Documentation

function confirmSpace

A preparation function: pass this call to all the members in the tree / chain, make sure everyone is in configuration or fourier space, and everyone has the actual same layout. 

virtual void TempLat::SpaceStateInterface::confirmSpace (
    const LayoutStruct < NDim > & newLayout,
    const SpaceStateType & spaceType
) = 0

function getToolBox

A preparation function: pass this call to all the members in the tree / chain. We only want to update ghost cells on those fields where this expression tree actually uses a spatially shifted view (which needs ghost cells). So only such views have permission to toggle the value of the detector to true. The Fields on the receiving end of this chain, then update ghosts. 

inline virtual device::memory::host_ptr < MemoryToolBox < 3 > > TempLat::SpaceStateInterface::getToolBox () = 0

For measurement objects.

Public Static Functions Documentation

function SpaceTypeString

static inline std::string TempLat::SpaceStateInterface::SpaceTypeString (
    SpaceStateType st
)

function SpaceTypetoCanonicalCharacter

static inline std::string TempLat::SpaceStateInterface::SpaceTypetoCanonicalCharacter (
    SpaceStateType st
)

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