Class TempLat::FourierView

template <typename T, size_t _NDim>

ClassList > TempLat > FourierView

A view on the field which, when interacted with, assures every time again that things are in fourier space, and possibly the ghost cells are updated when needed.More...

#include <fieldviewfourier.h>

Inherits the following classes: TempLat::AbstractField

Public Static Attributes

Type	Name
constexpr size_t	NDim = `\_NDim`

Public Static Attributes inherited from TempLat::AbstractField

See TempLat::AbstractField

Type	Name
constexpr size_t	NDim = `\_NDim`

Public Functions

Type	Name
void	assign (R && g)
void	assign (R && g)
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
DEVICE_INLINE_FUNCTION auto	eval (const IDX &... idx) const
auto	getFullNDHostView () const
const auto &	getLayout () const
auto	getLocalNDHostView () const
auto	getRawHostView () const
DEVICE_INLINE_FUNCTION complex< T > &	getSet (const IDX &... idx) const
auto	getView () const
void	onBeforeAssignment (R && g)
void	operator= (R && g)
void	setZeroMode (const complex< T > & toSet)
std::string	toString () const
std::string	to_string () const

Public Functions inherited from TempLat::AbstractField

See TempLat::AbstractField

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 inherited from TempLat::AbstractField

See TempLat::AbstractField

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

Detailed Description

No public constructor: only the friend class Field can instantiate this view on its own memory.

Unit test: ctest -R test-fieldviewconfig

Public Static Attributes Documentation

variable NDim

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

Public Functions Documentation

function assign [1/2]

template<typename R>
inline void TempLat::FourierView::assign (
    R && g
)

function assign [2/2]

template<typename R>
inline void TempLat::FourierView::assign (
    R && g
)

function confirmSpace

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

function eval

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

function getFullNDHostView

inline auto TempLat::FourierView::getFullNDHostView () const

function getLayout

inline const auto & TempLat::FourierView::getLayout () const

function getLocalNDHostView

inline auto TempLat::FourierView::getLocalNDHostView () const

function getRawHostView

inline auto TempLat::FourierView::getRawHostView () const

function getSet

template<typename... IDX>
inline DEVICE_INLINE_FUNCTION complex< T > & TempLat::FourierView::getSet (
    const IDX &... idx
) const

function getView

inline auto TempLat::FourierView::getView () const

function onBeforeAssignment

template<typename R>
inline void TempLat::FourierView::onBeforeAssignment (
    R && g
)

function operator=

template<typename R>
inline void TempLat::FourierView::operator= (
    R && g
)

function setZeroMode

template<typename... Args>
inline void TempLat::FourierView::setZeroMode (
    const complex< T > & toSet
)

function toString

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

function to_string

inline std::string TempLat::FourierView::to_string () const

Friends Documentation

friend Field

template<typename S, size_t __NDim>
class TempLat::FourierView::Field (
    Field
)

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