Observables::ParticleDistances Class Reference

Calculate distances between particles in a polymer. More...

#include <ParticleDistances.hpp>

Inheritance diagram for Observables::ParticleDistances:

Collaboration diagram for Observables::ParticleDistances:

Public Member Functions
	ParticleDistances (std::vector< int > ids)
std::vector< double >	evaluate (boost::mpi::communicator const &comm, ParticleReferenceRange const &local_particles, const ParticleObservables::traits< Particle > &traits) const override
std::vector< std::size_t >	shape () const override
	PidObservable (std::vector< int > ids)
Public Member Functions inherited from Observables::PidObservable
	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.

Detailed Description

Calculate distances between particles in a polymer.

For \( n \) bonded particles, return the \( n-1 \) distances separating them.

Definition at line 38 of file ParticleDistances.hpp.

Constructor & Destructor Documentation

ParticleDistances()

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

inlineexplicit

Definition at line 41 of file ParticleDistances.hpp.

References Observables::PidObservable::ids().

Member Function Documentation

evaluate()

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

inlineoverridevirtual

Implements Observables::PidObservable.

Definition at line 48 of file ParticleDistances.hpp.

References System::System::box_geo, System::get_system(), Observables::PidObservable::ids(), and Observables::Observable::n_values().

PidObservable()

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

inlineexplicit

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

shape()

std::vector< std::size_t > Observables::ParticleDistances::shape ( ) const

inlineoverridevirtual

Implements Observables::Observable.

Definition at line 68 of file ParticleDistances.hpp.

References Observables::PidObservable::ids().

---

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

• ParticleDistances.hpp