SWMM 5.0 Update History
==================

-----------------------
Build 5.0.013 (3/11/08)
-----------------------
Engine Updates:

1.  The check on acceptable values for site latitude was
    corrected (see climate.c).

2.  The definition and implementation of the PID controller
    was changed. See the Help file or the Users Manual for
    details (see controls.c).

3.  The following changes were made to the dynamic wave flow
    routing routine in dynwave.c:
    a. A new method that places more weight on upstream conduit
       geometry as the Froude number approaches 1 was added.
    b. A code re-factoring error that crept into the inertial
       term of the momentum equation was corrected.
    c. The flow in a fully flowing open channel can no longer be
       greater than the full normal flow.
    d. The Normal Flow Limit based on both slope and Froude number
       was modified to simply implement the two criteria together
       in the same fashion as they are done individually.
    e. A check was added that prevents any flow out of a node that
       is dry.
    f. The ponding computation was reverted back to that of 5.0.009
       (depth is computed from volume rather than volume computed
       from depth) to better maintain flow continuity.
    g. Using the maximum allowable change in depth at a node as a
       criterion for selecting a variable time step was restored.

4.  The crown elevations of any connecting non-conduit links are
    now considered when determining a node's crown elevation (see
    flowrout.c).

5.  The possibility that the initial setting of an orifice was not
    being made correctly was eliminated (see link.c).

6.  Error checks were added to test for invalid numbers in a hot
    start file (see routing.c).

GUI Updates:

1.  Checks were added to test for erroneous values in an INI file
    that would prevent a graph from displaying properly.


----------------------
Build 5.0.012 (2/4/08)
----------------------
Engine Updates:

1.  The summary results tables written to the Status Report file
    have been updated and expanded. See the Users Manual for more
    details. Code changes to support this were made to dynwave.c,
    flowrout.c, funcs.h, inputrpt.c (a new module), keywords.c,
    keywords.h, link.c, objects.h, output.c, report.c, stats.c,
    statsrpt.c (a new module), and text.h.

2.  Conduit offsets can now be specified as an absolute
    elevation or, as before, a relative depth above the node
    invert. The same is true for the bottom of orifices, weirs,
    and outlets. The "Link Offsets" setting in the GUI and the
    corresponding LINK_OFFSETS entry in the project's input file
    determine which option, DEPTH or ELEVATION, is in effect.
    (see project.c, link.c, keywords.c, keywords.h, globals.h,
    and text.h).

3.  A PID-type controller has been added to the types of
    modulated control rules that are available. See the Help
    file or the Users Manual for instructions on how to use
    this feature (see controls.c and keywords.c).

4.  In the simulation results, "flooding" is now considered to
    occur whenever the water level exceeds the top of a node,
    whether ponding occurs or not. Before, flooding was only
    recorded when there was no ponding and node overflow was lost
    from the system (see dynwave.c, flowrout.c, massbal.c, node.c,
    stats.c, and statsrpt.c). 

5.  The point at which the time to drain the upper soil zone for
    Green-Ampt infiltration is first calculated was moved from time
    0 to the time when the first rainfall period occurs. This fixes
    a problem where different runoff hydrographs were being produced
    when a project's start date was shifted slightly (see infil.c). 

6.  The criteria used to determine when steady state flow
    conditions exist were changed to more closely follow those
    used in SWMM 4 (see routing.c and the Help File or Users
    Manual for the Skip Steady Periods option).

7.  The optional user-assigned maximum flow limit for conduits was
    made operational for all flow routing options, not just Dynamic
    Wave routing (see link.c).

8.  SI unit conversion problems for both a pump's on/off depth
    settings and its pump curve slope values were fixed (see link.c).

9.  The possibility that ponding could occur at the inlet (wet well)
    node for a Type I pump was added (see dynwave.c).

10. A mistake in the Hazen-WIlliams head loss formula for force
    main conduits was corrected (see forcmain.c).

11. The minimum limit of 0.0001 on flow area and hydraulic radius
    computed from flow depth during dynamic wave routing was removed
    since flow depth is already limited by this amount (see dynwave.c).

12. The flow direction test added for checking UPSTREAM CRITICAL and
    DOWNSTREAM CRITICAL flow conditions in dynamic wave flow routing
    was removed to prevent solutions from becoming stuck (see
    dynwave.c).

13. The use of a maximum allowable change in depth at a node as a
    criterion for selecting a variable time step for dynamic wave
    flow routing was dropped (see dynwave.c).

14. A more refined method for computing the flow across a bottom
    orifice at low heads was implemented. (see link.c).

15. The head loss calculation caused by flap gates in weirs was
    extended to orifices as well (see link.c).

16. The computation of depth as a function of area for a trapezoidal
    channel was extended to consider the case where the user used
    0 for the side slopes (making it a rectangular channel - a
    holdover from SWMM 4) (see xsect.c).

