SectionHandlers2D.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_SECTION_HANDLERS_HPP
#define OPENSWMM_ENGINE_2D_SECTION_HANDLERS_HPP
 
#include "../data/MeshData.hpp"
#include "../data/SolverOptions2D.hpp"
#include "../infil/Infil2D.hpp"
#include "../SurfaceRouter2D.hpp"
#include "../../input/SectionRegistry.hpp"
 
#include <span>
#include <string>
#include <vector>
 
namespace openswmm::twoD {

std::string parse2DOptionsLine(const std::vector<std::string>& tokens, SolverOptions2D& opts,
                               std::vector<std::string>* warnings = nullptr);

std::string parse2DVertexLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string parse2DTriangleLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string parse2DQuadLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string parse2DInitialVelocityLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string parse2DVertexNodeMapLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string parse2DTriangleNodeMapLine(const std::vector<std::string>& tokens, MeshData& mesh);

std::string
parse2DBoundaryConditionsLine(const std::vector<std::string>& tokens,
                              std::vector<SurfaceRouter2D::PendingBoundaryRow>& pending_rows);

std::string
parse2DEdgeConveyanceLine(const std::vector<std::string>& tokens,
                          std::vector<SurfaceRouter2D::PendingEdgeConveyanceRow>& pending_rows);

std::string parse2DInfiltrationOptionsLine(const std::vector<std::string>& tokens, Infil2D& infil);

std::string parse2DInfiltrationDefaultsLine(const std::vector<std::string>& tokens, Infil2D& infil);

std::string parse2DInfiltrationLine(const std::vector<std::string>& tokens, Infil2D& infil);

bool is2DOptionKey(const std::string& key);

std::span<const char* const> current2DOptionKeys();

bool is2DRetiredOptionKey(const std::string& key);

const std::vector<std::string>& report2DVarTokens();
std::string parseReport2DVars(const std::string& text, unsigned& mask);
std::string formatReport2DVars(unsigned mask);

std::string format2DOptionValue(const SolverOptions2D& opts, const std::string& key);

std::string format2DOptionValueEx(const SolverOptions2D& opts, const Infil2D* infil,
                                  const std::string& key);

std::string format2DOptionValueEx(const SolverOptions2D& opts, const Infil2D* infil,
                                  const SubsurfaceConfig* aquifer, const std::string& key);

void register2DSections(MeshData& mesh, SolverOptions2D& options,
                        std::vector<SurfaceRouter2D::PendingBoundaryRow>& pending_bc_rows,
                        std::vector<SurfaceRouter2D::PendingEdgeConveyanceRow>& pending_ec_rows,
                        std::vector<SurfaceRouter2D::PendingInitialQualityRow>& pending_iq_rows,
                        std::vector<SurfaceRouter2D::PendingInitialBedQualityRow>& pending_ibq_rows,
                        std::vector<SurfaceRouter2D::PendingBoundaryQualityRow>& pending_bq_rows,
                        input::SectionRegistry& registry);

std::string parse2DInitialQualityLine(const std::vector<std::string>& tokens,
                                      std::vector<SurfaceRouter2D::PendingInitialQualityRow>& rows);

std::string
parse2DInitialBedQualityLine(const std::vector<std::string>& tokens,
                             std::vector<SurfaceRouter2D::PendingInitialBedQualityRow>& rows);

std::string
parse2DBoundaryQualityLine(const std::vector<std::string>& tokens,
                           std::vector<SurfaceRouter2D::PendingBoundaryQualityRow>& rows);

std::string load2DMeshExternalFile(
    MeshData& mesh, SolverOptions2D& opts,
    std::vector<SurfaceRouter2D::PendingBoundaryRow>& pending_bc_rows,
    std::vector<SurfaceRouter2D::PendingEdgeConveyanceRow>& pending_ec_rows, Infil2D* infil,
    const std::string& mesh_file, const std::string& inp_base_dir,
    std::vector<std::string>* warnings = nullptr,
    std::vector<SurfaceRouter2D::PendingInitialQualityRow>* pending_iq_rows = nullptr,
    std::vector<SurfaceRouter2D::PendingInitialBedQualityRow>* pending_ibq_rows = nullptr,
    std::vector<SurfaceRouter2D::PendingBoundaryQualityRow>* pending_bq_rows = nullptr);

void prescan2DUnitsHeader(const std::string& inp_path, SolverOptions2D& opts);
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_SECTION_HANDLERS_HPP