SPH
Public Member Functions | List of all members
NullRunCallbacks Class Reference
Inheritance diagram for NullRunCallbacks:
IRunCallbacks Polymorphic

Public Member Functions

virtual void onSetUp (const Storage &, Statistics &) override
 Called right before the run starts, i.e. after initial conditions are set up. More...
 
virtual void onTimeStep (const Storage &, Statistics &) override
 Called every timestep. More...
 
virtual bool shouldAbortRun () const override
 Returns whether current run should be aborted or not. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Definition at line 86 of file IRun.cpp.

Member Function Documentation

◆ onSetUp()

virtual void NullRunCallbacks::onSetUp ( const Storage storage,
Statistics stats 
)
inlineoverridevirtual

Called right before the run starts, i.e. after initial conditions are set up.

Implements IRunCallbacks.

Definition at line 88 of file IRun.cpp.

◆ onTimeStep()

virtual void NullRunCallbacks::onTimeStep ( const Storage storage,
Statistics stats 
)
inlineoverridevirtual

Called every timestep.

This is a blocking call, run is paused until the function returns. This allows to safely access the storage and run statistics. Note that accessing the storage from different thread during run is generally unsafe, as the storage can be resized during the run.

Implements IRunCallbacks.

Definition at line 90 of file IRun.cpp.

◆ shouldAbortRun()

virtual bool NullRunCallbacks::shouldAbortRun ( ) const
inlineoverridevirtual

Returns whether current run should be aborted or not.

Can be called any time.

Implements IRunCallbacks.

Definition at line 92 of file IRun.cpp.


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