TimestepController.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ENGINE_TIMESTEP_CONTROLLER_HPP
#define OPENSWMM_ENGINE_TIMESTEP_CONTROLLER_HPP
 
#include <algorithm>
#include <cmath>
 
namespace openswmm {
    struct SimulationContext;
}
 
namespace openswmm::hydraulics {
 
class TimestepController {
public:
    TimestepController() = delete;
 
    // -----------------------------------------------------------------------
    // Core timestep computation
    // -----------------------------------------------------------------------
 
    static double compute_next(const SimulationContext& ctx, double dt_cfl) noexcept;
 
    // -----------------------------------------------------------------------
    // Timer management
    // -----------------------------------------------------------------------
 
    static void advance(SimulationContext& ctx, double dt_taken) noexcept;
 
    static void reset_output_timer(SimulationContext& ctx) noexcept;
 
    // -----------------------------------------------------------------------
    // State queries
    // -----------------------------------------------------------------------
 
    static bool output_due(const SimulationContext& ctx) noexcept;
 
    static bool simulation_complete(const SimulationContext& ctx) noexcept;
 
    // -----------------------------------------------------------------------
    // Constants
    // -----------------------------------------------------------------------
 
    static constexpr double OUTPUT_EPSILON = 1.0e-6;
 
    static constexpr double SEC_PER_DAY = 86400.0;
};
 
} /* namespace openswmm::hydraulics */
 
#endif /* OPENSWMM_ENGINE_TIMESTEP_CONTROLLER_HPP */