enums.h

Go to the documentation of this file.

 
#ifndef ENUMS_H
#define ENUMS_H
 
enum ObjectType
{
     GAGE, // rain gage
     SUBCATCH,
     NODE,
     LINK,
     POLLUT,
     LANDUSE,
     TIMEPATTERN,
     CURVE,
     TSERIES,
     CONTROL,
     TRANSECT,
     AQUIFER,
     UNITHYD,
     SNOWMELT,
     SHAPE,
     LID,
     STREET,
     INLET,
     MAX_OBJ_TYPES
};
 
#define MAX_NODE_TYPES 5
 
enum NodeType
{    
     JUNCTION,
     OUTFALL,
     STORAGE,
     DIVIDER
};
 
#define MAX_LINK_TYPES 5
 
enum LinkType
{    
     CONDUIT,
     PUMP,
     ORIFICE,
     WEIR,
     OUTLET
};
 
enum FileType
{
     RAINFALL_FILE,
     RUNOFF_FILE,
     HOTSTART_FILE,
     RDII_FILE,
     INFLOWS_FILE,
     OUTFLOWS_FILE
}; 
 
 
enum FileUsageType
{
     NO_FILE,
     SCRATCH_FILE,
     USE_FILE,
     SAVE_FILE
};
 
 
enum GageDataType
{    
     RAIN_TSERIES,
     RAIN_FILE
};
 
enum XsectType
{    
     DUMMY,           // 0
     CIRCULAR,        // 1      closed
     FILLED_CIRCULAR, // 2      closed
     RECT_CLOSED,     // 3      closed
     RECT_OPEN,       // 4
     TRAPEZOIDAL,     // 5
     TRIANGULAR,      // 6
     PARABOLIC,       // 7
     POWERFUNC,       // 8
     RECT_TRIANG,     // 
     RECT_ROUND,      // 10
     MOD_BASKET,      // 11
     HORIZ_ELLIPSE,   // 12     closed
     VERT_ELLIPSE,    // 13     closed
     ARCH,            // 14     closed
     EGGSHAPED,       // 15     closed
     HORSESHOE,       // 16     closed
     GOTHIC,          // 17     closed
     CATENARY,        // 18     closed
     SEMIELLIPTICAL,  // 19     closed
     BASKETHANDLE,    // 20     closed
     SEMICIRCULAR,    // 21     closed
     IRREGULAR,       // 22
     CUSTOM,          // 23     closed
     FORCE_MAIN,      // 24     closed
     STREET_XSECT // 25
}; 
 
enum UnitsType
{    
     US, // US units
     SI, // SI (metric) units
}; 
 
enum FlowUnitsType
{    
     CFS,
     GPM,
     MGD,
     CMS,
     LPS,
     MLD,
}; 
 
enum ConcUnitsType
{
     MG,
     UG,
     COUNT,
};
 
enum ConversionType
{    
     RAINFALL,
     RAINDEPTH,
     EVAPRATE,
     LENGTH,
     LANDAREA,
     VOLUME,
     WINDSPEED,
     TEMPERATURE,
     MASS,
     GWFLOW,
     FLOW
};
 
#define MAX_SUBCATCH_RESULTS 9
 
enum SubcatchResultType
{
     SUBCATCH_RAINFALL,
     SUBCATCH_SNOWDEPTH,
     SUBCATCH_EVAP,
     SUBCATCH_INFIL,
     SUBCATCH_RUNOFF,
     SUBCATCH_GW_FLOW,
     SUBCATCH_GW_ELEV,
     SUBCATCH_SOIL_MOIST,
     SUBCATCH_WASHOFF,
}; 
 
#define MAX_NODE_RESULTS 7
 
enum NodeResultType
{    
     NODE_DEPTH,
     NODE_HEAD,
     NODE_VOLUME,
     NODE_LATFLOW,
     NODE_INFLOW,
     NODE_OVERFLOW,
     NODE_QUAL,
};
 
#define MAX_LINK_RESULTS 6
 
enum LinkResultType
{
     LINK_FLOW,
     LINK_DEPTH,
     LINK_VELOCITY,
     LINK_VOLUME,
     LINK_CAPACITY,
     LINK_QUAL,
}; 
 
#define MAX_SYS_RESULTS 15
 
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,
};
 
 
enum RunoffFlowType
{
     RUNOFF_RAINFALL,
     RUNOFF_EVAP,
     RUNOFF_INFIL,
     RUNOFF_RUNOFF,
     RUNOFF_DRAINS,
     RUNOFF_RUNON,
}; 
 
