Skip to content

Class TempLat::GetVectorComponentHelper

template <int N, typename R>

ClassList > TempLat > GetVectorComponentHelper

A class which returns one component of a vector as an object, keeping all fourier and co mechanics consistent. Mostly useful for wave numbers. More...

  • #include <getvectorcomponent.h>

Public Functions

Type Name
GetVectorComponentHelper (const R & pR)
device::Idx confirmGhostsUpToDate () const
void confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
void doWeNeedGhosts () const
DEVICE_INLINE_FUNCTION auto eval (const JDX &... jdx) const
auto getToolBox () const
std::string toString () const

Detailed Description

Unit test: ctest -R test-getvectorcomponent

Public Functions Documentation

function GetVectorComponentHelper

inline TempLat::GetVectorComponentHelper::GetVectorComponentHelper (
    const R & pR
) 

function confirmGhostsUpToDate

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

function confirmSpace

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

function doWeNeedGhosts

inline void TempLat::GetVectorComponentHelper::doWeNeedGhosts () const

function eval

template<typename... JDX>
inline DEVICE_INLINE_FUNCTION auto TempLat::GetVectorComponentHelper::eval (
    const JDX &... jdx
) const

function getToolBox

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

function toString

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


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