Jump to content

Measurement:Unit Identifiers: Difference between revisions

From AOWIS
mNo edit summary
 
(17 intermediate revisions by the same user not shown)
Line 3: Line 3:
* Related to: [[Measurement:Units]]
* Related to: [[Measurement:Units]]


AOWIS is based on the International System of Units (SI), as specified in [[Measurement:Units|Units]]. Accordingly, AOWIS uses UCUM<ref name="UCUM">Unified Code for Units of Measure (UCUM) https://ucum.org</ref> as the normative syntax and code system for machine-readable unit identifiers.
AOWIS uses the canonical SI-based engineering units specified in [[Measurement:Units|Units]]. UCUM<ref name="UCUM">Unified Code for Units of Measure (UCUM) https://ucum.org</ref> is the normative syntax and code system for the machine-readable unit identifiers.


AOWIS defines a canonical set of UCUM unit identifiers used across all system interfaces, storage formats, APIs, and inter-system data exchanges.
AOWIS defines a canonical set of UCUM unit identifiers used across all system interfaces, storage formats, APIs, and inter-system data exchanges.


Unit identifiers are machine-readable tokens and are not intended to represent typographic or human-readable SI notation.
Unit identifiers are machine-readable tokens and are not intended to represent typographic or human-readable unit notation.


== General Rules ==
== General Rules ==


* All unit identifiers MUST be lower-case ASCII-only.
* All unit identifiers MUST conform to UCUM.
* Unit identifiers MUST be unambiguous and consistent across all AOWIS-compliant systems.
* Each measurement quantity MUST be assigned exactly one UCUM unit identifier as its canonical unit identifier.
* Each physical quantity MUST map to exactly one canonical unit.
* Canonical unit identifiers MUST be used consistently across all AOWIS-compliant systems, interfaces, storage formats, APIs, and inter-system data exchanges.
* Units MUST NOT be context-dependent or system-dependent.
* Canonical unit identifiers MUST be interpreted independently of locale, display format, implementation, and system context.
* Units MUST be stable identifiers suitable for JSON, databases, and file formats.
* Canonical unit identifiers MUST remain stable across AOWIS-compliant systems and data formats.


== Requirements ==
== Requirements ==


<pre>
<pre>
REQ-MEAS-UNI-001: Unit identifiers MUST be ASCII-only strings.
REQ-MEAS-UNI-001: All unit identifiers MUST conform to UCUM.


REQ-MEAS-UNI-002: Unit identifiers MUST NOT contain Unicode characters, superscripts, or typographic symbols.
REQ-MEAS-UNI-002: Each measurement quantity MUST be assigned exactly one UCUM unit identifier as its canonical unit identifier.


REQ-MEAS-UNI-003: Each physical quantity in AOWIS MUST map to exactly one canonical unit identifier.
REQ-MEAS-UNI-003: The canonical unit identifier assigned to a measurement quantity MUST be used consistently across all AOWIS-compliant systems, interfaces, storage formats, APIs, and inter-system data exchanges.


REQ-MEAS-UNI-004: Units MUST be used consistently across all AOWIS system interfaces and storage formats.
REQ-MEAS-UNI-004: The measurement quantity identifier defines what is measured, while the unit identifier defines the unit in which it is expressed.
</pre>


REQ-MEAS-UNI-005: Units MUST NOT be context-dependent or implementation-defined.
== Canonical Measurement Quantities and Units ==


REQ-MEAS-UNI-006: Semantic meaning MUST be derived from the quantity field, not from the unit identifier.
The canonical UCUM unit identifier assigned to a measurement quantity is authoritative whenever a unit identifier is represented in serialization or data exchange.


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.
The AOWIS identifier suffix is an ASCII-safe representation used in field names, property names, database columns, and other technical identifiers. Division is represented by <code>_per_</code>, multiplication by <code>_</code>, and upper case is normalized to lower case.


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.
For fixed-schema measurement fields, the measurement quantity and canonical unit MAY be defined normatively by the schema and represented through the field name and its AOWIS identifier suffix. Such fields do not require a separate unit-identifier property.


