Class TempLat::ForwDiff

template <int dir, typename R>

ClassList > TempLat > ForwDiff

A class which implements forward finite differences. More...

#include <forwdiff.h>

Inherits the following classes: TempLat::UnaryOperator

Public Types

Type	Name
typedef typename GetFloatType< GetReturnType >::type	FloatType
typedef typename GetGetReturnType< R >::type	GetReturnType

Public Functions

Type	Name
	ForwDiff (R pR)
void	doWeNeedGhosts () const
DEVICE_INLINE_FUNCTION auto	eval (const IDX &... idx) const
virtual std::string	operatorString () override const Override this method in your derived class, to have an easy implementation of your toString method.

Public Functions inherited from TempLat::UnaryOperator

See TempLat::UnaryOperator

Type	Name
	UnaryOperator (const R & pR)
device::Idx	confirmGhostsUpToDate () const
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
void	doWeNeedGhosts () const
auto	getDx () const
auto	getKIR () const
auto	getToolBox () const
virtual std::string	operatorString () const Override this method in your derived class, to have an easy implementation of your toString method.
void	postGet ()
void	preGet ()
std::string	toString () const If your descending class implements `operatorString()` and your operator is of the type "OP b" (where OP is or whatever), this toString method does all the work for you, only adding parentheses if b contains spaces.*

Public Static Functions inherited from TempLat::UnaryOperator

See TempLat::UnaryOperator

Type	Name
consteval size_t	getNDim ()

Protected Attributes inherited from TempLat::UnaryOperator

See TempLat::UnaryOperator

Type	Name
R	mR

Detailed Description

Unit test: ctest -R test-forwdiff

Public Types Documentation

typedef FloatType

using TempLat::ForwDiff< dir, R >::FloatType =  typename GetFloatType<GetReturnType>::type;

typedef GetReturnType

using TempLat::ForwDiff< dir, R >::GetReturnType =  typename GetGetReturnType<R>::type;

Public Functions Documentation

function ForwDiff

inline TempLat::ForwDiff::ForwDiff (
    R pR
)

function doWeNeedGhosts

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

function eval

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

function operatorString

Override this method in your derived class, to have an easy implementation of your toString method.

inline virtual std::string TempLat::ForwDiff::operatorString () override const

Implements TempLat::UnaryOperator::operatorString

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