SWMM5 Delphi GUI Dcontrol.pas Summary

 The Dcontrol unit is part of the EPA SWMM project and provides the user interface for editing Rule-Based Controls in SWMM. This form contains a TMemo control where users can modify control rules written in a text format.

Key Features of the Dcontrol Unit:

1. Text Editing for Control Rules:

   • The form contains a TMemo control (Memo1) where the user can view and edit rule-based controls. These rules are stored in Project.ControlRules, which is a string list.

2. Loading and Saving Control Rules:

   • When the form is created (FormCreate), the Memo1 control is populated with the current control rules from Project.ControlRules. The user can then modify the contents.
   • The BtnOKClick handler saves the modified rules back into Project.ControlRules. If any blank lines are found at the end of the rules, they are removed before saving.

3. Status Bar and Notifications:

   • A TStatusBar (StatusBar1) is used for displaying messages or notifications about the current status, though it’s not actively updated in the provided code snippet.

4. Search and Focus:

   • The StartRule string can be set to a specific rule. If StartRule is not empty, the form will search for this rule within the memo text and select it (FormShow). This helps the user quickly navigate to a specific rule in a long list.

5. Help Button:

   • The BtnHelpClick procedure is linked to the Help button, which opens a specific help context for editing control rules. This allows users to get help related to the rule-based controls.

Constants and Properties:

• StartRule: A string used to specify a rule to focus on when the form is shown.
• Modified: A boolean flag to track if any changes were made to the control rules.
• Memo1: The TMemo control used for displaying and editing the control rules.
• Project.ControlRules: A string list that holds the control rules, which is loaded into the memo on form creation and saved on clicking OK.

Main Methods:

1. FormCreate:

   • Initializes the memo with existing control rules and sets the Modified flag to false.

2. FormShow:

   • If StartRule is provided, it searches for the rule within the memo and selects it to give focus to the rule. This helps in directly navigating to a specific rule.

3. BtnOKClick:

   • Saves the edited control rules back to Project.ControlRules. If the content of the memo has been modified, it updates the list and removes any blank lines from the end.

4. BtnHelpClick:

   • Displays the help for editing control rules by using the help system (HELP_CONTEXT, 210740).

5. FormKeyDown:

   • Handles the key press event to trigger help when the F1 key is pressed.

Summary:

The Dcontrol unit enables the user to edit rule-based controls in SWMM. It provides a simple text editor interface where users can add, modify, or remove control rules. The form also allows for quick navigation to a specific rule and provides help functionality to assist users in understanding the syntax and usage of control rules.

SWMM5 Delphi GUI Dcombine.pas Summary

 The Dcombine unit is a form used to combine two interface files into a third file in the EPA SWMM project. The user can select the files to combine and then specify a name for the resulting file. The form provides an interface for browsing and selecting files, along with an option to save the combined file.

Key Features:

1. File Selection and Browsing:

   • The form provides a TStringGrid where users can view and select the files to be combined, with an option to browse for files using a TOpenTxtFileDialog for the first two interface files and a TSaveDialog for the output file.
   • The user selects the files using the "Browse" button, and the selected file paths are displayed in the grid.

2. Combining Files:

   • When the "Combine" button is clicked (BtnCombineClick), the utility UCombine.CombineFiles is called with the selected file paths and a description. It performs the file combination, and upon success, the form closes with mrOK.

3. File Dialogs:

   • The OpenFileDlg and SaveFileDlg components are used to select the files to be combined and specify the name of the output file. The file dialogs allow the user to browse the file system to choose the appropriate files.
   • The SpeedButton1Click method handles opening the file dialogs when the user clicks on the "Browse" button next to the file name in the grid.

4. User Interface:

   • The form includes a simple grid where the user can see the names of the files being combined and the description. There are also buttons for combining the files, canceling the operation, and viewing help.
   • The form uses a Label2 to indicate that the files are being combined in the background.

5. Progress Indication:

   • A "stand by" message (Label2.Visible := True) is shown while the files are being processed. The screen cursor changes to crHourGlass to indicate that the program is working.

Constants:

• TXT_ROW_LABELS: Labels for the rows in the TStringGrid.
• TXT_FILE_DLG_FILTER: Filter for the file dialog, specifying that it accepts .TXT files.
• TXT_SELECT_FILE: Title for the file selection dialog.
• TXT_SAVE_FILE: Title for the save file dialog.
• TXT_STAND_BY: Message shown while files are being combined.

Main Methods:

1. FormCreate:

   • This method initializes the file dialog settings and populates the TStringGrid with labels.

2. StringGrid1KeyDown:

   • Handles the key event when the user presses Shift + Enter to invoke the file browsing dialog for a grid cell.

3. SpeedButton1Click:

   • Handles the browsing action by opening a file selection dialog based on which grid cell the user selects.

4. BtnCombineClick:

   • This method calls the CombineFiles function from the UCombine unit, combining the two files into a new one and providing feedback via the UI.

5. BtnHelpClick:

   • Displays the help message for the form.

Summary:

The Dcombine unit provides a user interface to combine two interface files into a third file. It handles file selection, validation, and calls the file combination utility in the UCombine unit. The form also provides feedback during the file combining process, ensuring that users are informed of the status of their action.

SWMM5 Delphi GUI Dcolramp.pas Summary

 The Dcolramp unit is a dialog form unit used in the EPA SWMM project to display and manage color ramp schemes. This form allows users to select a color scheme from a predefined set and view how it looks by dynamically updating the color of different shape components in the form.

Key Features:

1. Color Scheme Selection:

   • The form provides a combo box (ComboBox1) where users can choose from a list of predefined color schemes such as 'Rainbow', 'Pastel', 'Red', 'Green', etc.
   • Each color scheme consists of multiple colors (up to 5, as defined in MAXCOLOR), which are applied to various shapes (Shape0, Shape1, etc.) on the form.

2. Color Scheme Display:

   • When a color scheme is selected, the shapes on the form (represented by TShape components like Shape0, Shape1, etc.) are updated with the colors from the selected scheme.
   • The color values for each scheme are stored in a 2D array SchemeColors, which contains predefined color sets for each scheme.

3. User Interaction:

   • The combo box (ComboBox1) allows users to select the desired color scheme. When a scheme is selected, the ComboBox1Change event is triggered, which calls the ChangeColorScheme method to update the shapes with the new colors.
   • The shapes (Shape0, Shape1, etc.) display the colors for the selected scheme, and these colors are stored in the Colors array for further use.

Constants:

1. MAXSCHEME: The maximum index for available color schemes (10 in this case).
2. MAXCOLOR: The maximum number of colors in a single color scheme (5 in this case).
3. Schemes: A list of predefined color scheme names, such as 'Rainbow', 'Red', 'Green', etc.
4. SchemeColors: A 2D array containing the actual color values for each color scheme. Each scheme has 5 associated colors.

Main Methods:

1. FormCreate:

   • This method is triggered when the form is created. It loads the predefined color scheme names into the combo box (ComboBox1) and sets the default color scheme to the first one (ItemIndex := 0).

2. ComboBox1Change:

   • This method is triggered when the user changes the selected item in the combo box. It calls ChangeColorScheme to update the shapes with the colors of the newly selected scheme.

3. ChangeColorScheme:

   • This method updates the colors of the shapes (Shape0, Shape1, etc.) based on the selected color scheme. The color values are fetched from the SchemeColors array, and the Brush.Color property of each shape is updated accordingly.

Example Use Case:

• The user opens the dialog and sees a list of color schemes in the combo box (ComboBox1).
• The user selects a color scheme (e.g., 'Rainbow') from the list.
• The shapes (Shape0, Shape1, etc.) are automatically updated to display the colors from the selected scheme.
• The user can use these colors to visually represent different variables, such as runoff or pollutant levels, on the map or other components.

Summary:

The Dcolramp unit is a simple but effective part of the EPA SWMM project that provides users with an interface to choose and view different color schemes for graphical representations. By selecting a color scheme from the combo box, users can visually customize the appearance of the study area or results within the SWMM interface.

SWMM5 Delphi GUI Dclimate.pas Summary

