SWMM5 objects.h Summary

 The objects.h file in SWMM5 (Storm Water Management Model) contains definitions for data structures that represent various objects in the model, including nodes, links, subcatchments, pollutants, inflows, and other system components. These structures allow the model to manage and simulate different aspects of stormwater management, such as rainfall, runoff, groundwater, treatment processes, and flow routing.

Key Data Structures:

1. File Information (TFile):

• Represents a file used by the system, including its name, mode (open, closed, scratch), and the current state (opened or closed).

2. Curve and Time Series (TTable, TTableEntry):

• TTableEntry: Represents a data point in a curve or time series.
• TTable: Represents a curve or time series, including its ID, type, and a linked list of entries (data points).

3. Rain Gage (TGage):

• Represents a rain gauge, including its data source (time series or file), rainfall type, units, and related statistics (e.g., snow factor, rainfall accumulation).

4. Temperature (TTemp):

• Represents temperature-related data, including data source, time series, temperature, vapor pressure, and psychrometric constants.

5. Wind Speed (TWind):

• Represents monthly average wind speeds, either from a time series or monthly data.

6. Snow (TSnow):

• Represents snowmelt data, including the snow temperature threshold, snow catch deficiency correction, and snowmelt coefficients.

7. Evaporation (TEvap):

• Represents evaporation data, including evaporation rate, pan coefficients, and recovery patterns.

8. Adjustments (TAdjust):

• Represents monthly adjustments to temperature, evaporation, rainfall, and hydrological conductivity.

9. Event (TEvent):

• Represents an event's start and end date.

10. Aquifer (TAquifer):

• Represents groundwater aquifer data, including properties like porosity, conductivity, evaporation fractions, and initial conditions for the water table and moisture content.

11. Groundwater Statistics (TGWaterStats):

• Represents statistical data for groundwater, including infiltration, evaporation, lateral flow, and storage statistics.

12. Groundwater (TGroundwater):

• Represents groundwater flow parameters, including surface water outflow coefficients, groundwater flow parameters, and initial conditions for moisture content and water table height.

13. Snowmelt (TSnowmelt):

• Represents parameters for the snowmelt process, including snowmelt coefficients, snow depth, and surface types (impervious, pervious).

14. Snowpack (TSnowpack):

• Represents the state of the snowpack, including snow depth, free water content, and snowmelt indices.

15. Subcatchment (TSubcatch):

• Represents a subcatchment in the model, including properties like area, impervious fraction, slope, rainfall, evaporation, infiltration, and water quality (pollutant concentrations). The subcatchment also contains information about LID areas and groundwater flow equations.

16. Time Pattern (TPattern):

• Represents time series patterns used for various parameters, including rainfall, evaporation, or inflow data.

17. External Inflow (TExtInflow):

• Represents an external inflow (e.g., pollutant or flow) into the system, including data on concentration or mass and the time series or pattern associated with the inflow.

18. Dry Weather Flow Inflow (TDwfInflow):

• Represents dry weather flow data, including average values and time patterns.

19. Unit Hydrograph Inflow (TRdiiInflow):

• Represents an inflow based on a unit hydrograph, including the area of the sewershed and the unit hydrograph index.

20. Unit Hydrograph Group (TUnitHyd):

• Represents a group of unit hydrographs, including data like initial abstraction, time base, and peak time for each month.

21. Treatment (TTreatment):

• Represents a treatment process applied to a node or link, including a mathematical expression for removal or concentration.

22. Node (TNode):

• Represents a node in the conveyance system, which can be a junction, outfall, storage, or divider. This structure includes properties such as elevation, depth, volume, inflows, outflows, and water quality states.

23. Outfall (TOutfall):

• Represents an outfall node, including properties like type (fixed, tidal, timeseries, etc.), stage, and routing to subcatchments.

24. Storage (TStorage):

• Represents a storage unit (e.g., a detention pond or reservoir), including properties like evaporation, surface area, shape, and exfiltration.

25. Flow Divider (TDivider):

