OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches

Enumerated constants used in the SWMM model. More...

Collaboration diagram for SWMM Enumerations:

Macros

#define MAX_NODE_TYPES   5
 Maximum number of node types.
 
#define MAX_LINK_TYPES   5
 Maximum number of link types.
 
#define MAX_SUBCATCH_RESULTS   9
 Maximum number of subcatchment results.
 
#define MAX_NODE_RESULTS   7
 Maximum number of node results.
 
#define MAX_LINK_RESULTS   6
 Maximum number of link results.
 
#define MAX_SYS_RESULTS   15
 Maximum number of system results.
 

Enumerations

enum  ObjectType {
  GAGE ,
  SUBCATCH ,
  NODE ,
  LINK ,
  POLLUT ,
  LANDUSE ,
  TIMEPATTERN ,
  CURVE ,
  TSERIES ,
  CONTROL ,
  TRANSECT ,
  AQUIFER ,
  UNITHYD ,
  SNOWMELT ,
  SHAPE ,
  LID ,
  STREET ,
  INLET ,
  MAX_OBJ_TYPES
}
 Enumeration of object types used in SWMM5. More...
 
enum  NodeType {
  JUNCTION ,
  OUTFALL ,
  STORAGE ,
  DIVIDER
}
 Enumeration of node sub-types used in SWMM5. More...
 
enum  LinkType {
  CONDUIT ,
  PUMP ,
  ORIFICE ,
  WEIR ,
  OUTLET
}
 Enumeration of link sub-types used in SWMM5. More...
 
enum  FileType {
  RAINFALL_FILE ,
  RUNOFF_FILE ,
  HOTSTART_FILE ,
  RDII_FILE ,
  INFLOWS_FILE ,
  OUTFLOWS_FILE
}
 Enumeration of file types used in SWMM5. More...
 
enum  FileUsageType {
  NO_FILE ,
  SCRATCH_FILE ,
  USE_FILE ,
  SAVE_FILE
}
 Enumeration of file usage types used in SWMM5. More...
 
enum  GageDataType {
  RAIN_TSERIES ,
  RAIN_FILE
}
 Enumeration of rain gage data types used in SWMM5. More...
 
enum  XsectType {
  DUMMY ,
  CIRCULAR ,
  FILLED_CIRCULAR ,
  RECT_CLOSED ,
  RECT_OPEN ,
  TRAPEZOIDAL ,
  TRIANGULAR ,
  PARABOLIC ,
  POWERFUNC ,
  RECT_TRIANG ,
  RECT_ROUND ,
  MOD_BASKET ,
  HORIZ_ELLIPSE ,
  VERT_ELLIPSE ,
  ARCH ,
  EGGSHAPED ,
  HORSESHOE ,
  GOTHIC ,
  CATENARY ,
  SEMIELLIPTICAL ,
  BASKETHANDLE ,
  SEMICIRCULAR ,
  IRREGULAR ,
  CUSTOM ,
  FORCE_MAIN ,
  STREET_XSECT
}
 Enumeration of cross section shape types used in SWMM5. More...
 
enum  UnitsType {
  US ,
  SI
}
 Enumeration of measurement units types used in SWMM5. More...
 
enum  FlowUnitsType {
  CFS ,
  GPM ,
  MGD ,
  CMS ,
  LPS ,
  MLD
}
 Enumeration of flow units types used in SWMM5. More...
 
enum  ConcUnitsType {
  MG ,
  UG ,
  COUNT
}
 
enum  ConversionType {
  RAINFALL ,
  RAINDEPTH ,
  EVAPRATE ,
  LENGTH ,
  LANDAREA ,
  VOLUME ,
  WINDSPEED ,
  TEMPERATURE ,
  MASS ,
  GWFLOW ,
  FLOW
}
 Quanties requiring unit conversions in SWMM5. More...
 
enum  SubcatchResultType {
  SUBCATCH_RAINFALL ,
  SUBCATCH_SNOWDEPTH ,
  SUBCATCH_EVAP ,
  SUBCATCH_INFIL ,
  SUBCATCH_RUNOFF ,
  SUBCATCH_GW_FLOW ,
  SUBCATCH_GW_ELEV ,
  SUBCATCH_SOIL_MOIST ,
  SUBCATCH_WASHOFF
}
 Enumeration of computed subcatchment quantities. More...
 
enum  NodeResultType {
  NODE_DEPTH ,
  NODE_HEAD ,
  NODE_VOLUME ,
  NODE_LATFLOW ,
  NODE_INFLOW ,
  NODE_OVERFLOW ,
  NODE_QUAL
}
 Enumeration of computed node quantities. More...
 
enum  LinkResultType {
  LINK_FLOW ,
  LINK_DEPTH ,
  LINK_VELOCITY ,
  LINK_VOLUME ,
  LINK_CAPACITY ,
  LINK_QUAL
}
 Enumeration of computed link quantities. More...
 
