SubsurfaceSections.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_2D_SUBSURFACE_SECTIONS_HPP
#define OPENSWMM_ENGINE_2D_SUBSURFACE_SECTIONS_HPP
 
#include "SubsurfaceData.hpp"
#include "../../input/SectionRegistry.hpp"
 
#include <string>
#include <functional>
#include <limits>
#include <vector>
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::twoD {
 
struct MeshData;

std::string parseAquiferOptionsLine(const std::vector<std::string>& tokens, GwOptions& opts);

std::string parseAquiferLine(const std::vector<std::string>& tokens,
                             std::vector<GwAquiferRow>& rows);

std::string parseAquiferNodeLine(const std::vector<std::string>& tokens,
                                 std::vector<GwNodeBed>& beds, std::vector<std::string>& names);

std::string parseAquiferLinkLine(const std::vector<std::string>& tokens,
                                 std::vector<GwLinkRow>& rows, std::vector<std::string>& names);

std::string parseAquiferBoundaryLine(const std::vector<std::string>& tokens,
                                     std::vector<GwBoundaryRow>& rows);

void registerSubsurfaceSections(SubsurfaceConfig& cfg, std::vector<std::string>& node_names,
                                std::vector<std::string>& link_names,
                                input::SectionRegistry& registry);

GwUnitFactors gwUnitFactors(const SimulationContext& ctx) noexcept;

std::vector<std::string> resolveSubsurface(SimulationContext& ctx, const MeshData& mesh,
                                           SubsurfaceConfig& cfg, std::vector<std::string>& names,
                                           double node_xy_to_mesh);
 
struct MeshPolylineInterval {
    int cell = -1;
    double begin = 0, end = 0; 
    double share = 1;          
};
struct MeshPolylineMapping {
    std::string error;
    double length = 0, covered_length = 0;
    bool cancelled = false;
    std::size_t interval_count = 0, contact_cells = 0;
    std::vector<MeshPolylineInterval> intervals;
};

MeshPolylineMapping
mapMeshPolyline(const MeshData&, const std::vector<double>& x, const std::vector<double>& y,
                const std::function<bool(int)>& progress = {}, std::size_t first_interval = 0,
                std::size_t max_intervals = std::numeric_limits<std::size_t>::max(),
                bool count_contact_cells = false);

std::vector<GwLinkShare> resolveLinkSeepage(SimulationContext& ctx, const MeshData& mesh,
                                            SubsurfaceConfig& cfg,
                                            std::vector<std::string>& link_names,
                                            double node_xy_to_mesh, int& n_conduits);

std::vector<GwSubcatchShare> resolveSubcatchInfiltration(const SimulationContext& ctx,
                                                         const MeshData& mesh,
                                                         double node_xy_to_mesh, int& n_subcatch);

void writeSubsurfaceSections(const SubsurfaceConfig& cfg,
                             const std::vector<std::string>& node_names,
                             const std::vector<std::string>& link_names, std::string& out,
                             bool full_precision = false);
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_SUBSURFACE_SECTIONS_HPP