Skip to content

Class TempLat::HeavisideStepFunction

template <typename R>

ClassList > TempLat > HeavisideStepFunction

Heaviside step function We use the convention that H(0) = 1 for simplicity. More...

  • #include <heavisidestepfunction.h>

Inherits the following classes: TempLat::UnaryOperator

Public Functions

Type Name
HeavisideStepFunction (const R & pR)
auto d (const U & other)
Derivative of the Heaviside step function is the Dirac delta function.
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

Template parameters:

  • R Expression type of the argument.

Public Functions Documentation

function HeavisideStepFunction

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

function d

Derivative of the Heaviside step function is the Dirac delta function. 

template<typename U>
inline auto TempLat::HeavisideStepFunction::d (
    const U & other
)

function eval

template<typename... IDX>
inline DEVICE_INLINE_FUNCTION auto TempLat::HeavisideStepFunction::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::HeavisideStepFunction::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/operators/heavisidestepfunction.h