enum  SysFlowType {
  SYS_TEMPERATURE ,
  SYS_RAINFALL ,
  SYS_SNOWDEPTH ,
  SYS_INFIL ,
  SYS_RUNOFF ,
  SYS_DWFLOW ,
  SYS_GWFLOW ,
  SYS_IIFLOW ,
  SYS_EXFLOW ,
  SYS_INFLOW ,
  SYS_FLOODING ,
  SYS_OUTFLOW ,
  SYS_STORAGE ,
  SYS_EVAP ,
  SYS_PET
}
 
enum  FlowClassType {
  DRY ,
  UP_DRY ,
  DN_DRY ,
  SUBCRITICAL ,
  SUPCRITICAL ,
  UP_CRITICAL ,
  DN_CRITICAL ,
  MAX_FLOW_CLASSES ,
  UP_FULL ,
  DN_FULL ,
  ALL_FULL
}
 Enumeration of conduit flow classifications. More...
 
enum  RunoffFlowType {
  RUNOFF_RAINFALL ,
  RUNOFF_EVAP ,
  RUNOFF_INFIL ,
  RUNOFF_RUNOFF ,
  RUNOFF_DRAINS ,
  RUNOFF_RUNON
}
 Enumeration of runoff flow categories. More...
 
enum  LoadingType {
  BUILDUP_LOAD ,
  DEPOSITION_LOAD ,
  SWEEPING_LOAD ,
  BMP_REMOVAL_LOAD ,
  INFIL_LOAD ,
  RUNOFF_LOAD ,
  FINAL_LOAD
}
 Enumeration of surface pollutant loading categories. More...
 
enum  RainfallType {
  RAINFALL_INTENSITY ,
  RAINFALL_VOLUME ,
  CUMULATIVE_RAINFALL
}
 Enumeration of rainfall input data type options. More...
 
enum  TempType {
  NO_TEMP ,
  TSERIES_TEMP ,
  FILE_TEMP
}
 Enumeration of temperature data type options. More...
 
enum  WindType {
  MONTHLY_WIND ,
  FILE_WIND
}
 Enumeration of wind speed data type options. More...
 
enum  EvapType {
  CONSTANT_EVAP ,
  MONTHLY_EVAP ,
  TIMESERIES_EVAP ,
  TEMPERATURE_EVAP ,
  FILE_EVAP ,
  RECOVERY ,
  DRYONLY
}
 Enumeration of evaporation data type options. More...
 
enum  NormalizerType {
  PER_AREA ,
  PER_CURB
}
 Enumeration of buildup normalization options. More...
 
enum  BuildupType {
  NO_BUILDUP ,
  POWER_BUILDUP ,
  EXPON_BUILDUP ,
  SATUR_BUILDUP ,
  EXTERNAL_BUILDUP
}
 Enumeration of pollutant buildup function types. More...
 
enum  WashoffType {
  NO_WASHOFF ,
  EXPON_WASHOFF ,
  RATING_WASHOFF ,
  EMC_WASHOFF
}
 Enumeration of pollutant washoff function types. More...
 
enum  SubAreaType {
  IMPERV0 ,
  IMPERV1 ,
  PERV
}
 Enumeration of subcatchment area types. More...
 
enum  RunoffRoutingType {
  TO_OUTLET ,
  TO_IMPERV ,
  TO_PERV
}
 Enumeration of runoff routing types. More...
 
enum  RouteModelType {
  NO_ROUTING ,
  SF ,
  KW ,
  EKW ,
  DW
}
 Enumeration of routing model types. More...
 
enum  ForceMainType {
  H_W ,
  D_W
}
 Enumeration of force main friction loss models. More...
 
enum  OffsetType {
  DEPTH_OFFSET ,
  ELEV_OFFSET
}
 Enumeration of node offset types. More...
 
enum  KinWaveMethodType {
  NORMAL ,
  MODIFIED
}
 Enumeration of kinematic wave routing methods. More...
 
enum  CompatibilityType {
  SWMM5 ,
  SWMM3 ,
  SWMM4
}
 Enumeration of SWMM5 compatibility types. More...
 
enum  NormalFlowType {
  SLOPE ,
  FROUDE ,
  BOTH ,
  NEITHER
}
 Enumeration of normal flow computation methods. More...
 
enum  InertialDampingType {
  NO_DAMPING ,
  PARTIAL_DAMPING ,
  FULL_DAMPING
}
 Enumeration of inertial damping options. More...
 
enum  SurchargeMethodType {
  EXTRAN ,
  SLOT
}
 Enumeration of surcharge method types. More...
 
enum  InflowType {
  EXTERNAL_INFLOW ,
  DRY_WEATHER_INFLOW ,
  WET_WEATHER_INFLOW ,
  GROUNDWATER_INFLOW ,
  RDII_INFLOW ,
  FLOW_INFLOW ,
  CONCEN_INFLOW ,
  MASS_INFLOW
}
 Enumeration of inflow method types. More...
 
