4.4.3. Measure¶
4.4.3.1. Example Measure¶
For example, 16in pipeline with a 12.5km length operated at 5.8kpsi would therefore read:
1 2 3 4 5 | {
"diameter": {"val": 16, "unit":"in"},
"length": {"val":12.5, "unit":"km"},
"pressure": {"val":5.8, "unit":"ksi"}
}
|
Assuming the exactness of the conversion factor, this shall be interpreted as being strictly equivalent to:
1 2 3 4 5 | {
"diameter": {"val": 406.4, "unit":"mm"},
"length": {"val":12500, "unit":"m"},
"pressure": {"val":400, "unit":"bar"}
}
|
Measures are used to provide physical measure data. For example, the Length JSON fragment is consistently used to write any variable that reports length or distance.
All measures are provided under the form of a JSON fragment object with two members:
val, mapping to a number for the actual quantity or value of the measurement, eg 406.4,
unit, mapping to a string for the actual unit used, to declare the quantity, eg m, mm.
For sake of standardization, unit must be selected from enumerations provided within the JSON schema.
The documentation of the various measurement objects are reported in the sections below.
4.4.3.2. Schema Measure¶
-
pdef.model.measure.Measure Mother class for all Measures.
Show JSON schema
{ "title": "Measure", "description": "Mother class for all Measures.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "type": "string" } }, "required": [ "val" ] }
-
unit: Optional[str] = Ellipsis Unit of measure.
-
val: float = Ellipsis The value taken by the Measure.
- Constraints and examples:
examples = [1.0, -25.1, 1000000.0]
-
4.4.3.3. ElectricCurrent¶
-
pdef.model.measure.ElectricCurrent Measure of the intensity of an electric current.
Show JSON schema
{ "title": "ElectricCurrent", "description": ":ref:`Measure` of the intensity of an electric current.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "A" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[A] = Ellipsis Unit of measure.
4.4.3.4. Angle¶
-
pdef.model.measure.Angle Measure of an angle.
Show JSON schema
{ "title": "Angle", "description": ":ref:`Measure` of an angle.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "deg", "rad" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[deg, rad] = Ellipsis Unit of measure.
4.4.3.5. Azimuth¶
-
pdef.model.measure.Azimuth Measure of an angle relative to North.
Show JSON schema
{ "title": "Azimuth", "description": ":ref:`Measure` of an angle relative to North.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "deg", "rad" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[deg, rad] = Ellipsis Unit of measure.
4.4.3.6. Density¶
-
pdef.model.measure.Density Measure of a density.
Show JSON schema
{ "title": "Density", "description": ":ref:`Measure` of a density.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "g.m^-3", "kg.m^-3" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[g.m^-3, kg.m^-3] = Ellipsis Unit of measure.
4.4.3.7. Depth¶
4.4.3.7.1. Example Depth¶
1 2 3 4 5 | {
"val": 1556.0,
"unit": "m",
"ref": "MSL"
}
|
1 2 3 4 5 | {
"val": 1558.0,
"unit": "m",
"ref": "LAT"
}
|
4.4.3.7.2. Schema Depth¶
-
pdef.model.measure.Depth Measure of a depth. Positive counting downwards.
Show JSON schema
{ "title": "Depth", "description": ":ref:`Measure` of a depth. Positive counting downwards.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" }, "ref": { "title": "Depth Reference", "description": "The depth reference system used to specify the depth.", "examples": [ "LAT", "MSL" ], "enum": [ "LAT", "MSL" ], "type": "string" } }, "required": [ "val", "unit", "ref" ], "additionalProperties": false }
- Config
extra: str = forbid
-
ref: Literal[LAT, MSL] = Ellipsis The depth reference system used to specify the depth.
- Constraints and examples:
examples = [‘LAT’, ‘MSL’]
-
unit: Literal[km, hm, dam, m, dm, cm, mm, microm, ft, in] = Ellipsis Unit of measure.
4.4.3.8. Duration¶
-
pdef.model.measure.Duration Measure of a duration
Show JSON schema
{ "title": "Duration", "description": ":ref:`Measure` of a duration", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "s", "mn", "hr", "d", "mth", "y" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[s, mn, hr, d, mth, y] = Ellipsis Unit of measure.
4.4.3.9. Electro_Chemical_Efficiency¶
4.4.3.9.1. Example Electro_Chemical_Efficiency¶
1 2 3 4 | {
"val": 2500.0,
"unit": "A.h.kg^-1"
}
|
4.4.3.9.2. Schema Electro_Chemical_Efficiency¶
-
pdef.model.measure.Electro_Chemical_Efficiency Measure of Electro-chemical Efficiency.
Show JSON schema
{ "title": "Electro_Chemical_Efficiency", "description": ":ref:`Measure` of Electro-chemical Efficiency.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "Unit", "enum": [ "A.h.kg^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[A.h.kg^-1] = Ellipsis
4.4.3.10. Flow_Rate¶
-
pdef.model.measure.Flow_Rate Measure of a flow rate
Show JSON schema
{ "title": "Flow_Rate", "description": ":ref:`Measure` of a flow rate", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "l.s^-1", "m^3.s^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[l.s^-1, m^3.s^-1] = Ellipsis Unit of measure.
4.4.3.11. Force¶
-
pdef.model.measure.Force Measure of force
Show JSON schema
{ "title": "Force", "description": ":ref:`Measure` of force", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "N", "kN", "lbf" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[N, kN, lbf] = Ellipsis Unit of measure.
4.4.3.12. Frequency¶
-
pdef.model.measure.Frequency Measure of frequency
Show JSON schema
{ "title": "Frequency", "description": ":ref:`Measure` of frequency", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "s^-1", "mn^-1", "hr^-1", "d^-1", "mth^-1", "y^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[s^-1, mn^-1, hr^-1, d^-1, mth^-1, y^-1] = Ellipsis Unit of measure.
4.4.3.13. HeatInput¶
-
pdef.model.measure.HeatInput Measure of Heat Input
Show JSON schema
{ "title": "HeatInput", "description": ":ref:`Measure` of Heat Input", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "J/in", "J/mm", "kJ/in", "kJ/mm" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[J/in, J/mm, kJ/in, kJ/mm] = Ellipsis Unit of measure.
4.4.3.14. Length¶
-
pdef.model.measure.Length Measure of a length, distance, thickness, diameter, etc
Show JSON schema
{ "title": "Length", "description": ":ref:`Measure` of a length, distance, thickness, diameter, etc", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[km, hm, dam, m, dm, cm, mm, microm, ft, in] = Ellipsis Unit of measure.
4.4.3.15. Mass¶
-
pdef.model.measure.Mass Measure of mass
Show JSON schema
{ "title": "Mass", "description": ":ref:`Measure` of mass", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "g", "kg", "lb", "lbs", "t" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[g, kg, lb, lbs, t] = Ellipsis Unit of measure.
4.4.3.16. OHTC¶
-
pdef.model.measure.OHTC Measure of Overall Heat Transfer Coefficient (u-value).
Show JSON schema
{ "title": "OHTC", "description": ":ref:`Measure` of Overall Heat Transfer Coefficient (u-value).", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "W.m^-2.K^-1" ], "type": "string" }, "ref": { "title": "OHTC Diameter Reference", "description": "The reference diameter used to specify the OHTC.", "default": "ID", "examples": [ "ID", "OD" ], "enum": [ "ID", "OD" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
ref: Literal[ID, OD] = 'ID' The reference diameter used to specify the OHTC.
- Constraints and examples:
examples = [‘ID’, ‘OD’]
-
unit: Literal[W.m^-2.K^-1] = Ellipsis Unit of measure.
4.4.3.17. Pressure¶
4.4.3.17.1. Example Pressure¶
1 2 3 4 | {
"val": 450.0,
"unit": "MPa"
}
|
4.4.3.17.2. Schema Pressure¶
-
pdef.model.measure.Pressure Measure of pressure
Show JSON schema
{ "title": "Pressure", "description": ":ref:`Measure` of pressure", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "Pa", "kPa", "MPa", "GPa", "psi", "kpsi", "bar" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[Pa, kPa, MPa, GPa, psi, kpsi, bar] = Ellipsis Unit of measure.
4.4.3.18. Resistivity¶
-
pdef.model.measure.Resistivity Measure of electrical resistivity.
Show JSON schema
{ "title": "Resistivity", "description": ":ref:`Measure` of electrical resistivity.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "ohm.m^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[ohm.m^-1] = Ellipsis Unit of measure.
4.4.3.19. Specific_Heat_Capacity¶
-
pdef.model.measure.Specific_Heat_Capacity Measure of specific heat capacity, the amount of energy needed to raise the temperature of a substance by degree.
Show JSON schema
{ "title": "Specific_Heat_Capacity", "description": ":ref:`Measure` of specific heat capacity, the amount of energy needed to raise the \ntemperature of a substance by degree.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "J.K^-1.g^-1", "J.C^-1.g^-1", "J.K^-1.kg^-1", "J.C^-1.kg^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[J.K^-1.g^-1, J.C^-1.g^-1, J.K^-1.kg^-1, J.C^-1.kg^-1] = Ellipsis Unit of measure.
4.4.3.20. Speed¶
-
pdef.model.measure.Speed Measure of speed
Show JSON schema
{ "title": "Speed", "description": ":ref:`Measure` of speed", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "m.s^-1", "km.hr^-1", "mm.hr^-1", "knots", "ipm" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[m.s^-1, km.hr^-1, mm.hr^-1, knots, ipm] = Ellipsis Unit of measure.
4.4.3.21. Stress¶
4.4.3.21.1. Example Stress¶
1 2 3 4 | {
"val": 450.0,
"unit": "MPa"
}
|
4.4.3.21.2. Schema Stress¶
-
pdef.model.measure.Stress Measure of stress
Show JSON schema
{ "title": "Stress", "description": ":ref:`Measure` of stress", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "Pa", "kPa", "MPa", "GPa", "psi", "kpsi" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[Pa, kPa, MPa, GPa, psi, kpsi] = Ellipsis Unit of measure.
4.4.3.22. Temperature¶
-
pdef.model.measure.Temperature Measure of temperature
Show JSON schema
{ "title": "Temperature", "description": ":ref:`Measure` of temperature", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "K", "C", "F" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[K, C, F] = Ellipsis Unit of measure.
4.4.3.23. Thermal_Conductivity¶
4.4.3.23.1. Example Thermal_Conductivity¶
1 2 3 4 | {
"val": 45.0,
"unit": "W.m^-1.K^-1"
}
|
4.4.3.23.2. Schema Thermal_Conductivity¶
-
pdef.model.measure.Thermal_Conductivity Measure of Thermal Conductivity
Show JSON schema
{ "title": "Thermal_Conductivity", "description": ":ref:`Measure` of Thermal Conductivity", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "W.m^-1.K^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[W.m^-1.K^-1] = Ellipsis Unit of measure.
4.4.3.24. Thermal_Expansion_Coef¶
-
pdef.model.measure.Thermal_Expansion_Coef Measure of coefficient of thermal expansion
Show JSON schema
{ "title": "Thermal_Expansion_Coef", "description": ":ref:`Measure` of coefficient of thermal expansion", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "Unit", "enum": [ "C^-1", "K^-1", "F^-1" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[C^-1, K^-1, F^-1] = Ellipsis
4.4.3.25. UnitLess¶
-
pdef.model.measure.UnitLess Measure for dimensionless ratios.
Show JSON schema
{ "title": "UnitLess", "description": ":ref:`Measure` for dimensionless ratios.", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "anyOf": [ { "type": "null" }, { "enum": [ "ppb", "%", "ppm", "ppt", "ppq", "N/A", "" ], "type": "string" } ] } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[None, ppb, %, ppm, ppt, ppq, N/A, ] = Ellipsis Unit of measure.
4.4.3.26. Volt¶
-
pdef.model.measure.Volt Measure of a current tension
Show JSON schema
{ "title": "Volt", "description": ":ref:`Measure` of a current tension", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "V" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }
- Config
extra: str = forbid
-
unit: Literal[V] = Ellipsis Unit of measure.