REQ-MEAS-UNI-009: Physical quantity semantics MUST be derived exclusively from the "Quantity / Name" field and MUST NOT be inferred from unit identifiers.
When a unit identifier is represented explicitly, it MUST use the canonical UCUM identifier assigned to the measurement quantity. The AOWIS identifier suffix is a technical field-naming convention and is not itself a UCUM unit identifier.
</pre>
 
Generic or dynamically typed measurement values MUST explicitly identify their measurement quantity and canonical UCUM unit and MUST NOT rely solely on a field-name suffix.


== Canonical Unit Identifiers ==
Each identifier suffix is explicitly defined in the following tables.


=== Length and Spatial Quantities ===
=== Length and Distance Quantities ===


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| length || Linear spatial extent || m || m || Pipe/link length (SI-normalized EPANET model)
| <code>length</code> || Linear spatial extent along an object or path || metre (m) || <code>m</code> || <code>m</code> || Pipe and link length
|-
|-
| elevation || Vertical height relative to datum || m || m || Node elevation (SI-normalized EPANET model)
| <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
|-
|-
| distance || Spatial separation between points || m || m || Derived geometric quantity
| <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
|-
|-
| position_offset || Relative spatial offset magnitude || m || m || Not explicitly represented in EPANET
| <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
|}
 
=== Geographic Coordinate Quantities ===
 
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit 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> || UTM, UPS, and other projected-coordinate eastings
|-
| <code>projected_northing</code> || Northward coordinate within a projected coordinate reference system || metre (m) || <code>m</code> || <code>m</code> || UTM, UPS, and other projected-coordinate northings
|}
|}


Line 58: Line 80:


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| area || Two-dimensional spatial extent || m² || m2 || Not directly used
| <code>area</code> || Two-dimensional spatial extent || square metre () || <code>m2</code> || <code>m2</code> || Tank cross-sectional area and other geometric areas
|-
|-
| volume || Storage volume || m³ || m3 || Tank volume (SI-normalized EPANET model)
| <code>volume</code> || Three-dimensional spatial extent or storage capacity || cubic metre () || <code>m3</code> || <code>m3</code> || Tank volume
|}
|}


Line 68: Line 90:


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| volumetric_flow_rate || Volume per unit time || m³/s || m3_per_s || Link flow (SI-normalized EPANET model)
| <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
|-
|-
| mass_flow_rate || Mass per unit time || kg/s || kg_per_s || Not directly represented (derived)
| <code>velocity</code> || Rate of linear movement || metre per second (m/s) || <code>m/s</code> || <code>m_per_s</code> || Link flow velocity
|}
|}


=== Pressure and Stress ===
=== Hydraulic Head, Pressure, and Stress ===


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit 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
|-
| <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
|-
|-
| pressure || Force per unit area in fluid system || Pa || pa || Node pressure (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
|-
|-
| stress || Internal material stress || Pa || pa || Not represented
| <code>head_gain</code> || Increase in hydraulic head across an energy-adding component || metre (m) || <code>m</code> || <code>m</code> || Pump head curves and pump simulation results
|-
| <code>head_loss</code> || Reduction in hydraulic head across a hydraulic component || metre (m) || <code>m</code> || <code>m</code> || Total head loss across 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-system exchange
|-
| <code>stress</code> || Internal force per unit area within a material || megapascal (MPa) || <code>MPa</code> || <code>mpa</code> || Structural and material analysis; not currently represented in the hydraulic model
|}
|}


Line 88: Line 122:


{| class="wikitable"
{| class="wikitable"
! Quantity / Name !! Definition !! Canonical Unit (SI symbol) !! Serialized Unit !! EPANET Mapping
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit 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, hydraulic timesteps, quality timesteps, reporting intervals, and rule intervals
|-
| <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 of day and clock-time controls
|}
 
=== Dimensionless and Percentage Quantities ===
 
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
| <code>efficiency</code> || Ratio of useful output to total input, expressed as a percentage || percent (%) || <code>%</code> || <code>percent</code> || Pump efficiency values and efficiency curves
|-
| <code>relative_flow</code> || Flow relative to a defined reference flow, expressed as a percentage || percent (%) || <code>%</code> || <code>percent</code> || Valve characteristic curves
|-
| <code>valve_position</code> || Valve opening position relative to its full operating range || percent (%) || <code>%</code> || <code>percent</code> || Position-control valves and valve characteristic curves
|-
| <code>source_trace_percentage</code> || Proportion of water originating from a specified source node || percent (%) || <code>%</code> || <code>percent</code> || EPANET source-trace analysis
|}
 
