@oimlsmart/primmel-packages 0.1.0

package/oiml-r60/specification/calculations.prl

@@ -0,0 +1,318 @@
+calculation conversionFactor {
+  name "conversionFactor"
+  identifier /calc/conversion-factor
+  category metrological
+  description "Computes the conversion factor f per R 60-3 2.1.2.4"
+  inputs {
+    avgIndicationAt75pct : number { unit "counts" description "Average indication at 75% of Max" }
+    indicationAtDmin : number { unit "counts" description "Indication at minimum test load" }
+    n : integer { description "Number of verification intervals of the measuring range under test" }
+  }
+  output : number { unit "counts/v" name "conversion_factor_f" description "Conversion factor from counts to verification units" }
+  expression "ocl{(avgIndicationAt75pct - indicationAtDmin) / (0.75 * n)}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.4"
+}
+
+calculation vMin {
+  name "vMin"
+  identifier /calc/v-min
+  category metrological
+  description "Computes verification interval v_min per R 60-1, 3.5.11"
+  inputs {
+    d_max : number { unit "g, kg, or t" description "Maximum test load D_max" }
+    d_min : number { unit "g, kg, or t" description "Minimum test load D_min" }
+    n_lc : integer { description "Number of verification intervals" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor" }
+  }
+  output : number { unit "g, kg, or t" name "v_min" description "Minimum verification interval" }
+  expression "ocl{(d_max - d_min) / (n_lc * conversion_factor_f)}"
+  ref derives-from "urn:oiml:pub:r:60-1:2021#clause-3.5.11"
+}
+
+calculation mpe {
+  name "mpe"
+  identifier /calc/mpe
+  category metrological
+  description "Looks up MPE for a given load in v units per R 60-1 Table 4"
+  inputs {
+    load : number { unit "v" description "Test load in verification units" }
+    accuracy_class : enum { description "Accuracy class" enum_values { A B C D } }
+    p_lc : number { unit "dimensionless" description "Apportioning factor" }
+  }
+  output : number { unit "v" name "mpe" description "Maximum permissible error at this load" }
+  expression "ocl{lookupMPE(load, accuracy_class, p_lc)}"
+  ref derives-from "urn:oiml:pub:r:60-1:2021#table-4"
+}
+
+calculation loadCellError {
+  name "loadCellError"
+  identifier /calc/load-cell-error
+  category metrological
+  description "Load cell error: E_L = (I - I_ref) / f"
+  inputs {
+    avgIndication : number { unit "counts" description "Average indication reading" }
+    referenceIndication : number { unit "counts" description "Reference indication value" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "e_l" description "Load cell error in verification units" }
+  expression "ocl{(avgIndication - referenceIndication) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.3"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.5"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.6"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.8"
+}
+
+calculation repeatabilityError {
+  name "repeatabilityError"
+  identifier /calc/repeatability-error
+  category metrological
+  description "Repeatability error: E_R = (max - min) / f across runs"
+  inputs {
+    indications : collection { description "Collection of indication readings across runs" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "e_r" description "Repeatability error in verification units" }
+  expression "ocl{(indications->max() - indications->min()) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.3"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.3"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.3.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.3.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.3.3"
+}
+
+calculation creep {
+  name "creep"
+  identifier /calc/creep
+  category metrological
+  description "Creep: C_C = (I_t - I_0) / f"
+  inputs {
+    indicationAtTime : number { unit "counts" description "Indication at time t" }
+    initialIndication : number { unit "counts" description "Initial indication at D_max (t=0)" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "c_c" description "Creep change in verification units" }
+  expression "ocl{(indicationAtTime - initialIndication) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.3"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.5"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.6"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.8"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.9"
+}
+
+calculation deadLoadOutputReturn {
+  name "deadLoadOutputReturn"
+  identifier /calc/dead-load-return
+  category metrological
+  description "Dead load output return: DR = (I_min2 - I_min1) / f"
+  inputs {
+    minLoadIndication2 : number { unit "counts" description "Final indication at D_min after test" }
+    minLoadIndication1 : number { unit "counts" description "Initial indication at D_min before test" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "c_dr" description "Dead load output return in verification units" }
+  expression "ocl{(minLoadIndication2 - minLoadIndication1) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.5.4"
+}
+
+calculation barometricPressureEffect {
+  name "barometricPressureEffect"
+  identifier /calc/barometric-effect
+  category metrological
+  description "Barometric pressure effect: C_P = (I_2 - I_1) / f"
+  inputs {
+    indication2 : number { unit "counts" description "Indication at second pressure" }
+    indication1 : number { unit "counts" description "Indication at first pressure" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "change_v" description "Pressure-induced change in verification units" }
+  expression "ocl{(indication2 - indication1) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.6"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.6"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.6.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.6.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.6.3"
+}
+
+calculation temperatureMDLO {
+  name "temperatureMDLO"
+  identifier /calc/temperature-mdlo
+  category metrological
+  description "Temperature effect on MDLO per 5 degC increment"
+  inputs {
+    indication2 : number { unit "counts" description "Indication at second temperature" }
+    indication1 : number { unit "counts" description "Indication at first temperature" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+    temperature2 : number { unit "degC" description "Second temperature" }
+    temperature1 : number { unit "degC" description "First temperature" }
+  }
+  output : number { unit "v" name "change_per_5deg" description "MDLO change per 5 degC in verification units" }
+  expression "ocl{((indication2 - indication1) / conversion_factor_f) * 5 / abs(temperature2 - temperature1)}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4.3"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4.4"
+}
+
+calculation mdloStepChange {
+  name "mdloStepChange"
+  identifier /calc/mdlo-step-change
+  category metrological
+  description "Raw temperature effect on MDLO of one temperature step: C_M = (I_2 - I_1) / f, in v — BEFORE the T_f/(T_2-T_1) normalization and the v to v_min conversion (those live exactly once in the mdlo_normalized VerdictQuantity; the normalized per-5 degC form is temperatureMDLO). The honest close of the mdlo test's c_m variable, which previously had no named registry entry (PROPOSAL.R60-SSOT-Phase9.5 item 4, Response 4 item 4)."
+  inputs {
+    indication2 : number { unit "counts" description "Indication at second temperature" }
+    indication1 : number { unit "counts" description "Indication at first temperature" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor f" }
+  }
+  output : number { unit "v" name "c_m" description "Raw MDLO step change in verification units" }
+  expression "ocl{(indication2 - indication1) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.4.2"
+}
+
+calculation humidityCHmin {
+  name "humidityCHmin"
+  identifier /calc/humidity-chmin
+  category metrological
+  description "Humidity effect on minimum load output (CH cyclic): C_Hmin"
+  inputs {
+    indDminAfter : number { unit "counts" description "Average D_min indication after humidity exposure" }
+    indDminBefore : number { unit "counts" description "Average D_min indication before humidity exposure" }
+    conversion_factor_f : number { unit "counts/v" }
+  }
+  output : number { unit "v" name "c_hmin" }
+  expression "ocl{(indDminAfter - indDminBefore) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.3"
+}
+
+calculation humidityCHmax {
+  name "humidityCHmax"
+  identifier /calc/humidity-chmax
+  category metrological
+  description "Humidity effect on span (CH cyclic): C_Hmax"
+  inputs {
+    avgDmaxAfter : number { unit "counts" }
+    avgDminAfter : number { unit "counts" }
+    avgDmaxBefore : number { unit "counts" }
+    avgDminBefore : number { unit "counts" }
+    conversion_factor_f : number { unit "counts/v" }
+  }
+  output : number { unit "v" name "c_hmax" }
+  expression "ocl{((avgDmaxAfter - avgDminAfter) - (avgDmaxBefore - avgDminBefore)) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.1"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.2"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.7.3"
+}
+
+calculation maxAllowableSpanVariation {
+  name "maxAllowableSpanVariation"
+  identifier /calc/max-allowable-span-variation
+  category electronic
+  description "Maximum allowable span variation: max(0.5, 0.5 × |MPE|) with p_LC = 1.0"
+  inputs {
+    d_max : number { description "Maximum test load" }
+    accuracy_class : enum { enum_values { A B C D } }
+  }
+  output : number { unit "v" name "maxVariation" description "Maximum allowable variation" }
+  expression "ocl{max(0.5, 0.5 * abs(lookupMPE(d_max, accuracy_class, 1.0)))}"
+  ref derives-from "urn:oiml:pub:r:60-1:2021#clause-5.7.2.6"
+}
+
+calculation electronicDifference {
+  name "electronicDifference"
+  identifier /calc/electronic-difference
+  category electronic
+  description "Electronic disturbance difference between with/without readings"
+  inputs {
+    indicationWith : number { unit "counts" description "Indication with disturbance" }
+    indicationWithout : number { unit "counts" description "Indication without disturbance" }
+    conversion_factor_f : number { unit "counts/v" }
+  }
+  output : number { unit "v" name "difference" }
+  expression "ocl{(indicationWith - indicationWithout) / conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.2"
+}
+
+calculation significantFault {
+  name "significantFault"
+  identifier /calc/significant-fault
+  category electronic
+  description "Determines if an electronic disturbance causes a significant fault (difference exceeds one verification interval, 1 v — the R 60-1, 5.7.1.1 NOTE v_min threshold expressed in the test's v units; R 60-3 forms print the difference column in v against a '> v_min' criterion)"
+  inputs {
+    difference : number { unit "v" description "Observed difference in verification units" }
+  }
+  output : boolean { unit "1" name "isSignificant" description "Whether the fault exceeds one verification interval" }
+  expression "ocl{abs(difference) > 1}"
+  ref derives-from "urn:oiml:pub:r:60-1:2021#clause-5.7.1.1"
+}
+
+calculation deadLoadReturnMass {
+  name "deadLoadReturnMass"
+  identifier /calc/dead-load-return-mass
+  category metrological
+  description "Dead load output return in mass units: DR = (E_max − E_min) × C_DR / n_LC"
+  inputs {
+    e_max : number { unit "g, kg, or t" description "Maximum capacity E_max" }
+    e_min : number { unit "g, kg, or t" description "Minimum dead load E_min" }
+    c_dr : number { unit "v" description "Dead load output return C_DR in verification units" }
+    n_lc : integer { description "Maximum number of verification intervals n_LC" }
+  }
+  output : number { unit "g, kg, or t" name "dr" description "Dead load output return in mass units" }
+  expression "ocl{(e_max - e_min) * c_dr / n_lc}"
+  ref derives-from "urn:oiml:pub:r:60-1:2021#clause-3.5.10"
+}
+
+calculation referenceIndication {
+  name "referenceIndication"
+  identifier /calc/reference-indication
+  category metrological
+  description "Reference indication (net test load): R_i = [(test load − D_min) / (D_max − D_min)] × n × f"
+  inputs {
+    testLoad : number { unit "g, kg, or t" description "Applied test load" }
+    d_min : number { unit "g, kg, or t" description "Minimum test load D_min" }
+    d_max : number { unit "g, kg, or t" description "Maximum test load D_max" }
+    n : integer { description "Number of verification intervals" }
+    conversion_factor_f : number { unit "counts/v" description "Conversion factor" }
+  }
+  output : number { unit "indication units" name "r_i" description "Reference indication in indication units" }
+  expression "ocl{((testLoad - d_min) / (d_max - d_min)) * n * conversion_factor_f}"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.6"
+  ref derives-from "urn:oiml:pub:r:60-3:2021#clause-2.1.2.6"
+}
+
+calculation digitalChangeoverError {
+  name "digitalChangeoverError"
+  identifier /calc/digital-changeover-error
+  category metrological
+  description "Error prior to rounding for digital load cells with an output interval > 0.20 v, via the changeover point: P = I + ½v − ΔL, E = P − L, E_c = E − E_0 (all inputs in v)"
+  inputs {
+    indication_v : number { unit "v" description "Digital output value I at the load, in v" }
+    delta_l_v : number { unit "v" description "Additional load ΔL added until the output increases by one interval, in v" }
+    test_load_v : number { unit "v" description "Applied load L, in v" }
+    error_at_dmin_v : number { unit "v" description "Error E_0 at the minimum test load D_min, in v" }
+  }
+  output : number { unit "v" name "e_c" description "Corrected error prior to rounding, in v" }
+  expression "ocl{indication_v + 0.5 - delta_l_v - test_load_v - error_at_dmin_v}"
+  ref derives-from "urn:oiml:pub:r:60-2:2021#clause-2.10.7.2"
+}
+