parity with OWA root 2.00.12

This commit is contained in:
sam hatchett
2014-09-18 17:27:54 -04:00
parent 78238083d1
commit 523d34bd93
19 changed files with 888 additions and 58 deletions

54
doc/Readme.txt Normal file
View File

@@ -0,0 +1,54 @@
Contents of EPANET2.ZIP
=======================
This archive contains the source code for the EPANET 2
network hydraulic and water quality solver. The solver
provides functions for simulating the extended period
hydraulic and water quality behavior of water distribution
system pipe networks. It is written in ANSI-compatible C
and can be compiled into either a Windows Dynamic Link
Library of functions or into a command-line executable.
The archived code is set up for compilation as a DLL.
To compile it as a command line (or console) application
simply comment out the "#define DLL" macro statement at
the top of EPANET.C and un-comment the "#define CLE" macro.
The DLL version of the solver (epanet2.dll) is used with
the EPANET 2 user interface executable (epanet2w.exe) to
form a complete Windows modeling package. It also serves
as the function library for the EPANET Programmer's Toolkit,
allowing developers to construct their own customized pipe
network analysis applications.
The following C-code files are included in this archive:
EPANET.C -- main module providing supervisory control
INPUT1.C -- controls processing of input data
INPUT2.C -- reads data from input file
INPUT3.C -- parses individual lines of input data
INPFILE.C -- saves modified input data to a text file
RULES.C -- implements rule-based control of piping system
HYDRAUL.C -- computes extended period hydraulic behavior
QUALITY.C -- tracks transport & fate of water quality
OUTPUT.C -- handles transfer of data to and from binary files
REPORT.C -- handles reporting of results to text file
SMATRIX.C -- sparse matrix linear equation solver routines
MEMPOOL.C -- memory pool management routines
HASH.C -- hash table routines
Also included are the following header files:
TOOLKIT.H -- function prototypes of exported DLL functions
FUNCS.H -- prototypes of all other functions
TYPES.H -- declaration of global constants and data structures
VARS.H -- declaration of global variables
HASH.H -- header file for hash table routines
MEMPOOL.H -- header file for memory pool routines
ENUMSTXT.H -- string constants for enumerated types
TEXT.H -- declaration of all other string constants
The comments at the top of each file lists the date when the latest
update was made, and these updates can be located in the code by
searching for comments with the phrase "/*** Updated" or with the
release number (e.g., 2.00.12) in them.
Other useful documentation that can be consulted includes the EPANET
Programmers Toolkit Help file and the EPANET Version 2 Users Manual.

57
doc/changes.txt Normal file
View File

@@ -0,0 +1,57 @@
-----------------------
Build 2.00.12 (2/25/08)
-----------------------
Computational Engine Changes (epanet2.dll and epanet2d.exe):
===============================================================================
CODE MODULES CHANGES
===============================================================================
EPANET.C Temporary files are now written to the users's current working
INPUT1.C directory or to the designated Temporary Directory when running
VARS.H the Windows GUI, thus avoiding file access problems for users
FUNCS.H who do not have administrative privileges on their machine.
-------------------------------------------------------------------------------
EPANET.C The following tank parameters were made available for retrieval
TOOLKIT.H using the Toolkit's ENgetnodevalue function: tank diameter,
EPANET2.H minimum volume, index of the tank's volume curve, the initial,
minimum, and maximum water levels, the fraction of a 2-compart-
ment tank devoted to the mixing zone, and the tank's bulk
reaction rate coefficient. These same parameters (with the
exception of the volume curve) were made modifiable using the
ENsetnodevalue function, as was the choice of mixing model.
See the Toolkit Help file for details.
-------------------------------------------------------------------------------
EPANET.C A new Toolkit function, ENaddpattern, was added that allows
TOOLKIT.C programmers to add a new time pattern to the network in any
EPANET2.H custom code that they write.
-------------------------------------------------------------------------------
HYDRAUL.C A DAMPLIMIT parameter was added to control at what point during
INPUT1.C the hydraulic solution iterations status checks on PRVs and PSVs
INPUT3.C begin and subsequent flow changes are dampened.
REPORT.C
VARS.H
TEXT.H
-------------------------------------------------------------------------------
HYDRAUL.C Demands for tanks (net inflows/outflows) were not always being
set to zero when the tank was full or empty which was causing
problems in the water quality routing solutions.
-------------------------------------------------------------------------------
QUALITY.C The water quality functions for all of the tank mixing models
were modified so as to produce more robust results for cases
where there is a significant amount of volume exchange over a
water quality time step.
-------------------------------------------------------------------------------
EPANET.C A problem with the system not recognizing that water quality
QUALITY.C reactions could begin after some initial period of time when
VARS.H the Toolkit was used to modify reaction rate coefficients was
fixed.
-------------------------------------------------------------------------------
INPFILE.C A problem with extraneous lines being written to the [REPORT]
section of an EPANET input file created with the ENsaveinpfile
function was fixed. Also the number of decimal places for some
items written to the saved file, such as nodal demands, was
increased.
-------------------------------------------------------------------------------
TYPES.H The code version was changed to 20012 and INT4 was explicitly
defined as an "int" data type.
===============================================================================