Observables::PidObservable Class Reference

Particle-based observable. More...

#include <PidObservable.hpp>

Inheritance diagram for Observables::PidObservable:

Collaboration diagram for Observables::PidObservable:

Public Member Functions
	PidObservable (std::vector< int > ids)
std::vector< double >	operator() (boost::mpi::communicator const &comm) const final
std::vector< int > const &	ids () const
Public Member Functions inherited from Observables::Observable
	Observable ()=default
virtual	~Observable ()=default
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.

Private Member Functions
virtual std::vector< double >	evaluate (boost::mpi::communicator const &comm, ParticleReferenceRange const &local_particles, const ParticleObservables::traits< Particle > &traits) const =0

Detailed Description

Particle-based observable.

Base class for observables extracting raw data from particle subsets and returning either the data or a statistic derived from it.

Definition at line 54 of file core/observables/PidObservable.hpp.

Constructor & Destructor Documentation

PidObservable()

Observables::PidObservable::PidObservable ( std::vector< int >  ids )

inlineexplicit

Definition at line 64 of file core/observables/PidObservable.hpp.

Member Function Documentation

evaluate()

virtual std::vector< double > Observables::PidObservable::evaluate ( boost::mpi::communicator const &  comm, ParticleReferenceRange const &  local_particles, const ParticleObservables::traits< Particle > &  traits  ) const

privatepure virtual

Implemented in Observables::TotalForce, Observables::BondAngles, Observables::BondDihedrals, Observables::CosPersistenceAngles, Observables::CylindricalDensityProfile, Observables::CylindricalFluxDensityProfile, Observables::CylindricalLBFluxDensityProfileAtParticlePositions, Observables::CylindricalVelocityProfile, Observables::DensityProfile, Observables::FluxDensityProfile, Observables::ForceDensityProfile, Observables::ParticleDipoleFields, Observables::ParticleDistances, Observables::ParticleObservable< ObsType >, Observables::ParticleObservable< ParticleObservables::DipoleFields >, and Observables::CylindricalLBVelocityProfileAtParticlePositions.

Referenced by operator()().

ids()

std::vector< int > const & Observables::PidObservable::ids ( ) const

inline

Definition at line 67 of file core/observables/PidObservable.hpp.

Referenced by Observables::BondAngles::BondAngles(), Observables::BondDihedrals::BondDihedrals(), Observables::CosPersistenceAngles::CosPersistenceAngles(), Observables::BondAngles::evaluate(), Observables::BondDihedrals::evaluate(), Observables::CosPersistenceAngles::evaluate(), Observables::ParticleDistances::evaluate(), Observables::ParticleObservable< ObsType >::evaluate(), operator()(), Observables::ParticleDistances::ParticleDistances(), Observables::BondAngles::shape(), Observables::BondDihedrals::shape(), Observables::CosPersistenceAngles::shape(), Observables::ParticleDistances::shape(), and Observables::ParticleObservable< ObsType >::shape().

operator()()

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

finalvirtual

Implements Observables::Observable.

Definition at line 30 of file PidObservable.cpp.

References evaluate(), fetch_particles(), and ids().

---

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

• core/observables/PidObservable.hpp
• PidObservable.cpp