enum  PatternType {
  MONTHLY_PATTERN ,
  DAILY_PATTERN ,
  HOURLY_PATTERN ,
  WEEKEND_PATTERN
}
 Enumeration of time pattern types. More...
 
enum  OutfallType {
  FREE_OUTFALL ,
  NORMAL_OUTFALL ,
  FIXED_OUTFALL ,
  TIDAL_OUTFALL ,
  TIMESERIES_OUTFALL
}
 Enumeration of outfall types. More...
 
enum  StorageType {
  TABULAR ,
  FUNCTIONAL ,
  CYLINDRICAL ,
  CONICAL ,
  PARABOLOID ,
  PYRAMIDAL
}
 Enumeration of storage node types. More...
 
enum  ReactorType {
  CSTR ,
  PLUG
}
 Enumeration of reactor types. More...
 
enum  TreatmentType {
  REMOVAL ,
  CONCEN
}
 Enumeration of pollutant treatment types. More...
 
enum  DividerType {
  CUTOFF_DIVIDER ,
  TABULAR_DIVIDER ,
  WEIR_DIVIDER ,
  OVERFLOW_DIVIDER
}
 Enumeration of flow divider types. More...
 
enum  PumpCurveType {
  TYPE1_PUMP ,
  TYPE2_PUMP ,
  TYPE3_PUMP ,
  TYPE4_PUMP ,
  TYPE5_PUMP ,
  IDEAL_PUMP
}
 Enumeration of pump curve types. More...
 
enum  OrificeType {
  SIDE_ORIFICE ,
  BOTTOM_ORIFICE
}
 Enumeration of orifice types. More...
 
enum  WeirType {
  TRANSVERSE_WEIR ,
  SIDEFLOW_WEIR ,
  VNOTCH_WEIR ,
  TRAPEZOIDAL_WEIR ,
  ROADWAY_WEIR
}
 Enumeration of weir types. More...
 
enum  CurveType {
  STORAGE_CURVE ,
  DIVERSION_CURVE ,
  TIDAL_CURVE ,
  RATING_CURVE ,
  CONTROL_CURVE ,
  SHAPE_CURVE ,
  WEIR_CURVE ,
  PUMP1_CURVE ,
  PUMP2_CURVE ,
  PUMP3_CURVE ,
  PUMP4_CURVE ,
  PUMP5_CURVE
}
 Enumeration of curve types. More...
 
enum  NodeInletType {
  NO_INLET ,
  BYPASS ,
  CAPTURE
}
 Enumeration of node inlet types. More...
 
enum  InputSectionType {
  s_TITLE ,
  s_OPTION ,
  s_FILE ,
  s_RAINGAGE ,
  s_TEMP ,
  s_EVAP ,
  s_SUBCATCH ,
  s_SUBAREA ,
  s_INFIL ,
  s_AQUIFER ,
  s_GROUNDWATER ,
  s_SNOWMELT ,
  s_JUNCTION ,
  s_OUTFALL ,
  s_STORAGE ,
  s_DIVIDER ,
  s_CONDUIT ,
  s_PUMP ,
  s_ORIFICE ,
  s_WEIR ,
  s_OUTLET ,
  s_XSECTION ,
  s_TRANSECT ,
  s_LOSSES ,
  s_CONTROL ,
  s_POLLUTANT ,
  s_LANDUSE ,
  s_BUILDUP ,
  s_WASHOFF ,
  s_COVERAGE ,
  s_INFLOW ,
  s_DWF ,
  s_PATTERN ,
  s_RDII ,
  s_UNITHYD ,
  s_LOADING ,
  s_TREATMENT ,
  s_CURVE ,
  s_TIMESERIES ,
  s_REPORT ,
  s_COORDINATE ,
  s_VERTICES ,
  s_POLYGON ,
  s_LABEL ,
  s_SYMBOL ,
  s_BACKDROP ,
  s_TAG ,
  s_PROFILE ,
  s_MAP ,
  s_LID_CONTROL ,
  s_LID_USAGE ,
  s_GWF ,
  s_ADJUST ,
  s_EVENT ,
  s_STREET ,
  s_INLET_USAGE ,
  s_INLET
}
 Enumeration of input file section types. More...
 
enum  InputOptionType {
  FLOW_UNITS ,
  INFIL_MODEL ,
  ROUTE_MODEL ,
  START_DATE ,
  START_TIME ,
  END_DATE ,
  END_TIME ,
  REPORT_START_DATE ,
  REPORT_START_TIME ,
  SWEEP_START ,
  SWEEP_END ,
  START_DRY_DAYS ,
  WET_STEP ,
  DRY_STEP ,
  ROUTE_STEP ,
  RULE_STEP ,
  REPORT_STEP ,
  ALLOW_PONDING ,
  INERT_DAMPING ,
  SLOPE_WEIGHTING ,
  VARIABLE_STEP ,
  NORMAL_FLOW_LTD ,
  LENGTHENING_STEP ,
  MIN_SURFAREA ,
  COMPATIBILITY ,
  SKIP_STEADY_STATE ,
  TEMPDIR ,
  IGNORE_RAINFALL ,
  FORCE_MAIN_EQN ,
  LINK_OFFSETS ,
  MIN_SLOPE ,
  IGNORE_SNOWMELT ,
  IGNORE_GWATER ,
  IGNORE_ROUTING ,
  IGNORE_QUALITY ,
  MAX_TRIALS ,
  HEAD_TOL ,
  SYS_FLOW_TOL ,
  LAT_FLOW_TOL ,
  IGNORE_RDII ,
  MIN_ROUTE_STEP ,
  NUM_THREADS ,
  SURCHARGE_METHOD
}
 Enumeration of input file option types. More...
 