=== Reaction and Leakage Quantities ===
 
{| class="wikitable"
! Measurement Quantity Identifier !! Definition !! Canonical Unit !! Canonical UCUM Unit Identifier !! AOWIS Identifier Suffix !! AOWIS Model / EPANET Mapping
|-
|-
| time || Simulation or observation time || s || s || Simulation time (EPANET internal time normalized to seconds)
| <code>first_order_bulk_reaction_coefficient</code> || First-order reaction-rate coefficient for a substance within the bulk fluid || per day (d⁻¹) || <code>/d</code> || <code>per_d</code> || Global, pipe-specific, and tank-specific first-order bulk reaction coefficients
|-
|-
| duration || Time interval length || s || s || Simulation duration / reporting intervals
| <code>first_order_wall_reaction_coefficient</code> || First-order reaction-rate coefficient for a substance at a pipe wall || metre per day (m/d) || <code>m/d</code> || <code>m_per_d</code> || Global and pipe-specific first-order wall reaction coefficients
|-
| <code>leak_area_per_pipe_length</code> || Effective leak area distributed over pipe length || square millimetre per metre (mm²/m) || <code>mm2/m</code> || <code>mm2_per_m</code> || Pipe leakage-area model
|-
| <code>leak_area_expansion_per_pressure_head</code> || Increase in effective leak area per unit pressure head || square millimetre per metre (mm²/m) || <code>mm2/m</code> || <code>mm2_per_m</code> || Pressure-dependent leak-area expansion
|}
|}


=== Electrical Quantities ===
=== Water Quality Quantities ===


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


== Data Representation Format ==
== Context-Dependent Measurement Values ==
 
A numeric field whose measurement quantity or unit depends on another field, enum, object type, equation, or operating mode MUST NOT be assigned a single canonical unit or AOWIS identifier suffix.


All AOWIS measurement values MUST use the following structure:
Such values MUST be represented using quantity-specific fields or a discriminated data structure that identifies the applicable measurement quantity.


<pre>
{| class="wikitable"
{
! Current Model Concept !! Context-Dependent Meaning !! Required Resolution
  "quantity": "<physical_quantity>",
|-
  "value": <numeric_value>,
| Valve setting || Pressure head, volumetric flow rate, loss coefficient, valve position, or a curve reference, depending on valve type || Replace the generic numeric setting with quantity-specific fields or a discriminated valve-setting structure
  "unit": "<canonical_unit>",
|-
  "uncertainty": <numeric_value>
| Control action setting || The setting quantity supported by the controlled link type || Use the same quantity-specific representation as the target link
}
|-
</pre>
| Control trigger level or pressure || Water level or pressure head, depending on the controlled node and control type || Represent water-level and pressure-head triggers separately
|-
| Rule premise value || Demand, hydraulic head, water level, pressure head, volumetric flow rate, power, elapsed time, time of day, fill time, drain time, or another quantity selected by the rule variable || Store the rule variable together with a quantity-specific value representation
|-
| Rule action setting || The setting quantity supported by the target link type || Use the same quantity-specific representation as the target link
|-
| Initial quality and simulation quality || Chemical concentration, water age, or source-trace percentage, depending on the quality-analysis mode || Represent each quality-analysis value using its defined measurement quantity
|-
| Quality-source strength || Chemical concentration or chemical mass flow rate, depending on the quality-source type || Represent source strength using a source-type-specific structure
|-
| Bulk and wall reaction coefficients || The dimensions of the coefficient depend on the configured reaction order || Use reaction-order-specific quantity fields or a discriminated reaction-coefficient structure
|-
| Emitter coefficient || Volumetric flow rate divided by pressure head raised to the configured emitter exponent || Store the coefficient together with its exponent in a dedicated structure
|-
| Generic curve coordinates || Coordinate quantities determined by the curve type || Use a typed curve structure whenever the coordinate quantities are known
|-
| Report thresholds || The measurement quantity of the corresponding report field || Associate each threshold with the report field's defined measurement quantity
|-
| EPANET map and backdrop coordinates || Coordinate units determined by the associated EPANET map or backdrop configuration || Convert to an explicitly identified geographic, projected, or local coordinate representation
|}
 
