gmx::EnergySignaller Class Reference

#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:

• energy calculation step
• virial calculation step
• free energy calculation step

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	setup () 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

step	The current time step
time	The current time

Implements gmx::ISignaller.

---

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

• src/gromacs/modularsimulator/signallers.h
• src/gromacs/modularsimulator/signallers.cpp