enum  NoYesType {
  NO ,
  YES
}
 Enumeration of no/yes options. More...
 
enum  NoneAllType {
  NONE ,
  ALL ,
  SOME
}
 Enumeration of none/all/some options. More...
 

Detailed Description

Enumerated constants used in the SWMM model.

Macro Definition Documentation

◆ MAX_LINK_RESULTS

#define MAX_LINK_RESULTS   6

Maximum number of link results.

◆ MAX_LINK_TYPES

#define MAX_LINK_TYPES   5

Maximum number of link types.

◆ MAX_NODE_RESULTS

#define MAX_NODE_RESULTS   7

Maximum number of node results.

◆ MAX_NODE_TYPES

#define MAX_NODE_TYPES   5

Maximum number of node types.

◆ MAX_SUBCATCH_RESULTS

#define MAX_SUBCATCH_RESULTS   9

Maximum number of subcatchment results.

◆ MAX_SYS_RESULTS

#define MAX_SYS_RESULTS   15

Maximum number of system results.

Enumeration Type Documentation

◆ BuildupType

Enumeration of pollutant buildup function types.

Enumerator
NO_BUILDUP 

No buildup.

POWER_BUILDUP 

Power function buildup.

EXPON_BUILDUP 

Exponential function buildup.

SATUR_BUILDUP 

Saturation function buildup.

EXTERNAL_BUILDUP 

External time series buildup.

◆ CompatibilityType

Enumeration of SWMM5 compatibility types.

Enumerator
SWMM5 

SWMM 5.0 weighting for area & hyd. radius.

SWMM3 

SWMM 3 weighting.

SWMM4 

SWMM 4 weighting.

◆ ConcUnitsType

Enumerator
MG 

Milligrams per liter.

UG 

Micrograms per liter.

COUNT 

Counts per liter.

◆ ConversionType

Quanties requiring unit conversions in SWMM5.

Enumerator
RAINFALL 

Rainfall.

RAINDEPTH 

Rain depth.

EVAPRATE 

Evaporation rate.

LENGTH 

Length.

LANDAREA 

Land area.

VOLUME 

Volume.

WINDSPEED 

Wind speed.

TEMPERATURE 

Temperature.

MASS 

Mass.

GWFLOW 

Groundwater flow.

FLOW 

Flow rate.

◆ CurveType

enum CurveType

Enumeration of curve types.

Enumerator
STORAGE_CURVE 

Surface area v. depth for storage node.

DIVERSION_CURVE 

Diverted flow v. inflow for divider node.

TIDAL_CURVE 

Water elev. v. hour of day for outfall.

RATING_CURVE 

Flow rate v. head for outlet link.

CONTROL_CURVE 

Control setting v. controller variable.

SHAPE_CURVE 

Width v. depth for custom x-section.

WEIR_CURVE 

Discharge coeff. v. head for weir.

PUMP1_CURVE 

Flow v. wet well volume for pump.

PUMP2_CURVE 

Flow v. depth for pump (discrete)

PUMP3_CURVE 

Flow v. head for pump (continuous)

PUMP4_CURVE 

Flow v. depth for pump (continuous)

PUMP5_CURVE 

Variable speed version of TYPE3 pump.

◆ DividerType

Enumeration of flow divider types.

Enumerator
CUTOFF_DIVIDER 

Diverted flow is excess of cutoff flow.

TABULAR_DIVIDER 

Table of diverted flow versus inflow.

WEIR_DIVIDER 

Diverted flow proportional to excess flow.

OVERFLOW_DIVIDER 

Diverted flow if flow > full conduit flow.

◆ EvapType

enum EvapType

Enumeration of evaporation data type options.

Enumerator
CONSTANT_EVAP 

Constant evaporation rate.

MONTHLY_EVAP 

Evaporation rate varies by month.

TIMESERIES_EVAP 

Evaporation rate from time series.

TEMPERATURE_EVAP 

Evaporation rate from daily temperature.

FILE_EVAP 

Evaporation rate from climate file.

RECOVERY 

Soil moisture recovery pattern.

DRYONLY 

Evaporation allowed only in dry periods.

◆ FileType

enum FileType

Enumeration of file types used in SWMM5.

Enumerator
RAINFALL_FILE 

Rainfall file.

