OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm::roadway Namespace Reference

Enumerations

enum class  SurfaceType : int {
  PAVED = 0 ,
  GRAVEL = 1
}
 

Functions

double getDischargeCoeff (double hw_ratio, SurfaceType surface)
 Get discharge coefficient Cr from head/width ratio.
 
double getSubmergenceFactor (double ht_ratio, SurfaceType surface)
 Get submergence correction factor Kt.
 
double getFlow (double head_up, double head_down, double road_width, double road_length, SurfaceType surface, double &dqdh)
 Compute roadway weir overflow.
 

Enumeration Type Documentation

◆ SurfaceType

enum class openswmm::roadway::SurfaceType : int
strong
Enumerator
PAVED 
GRAVEL 

Function Documentation

◆ getDischargeCoeff()

double openswmm::roadway::getDischargeCoeff ( double  hw_ratio,
SurfaceType  surface 
)

Get discharge coefficient Cr from head/width ratio.

Parameters
hw_ratiohead / road_width.
surfacePaved or gravel.
Returns
Discharge coefficient.
Here is the caller graph for this function:

◆ getFlow()

double openswmm::roadway::getFlow ( double  head_up,
double  head_down,
double  road_width,
double  road_length,
SurfaceType  surface,
double &  dqdh 
)

Compute roadway weir overflow.

Parameters
head_upUpstream head above road crest (ft).
head_downDownstream head above road crest (ft).
road_widthRoad width (ft).
road_lengthCrest length perpendicular to flow (ft).
surfaceRoad surface type.
[out]dqdhDerivative dQ/dH.
Returns
Overflow rate (cfs).
Here is the call graph for this function:

◆ getSubmergenceFactor()

double openswmm::roadway::getSubmergenceFactor ( double  ht_ratio,
SurfaceType  surface 
)

Get submergence correction factor Kt.

Parameters
ht_ratiohead_down / head_up.
surfacePaved or gravel.
Returns
Submergence factor (0-1).
Here is the caller graph for this function: