Public Member Functions | List of all members
simulation1d::SafeTimeTermination Class Reference

Terminates the simulation after a certain time is reached. More...

#include <main_loop_1d.hpp>

Inheritance diagram for simulation1d::SafeTimeTermination:
Inheritance graph
[legend]
Collaboration diagram for simulation1d::SafeTimeTermination:
Collaboration graph
[legend]

Public Member Functions

 SafeTimeTermination (double termination_time, int max_cycles)
 Class constructor. More...
 
bool operator() (hdsim1D const &sim)
 Determines if a simulation should continue running. More...
 

Detailed Description

Terminates the simulation after a certain time is reached.

Definition at line 34 of file main_loop_1d.hpp.

Constructor & Destructor Documentation

◆ SafeTimeTermination()

SafeTimeTermination::SafeTimeTermination ( double  termination_time,
int  max_cycles 
)

Class constructor.

Parameters
termination_timeTime to stop simulation
max_cyclesUpper bound on the number of time advance cycles

Definition at line 8 of file main_loop_1d.cpp.

Member Function Documentation

◆ operator()()

bool SafeTimeTermination::operator() ( hdsim1D const &  sim)
virtual

Determines if a simulation should continue running.

Parameters
simHydrodynamic simulation
Returns
True if the simulation should run more

Implements simulation1d::TerminationCondition.

Definition at line 13 of file main_loop_1d.cpp.

Here is the call graph for this function:

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