Routing.hpp

Go to the documentation of this file.

 
#ifndef OPENSWMM_ROUTING_HPP
#define OPENSWMM_ROUTING_HPP
 
#include "XSectBatch.hpp"
#include "KinematicWave.hpp"
#include "DynamicWave.hpp"
#include "Divider.hpp"
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
 
// ============================================================================
// Routing model enum
// ============================================================================
 
enum class RouteModel : int {
    STEADY    = 0,   
    KINWAVE   = 1,   
    DYNWAVE   = 2    
};
 
// ============================================================================
// Routing orchestrator
// ============================================================================

class Router {
public:
    void init(SimulationContext& ctx, RouteModel model);

    int step(SimulationContext& ctx, double dt,
             double evap_rate = 0.0,
             dynwave::DWSolver::NonConduitFlowFunc non_conduit_fn = nullptr);

    double getAdaptiveStep(SimulationContext& ctx,
                           double fixed_step, double courant);

    const XSectGroups& xsectGroups() const { return groups_; }

    bool hasCycle() const { return cycle_detected_; }

    void setDWNumThreads(int n) { dw_solver_.setNumThreads(n); }

    dynwave::DWSolver& dwSolver() { return dw_solver_; }

    bool lastStepConverged() const {
        return (model_ == RouteModel::DYNWAVE) ? dw_solver_.lastConverged() : true;
    }
 
private:
    RouteModel model_ = RouteModel::DYNWAVE;
    XSectGroups groups_;
    kinwave::KWSolver kw_solver_;
    dynwave::DWSolver dw_solver_;
    // Divider data moved to ctx.node_subtypes.dividers (relational side-table).
    std::vector<int> steady_sorted_links_;  
    bool cycle_detected_ = false;           
 

    void initNodeFlows(SimulationContext& ctx, double dt, double evap_rate);

    void computeConduitLosses(SimulationContext& ctx, double dt, double evap_rate);

    void updateLinkStates(SimulationContext& ctx);

    int executeSteadyFlow(SimulationContext& ctx, double dt);
};
 
} // namespace openswmm
 
#endif // OPENSWMM_ROUTING_HPP