OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
Macros | Enumerations
enums.h File Reference

Header file for enumerated constants. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Header file for enumerated constants.

Author
L. Rossman
Date
Created: 2022-06-01
Last updated: 2024-12-30
Version
5.3.0

Enumerated constants used in the SWMM model.

Update history

Build 5.1.004:

  • IGNORE_RDII for the ignore RDII option added. Build 5.1.007:
  • s_GWF for [GWF] input file section added.
  • s_ADJUST for [ADJUSTMENTS] input file section added. Build 5.1.008:
  • Enumerations for fullness state of a conduit added.
  • NUM_THREADS added for number of parallel threads option.
  • Runoff flow categories added to represent mass balance components. Build 5.1.010:
  • New ROADWAY_WEIR type of weir added.
  • Potential evapotranspiration (PET) added as a system output variable. Build 5.1.011:
  • s_EVENT added to InputSectionType enumeration. Build 5.1.013:
  • SURCHARGE_METHOD and RULE_STEP options added.
  • WEIR_CURVE added as a curve type. Build 5.2.0:
  • Support added for Streets and Inlets.
  • Support added for variable speed pumps.
  • Support added for analytical storage shapes. Build 5.2.1:
  • Adds a NEITHER option to the NormalFlowType enumeration.