User-supplied options for analyzing a pipe network. More...

#include <options.h>

Public Types
enum	UnitSystem { US, SI }

enum	FlowUnits { CFS, GPM, MGD, IMGD, AFD, LPS, LPM, MLD, CMH, CMD }

enum	PressureUnits { PSI, METERS, KPA }

enum	FileMode { SCRATCH, USE, SAVE }

enum	IfUnbalanced { STOP, CONTINUE }

enum	QualType { NOQUAL, AGE, TRACE, CHEM }

enum	QualUnits { NOUNITS, HRS, PCNT, MGL, UGL }

enum	ReportedItems { NONE, ALL, SOME }

enum	StringOption { HYD_FILE_NAME, OUT_FILE_NAME, RPT_FILE_NAME, MAP_FILE_NAME, HEADLOSS_MODEL, DEMAND_MODEL, LEAKAGE_MODEL, HYD_SOLVER, STEP_SIZING, MATRIX_SOLVER, DEMAND_PATTERN_NAME, QUAL_MODEL, QUAL_NAME, QUAL_UNITS_NAME, TRACE_NODE_NAME, MAX_STRING_OPTIONS }

enum	IndexOption { UNIT_SYSTEM, FLOW_UNITS, PRESSURE_UNITS, MAX_TRIALS, IF_UNBALANCED, HYD_FILE_MODE, DEMAND_PATTERN, ENERGY_PRICE_PATTERN, QUAL_TYPE, QUAL_UNITS, TRACE_NODE, REPORT_SUMMARY, REPORT_ENERGY, REPORT_STATUS, REPORT_TRIALS, REPORT_NODES, REPORT_LINKS, MAX_INDEX_OPTIONS }

enum	ValueOption { SPEC_GRAVITY, KIN_VISCOSITY, DEMAND_MULTIPLIER, MINIMUM_PRESSURE, SERVICE_PRESSURE, PRESSURE_EXPONENT, EMITTER_EXPONENT, LEAKAGE_COEFF1, LEAKAGE_COEFF2, RELATIVE_ACCURACY, HYD_TOLERANCE, TIME_WEIGHT, MOLEC_DIFFUSIVITY, QUAL_TOLERANCE, BULK_ORDER, WALL_ORDER, TANK_ORDER, BULK_COEFF, WALL_COEFF, LIMITING_CONCEN, ROUGHNESS_FACTOR, ENERGY_PRICE, PEAKING_CHARGE, PUMP_EFFICIENCY, MAX_VALUE_OPTIONS }

enum	TimeOption { START_TIME, HYD_STEP, QUAL_STEP, PATTERN_STEP, PATTERN_START, REPORT_STEP, REPORT_START, RULE_STEP, TOTAL_DURATION, REPORT_STATISTIC, MAX_TIME_OPTIONS }

Public Member Functions
int	flowUnits ()

int	pressureUnits ()

std::string	stringOption (StringOption option)

int	indexOption (IndexOption option)

double	valueOption (ValueOption option)

int	timeOption (TimeOption option)

void	setDefaults ()

void	adjustOptions ()

int	setOption (StringOption option, const std::string &value)

int	setOption (IndexOption option, const std::string &value, Network *nw)

void	setOption (IndexOption option, int value)

void	setOption (ValueOption option, double value)

void	setOption (TimeOption option, int value)

void	setReportFieldOption (int fieldType, int fieldIndex, int enabled, int precision, double lowerLimit, double upperLimit)

std::string	hydOptionsToStr ()

std::string	qualOptionsToStr ()

std::string	demandOptionsToStr ()

std::string	timeOptionsToStr ()

std::string	reactOptionsToStr ()

std::string	energyOptionsToStr (Network *network)

std::string	reportOptionsToStr ()

Detailed Description

User-supplied options for analyzing a pipe network.

Member Enumeration Documentation

enum Options::IndexOption

