LidNodeAquifer.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0

 
#pragma once
#include <vector>
namespace openswmm {
struct SimulationContext;
class Router;
namespace twoD {
class SubsurfaceSolver;
struct SurfaceStateData;
struct RichardsBedAcceptance;
}
namespace lidnode {
// Production column preparation at the single global hydraulic cadence.
// Accepted gross receipts wait for each receiving groundwater cell's clock.
void prepareMeshRichardsStep(SimulationContext& ctx, twoD::SubsurfaceSolver& gw,
                             twoD::SurfaceStateData& surface, double dt, double evaporation);
// Internal water-only real LID-state bridge at an explicit closed owner interval.
// Uses current node geometry, pressure limits, forcing and clogging; no new UI
// parameters. Successful preparation requires one finishStep after routing ports.
// Production cross-tier 1D scheduling and joint restart remain gated.
twoD::RichardsBedAcceptance
acceptRichardsNodesAtFiring(SimulationContext& ctx, twoD::SubsurfaceSolver& gw,
                            twoD::SurfaceStateData& surface, double start, double end,
                            double evaporation, const std::vector<int>& nodes);
// Same atomic real-state publication, replacing one actual due GW tier firing
// including its ordinary cells. Caller supplies all due Richards node owners.
twoD::RichardsBedAcceptance acceptRichardsNodesForTier(SimulationContext& ctx,
                                                       twoD::SubsurfaceSolver& gw,
                                                       twoD::SurfaceStateData& surface, int tier,
                                                       double start, double end, double evaporation,
                                                       const std::vector<int>& nodes);
// Internal atomic fixed-forcing conduit window. Native DW and mixed LID rows
// advance at step_ends; the due GW tier settles once. The caller supplies all
// Mesh nodes in the 1D network on that tier. Other GW tiers retain their clocks.
// No live source/face drivers, structure callbacks, ponding/flooding or restart.
twoD::RichardsBedAcceptance
routeRichardsNodesForTierWindow(SimulationContext& ctx, Router& router, twoD::SubsurfaceSolver& gw,
                                twoD::SurfaceStateData& surface, int tier, double start, double end,
                                const std::vector<double>& step_ends, double evaporation,
                                const std::vector<int>& nodes);
}
}