LidNode.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Caleb Buahin

 
#ifndef OPENSWMM_LID_NODE_HPP
#define OPENSWMM_LID_NODE_HPP
#include "../data/LidNodeData.hpp"
#include <string>
namespace openswmm {
struct SimulationContext;
namespace lidnode {
bool richardsMode(const SimulationContext& ctx, int node);
LidNodeBottom bottomMode(const SimulationContext& c, int node);
double exchangeRichardsPorts(SimulationContext& ctx, int link, double flow, double dt);
void prepareRichardsStep(SimulationContext& ctx, double dt, double evaporation,
                         bool mesh_prepared = false);
void refreshRichardsState(SimulationContext& ctx, int row);
void readRichards(SimulationContext& ctx, const std::vector<std::string>& lines);
std::vector<LidNodeLayer> layers(const SimulationContext& ctx, int control);
bool validLayer(const LidNodeLayer& l);
std::string validateStack(const std::vector<LidNodeLayer>& stack);
double thickness(const std::vector<LidNodeLayer>& stack);
// Validate references, layer stacks, MaxDepth and anchored offsets. Authored
// layer units remain unchanged; node/link values are canonical internal units.
void validate(SimulationContext& ctx);
void sync(SimulationContext& ctx, int control);
void initialize(SimulationContext& ctx);
// Reconstruct infiltration history from current physical moisture when loading
// a pre-V10 hot start. Exact continuation requires V10 history.
void initializeInfiltration(SimulationContext& ctx, int node);
void prepareStep(SimulationContext& ctx, double dt, double evaporation);
// Internal mixed-mode preparation after all Mesh columns share an accepted interval.
void prepareStepAfterMesh(SimulationContext& ctx, double dt, double evaporation);
void finishStep(SimulationContext& ctx);
// Internal Mesh cohort boundary. Every connected Mesh endpoint must belong to
// the same accepted interval/cohort. Other LID rows and GW clocks are untouched.
void finishRichardsNodes(SimulationContext& ctx, double start, double end,
                         const std::vector<int>& nodes);
// Global routing preflight, before loss/flow/Picard mutation. Returns whether
// Mesh owners are present; all must have accepted the current routing interval.
bool validateRichardsRouting(const SimulationContext& ctx, double dt);
void resetPorts(SimulationContext& ctx);
double portOffset(const SimulationContext& ctx, int link, int node);
// Physical interfaces belong to the cell above, allowing only roundoff-sized
// elevation differences. Shared by hydraulic and pollutant port coupling.
int portCell(const LidNodeState& state, double offset);
double portDepth(const SimulationContext& ctx, int node, double offset);
double exchangePorts(SimulationContext& ctx, int link, double flow, double dt);
double bottomConductivity(const SimulationContext& c, int storage_row);
double bottomCloggingFactor(const SimulationContext& c, int storage_row);
double heldVolume(const SimulationContext& ctx, int node);
bool active(const SimulationContext& ctx, int node);
bool validTreatment(const SimulationContext& ctx, const LidLayerTreatment& rule,
                    std::string& error);
void readTreatment(SimulationContext& ctx, const std::vector<std::string>& lines);
void prepareQuality(SimulationContext& ctx, double dt);
void prepareOutletQuality(SimulationContext& ctx, double dt, bool book_reaction);
bool receiveQuality(SimulationContext& ctx, int node, int link, double volume, int pollutant,
                    double mass, double dt);
double outletQuality(const SimulationContext& ctx, int node, int link, int pollutant,
                     double fallback);
double heldMass(const SimulationContext& ctx, int node, int pollutant);
void readNodes(SimulationContext& ctx, const std::vector<std::string>& lines);
void readOutlets(SimulationContext& ctx, const std::vector<std::string>& lines);
} // namespace lidnode
} // namespace openswmm
#endif