OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
ReactionLegacyBinding.hpp
Go to the documentation of this file.
1// SPDX-License-Identifier: Apache-2.0
2//
3// Copyright 2026 Caleb Buahin
4//
5// Licensed under the Apache License, Version 2.0 (the "License");
6// you may not use this file except in compliance with the License.
7// You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16
47
48#ifndef OPENSWMM_ENGINE_TRANSPORT_REACTION_LEGACY_BINDING_HPP
49#define OPENSWMM_ENGINE_TRANSPORT_REACTION_LEGACY_BINDING_HPP
50
51#include <limits>
52
53namespace openswmm {
55}
56
57namespace openswmm::transport {
58
61bool legacyReactionsActive(const SimulationContext& ctx);
62
66void ensureMsxState(SimulationContext& ctx);
67
75void reactSpeciesBlock(SimulationContext& ctx, bool tank, double dt,
76 double* species_block, const double* pollut,
77 double hrt_seconds,
78 double temp_c = std::numeric_limits<double>::quiet_NaN());
79
82void reactLegacyNodes(SimulationContext& ctx, double dt);
83
88void reactLegacyLinks(SimulationContext& ctx, double dt);
89
96void warnIfLegacyBindingBypassed(SimulationContext& ctx);
97
98} // namespace openswmm::transport
99
100#endif // OPENSWMM_ENGINE_TRANSPORT_REACTION_LEGACY_BINDING_HPP
Definition ExplicitFvSolver.hpp:52
void reactLegacyNodes(SimulationContext &ctx, double dt)
Definition ReactionLegacyBinding.cpp:228
void ensureMsxState(SimulationContext &ctx)
Definition ReactionLegacyBinding.cpp:65
void reactLegacyLinks(SimulationContext &ctx, double dt)
Definition ReactionLegacyBinding.cpp:237
void warnIfLegacyBindingBypassed(SimulationContext &ctx)
Definition ReactionLegacyBinding.cpp:246
void reactSpeciesBlock(SimulationContext &ctx, bool tank, double dt, double *species_block, const double *pollut, double hrt_seconds, double temp_c)
Definition ReactionLegacyBinding.cpp:195
bool legacyReactionsActive(const SimulationContext &ctx)
Definition ReactionLegacyBinding.cpp:224
Definition NodeCoupling.cpp:16
Central, reentrant simulation context.
Definition SimulationContext.hpp:353