ReactionLegacyBinding.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_TRANSPORT_REACTION_LEGACY_BINDING_HPP
#define OPENSWMM_ENGINE_TRANSPORT_REACTION_LEGACY_BINDING_HPP
 
#include <limits>
 
namespace openswmm {
struct SimulationContext;
struct ReactionData;
}
 
namespace openswmm::transport {

bool legacyReactionsActive(const SimulationContext& ctx);

void ensureMsxState(SimulationContext& ctx);

void noteNegativeClamp(SimulationContext& ctx, const char* where);

double clampRateSpecies(const ReactionData& rx, bool tank, double* block, double* added);

void reactSpeciesBlock(SimulationContext& ctx, bool tank, double dt, double* species_block,
                       const double* pollut, double hrt_seconds,
                       double temp_c = std::numeric_limits<double>::quiet_NaN(), int element = -1);

void reactLegacyNodes(SimulationContext& ctx, double dt);

void reactLegacyLinks(SimulationContext& ctx, double dt);

void warnIfLegacyBindingBypassed(SimulationContext& ctx);
 
} // namespace openswmm::transport
 
#endif // OPENSWMM_ENGINE_TRANSPORT_REACTION_LEGACY_BINDING_HPP