Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::ISignaller Class Referenceabstract

#include <gromacs/modularsimulator/modularsimulatorinterfaces.h>

+ Inheritance diagram for gmx::ISignaller:

Description

The general Signaller interface.

Signallers are run at the beginning of Simulator steps, informing their clients about the upcoming step. This allows clients to decide if they need to be activated at this time step, and what functions they will have to run. Examples for signallers include the neighbor-search signaller (informs its clients when a neighbor-searching step is about to happen) or the logging signaller (informs its clients when a logging step is about to happen).

We expect all signallers to accept registration from clients, but different signallers might handle that differently, so we don't include this in the interface.

Public Member Functions

virtual void signal (Step, Time)=0
 Function run before every step of scheduling.
 
virtual void signallerSetup ()=0
 Method guaranteed to be called after construction, before simulator run.
 
virtual ~ISignaller ()=default
 Standard virtual destructor.
 

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