The Dclimate unit is part of the EPA SWMM project, and it is responsible for providing the dialog form that allows users to manage climatology data for simulations. The dialog allows the user to configure temperature, evaporation, wind speed, and snowmelt parameters, as well as the associated time series data for those parameters. This form also includes additional configuration for recovery patterns, climate adjustment, and other parameters related to climatology.

Key Features:

1. Temperature Data:

   • Users can define temperature data either from a time series, a file, or manually input data.
   • The dialog allows the user to configure a starting date for the temperature data if necessary.

2. Evaporation Data:

   • Users can select the source for evaporation data: constant, time series, file, or monthly data.
   • If using a time series or file, users can specify the respective series or file.
   • It also allows the user to set evaporation values on a monthly basis and link them to patterns.

3. Wind Speed Data:

   • Wind speed can be entered monthly or read from a file.
   • The user can configure the wind speed data source and set the monthly values for wind speed.

4. Snowmelt Data:

   • Users can define snowmelt data for temperature adjustments.

5. Adjustment Data:

   • Users can define adjustments for temperature, evaporation, rainfall, and soil conductivity.
   • The form provides a grid for monthly adjustments, and users can define these adjustments as needed.

6. Recovery Patterns:

   • Allows the user to define patterns for soil recovery with external buttons that can link to or remove existing patterns.

7. Form Navigation:

   • The dialog uses a TPageControl to separate different sections like temperature, evaporation, wind speed, and snowmelt data.
   • Each page allows users to input and configure the data according to the specific climatology requirements for the simulation.

8. User Controls:

   • RadioButton for selecting between different climatology data sources (e.g., external file, time series).
   • TNumEdit fields for editing numerical values for various parameters like evaporation rates, recovery coefficients, and wind speed.
   • TGridEditFrame components are used for data grids where users can enter multiple values at once, such as for monthly adjustments and snowmelt coefficients.

9. File Management:

   • It allows users to browse for files containing climatology data (e.g., temperature data files).
   • The TempSeriesCombo box allows users to select a time series from the project's list, and TempFileEdit allows users to specify a file path for external temperature data.

10. Help and Context-Sensitive Assistance:

    • The form has integrated help functionality for each tab, guiding users to understand and enter the climatology data correctly.

Key Constants:

• MonthLabels: A list of month names, used for grid labeling.
• AdjustColLabels: A list of column labels for the adjustment grid (used for climate adjustments like temperature, evaporation, etc.).
• ADCColLabels: Column labels for the areal depletion grid (used for adjusting impervious and pervious areas).
• TXT_SELECT_FILE, TXT_FILE_FILTER: Constants used for file selection dialogs.

Methods and Event Handlers:

1. Form Initialization (FormCreate):

   • The form's OnCreate handler initializes the dialog by setting up the grids for input data (e.g., for temperature, evaporation, wind speed, etc.) and loading any pre-existing data from the project's climatology settings.

2. Evaporation Source Change (EvapSourceComboChange):

   • This method handles changes in the evaporation data source. Based on the selected source (constant, time series, file, monthly), it shows or hides the relevant input fields.

3. Time Series and File Selection (TempSeriesComboChange, TempFileBtnClick, etc.):

   • These methods handle file browsing and time series selection for climatology data. Users can select or edit existing time series or specify new files containing climatology data.

4. Validation (EditChanged, OKBtnClick):

   • The dialog validates inputs when values are changed and when the user clicks OK to save the data.

5. Help (HelpBtnClick):

   • The help button provides context-sensitive assistance based on the currently active tab on the form.

Example Use Case:

1. Setting Up Temperature Data:

   • A user selects the temperature data source as a time series and selects an existing time series from the list.
   • The user can optionally provide a start date for the temperature data.

2. Configuring Evaporation Data:

   • The user selects whether to use constant evaporation, time series data, or file-based data. If a time series or file is selected, the user can browse for the relevant file or select the series.

3. Adjusting Evaporation or Wind Speed Data:

   • The user adjusts values for evaporation or wind speed on a monthly basis by entering data in the provided grid or selecting the relevant patterns.

4. Applying Changes:

   • Once all climatology data is entered, the user clicks OK to save the data to the project.

Summary:

The Dclimate unit is an essential component of the EPA SWMM project, allowing users to input and configure climatology data for hydrological simulations. It supports a variety of data sources and provides flexible options for temperature, evaporation, wind speed, and other climatology-related parameters. The use of grids and combo boxes makes data entry efficient, and the context-sensitive help ensures that users can easily navigate the form.

SWMM5 Delphi GUI Dchart.pas Summary

 The Dchart unit is a dialog form used in the EPA SWMM project to configure various charting options for visualizing simulation results. This dialog provides a comprehensive interface for users to customize the appearance and behavior of charts, including axis settings, series configurations, and legend options.

Key Features:

1. Chart Series Configuration:

   • Users can configure the appearance of the chart series, such as line style, line color, point markers, area fill styles, and pie chart properties.
   • TSeriesOptions class stores options for each chart series, which include settings for line visibility, marker style, area fill style, pie chart properties, and label visibility.

2. Axis Configuration:

   • Users can set the axis titles, scaling (minimum, maximum, and increment values), and gridlines for the X and Y axes.
   • There is support for both linear and date-time axes.
   • The dialog includes controls for configuring both the left and right Y-axes and the X-axis.

3. Legend Configuration:

   • The dialog allows users to modify the legend's position, visibility, frame, and other properties, such as shadow and transparency.

4. Graph Appearance:

   • Users can specify the background color, 3D view settings, and graph title.
   • The dialog includes options for setting up the general appearance of the chart, including font choices for various elements such as the graph title and axis labels.

5. Series Options:

   • The dialog allows the user to select the type of chart series (line, bar, point, pie, etc.) and configure properties specific to each type of series. For example, for line charts, users can modify the line width and style, and for pie charts, they can control the rotation angle and whether the pie chart is circled.

6. Auto-scaling:

   • The dialog supports auto-scaling of the axes, particularly for time-series data, by automatically adjusting the axis range based on the data.

7. Page Control for Multiple Tabs:

   • The dialog includes multiple tabs (e.g., general settings, axis settings, legend settings, and series-specific settings) for organizing the various configuration options.

Key Constants and Enumerations:

• LineStyleText: Array of available line styles (solid, dashed, etc.).
• LegendPosText: Array of available legend positions (left, right, top, bottom).
• MarkStyleText: Array of available marker styles (rectangle, circle, triangle, etc.).
• FillStyleText: Array of available fill styles for areas (solid, diagonal, etc.).
• StackStyleText: Array of available stack styles for bar charts (side, stacked, etc.).
• LabelStyleText: Array of available label styles (value, percent, label, etc.).
• DateFormats: Array of available date formats for time series data.

Methods and Event Handlers:

1. Form Initialization:

   • The FormCreate method initializes the form by loading available options for series styles, axis configurations, and other chart settings into combo boxes and other UI controls.

2. Series Configuration:

   • The SeriesComboBoxClick method is used to load the options for the selected series.
   • The SaveSeriesOptions method saves the options for the current series into the theSeries string list.

3. Axis Configuration:

   • The SetAxisOptions method assigns the user-defined axis options to the corresponding chart axis (X or Y).
   • The ValidAxisScaling method checks if the axis scaling parameters are valid (e.g., ensuring that the minimum is less than the maximum).

4. Font and Label Configuration:

   • The GraphTitleFontLabelLinkClick, AxisFontLabelLinkClick, and LegendFontLabelLinkClick methods open the font dialog to allow users to choose fonts for various elements like the graph title, axis titles, and legend.

5. Auto-scaling:

   • The AutoScaleAxis method automatically scales the selected axis based on the data range and increments.

6. Help:

   • The HelpBtnClick method opens the help documentation for chart options.
   • The FormKeyDown method enables the use of the F1 key for accessing the help.

Example Use Case:

1. A user runs a simulation in SWMM and wants to visualize the results. They open the chart options dialog and select the type of chart they want (e.g., line, bar, pie).
2. The user configures the appearance of the series (e.g., changing line styles, adding markers) and adjusts the axis scaling and legend settings.
3. After configuring the chart, the user applies the settings, and the chart is displayed with the updated appearance.

Summary:

The Dchart unit provides a powerful and flexible interface for configuring charts in EPA SWMM. Users can fine-tune the appearance of the charts, including axis labels, series styles, and legends, making it easier to interpret the results of simulations. The integration with various charting options and the ability to automatically scale axes make it a valuable tool for visualizing hydrological model outputs.

SWMM5 Delphi GUI Dcalib1.pas Summary

 The Dcalib1 unit provides a dialog form for managing the calibration data files used in the EPA SWMM (Storm Water Management Model). This form allows the user to browse, edit, and delete calibration files associated with various model variables, which are used to calibrate and simulate different aspects of the hydrological system.

Key Components:

1. Form Controls:

   • StringGrid1: A grid control that displays the calibration variables and their associated file names.
   • BtnOK: Confirms the changes made to the calibration files.
   • BtnCancel: Closes the form without saving changes.
   • BtnHelp: Opens the help documentation for the calibration data form.
   • BtnBrowse: Opens a file dialog to select a calibration file.
   • BtnEdit: Opens the selected calibration file in the system's default text editor (e.g., Notepad).
   • BtnDelete: Deletes the selected calibration file entry.

2. Event Handlers:

   • FormCreate: Initializes the form by populating the grid with the current calibration file names and sets up the grid's appearance.
   • BtnBrowseClick: Opens the file dialog for selecting a calibration file.
   • BtnEditClick: Opens the selected file in Notepad for editing.
   • BtnDeleteClick: Clears the selected calibration file entry.
   • BtnOKClick: Updates the project’s calibration data with the changes made in the grid.
   • BtnHelpClick: Displays the help content related to the calibration data form.
   • FormKeyDown: Allows the use of the F1 key to open the help documentation.

3. Data Handling:

   • FileNames: An array storing the file paths of the calibration files.
   • FileDir: The directory in which the calibration files are located.
   • CalibData: A global variable containing the calibration data for different variables.

4. Grid Control:

   • The grid control is initialized with the calibration variables (like Flow, Runoff, etc.) and their associated file names.
   • The user can select a file for each calibration variable by browsing and selecting files through the file dialog.

5. File Operations:

   • Browse: The BtnBrowseClick handler allows the user to select a file using a file dialog. The selected file path is updated in the grid.
   • Edit: The BtnEditClick handler opens the selected calibration file in the default text editor for the user to review or edit.
   • Delete: The BtnDeleteClick handler clears the current entry in the grid for the selected calibration variable.
   • OK: The BtnOKClick handler saves the changes made to the calibration files and updates the project’s calibration data.

6. Help:

   • The form includes a help button (BtnHelpClick) that opens the help documentation for calibration.

Key Constants:

• TXT_PARAMETER: The header for the calibration variable column in the grid.
• TXT_NAME_OF_FILE: The header for the file name column in the grid.
• TXT_SELECT_FILE: The title for the file selection dialog.
• TXT_FILE_FILTER: The file type filter for the file selection dialog.

Example Use Case:

• A user wants to update the calibration files for a hydrological model in SWMM. They open the TCalibDataForm dialog, browse and select new files for each calibration variable (such as Flow, Runoff), and confirm the changes. The dialog updates the project’s calibration data with the new file paths.

Summary:

The Dcalib1 unit provides a user-friendly interface for managing calibration data files in EPA SWMM. Users can easily browse, edit, delete, and confirm calibration file selections through the form's grid control, which simplifies the process of linking external data files to the model variables. This ensures that the model runs with the most up-to-date calibration data for accurate simulation and analysis.

SWMM5 Delphi GUI Dbackdrp.pas Summary

 The Dbackdrp unit provides a dialog form for selecting a backdrop image for the study area map within the SWMM (Storm Water Management Model) software. This unit enables the user to load and configure the backdrop image, scale it to fit the map's dimensions, and adjust the study area to the image's extent. Here’s an overview of its functionality:

Key Components:

1. Form Controls:

   • ImageFileEdit: Displays the selected backdrop image file path.
   • ImageFileBtn: Opens a file dialog to select the backdrop image.
   • WorldFileEdit: Displays the associated world file path.
   • WorldFileBtn: Opens a file dialog to select the world file.
   • ScaleMapCheckBox: Enables or disables the scaling of the map to the backdrop.
   • WorldFileDelBtn: Deletes the world file association.
   • OKBtn, CancelBtn, HelpBtn: Standard buttons for confirmation, cancellation, and help.

2. Event Handlers:

   • FormCreate: Initializes form controls and sets default values.
   • ImageFileBtnClick: Opens a file dialog to select an image file for the backdrop.
   • WorldFileBtnClick: Opens a file dialog to select a world file for the backdrop image.
   • WorldFileDelBtnClick: Clears the world file.
   • OKBtnClick: Processes the selected image and world files, validates the input, and applies the backdrop settings.
   • WorldFileEditChange: Enables the "Scale Map" checkbox when a world file is provided.
   • HelpBtnClick: Displays the help documentation for the backdrop settings.
   • FormKeyDown: Allows opening help using the F1 key.

3. Data Handling:

   • ReadImageFile: Reads and validates the selected image file, retrieves its pixel dimensions.
   • ReadWorldFile: Reads and validates the world file, extracting geospatial data (coordinates and scaling factors).
   • GetBackdropFileName: Returns the file name of the selected backdrop image.
   • GetBackdropCoords: Returns the coordinates of the backdrop's lower-left and upper-right corners.

4. Scaling and Transformation:

   • ScaleBackdrop: Scales the backdrop image to fit either the window or the map's dimensions.
   • ScaleMapToBackdrop: Adjusts the map's coordinates to fit the backdrop’s extent.
   • SetScaling: Determines how the backdrop image and map should be scaled relative to one another.

5. Validation:

   • Ensures that both the image and world files exist and are valid.
   • Handles error messages if the files are not found or are invalid.
   • Displays a confirmation prompt if the backdrop and map do not overlap.

Key Constants and Messages:

• Scaling Options:
  • SCALE_TO_WINDOW: Scale the backdrop to fit the window.
  • SCALE_TO_MAP: Scale the map to fit the backdrop.
  • SCALE_TO_BACKDROP: Scale the map to match the backdrop dimensions.
• Error Messages:
  • MSG_NO_IMAGE_FILE: Error when the image file is not found.
  • MSG_BAD_IMAGE_FILE: Error when the image file cannot be read.
  • MSG_NO_WORLD_FILE: Error when the world file is not found.
  • MSG_BAD_WORLD_FILE: Error when the world file is invalid.
  • MSG_NO_OVERLAP: Warning when the backdrop does not overlap with the map, asking if it should be scaled to fit.

Workflow:

1. User Input:
   • The user selects an image file and an optional world file for the backdrop.
2. Scaling:
   • Depending on the selected scaling option, either the map is scaled to match the backdrop, or the backdrop is resized to fit the map.
3. Validation:
   • The form checks that both files are valid and that the dimensions do not overlap incorrectly.
4. Update:
   • The map is redrawn with the updated backdrop settings, and the changes are saved.

Example Use Case:

• A user wants to update the backdrop image for the study area map. They select a new image and its corresponding world file, choose how to scale the image relative to the map, and click OK. The map is then updated to reflect the new backdrop, and the user’s settings are saved.

In summary, the Dbackdrp unit provides the interface for configuring and applying a backdrop image to the SWMM study area map, offering the user control over how the image is scaled and aligned with the map’s dimensions.

SWMM5 Delphi GUI Dbackdim.pas Summary

 The Dbackdim unit provides the dialog form for setting the dimensions of the backdrop picture for the study area map in the SWMM (Storm Water Management Model) software. The backdrop image is essential in visualizing and aligning the study area on the map interface. Here's a summary of its functionality:

Key Elements:

1. Form Components:

   • GroupBox1: Holds labels and input fields for the lower-left coordinates (LLX, LLY) of the backdrop.
   • GroupBox2: Holds labels and input fields for the upper-right coordinates (URX, URY) of the backdrop.
   • Radio Buttons: Provide options to resize the backdrop or scale the map to match the backdrop.
   • Buttons: OK, Cancel, and Help buttons to interact with the user.
   • Labels: Display information to the user, including hints and instructions.

