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

Returns the quantity value of given particle. More...

#include <Integrals.h>

Inheritance diagram for QuantityValue:
IIntegral< Float > Polymorphic

Public Member Functions

 QuantityValue (const QuantityId id, const Size particleIdx)
 
virtual Float evaluate (const Storage &storage) const override
 Computes the integral quantity using particles in the storage. More...
 
virtual std::string getName () const override
 Returns the name of the integral. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Returns the quantity value of given particle.

Mainly used for debugging. Currently available only for scalar quantities.

Definition at line 209 of file Integrals.h.

Constructor & Destructor Documentation

◆ QuantityValue()

QuantityValue::QuantityValue ( const QuantityId  id,
const Size  particleIdx 
)

Definition at line 191 of file Integrals.cpp.

Member Function Documentation

◆ evaluate()

Float QuantityValue::evaluate ( const Storage storage) const
overridevirtual

Computes the integral quantity using particles in the storage.

Storage must contain quantites relevant to the integral implementation. Generally positions, masses and density must be present.

Implements IIntegral< Float >.

Definition at line 195 of file Integrals.cpp.

◆ getName()

virtual std::string QuantityValue::getName ( ) const
inlineoverridevirtual

Returns the name of the integral.

Needed to label the integral in logs, GUI etc.

Implements IIntegral< Float >.

Definition at line 219 of file Integrals.h.


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