Gromacs  2025-dev-20240910-a7e2421
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Friends
gmx::LastStepSignaller Class Referencefinal

#include <gromacs/modularsimulator/signallers.h>

+ Inheritance diagram for gmx::LastStepSignaller:
+ Collaboration diagram for gmx::LastStepSignaller:

Description

Element signalling the last step.

This element informs its clients via callbacks when the last step is happening.

Public Types

typedef ILastStepSignallerClient 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::INeighborSearchSignallerClient
virtual ~INeighborSearchSignallerClient ()=default
 Standard virtual destructor.
 

Friends

class SignallerBuilder< LastStepSignaller >
 Allow builder to construct.
 

Additional Inherited Members

Member Function Documentation

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

Run the signaller at a specific step / time.

Informs callbacks if this is the last step

Parameters
stepThe current time step
timeThe current time

Implements gmx::ISignaller.


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