Enumerator
UNIT_SYSTEM	Choice of units system.
FLOW_UNITS	Choice of flow rate units.
PRESSURE_UNITS	Choice of pressure units.
MAX_TRIALS	Maximum hydraulic trials.
IF_UNBALANCED	Stop or continue if network is unbalanced.
HYD_FILE_MODE	Binary hydraulics file mode.
DEMAND_PATTERN	Global demand pattern index.
ENERGY_PRICE_PATTERN	Global energy price pattern index.
QUAL_TYPE	Type of water quality analysis.
QUAL_UNITS	Units of the quality constituent.
TRACE_NODE	Node index for source tracing.
REPORT_SUMMARY	report input/output summary
REPORT_ENERGY	report energy usage
REPORT_STATUS	report system status
REPORT_TRIALS	report result of each trial
REPORT_NODES	report node results
REPORT_LINKS	report link results

enum Options::StringOption

Enumerator
HYD_FILE_NAME	Name of binary file containing hydraulic results.
OUT_FILE_NAME	Name of binary file containing simulation results.
RPT_FILE_NAME	Name of text file containing output report.
MAP_FILE_NAME	Name of text file containing nodal coordinates.
HEADLOSS_MODEL	Name of head loss model used.
DEMAND_MODEL	Name of nodal demand model used.
LEAKAGE_MODEL	Name of pipe leakage model used.
HYD_SOLVER	Name of hydraulic solver method.
STEP_SIZING	Name of Newton step size method.
MATRIX_SOLVER	Name of sparse matrix eqn. solver.
DEMAND_PATTERN_NAME	Name of global demand pattern.
QUAL_MODEL	Name of water quality model used.
QUAL_NAME	Name of water quality constituent.
QUAL_UNITS_NAME	Name of water quality units.
TRACE_NODE_NAME	Name of node for source tracing.

enum Options::TimeOption

Enumerator
START_TIME	Starting time of day.
HYD_STEP	Hydraulic simulation time step.
QUAL_STEP	Water quality simulation time step.
PATTERN_STEP	Global time interval for time patterns.
PATTERN_START	Time of day at which all time patterns start.
REPORT_STEP	Reporting time step.
REPORT_START	Simulation time at which reporting begins.
RULE_STEP	Time step used to evaluate control rules.
TOTAL_DURATION	Total simulation duration.
REPORT_STATISTIC	How results are reported (min, max, range)

enum Options::ValueOption

Enumerator
SPEC_GRAVITY	Specific Gravity.
KIN_VISCOSITY	Kinematic viscosity (ft2/sec)
DEMAND_MULTIPLIER	Global base demand multiplier.
MINIMUM_PRESSURE	Global minimum pressure to supply demand (ft)
SERVICE_PRESSURE	Global pressure to supply full demand (ft)
PRESSURE_EXPONENT	Global exponent for power function demands.
EMITTER_EXPONENT	Global exponent in emitter discharge formula.
RELATIVE_ACCURACY	sum of all \|flow changes\| / sum of all \|flows\|
HYD_TOLERANCE	Largest flow change for convergence.
TIME_WEIGHT	Time weighting for variable head tanks.
MOLEC_DIFFUSIVITY	Chemical's molecular diffusivity (ft2/sec)
QUAL_TOLERANCE	Tolerance for water quality comparisons.
BULK_ORDER	Order of all bulk flow reactions in pipes.
WALL_ORDER	Order of all pipe wall reactions.
TANK_ORDER	Order of all bulk water reactions in tanks.
BULK_COEFF	Global rate coefficient for bulk reactions.
WALL_COEFF	Global rate coefficient for wall reactions.
LIMITING_CONCEN	Maximum concentration for growth reactions.
ROUGHNESS_FACTOR	Relates wall reaction coeff. to pipe roughness.
ENERGY_PRICE	Global energy price (per kwh)
PEAKING_CHARGE	Fixed energy charge per peak kw.
PUMP_EFFICIENCY	Global pump efficiency (fraction)

The documentation for this class was generated from the following files:

/Users/sam/Dropbox (CitiLogics)/Code/epanet-dev/src/Core/options.h
/Users/sam/Dropbox (CitiLogics)/Code/epanet-dev/src/Core/options.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation