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

#include <gromacs/modularsimulator/signallers.h>

+ Inheritance diagram for gmx::EnergySignaller:
+ Collaboration diagram for gmx::EnergySignaller:

Description

Element signalling energy related special steps.

This element informs its clients via callbacks of the following events:

Public Types

typedef IEnergySignallerClient Client
 Define client type.
 

Public Member Functions

void signal (Step step, Time time) override
 Run the signaller at a specific step / time. More...
 
void signallerSetup () override
 Check that necessary registration was done.
 
- Public Member Functions inherited from gmx::ISignaller
virtual ~ISignaller ()=default
 Standard virtual destructor.
 
- Public Member Functions inherited from gmx::ITrajectorySignallerClient
virtual ~ITrajectorySignallerClient ()=default
 Standard virtual destructor.
 
- Public Member Functions inherited from gmx::ILoggingSignallerClient
virtual ~ILoggingSignallerClient ()=default
 Standard virtual destructor.
 

Friends

class SignallerBuilder< EnergySignaller >
 Allow builder to construct.
 

Additional Inherited Members

Member Function Documentation

void gmx::EnergySignaller::signal ( Step  step,
Time  time 
)
overridevirtual

Run the signaller at a specific step / time.

Informs callbacks of energy / virial / free energy special steps

Parameters
stepThe current time step
timeThe current time

Implements gmx::ISignaller.


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