Class TempLat::UnaryOperator

template <typename R>

ClassList > TempLat > UnaryOperator

A parent class which implements the common methods that all unary operators (-, sqrt ) share. More...

#include <unaryoperator.h>

Inherited by the following classes: TempLat::AsComplexField, TempLat::BackDiff, TempLat::ComplexEvalComponent, TempLat::ComplexFieldAsFourier, TempLat::ExpressionShifter, TempLat::ExpressionShifterByOne, TempLat::ForwDiff, TempLat::ForwDij, TempLat::HeavisideStepFunction, TempLat::LatticeForwardGradient, TempLat::LatticeLaplacian, TempLat::NeutDiff, TempLat::NeutDij, TempLat::NormGradientSquare, TempLat::Operators::AbsoluteValue, TempLat::Operators::ComplexConjugate, TempLat::Operators::DiracDeltaFunction, TempLat::Operators::MultiplicationN, TempLat::Operators::PowerN, TempLat::Operators::SafeSqrt

Public Functions

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

Type	Name
consteval size_t	getNDim ()

Protected Attributes

Type	Name
R	mR

Detailed Description

Unit test: ctest -R test-unaryoperator

Public Functions Documentation

function UnaryOperator

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

function confirmGhostsUpToDate

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

function confirmSpace

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

function doWeNeedGhosts

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

function getDx

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

function getKIR

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

function getToolBox

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

For measurement objects.

function operatorString

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

inline virtual std::string TempLat::UnaryOperator::operatorString () const

function postGet

inline void TempLat::UnaryOperator::postGet ()

function preGet

inline void TempLat::UnaryOperator::preGet ()

function toString

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.

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

Public Static Functions Documentation

function getNDim

static inline consteval size_t TempLat::UnaryOperator::getNDim ()

Protected Attributes Documentation

variable mR

R TempLat::UnaryOperator< R >::mR;

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