RUNOFF_FILE 

Runoff file.

HOTSTART_FILE 

Hotstart file.

RDII_FILE 

RDII file.

INFLOWS_FILE 

Infows interface file.

OUTFLOWS_FILE 

Outflows interface file.

◆ FileUsageType

Enumeration of file usage types used in SWMM5.

Enumerator
NO_FILE 

No file usage.

SCRATCH_FILE 

Temporary scratch file.

USE_FILE 

Use previously saved file.

SAVE_FILE 

Save file currently in use.

◆ FlowClassType

Enumeration of conduit flow classifications.

Enumerator
DRY 

Dry conduit.

UP_DRY 

Upstream end is dry.

DN_DRY 

Downstream end is dry.

SUBCRITICAL 

Subcritical flow.

SUPCRITICAL 

Supercritical flow.

UP_CRITICAL 

Free-fall at the upstream end.

DN_CRITICAL 

Free-fall at the downstream end.

MAX_FLOW_CLASSES 

Number of distinct flow classes.

UP_FULL 

Upstream end is full.

DN_FULL 

Downstream end is full.

ALL_FULL 

Completely full conduit.

◆ FlowUnitsType

Enumeration of flow units types used in SWMM5.

Enumerator
CFS 

Cubic feet per second.

GPM 

Gallons per minute.

MGD 

Million gallons per day.

CMS 

Cubic meters per second.

LPS 

Liters per second.

MLD 

Million liters per day.

◆ ForceMainType

Enumeration of force main friction loss models.

Enumerator
H_W 

Hazen-Williams equation.

D_W 

Darcy-Weisbach equation.

◆ GageDataType

Enumeration of rain gage data types used in SWMM5.

Enumerator
RAIN_TSERIES 

Rainfall from user-supplied time series.

RAIN_FILE 

Rainfall from external file.

◆ InertialDampingType

Enumeration of inertial damping options.

Enumerator
NO_DAMPING 

No inertial damping.

PARTIAL_DAMPING 

Partial inertial damping.

FULL_DAMPING 

Full inertial damping.

◆ InflowType

enum InflowType

Enumeration of inflow method types.

Enumerator
EXTERNAL_INFLOW 

User supplied external inflow.

DRY_WEATHER_INFLOW 

User supplied dry weather inflow.

WET_WEATHER_INFLOW 

Computed runoff inflow.

GROUNDWATER_INFLOW 

Computed groundwater inflow.

RDII_INFLOW 

Computed I&I inflow.

FLOW_INFLOW 

Inflow parameter is flow.

CONCEN_INFLOW 

Inflow parameter is pollutant concen.

MASS_INFLOW 

Inflow parameter is pollutant mass.

◆ InputOptionType

Enumeration of input file option types.

Enumerator
FLOW_UNITS 

Flow units.

INFIL_MODEL 

Infiltration modeling method.

ROUTE_MODEL 

Flow routing method.

START_DATE 

Starting date of simulation.

START_TIME 

Starting time of simulation.

END_DATE 

Ending date of simulation.

END_TIME 

Ending time of simulation.

REPORT_START_DATE 

Reporting start date.

REPORT_START_TIME 

Reporting start time.

SWEEP_START 

Sweep start date.

SWEEP_END 

Sweep end date.

START_DRY_DAYS 

Start dry days.

WET_STEP 

Wet weather flow routing time step.

DRY_STEP 

Dry weather flow routing time step.

ROUTE_STEP 

Flow routing time step.

RULE_STEP 

Control rule time step.

REPORT_STEP 

Reporting time step.

ALLOW_PONDING 

Allow ponding.

INERT_DAMPING 

Inertial dampening option.

SLOPE_WEIGHTING 

Slope weighting for dynamic wave routing.

VARIABLE_STEP 

Variable step method.

NORMAL_FLOW_LTD 

Normal flow limitation.

LENGTHENING_STEP 

Lengthening step for dynamic wave routing.

MIN_SURFAREA 

Minimum surface area for dynamic wave routing.

COMPATIBILITY 

Compatibility option.

SKIP_STEADY_STATE 

Skip steady state option.

TEMPDIR 

Temporary directory.

IGNORE_RAINFALL 

Ignore rainfall.

FORCE_MAIN_EQN 

Force main equation.

LINK_OFFSETS 

Link offsets.

MIN_SLOPE 

Minimum conduit slope.

IGNORE_SNOWMELT 

Ignore snowmelt.

IGNORE_GWATER 

Ignore groundwater.

IGNORE_ROUTING 

Ignore routing.

IGNORE_QUALITY 

Ignore quality.

MAX_TRIALS 

Maximum number of iterations trials for dynamic wave routing solver.

HEAD_TOL 

Head convergence tolerance for dynamic wave routing solver.

SYS_FLOW_TOL 

System flow tolerance for dynamic wave routing solver.

LAT_FLOW_TOL 

Lateral inflow tolerance for dynamic wave routing solver.

IGNORE_RDII 

