GwTransportSections.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_GW_TRANSPORT_SECTIONS_HPP
#define OPENSWMM_ENGINE_2D_GW_TRANSPORT_SECTIONS_HPP
 
#include "GwTransportData.hpp"
#include "../../input/SectionRegistry.hpp"
 
#include <string>
#include <vector>
 
namespace openswmm {
struct SimulationContext;
}
 
namespace openswmm::twoD {
 
struct MeshData;

std::string parseGwTransportOptionsLine(const std::vector<std::string>& tokens,
                                        GwTransportOptions& opts);

std::string parseGwParamsLine(const std::vector<std::string>& tokens,
                              std::vector<GwParamsRow>& rows);

std::string parseGwSorptionLine(const std::vector<std::string>& tokens,
                                std::vector<GwSorptionRow>& rows);

std::string parseGwInitialQualityLine(const std::vector<std::string>& tokens,
                                      std::vector<GwInitialQualityRow>& rows,
                                      std::string& file);

std::string parseGwBoundaryQualityLine(const std::vector<std::string>& tokens,
                                       std::vector<GwBoundaryQualityRow>& rows);

std::string parseGwSourcesLine(const std::vector<std::string>& tokens,
                               std::vector<GwSourceRow>& rows);

void registerGwTransportSections(GwTransportData& gw,
                                 input::SectionRegistry& registry);

std::vector<std::string> resolveGwTransport(SimulationContext& ctx,
                                            const MeshData& mesh,
                                            GwTransportData& gw);

std::string gwTransportInertWarning(const GwTransportData& gw);
 
}  // namespace openswmm::twoD
 
#endif  // OPENSWMM_ENGINE_2D_GW_TRANSPORT_SECTIONS_HPP