TimestepController.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#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 SEC_PER_DAY = 86400.0;
};
 
} /* namespace openswmm::hydraulics */
 
#endif /* OPENSWMM_ENGINE_TIMESTEP_CONTROLLER_HPP */