SWMM5 project.c Summary

 The project.c file is a key component of the SWMM5 (Storm Water Management Model) project management system. It handles the initialization, validation, and memory management of the project's data objects, such as subcatchments, nodes, links, pollutants, and more. The file provides functionality for opening and closing a project, reading input data, allocating memory for project objects, and validating data. It also manages hash tables for efficiently identifying objects by their ID names and handles the cleanup of memory when the project is closed.

Key Features of the Code:

1. Project Initialization:

• project_open(): Initializes a new SWMM project by setting default values, opening the required files, and initializing data structures.
• project_readInput(): Reads the input data for the project from the input file, including the number of objects and their properties.
• project_validate(): Validates the input data to ensure correctness, including checking for valid curves, time series, subcatchments, nodes, links, and other project components.
• project_init(): Initializes the internal state of all objects, including subcatchments, nodes, links, and more.

2. Memory Management:

• createObjects(): Allocates memory for all project objects (e.g., subcatchments, nodes, links) based on the number of objects defined in the input file.
• deleteObjects(): Frees the memory allocated for all project objects, including land use factors, groundwater, and other components.
• createHashTables(): Allocates memory for hash tables used to store object IDs for quick lookup.
• deleteHashTables(): Frees the memory used for hash tables and cleans up memory pools.

3. Object Management:

• project_addObject(): Adds an object to a hash table, ensuring that no duplicate object IDs are added.
• project_findObject(): Finds an object by its ID using the hash table for efficient lookup.
• project_findID(): Finds the address where an object's ID string is stored in memory.
• project_createMatrix(): Allocates memory for a matrix of doubles, used for storing various project-related data.
• project_freeMatrix(): Frees the memory allocated for a matrix of doubles.

4. Data Validation and Defaults:

• setDefaults(): Sets default values for various project settings, including units, flow routing methods, time steps, and more.
• project_validate(): Ensures that the data in the project file is valid, including checking curves, time series, and other components.
• project_readOption(): Reads specific project options from input data, such as simulation start and end dates, time steps, and flow units.

5. File Management:

• openFiles(): Opens the input and output files for reading and writing the project's data.
• deleteFiles(): Frees the memory used by the file structures once the project is closed.

6. Infiltration, LID, and Water Quality:

• infil_create(): Allocates memory for infiltration-related data.
• lid_create(): Allocates memory for Low Impact Development (LID) objects.
• lid_delete(): Frees memory used by LID objects.
• infil_delete(): Frees memory used by infiltration-related data.
• gwater_create(): Allocates memory for groundwater-related data.
• gwater_delete(): Frees memory used by groundwater-related data.

Workflow:

1. Opening a Project:

   • The project is opened by reading the project files (input, report, and output) and initializing the required data structures, including hash tables and object arrays.

2. Reading Input Data:

   • The input file is parsed to extract project data, such as subcatchments, nodes, links, and other elements. This data is validated to ensure it conforms to the expected structure.

3. Object Initialization:

   • Objects such as subcatchments, nodes, and links are initialized based on the parsed input data. Memory is allocated for each object, and their properties are set to default values where necessary.

4. Validating Data:

   • The input data is validated to check for consistency, including ensuring that all objects are properly defined, time steps are valid, and parameters are within acceptable ranges.

5. Running the Simulation:

   • Once the project is initialized and validated, the simulation can run, utilizing the data stored in the project objects. Various computational methods are applied based on the project configuration (e.g., flow routing, water quality, infiltration, etc.).

6. Closing the Project:

   • When the simulation is complete, the project is closed, and memory used by project objects is freed.

Summary:

The project.c file is essential for managing the project's data in SWMM5. It provides functionality for reading input data, validating it, initializing objects, and managing memory. The file also handles the opening and closing of the project's files and the creation and deletion of various project-related objects, such as subcatchments, nodes, and links. By managing these operations, the file ensures that the project runs smoothly and that the necessary data is available for simulation and output generation.