Particle Identification and Tracking
Public Member Functions | List of all members
tracking::Accumulator Class Referenceabstract

An ABC of objects that accumulate information from particles. More...

#include <accumulator.h>

+ Inheritance diagram for tracking::Accumulator:

Public Member Functions

virtual void add_particle (const particle *)=0
 Adds a particle. More...
 
virtual void out_to_wrapper (utilities::Generic_wrapper &, const utilities::Md_store &md_store) const =0
 outputs the result of the computation to the wrapper More...
 
virtual ~Accumulator ()
 no-op Destructor More...
 
 Accumulator ()
 no-op constructor More...
 

Detailed Description

An ABC of objects that accumulate information from particles.

In my naming scheme Accumulator objects are for measurements that do not care about a particles neighborhood, ex $s(q)$. This is different than Corr objects that deal with measurements that depend on the neighborhood around the particle.

This may need to pick up temperature functionality like Corr. This class and Corr might be able to be merged.

Constructor & Destructor Documentation

virtual tracking::Accumulator::~Accumulator ( )
inlinevirtual

no-op Destructor

tracking::Accumulator::Accumulator ( )
inline

no-op constructor

Member Function Documentation

virtual void tracking::Accumulator::add_particle ( const particle )
pure virtual

Adds a particle.

The sub class determines what is computed from the particle.

Implemented in tracking::Accum_chi4_self, tracking::Accum_sofq, and tracking::Accum_sofq_ND.

Referenced by tracking::Master_box::compute_accum(), and tracking::hash_box::compute_accum().

virtual void tracking::Accumulator::out_to_wrapper ( utilities::Generic_wrapper ,
const utilities::Md_store md_store 
) const
pure virtual

outputs the result of the computation to the wrapper

Implemented in tracking::Accum_chi4_self, tracking::Accum_sofq, and tracking::Accum_sofq_ND.


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