Ignore RDII.

MIN_ROUTE_STEP 

Minimum route step.

NUM_THREADS 

Number of threads.

SURCHARGE_METHOD 

Surcharge method.

◆ InputSectionType

Enumeration of input file section types.

Enumerator
s_TITLE 

Title section.

s_OPTION 

Options section.

s_FILE 

Input files section.

s_RAINGAGE 

Raingage section.

s_TEMP 

Temperature data section.

s_EVAP 

Evaporation data section.

s_SUBCATCH 

Subcatchments data section.

s_SUBAREA 

Subareas data section.

s_INFIL 

Infiltration data section.

s_AQUIFER 

Aquifers data section.

s_GROUNDWATER 

Groundwater units data section.

s_SNOWMELT 

Snowmelt data section.

s_JUNCTION 

Junctions data section.

s_OUTFALL 

Outfalls data section.

s_STORAGE 

Storage units data section.

s_DIVIDER 

Dividers unit data section.

s_CONDUIT 

Conduits data section.

s_PUMP 

Pumps data section.

s_ORIFICE 

Orifices data section.

s_WEIR 

Weirs data section.

s_OUTLET 

Outlets data section.

s_XSECTION 

Xsections data section.

s_TRANSECT 

Transects data section.

s_LOSSES 

Loss methods data section.

s_CONTROL 

Control rules data section.

s_POLLUTANT 

Pollutants data section.

s_LANDUSE 

Land uses data section.

s_BUILDUP 

Pollutant buildup data section.

s_WASHOFF 

Pollutant washoff data section.

s_COVERAGE 

Coverages data section.

s_INFLOW 

Inflows data section.

s_DWF 

DWF patterns data section.

s_PATTERN 

Time patterns data section.

s_RDII 

RDII data section.

s_UNITHYD 

Unit hydrographs data section.

s_LOADING 

Pollutant loading data section.

s_TREATMENT 

Treatment functions data section.

s_CURVE 

Curve data section.

s_TIMESERIES 

Time series data section.

s_REPORT 

Reporting options data section.

s_COORDINATE 

Coordinates data section.

s_VERTICES 

Vertices data section.

s_POLYGON 

Polygons data section.

s_LABEL 

Labels data section.

s_SYMBOL 

Symbols data section.

s_BACKDROP 

Backdrop data section.

s_TAG 

Tags data section.

s_PROFILE 

Profiles data section.

s_MAP 

Map data section.

s_LID_CONTROL 

LID control data section.

s_LID_USAGE 

LID usage data section.

s_GWF 

GWF data section.

s_ADJUST 

Adjustments data section.

s_EVENT 

Event data section.

s_STREET 

Streets data section.

s_INLET_USAGE 

Inlets usage data section.

s_INLET 

Inlets data section.

◆ KinWaveMethodType

Enumeration of kinematic wave routing methods.

Enumerator
NORMAL 

Normal method.

MODIFIED 

Modified method.

◆ LinkResultType

Enumeration of computed link quantities.

Enumerator
LINK_FLOW 

Flow rate.

LINK_DEPTH 

Flow depth.

LINK_VELOCITY 

Flow velocity.

LINK_VOLUME 

Flow volume.

LINK_CAPACITY 

Ratio of area to full area.

LINK_QUAL 

Concentration of each pollutant.

◆ LinkType

enum LinkType

Enumeration of link sub-types used in SWMM5.

Enumerator
CONDUIT 

Conduit link.

PUMP 

Pump link.

ORIFICE 

Orifice link.

WEIR 

Weir link.

OUTLET 

Outlet link.

◆ LoadingType

Enumeration of surface pollutant loading categories.

Enumerator
BUILDUP_LOAD 

Pollutant buildup load.

DEPOSITION_LOAD 

Pollutant deposition load.

SWEEPING_LOAD 

Pollutant load removed by sweeping.

BMP_REMOVAL_LOAD 

Pollutant load removed by BMPs.

INFIL_LOAD 

Runon load removed by infiltration.

RUNOFF_LOAD 

Pollutant load removed by runoff.

FINAL_LOAD 

Pollutant load remaining on surface.

◆ NodeInletType

Enumeration of node inlet types.

Enumerator
NO_INLET 

No inlet.

BYPASS 

Bypass flow inlet.

CAPTURE 

Capture flow inlet.

◆ NodeResultType

Enumeration of computed node quantities.

Enumerator
NODE_DEPTH 

Depth of water above node invert.

NODE_HEAD 

Hydraulic head at node.

NODE_VOLUME 

Volume of stored & ponded water.

NODE_LATFLOW 

Lateral inflow rate.

NODE_INFLOW 

Total inflow rate.

NODE_OVERFLOW 

Overflow rate.

NODE_QUAL 

Concentration of each pollutant.

◆ NodeType

enum NodeType

Enumeration of node sub-types used in SWMM5.

Enumerator
JUNCTION 

Junction node.

OUTFALL 

Outfall node.

STORAGE 

