Jump to content

Measurement:Canonical Units: Difference between revisions

From AOWIS
mNo edit summary
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
* Part of: [[Measurement:Main_Page]]
* Part of: [[Measurement:Main_Page]]
* Related to: [[Measurement:Units]]
* Related to: [[Measurement:Units]]


AOWIS defines a canonical set of unit identifiers used in all system interfaces, storage formats, APIs, and inter-system data exchanges.
This page is the normative registry of canonical measurement quantities and units used by AOWIS.
 
The representation and conversion rules governing these quantities are defined in [[Measurement:Units]].
 
UCUM<ref name="UCUM">Unified Code for Units of Measure (UCUM) https://ucum.org</ref> is used for machine-readable physical unit identifiers.


All unit identifiers MUST be lower-case ASCII-only strings and MUST NOT contain Unicode characters, superscripts, or typographic symbols.
== Identifier and Field-Naming Rules ==


Units are machine-readable tokens and are not intended to represent typographic or human-rendered SI notation.
The canonical unit assigned to each measurement quantity in this registry is authoritative.


== General Rules ==
When a unit identifier is explicitly represented, it MUST use the canonical UCUM identifier defined here.


* All unit identifiers MUST be lower-case ASCII-only.
The AOWIS identifier suffix is an ASCII-safe naming convention used for fixed-schema field names, property names, database columns, and similar technical identifiers.
* Unit identifiers MUST be unambiguous and consistent across all AOWIS-compliant systems.
* Each physical quantity MUST map to exactly one canonical unit.
* Units MUST NOT be context-dependent or system-dependent.
* Units MUST be stable identifiers suitable for JSON, databases, and file formats.


== Requirements ==
The suffix convention is:
 
* division is represented by <code>_per_</code>;
* multiplication is represented by <code>_</code>;
* unit symbols are normalized to lower case where required for identifier naming;
* quantity-specific semantic qualifiers MAY be included where a literal unit-only suffix would be ambiguous;
* dimensionless fields with canonical UCUM unit <code>1</code> normally omit a unit suffix.
 
For example:


<pre>
<pre>
REQ-MEAS-UNI-001: Unit identifiers MUST be ASCII-only strings.
m3/h        -> m3_per_h
m/s        -> m_per_s
kW.h/m3    -> kw_h_per_m3
mm2/(100.m) -> mm2_per_100m
</pre>


REQ-MEAS-UNI-002: Unit identifiers MUST NOT contain Unicode characters, superscripts, or typographic symbols.
The AOWIS identifier suffix is not itself a UCUM unit identifier.


REQ-MEAS-UNI-003: Each physical quantity in AOWIS MUST map to exactly one canonical unit identifier.
For generic or dynamically typed measurement values, the resolved measurement quantity determines the canonical unit through this registry.


REQ-MEAS-UNI-004: Units MUST be used consistently across all AOWIS system interfaces and storage formats.
== Length and Distance Quantities ==


REQ-MEAS-UNI-005: Units MUST NOT be context-dependent or implementation-defined.
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>length</code> || Linear spatial extent along an object or path || metre (m) || <code>m</code> || <code>m</code> || Pipe and link length
|-
| <code>elevation</code> || Vertical height relative to an engineering or hydraulic datum || metre (m) || <code>m</code> || <code>m</code> || Junction, tank, reservoir, and terrain elevation
|-
| <code>altitude</code> || Vertical position reported by a geographic positioning source || metre (m) || <code>m</code> || <code>m</code> || Geographic altitude; not necessarily suitable as hydraulic elevation
|-
| <code>distance</code> || Spatial separation between positions || metre (m) || <code>m</code> || <code>m</code> || Derived geometric distance
|-
| <code>vertical_offset</code> || Vertical difference between referenced elevations or heads || metre (m) || <code>m</code> || <code>m</code> || Elevation, tank-bottom, and reservoir-head offsets
|-
| <code>link_diameter</code> || Internal or nominal diameter of a pipe or valve || millimetre (mm) || <code>mm</code> || <code>mm</code> || EPANET pipe and valve diameter
|-
| <code>tank_diameter</code> || Internal diameter of a cylindrical storage tank || metre (m) || <code>m</code> || <code>m</code> || EPANET tank diameter
|-
| <code>darcy_weisbach_roughness_height</code> || Absolute pipe-wall roughness height used by the Darcy-Weisbach formulation || millimetre (mm) || <code>mm</code> || <code>mm</code> || EPANET Darcy-Weisbach pipe roughness
|}


REQ-MEAS-UNI-006: Semantic meaning MUST be derived from the quantity field, not from the unit identifier.
== Geographic Coordinate Quantities ==