2. Event Handlers:

   • FormShow: Called when the form is shown. It initializes data and sets the default options for resizing and scaling.
   • OKBtnClick: Handles the "OK" button click. It validates the input, updates the map and backdrop dimensions, and redraws the map.
   • ResizeOnlyBtnClick: Enables the user to resize only the backdrop, while displaying the map's dimensions.
   • ScaleBackdropBtnClick: Enables the user to scale the backdrop according to the map's current size.
   • ScaleMapBtnClick: Allows the user to scale the map to match the backdrop's size.
   • LLXEditChange: Updates the map dimensions in real-time as the user modifies the backdrop dimensions.
   • HelpBtnClick: Provides access to the help documentation for the backdrop dimensions settings.

3. Data Handling:

   • SetData: Stores the original dimensions of both the map and backdrop and displays them on the form.
   • DisplayBackdropDimensions: Displays the current dimensions of the backdrop in the corresponding fields.
   • DisplayMapDimensions: Displays the current dimensions of the map in the corresponding fields.
   • EnableEditFields: Enables or disables the edit fields based on the user's selected operation (resizing or scaling).

4. Scaling and Transformation:

   • The program can scale the map to match the backdrop's dimensions or resize the backdrop based on the map. The transformation involves mapping the coordinates between the map and the backdrop to ensure they are proportionate.

5. Validation:

   • Invalid or blank fields are checked, and appropriate error messages are displayed.
   • The map and backdrop dimensions must not be zero, ensuring that valid dimensions are provided for both.

Workflow:

1. User input: The user can input the coordinates for the lower-left and upper-right corners of the backdrop image.
2. Scaling: Depending on the option selected (Scale Map, Scale Backdrop, Resize Only), the map or backdrop dimensions are adjusted.
3. Update and redraw: Once the user confirms the settings, the map is redrawn with the updated dimensions.

Key Constants and Messages:

• MSG_BLANK_FIELD: Message displayed when a field is left blank.
• MSG_ILLEGAL_DIMENSIONS: Message displayed when illegal dimensions are provided (e.g., zero width/height).

Example Use Case:

