Class TempLat::VectorDotter

template <typename R, typename T>

ClassList > TempLat > VectorDotter

A class which takes two VectorGetters, and implements a special get method which returns the dot-product / contraction of the two vectors. More...

#include <vectordotter.h>

Inherits the following classes: TempLat::BinaryOperator

Public Functions

Type	Name
	VectorDotter (R & a, T & b)
	VectorDotter (const VectorDotter &) = default
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) 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.
std::string	toString () const

Public Functions inherited from TempLat::BinaryOperator

See TempLat::BinaryOperator

Type	Name
	BinaryOperator (const R & pR, const T & pT)
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 = 0 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 "a OP b" (where OP is or whatever), this toString method does all the work for you.*

Public Static Functions inherited from TempLat::BinaryOperator

See TempLat::BinaryOperator

Type	Name
consteval size_t	getNDim ()

Protected Attributes inherited from TempLat::BinaryOperator

See TempLat::BinaryOperator

Type	Name
R	mR
T	mT

Detailed Description

Unit test: ctest -R test-vectordotter

Public Functions Documentation

function VectorDotter [1/2]

inline TempLat::VectorDotter::VectorDotter (
    R & a,
    T & b
)

function VectorDotter [2/2]

TempLat::VectorDotter::VectorDotter (
    const VectorDotter &
) = default

function confirmSpace

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

function eval

template<typename... IDX>
inline DEVICE_INLINE_FUNCTION auto TempLat::VectorDotter::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::VectorDotter::operatorString () override const

Implements TempLat::BinaryOperator::operatorString

function toString

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

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