REQ-MEAS-UNI-007: The "Quantity / Name" field MUST be the canonical machine-readable identifier for a physical quantity and MUST be used as the key in all AOWIS data formats, APIs, databases, and serialized representations.
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>latitude</code> || Angular position north or south of the equator || degree (°) || <code>deg</code> || <code>deg</code> || WGS 84 latitude
|-
| <code>longitude</code> || Angular position east or west of the prime meridian || degree (°) || <code>deg</code> || <code>deg</code> || WGS 84 longitude
|-
| <code>projected_easting</code> || Eastward coordinate within a projected coordinate reference system || metre (m) || <code>m</code> || <code>m</code> || Projected-coordinate easting
|-
| <code>projected_northing</code> || Northward coordinate within a projected coordinate reference system || metre (m) || <code>m</code> || <code>m</code> || Projected-coordinate northing
|-
| <code>local_x</code> || X coordinate within an explicitly defined local engineering coordinate system || metre (m) || <code>m</code> || <code>m</code> || Local coordinates when the coordinate system is defined in metres
|-
| <code>local_y</code> || Y coordinate within an explicitly defined local engineering coordinate system || metre (m) || <code>m</code> || <code>m</code> || Local coordinates when the coordinate system is defined in metres
|}
 
== Area and Volume Quantities ==


REQ-MEAS-UNI-008: The "Quantity / Name" field MUST be treated as an immutable identifier and MUST NOT be modified, localized, abbreviated, or reinterpreted across implementations.
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>area</code> || Two-dimensional spatial extent || square metre (m²) || <code>m2</code> || <code>m2</code> || Tank cross-sectional area and other geometric areas
|-
| <code>volume</code> || Three-dimensional spatial extent or storage capacity || cubic metre (m³) || <code>m3</code> || <code>m3</code> || Tank volume
|}


REQ-MEAS-UNI-009: Physical quantity semantics MUST be derived exclusively from the "Quantity / Name" field and MUST NOT be inferred from unit identifiers.
== Flow and Transport Quantities ==
</pre>


== Canonical Unit Identifiers ==
{| class="wikitable"
! Measurement Quantity Identifier
!! Definition
!! Canonical Unit
!! UCUM Identifier
!! AOWIS Identifier Suffix
!! AOWIS Model / EPANET Mapping
|-
| <code>volumetric_flow_rate</code>
|| Volume transported per unit time
|| cubic metre per hour (m³/h)
|| <code>m3/h</code>
|| <code>m3_per_h</code>
|| Demand, link flow, leakage flow, emitter flow, and pump-curve flow
|-
| <code>velocity</code>
|| Rate of linear movement
|| metre per second (m/s)
|| <code>m/s</code>
|| <code>m_per_s</code>
|| Link flow velocity
|-
| <code>molecular_diffusivity</code>
|| Molecular diffusion coefficient of a chemical species
|| square metre per second (m²/s)
|| <code>m2/s</code>
|| <code>m2_per_s</code>
|| Physical molecular diffusivity used by the AOWIS multi-species model; backend-relative representations such as EPANET-MSX relative diffusivity are converted at the adapter boundary
|-
| <code>longitudinal_dispersion_coefficient</code>
|| Longitudinal dispersion coefficient describing axial spreading of a transported species
|| square metre per second (m²/s)
|| <code>m2/s</code>
|| <code>m2_per_s</code>
|| Multi-species longitudinal dispersion
|}


=== Length and Spatial Quantities ===
== Hydraulic Head, Pressure, and Stress Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>hydraulic_head</code> || Total mechanical energy per unit weight of fluid expressed as an equivalent fluid-column height || metre (m) || <code>m</code> || <code>m</code> || Junction, reservoir, and tank hydraulic head
|-
|-
| length || Linear spatial extent || m || m || Pipe/link length (SI-normalized EPANET model)
| <code>pressure_head</code> || Fluid pressure expressed as an equivalent fluid-column height || metre (m) || <code>m</code> || <code>m</code> || EPANET node pressure, pressure-driven demand thresholds, and pressure-control valve settings
|-
|-
| elevation || Vertical height relative to datum || m || m || Node elevation (SI-normalized EPANET model)
| <code>water_level</code> || Height of a water surface relative to a defined local reference level || metre (m) || <code>m</code> || <code>m</code> || Initial, minimum, maximum, and simulated tank levels
|-
|-
| distance || Spatial separation between points || m || m || Derived geometric quantity
| <code>head_gain</code> || Increase in hydraulic head across an energy-adding component || metre (m) || <code>m</code> || <code>m</code> || Pump curves and pump simulation results
|-
|-
| position_offset || Relative spatial offset magnitude || m || m || Not explicitly represented in EPANET
| <code>head_loss</code> || Reduction in hydraulic head across a hydraulic component || metre (m) || <code>m</code> || <code>m</code> || Pipes, valves, and other energy-dissipating components
|-
| <code>head_loss_gradient</code> || Hydraulic head loss per unit pipe length || metre per kilometre (m/km) || <code>m/km</code> || <code>m_per_km</code> || EPANET pipe head-loss reporting
|-
| <code>pressure</code> || Normal force per unit area within a fluid system || kilopascal (kPa) || <code>kPa</code> || <code>kpa</code> || Physical pressure measurements, sensors, SCADA data, and external exchange
|-
| <code>stress</code> || Internal force per unit area within a material || megapascal (MPa) || <code>MPa</code> || <code>mpa</code> || Structural and material analysis
|}
|}


