OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
HydrologyHandler.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
26
27#ifndef OPENSWMM_ENGINE_HYDROLOGY_HANDLER_HPP
28#define OPENSWMM_ENGINE_HYDROLOGY_HANDLER_HPP
29
30#include <vector>
31#include <string>
32
33namespace openswmm {
35}
36
37namespace openswmm::input {
38
40void handle_evaporation(SimulationContext& ctx, const std::vector<std::string>& lines);
41
43void handle_temperature(SimulationContext& ctx, const std::vector<std::string>& lines);
44
46void handle_snowpacks(SimulationContext& ctx, const std::vector<std::string>& lines);
47void handle_ueb_options(SimulationContext& ctx, const std::vector<std::string>& lines);
48void handle_mesh_snow_options(SimulationContext&, const std::vector<std::string>&);
49void handle_mesh_snow_defaults(SimulationContext&, const std::vector<std::string>&);
50void handle_mesh_snow_cells(SimulationContext&, const std::vector<std::string>&);
51
53void handle_aquifers(SimulationContext& ctx, const std::vector<std::string>& lines);
54
56void handle_groundwater(SimulationContext& ctx, const std::vector<std::string>& lines);
57
59void handle_gwf(SimulationContext& ctx, const std::vector<std::string>& lines);
60
62void handle_lid_controls(SimulationContext& ctx, const std::vector<std::string>& lines);
63
65void handle_lid_usage(SimulationContext& ctx, const std::vector<std::string>& lines);
66
67} /* namespace openswmm::input */
68
69#endif /* OPENSWMM_ENGINE_HYDROLOGY_HANDLER_HPP */
Definition CatchmentHandler.cpp:70
void handle_mesh_snow_cells(SimulationContext &ctx, const std::vector< std::string > &lines)
Parse explicit mesh-snow cell rows through the shared dispatch.
Definition HydrologyHandler.cpp:563
void handle_lid_usage(SimulationContext &ctx, const std::vector< std::string > &lines)
Append conventional LID deployment rows for known subcatchment/control names.
Definition HydrologyHandler.cpp:939
void handle_evaporation(SimulationContext &ctx, const std::vector< std::string > &lines)
Update evaporation source/options, monthly values and recovery flags.
Definition HydrologyHandler.cpp:237
void handle_lid_controls(SimulationContext &ctx, const std::vector< std::string > &lines)
Merge conventional or NODE LID type/layer/removal authoring.
Definition HydrologyHandler.cpp:818
void handle_ueb_options(SimulationContext &ctx, const std::vector< std::string > &lines)
Apply authored UEB option rows to snow configuration.
Definition HydrologyHandler.cpp:486
void handle_temperature(SimulationContext &ctx, const std::vector< std::string > &lines)
Update climate/snow forcing source and environmental authoring options.
Definition HydrologyHandler.cpp:292
void handle_aquifers(SimulationContext &ctx, const std::vector< std::string > &lines)
Append named legacy aquifer parameter sets and optional evaporation pattern.
Definition HydrologyHandler.cpp:580
void handle_mesh_snow_options(SimulationContext &ctx, const std::vector< std::string > &lines)
Parse mesh-snow option rows through the shared dispatch.
Definition HydrologyHandler.cpp:535
void handle_mesh_snow_defaults(SimulationContext &ctx, const std::vector< std::string > &lines)
Parse mesh-snow default/tag rows through the shared dispatch.
Definition HydrologyHandler.cpp:549
void handle_snowpacks(SimulationContext &ctx, const std::vector< std::string > &lines)
Merge snowpack surface/removal rows or delegate UEB authoring.
Definition HydrologyHandler.cpp:430
void handle_groundwater(SimulationContext &ctx, const std::vector< std::string > &lines)
Assign subcatchment groundwater exchange coefficients and optional overrides.
Definition HydrologyHandler.cpp:633
void handle_gwf(SimulationContext &ctx, const std::vector< std::string > &lines)
Validate and retain custom LATERAL/DEEP groundwater flow expressions.
Definition HydrologyHandler.cpp:724
Definition ExchangeLaw.hpp:60
Central, reentrant simulation context.
Definition SimulationContext.hpp:390