17. A bug introduced in 5.0.010 that was preventing RDII from being
    computed for unit hydrographs that used the same rain gage as
    another unit hydrograph was fixed (see rdii.c and objects.h).

18. Pollutant loading from RDII was corrected to be based on the
    pollutant's specified RDII quality rather than its rainfall
    quality (see routing.c). 

19. The "Snow Only" option for the buildup of a pollutant was never
    actually implemented and has now been added (see subcatch.c).

20. Additional error checking for valid snow melt and snow pack
    input parameters was added (see snow.c, error.c, and error.h).

21. The same runoff threshold is now used for both pollutant washoff
    (when above the threshold) and buildup (when below the threshold)
    to avoid non-zero runoff concentrations from being reported
    during periods with negligible runoff (see subcatch.c).

22. The values for total system outflow and system flooding that are
    saved to the binary results file at each reporting time step are
    now set equal to the same values that are used for computing the
    overall flow continuity error, thus avoiding inconsistent system
    outflow values being generated for some data sets (see output.c).

23. For the command line version of SWMM, the default END_TIME option
    was corrected from being 24 days to 0 days (i.e., midnight of the
    END_DATE value) (see project.c and swmm5.c).

GUI Updates:

1.  The Status Bar on the bottom of the main window was given a new look,
    with drop down buttons added for changing the Link Offsets convention
    and the project's flow units.

2.  A combo-box was added to the Nodes/Links page of the Project Defaults
    dialog to select the Link Offsets convention (in addition to the
    button on the Status Bar).

3.  The choice of Flow Units was removed from the General Options page
    of the Simulations Options dialog and placed into a drop down button
    on the main window's Status Bar. (As before, one can also set flow
    units from the Nodes/Links page of the Project Defaults dialog.

4.  A Bookmarks panel was added to the Status Report window to make it
    easier to navigate between different sections within the report.

5.  A new Measurement Tool button was added to the Map Toolbar that
    allows one to measure the distance of a polyline or the area of a
    polygon drawn directly on the study area map.

6.  Storage Units were added to the choice of objects that can be
    edited using the Group Editor dialog.

7.  The length assumed for non-conduit objects displayed on a profile
    plot was reduced from 100 ft to 10 ft.

8.  A "View Conduits Only" option was added to the Profile Plot Options
    dialog that makes the plot display just the water depth in the
    conduits along the profile and not show the HGL and ground surface.
    This allows one to get a better view of how full a conduit is.
    
9.  The Project Data viewer (launched when Project | Details is selected)
    can now be split into two views by selecting Window | Split from its
    menu bar (or Window | Remove Split to remove the split view).

10. The number of decimal places set for each computed variable on the
    Number Formats page of the Program Preferences dialog is now saved
    between sessions as the other preferences are.

11. Current simulation results are now always saved between sessions
    (if requested by the user) even if data were modified after the
    last run was made. In this case, when the project is opened again,
    the Run Status icon will show that results are available but need
    updating.

12. If the user changes the display format of a Date/Time axis in the
    Graph Options dialog and checks the Default box in the dialog, then
    this format will be used for all future time series plots for the
    current project.

13. A problem with the Profile Plot dialog not always identifying the
    path of fewest links between two nodes when asked to do so was
    corrected.

14. Entries in the [REPORT] section of a project input file that were
    used to define reporting options for the command line version of
    SWMM 5 will no longer be lost when the project is run under the
    GUI version of SWMM. The GUI version simply ignores them but adds
    them into the project file whenever it is saved.

15. Conduit lengths and areas were always being re-computed after the
    study area map's dimensions or distance units were changed with the
    Map Dimensions dialog rather than only when the user selected the
    re-compute option on the dialog.

16. The backdrop map now pans to the correct position when the Edit |
    Find Object command is used to locate an object that is currently
    not in view on the staudy area map.

17. The problem of having the name of a subcatchment's outlet node
    or groundwater node be lost whenever that node was converted to
    another type using the study area map's right-click popup menu
    was fixed.

18. The Statistics Report analyzer was failing to include the last
    event in its calculations for some data sets.

19. Additional input validation was added to the Snow Pack editor form.

