Class TempLat::SU2BinaryOperator

template <typename R, typename T>

ClassList > TempLat > SU2BinaryOperator

A class which implements basic features of su2 binary operators. More...

#include <su2binaryoperator.h>

Inherited by the following classes: TempLat::SU2Addition, TempLat::SU2Commutator, TempLat::SU2Multiplication, TempLat::SU2Subtraction, TempLat::ScalarSU2Multiplication

Public Types

Type	Name
typedef SU2Getter	Getter

Public Static Attributes

Type	Name
constexpr size_t	size = `4`

Public Functions

Type	Name
	SU2BinaryOperator (const R & pR, const T & pT)
device::Idx	confirmGhostsUpToDate () const
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
void	doWeNeedGhosts () const Space/ghost confirmation by walking this SU(2) expression's own (linear) structure - forwarded to both operands, mirroring the generic BinaryOperator . This lets an SU(2) assignment confirm space/ghosts on the whole expression instead of building the exponential per-component SU2Get expansion just for confirmation (see_su2liealgebrafield.h /su2field.h _operator=).
auto	getDx () const
const R &	getFirst () const Access the two operands. Used by the algebraic simplification rules (e.g. the dagger anti-homomorphism (A.B)^dagger = B^dagger.A^dagger, see su2dagger.h ).
auto	getKIR () const
const T &	getSecond () 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 "a OP b" (where OP is or whatever), this toString method does all the work for you.*

Public Static Functions

Type	Name
consteval size_t	getNDim ()

Protected Attributes

Type	Name
R	mR
T	mT

Detailed Description

Unit test: ctest -R test-su2binaryoperator

Public Types Documentation

typedef Getter

using TempLat::SU2BinaryOperator< R, T >::Getter =  SU2Getter;

Public Static Attributes Documentation

variable size

constexpr size_t TempLat::SU2BinaryOperator< R, T >::size;

Public Functions Documentation

function SU2BinaryOperator

inline TempLat::SU2BinaryOperator::SU2BinaryOperator (
    const R & pR,
    const T & pT
)

function confirmGhostsUpToDate

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

function confirmSpace

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

function doWeNeedGhosts

Space/ghost confirmation by walking this SU(2) expression's own (linear) structure - forwarded to both operands, mirroring the generic BinaryOperator . This lets an SU(2) assignment confirm space/ghosts on the whole expression instead of building the exponential per-component SU2Get expansion just for confirmation (see_su2liealgebrafield.h /su2field.h _operator=).

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

function getDx

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

function getFirst

Access the two operands. Used by the algebraic simplification rules (e.g. the dagger anti-homomorphism (A.B)^dagger = B^dagger.A^dagger, see su2dagger.h ).

inline const R & TempLat::SU2BinaryOperator::getFirst () const

function getKIR

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

function getSecond

inline const T & TempLat::SU2BinaryOperator::getSecond () const

function getToolBox

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

function operatorString

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

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

function postGet

inline void TempLat::SU2BinaryOperator::postGet ()

function preGet

inline void TempLat::SU2BinaryOperator::preGet ()

function toString

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.

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

Public Static Functions Documentation

function getNDim

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

Protected Attributes Documentation

variable mR

R TempLat::SU2BinaryOperator< R, T >::mR;

variable mT

T TempLat::SU2BinaryOperator< R, T >::mT;

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