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

Returns the total energy of all particles. More...

#include <Integrals.h>

Inheritance diagram for TotalEnergy:
IIntegral< Float > Polymorphic

Public Member Functions

 TotalEnergy (const Float omega=0._f)
 
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 total energy of all particles.

This is simply of sum of total kinetic energy and total internal energy.

Todo:
this has to be generalized if some external potential is used.

Definition at line 132 of file Integrals.h.

Constructor & Destructor Documentation

◆ TotalEnergy()

TotalEnergy::TotalEnergy ( const Float  omega = 0._f)
explicit

Definition at line 66 of file Integrals.cpp.

Member Function Documentation

◆ evaluate()

Float TotalEnergy::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 69 of file Integrals.cpp.

◆ getName()

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

Returns the name of the integral.

Needed to label the integral in logs, GUI etc.

Implements IIntegral< Float >.

Definition at line 141 of file Integrals.h.


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