SPH
Public Member Functions | Public Attributes | List of all members
MeanStepTls< T > Struct Template Reference

Public Member Functions

 MeanStepTls (const Float power)
 
INLINE void add (const Float step, const T UNUSED(v), const T UNUSED(dv), const Float UNUSED(idx))
 
INLINE void add (const MeanStepTls &other)
 
INLINE Optional< FloatgetStep () const
 
INLINE void saveStats (Statistics &UNUSED(stats)) const
 

Public Attributes

NegativeMean mean
 

Detailed Description

template<typename T>
struct MeanStepTls< T >

Helper class storing a (generalized) mean. Statistics do not apply here (no single particle is the restrictive one). Same interface as in MinimalStepTls.

Definition at line 91 of file TimeStepCriterion.cpp.

Constructor & Destructor Documentation

◆ MeanStepTls()

template<typename T >
MeanStepTls< T >::MeanStepTls ( const Float  power)
inline

Definition at line 94 of file TimeStepCriterion.cpp.

Member Function Documentation

◆ add() [1/2]

template<typename T >
INLINE void MeanStepTls< T >::add ( const Float  step,
const T   UNUSEDv,
const T   UNUSEDdv,
const Float   UNUSEDidx 
)
inline

Definition at line 97 of file TimeStepCriterion.cpp.

◆ add() [2/2]

template<typename T >
INLINE void MeanStepTls< T >::add ( const MeanStepTls< T > &  other)
inline

Definition at line 101 of file TimeStepCriterion.cpp.

◆ getStep()

template<typename T >
INLINE Optional<Float> MeanStepTls< T >::getStep ( ) const
inline

Definition at line 105 of file TimeStepCriterion.cpp.

◆ saveStats()

template<typename T >
INLINE void MeanStepTls< T >::saveStats ( Statistics UNUSEDstats) const
inline

Definition at line 115 of file TimeStepCriterion.cpp.

Member Data Documentation

◆ mean

template<typename T >
NegativeMean MeanStepTls< T >::mean

Definition at line 92 of file TimeStepCriterion.cpp.


The documentation for this struct was generated from the following file: