SWMM5 text.h Summary

 The text.h file in SWMM 5 defines a variety of constants, text strings, and keywords that are used throughout the program. It is primarily responsible for managing the textual output of the simulation, including error messages, warnings, and reporting options. The file also organizes keywords for different sections of input files, such as rainfall data, infiltration methods, and flow routing methods.

Key Components in text.h:

1. Text Formatting Constants:

   • Constants like FMT01, FMT03, FMT04, etc., define various formatted strings used throughout the program. These are used for displaying messages, formatting outputs, and structuring report headings.

2. Error and Warning Messages:

   • The file defines numerous warning and error messages, such as WARN01 for warnings related to wet weather time steps and WARN02 for node depth warnings. These warnings and errors are displayed when specific conditions in the simulation are met.
   • Example:
     • WARN01: "WARNING 01: wet weather time step reduced to recording interval for Rain Gage."
     • WARN02: "WARNING 02: maximum depth increased for Node."

3. Analysis Option Keywords:

   • These keywords define various simulation options that can be specified in the input file. For example, options for flow units (w_FLOW_UNITS), infiltration methods (w_HORTON), and routing models (w_KW).
   • These keywords are used to control different aspects of the simulation, such as the routing model, the time step intervals, or the type of infiltration model.

4. Flow Units and Methods:

   • Defines various flow unit types, such as w_CFS (cubic feet per second), w_MGD (million gallons per day), w_LPS (liters per second), and routing methods like w_KW (kinematic wave) and w_DW (dynamic wave).

5. Surcharge Methods and Infiltration Models:

   • Keywords for different methods of surcharge (w_EXTRAN and w_SLOT) and infiltration methods (w_HORTON, w_GREEN_AMPT, etc.).

6. Pollutant Buildup and Washoff Functions:

   • Defines various methods for pollutant buildup and washoff, including exponential (w_EXP), saturation (w_SAT), and external (w_EXT) methods.

7. Reporting and Output Options:

   • Keywords like w_REPORT, w_DISABLED, w_INPUT, w_CONTINUITY, and w_FLOWSTATS are used to specify which data should be included in the simulation report.

8. Time Series and Table Keywords:

   • Keywords for defining and reading time series data (w_FILE, w_TIMESERIES), as well as specifying tables for use in the simulation (e.g., curves for rating flow vs. depth).

9. Control Rules:

   • Keywords like w_RULE, w_IF, w_AND, w_OR, and w_THEN define the structure of control rules that can be applied during the simulation, for example, to control pumps or gates.

10. Storage Node Shapes:

• Defines different types of storage node shapes such as w_CYLINDRICAL, w_CONICAL, and w_PARABOLOID, which are used to define the geometry of storage tanks or reservoirs.

Summary:

The text.h file plays a vital role in SWMM 5 by defining the text strings, keywords, and error/warning messages used across the program. It organizes and structures important simulation options, input data types, and reporting criteria, allowing users to specify various aspects of the simulation through text-based input files. This structure also ensures consistency and simplifies modifications to the input/output mechanisms of the SWMM simulation.