OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
Roadway.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
32
33#ifndef OPENSWMM_ROADWAY_HPP
34#define OPENSWMM_ROADWAY_HPP
35
36namespace openswmm {
37
38namespace roadway {
39
40enum class SurfaceType : int {
41 PAVED = 0,
43};
44
56double getFlow(double head_up, double head_down,
57 double road_width, double road_length,
58 SurfaceType surface, double& dqdh);
59
67double getDischargeCoeff(double hw_ratio, SurfaceType surface);
68
76double getSubmergenceFactor(double ht_ratio, SurfaceType surface);
77
78} // namespace roadway
79} // namespace openswmm
80
81#endif // OPENSWMM_ROADWAY_HPP
Definition Roadway.cpp:32
double getFlow(double head_up, double head_down, double road_width, double road_length, SurfaceType surface, double &dqdh)
Compute roadway weir overflow.
Definition Roadway.cpp:90
SurfaceType
Definition Roadway.hpp:40
@ GRAVEL
Definition Roadway.hpp:42
@ PAVED
Definition Roadway.hpp:41
double getDischargeCoeff(double hw_ratio, SurfaceType surface)
Get discharge coefficient Cr from head/width ratio.
Definition Roadway.cpp:71
double getSubmergenceFactor(double ht_ratio, SurfaceType surface)
Get submergence correction factor Kt.
Definition Roadway.cpp:83
Definition NodeCoupling.cpp:16