=== Area and Volume ===
== Time Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier
!! Definition
!! Canonical Unit
!! UCUM Identifier
!! AOWIS Identifier Suffix
!! AOWIS Model / EPANET Mapping
|-
| <code>elapsed_time</code>
|| Time elapsed from a defined simulation or process origin
|| second (s)
|| <code>s</code>
|| <code>s</code>
|| Simulation elapsed time and time-based control triggers
|-
| <code>duration</code>
|| Length of a time interval
|| second (s)
|| <code>s</code>
|| <code>s</code>
|| Simulation duration and time steps
|-
| <code>time_of_day</code>
|| Time elapsed since the start of the current day
|| second (s)
|| <code>s</code>
|| <code>s</code>
|| Simulation start time and clock-time controls
|}
 
The canonical unit second does not imply integral-second resolution. Sub-second durations and time steps are represented as fractional seconds. For example, a time step of one millisecond is represented canonically as <code>0.001 s</code>.
 
== Hydraulic Coefficients and Other Dimensionless Quantities ==
 
The canonical UCUM unit identifier for all quantities in this section is <code>1</code>. The AOWIS unit suffix is omitted.
 
Semantic terms such as <code>ratio</code>, <code>factor</code>, <code>coefficient</code>, <code>multiplier</code>, <code>number</code>, and <code>exponent</code> describe the quantity and are not unit suffixes.
 
{| class="wikitable"
! Measurement Quantity Identifier
!! Definition
!! UCUM Identifier
!! AOWIS Identifier Suffix
!! AOWIS Model / EPANET Mapping
|-
| <code>hazen_williams_roughness_coefficient</code>
|| Hazen-Williams pipe roughness coefficient
|| <code>1</code>
|| none
|| EPANET Hazen-Williams roughness
|-
| <code>chezy_manning_roughness_coefficient</code>
|| Chezy-Manning pipe roughness coefficient
|| <code>1</code>
|| none
|| EPANET Chezy-Manning roughness
|-
| <code>minor_loss_coefficient</code>
|| Coefficient representing local hydraulic losses
|| <code>1</code>
|| none
|| Pipe and valve minor loss; TCV setting
|-
| <code>darcy_weisbach_friction_factor</code>
|| Darcy-Weisbach friction factor
|| <code>1</code>
|| none
|| Pipe simulation result
|-
| <code>pump_speed_ratio</code>
|| Pump rotational speed relative to nominal or reference speed
|| <code>1</code>
|| none
|| Pump setting, result, pattern, control, and rule values
|-
| <code>pattern_multiplier</code>
|| Factor applied by a hydraulic or energy pattern
|| <code>1</code>
|| none
|| EPANET pattern factor
|-
| <code>demand_multiplier</code>
|| Global factor applied to base demands
|| <code>1</code>
|| none
|| EPANET demand multiplier
|-
| <code>pressure_exponent</code>
|| Exponent used by the pressure-driven demand relation
|| <code>1</code>
|| none
|| EPANET pressure exponent
|-
| <code>emitter_exponent</code>
|| Exponent used by the emitter pressure-flow relation
|| <code>1</code>
|| none
|| EPANET emitter exponent
|-
| <code>reaction_order</code>
|| Order of a bulk, wall, or tank reaction equation
|| <code>1</code>
|| none
|| EPANET reaction order
|-
| <code>specific_gravity</code>
|| Fluid density relative to a defined reference density
|| <code>1</code>
|| none
|| EPANET specific gravity
|-
| <code>relative_viscosity</code>
|| Kinematic viscosity relative to the solver reference
|| <code>1</code>
|| none
|| EPANET relative viscosity
|-
| <code>relative_diffusivity</code>
|| Molecular diffusivity relative to a defined solver reference diffusivity
|| <code>1</code>
|| none
|| EPANET and EPANET-MSX relative diffusivity representations
|-
| <code>peclet_number</code>
|| Ratio characterizing advective transport relative to diffusive or dispersive transport
|| <code>1</code>
|| none
|| Multi-species dispersion; includes solver thresholds based on the Peclet number
|-
|-
| area || Two-dimensional spatial extent || m² || m2 || Not directly used
| <code>mixing_fraction</code>
|| Fraction of tank volume assigned to the applicable mixing zone
|| <code>1</code>
|| none
|| EPANET tank mixing fraction
|-
|-
| volume || Storage volume || m³ || m3 || Tank volume (SI-normalized EPANET model)
| <code>hydraulic_accuracy</code>
|| Relative hydraulic convergence criterion
|| <code>1</code>
|| none
|| EPANET hydraulic accuracy
|-
| <code>hydraulic_damping_limit</code>
|| Relative threshold controlling solver damping or status checks
|| <code>1</code>
|| none
|| EPANET damping limit
|-
| <code>relative_error</code>
|| Relative numerical error
|| <code>1</code>
|| none
|| Hydraulic and water-quality numerical error, tolerance, and simulation statistics
|-
| <code>flow_balance_ratio</code>
|| Ratio of total outflow to total inflow
|| <code>1</code>
|| none
|| EPANET flow-balance reporting
|-
| <code>quality_mass_balance_ratio</code>
|| Water-quality mass-conservation ratio
|| <code>1</code>
|| none
|| EPANET and multi-species quality mass-balance reporting
|}
|}


