SPH
Public Member Functions | List of all members
ParticleNumberColumn Class Reference

Helper column printing particle numbers. More...

#include <Column.h>

Inheritance diagram for ParticleNumberColumn:
ITextColumn Polymorphic

Public Member Functions

virtual Dynamic evaluate (const Storage &UNUSED(storage), const Statistics &UNUSED(stats), const Size particleIdx) const override
 
virtual void accumulate (Storage &, const Dynamic, const Size) 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

Helper column printing particle numbers.

Definition at line 269 of file Column.h.

Member Function Documentation

◆ accumulate()

virtual void ParticleNumberColumn::accumulate ( Storage storage,
const  value,
const  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 277 of file Column.h.

◆ evaluate()

virtual Dynamic ParticleNumberColumn::evaluate ( const Storage UNUSEDstorage,
const Statistics UNUSEDstats,
const Size  particleIdx 
) const
inlineoverridevirtual

Definition at line 271 of file Column.h.

◆ getName()

virtual std::string ParticleNumberColumn::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 281 of file Column.h.

◆ getType()

virtual ValueEnum ParticleNumberColumn::getType ( ) const
inlineoverridevirtual

Returns the value type of the column.

Implements ITextColumn.

Definition at line 285 of file Column.h.


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