QualityRouting.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_QUALITY_ROUTING_HPP
#define OPENSWMM_QUALITY_ROUTING_HPP
 
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace quality {
 
// ============================================================================
// Constants
// ============================================================================
 
constexpr double ZERO_VOLUME = 0.0353147;  
constexpr double ZERO_DEPTH  = 0.003281;   

void applyNodeTreatment(SimulationContext& ctx, int node, double dt,
                        double q_in_cfs, const double* cin);
 
// ============================================================================
// Quality solver
// ============================================================================
 
class QualitySolver {
public:
    void init(int n_nodes, int n_links, int n_pollutants);

    void execute(SimulationContext& ctx, double dt);

    void assembleExternalLoads(SimulationContext& ctx, double dt);

    void addExtInflowLoads(SimulationContext& ctx, double dt);
    void addCouplingLoads(SimulationContext& ctx, double dt);

    void addWetWeatherLoads(SimulationContext& ctx, double dt);

    void updateLinkQuality(SimulationContext& ctx, double dt);

    void applyTreatment(SimulationContext& ctx, double dt);
 
private:
    int n_pollutants_ = 0;
 
    // Quality mass inflow arrays are stored on NodeData (nodes.qual_mass_in[],
    // nodes.qual_vol_in[]) so that external quality sources (user forcing, DWF
    // quality, etc.) can contribute at the same assembly point.

    void addRdiiLoads(SimulationContext& ctx, double dt);

    void addDwfLoads(SimulationContext& ctx, double dt);

    void addGwLoads(SimulationContext& ctx, double dt);

    void addIfaceLoads(SimulationContext& ctx, double dt);

    void accumulateLinkLoads(SimulationContext& ctx, double dt);

    void mixAtNodes(SimulationContext& ctx, double dt);

    void applyDecay(SimulationContext& ctx, double dt);
 
};
 
} // namespace quality
} // namespace openswmm
 
#endif // OPENSWMM_QUALITY_ROUTING_HPP