OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
SurfaceSolverFactory.hpp
Go to the documentation of this file.
1// SPDX-License-Identifier: Apache-2.0
2//
3// Copyright 2026 Caleb Buahin
4//
5// Licensed under the Apache License, Version 2.0 (the "License");
6// you may not use this file except in compliance with the License.
7// You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16
53
54#ifndef OPENSWMM_ENGINE_2D_SURFACE_SOLVER_FACTORY_HPP
55#define OPENSWMM_ENGINE_2D_SURFACE_SOLVER_FACTORY_HPP
56
57#include <memory>
58#include <string>
59#include "GwRechargeBackend.hpp"
60
61namespace openswmm::twoD {
62
63struct SolverOptions2D;
64class ISurfaceSolver;
65
99std::unique_ptr<ISurfaceSolver> makeSurfaceSolver(const SolverOptions2D& opts,
100 std::string* chosen = nullptr, int n_cells = 0,
101 bool plugin_capable = true);
102
122
123} // namespace openswmm::twoD
124
125#endif // OPENSWMM_ENGINE_2D_SURFACE_SOLVER_FACTORY_HPP
Backend contract for groundwater recharge operations.
Abstract time integrator for the 2D surface-routing ODE system.
Definition ISurfaceSolver.hpp:61
Definition ExchangeLaw.hpp:60
std::unique_ptr< ISurfaceSolver > makeSurfaceSolver(const SolverOptions2D &opts, std::string *chosen=nullptr, int n_cells=0, bool plugin_capable=true)
Construct the 2D surface solver per the runtime backend policy.
GwRechargeBackend makeGwRechargeBackend(const SolverOptions2D &opts, int n_cells)
Optional stateless host recharge operator. Surface/water/transfer ownership stays with the built-in m...
Definition GwRechargeBackend.hpp:17
Definition SolverOptions2D.hpp:257