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

Helper class storing a minimal value of time step and corresponding statistics. More...

Public Member Functions

 MinimalStepTls (const Float UNUSED(power))
 
INLINE void add (const Float step, const T v, const T dv, const Size idx)
 Add a time step to the set, given also value, derivative and particle index. More...
 
INLINE void add (const MinimalStepTls &other)
 Add a time step computed by other TLS. More...
 
INLINE Size isDefined () const
 
INLINE Optional< Float > getStep () const
 Return the computed time step. More...
 
INLINE void saveStats (Statistics &stats) const
 Save auxiliary statistics. More...
 

Public Attributes

Float minStep = INFTY
 
T value = T(0._f)
 
T derivative = T(0._f)
 
Size particleIdx = 0
 

Detailed Description

template<typename T>
struct MinimalStepTls< T >

Helper class storing a minimal value of time step and corresponding statistics.

Definition at line 48 of file TimeStepCriterion.cpp.

Constructor & Destructor Documentation

◆ MinimalStepTls()

template<typename T >
MinimalStepTls< T >::MinimalStepTls ( const Float   UNUSEDpower)
inline

Definition at line 54 of file TimeStepCriterion.cpp.

Member Function Documentation

◆ add() [1/2]

template<typename T >
INLINE void MinimalStepTls< T >::add ( const Float  step,
const T  v,
const T  dv,
const Size  idx 
)
inline

Add a time step to the set, given also value, derivative and particle index.

Definition at line 57 of file TimeStepCriterion.cpp.

◆ add() [2/2]

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

Add a time step computed by other TLS.

Definition at line 67 of file TimeStepCriterion.cpp.

◆ getStep()

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

Return the computed time step.

Definition at line 76 of file TimeStepCriterion.cpp.

◆ isDefined()

template<typename T >
INLINE Size MinimalStepTls< T >::isDefined ( ) const
inline

Definition at line 71 of file TimeStepCriterion.cpp.

◆ saveStats()

template<typename T >
INLINE void MinimalStepTls< T >::saveStats ( Statistics &  stats) const
inline

Save auxiliary statistics.

Definition at line 81 of file TimeStepCriterion.cpp.

Member Data Documentation

◆ derivative

template<typename T >
T MinimalStepTls< T >::derivative = T(0._f)

Definition at line 51 of file TimeStepCriterion.cpp.

◆ minStep

template<typename T >
Float MinimalStepTls< T >::minStep = INFTY

Definition at line 49 of file TimeStepCriterion.cpp.

◆ particleIdx

template<typename T >
Size MinimalStepTls< T >::particleIdx = 0

Definition at line 52 of file TimeStepCriterion.cpp.

◆ value

template<typename T >
T MinimalStepTls< T >::value = T(0._f)

Definition at line 50 of file TimeStepCriterion.cpp.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.1