=== Flow and Transport ===
== Percentage Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| volumetric_flow_rate || Volume per unit time || m³/s || m3_s || Link flow (SI-normalized EPANET model)
| <code>efficiency</code> || Ratio of useful output to total input expressed as a percentage || percent (%) || <code>%</code> || <code>percent</code> || Pump efficiency and efficiency curves
|-
|-
| mass_flow_rate || Mass per unit time || kg/s || kg_s || Not directly represented (derived)
| <code>relative_flow</code> || Flow relative to a defined reference flow || percent (%) || <code>%</code> || <code>percent</code> || Valve characteristic curves
|-
| <code>valve_position</code> || Valve opening position relative to its operating range || percent (%) || <code>%</code> || <code>percent</code> || Position-control valves
|-
| <code>source_trace_percentage</code> || Proportion of water originating from a specified source node || percent (%) || <code>%</code> || <code>percent</code> || EPANET source-trace analysis
|-
| <code>operating_time_percentage</code> || Fraction of a reporting period during which equipment operates || percent (%) || <code>%</code> || <code>percent</code> || Pump energy reporting
|-
| <code>demand_reduction_percentage</code> || Reduction in delivered demand relative to requested demand || percent (%) || <code>%</code> || <code>percent</code> || Hydraulic statistics
|-
| <code>leakage_loss_percentage</code> || Leakage loss relative to total system inflow || percent (%) || <code>%</code> || <code>percent</code> || Leakage statistics
|}
|}


=== Pressure and Stress ===
== Reaction and Leakage Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| pressure || Force per unit area in fluid system || Pa || pa || Node pressure (SI-normalized EPANET model)
| <code>first_order_bulk_reaction_coefficient</code> || First-order reaction-rate coefficient within the bulk fluid || per day (d⁻¹) || <code>/d</code> || <code>per_d</code> || Global, pipe, and tank first-order bulk reactions
|-
|-
| stress || Internal material stress || Pa || pa || Not represented
| <code>first_order_wall_reaction_coefficient</code> || First-order reaction-rate coefficient at a pipe wall || metre per day (m/d) || <code>m/d</code> || <code>m_per_d</code> || Global and pipe first-order wall reactions
|-
| <code>leak_area_per_100m_pipe_length</code> || Effective leak area assigned per 100 metres of pipe length || square millimetre per 100 metres (mm²/100 m) || <code>mm2/(100.m)</code> || <code>mm2_per_100m</code> || EPANET 2.3 FAVAD leak area; EPANET uses 100 project length units and the adapter converts when required<ref name="EPANET23">OWA-EPANET 2.3 release notes https://github.com/OpenWaterAnalytics/EPANET/blob/v2.3/ReleaseNotes2_3.md</ref>
|-
| <code>leak_area_expansion_per_pressure_head</code> || Increase in effective leak area per unit pressure head || square millimetre per metre of pressure head (mm²/m) || <code>mm2/m</code> || <code>mm2_per_m_head</code> || EPANET 2.3 FAVAD leak expansion
|}
|}


=== Time ===
== Water Quality Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier
!! Definition
!! Canonical Unit
!! UCUM Identifier
!! AOWIS Identifier Suffix
!! AOWIS Model / EPANET Mapping
|-
|-
| time || Simulation or observation time || s || s || Simulation time (EPANET internal time normalized to seconds)
| <code>chemical_mass_concentration</code>
|| Mass concentration of a chemical substance in water
|| milligram per litre (mg/L)
|| <code>mg/L</code>
|| <code>mg_per_l</code>
|| EPANET chemical quality; multi-species bulk species using a mass basis
|-
|-
| duration || Time interval length || s || s || Simulation duration / reporting intervals
| <code>chemical_amount_concentration</code>
|| Amount-of-substance concentration of a chemical substance in water
|| millimole per litre (mmol/L)
|| <code>mmol/L</code>
|| <code>mmol_per_l</code>
|| Multi-species bulk species using an amount-of-substance basis
|-
| <code>chemical_surface_mass_density</code>
|| Mass of a chemical species associated with a surface per unit surface area
|| milligram per square metre (mg/m²)
|| <code>mg/m2</code>
|| <code>mg_per_m2</code>
|| Multi-species wall species using a mass basis
|-
| <code>chemical_surface_amount_density</code>
|| Amount of a chemical species associated with a surface per unit surface area
|| millimole per square metre (mmol/m²)
|| <code>mmol/m2</code>
|| <code>mmol_per_m2</code>
|| Multi-species wall species using an amount-of-substance basis
|-
| <code>chemical_mass_flow_rate</code>
|| Chemical mass introduced into or transported through the system per unit time
|| milligram per minute (mg/min)
|| <code>mg/min</code>
|| <code>mg_per_min</code>
|| EPANET mass-booster source strength; multi-species MASS source using a mass basis
|-
| <code>chemical_amount_flow_rate</code>
|| Amount of chemical substance introduced into or transported through the system per unit time
|| millimole per minute (mmol/min)
|| <code>mmol/min</code>
|| <code>mmol_per_min</code>
|| Multi-species MASS source using an amount-of-substance basis
|-
| <code>water_age</code>
|| Time elapsed since water entered the modelled distribution system
|| hour (h)
|| <code>h</code>
|| <code>h</code>
|| EPANET water-age analysis
|}
|}


