Observables::Observable Class Reference

Base class for observables. More...

#include <Observable.hpp>

Inheritance diagram for Observables::Observable:

Public Member Functions
	Observable ()=default
virtual	~Observable ()=default
virtual std::vector< double >	operator() (boost::mpi::communicator const &comm) const =0
	Calculate the set of values measured by the observable.
std::size_t	n_values () const
	Size of the flat array returned by the observable.
virtual std::vector< std::size_t >	shape () const =0
	Dimensions needed to reshape the flat array returned by the observable.

Detailed Description

Base class for observables.

An observable extracts raw data from a system or compute a statistic based on the state of a system, and returns an array of doubles.

Observables typically don't have setters or getters to access and modify their member variables, and usually only have a default constructor with no argument. Each observable class has a corresponding interface in ScriptInterface::Observables, where setters and getters are defined.

Definition at line 42 of file core/observables/Observable.hpp.

Constructor & Destructor Documentation

Observable()

Observables::Observable::Observable ( )

default

~Observable()

virtual Observables::Observable::~Observable ( )

virtualdefault

Member Function Documentation

n_values()

std::size_t Observables::Observable::n_values ( ) const

inline

Size of the flat array returned by the observable.

Definition at line 51 of file core/observables/Observable.hpp.

References shape().

Referenced by Observables::BondAngles::evaluate(), Observables::BondDihedrals::evaluate(), Observables::CosPersistenceAngles::evaluate(), and Observables::ParticleDistances::evaluate().

operator()()

virtual std::vector< double > Observables::Observable::operator() ( boost::mpi::communicator const &  comm ) const

pure virtual

Calculate the set of values measured by the observable.

Implemented in Observables::Energy, Observables::Pressure, Observables::PressureTensor, Observables::PidObservable, Observables::RDF, Observables::CylindricalLBVelocityProfile, Observables::DPDStress, Observables::LBFluidPressureTensor, and Observables::LBVelocityProfile.

shape()

virtual std::vector< std::size_t > Observables::Observable::shape ( ) const

pure virtual

Dimensions needed to reshape the flat array returned by the observable.

Implemented in Observables::BondAngles, Observables::BondDihedrals, Observables::CosPersistenceAngles, Observables::CylindricalFluxDensityProfile, Observables::CylindricalLBFluxDensityProfileAtParticlePositions, Observables::CylindricalLBVelocityProfile, Observables::CylindricalLBVelocityProfileAtParticlePositions, Observables::CylindricalVelocityProfile, Observables::DPDStress, Observables::Energy, Observables::FluxDensityProfile, Observables::ForceDensityProfile, Observables::LBFluidPressureTensor, Observables::LBVelocityProfile, Observables::ParticleDistances, Observables::ParticleObservable< ObsType >, Observables::ParticleObservable< ParticleObservables::DipoleFields >, Observables::Pressure, Observables::PressureTensor, Observables::ProfileObservable, Observables::RDF, and Observables::TotalForce.

Referenced by n_values().

---

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

• core/observables/Observable.hpp