== Data Model ==
 
Concrete AOWIS data structures and field definitions are specified by the [https://github.com/aowis-org/AOWIS-SERVER-MODEL AOWIS Server Model].
 
Fixed-schema fields encode their canonical unit through the normative schema and AOWIS identifier suffix; generic or dynamically typed measurement values carry an explicit canonical UCUM unit identifier.


Example:
Measurement fields defined by the model MUST use the canonical units specified on this page.


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

Latest revision as of 14:35, 30 July 2026

AOWIS uses the canonical SI-based engineering units specified in Units. UCUM[1] is the normative syntax and code system for the machine-readable unit identifiers.

AOWIS defines a canonical set of UCUM unit identifiers used across all system interfaces, storage formats, APIs, and inter-system data exchanges.

Unit identifiers are machine-readable tokens and are not intended to represent typographic or human-readable unit notation.

General Rules

  • All unit identifiers MUST conform to UCUM.
  • Each measurement quantity MUST be assigned exactly one UCUM unit identifier as its canonical unit identifier.
  • Canonical unit identifiers MUST be used consistently across all AOWIS-compliant systems, interfaces, storage formats, APIs, and inter-system data exchanges.
  • Canonical unit identifiers MUST be interpreted independently of locale, display format, implementation, and system context.
  • Canonical unit identifiers MUST remain stable across AOWIS-compliant systems and data formats.

Requirements

REQ-MEAS-UNI-001: All unit identifiers MUST conform to UCUM.

REQ-MEAS-UNI-002: Each measurement quantity MUST be assigned exactly one UCUM unit identifier as its canonical unit identifier.

REQ-MEAS-UNI-003: The canonical unit identifier assigned to a measurement quantity MUST be used consistently across all AOWIS-compliant systems, interfaces, storage formats, APIs, and inter-system data exchanges.

REQ-MEAS-UNI-004: The measurement quantity identifier defines what is measured, while the unit identifier defines the unit in which it is expressed.

Canonical Measurement Quantities and Units

The canonical UCUM unit identifier assigned to a measurement quantity is authoritative whenever a unit identifier is represented in serialization or data exchange.

The AOWIS identifier suffix is an ASCII-safe representation used in field names, property names, database columns, and other technical identifiers. Division is represented by _per_, multiplication by _, and upper case is normalized to lower case.

For fixed-schema measurement fields, the measurement quantity and canonical unit MAY be defined normatively by the schema and represented through the field name and its AOWIS identifier suffix. Such fields do not require a separate unit-identifier property.

When a unit identifier is represented explicitly, it MUST use the canonical UCUM identifier assigned to the measurement quantity. The AOWIS identifier suffix is a technical field-naming convention and is not itself a UCUM unit identifier.

Generic or dynamically typed measurement values MUST explicitly identify their measurement quantity and canonical UCUM unit and MUST NOT rely solely on a field-name suffix.

Each identifier suffix is explicitly defined in the following tables.

Length and Distance Quantities

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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

Geographic Coordinate Quantities

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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 UTM, UPS, and other projected-coordinate eastings
projected_northing Northward coordinate within a projected coordinate reference system metre (m) m m UTM, UPS, and other projected-coordinate northings

Area and Volume

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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

Hydraulic Head, Pressure, and Stress

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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 head curves and pump simulation results
head_loss Reduction in hydraulic head across a hydraulic component metre (m) m m Total head loss across 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-system exchange
stress Internal force per unit area within a material megapascal (MPa) MPa mpa Structural and material analysis; not currently represented in the hydraulic model

Time

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit 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, hydraulic timesteps, quality timesteps, reporting intervals, and rule intervals
time_of_day Time elapsed since the start of the current day second (s) s s Simulation start time of day and clock-time controls

Dimensionless and Percentage Quantities

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
efficiency Ratio of useful output to total input, expressed as a percentage percent (%) % percent Pump efficiency values and efficiency curves
relative_flow Flow relative to a defined reference flow, expressed as a percentage percent (%) % percent Valve characteristic curves
valve_position Valve opening position relative to its full operating range percent (%) % percent Position-control valves and valve characteristic curves
source_trace_percentage Proportion of water originating from a specified source node percent (%) % percent EPANET source-trace analysis

Reaction and Leakage Quantities

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
first_order_bulk_reaction_coefficient First-order reaction-rate coefficient for a substance within the bulk fluid per day (d⁻¹) /d per_d Global, pipe-specific, and tank-specific first-order bulk reaction coefficients
first_order_wall_reaction_coefficient First-order reaction-rate coefficient for a substance at a pipe wall metre per day (m/d) m/d m_per_d Global and pipe-specific first-order wall reaction coefficients
leak_area_per_pipe_length Effective leak area distributed over pipe length square millimetre per metre (mm²/m) mm2/m mm2_per_m Pipe leakage-area model
leak_area_expansion_per_pressure_head Increase in effective leak area per unit pressure head square millimetre per metre (mm²/m) mm2/m mm2_per_m Pressure-dependent leak-area expansion

Water Quality Quantities

Measurement Quantity Identifier Definition Canonical Unit Canonical UCUM Unit Identifier AOWIS Identifier Suffix AOWIS Model / EPANET Mapping
chemical_concentration Mass concentration of a chemical substance in water milligram per litre (mg/L) mg/L mg_per_l EPANET chemical-quality input and simulation results
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 Canonical UCUM Unit 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 and electrical energy
energy_intensity Energy consumed per unit volume of transported water 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 Measurement Values

A numeric field whose measurement quantity or unit depends on another field, enum, object type, equation, or operating mode MUST NOT be assigned a single canonical unit or AOWIS identifier suffix.

Such values MUST be represented using quantity-specific fields or a discriminated data structure that identifies the applicable measurement quantity.

Current Model Concept Context-Dependent Meaning Required Resolution
Valve setting Pressure head, volumetric flow rate, loss coefficient, valve position, or a curve reference, depending on valve type Replace the generic numeric setting with quantity-specific fields or a discriminated valve-setting structure
Control action setting The setting quantity supported by the controlled link type Use the same quantity-specific representation as the target link
Control trigger level or pressure Water level or pressure head, depending on the controlled node and control type Represent water-level and pressure-head triggers separately
Rule premise value Demand, hydraulic head, water level, pressure head, volumetric flow rate, power, elapsed time, time of day, fill time, drain time, or another quantity selected by the rule variable Store the rule variable together with a quantity-specific value representation
Rule action setting The setting quantity supported by the target link type Use the same quantity-specific representation as the target link
Initial quality and simulation quality Chemical concentration, water age, or source-trace percentage, depending on the quality-analysis mode Represent each quality-analysis value using its defined measurement quantity
Quality-source strength Chemical concentration or chemical mass flow rate, depending on the quality-source type Represent source strength using a source-type-specific structure
Bulk and wall reaction coefficients The dimensions of the coefficient depend on the configured reaction order Use reaction-order-specific quantity fields or a discriminated reaction-coefficient structure
Emitter coefficient Volumetric flow rate divided by pressure head raised to the configured emitter exponent Store the coefficient together with its exponent in a dedicated structure
Generic curve coordinates Coordinate quantities determined by the curve type Use a typed curve structure whenever the coordinate quantities are known
Report thresholds The measurement quantity of the corresponding report field Associate each threshold with the report field's defined measurement quantity
EPANET map and backdrop coordinates Coordinate units determined by the associated EPANET map or backdrop configuration Convert to an explicitly identified geographic, projected, or local coordinate representation

Data Model

Concrete AOWIS data structures and field definitions are specified by the AOWIS Server Model.

Fixed-schema fields encode their canonical unit through the normative schema and AOWIS identifier suffix; generic or dynamically typed measurement values carry an explicit canonical UCUM unit identifier.

Measurement fields defined by the model MUST use the canonical units specified on this page.

References

  1. Unified Code for Units of Measure (UCUM) https://ucum.org