enum LoadingType
{
     BUILDUP_LOAD,
     DEPOSITION_LOAD,
     SWEEPING_LOAD,  
     BMP_REMOVAL_LOAD,
     INFIL_LOAD,
     RUNOFF_LOAD,
     FINAL_LOAD,     
}; 
 
enum RainfallType
{    
     RAINFALL_INTENSITY,
     RAINFALL_VOLUME,
     CUMULATIVE_RAINFALL,
};
 
enum TempType
{    
     NO_TEMP,
     TSERIES_TEMP,
     FILE_TEMP,
}; 
 
enum WindType
{    
     MONTHLY_WIND,
     FILE_WIND,
};
 
enum EvapType
{    
     CONSTANT_EVAP,
     MONTHLY_EVAP,
     TIMESERIES_EVAP,
     TEMPERATURE_EVAP,
     FILE_EVAP,
     RECOVERY,
     DRYONLY,
};
 
enum NormalizerType
{    
     PER_AREA,
     PER_CURB,
};
 
enum BuildupType
{
     NO_BUILDUP,
     POWER_BUILDUP,
     EXPON_BUILDUP,
     SATUR_BUILDUP,
     EXTERNAL_BUILDUP,
};
 
enum WashoffType
{
     NO_WASHOFF,
     EXPON_WASHOFF,
     RATING_WASHOFF,
     EMC_WASHOFF,
};
 
enum SubAreaType
{    
     IMPERV0,
     IMPERV1,
     PERV,
};
 
enum RunoffRoutingType
{
     TO_OUTLET,
     TO_IMPERV,
     TO_PERV,
};
 
enum RouteModelType
{    
     NO_ROUTING,
     SF,
     KW,
     EKW,
     DW,
};
 
enum ForceMainType
{
     H_W,
     D_W,
};
 
enum OffsetType
{
     DEPTH_OFFSET,
     ELEV_OFFSET,
};
 
enum KinWaveMethodType
{
     NORMAL,
     MODIFIED,
};
 
enum CompatibilityType
{
     SWMM5,
     SWMM3,
     SWMM4,
};
 
enum NormalFlowType
{    
     SLOPE,
     FROUDE,
     BOTH,
     NEITHER, 
};
 
enum InertialDampingType
{
     NO_DAMPING,
     PARTIAL_DAMPING,
     FULL_DAMPING,
}; 
 
enum SurchargeMethodType
{    
     EXTRAN,
     SLOT,
};
 
enum InflowType
{
     EXTERNAL_INFLOW, 
     DRY_WEATHER_INFLOW, 
     WET_WEATHER_INFLOW,
     GROUNDWATER_INFLOW,
     RDII_INFLOW,
     FLOW_INFLOW,
     CONCEN_INFLOW,
     MASS_INFLOW,
};
 
enum PatternType
{
     MONTHLY_PATTERN,
     DAILY_PATTERN,
     HOURLY_PATTERN,
     WEEKEND_PATTERN,
}; 
 
enum OutfallType
{
     FREE_OUTFALL,
     NORMAL_OUTFALL,
     FIXED_OUTFALL,
     TIDAL_OUTFALL,
     TIMESERIES_OUTFALL,
}; 
 
enum StorageType
{
     TABULAR,
     FUNCTIONAL,
     CYLINDRICAL,
     CONICAL,
     PARABOLOID,
     PYRAMIDAL,
};
 
enum ReactorType
{
     CSTR,
     PLUG,
}; 
 
enum TreatmentType
{
     REMOVAL,
     CONCEN,
};
 
enum DividerType
{
     CUTOFF_DIVIDER,
     TABULAR_DIVIDER,
     WEIR_DIVIDER,
     OVERFLOW_DIVIDER,
};
 
enum PumpCurveType
{
     TYPE1_PUMP,
     TYPE2_PUMP,
     TYPE3_PUMP,
     TYPE4_PUMP,
     TYPE5_PUMP,
     IDEAL_PUMP,
};
 
enum OrificeType
{    
     SIDE_ORIFICE,
     BOTTOM_ORIFICE,     
}; 
 
enum WeirType
{
     TRANSVERSE_WEIR,
     SIDEFLOW_WEIR,
     VNOTCH_WEIR,
     TRAPEZOIDAL_WEIR,
     ROADWAY_WEIR,
}; 
 
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,
}; 
 
enum NodeInletType
{    
     NO_INLET,
     BYPASS,
     CAPTURE,
};
 
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,
};
 
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,
};
 
enum NoYesType
{
     NO,
     YES,
};
 
enum NoneAllType
{
     NONE,
     ALL,
     SOME,
};
 
#endif // ENUMS_H