ParM  parm
A molecular dynamics library
Public Member Functions | List of all members
StateTracker Class Referenceabstract

The general interface for a "tracker", a class that needs to be called every timestep. More...

#include <trackers.hpp>

Inheritance diagram for StateTracker:
ContactTracker EnergyTracker ISFTracker NeighborList RDiffs RsqTracker SmoothLocs

Public Member Functions

virtual void update (Box &box)=0
 This function is called once per timestep, when particles are in their set position. More...
 
virtual ~StateTracker ()
 

Detailed Description

The general interface for a "tracker", a class that needs to be called every timestep.

StateTracker is used as a base for some "helper" classes, like neighbor lists (NeighborList), as well as for many statistics.

Examples:
hardspheres.cpp.

Constructor & Destructor Documentation

virtual StateTracker::~StateTracker ( )
inlinevirtual

Member Function Documentation

virtual void StateTracker::update ( Box box)
pure virtual

This function is called once per timestep, when particles are in their set position.

Implemented in RDiffs, SmoothLocs, ISFTracker, RsqTracker, EnergyTracker, ContactTracker, and NeighborList.


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