Class TempLat::NormGradientSquare

template <typename R>

ClassList > TempLat > NormGradientSquare

A class which computes the gradient square norm. More...

#include <normgradientsquare.h>

Inherits the following classes: TempLat::UnaryOperator

Public Types

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

Public Static Attributes

Type	Name
constexpr size_t	NDim = `GetNDim::get<R>()`

Public Functions

Type	Name
	NormGradientSquare (const R & pR)
auto	d (const S & other)
void	doWeNeedGhosts () const
DEVICE_INLINE_FUNCTION auto	eval (const IDX &... idx) const
std::string	toString () const

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-normgradientsquare

Public Types Documentation

typedef FloatType

using TempLat::NormGradientSquare< R >::FloatType =  typename GetFloatType<GetReturnType>::type;

typedef GetReturnType

using TempLat::NormGradientSquare< R >::GetReturnType =  typename GetGetReturnType<R>::type;

Public Static Attributes Documentation

variable NDim

constexpr size_t TempLat::NormGradientSquare< R >::NDim;

Public Functions Documentation

function NormGradientSquare

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

function d

template<typename S>
inline auto TempLat::NormGradientSquare::d (
    const S & other
)

function doWeNeedGhosts

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

function eval

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

function toString

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

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