Storage node.

DIVIDER 

Divider node.

◆ NoneAllType

Enumeration of none/all/some options.

Enumerator
NONE 

None option.

ALL 

All option.

SOME 

Some option.

◆ NormalFlowType

Enumeration of normal flow computation methods.

Enumerator
SLOPE 

Based on slope only.

FROUDE 

Based on Froude number only.

BOTH 

Based on both slope & Froude number.

NEITHER 

Neither slope nor Froude number.

◆ NormalizerType

Enumeration of buildup normalization options.

Enumerator
PER_AREA 

Normalized per unit of area.

PER_CURB 

Normalized per unit of curb length.

◆ NoYesType

enum NoYesType

Enumeration of no/yes options.

Enumerator
NO 

No option.

YES 

Yes option.

◆ ObjectType

enum ObjectType

Enumeration of object types used in SWMM5.

Enumerator
GAGE 

Rain gage.

SUBCATCH 

Subcatchment.

NODE 

Node.

LINK 

Link.

POLLUT 

Pollutant.

LANDUSE 

Land use category.

TIMEPATTERN 

Dry weather flow time pattern.

CURVE 

Generic table of values.

TSERIES 

Time series of values.

CONTROL 

Convyance system control rules.

TRANSECT 

Irregular channel cross-section.

AQUIFER 

Groundwater aquifer.

UNITHYD 

RDII unit hydrograph.

SNOWMELT 

Snowmelt parameter set.

SHAPE 

Custom conduit shape.

LID 

LID treatment units.

STREET 

Street.

INLET 

Inlet.

MAX_OBJ_TYPES 

Maximum number of object types.

◆ OffsetType

enum OffsetType

Enumeration of node offset types.

Enumerator
DEPTH_OFFSET 

Offset measured as depth.

ELEV_OFFSET 

Offset measured as elevation.

◆ OrificeType

Enumeration of orifice types.

Enumerator
SIDE_ORIFICE 

Side orifice.

BOTTOM_ORIFICE 

Bottom orifice.

◆ OutfallType

Enumeration of outfall types.

Enumerator
FREE_OUTFALL 

Critical depth outfall condition.

NORMAL_OUTFALL 

Normal flow depth outfall condition.

FIXED_OUTFALL 

Fixed depth outfall condition.

TIDAL_OUTFALL 

Tidal stage outfall condition.

TIMESERIES_OUTFALL 

Variable time series outfall depth.

◆ PatternType

Enumeration of time pattern types.

Enumerator
MONTHLY_PATTERN 

Dry weather flow multipliers for each month.

DAILY_PATTERN 

Dry weather flow multipliers for each day of week.

HOURLY_PATTERN 

Dry weather flow multipliers for each hour of day.

WEEKEND_PATTERN 

Dry weather flow multipliers for weekend days.

◆ PumpCurveType

Enumeration of pump curve types.

Enumerator
TYPE1_PUMP 

Flow varies stepwise with wet well volume.

TYPE2_PUMP 

Flow varies stepwise with inlet depth.

TYPE3_PUMP 

Flow varies with head delivered.

TYPE4_PUMP 

Flow varies with inlet depth.

TYPE5_PUMP 

Variable speed version of TYPE3 pump.

IDEAL_PUMP 

Outflow varies with inflow.

◆ RainfallType

Enumeration of rainfall input data type options.

Enumerator
RAINFALL_INTENSITY 

Rainfall expressed as intensity.

RAINFALL_VOLUME 

Rainfall expressed as volume.

CUMULATIVE_RAINFALL 

Rainfall expressed as cumulative volume.

◆ ReactorType

Enumeration of reactor types.

Enumerator
CSTR 

Completely mixed reactor.

PLUG 

Plug flow reactor.

◆ RouteModelType

Enumeration of routing model types.

Enumerator
NO_ROUTING 

No routing.

SF 

Steady flow routing.

KW 

Kinematic wave routing.

EKW 

Extended kinematic wave routing.

DW 

Dynamic wave routing.

◆ RunoffFlowType

Enumeration of runoff flow categories.

Enumerator
RUNOFF_RAINFALL 

Rainfall.

RUNOFF_EVAP 

Evaporation.

RUNOFF_INFIL 

Infiltration.

RUNOFF_RUNOFF 

Runoff.

RUNOFF_DRAINS 

LID drain flow.

RUNOFF_RUNON 

Runon from outfalls.

◆ RunoffRoutingType

Enumeration of runoff routing types.

Enumerator
TO_OUTLET 

Pervious and impervious runoff goes to outlet.

TO_IMPERV 

Pervious runoff goes to impervious area.

TO_PERV 

Impervious runoff goes to pervious area.

◆ StorageType

Enumeration of storage node types.

Enumerator
TABULAR 

Area versus depth storage from table.

FUNCTIONAL 

Area versus depth storage from function.

CYLINDRICAL 

Area versus depth storage from elliptical cylinder.

CONICAL 

Area versus depth storage from elliptical cone.