• Represents a divider node, which splits flow between two or more links based on a set of conditions (e.g., weir flow, cutoff, overflow, or tabular relationships).

26. Link (TLink):

• Represents a link in the conveyance system, such as a pipe, culvert, or conduit. It includes properties like flow, depth, cross-sectional area, and flow direction.

27. Conduit (TConduit):

• Represents a conduit link in the system, including properties like length, roughness, capacity, and flow rates.

28. Pump (TPump):

• Represents a pump in the system, including properties like type, curve, and settings for controlling flow.

29. Orifice (TOrifice):

• Represents an orifice in the system, including properties like discharge coefficients and control settings.

30. Weir (TWeir):

• Represents a weir in the system, including properties like discharge coefficients, end contractions, and flow control settings.

31. Outlet (TOutlet):

• Represents an outlet device, including properties like discharge coefficients and rating curves.

32. Pollutant (TPollut):

• Represents a pollutant in the system, including properties like units, mass conversion factors, and concentration levels for various flow types (e.g., dry weather, runoff, groundwater).

33. Buildup (TBuildup):

• Represents a function for pollutant buildup on a surface, including a normalizer and function type for calculating buildup rates.

34. Washoff (TWashoff):

• Represents a function for pollutant washoff from a surface, including coefficients and exponents for the washoff process.

35. Landuse (TLanduse):

• Represents a land use type, including properties like street sweeping intervals, buildup functions for pollutants, and washoff functions.

36. Reporting Flags (TRptFlags):

• Represents the flags used to control which results are reported (e.g., node results, flow statistics, continuity errors, etc.).

37. Runoff Totals (TRunoffTotals):

• Represents the cumulative runoff totals, including values for rainfall, runoff, evaporation, infiltration, and storage.

38. Loading Totals (TLoadingTotals):

• Represents the cumulative loading totals for pollutants, including buildup, deposition, sweeping, BMP removal, runoff, and final load.

39. Groundwater Totals (TGwaterTotals):

• Represents the cumulative groundwater totals, including values for infiltration, evaporation, lateral flow, and deep percolation.

40. Routing Totals (TRoutingTotals):

• Represents the cumulative routing totals for flow and water quality, including inflows, outflows, losses, and reactions.

41. Time Step Statistics (TTimeStepStats):

• Represents the statistics for the time step in the simulation, including the minimum, maximum, and average time steps, as well as the number of trials.

42. Rainfall Statistics (TRainStats):

• Represents the statistics for rainfall data, including the number of periods with rainfall, missing data, and malfunctioning gauges.

43. Subcatchment Statistics (TSubcatchStats):

• Represents the statistics for subcatchments, including values for precipitation, runoff, infiltration, and impervious/pervious runoff.

44. Node Statistics (TNodeStats):

• Represents the statistics for nodes, including values for depth, flooding, surcharging, inflow, overflow, and water quality.

45. Storage Statistics (TStorageStats):

• Represents the statistics for storage units, including values for volume, evaporation, exfiltration, and maximum flow.

46. Outfall Statistics (TOutfallStats):

• Represents the statistics for outfall nodes, including average flow, maximum flow, and pollutant load totals.

47. Pump Statistics (TPumpStats):

• Represents the statistics for pumps, including flow, energy consumption, and start-ups.

48. Link Statistics (TLinkStats):

• Represents the statistics for links, including flow, velocity, depth, flooding, and time spent in different flow conditions.

49. Maximum Value Statistics (TMaxStats):

• Represents the maximum values for nodes or links, including the maximum value and the corresponding object index.

50. Report Field Info (TRptField):

• Represents the configuration for reporting variables, including the name, units, and precision of the reported value.

Summary:

The objects.h file defines a wide range of data structures used to represent the various objects in the SWMM5 system, such as nodes, links, subcatchments, pollutants, and other system components. These structures allow for efficient simulation of stormwater management systems, handling aspects like runoff, groundwater flow, pollutant transport, and water quality. The file also defines cumulative statistics, reporting configurations, and error handling mechanisms to ensure accurate results during the simulation.