Call 'EPANET' Functions to Simulate Pipe Networks


[Up] [Top]

Documentation for package ‘epanet2toolkit’ version 0.5.1

Help Pages

ENclose Close down the EPANET Toolkit system.
ENcloseH close hydraulics engine
ENcloseQ Close water quality analysis and free allocated memory
ENepanet ENepanet
ENgetcontrol ENgetcontrol
ENgetcoord Get coordinates for a node
ENgetcount Get number of network elements.
ENgetflowunits Retrieve a code number indicating the units used to express all flow rates.
ENgetlinkid Retrieve the ID label of a link
ENgetlinkindex Retrieve the index of a link
ENgetlinknodes Retrieve the index of the end nodes of a link
ENgetlinktype Retrieve the type code for a link
ENgetlinkvalue Retrieve parameter value for a link
ENgetnodeid Retrieve the ID label a node.
ENgetnodeindex Retrieve the index of a node
ENgetnodetype Retrieve the node-type code
ENgetnodevalue Retrieve node parameter value.
ENgetoption Retrieve the value of an analysis option.
ENgetpatternid Retrieve the ID label a time pattern
ENgetpatternindex Retrieve the index a time pattern.
ENgetpatternlen Retrieve the number of time periods in a time pattern.
ENgetpatternvalue Retrieve the multiplier factor for a specific time period
ENgetqualinfo Get quality analysis information
ENgetqualtype Retrieve the type of water quality analysis called for.
ENgettimeparam Get the value of one or more specific analysis time parameters.
ENgetversion Retrieve the current version number of the EPANET Toolkit.
ENinitH Initialize hydraulic engine
ENinitQ Initialize water quality analysis
ENnextH determine the next hydraulic step
ENnextQ Advances WQ simulation to start of the next hydraulic time period.
ENopen Open the EPANET Toolkit.
ENopenH Open hydraulics analysis system.
ENopenQ Sets up for Water Quality analysis
ENreport Write simulation report to the report file
ENrunH run hydraulics engine
ENrunQ Computs WQ results at current time .
ENsaveH ENsaveH Saves hydraulic results to binary file
ENsaveinpfile ENaveinpfile Saves current data to "INP" formatted text file.
ENsetcontrol Set the parameters of a simple control statement
ENsetcoord Set coordinates for a node
ENsetlinkvalue Set a parameter value for a link
ENsetnodevalue Set the parameter value for a node.
ENsetoption Set the value of a particular analysis option.
ENsetpattern Set all of the multiplier factors for a specific time pattern.
ENsetpatternvalue set pattern value
ENsetqualtype Set the type of water quality analysis called for.
ENsettimeparam Set the value of a time parameter.
ENsolveH ENsolveH
ENsolveQ Solve network water quality for all time periods
ENstepQ Advances WQ simulation one water quality time step.
epanet2toolkit epanet2toolkit