=== Electrical Quantities ===
== Power, Energy, and Electrical Quantities ==


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! UCUM Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>power</code> || Rate of energy transfer || kilowatt (kW) || <code>kW</code> || <code>kw</code> || Pump power and electrical power
|-
|-
| current || Rate of electric charge flow || A || a
| <code>energy</code> || Work performed or energy transferred || kilowatt-hour (kWh) || <code>kW.h</code> || <code>kw_h</code> || Pump energy consumption
|-
|-
| voltage || Electric potential difference || V || v
| <code>energy_intensity</code> || Energy consumed per unit volume || kilowatt-hour per cubic metre (kWh/m³) || <code>kW.h/m3</code> || <code>kw_h_per_m3</code> || Pump energy-use reporting
|-
|-
| resistance || Opposition to electric current flow || Ω || ohm
| <code>electric_current</code> || Rate of electric charge flow || ampere (A) || <code>A</code> || <code>a</code> || Electrical model
|-
|-
| power || Rate of energy transfer || W || w
| <code>voltage</code> || Electric potential difference || volt (V) || <code>V</code> || <code>v</code> || Electrical model
|-
|-
| energy || Work or transferred electrical energy || J || j
| <code>electrical_resistance</code> || Opposition to electric current flow || ohm (Ω) || <code>Ohm</code> || <code>ohm</code> || Electrical model
|-
|-
| capacitance || Ability to store electric charge || F || f
| <code>capacitance</code> || Ability to store electric charge || farad (F) || <code>F</code> || <code>f</code> || Electrical model
|}
|}


== Data Representation Format ==
== Context-Dependent Quantity Resolution ==


All AOWIS measurement values MUST use the following structure:
Some Model concepts resolve to different registered measurement quantities depending on their context. The representation requirements for such values are defined in [[Measurement:Units]] and, where applicable, the corresponding Measurement subsystem specification.


<pre>
{| class="wikitable"
{
! Model Concept
  "quantity": "<physical_quantity>",
!! Resolved Measurement Quantity
  "value": <numeric_value>,
|-
  "unit": "<canonical_unit>",
| Valve setting
  "uncertainty": <numeric_value>
|| PRV, PSV, and PBV: <code>pressure_head</code>; FCV: <code>volumetric_flow_rate</code>; TCV: <code>minor_loss_coefficient</code>; PCV: <code>valve_position</code>; GPV: curve reference rather than a measurement value
}
|-
</pre>
| Pump setting
|| <code>pump_speed_ratio</code>
|-
| Control trigger
|| <code>water_level</code>, <code>pressure_head</code>, <code>elapsed_time</code>, or <code>time_of_day</code>, depending on control type
|-
| Control or rule action setting
|| The measurement quantity supported by the target link type
|-
| Rule premise value
|| The measurement quantity selected by the rule variable
|-
| Initial or simulated standard water quality
|| <code>chemical_mass_concentration</code>, <code>water_age</code>, or <code>source_trace_percentage</code>, depending on quality-analysis mode
|-
| Standard quality-source strength
|| <code>chemical_mass_concentration</code> or <code>chemical_mass_flow_rate</code>, depending on source type
|-
| Multi-species bulk quality value
|| Mass-basis species: <code>chemical_mass_concentration</code>; amount-of-substance-basis species: <code>chemical_amount_concentration</code>
|-
| Multi-species wall quality value
|| Mass-basis species: <code>chemical_surface_mass_density</code>; amount-of-substance-basis species: <code>chemical_surface_amount_density</code>
|-
| Multi-species initial quality
|| The same quantity as the corresponding species value: bulk species resolve to <code>chemical_mass_concentration</code> or <code>chemical_amount_concentration</code>; wall species resolve to <code>chemical_surface_mass_density</code> or <code>chemical_surface_amount_density</code>
|-
| Multi-species absolute error tolerance
|| The same measurement quantity as the corresponding species value
|-
| Multi-species relative error tolerance
|| <code>relative_error</code>
|-
| Multi-species source strength
|| CONCEN, SETPOINT, and FLOWPACED sources resolve to <code>chemical_mass_concentration</code> or <code>chemical_amount_concentration</code> according to the species basis; MASS sources resolve to <code>chemical_mass_flow_rate</code> or <code>chemical_amount_flow_rate</code>. Wall species are not valid node-source species.
|-
| Reaction coefficient
|| The applicable reaction-coefficient quantity determined by reaction order
|-
| Molecular diffusion coefficient
|| <code>molecular_diffusivity</code>
|-
| Fixed longitudinal dispersion coefficient
|| <code>longitudinal_dispersion_coefficient</code>
|-
| Peclet-number dispersion threshold
|| <code>peclet_number</code>
|-
| Emitter coefficient
|| Equation-dependent coefficient in <code>Q = C H^n</code>; no single fixed canonical unit applies independently of <code>n</code>
|-
| Generic curve coordinate
|| The measurement quantity defined by the curve type
|-
| Report threshold
|| The measurement quantity of the corresponding report field
|-
| EPANET map or backdrop coordinate
|| The applicable geographic, projected, or local coordinate quantity after the coordinate representation is resolved
|}


Example:
== References ==


<pre>
<references />
{
  "quantity": "pipe_length",
  "value": 1200,
  "unit": "m",
  "uncertainty": 5
}
</pre>

Latest revision as of 00:38, 25 September 2026

This page is the normative registry of canonical measurement quantities and units used by AOWIS.

The representation and conversion rules governing these quantities are defined in Measurement:Units.

UCUM[1] is used for machine-readable physical unit identifiers.

Identifier and Field-Naming Rules

The canonical unit assigned to each measurement quantity in this registry is authoritative.

When a unit identifier is explicitly represented, it MUST use the canonical UCUM identifier defined here.

The AOWIS identifier suffix is an ASCII-safe naming convention used for fixed-schema field names, property names, database columns, and similar technical identifiers.

The suffix convention is:

  • division is represented by _per_;
  • multiplication is represented by _;
  • unit symbols are normalized to lower case where required for identifier naming;
  • quantity-specific semantic qualifiers MAY be included where a literal unit-only suffix would be ambiguous;
  • dimensionless fields with canonical UCUM unit 1 normally omit a unit suffix.

For example:

m3/h        -> m3_per_h
m/s         -> m_per_s
kW.h/m3     -> kw_h_per_m3
mm2/(100.m) -> mm2_per_100m

The AOWIS identifier suffix is not itself a UCUM unit identifier.

For generic or dynamically typed measurement values, the resolved measurement quantity determines the canonical unit through this registry.

Length and Distance Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
length Linear spatial extent along an object or path metre (m) m m Pipe and link length
elevation Vertical height relative to an engineering or hydraulic datum metre (m) m m Junction, tank, reservoir, and terrain elevation
altitude Vertical position reported by a geographic positioning source metre (m) m m Geographic altitude; not necessarily suitable as hydraulic elevation
distance Spatial separation between positions metre (m) m m Derived geometric distance
vertical_offset Vertical difference between referenced elevations or heads metre (m) m m Elevation, tank-bottom, and reservoir-head offsets
link_diameter Internal or nominal diameter of a pipe or valve millimetre (mm) mm mm EPANET pipe and valve diameter
tank_diameter Internal diameter of a cylindrical storage tank metre (m) m m EPANET tank diameter
darcy_weisbach_roughness_height Absolute pipe-wall roughness height used by the Darcy-Weisbach formulation millimetre (mm) mm mm EPANET Darcy-Weisbach pipe roughness

Geographic Coordinate Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
latitude Angular position north or south of the equator degree (°) deg deg WGS 84 latitude
longitude Angular position east or west of the prime meridian degree (°) deg deg WGS 84 longitude
projected_easting Eastward coordinate within a projected coordinate reference system metre (m) m m Projected-coordinate easting
projected_northing Northward coordinate within a projected coordinate reference system metre (m) m m Projected-coordinate northing
local_x X coordinate within an explicitly defined local engineering coordinate system metre (m) m m Local coordinates when the coordinate system is defined in metres
local_y Y coordinate within an explicitly defined local engineering coordinate system metre (m) m m Local coordinates when the coordinate system is defined in metres

Area and Volume Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
area Two-dimensional spatial extent square metre (m²) m2 m2 Tank cross-sectional area and other geometric areas
volume Three-dimensional spatial extent or storage capacity cubic metre (m³) m3 m3 Tank volume

Flow and Transport Quantities

Measurement Quantity Identifier ! Definition ! Canonical Unit ! UCUM Identifier ! AOWIS Identifier Suffix ! AOWIS Model / EPANET Mapping
volumetric_flow_rate Volume transported per unit time cubic metre per hour (m³/h) m3/h m3_per_h Demand, link flow, leakage flow, emitter flow, and pump-curve flow
velocity Rate of linear movement metre per second (m/s) m/s m_per_s Link flow velocity
molecular_diffusivity Molecular diffusion coefficient of a chemical species square metre per second (m²/s) m2/s m2_per_s Physical molecular diffusivity used by the AOWIS multi-species model; backend-relative representations such as EPANET-MSX relative diffusivity are converted at the adapter boundary
longitudinal_dispersion_coefficient Longitudinal dispersion coefficient describing axial spreading of a transported species square metre per second (m²/s) m2/s m2_per_s Multi-species longitudinal dispersion

Hydraulic Head, Pressure, and Stress Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
hydraulic_head Total mechanical energy per unit weight of fluid expressed as an equivalent fluid-column height metre (m) m m Junction, reservoir, and tank hydraulic head
pressure_head Fluid pressure expressed as an equivalent fluid-column height metre (m) m m EPANET node pressure, pressure-driven demand thresholds, and pressure-control valve settings
water_level Height of a water surface relative to a defined local reference level metre (m) m m Initial, minimum, maximum, and simulated tank levels
head_gain Increase in hydraulic head across an energy-adding component metre (m) m m Pump curves and pump simulation results
head_loss Reduction in hydraulic head across a hydraulic component metre (m) m m Pipes, valves, and other energy-dissipating components
head_loss_gradient Hydraulic head loss per unit pipe length metre per kilometre (m/km) m/km m_per_km EPANET pipe head-loss reporting
pressure Normal force per unit area within a fluid system kilopascal (kPa) kPa kpa Physical pressure measurements, sensors, SCADA data, and external exchange
stress Internal force per unit area within a material megapascal (MPa) MPa mpa Structural and material analysis

Time Quantities

Measurement Quantity Identifier ! Definition ! Canonical Unit ! UCUM Identifier ! AOWIS Identifier Suffix ! AOWIS Model / EPANET Mapping
elapsed_time Time elapsed from a defined simulation or process origin second (s) s s Simulation elapsed time and time-based control triggers
duration Length of a time interval second (s) s s Simulation duration and time steps
time_of_day Time elapsed since the start of the current day second (s) s s Simulation start time and clock-time controls

The canonical unit second does not imply integral-second resolution. Sub-second durations and time steps are represented as fractional seconds. For example, a time step of one millisecond is represented canonically as 0.001 s.

Hydraulic Coefficients and Other Dimensionless Quantities

The canonical UCUM unit identifier for all quantities in this section is 1. The AOWIS unit suffix is omitted.

Semantic terms such as ratio, factor, coefficient, multiplier, number, and exponent describe the quantity and are not unit suffixes.

Measurement Quantity Identifier ! Definition ! UCUM Identifier ! AOWIS Identifier Suffix ! AOWIS Model / EPANET Mapping
hazen_williams_roughness_coefficient Hazen-Williams pipe roughness coefficient 1 none EPANET Hazen-Williams roughness
chezy_manning_roughness_coefficient Chezy-Manning pipe roughness coefficient 1 none EPANET Chezy-Manning roughness
minor_loss_coefficient Coefficient representing local hydraulic losses 1 none Pipe and valve minor loss; TCV setting
darcy_weisbach_friction_factor Darcy-Weisbach friction factor 1 none Pipe simulation result
pump_speed_ratio Pump rotational speed relative to nominal or reference speed 1 none Pump setting, result, pattern, control, and rule values
pattern_multiplier Factor applied by a hydraulic or energy pattern 1 none EPANET pattern factor
demand_multiplier Global factor applied to base demands 1 none EPANET demand multiplier
pressure_exponent Exponent used by the pressure-driven demand relation 1 none EPANET pressure exponent
emitter_exponent Exponent used by the emitter pressure-flow relation 1 none EPANET emitter exponent
reaction_order Order of a bulk, wall, or tank reaction equation 1 none EPANET reaction order
specific_gravity Fluid density relative to a defined reference density 1 none EPANET specific gravity
relative_viscosity Kinematic viscosity relative to the solver reference 1 none EPANET relative viscosity
relative_diffusivity Molecular diffusivity relative to a defined solver reference diffusivity 1 none EPANET and EPANET-MSX relative diffusivity representations
peclet_number Ratio characterizing advective transport relative to diffusive or dispersive transport 1 none Multi-species dispersion; includes solver thresholds based on the Peclet number
mixing_fraction Fraction of tank volume assigned to the applicable mixing zone 1 none EPANET tank mixing fraction
hydraulic_accuracy Relative hydraulic convergence criterion 1 none EPANET hydraulic accuracy
hydraulic_damping_limit Relative threshold controlling solver damping or status checks 1 none EPANET damping limit
relative_error Relative numerical error 1 none Hydraulic and water-quality numerical error, tolerance, and simulation statistics
flow_balance_ratio Ratio of total outflow to total inflow 1 none EPANET flow-balance reporting
quality_mass_balance_ratio Water-quality mass-conservation ratio 1 none EPANET and multi-species quality mass-balance reporting

Percentage Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
efficiency Ratio of useful output to total input expressed as a percentage percent (%) % percent Pump efficiency and efficiency curves
relative_flow Flow relative to a defined reference flow percent (%) % percent Valve characteristic curves
valve_position Valve opening position relative to its operating range percent (%) % percent Position-control valves
source_trace_percentage Proportion of water originating from a specified source node percent (%) % percent EPANET source-trace analysis
operating_time_percentage Fraction of a reporting period during which equipment operates percent (%) % percent Pump energy reporting
demand_reduction_percentage Reduction in delivered demand relative to requested demand percent (%) % percent Hydraulic statistics
leakage_loss_percentage Leakage loss relative to total system inflow percent (%) % percent Leakage statistics

Reaction and Leakage Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
first_order_bulk_reaction_coefficient First-order reaction-rate coefficient within the bulk fluid per day (d⁻¹) /d per_d Global, pipe, and tank first-order bulk reactions
first_order_wall_reaction_coefficient First-order reaction-rate coefficient at a pipe wall metre per day (m/d) m/d m_per_d Global and pipe first-order wall reactions
leak_area_per_100m_pipe_length Effective leak area assigned per 100 metres of pipe length square millimetre per 100 metres (mm²/100 m) mm2/(100.m) mm2_per_100m EPANET 2.3 FAVAD leak area; EPANET uses 100 project length units and the adapter converts when required[2]
leak_area_expansion_per_pressure_head Increase in effective leak area per unit pressure head square millimetre per metre of pressure head (mm²/m) mm2/m mm2_per_m_head EPANET 2.3 FAVAD leak expansion

