Class TempLat::AbstractField

template <typename T, size_t _NDim>

ClassList > TempLat > AbstractField

A base class for a one-component field, providing common functionality and holding relevant pointers to memory tools.

#include <abstractfield.h>

Inherited by the following classes: TempLat::ConfigView, TempLat::FourierView, TempLat::ConfigView, TempLat::FourierView

Public Static Attributes

Type	Name
constexpr size_t	NDim = `\_NDim`

Public Functions

Type	Name
	AbstractField (std::string name, device::memory::host_ptr< MemoryToolBox< NDim > > toolBox, LatticeParameters< T > pLatPar)
bool	areGhostsStale () const
device::Idx	confirmGhostsUpToDate () const
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
auto	getDx () const
auto	getKIR () const
auto	getLatParams () const
device::memory::host_ptr< MemoryManager< T, NDim > >	getMemoryManager () const
device::memory::host_ptr< MemoryToolBox< NDim > >	getToolBox () const
bool	isConfigSpace () const Check the current state.
bool	isFourierSpace () const Check the current state.
void	setGhostsAreStale () const

Protected Attributes

Type	Name
const LatticeParameters< T >	latPar
device::memory::host_ptr< MemoryManager< T, NDim > >	mManager
device::memory::host_ptr< MemoryToolBox< NDim > >	mToolBox

Public Static Attributes Documentation

variable NDim

constexpr size_t TempLat::AbstractField< T, _NDim >::NDim;

Public Functions Documentation

function AbstractField

inline TempLat::AbstractField::AbstractField (
    std::string name,
    device::memory::host_ptr < MemoryToolBox < NDim > > toolBox,
    LatticeParameters < T > pLatPar
)

function areGhostsStale

inline bool TempLat::AbstractField::areGhostsStale () const

function confirmGhostsUpToDate

inline device::Idx TempLat::AbstractField::confirmGhostsUpToDate () const

function confirmSpace

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

function getDx

inline auto TempLat::AbstractField::getDx () const

function getKIR

inline auto TempLat::AbstractField::getKIR () const

function getLatParams

inline auto TempLat::AbstractField::getLatParams () const

function getMemoryManager

inline device::memory::host_ptr < MemoryManager < T, NDim > > TempLat::AbstractField::getMemoryManager () const

function getToolBox

inline device::memory::host_ptr < MemoryToolBox < NDim > > TempLat::AbstractField::getToolBox () const

function isConfigSpace

Check the current state.

inline bool TempLat::AbstractField::isConfigSpace () const

Returns:

true if in configuration space

function isFourierSpace

Check the current state.

inline bool TempLat::AbstractField::isFourierSpace () const

Returns:

true if in fourier space

function setGhostsAreStale

inline void TempLat::AbstractField::setGhostsAreStale () const

Protected Attributes Documentation

variable latPar

const LatticeParameters<T> TempLat::AbstractField< T, _NDim >::latPar;

variable mManager

device::memory::host_ptr<MemoryManager<T, NDim> > TempLat::AbstractField< T, _NDim >::mManager;

variable mToolBox

device::memory::host_ptr<MemoryToolBox<NDim> > TempLat::AbstractField< T, _NDim >::mToolBox;

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