PARABOLOID 

Area versus depth storage from elliptical paraboloid.

PYRAMIDAL 

Area versus depth storage from rectangular pyramid.

◆ SubAreaType

Enumeration of subcatchment area types.

Enumerator
IMPERV0 

Impervious area with no depression storage.

IMPERV1 

Impervious area with depression storage.

PERV 

Pervious area.

◆ SubcatchResultType

Enumeration of computed subcatchment quantities.

Enumerator
SUBCATCH_RAINFALL 

Rainfall intensity.

SUBCATCH_SNOWDEPTH 

Snow depth.

SUBCATCH_EVAP 

Evaporation loss.

SUBCATCH_INFIL 

Infiltration loss.

SUBCATCH_RUNOFF 

Runoff flow rate.

SUBCATCH_GW_FLOW 

Groundwater flow rate.

SUBCATCH_GW_ELEV 

Groundwater elevation of saturated table.

SUBCATCH_SOIL_MOIST 

Soil moisture content.

SUBCATCH_WASHOFF 

Pollutant washoff concentration.

◆ SurchargeMethodType

Enumeration of surcharge method types.

Enumerator
EXTRAN 

Original EXTAN method.

SLOT 

Preissmann slot method.

◆ SysFlowType

Enumerator
SYS_TEMPERATURE 

Air temperature.

SYS_RAINFALL 

Rainfall intensity.

SYS_SNOWDEPTH 

Snow depth.

SYS_INFIL 

Infiltration loss.

SYS_RUNOFF 

Runoff flow.

SYS_DWFLOW 

Dry weather inflow.

SYS_GWFLOW 

Groundwater inflow.

SYS_IIFLOW 

RDII inflow.

SYS_EXFLOW 

External inflow.

SYS_INFLOW 

Total lateral inflow.

SYS_FLOODING 

Flooding outflow.

SYS_OUTFLOW 

Outfall flow.

SYS_STORAGE 

Storage volume.

SYS_EVAP 

Evaporation.

SYS_PET 

Potential evapotranspiration.

◆ TempType

enum TempType

Enumeration of temperature data type options.

Enumerator
NO_TEMP 

No temperature data supplied.

TSERIES_TEMP 

Temperature data from time series.

FILE_TEMP 

Temperature data from climate file.

◆ TreatmentType

Enumeration of pollutant treatment types.

Enumerator
REMOVAL 

Treatment stated as a removal.

CONCEN 

Treatment stated as effluent concen.

◆ UnitsType

enum UnitsType

Enumeration of measurement units types used in SWMM5.

Enumerator
US 

US units.

SI 

SI units.

◆ WashoffType

Enumeration of pollutant washoff function types.

Enumerator
NO_WASHOFF 

No washoff.

EXPON_WASHOFF 

Exponential washoff equation.

RATING_WASHOFF 

Rating curve washoff equation.

EMC_WASHOFF 

Event mean concentration washoff.

◆ WeirType

enum WeirType

Enumeration of weir types.

Enumerator
TRANSVERSE_WEIR 

Transverse weir.

SIDEFLOW_WEIR 

Side flow weir.

VNOTCH_WEIR 

V-notch (triangular) weir.

TRAPEZOIDAL_WEIR 

Trapezoidal weir.

ROADWAY_WEIR 

FHWA HDS-5 roadway weir.

◆ WindType

enum WindType

Enumeration of wind speed data type options.

Enumerator
MONTHLY_WIND 

Wind speed varies by month.

FILE_WIND 

Wind speed from climate file.

◆ XsectType

enum XsectType

Enumeration of cross section shape types used in SWMM5.

Enumerator
DUMMY 

Dummy cross section.

CIRCULAR 

Circular cross section.

FILLED_CIRCULAR 

Filled circular cross section.

RECT_CLOSED 

Rectangular cross section.

RECT_OPEN 

Rectangular open cross section.

TRAPEZOIDAL 

Trapezoidal cross section.

TRIANGULAR 

Triangular cross section.

PARABOLIC 

Parabolic cross section.

POWERFUNC 

Power function cross section.

RECT_TRIANG 

Rectangular triangular cross section.

RECT_ROUND 

Rectangular round cross section.

MOD_BASKET 

Modified Baskethandle cross section.

HORIZ_ELLIPSE 

Horizontal elliptical cross section.

VERT_ELLIPSE 

Vertical elliptical cross section.

ARCH 

Arch cross section.

EGGSHAPED 

Egg-shaped cross section.

HORSESHOE 

Horseshoe cross section.

GOTHIC 

Gothic cross section.

CATENARY 

Catenary cross section.

SEMIELLIPTICAL 

Semi-elliptical cross section.

BASKETHANDLE 

Baskethandle cross section.

SEMICIRCULAR 

Semi-circular cross section.

IRREGULAR 

Irregular cross section.

CUSTOM 

Custom cross section.

FORCE_MAIN 

Force main cross section.

STREET_XSECT 

Street cross section.