BedExchange.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_BED_EXCHANGE_HPP
#define OPENSWMM_ENGINE_TRANSPORT_BED_EXCHANGE_HPP
 
#include "../../../data/BedZoneData.hpp"   // SedimentConfig (light header)
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::transport::heat {

struct BedCoupling {
    double g_wb = 0.0;  
    double g_bg = 0.0;  
    double c_w  = 0.0;  
    double c_b  = 0.0;  
    double t_gr = 0.0;  

    bool viable() const noexcept { return c_w > 0.0 && c_b > 0.0; }
};

struct PairStep {
    double dt_w = 0.0;  
    double dt_b = 0.0;  
};

PairStep relaxPair(const BedCoupling& g, double t_w, double t_b,
                   double j0, double j1, double h, double area_m2,
                   double dt) noexcept;

struct SolutePairStep {
    double dc_w = 0.0;  
    double dc_b = 0.0;  
};

SolutePairStep exchangePair(double c_w, double c_b, double vol_w,
                            double vol_b, double q_exch, double dt) noexcept;

BedCoupling bedCouplingForLink(const SimulationContext& ctx, int link,
                               double vol_ft3, double t_gr) noexcept;

BedCoupling bedCouplingFromContact(const SimulationContext& ctx,
                                   const SedimentConfig& sc,
                                   double bed_m2, double vol_ft3,
                                   double t_gr) noexcept;

double groundTempFor(const SimulationContext& ctx, const SedimentConfig& sc,
                     double t_gr_global) noexcept;

double bedExchangeQ(const SedimentConfig& cfg, double bed_m2) noexcept;

double linkBedAreaM2(const SimulationContext& ctx, int link) noexcept;

double linkFreeSurfaceFt2(const SimulationContext& ctx, int link) noexcept;

double groundTemperature(SimulationContext& ctx) noexcept;

bool bedExchangeEnabled(const SimulationContext& ctx) noexcept;

void seedBedTemperature(SimulationContext& ctx);

void applyBedSoluteExchange(SimulationContext& ctx, double* link_conc,
                            int n_arr, int offset, int n_total, double dt);
 
}  // namespace openswmm::transport::heat
 
#endif  // OPENSWMM_ENGINE_TRANSPORT_BED_EXCHANGE_HPP