SPH
Public Member Functions | List of all members
DerivativeColumn< TValue > Class Template Reference

Returns first derivatives of given quantity as stored in storage. More...

#include <Column.h>

Inheritance diagram for DerivativeColumn< TValue >:
ITextColumn Polymorphic

Public Member Functions

 DerivativeColumn (const QuantityId id)
 
virtual Dynamic evaluate (const Storage &storage, const Statistics &UNUSED(stats), const Size particleIdx) const override
 
virtual void accumulate (Storage &storage, const Dynamic value, const Size particleIdx) const override
 Reads the value of the column and saves it into the storage, if possible. More...
 
virtual std::string getName () const override
 Returns a name of the column. More...
 
virtual ValueEnum getType () const override
 Returns the value type of the column. More...
 
- Public Member Functions inherited from ITextColumn
virtual Dynamic evaluate (const Storage &storage, const Statistics &stats, const Size particleIdx) const =0
 Returns the value of the output column for given particle. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

template<typename TValue>
class DerivativeColumn< TValue >

Returns first derivatives of given quantity as stored in storage.

Quantity must contain derivative, checked by assert.

Definition at line 115 of file Column.h.

Constructor & Destructor Documentation

◆ DerivativeColumn()

template<typename TValue >
DerivativeColumn< TValue >::DerivativeColumn ( const QuantityId  id)
inlineexplicit

Definition at line 120 of file Column.h.

Member Function Documentation

◆ accumulate()

template<typename TValue >
virtual void DerivativeColumn< TValue >::accumulate ( Storage storage,
const Dynamic  value,
const Size  particleIdx 
) const
inlineoverridevirtual

Reads the value of the column and saves it into the storage, if possible.

Parameters
storageParticle storage where the value is stored
valueAccumulated value, must be the same type as this column. Checked by assert.
particleIdxIndex of accumulated particle; if larger than current size of the storage, the storage is resized accordingly.
Exceptions
Exceptionif value cannot be accumulated.

Implements ITextColumn.

Definition at line 134 of file Column.h.

◆ evaluate()

template<typename TValue >
virtual Dynamic DerivativeColumn< TValue >::evaluate ( const Storage storage,
const Statistics UNUSEDstats,
const Size  particleIdx 
) const
inlineoverridevirtual

Definition at line 123 of file Column.h.

◆ getName()

template<typename TValue >
virtual std::string DerivativeColumn< TValue >::getName ( ) const
inlineoverridevirtual

Returns a name of the column.

The name is printed in the header of the output file.

Implements ITextColumn.

Definition at line 148 of file Column.h.

◆ getType()

template<typename TValue >
virtual ValueEnum DerivativeColumn< TValue >::getType ( ) const
inlineoverridevirtual

Returns the value type of the column.

Implements ITextColumn.

Definition at line 152 of file Column.h.


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