diff --git a/doc/main.dox b/doc/main.dox index 347ae24..0b30bdf 100755 --- a/doc/main.dox +++ b/doc/main.dox @@ -1,4 +1,4 @@ -/** +/** @mainpage Overview EPANET is a program that performs extended period simulation of hydraulic and water quality behavior within water distribution system pipe networks. A network can consist of pipes, nodes (pipe junctions), pumps, valves and storage tanks or reservoirs. EPANET tracks the flow of water in each pipe, the pressure at each node, the height of water in each tank, and the concentration of a chemical species throughout the network during a multi-time period simulation. In addition to chemical species, water age and source tracing can also be simulated. @@ -27,7 +27,7 @@ Before using the OWA-EPANET Toolkit one should be familiar with the way that EPA More detailed information can be obtained from reading the EPANET 2 Users Manual. -__Note:__ OWA (Open Water Analytics) exists on GitHub as an open community for the exchange of information and ideas related to computing in the water & wastewater industries. It's activities and code projects are neither affiliated with nor endorsed by the USEPA. +__Note:__ OWA (Open Water Analytics) exists on GitHub as an open community for the exchange of information and ideas related to computing in the water & wastewater industries. Its activities and code projects are neither affiliated with nor endorsed by the USEPA. */ /** @@ -83,13 +83,13 @@ The EPANET Toolkit contains separate code modules for network building, hydrauli -- The network builder receives a description of the network being simulated either from an external input file (.inp) or from a series of function calls that create network objects and assign their properties via code. These data are stored in a Project data structure. +- The network builder receives a description of the network being simulated either from an external input file (.inp) or from a series of function calls that create network objects and assign their properties via code. These data are stored in a Project data structure. -- The hydraulics solver carries out an extended period hydraulic simulation. The results obtained at every time step can be written to an external, unformatted (binary) hydraulics file (.hyd). Some of these time steps might represent intermediate points in time where system conditions change because of tanks becoming full or empty or pumps turning on or off due to level controls or timed operation. +- The hydraulics solver carries out an extended period hydraulic simulation. The results obtained at every time step can be written to an external, unformatted (binary) hydraulics file (.hyd). Some of these time steps might represent intermediate points in time where system conditions change because of tanks becoming full or empty or pumps turning on or off due to level controls or timed operation. -- If a water quality simulation is requested, the water quality solver accesses the flow data from the hydraulics file as it computes substance transport and reaction throughout the network over each hydraulic time step. During this process it can write both the formerly computed hydraulic results as well as its water quality results for each preset reporting interval to an unformatted (binary) output file (.out). If no water quality analysis was called for, then the hydraulic results stored in the .hyd file can simply be written out to the binary output file at uniform reporting intervals. +- If a water quality simulation is requested, the water quality solver accesses the flow data from the hydraulics file as it computes substance transport and reaction throughout the network over each hydraulic time step. During this process it can write both the formerly computed hydraulic results as well as its water quality results for each preset reporting interval to an unformatted (binary) output file (.out). If no water quality analysis was called for, then the hydraulic results stored in the .hyd file can simply be written out to the binary output file at uniform reporting intervals. -- If requested, a report writer reads back the computed simulation results from the binary output file (.out) for each reporting period and writes out selected values to a formatted report file (.rpt). Any error or warning messages generated during the run are also written to this file. +- If requested, a report writer reads back the computed simulation results from the binary output file (.out) for each reporting period and writes out selected values to a formatted report file (.rpt). Any error or warning messages generated during the run are also written to this file. Toolkit functions exist to carry out all of these steps under the programmer's control, including the ability to read and modify the contents of the Project data structure. */ diff --git a/include/epanet2_2.h b/include/epanet2_2.h index d5c823a..cbfece3 100644 --- a/include/epanet2_2.h +++ b/include/epanet2_2.h @@ -645,15 +645,15 @@ typedef struct Project *EN_Project; @param index the element's current index (starting from 1). @param[out] value the order in which the element's results were written to file. @return an error code. - + If the element does not appear in the file then its result index is 0. - + This function can be used to correctly retrieve results from an EPANET binary output file after the order of nodes or links in a network's database has been changed due to editing - operations. - */ + operations. + */ int DLLEXPORT EN_getresultindex(EN_Project ph, int type, int index, int *value); - + /******************************************************************** Analysis Options Functions @@ -771,7 +771,7 @@ typedef struct Project *EN_Project; @param[out] index the index of the newly added node @return an error code. - When a new node is created all of it's properties (see @ref EN_NodeProperty) are set to 0. + When a new node is created all of its properties (see @ref EN_NodeProperty) are set to 0. */ int DLLEXPORT EN_addnode(EN_Project ph, char *id, int nodeType, int *index); @@ -1236,7 +1236,7 @@ typedef struct Project *EN_Project; @return an error code. */ int DLLEXPORT EN_getvertexcount(EN_Project ph, int index, int *count); - + /** @brief Retrieves the coordinate's of a vertex point assigned to a link. @param ph an EPANET project handle. @@ -1247,7 +1247,7 @@ typedef struct Project *EN_Project; @return an error code. */ int DLLEXPORT EN_getvertex(EN_Project ph, int index, int vertex, double *x, double *y); - + /** @brief Assigns a set of internal vertex points to a link. @param ph an EPANET project handle. @@ -1256,8 +1256,8 @@ typedef struct Project *EN_Project; @param y an array of Y-coordinates for the vertex points. @param count the number of vertex points being assigned. @return an error code. - - Replaces any existing vertices previously assigned to the link. + + Replaces any existing vertices previously assigned to the link. */ int DLLEXPORT EN_setvertices(EN_Project ph, int index, double *x, double *y, int count); diff --git a/src/rules.c b/src/rules.c index 256973b..68b8de6 100644 --- a/src/rules.c +++ b/src/rules.c @@ -171,7 +171,7 @@ void freerules(Project *pr) //-------------------------------------------------------------- { int i; - + // Already freed if (pr->network.Rule == NULL) return; @@ -1087,7 +1087,7 @@ int onactionlist(Project *pr, int i, Saction *a) // Link appears in list if (link == a1->link) { - // Replace it's action with 'a' if rule i has higher priority + // Replace its action with 'a' if rule i has higher priority if (net->Rule[i].priority > net->Rule[i1].priority) { actionItem->action = a; @@ -1266,7 +1266,7 @@ void writepremise(Spremise *p, FILE *f, Network *net) strcpy(s_id, ""); } - // If premise has no value field, use it's status field as a value + // If premise has no value field, use its status field as a value if (p->value == MISSING) strcpy(s_value, Value[p->status]); // Otherwise get text of premise's value field