----------------------
Build 5.0.011 (7/16/07
----------------------
Engine Updates:

1.  A bug that prevented Weir and Outlet settings from being
    updated after they were changed by control rules was fixed
    (see link.c).

2.  The control setting for a Weir was not being accounted
    for when computing an equivalent orifice coefficient for
    surcharged flow or when computing flow through a V-notch
    weir (see link.c).

3.  The reported depth of flow through a Weir was not taking into
    account the Weir's control setting (see link.c).

4.  An update made in 5.0.010 to how ponded depths and volumes are
    computed under dynamic wave flow routing was corrected (see
    dynwave.c).

5.  The equations used to mix the quality of runon, rainfall and
    ponded water over a subcatchment were revised to prevent
    numerical instability at very low volumes (see subcatch.c).
    
6.  Missing values in NCDC rainfall files that use the 'M' flag
    are now added to the total number of missing records reported
    (see rain.c).

GUI Updates

1.  A bug introduced in release 5.0.010 that neglected to place
    quotation marks around Map Labels and backdrop file names
    (which can have spaces in them) when a project was saved to
    file and which caused problems when the project was re-opened
    has been fixed.


-----------------------
Build 5.0.010 (6/19/07)
-----------------------
Engine Updates:

1.  All "float" variables were re-declared as "doubles"
    (except for those variables written to binary interface
    files) and the engine was re-compiled using the Microsoft
    VC++ 2005 compiler.

2.  A new NO ROUTING option was added which allows a run to
    ignore any flow routing and only compute runoff (see
    swmm5.c, keywords.c, stats.c, and enums.h).

3.  A new type of pump, an Ideal Pump, was added which pumps at a
    rate equal to the inflow to its inlet node and does not use a
    pump curve (see enums.h, link.c, and flowrout.c).

4.  A new type of conduit shape, a Custom Shape, was added which
    allows users to define their own cross-sectional geometry for
    closed conduits. To implement this feature, a new type of curve,
    a Shape Curve, was added which records how the width of the
    cross-section varies with height. (See keywords.c, link.c,
    project.c, report.c, shape.c, xsect.c, enums.h, funcs.h,
    globals.h, objects.h, and text.h).

5.  Another new type of conduit shape, a Circular Force Main, was
    added. It is a circular pipe that uses either the Hazen-Williams
    or Darcy-Weisbach equations, instead of the Manning equation,
    for pressurized flow only. The Hazen-Williams C-factor or the
    Darcy-Weisbach roughness height is one of the shape's parameters.
    The choice of which equation to use (for Force Mains only) is a
    new global option. (See project.c, forcmain.c, dynwave.c, 
    keywords.c, link.c, xsect.c, enums.h, globals.h and text.h).

6.  Pumps can now have startup and shutoff inlet node depths supplied
    directly as part of a pump's properties rather than as part of a
    control rule. (See link.c, routing.c, objects.h, and funcs.h).   

7.  Orifices can now have timed gate openings and closings as in
    SWMM 4 (i.e., the SWMM 4 ORATE parameter). (See link.c and 
    objects.h).

8.  Unit Hydrographs used for RDII inflows can now have an initial
    abstraction loss associated with them. Consult the Users Manual
    or the Help file for details. (See rdii.c and objects.h).

9.  A new criterion was added to determine when a conduit has
    supercritical flow and therefore normal flow conditions
    might apply. It is based on both water surface slope and
    the Froude number (as opposed to just one or the other).
    (See dynwave.c, project.c, keywords.c, enums.h, and text.h).

10. A Flow Instability Index is now computed for each non-pump link.
    It counts the number of time steps in which the link's flow is
    either higher or lower than the flows at the previous and next
    time steps. The Status Report lists the links with the five
    highest indexes. (See objects.h, stats.c, and report.c).

11. Node volumes are now initialized to take account of any initial
    ponding that may be implied by the node depth stored in a hot
    start file (see flowrout.c).

12. The area corrections to the inlet and outlet loss terms under
    dynamic wave flow routing that were introduced in Build 5.0.008
    were removed (see dynwave.c).

13. To comply more closely with standard hydraulic practice, the
    head across an orifice is now computed with respect to the
    midpoint of its opening, rather than to the bottom. Also,
    orifices are now treated the same as weirs in terms of not
    contributing any surface area to their end nodes (see link.c
    and dynwave.c).

14. The partly opened setting for an orifice is now interpreted as
    fraction of the full orifice opening height available rather
    than as the fraction of the full area available. Also, the
    equivalent discharge coefficient for a partly full orifice is
    now re-computed whenever the setting of the orifice changes
    (see link.c).

15. In kinematic wave flow routing, when a conduit's inflow is
    limited to its maximum normal flow, its corresponding inflow
    area is now correctly normalized to the full flow area (see
    kinwave.c).

16. For dynamic wave flow routing, the criteria used to check if
    a node is not full before using its depth to compute a variable
    time step was corrected to avoid excessively small time steps
    (see dynwave.c).

17. The width v. depth table for circular shapes was expanded to 51
    entries to match that of the other tables for this shape (see
    xsect.dat).

18. The number of entries in the geometry tables for irregular
    cross-sections was increased to 51 entries (see objects.h).

19. For Divider nodes, both end nodes of the diversion link are now
    checked to see if one of them is connected to the divider node
    (see node.c).

20. Conditions on Outlet links are now correctly recognized in control
    rule statements and an error message is now generated if more than
    one rule clause is placed on the same line (see controls.c).

21. When the Ignore Rainfall option is used, a rain gage's rainfall is
    now properly initialized to 0 to prevent a spurious rainfall value
    from being reported (see gage.c).

22. An explicit check is now made in the engine (which already exists
    in the GUI) to see if the ID name of the outlet of a subcatchment
    exists as both a node and a subcatchment. If so, then Error 108
    is thrown. (See subcatch.c).

23. The column in the Node Depth Summary of the Status Report that 
    previously displayed the total volume of ponded water at each
    node (but was labelled "Total Flooding") now displays the maximum
    volume of ponded water at each node and is labelled "Max Vol. Ponded".
    Also, flow values appearing in the Status Report's tables were expanded
    to 3 decimal places for MGD and CMS units, and an additional
    decimal place was added to ponded area and conduit length in the
    report's Input Summary tables (see stats.c and report.c).

24. When a node is ponded under dynamic wave routing, the water depth
    is now always set equal to the ponded depth rather than the smaller
    of the ponded and dynamic depths (see dynwave.c).

25. A more efficient way of processing the mathematical expressions
    used in treatment functions has been implemented (see mathexpr.h,
    mathexpr.c, and objects.h).

26. A bug in the Groundwater routine that allowed infiltration to
    continue even when the entire groundwater table was saturated was
    fixed as was a metric units conversion error on computed groundwater
    flow (see gwater.c).

27. The locations of the left and right overbank stations for an 
    irregular channel transect are now adjusted by the Station Modifier
    multiplier, in the same way as all of the other station locations
    across the transect are.

28. An error in computing the flow contribution of the triangular
    ends of a trapezoidal weir was corrected (see link.c).

29. A roundoff error under kinematic wave and steady flow routing that
    sometimes caused nodes to be incorrectly reported as ponded was
    fixed (see flowrout.c).

GUI Updates:

1.  A "Tools" item was added to SWMM's main menu. The existing menu
    options to set Program Preferences and Map Display Options were
    moved there. In addition, it contains a "Configure Tools" option
    that can be used register add-in tools with SWMM 5. Consult the
    Users Manual or the Help file for more information regarding add-
    in tools.
 
2.  A "None" option was added to the choice of routing methods on the
    General page of the Simulation Options dialog to accommodate the
    new No Routing analysis option.

3.  The Property Editor for Pumps was modified to allow the Pump Curve
    field to remain blank (or accept a *) to signify the new Ideal type
    pump and to accept startup and shutoff depths.

4.  The Property Editor for orifices was modified to include a Time To
    Close/Open field.

5.  The Unit Hydrograph Editor dialog was modified to include the new
    Initial Abstraction parameters.

6.  The Analysis Options dialog was modified to accommodate the new
    supercritical flow criterion.

7.  The Cross-Section Editor and the Curve Editor were modified to
    accommodate the new Custom cross-section shape feature as well as
    the new Circular Force Main shape.

8.  The File | Export menu has a new option that, once a run has been
    successfully made, will export the node and link results at the
    current time period being viewed to a Hotstart file.

9.  The popup menu for toggling the map's Auto-Length feature was
    replaced with a check box on the Status Panel.

10. A check box was added to the Map Dimensions dialog to ask if conduit
    lengths and subcatchment areas should be recomputed when the Auto-
    Length setting is on.

11. The Group Delete feature now offers the option of only deleting
    objects with a specific value for their Tag property.

12. Ponded Area was added to the list of node parameters that can be
    assigned a default value through the Project >> Defaults menu item. 

13. The epaswmm5.ini file that contains a user's program preferences
    is now saved to the users Application Data folder, in a sub-folder
    named EPASWMM, rather than to the user's home folder. 

14. Conduit slopes are no longer displayed as absolute values, so that
    negative slopes will show up on a thematic display on the study area
    map and will also be identified when a map query is made.

15. The bitmap image on the Run speed button was replaced.

16. The automatic identification of a connected path of links between
    two nodes specified on the Profile Plot dialog now uses the path
    with the smallest number of links.

17. The Study Area Map's Zoom Out feature no longer uses a zoom out
    to previous extent. Instead it zooms out relative to the current
    center of the map.

18. The Animator toolbar was made a permanent part of the Map Browser
    panel.

19. The operation of the date and time controls on the Map Browser panel
    were modified to work correctly with reporting times that are larger
    than 1 day.

20. The options on the Map Query dialog were extended to allow one to
    identify all nodes on the map that have been assigned a particular
    type of external inflow (Direct, Dry Weather, RDII, or Groundwater).


-----------------------
Build 5.0.009 (9/19/06)
-----------------------
Engine Updates:
1.  A climate file in the user-prepared format will no longer
    be confused with one using the Canadian format (see
    climate.c).
2.  The minimum runoff which can generate pollutant washoff was
    changed from 0.001 in/hr to 0.001 cfs (see subcatch.c).
3.  A new RDII event now begins when the duration of a
    continuous run of dry weather exceeds the base time of
    the longest unit hydrograph rather than arbitrarily being
    set at 12 hours (see rdii.c).
4.  Problems with dynamic flow routing through long force mains
    connected to Type 3 and Type 4 pumps have been corrected (see
    dynwave.c and link.c).

GUI Updates:
1.  A problem in displaying profile plots when all elevations
    are below zero has been corrected.

----------------------
Build 5.0.008 (7/5/06)
----------------------
Engine Updates:
1.  The conversion from the Horton infiltration drying
    time input parameter to an equivalent regeneration
    curve constant was corrected.
2.  Pipe invert elevations at outfalls are now measured
    relative to the outfall stage elevation rather than
    the outfall's invert elevation.
3.  Entrance/exit minor loss terms for dynamic wave flow
    routing are now adjusted by the ratio of the mid-point
    to entrance/exit areas to improve the energy balance.
4.  A possible error in computing flow depth from head when
    checking the normal flow limitation based on the Froude
    number for dynamic wave flow routing was corrected.
5.  A potential problem with converting the units of rainfall
    read from an external file was corrected.
6.  The equivalent length of orifices and weirs was changed
    from being a minimum of 200 ft to a maximum of 200 ft.
7.  Problems in displaying washoff mass balance results for
    pollutants expressed as Counts/Liter were fixed.
8.  The reporting of total system maximum runoff rate in the
    Status Report's Subcatchment Runoff Summary table has been
    corrected.
9.  The subcatchment pollutant washoff process was
    reprogrammed to provide more rigorous mass balance
    results for the case where runoff from one subcatchment
    is routed over another subcatchment or when there is
    direct deposition from rainfall.
10. Checks for non-negative conduit offsets and orifice/
    weir/outlet heights have been added.
11. A constant value and a scaling factor have been added to
    Direct External inflows. See the Inflows Editor - Direct
    Page topic in the Help file for more details.
12. A listing of total washoff loads for each pollutant for
    each subcatchment has been added to the Status Report.
13. A new summary table of Node Inflows and Flooding has been
    added to the Status Report.
14. A new summary table of Outfall flows and pollutant loads
    has been added to the Status Report.
15. The 5.0.006 Engine Update #12 has been revoked.

GUI Updates:
1.  The Inflows Editor was modified to accommodate the baseline
    and scaling parameters added to direct external inflows.
2.  The .INI file that saves a user's program preferences is now
    saved to the user's home directory rather than the SWMM
    installation directory.
3.  The Select All command was extended to apply to the Status
    Report display.
4.  A new text file viewer component was used for the Status
    Report to speed up the display of the report's contents.
5.  A formating error on the Horizontal Axis page of the Graph
    Options dialog form was corrected. This required making
    changes to the custom Chart Dialog component that is included
    with the GUI's source code.
6.  Some cosmetic changes were made to the look of Tabular
    reports.
7.  Type 3 pump curves (head v. flow) are now displayed with
    head on the vertical axis and flow on the horizontal axis
    when the View option is selected in the Curve Editor dialog.


-----------------------
Build 5.0.007 (3/10/06)
-----------------------
Engine Updates:
1.  An "Ignore Rainfall" analysis option was added that causes
    the program to only consider user-supplied external inflow
    time series and dry weather flows and ignore any rainfall
    inputs that would otherwise produce runoff.
2.  The hydraulic radius calculations for Rectangular-Closed,
    Rectangular-Triangular, and Rectangular-Round conduit shapes
    were modified to account for the increase in wetted perimeter
    that occurs under full flow due to the top surface.
3.  Refinements were made in several places in the code that need
    to distinguish between Full Flow and Maximum Flow conditions in
    closed conduits.
4.  The code now properly accounts for the case where the depth at
    which the maximum normal flow occurs through an irregular shaped
    cross section is less than the full depth.
5.  The final volume of any ponded water (caused by node flooding)
    is now included in the reported flow continuity error.
6.  Peak runoff flow was added to the Subcatchment Summary table
    in the Status Report.
7.  Non-conduit links are now included in the Link Flow Summary table
    of the Status Report.

GUI Updates:
1.  The Maximum Depth field in the Property Editor for a conduit with
    an irregular shape now shows the correct value for any set of
    transect elevation values.
2.  The "Save Profile to File" button is now enabled when the user
    manually adds a specified set of links to the Profile Plot dialog.
3.  Link Flow Depth and Link Velocity have been added as choices for
    calibration variables.
4.  The way that non-conduit links are displayed on profile plots was
    changed to avoid problems that occurred for weirs and orifices with
    crest heights above the node invert.
5.  A problem with the way that the Group Editing function was handling
    the case of irregular shaped cross sections was fixed.
    

-------------------------
Build 5.0.006a (10/19/05)
-------------------------
Engine Updates:
1.  The formula for snow melt rate during periods with rainfall
    was corrected to return its value in ft/sec rather than in/hr.
2.  A problem with generating routing interface files for systems
    with just nodes and no links was corrected.

GUI Updates:
1.  Numerical precision problems in computing centroids for
    subcatchments with very small distances between vertices
    were fixed.
2.  A problem with no calibration data being shown on a time
    series graph when some of the data were outside the range
    of the graph was fixed.
3.  A problem with calibration data represented as dates (not
    elapsed time) being shifted one reporting period over in
    time series graphs that used elapsed time was fixed.


----------------------
Build 5.0.006 (9/5/05)
----------------------
Engine Updates:
1.  A new summary table of maximum volumes and outflow rates
    for each storage unit has been added to the Status Report.
2.  The SWMM 4 BC parameter, which specifies a minimum groundwater
    table elevation for groundwater flow to occur, was added as an
    optional groundwater flow parameter. If not provided then as
    before, the invert of the receiving node defines the minimum
    groundwater table elevation for flow to begin.
3.  A new option was added to the Action clause of a control rule that 
    allows the control setting for pumps, orifices, weirs, and outlets
    to be defined either by a curve (of setting versus node depth, for
    example) or by a time series. See the "Modulated Controls" topic
    in the Help file for more details.
4.  The problem with interior nodes being mistaken for outfall nodes
    (depending on the orientation of the connecting links) under water
    quality analyses was fixed.
5.  Geometry tables for standard size elliptical pipes were added
    (the standard size code number in the input file was being mistaken
    for an actual dimension).
6.  Storage curves of area versus depth are now linearly extrapolated
    when a depth exceeds the table limit (as in SWMM 4) rather than just
    keeping the area constant.
7.  Evaporation is no longer computed from a storage unit when it
    becomes dry.
8.  In water quality routing, concentrations in storage units are now
    adjusted to reflect any evaporation loss over each time step.
9.  It is now permissible to use the same hotstart file to both provide
    initial values for a run and to save the final values from a run.
10. The code was modified to be able to read evaporation values from a
    climate file during runs where no runoff computations are being
    made (previously any evaporation in such files was being ignored in
    data sets with no subcatchments).
11. A problem in the way that water quality was being routed through
    dummy conduits was fixed.
12. For pollutant treatment functions that define fractional removal in
    a storage unit node as a function of concentration, the concentration
    used is now the inflow concentration into the node (as is done for
    non-storage nodes), rather than the concentration in the storage unit.
13. The global first-order decay reaction assigned to specific pollutants
    is not applied to any storage unit that has a treatment function
    defined for the pollutant.
14. The total moisture available for infiltration at each time step of
    the runoff process now has evaporation subtracted from it before
    infiltration is computed.
15. Corrections were made to the way that the water volume in the upper
    soil zone is depeleted during dry periods under Green- Ampt
    infiltration.
16. A climate file is now positioned to begin reading at the start of the
    simulation period (rather than the start of the file) unless the user
    supplies a specific starting date to begin reading from the file.
17. A fatal error is now generated if the end of a climate file is reached
    when seeking climate data during a run (rather than just maintaining
    the same climate values for the remainder of the run).
18. The Node and Conduit flow statistics that appear in the Status Report
    are now only collected over the reporting period of the simulation,
    not the entire period (as would be the case when the user specifies
    a Report Start Date that comes after the Simulation Start Date).
19. The computation of the initial and final groundwater storage volumes
    used in the Groundwater Continuity table were corrected. This error 
    only affected the continuity numbers and not the computed flows and
    water table levels.

GUI Updates:
1.  The File >> Reopen command will now list up to 10 most recently used
    files.
2.  Map coordinates are now displayed with 3 decimal places in the Status
    Bar.
3.  The File >> Preferences dialog now contains a "Prompt to Save Results"
    option. If left unchecked, simulation results will always be saved when
    a project file is closed and will be available for viewing the next
    time the project is opened.
4.  A "Report Elapsed Time by Default" option was also added to the File >>
    Preferences dialog. If checked, then time series graphs and tables will
    default to using elapsed time, rather than date/time, as the time
    variable. This choice can always be changed in the dialog box that
    appears when a graph or table is first created.
5.  Additional reporting variables were added to the list of parameters
    for which Calibration Files can be used (e.g., groundwater elevation,
    node flooding, etc.).
6.  Percent impervious was added to the list of subcatchment themes that
    can be viewed on the Study Area Map.
7.  An Exceedance Frequency plot panel was added to the output produced
    when a Statistics report is generated.
8.  Users can now add, delete, or re-position items in the list of
    links selected for a Profile Plot in the Profile Plot dialog using a
    new set of buttons added to the dialog. Links are added to the list
    by selecting the link either on the Map or from the Data Browser and
    then clicking the PLUS button on the dialog.
9.  Profile Plots can now be generated before any simulation results are
    available. They include an Update button that allows one to update
    the plot after editing changes have been made to any nodes or links
    contained in the plot.
10. The Edit >> Find menu command (and its associated speed button) was
    split into two sub-commands, one for finding objects on the map (as
    before) and another for finding text within a Status Report.
11. Problems with the wrong data fields sometimes being updated in the
    Group Editor were fixed.
12. The Interface File Combine utility was not working at all (the format
    of the interface file had changed since the original code was written).
    This has been fixed.
13. The centroids of subcatchment polygons on the map are now computed as
    true centroids rather than being merely the average of the vertex
    coordinates.
14. The Maximum Depth property is now preserved when a storage unit is
    converted to a junction (by right-clicking on it and selecting
    Convert To from the popup menu).
15. Map and Profile Plot animation is now turned off whenever the Animator
    Toolbar is closed.
16. More universal support was provided for entering numerical values in
    scientific notation throughout the GUI's various data entry fields.
17. Display problems with zoom-ins on the preview plots of Transects,
    Curves, and Time Series in their respective Editor dialogs were fixed.
18. In the GUI source code:
    a. The custom TOpenTextFileDialog component was renamed to
       TOpenTxtFileDialog so as not to conflict with a Delphi 2005
       component of the same name.
    b. The custom ChartDlg component was modified to add support for a
       chart axis that uses Date/Time labels.
    c. A new unit named Ucalib.pas was added that includes the code for
       reading data from Calibration Files that was previously contained
       in the Fgraph.pas unit.
    d. The Delphi DFM files for the project are now packaged as text
       files, not binaries, in the source code distribution.


------------------------
Build 5.0.005b (6/15/05)
------------------------
Engine Updates:
1. The end node offsets for conduits with the partly filled
   circular cross-section shape were not being increased to
   account for the depth of fill.
2. Flow through a weir was not necessarily zero when the
   water level on the side of the weir at higher head was
   zero.
3. The "crest height" for a Bottom Orifice is now
   interpreted as having the orifice lie in a horizontal
   plane the specified distance above its upstream node's
   invert. This allows riser outlet pipes in storage units
   to be simulated.

GUI Updates:
1. The keyword "WEIR" was not being recognized as a
   legitimate type of Flow Divider node by the GUI's
   input data file parser.
2. The Profile Plot could display hydraulic grade lines
   that dropped below the invert of a conduit.


------------------------
Build 5.0.005a (5/25/05)
------------------------
Engine Updates:
1. An erroneous error message that appears when a node has
   multiple outflow links with one of them being an Outlet
   link has been fixed.

GUI Updates:
1. Corrections were made for the way a Profile Plot is
   drawn when negative elevation values occur.
   

------------------------
Build 5.0.005 (5/20/05)
------------------------
Engine Updates:
1.  An error in computing ponded depths at flooded nodes under 
    Dynamic Wave flow routing was corrected.
2.  The wrong lookup function was being used to find water
    elevations at Time Series type outfall nodes.
3.  An error in interpolating values stored on a routing interface
    file was corrected.
4.  The rainfall file reader was confusing the standard space-
    delimted format with other file formats.
5.  A reporting error for rainfall time series that had no ending
    zero value was corrected.
6.  A problem with neglecting to compute a snowmelt coefficient
    for pervious areas was fixed. 
7.  The keyword for specifying that pollutant buildup be normalized
    to curb length was modified to accept either CURB or CURBLENGTH.
8.  The conversion factor the user supplies for external pollutant
    mass inflows must now convert time series values into mass
    concentration units per second (e.g., 5.25 will convert from lbs/
    day to mg/sec). Flow units are no longer part of the conversion.
9.  The ratio of maximum to design flow listed for each conduit in
    the status report was corrected to account for the number of
    barrels included in the conduit.
10. The minimum elevation change applied to a flat conduit was
    changed to 0.001 feet, as used in SWMM 4.
11. The maximum depth of an irregular cross-section transect is now
    based on the highest elevation of all stations, rather than just
    the higher of the first and last station, and vertical walls
    extending up to the higest elevation are added at the first and
    last station if need be.
12. The nominal width property of an irregular cross-section transect
    is now taken as the top width at full depth rather than the 
    maximum width over all depths.
13. At outfalls where the user-specified water elevation is below
    that of a free outfall, the free outfall elevation is now used.
14. A new property, the maximum allowable flow, was added to the
    Conduit object. The default value is 0.0, which indicates that
    no maxmimum flow is prescribed.
15. Depths at outfall nodes under Steady and Kinematic Wave flow
    routing are now reported as the depth in the connecting
    conduit.
16. The calculation of the head over a non-surcharged, submerged weir
    was corrected to be based on the height of water above the weir
    crest, rather than the difference in heads on either side of the
    weir.
17. The equation used to reduce the length of a weir with side
    contractions was modified to fix a bug in SWMM 4.
18. A new water quality routing algorithm was written that produces
    more robust results under Dynamic Wave flow routing.
19. The Compatibility Mode option under Dynamic Wave flow routing was
    removed. Now there is just a single method used which has been
    designed to be compatible with SWMM 4 yet produce more stable
    results.
20. A new dynamic wave routing option was added that determines which
    criterion decides when conduit flow is limited to normal flow (it
    represents the KSUPER parameter used in SWMM 4).
21. A new flow routing option was added that allows routing calculations
    to be skipped during periods of steady flow which can greatly reduce
    the time required for continuous simulations.

GUI Updates:
1.  An error in reading the flapgate parameter for Weirs in an input
    file was corrected.
2.  Having the Property Editor positioned outside the viewable screen
    area when the user changed the video settings to a lower resolution
    was corrected.
3.  The Convert To option to change nodes from one type of object to
    another was fixed.
4.  The Routing Time Step option is now entered as fractional seconds
    on the Analysis Options form. The older format of hrs:min:sec will
    still be imported correctly from previous SWMM5 input files.
5.  The ability to include a startup input file on the command line
    that launches the GUI was added (add /f filename to the command
    line where filename is the fully qualified name of the input file
    to start with).
6.  Support for output results files greater than 2 gigabytes was added.
7.  The display of the hydraulic grade line in Profile Plots, and its
    intersection with the flow volume in conduits was improved.
8.  The summary results tables contained in the Status Report were
    modified to display more useful information.
9.  The graph options selection dialogs were made to behave more
    consistently.
10. Support was added for copying and printing the graphical views of
    curves, time series, and transects from within their respective
    editors.
11. The SWMM 4 flow calibration data file (Extran1.dat) distributed with
    the example data set Example2.inp was modified to contain the flows
    actually produced by SWMM version 4.4h, rather than the original
    numbers printed in the 1988 Extran manual.

In addition, the SWMM 5.0 Users Manual and Help file were updated to
reflect these changes and new additions.

------------------------
Build 5.0.004 (11/24/04)
------------------------
Engine Updates:
1. Fixes were made to the routines that identify and read data from the
   NCDC-formatted external rain files.
2. The sign of reported velocity in links with adverse slope was
   corrected.
3. Reading of results from previously saved Runoff Interface files
   was corrected.
4. The calculation of a regeneration rate constant from a soil drying
   time value for Curve Number infiltration was corrected, and the
   method was modified to use a constant infiltration capacity during
   each rain event, rather than a continuously declining capacity.
5. A correction was made to the dynamic wave routing routine for 
   SWMM4 and SWMM3 compatibility modes that improves the match with
   Extran results from these earlier versions of SWMM.
6. The check for zero-sloped conduits was modified to include any
   conduit with elevation difference below 0.01 feet.
7. The computation of the ponded depth at flooded nodes under dynamic
   wave flow routing was corrected.
8. A check was added to make sure that the reporting time step is
   not longer than the run duration.
9. Surcharged and high Froude number conduits were previously excluded
   from consideration when computing a variable time step for dynamic
   wave routing; they are now included.
10. The code numbers for the concentration units used for each pollutant
    was added to the binary output file produced from a simulation.

GUI Updates:
1. Negative values can now be entered for temperature values that
   appear on several input forms.
2. The input file reader now checks to make sure that the various time-
   of-day option values are valid.
3. A problem with copying the correct dates for a Tabular Report that
   is being copied to the clipboard or to a file was corrected.
4. The Graph Options dialog form was modified to display the Solid 
   option for Style whenever a Size greater than 1 is selected. (Due
   to a limitation of the Graphics library used in EPA SWMM, only
   solid lines can be drawn at a thickness greater than 1.)
   
 
------------------------
Build 5.0.003 (11/10/04)
------------------------
Engine Updates:
1. Modifications were made to full depth entries of width tables for
   closed rounded cross-section shapes to improve the numerical
   stability for dynamic wave flow routing.
2. Error 405 was added to detect if the size of the binary results
   file would exceed the 2.1 Gbyte system limit.
3. A units problem for RDII inflows under metric flow units was
   corrected.
4. A problem reading the TEMPDIR option when it contained spaces was
   corrected.
5. Support for Canadian DLY02 and DLY04 temperature files was added.
6. Rule-based control of crest height for weirs was corrected
   (previously the control setting adjusted flow rather than the
   relative distance between weir crest and crown).

GUI Updates:
1. A problem with the Group Editing feature for conduits was corrected
   (the editor would update the wrong conduit parameter).
2. Execution time for long term simulations on smaller projects was
   speeded up considerably by only refreshing the progress meter every
   day rather than every minute.
3. The time to draw time series graphs and perform statistical analyses
   on large data sets was considerably shortened.

-----------------------
Build 5.0.002 (11/1/04)
-----------------------
Engine Updates
1. Modifications made to the Picard method used for dynamic wave
   flow routing routine.

------------------------
Build 5.0.001 (10/29/04)
------------------------
First official release of SWMM 5.