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::NeighborSearchSignaller Class Referencefinal

#include <gromacs/modularsimulator/signallers.h>

+ Inheritance diagram for gmx::NeighborSearchSignaller:
+ Collaboration diagram for gmx::NeighborSearchSignaller:

Description

Element signalling a neighbor search step.

This element informs its clients via callbacks when a neighbor-searching step is happening.

Public Types

typedef
INeighborSearchSignallerClient 
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
 Do nothing at setup time.
 

Friends

class SignallerBuilder< NeighborSearchSignaller >
 Allow builder to construct.
 

Member Function Documentation

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

Run the signaller at a specific step / time.

Informs callbacks if step % nstlist_ == 0

Parameters
stepThe current time step
timeThe current time

Implements gmx::ISignaller.


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