Public Member Functions | List of all members
TerminationCondition Class Referenceabstract

Abstract class for a termination condition for the main loop. More...

#include <main_loop_2d.hpp>

Inheritance diagram for TerminationCondition:
Inheritance graph
[legend]

Public Member Functions

virtual bool operator() (const hdsim &sim)=0
 Returns true if the simulation should continue, false otherwise. More...
 
virtual ~TerminationCondition (void)
 Virtual destructor.
 

Detailed Description

Abstract class for a termination condition for the main loop.

Definition at line 61 of file main_loop_2d.hpp.

Member Function Documentation

◆ operator()()

virtual bool TerminationCondition::operator() ( const hdsim sim)
pure virtual

Returns true if the simulation should continue, false otherwise.

Parameters
simHydrodynamic simulation
Returns
True is simulation should continue running

Implemented in CycleTermination, SafeTimeTermination, and KillSwitch.


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