Public Member Functions | List of all members
CycleTermination Class Reference

Terminates the simulation after a specified number of iterations. More...

#include <main_loop_2d.hpp>

Inheritance diagram for CycleTermination:
Inheritance graph
[legend]
Collaboration diagram for CycleTermination:
Collaboration graph
[legend]

Public Member Functions

 CycleTermination (int max_cycles)
 Class constructor. More...
 
bool operator() (const hdsim &sim)
 Returns true if the simulation should continue, false otherwise. More...
 
- Public Member Functions inherited from TerminationCondition
virtual ~TerminationCondition (void)
 Virtual destructor.
 

Detailed Description

Terminates the simulation after a specified number of iterations.

Definition at line 95 of file main_loop_2d.hpp.

Constructor & Destructor Documentation

◆ CycleTermination()

CycleTermination::CycleTermination ( int  max_cycles)
explicit

Class constructor.

Parameters
max_cyclesMaximum number of cycles

Definition at line 33 of file main_loop_2d.cpp.

Member Function Documentation

◆ operator()()

bool CycleTermination::operator() ( const hdsim &  sim)
virtual

Returns true if the simulation should continue, false otherwise.

Parameters
simHydrodynamic simulation
Returns
True is simulation should continue running

Implements TerminationCondition.

Definition at line 36 of file main_loop_2d.cpp.

Here is the call graph for this function:

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