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 <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);

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

GwUnitFactors gwUnitFactors(const SimulationContext& ctx) noexcept;

std::vector<std::string> resolveSubsurface(SimulationContext& ctx,
                                           const MeshData& mesh,
                                           SubsurfaceConfig& cfg,
                                           const std::vector<std::string>& names);

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