• A user wants to adjust the dimensions of the backdrop for a new map layout. They select the appropriate scaling option (e.g., resize the backdrop to match the map's current dimensions), input the new dimensions, and click OK to apply the changes. The map is then redrawn with the new backdrop size.

In summary, the Dbackdim unit provides a crucial interface for managing and adjusting the backdrop dimensions within the SWMM study area map, allowing for better visualization and alignment of simulation results.

Changes from SWMM Version 4 to XPSWMM

 Changes from SWMM Version 4 to XPSWMM

The transition from SWMM Version 4 to XPSWMM (extended and enhanced SWMM) introduced numerous improvements, bug fixes, and new features. These updates significantly expanded the capabilities of the software, including enhanced stability, improved accuracy, and more flexible user options for stormwater modeling. Below are the main changes and enhancements made from SWMM Version 4 to XPSWMM:

1. Bug Fixes:

• Several hundred bug fixes were implemented to address known issues in the original SWMM code, improving the overall stability and reliability of the program.

2. Vertically Differentiated Roughness:

• Roughness in conduits is now differentiated vertically. Each conduit can have two regions of roughness:
  • Higher roughness is applied when the flow depth is less than a predefined threshold.
  • Normal roughness is applied when the flow depth is above that threshold.

3. Shock Losses in Flow Transitions:

• Shock losses have been added to model the transition from subcritical flow to supercritical flow, providing more accurate flow modeling in these conditions.

4. Side Flow Weir Equations:

• The approach velocity in the side-flow weir equations is now properly accounted for, improving the accuracy of flow predictions in weirs with side flows.

5. EXTRAN Simulation Linking:

• Two EXTRAN simulations can now be linked via a stage boundary condition, allowing the time history of stage and flow from one simulation to be connected to the stage and flow history in another EXTRAN simulation.

6. Transition Between Open Channel and Pressure Flow:

• The transition between open channel flow and pressure flow at weirs has been enhanced to improve the stability of the flow solution, particularly in systems with varying flow conditions.

7. Demand Curve for Outfalls:

• A demand curve for outfalls, or a Q(t) boundary condition, has been added, allowing for more flexibility in modeling the flow and depth at outfalls.

8. Floodplain Modeling for Natural Channels:

• Natural channels now automatically include floodplain modeling to account for flows above the maximum channel depth, improving the model's ability to simulate realistic floodplain dynamics.

9. Ponded Water at EXTRAN Nodes:

• Ponded flood water at EXTRAN nodes can optionally be returned to the main system, providing more flexibility in the modeling of stormwater systems with ponded areas.

10. Enhanced Stability in EXTRAN:

• EXTRAN stability has been greatly enhanced, particularly in the solution of conduit flows and junction depths, making the model more robust and reliable for large and complex networks.

11. Flow Losses in Conduits:

• Expansion and contraction losses due to changes in cross-sectional area are now simulated in conduits, improving the accuracy of flow predictions in variable-section conduits.

12. Entrance/Exit Losses at Junctions:

• Entrance and exit losses at junctions are now simulated in conduits, providing more accurate flow modeling at these locations.

13. Outfall Depth Calculation:

• The depth at an outfall can now be calculated in three different ways:
  • Fixed depth at the normal depth (especially useful for natural channels).
  • Fixed at the critical depth.
  • Minimum of normal or critical depth, based on conduit flow.

14. Rating Curve Boundary Conditions:

• Rating curve boundary conditions for outfalls (Q(h)) have been added, providing greater flexibility in modeling outfalls with variable flow conditions.

15. Irregular Shaped Closed Conduits:

• Support for irregularly shaped closed conduits has been added, allowing for more complex conduit geometries in the stormwater model.

16. Water Quality Modeling in EXTRAN:

• Water quality modeling in EXTRAN has been started, enabling the model to simulate pollutant transport and water quality along with hydraulic flows.

17. User-Defined Weir Exponents:

• User-defined weir exponents allow for more flexibility in modeling weir flow, enabling users to customize the behavior of weirs based on empirical or site-specific data.

18. Weir Lengths as a Function of Depth:

• User-defined weir lengths that vary as a function of depth have been introduced, providing more realistic simulations for weirs with varying geometry.

19. Weir Rating Curves:

• Weir rating curves have been added, allowing users to define the flow through weirs based on depth.

20. Single Solution for EXTRAN:

• XPSWMM uses a single solution method that merges the previous solutions in EXTRAN 4, which helps reduce the complexity and maintenance required by the multiple solutions in older versions of SWMM.

21. Pollutants:

• The number of pollutants has been increased to 20 across all modules, with support for routing and tracking of these pollutants throughout the system.

22. Land Use Modeling:

• The number of land uses has been increased to 10, with the ability to route flow through all conduits, not just through specific types.

23. Storage/Treatment (STP) and BMP Integration:

• The Storage/Treatment module has been integrated with the Transport module, allowing for multiple STPs and BMPs within a single network, and no longer constraining them to the outlet of the system.

24. User-Defined Pollutant Removal Equations:

• User-defined pollutant removal equations have been introduced, allowing users to define custom equations for pollutant removal based on site-specific data or treatment processes.

25. Flexible Time Units:

• Time units in XPSWMM have been made more flexible, enabling better customization of time steps and durations in the simulation.

26. Enhanced Interface for Modules:

• Utilities (e.g., rainfall, temperature, wind, statistics) have been integrated within the overall interface, improving user experience and making it easier to manage multiple types of data.

27. SCS Hydrograph Generation:

• The SCS method of hydrograph generation has been provided, enabling the model to generate runoff hydrographs based on Soil Conservation Service guidelines.

28. EMC (Event Mean Concentration) Method:

• The EMC method is now available for pollutant generation, allowing users to model event-based pollutant concentrations based on observed or estimated values.

29. Flow Divide and Flow Paths:

• Flow divides now have explicitly defined flow paths, making it easier to track and model the flow distribution in systems with complex flow-dividing elements.

30. Flexible Pollutant Characteristics:

• Pollutant characteristics are now local, meaning that users can assign different characteristics to pollutants at different locations in the system, allowing for more detailed modeling.

31. Improved Hydraulic Elements:

• The number of hydraulic elements has been increased to 26 across all modules, improving the model’s ability to handle complex networks and diverse hydraulic conditions.

Conclusion:

The move from SWMM Version 4 to XPSWMM introduced substantial improvements in the flexibility, stability, and accuracy of the model. New features like the ability to model irregularly shaped conduits, user-defined pollutant removal and weir rating curves, and enhanced EXTRAN simulations significantly expanded the modeling capabilities of the software. Additionally, the integration of pollutant routing, land use modeling, and storage/treatment options made XPSWMM a much more comprehensive tool for simulating both hydrology and water quality in stormwater systems.

SWMM Version 3 to SWMM Version 4 Changes Summary

 The transition from SWMM Version 3 to SWMM Version 4 brought several important improvements and enhancements, including:

1. Error Correction and Convergence Improvements:

• General bug fixes were applied to all blocks, including flow routing and surcharge routines, which helped improve the model's convergence performance.

2. "Hot Start" Capability:

• SWMM V4 introduced the ability to restart simulations from the end of a previous run, making it easier to continue simulations without starting from scratch.

3. Improved Flow Routing:

• Minor improvements were made to the flow routing and surcharge routines, which enhanced the model’s ability to simulate stormwater flow more accurately.

4. Support for DYNHYD4 and WASP4:

• SWMM V4 output can be linked to DYNHYD4 (for water quantity simulation) and WASP4 (for water quality simulation). This enhancement allows for comprehensive simulation of the water system, including runoff, transport, and water quality modeling.

5. Microcomputer Version Enhancements:

• SWMM V4's microcomputer version improved file manipulation and interface handling. Users could now manipulate interface files, and data could be saved and retrieved in various formats (e.g., ASCII/text) that are compatible with spreadsheet software like Lotus 1-2-3.

6. Subsurface Routing:

• A new subsurface routing capability was added to the Runoff Block, which allows for separate accounting of unsaturated and saturated zones. This includes the simulation of fluctuating water table elevation and baseflow to channels/pipes generated from the saturated zone.

7. New Precipitation Data Input Options:

• SWMM V4 now reads precipitation data in the new National Weather Service format, and users could input their own precipitation data time series. The model supports up to 10 rain gauges for continuous simulation.

8. Rain and Temperature Blocks:

• Rain and Temp blocks were added to process continuous precipitation and temperature data more effectively, with enhanced statistical analysis.

9. Improved Numerical Methods in the Runoff Block:

• The Runoff Block received an upgrade in the numerical methods used for simulation, particularly in coupling the nonlinear reservoir equations, evaporation, infiltration, and groundwater flow.

10. Modularization and Performance Enhancements:

• SWMM V4 was more modular than its predecessor, allowing users to run only specific blocks of interest. This made the program more efficient, especially for large projects, and allowed faster execution times.

11. Graphing and Plotting:

• The Graph Block was no longer limited to 200 data points, and users could plot an unlimited number of data points for both measured and predicted graphs, including loadographs (mass/time vs. time) and pollutographs (concentration vs. time).

12. Improved Printout Control:

• Users gained greater control over the printout, allowing them to bypass most printouts if desired. Error messages were now summarized at the end of the simulation rather than printed at every time step.

13. Irregular Cross-Section Support:

• SWMM V4 introduced support for channels with irregular cross-sections, including input options for HEC-2 data lines and user-generated data lines in HEC-2 format.

14. New Cross-Section Shapes:

• New types of cross-sections, including Power Function, Parabolic, and Elliptic channels, were added. Variable-sized storage junctions (using stage-area data) were also introduced.

15. Dynamic Head Pumps and Boundary Conditions:

• New pump curves were added, including dynamic head pumps that adjust head based on flow. Additionally, variable orifice discharge coefficients and orifice areas were included over time.

16. Flap Gate Simulation:

• Flap gates were added for conduits, enabling the model to simulate reverse flow prevention in interior conduits.

17. Input and Output File Enhancements:

• SWMM V4 introduced a "Hot Start" feature, allowing users to restart simulations from the middle of a previous run. This version also included enhancements to input/output file handling for easier file compression and distribution.

18. Improved Error Handling:

• Input error checking and output summaries were significantly improved. SWMM V4 includes better input validation and the ability to read and write interface files with identifiers for each data group.

19. Surcharge Algorithm:

• The surcharge algorithm was expanded to handle surcharged weirs and included two additional flow solutions for more accurate flood simulations.

20. Unit System Support:

• SWMM V4 introduced metric units alongside imperial units, allowing the user to choose between different unit systems for input and output.

21. Enhanced Rectangular Conduit Calculation:

• Errors in the calculation of rectangular conduit shapes were corrected, improving accuracy in simulations involving these types of conduits.

22. Alphanumeric Conduit and Junction Names:

• SWMM V4 allowed alphanumeric names for conduits and junctions (instead of using pure numbers), providing more flexibility in project identification.

23. Summary Reports and Error Checking:

• The version enhanced summary reports and error checking for both input and output. The simulation process and model results were much easier to understand and interpret.

24. Improved Flow Solutions:

• Two additional flow solutions were included in the model for more robust simulations of stormwater systems.

25. User Interface:

• SWMM V4 provided a more user-friendly interface, with support for alphanumeric object names, simplified file formats, and easier project navigation.

---

Conclusion:

The improvements from SWMM Version 3 to SWMM Version 4 significantly enhanced the model's capabilities, accuracy, and flexibility. These changes addressed several limitations of the previous version, such as convergence problems, error handling, and data input/output flexibility. The integration of more advanced simulation blocks, better modularity, improved numerical methods, and enhanced user control over model settings made SWMM 4 a more powerful tool for hydrological modeling. The model's ability to interface with other software (e.g., DYNHYD4 and WASP4) and its support for continuous simulation and different unit systems made it a more versatile tool for stormwater management.

SWMM5 Delphi GUI Darchpipe.pas Summary

 The Darchpipe.pas unit is part of the EPA SWMM (Storm Water Management Model) project and provides a dialog form used to select a standard size of arch pipe for use in the model. The form allows users to choose a pipe size from a predefined list of standard sizes or enter a custom pipe size. The dialog utilizes a TreeView component to display these options in a structured manner.

Key Features of Darchpipe.pas:

1. Form Controls:

   • Panels and Buttons:
     • Panel1, Panel2: Contain layout for form elements.
     • Button1 (OK), Button2 (Cancel): Buttons for confirming or canceling the selection.
     • TreeView1: Displays a tree structure with pipe categories and pipe sizes.
   • TreeView Structure:
     • The TreeView is divided into root nodes representing material categories, with sub-nodes for the available standard pipe sizes.
   • Pipe Selection:
     • The user selects a pipe size, and the corresponding size code and dimensions (height and width) are extracted from the TreeView selection.

2. Event Handlers:

   • FormCreate: Initializes the form and populates the TreeView with standard arch pipe sizes.
   • FormShow: Displays the currently selected pipe size in the TreeView.
   • Button1Click: Handles the OK button click event, retrieves the selected pipe size, and closes the form.
   • FormShow: Sets the correct TreeView node as selected when the form is shown.

3. Arch Pipe Selection:

   • The TreeView displays standard arch pipe sizes categorized by material type, including height x width values.
   • The user can select a standard pipe size, which is then assigned to the SizeCode, MaxHeight, and MaxWidth variables.
   • If the user selects a "Custom" option, the form allows for custom dimensions (height and width) to be set.

4. Error Handling:

   • If no pipe size is selected, the user is prompted with an error message.

Purpose:

The Darchpipe.pas unit serves as the user interface for selecting an arch pipe size or entering custom dimensions for the selected pipe. The pipe size is then used in the SWMM simulation for modeling the conveyance system. The form includes predefined pipe sizes, and the TreeView structure helps organize the options in a user-friendly manner.

SWMM5 Delphi GUI Daquifer.pas Summary

 The Daquifer.pas unit is part of the EPA SWMM (Storm Water Management Model) project and contains the form and logic for managing and editing groundwater aquifer properties within the software. The form allows users to view and modify aquifer-related parameters, which are used for simulating groundwater flow and interactions in the SWMM model.

Key Features of Daquifer.pas:

1. Form Controls:

   • Panels and Buttons:
     • Panel1, Panel2: Contain layout for form elements.
     • OKBtn, CancelBtn, HelpBtn: Buttons for submitting, cancelling, or accessing help.
   • Property Editor:
     • PropEdit1: A custom editor control (TPropEdit) for displaying and editing aquifer properties.
   • Hint Label:
     • HintLabel: Displays hints for selected properties.

2. Property Management:

   • Aquifer Properties:
     • The aquifer properties include name, porosity, wilting point, field capacity, conductivity, and others.
     • The AquiferProps array contains the list of all property labels, and DefaultProps contains their default values.
     • AquiferHint provides descriptions for each property.
   • Validation:
     • ValidateEntry: Ensures that each property field is filled out correctly.
     • ValidateInput: Checks if the aquifer name is valid and not duplicated.
   • Setting and Getting Data:
     • SetData: Loads the current aquifer property values into the form.
     • GetData: Retrieves the edited values from the form and updates the aquifer data.

3. Event Handlers:

   • FormCreate: Initializes the property editor and sets up the properties for the aquifer form.
   • FormShow: Displays the form with the current property values.
   • OKBtnClick: Validates the input and confirms the changes if valid.
   • HelpBtnClick: Opens the help for aquifer properties (via context help).
   • FormKeyDown: Allows users to press F1 for help.

4. Aquifer Property Definitions:

   • PropNames: Contains the names of the aquifer properties.
   • DefaultProps: Specifies the default values for these properties (e.g., porosity, conductivity, etc.).
   • AquiferHint: Provides a description for each property to assist users in filling out the form.

5. Aquifer Validation:

   • The form ensures that the aquifer name is valid (non-blank and unique).
   • If the user attempts to save the data with invalid input, appropriate error messages are displayed.

Purpose:

The Daquifer.pas unit is responsible for managing the aquifer properties in the EPA SWMM simulation. It provides a user-friendly interface for editing aquifer characteristics that are used to simulate groundwater behavior. The form includes functionality for entering aquifer data, validating input, and saving the changes, with error handling for duplicate or invalid entries.

In summary, this unit handles the interaction between the user and the SWMM system regarding groundwater aquifer properties, ensuring that the data is entered correctly and efficiently.

SWMM5 Delphi GUI Dabout.pas Summary

 The Dabout.pas unit is part of the EPA SWMM (Storm Water Management Model) project and contains the logic for the "About" dialog box in the SWMM interface. This form provides information about the software, including a description of its purpose, a disclaimer, and links to external resources.

Key Features of Dabout.pas:

1. About Box UI Components:

   • Labels:
     • Label1: Title or introductory label in the form.
     • Label2: Subtitle or additional description.
     • Label5: A label describing the software version or additional info.
     • Label4: Displays the software version (e.g., "Storm Water Management Model Version 5.2").
     • Label6: Displays the system architecture (e.g., "64-bit Edition" if running on 64-bit).
   • Panels:
     • Panel1: Contains the main content.
     • Panel2: Contains the footer or extra information.
   • PageControl:
     • TabSheet1: First tab displaying the main software description.
     • TabSheet2: Second tab showing additional information, including links to EPA SWMM documentation and external resources.
   • Memo:
     • Memo1: Displays the disclaimer text.
     • Memo2: Displays the description of the software and additional information.
   • LinkLabel:
     • LinkLabel1: Contains a clickable link that redirects the user to the EPA SWMM website.

2. Event Handlers:

   • FormCreate: Initializes the form, sets labels, and loads text for the description, disclaimer, and links.
   • FormKeyDown: Allows the user to close the "About" dialog by pressing the ESC key.
   • LinkLabel1LinkClick: Opens the URL in the default web browser when the user clicks the link.

3. External Resources:

   • The link provided (https://www.epa.gov/water-research/storm-water-management-model-swmm) redirects users to the official EPA SWMM page for more information.

4. Version and System Information:

   • The form displays the current version of the software (e.g., "Version 5.2").
   • It also displays system-specific information, such as whether the application is a 64-bit version.

Purpose:

The Dabout.pas unit provides a user interface for showing details about the EPA SWMM software, including its version, description, and relevant links. The user can read about the software, access legal disclaimers, and find further information through external links, specifically linking to the EPA website.

In summary, Dabout.pas is an essential part of the user interface for the EPA SWMM project, offering users detailed information and links for further reading, while also ensuring that legal disclaimers are visible for users.

SWMM5 Delphi GUI Animator.pas Summary

 The Animator.pas unit is part of the EPA SWMM (Storm Water Management Model) and is responsible for managing the animation of results in the SWMM interface, specifically for animating the study area map and profile plots. It handles the user interface elements like buttons and sliders to control the animation of simulation results over time.

Key Features of Animator.pas:

1. Controls for Animation:

   • AnimatorBox: A group box containing the animation controls.
   • SpeedBar: A trackbar (slider) to adjust the speed of the animation.
   • AnimatorToolBar: A toolbar with buttons to control the animation.
     • RewindBtn: Rewinds the animation to the start.
     • BackBtn: Goes backward in time in the animation.
     • PauseBtn: Pauses the animation.
     • FwdBtn: Moves forward in time in the animation.

2. Timer:

   • Timer: A timer control that triggers the updates for the animation (to move to the next or previous time step).

3. Event Handlers:

   • BackBtnClick: Starts the animation when the "Back" button is clicked.
   • RewindBtnClick: Rewinds the animation to the start when the "Rewind" button is clicked.
   • PauseBtnClick: Pauses the animation when the "Pause" button is clicked.
   • FwdBtnClick: Starts or continues the animation forward when the "Forward" button is clicked.
   • SpeedBarChange: Changes the speed of the animation based on the position of the SpeedBar.
   • TimerTimer: Executes the logic for moving forward or backward in time, depending on whether the forward or backward button is pressed.

4. Methods:

   • UpdateStatus: Updates the status of the animation controls based on whether the simulation has data and more than one time period is available. If these conditions are not met, the controls are disabled.

5. Animation Logic:

   • The animation controls are enabled only if there is more than one time period of data available. The buttons allow users to navigate through the simulation's time periods.
   • The Timer control triggers updates when the FwdBtn or BackBtn is clicked, moving through the simulation's time periods.
   • The SpeedBar allows users to adjust the speed of the animation, with the interval of the Timer being adjusted accordingly.

Purpose:

This unit is integral to the interactive aspect of the EPA SWMM software, allowing users to visualize the progression of simulation results over time on the study area map and profile plots. It ensures the results are presented in an animated format with user-controllable features such as pausing, rewinding, and adjusting the speed of the animation.

In summary, Animator.pas handles the animation controls and the timing of updates for visualizing the simulation results dynamically.

SWMM5 Delphi GUI Objprops.txt Summary

 The Objprops.txt file contains constant definitions for various project objects, properties, and options used in EPA SWMM5 (Storm Water Management Model). These constants are imported into the Uproject.pas unit and are used to define the properties of various objects in the SWMM model, such as raingages, subcatchments, junctions, links, pumps, orifices, and more.

Key Components of Objprops.txt:

1. Labels for Project Objects:

   • ObjectLabels: An array defining the labels for different project objects like Title, Rain Gage, Subcatchment, Junction, Link, Pump, Weir, etc.

2. Labels for Project Options:

   • OptionLabels: An array containing labels for various project options such as COMPATIBILITY, REPORT_CONTROLS, FLOW_UNITS, INFILTRATION, FLOW_ROUTING, and more. These options govern the configuration of the simulation and are used to fine-tune the modeling of runoff and drainage.

3. Raingage Data Source Options:

   • RaingageOptions: Defines the data source options for raingages, which can either be TIMESERIES or FILE.
   • RainUnits: Specifies the units for rainfall measurements, either IN (inches) or MM (millimeters).

4. Flow Units:

   • FlowUnitsOptions: Specifies different flow units for the simulation, including CFS (cubic feet per second), GPM (gallons per minute), MGD (million gallons per day), CMS (cubic meters per second), LPS (liters per second), and MLD (million liters per day).

5. Link Offsets:

   • LinkOffsetsOptions: Defines the possible choices for link offsets, which can be DEPTH or ELEVATION.

6. Infiltration Model Options:

   • InfilOptions: Specifies the different infiltration models available for the simulation, such as HORTON, GREEN_AMPT, CURVE_NUMBER, and more.

7. Temperature Keywords:

   • TempKeywords: Defines keywords for temperature-related options like WINDSPEED, SNOWMELT, and ADC (air dry coefficient).

8. Evaporation and Snowpack Data Options:

   • EvapOptions: Defines evaporation data sources such as CONSTANT, TIMESERIES, FILE, etc.
   • SnowpackOptions: Defines snowpack-related options like PLOWABLE, IMPERVIOUS, and PERVIOUS.

9. Routing Methods and Force Main Equation Options:

   • RoutingOptions: Specifies different flow routing methods such as STEADY, KINWAVE, and DYNWAVE.
   • DynWaveOptions: Defines the dynamic wave options like EULER, PICARD, and HYBRID.
   • ForceMainEqnOptions: Specifies choices for force main equations (H-W and D-W).

10. Pump Curve Types:

• PumpTypes: Defines different pump curve types like TYPE1, TYPE2, TYPE3, and TYPE4.

11. Weir Types and Shapes:

• WeirTypes: Defines various weir types like TRANSVERSE, SIDEFLOW, V-NOTCH, etc.
• WeirShapes: Specifies weir shapes such as RECT_OPEN, TRAPEZOIDAL, etc.

12. Curve Type Options:

• CurveTypeOptions: Defines curve types used in the simulation, including CONTROL, DIVERSION, PUMP1, PUMP2, RATING, and others.

13. Divider Options:

• DividerOptions: Specifies the types of dividers, including CUTOFF, TABULAR, WEIR, and OVERFLOW.

14. Miscellaneous Keywords:

• Defines various options for simulation configuration, such as OFF, ON, NO, YES, NONE, ALL, etc.

15. Project Object Property Lists:

• RaingageProps, SubcatchProps, JunctionProps, etc., are arrays defining properties for each type of project object (raingage, subcatchment, junction, outfall, etc.). These properties are used for input and output in the model.

16. Hints for Object Properties:

• RaingageHint, SubcatchHint, JunctionHint, etc., provide descriptions or instructions for each property, helping users understand how to configure them properly.

Summary:

The Objprops.txt file is a key configuration file for EPA SWMM5, containing the definitions and options for project objects, simulation parameters, and various configurations. It includes the types of objects in the simulation (e.g., raingages, subcatchments, nodes), their properties, and the possible values or choices for these properties (e.g., flow units, routing methods, infiltration models). This file also provides hints for configuring object properties and options, making it easier for users to set up and understand the model's behavior.

SWMM5 Delphi GUI viewvars.txt Summary

 The viewvars.txt file contains definitions for various view variables (also known as map themes) used in EPA SWMM5 (Storm Water Management Model) for visualization purposes. These view variables represent key metrics and data related to subcatchments, nodes, links, and system-wide statistics.

Key Components of viewvars.txt:

1. Constants and Variables:

   • MAXINTERVALS: Maximum number of intervals for color scaling.
   • MapObjectName: Array that categorizes map themes into three types: Subcatchments, Nodes, and Links.

2. Subcatchment Variables:

   • Input Data:
     • Variables like AREA, WIDTH, SUBCATCHSLOPE, IMPERVIOUSNESS, and LID_USAGE represent subcatchment characteristics.
   • Summary Report:
     • Variables such as TOTAL_PRECIP, TOTAL_EVAP, TOTAL_INFIL, TOTAL_RUNOFF, PEAK_RUNOFF, RUNOFF_COEFF provide key summary statistics for subcatchments.
   • Time Series Output:
     • Includes variables such as RAINFALL, SNOWDEPTH, EVAP, INFIL, RUNOFF, GW_FLOW, GW_ELEV, and SUBCATCHQUAL, representing various outputs for subcatchments over time.

3. Node Variables:

   • Input Data:
     • Variables like INVERT and MAX_DEPTH describe the basic properties of nodes.
   • Summary Report:
     • Variables such as MAX_LATFLOW, TOT_LATFLOW, MAX_FLOODING, TOT_FLOODING, HRS_FLOODED summarize node performance.
   • Time Series Output:
     • Time-dependent variables like NODEDEPTH, HEAD, VOLUME, LATFLOW, INFLOW, OVERFLOW, NODEQUAL.

4. Link Variables:

   • Input Data:
     • Variables like DIAMETER, ROUGHNESS, LINKSLOPE represent the basic attributes of links.
   • Summary Report:
     • Variables like MAX_FLOW, MAX_VELOC, MAX_FULL, HRS_SURCH, HRS_CAP_LTD provide link-related statistics.
   • Time Series Output:
     • Variables such as FLOW, LINKDEPTH, VELOCITY, LINKVOLUME, CAPACITY, LINKQUAL represent time-dependent outputs for links.

5. System-Wide Variables:

   • Variables like SYS_TEMPERATURE, SYS_RAINFALL, SYS_RUNOFF, SYS_DWFLOW, SYS_GWFLOW, and SYS_OUTFLOW represent system-wide statistics over time.
   • SYSVIEWS is used to define the maximum system-wide display variables.

6. TViewVariable:

   • Represents the structure for each view variable.
   • Includes the Name of the variable, its SourceIndex (which determines where it is sourced from in the data), and DefIntervals (which define default color legend intervals).

7. Base Units:

   • Different variables have units assigned in the BaseSubcatchUnits, BaseNodeUnits, and BaseLinkUnits arrays.
   • The units are used for visualization and are specific to the type of object (e.g., Subcatchments, Nodes, Links).
     • Examples include ac (acres), ft (feet), CFS (cubic feet per second), mg/L (milligrams per liter).

Summary:

The viewvars.txt file in SWMM5 defines various view variables used for visualizing the results of a simulation. These variables cover a wide range of parameters related to subcatchments, nodes, links, and system-wide statistics. Each variable has a corresponding SourceIndex, which maps it to the appropriate data source, and DefIntervals, which define default intervals for color scaling in the visualization. This file is critical for generating graphical outputs such as maps and charts, enabling users to understand and interpret the simulation results effectively.

SWMM5 xsect.c Summary

 The xsect.c file in SWMM 5 is responsible for handling the cross-sectional geometry and hydraulic calculations for various types of conduits and channels. It provides functions to compute hydraulic parameters (such as area, wetted perimeter, hydraulic radius, section factor) based on the shape and dimensions of the cross-section, as well as to handle a variety of cross-sectional shapes used in drainage and stormwater systems.

Key Components of xsect.c:

1. Cross Section Geometry Functions:

   • Functions like getAofY(), getWofY(), getRofY(), and getYofA() compute the area, top width, hydraulic radius, and flow depth at a given value of depth or area for various cross-sections.
   • getSofA(), getRofA(), getdSdA(), and other functions calculate the section factor, hydraulic radius, and derivatives of section factor with respect to area, which are critical for hydraulic flow modeling using Manning's equation.

2. Cross Section Shape Types:

   • The file supports various geometric shapes for conduits and channels, such as:
     • Circular, Filled Circular, Egg Shaped, Horsehoe, Gothic, Catenary, Semicircular, Arch, Rectangular, Trapezoidal, Triangular, Parabolic, Power Function, Custom, Street Xsect (for streets), etc.
   • Each shape type has specialized functions for computing hydraulic parameters such as getRofA() (hydraulic radius for a given area) and getAofY() (area for a given depth).

3. Manning’s Equation:

   • Several functions in the file use Manning’s equation to calculate flow characteristics for different cross-sections, considering parameters like the flow area and wetted perimeter.
   • For instance, getSofA() computes the section factor (which is used in Manning’s equation) at a given area, while getRofA() calculates the hydraulic radius.

4. Flow Calculation for Special Shapes:

   • The file also includes specific calculations for special shapes like Eggshaped, Horsehoe, Gothic, Arch, Basket Handle, and Mod. Basket Handle shapes. These shapes require customized methods to compute parameters due to their unique geometry.

5. Handling Irregular and Custom Shapes:

   • For irregular and custom cross-sections, the file provides a way to define and compute the geometry based on user-defined data, supporting flexible configurations for modeling real-world drainage and stormwater systems.

6. Functions for Computing Critical Flow Depths:

   • getYcrit() computes the critical flow depth for a cross-section given a flow rate. The critical flow depth is important for flood modeling and for determining flow regime transitions (subcritical, critical, supercritical flow).

7. Street Cross-Sections:

   • xsect_setStreetXsectParams() is used for setting parameters for street cross-sections. Streets often have a unique shape, and this function models the geometry of streets with channels, curbs, gutters, and backing.

Functions Related to Geometry:

• xsect_isOpen(): Determines if the cross-section is open (e.g., an open channel or conduit) or closed.
• xsect_getSofA(): Computes the section factor (a measure of the ability of a section to convey flow) for a given area.
• xsect_getRofA(): Computes the hydraulic radius (ratio of flow area to wetted perimeter) for a given area.
• xsect_getYofA(): Returns the flow depth (Y) for a given flow area (A).
• xsect_getAofY(): Returns the flow area (A) for a given flow depth (Y).
• xsect_getWofY(): Returns the top width (W) of a cross-section at a given flow depth (Y).
• xsect_getdSdA(): Computes the derivative of the section factor with respect to area, used for flow calculations.

Specialized Shape Functions:

• Circular Shapes:

  • circ_getAofY(), circ_getRofA(), circ_getSofA(): Handle calculations for circular cross-sections.

• Filled Circular:

  • filled_circ_getYofA(), filled_circ_getRofA(), filled_circ_getAofY(): Handle filled circular sections, where part of the circle is filled with water.

• Rectangular and Trapezoidal:

  • rect_closed_getSofA(), rect_open_getSofA(): Handle closed and open rectangular cross-sections.
  • rect_triang_getSofA(), rect_round_getSofA(): Handle triangular and rounded rectangular cross-sections.

• Custom Shapes:

  • xsect_setCustomXsectParams(): Assigns parameters to custom-shaped cross-sections, allowing for flexible modeling based on user input.

Purpose:

• The primary purpose of xsect.c is to provide the necessary functions for calculating key hydraulic parameters like area, width, hydraulic radius, and section factor, which are essential for flow modeling in SWMM.

• The file allows SWMM to handle a wide variety of conduit and channel shapes, including standard shapes (circular, rectangular) and custom, user-defined shapes, ensuring flexibility and accuracy in hydraulic simulations.

• Through specialized functions for calculating flow characteristics and handling different cross-section shapes, xsect.c plays a critical role in SWMM's ability to model stormwater systems effectively, considering complex geometries and varying flow conditions.

SWMM5 xsection.dat Summary

 The xsection.dat file contains tables of relative geometric properties for rounded cross-sections, which are used in the EPA SWMM5 (Storm Water Management Model) to model various shapes of drainage and stormwater cross-sections. These properties help determine flow characteristics such as area, width, hydraulic radius, section factor, and wetted perimeter at different flow depths.

Key Components of xsection.dat:

1. Cross-Section Geometry Tables:

   • The file includes tables for multiple types of cross-sectional shapes, such as circular, egg-shaped, horseshoe, gothic, catenary, semi-elliptical, and basket-handle shapes.
   • For each shape, the following tables are provided:
     • A_xxx: Represents the area divided by the full area versus the depth divided by the full depth (for a given shape).
     • Y_xxx: Represents the depth divided by the full depth versus the area divided by the full area.
     • W_xxx: Represents the width divided by the maximum width versus the depth divided by the full depth.
     • R_xxx: Represents the hydraulic radius divided by the hydraulic radius at full depth versus the depth divided by the full depth.
     • S_xxx: Represents the section factor divided by the section factor at full depth versus the area divided by the area at full depth.
     • N_Z_xxx: Number of equal intervals between 0.0 and 1.0 in the table for parameter Z and shape xxx.

2. Shape-Specific Tables:

   • Circular Shape: Includes parameters for standard circular cross-sections, which use Manning's equation to calculate flow.
     • Tables: A_Circ, R_Circ, Y_Circ, S_Circ, W_Circ.
   • Egg-Shaped Shape: Provides parameters for egg-shaped cross-sections.
     • Tables: A_Egg, R_Egg, Y_Egg, S_Egg, W_Egg.
   • Horseshoe Shape: Provides parameters for horseshoe-shaped cross-sections.
     • Tables: A_Horseshoe, R_Horseshoe, Y_Horseshoe, S_Horseshoe, W_Horseshoe.
   • Gothic Shape: Provides parameters for gothic-shaped cross-sections.
     • Tables: A_Gothic, R_Gothic, Y_Gothic, S_Gothic, W_Gothic.
   • Catenary Shape: Provides parameters for catenary-shaped cross-sections.
     • Tables: A_Catenary, R_Catenary, Y_Catenary, S_Catenary, W_Catenary.
   • Semi-Elliptical Shape: Provides parameters for semi-elliptical cross-sections.
     • Tables: A_SemiEllip, R_SemiEllip, Y_SemiEllip, S_SemiEllip, W_SemiEllip.
   • Basket-Handle Shape: Provides parameters for basket-handle shaped cross-sections.
     • Tables: A_BasketHandle, R_BasketHandle, Y_BasketHandle, S_BasketHandle, W_BasketHandle.
   • Semi-Circular Shape: Provides parameters for semi-circular cross-sections.
     • Tables: A_SemiCirc, R_SemiCirc, Y_SemiCirc, S_SemiCirc, W_SemiCirc.

3. Geometric Properties:

   • Each table contains values for a specific geometric property (e.g., area, width, hydraulic radius) as a function of flow depth, normalized to full depth and area.
   • These tables are used for hydraulic calculations, such as computing the flow, hydraulic radius, and wetted perimeter, and are essential for solving Manning's equation for flow in conduits and channels.

4. Key Parameters for Specific Shapes:

   • Circular Shape: Parameters such as the radius of the circle, wetted perimeter, and the area of the circle are calculated and normalized in the R_Circ and A_Circ tables.
   • Egg-Shaped Shape: Parameters for this shape are used to compute the flow characteristics in egg-shaped pipes and channels.
   • Horseshoe Shape: This shape is commonly used for stormwater culverts and is modeled using the A_Horseshoe and R_Horseshoe tables.
   • Gothic Shape: Used for unique stormwater and sewer applications, modeled using A_Gothic, R_Gothic, etc.
   • Semi-Elliptical and Basket-Handle shapes: Often used for specialized sewer systems, modeled using the respective geometric tables.

5. Full Depth and Section Factor:

   • Each shape has a corresponding section factor, which is used to calculate flow using Manning's equation.
   • The S_xxx tables provide the section factor relative to full section factor at full depth.

6. Manning’s Equation:

   • The file also supports the calculation of flow using Manning's equation for these cross-sections, considering the roughness coefficients (Manning's n values) for different parts of the cross-section.

7. Use in SWMM:

   • The tables in xsection.dat are critical for computing the flow, head, and other hydraulic characteristics of channels, pipes, and culverts in the SWMM model. They provide the necessary geometric data for different types of cross-sections, ensuring the model can simulate flow through diverse drainage structures accurately.

Summary:

The xsection.dat file in SWMM5 provides predefined tables for various cross-section shapes (such as circular, egg-shaped, horseshoe, and others) that are used to calculate hydraulic parameters such as area, wetted perimeter, hydraulic radius, and section factor at different flow depths. These tables are fundamental for modeling flow through stormwater and sewer systems, ensuring that the flow calculations are based on the correct geometry for each type of conduit or channel.+