MsxSurfaceQuality.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_QUALITY_MSX_SURFACE_QUALITY_HPP
#define OPENSWMM_ENGINE_QUALITY_MSX_SURFACE_QUALITY_HPP
 
#include <string>
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
struct SimulationOptions;
 
namespace msxsurf {

double speciesUnitFactor(const std::string& units, const SimulationOptions& opts);

bool active(const SimulationContext& ctx) noexcept;

std::vector<std::string> resolve(SimulationContext& ctx);

void refreshDerived(SimulationContext& ctx) noexcept;

void initState(SimulationContext& ctx);

void step(SimulationContext& ctx, double dt_runoff, double old_runoff_time);

void bookPostLid(SimulationContext& ctx, double dt_runoff,
                 const std::vector<double>& lid_infil_vol);

void addLidDrain(SimulationContext& ctx, int control, int sc, int node, double drain_cfs,
                 bool to_perv, bool runoff_load, double dt_runoff,
                 const double* source = nullptr) noexcept;
void rollLidDrain(SimulationContext& ctx) noexcept;
void addLidDrainRunon(SimulationContext& ctx, int control, int sc, int receiver, double drain_cfs,
                      bool to_perv, bool runoff_load, double dt_runoff,
                      const double* source = nullptr) noexcept;
void consumeLidDrainRunon(SimulationContext& ctx, int receiver) noexcept;

void activateForRain(SimulationContext& ctx) noexcept;

void resolveLidRemovals(SimulationContext& ctx, std::vector<std::string>& warnings);

double remainingBuildup(const SimulationContext& ctx, int m) noexcept;

void clearRunon(SimulationContext& ctx) noexcept;
void addRunon(SimulationContext& ctx, int donor, int receiver, double q) noexcept;

void deliver(SimulationContext& ctx, double dt_routing);
 
} // namespace msxsurf
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_QUALITY_MSX_SURFACE_QUALITY_HPP