# EPANET: [REPORT]

[REPORT]

Purpose:

Describes the contents of the output report produced from a simulation.

Formats:

PAGESIZE | value
FILE | filename
STATUS | YES / NO / FULL
SUMMARY | YES / NO
MESSAGES | YES / NO
ENERGY | YES / NO
NODES | NONE / ALL/ node1 node2 ...
LINKS | NONE / ALL/ node1 node2 ...
variable | YES / NO
variable | BELOW / ABOVE / PRECISION value

Definitions:

PAGESIZE sets the number of lines written per page of the output report. The default is 0, meaning that no line limit per page is in effect.

FILE supplies the name of a file to which the output report will be written (ignored by the Windows version of EPANET). The default is to write the report to the project's Report File file.

STATUS determines whether a hydraulic status report should be generated. If YES is selected the report will identify all network components that change status during each time step of the simulation. If FULL is selected, then the status report will also include information from each trial of each hydraulic analysis. This level of detail is only useful for de-bugging networks that become hydraulically unbalanced. The default is NO.

SUMMARY determines whether a summary table of number of network components and key analysis options is generated. The default is YES.

ENERGY determines if a table reporting average energy usage and cost for each pump is provided. The default is NO.

NODES identifies which nodes will be reported on. You can either list individual node ID labels or use the keywords NONE or ALL. Additional NODES lines can be used to continue the list. The default is NONE.

LINKS identifies which links will be reported on. You can either list individual link ID labels or use the keywords NONE or ALL Additional LINKS lines can be used to continue the list. The default is NONE.

The variable reporting option is used to identify which quantities are reported on, how many decimal places are displayed, and what kind of filtering should be used to limit output reporting. Node variables that can be reported on include:

- Elevation
- Demand
- Head
- Pressure
- Quality

Link variables include:

- Length
- Diameter
- Flow
- Velocity
- Headloss
- State (same as status: open, active, closed)
- Setting (roughness for pipes, speed for pumps, pressure/flow setting for valves)
- Reaction (reaction rate)
- F-Factor (friction factor).

The default quantities reported are Demand, Head, Pressure, and Quality for nodes and Flow, Velocity, and Headloss for links. The default precision is two decimal places.

Remarks:

1. All options assume their default values if not explicitly specified in this section.
2. Items offset by slashes (/) indicate allowable choices.
3. The default is to not report on any nodes or links, so a NODES or LINKS option must be supplied if you wish to report results for these items.

Example:

The following example reports on nodes N1, N2, N3, and N17 and all links with velocity above 3.0. The standard node variables (Demand, Head, Pressure, and Quality) are reported on while only Flow, Velocity, and F-Factor (friction factor) are displayed for links.

[REPORT]
NODES N1 N2 N3 N17
LINKS ALL
FLOW YES
VELOCITY PRECISION 4
F-FACTOR PRECISION 4
VELOCITY ABOVE 3.0