Water Quality Quantities

Measurement Quantity Identifier ! Definition ! Canonical Unit ! UCUM Identifier ! AOWIS Identifier Suffix ! AOWIS Model / EPANET Mapping
chemical_mass_concentration Mass concentration of a chemical substance in water milligram per litre (mg/L) mg/L mg_per_l EPANET chemical quality; multi-species bulk species using a mass basis
chemical_amount_concentration Amount-of-substance concentration of a chemical substance in water millimole per litre (mmol/L) mmol/L mmol_per_l Multi-species bulk species using an amount-of-substance basis
chemical_surface_mass_density Mass of a chemical species associated with a surface per unit surface area milligram per square metre (mg/m²) mg/m2 mg_per_m2 Multi-species wall species using a mass basis
chemical_surface_amount_density Amount of a chemical species associated with a surface per unit surface area millimole per square metre (mmol/m²) mmol/m2 mmol_per_m2 Multi-species wall species using an amount-of-substance basis
chemical_mass_flow_rate Chemical mass introduced into or transported through the system per unit time milligram per minute (mg/min) mg/min mg_per_min EPANET mass-booster source strength; multi-species MASS source using a mass basis
chemical_amount_flow_rate Amount of chemical substance introduced into or transported through the system per unit time millimole per minute (mmol/min) mmol/min mmol_per_min Multi-species MASS source using an amount-of-substance basis
water_age Time elapsed since water entered the modelled distribution system hour (h) h h EPANET water-age analysis

Power, Energy, and Electrical Quantities

Measurement Quantity Identifier Definition Canonical Unit UCUM Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
power Rate of energy transfer kilowatt (kW) kW kw Pump power and electrical power
energy Work performed or energy transferred kilowatt-hour (kWh) kW.h kw_h Pump energy consumption
energy_intensity Energy consumed per unit volume kilowatt-hour per cubic metre (kWh/m³) kW.h/m3 kw_h_per_m3 Pump energy-use reporting
electric_current Rate of electric charge flow ampere (A) A a Electrical model
voltage Electric potential difference volt (V) V v Electrical model
electrical_resistance Opposition to electric current flow ohm (Ω) Ohm ohm Electrical model
capacitance Ability to store electric charge farad (F) F f Electrical model

Context-Dependent Quantity Resolution

Some Model concepts resolve to different registered measurement quantities depending on their context. The representation requirements for such values are defined in Measurement:Units and, where applicable, the corresponding Measurement subsystem specification.

Model Concept ! Resolved Measurement Quantity
Valve setting PRV, PSV, and PBV: pressure_head; FCV: volumetric_flow_rate; TCV: minor_loss_coefficient; PCV: valve_position; GPV: curve reference rather than a measurement value
Pump setting pump_speed_ratio
Control trigger water_level, pressure_head, elapsed_time, or time_of_day, depending on control type
Control or rule action setting The measurement quantity supported by the target link type
Rule premise value The measurement quantity selected by the rule variable
Initial or simulated standard water quality chemical_mass_concentration, water_age, or source_trace_percentage, depending on quality-analysis mode
Standard quality-source strength chemical_mass_concentration or chemical_mass_flow_rate, depending on source type
Multi-species bulk quality value Mass-basis species: chemical_mass_concentration; amount-of-substance-basis species: chemical_amount_concentration
Multi-species wall quality value Mass-basis species: chemical_surface_mass_density; amount-of-substance-basis species: chemical_surface_amount_density
Multi-species initial quality The same quantity as the corresponding species value: bulk species resolve to chemical_mass_concentration or chemical_amount_concentration; wall species resolve to chemical_surface_mass_density or chemical_surface_amount_density
Multi-species absolute error tolerance The same measurement quantity as the corresponding species value
Multi-species relative error tolerance relative_error
Multi-species source strength CONCEN, SETPOINT, and FLOWPACED sources resolve to chemical_mass_concentration or chemical_amount_concentration according to the species basis; MASS sources resolve to chemical_mass_flow_rate or chemical_amount_flow_rate. Wall species are not valid node-source species.
Reaction coefficient The applicable reaction-coefficient quantity determined by reaction order
Molecular diffusion coefficient molecular_diffusivity
Fixed longitudinal dispersion coefficient longitudinal_dispersion_coefficient
Peclet-number dispersion threshold peclet_number
Emitter coefficient Equation-dependent coefficient in Q = C H^n; no single fixed canonical unit applies independently of n
Generic curve coordinate The measurement quantity defined by the curve type
Report threshold The measurement quantity of the corresponding report field
EPANET map or backdrop coordinate The applicable geographic, projected, or local coordinate quantity after the coordinate representation is resolved

References

  1. ↑ Unified Code for Units of Measure (UCUM) https://ucum.org
  2. ↑ OWA-EPANET 2.3 release notes https://github.com/OpenWaterAnalytics/EPANET/blob/v2.3/ReleaseNotes2_3.md