atmospheric 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fee8e85ad0a5ae8332b352e8e95098e33f3f0235032e1fbe34273a9b14db058
-  data.tar.gz: 7f5b0d515d007ca5c3cf7c4581312265e1c0c01ddd0e4bac1fa9b8f22a05322f
+  metadata.gz: 9b084338a6346bc02e4440ef14304456ae2f2b3fa14a0a1bbd1d332683cdb0a9
+  data.tar.gz: 8eebfa7a90b447d868eb1fe2bf689aa2a957799a884ef3899181cfe6e4b794d1
 SHA512:
-  metadata.gz: 2bdb5af2f4c861774e283903e3fef5242614eebd4ef30873e7c8df09cd2c6d4fb4486bf79bc2a4e1cc008acf77769c49cf03a0eaf00989fec013fee71dd91d28
-  data.tar.gz: 4b647397cf70c2fd211670e2f5d4dd35c6e3be1624d4f3373da7c015581971a00d8ed82d291c139a5b2f691299297af92cc2d54f31a41a0bf21baf78c23e7c08
+  metadata.gz: 5162c59105d0eea75bae5f513d857aa0a0c245c7b857835e7f3a94c07b00e0ba6beaac986b44540c3c081d01ce44307b57be4dd5e7549ed8906254a61e6544f5
+  data.tar.gz: 7792ae4d76eb57082bebafa2167844d3977805b964bcd2c3839ac9df180b1102bf2e38c08a07d45b62778fb545f815bc67f0127bdd5ae12c56a08771454ceb92

data/README.adoc

@@ -75,18 +75,27 @@ require 'atmospheric'
 Atmospheric::Export::AltitudeAttrs.new.set_altitude(
   value: {altitude-value} <1>
   type: {altitude-type} <2>
-  unit: {altitude-unit} <3>
+  unit: {altitude-unit} <3>,
+  precision: {precision-mode} <4>
 )
 ----
 <1> Value of the altitude desired. Integer.
 <2> Type of altitude. Symbol. One of `:geometric`, `:geopotential`.
 <3> Unit of the altitude. Symbol. One of `:meters`, `:feet`.
-
-NOTE: The `set_altitude` method does not yet support high-precision mode.
+<4> Precision mode. Symbol. One of `:normal`, `:high`, `:reduced`. Default is `:normal`.
 
 Each attribute of the `AltitudeAttrs` object is wrapped in a defined
 data class which is associated with a https://www.unitsml.org/[UnitsML] unit.
 
+Behavior of the precision mode:
+
+`:reduced`:: (default) Uses Isa::NormalPrecision for calculations with signficant digits
+rounding according to the original ISO 2533 specification.
+
+`:normal`:: Uses Isa::NormalPrecision for calculations without value modification.
+
+`:high`:: Uses Isa::HighPrecision for calculations without value modifications. This mode uses BigDecimal.
+
 Depending on the type of the value, it is in one of the following classes:
 
 * Integer. Class: `UnitValueInteger`
@@ -303,8 +312,9 @@ Syntax:
 require 'atmospheric'
 
 Atmospheric::Export::PressureAttrs.new.set_pressure(
-  value: {pressure-value} <1>
-  unit: {pressure-unit} <2>
+  value: {pressure-value}, <1>
+  unit: {pressure-unit}, <2>
+  precision: {precision-mode} <3>
 )
 ----
 <1> Value of the pressure desired. Float.
@@ -312,6 +322,15 @@ Atmospheric::Export::PressureAttrs.new.set_pressure(
 
 NOTE: The `set_pressure` method does not yet support high-precision mode.
 
+Behavior of the precision mode:
+
+`:reduced`:: (default) Uses Isa::NormalPrecision for calculations with signficant digits
+rounding according to the original ISO 2533/ADD 2 specification.
+
+`:normal`:: Uses Isa::NormalPrecision for calculations without value modification.
+
+`:high`:: Uses Isa::HighPrecision for calculations without value modifications. This mode uses BigDecimal.
+
 Each attribute of the `PressureAttrs` object is wrapped in a defined
 data class which is associated with a https://www.unitsml.org/[UnitsML] unit.
 
@@ -949,8 +968,13 @@ is a `PressureAttrs` object. It follows this step schedule:
 ====
 [source,ruby]
 ----
+# Defaults to precision mode `:reduced`
 Atmospheric::Export::Iso25332025.table_atmosphere_meters #=> Lutaml::Model
 Atmospheric::Export::Iso25332025.table_atmosphere_meters.to_yaml #=> YAML
+
+# To use precision mode `:high`
+x = Atmospheric::Export::Iso25332025.table_atmosphere_meters(precision: :high)
+x.to_yaml #=> YAML
 ----
 ====
 
@@ -1069,8 +1093,13 @@ Provides:
 
 [source,ruby]
 ----
+# Defaults to precision mode `:reduced`
 Atmospheric::Export::Iso25332025.table_hypsometrical_mbar         #=> Lutaml::Model
 Atmospheric::Export::Iso25332025.table_hypsometrical_mbar.to_yaml #=> YAML
+
+# To use precision mode `:high`
+x = Atmospheric::Export::Iso25332025.table_hypsometrical_mbar(precision: :high)
+x.to_yaml #=> YAML
 ----
 
 

data/lib/atmospheric/export/altitude_attrs.rb

@@ -33,6 +33,7 @@ module Atmospheric
       attribute :mean_speed, UnitValueFloat
       attribute :frequency, UnitValueFloat
       attribute :mean_free_path, UnitValueFloat
+      attribute :precision, :string, values: %w[reduced normal high]
 
       key_value do
         map "geometric-altitude-m", to: :geometric_altitude_m
@@ -64,6 +65,8 @@ module Atmospheric
         map "mean-speed", to: :mean_speed
         map "frequency", to: :frequency
         map "mean-free-path", to: :mean_free_path
+
+        map "precision", to: :precision
       end
 
       xml do
@@ -97,10 +100,14 @@ module Atmospheric
         map_element "mean-speed", to: :mean_speed
         map_element "frequency", to: :frequency
         map_element "mean-free-path", to: :mean_free_path
+
+        map_element "precision", to: :precision
       end
 
       # In meters only
       def realize_values_from_geopotential(gp_h_m, precision: :reduced)
+        self.precision = precision.to_s
+
         %i[
           temperature_k temperature_c pressure_mbar pressure_mmhg density
           acceleration ppn rhorhon sqrt_rhorhon speed_of_sound
@@ -114,117 +121,119 @@ module Atmospheric
       end
 
       def calculate(gp_h_m, name, precision: :reduced)
+        isa = precision == :high ? Isa::HighPrecision.instance : Isa::NormalPrecision.instance
+
         case name
         when :temperature_k
-          v = Isa::NormalPrecision.instance.temperature_at_layer_from_geopotential(gp_h_m)
+          v = isa.temperature_at_layer_from_geopotential(gp_h_m)
           UnitValueFloat.new(
-            value: precision == :reduced ? (v * 1000.0).round : v,
+            value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "K"
           )
         when :temperature_c
-          v = Isa::NormalPrecision.instance.temperature_at_layer_celcius(gp_h_m)
+          v = isa.temperature_at_layer_celcius(gp_h_m)
           UnitValueFloat.new(
-            value: precision == :reduced ? (v * 1000.0).round : v,
+            value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "degC"
           )
         when :pressure_mbar
-          v = Isa::NormalPrecision.instance.pressure_from_geopotential_mbar(gp_h_m)
+          v = isa.pressure_from_geopotential_mbar(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "mbar"
           )
         when :pressure_mmhg
-          v = Isa::NormalPrecision.instance.pressure_from_geopotential_mmhg(gp_h_m)
+          v = isa.pressure_from_geopotential_mmhg(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "u:mm_Hg"
           )
         when :density
-          v = Isa::NormalPrecision.instance.density_from_geopotential(gp_h_m)
+          v = isa.density_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "kg*m^-3"
           )
         when :acceleration
-          v = Isa::NormalPrecision.instance.gravity_at_geopotential(gp_h_m)
+          v = isa.gravity_at_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? v.round(4) : v,
             unitsml: "m*s^-2"
           )
         when :ppn
-          v = Isa::NormalPrecision.instance.p_p_n_from_geopotential(gp_h_m)
+          v = isa.p_p_n_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: nil
           )
         when :rhorhon
-          v = Isa::NormalPrecision.instance.rho_rho_n_from_geopotential(gp_h_m)
+          v = isa.rho_rho_n_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: nil
           )
         when :sqrt_rhorhon
-          v = Isa::NormalPrecision.instance.root_rho_rho_n_from_geopotential(gp_h_m)
+          v = isa.root_rho_rho_n_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: nil
           )
         when :speed_of_sound
-          v = Isa::NormalPrecision.instance.speed_of_sound_from_geopotential(gp_h_m)
+          v = isa.speed_of_sound_from_geopotential(gp_h_m)
           UnitValueFloat.new(
-            value: precision == :reduced ? (v * 1000.0).round : v,
+            value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
             unitsml: "m*s^-1"
           )
         when :dynamic_viscosity
-          v = Isa::NormalPrecision.instance.dynamic_viscosity_from_geopotential(gp_h_m)
+          v = isa.dynamic_viscosity_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "Pa*s"
           )
         when :kinematic_viscosity
-          v = Isa::NormalPrecision.instance.kinematic_viscosity_from_geopotential(gp_h_m)
+          v = isa.kinematic_viscosity_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "m^2*s^-1"
           )
         when :thermal_conductivity
-          v = Isa::NormalPrecision.instance.thermal_conductivity_from_geopotential(gp_h_m)
+          v = isa.thermal_conductivity_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "W*m^-1*K^-1"
           )
         when :pressure_scale_height
-          v = Isa::NormalPrecision.instance.pressure_scale_height_from_geopotential(gp_h_m)
+          v = isa.pressure_scale_height_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? v.round(1) : v,
             unitsml: "m"
           )
         when :specific_weight
-          v = Isa::NormalPrecision.instance.specific_weight_from_geopotential(gp_h_m)
+          v = isa.specific_weight_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "N*m^-3"
           )
         when :air_number_density
-          v = Isa::NormalPrecision.instance.air_number_density_from_geopotential(gp_h_m)
+          v = isa.air_number_density_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "m^-3"
           )
         when :mean_speed
-          v = Isa::NormalPrecision.instance.mean_air_particle_speed_from_geopotential(gp_h_m)
+          v = isa.mean_air_particle_speed_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? v.round(2) : v,
             unitsml: "m*s^-1"
           )
         when :frequency
-          v = Isa::NormalPrecision.instance.air_particle_collision_frequency_from_geopotential(gp_h_m)
+          v = isa.air_particle_collision_frequency_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "s^-1"
           )
         when :mean_free_path
-          v = Isa::NormalPrecision.instance.mean_free_path_of_air_particles_from_geopotential(gp_h_m)
+          v = isa.mean_free_path_of_air_particles_from_geopotential(gp_h_m)
           UnitValueFloat.new(
             value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
             unitsml: "m"

data/lib/atmospheric/export/iso_25331975/group_one_attrs.rb

@@ -41,39 +41,41 @@ module Atmospheric
         end
 
         def calculate(gp_h_m, name, precision: :reduced)
+          isa = precision == :high ? Isa::HighPrecision.instance : Isa::NormalPrecision.instance
+
           case name
           when :temperature_k
-            v = Isa::NormalPrecision.instance.temperature_at_layer_from_geopotential(gp_h_m)
+            v = isa.temperature_at_layer_from_geopotential(gp_h_m)
             UnitValueInteger.new(
               value: precision == :reduced ? (v * 1000.0).round : v,
               unitsml: "K"
             )
           when :temperature_c
-            v = Isa::NormalPrecision.instance.temperature_at_layer_celcius(gp_h_m)
+            v = isa.temperature_at_layer_celcius(gp_h_m)
             UnitValueInteger.new(
               value: precision == :reduced ? (v * 1000.0).round : v,
               unitsml: "degC"
             )
           when :pressure_mbar
-            v = Isa::NormalPrecision.instance.pressure_from_geopotential_mbar(gp_h_m)
+            v = isa.pressure_from_geopotential_mbar(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: "mbar"
             )
           when :pressure_mmhg
-            v = Isa::NormalPrecision.instance.pressure_from_geopotential_mmhg(gp_h_m)
+            v = isa.pressure_from_geopotential_mmhg(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: "u:mm_Hg"
             )
           when :density
-            v = Isa::NormalPrecision.instance.density_from_geopotential(gp_h_m)
+            v = isa.density_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: "kg*m^-3"
             )
           when :acceleration
-            v = Isa::NormalPrecision.instance.gravity_at_geopotential(gp_h_m)
+            v = isa.gravity_at_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? v.round(4) : v,
               unitsml: "m*s^-2"

data/lib/atmospheric/export/iso_25331975/group_three_attrs.rb

@@ -40,39 +40,41 @@ module Atmospheric
         end
 
         def calculate(gp_h_m, name, precision: :reduced)
+          isa = precision == :high ? Isa::HighPrecision.instance : Isa::NormalPrecision.instance
+
           case name
           when :pressure_scale_height
-            v = Isa::NormalPrecision.instance.pressure_scale_height_from_geopotential(gp_h_m)
+            v = isa.pressure_scale_height_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? v.round(1) : v,
               unitsml: "m"
             )
           when :specific_weight
-            v = Isa::NormalPrecision.instance.specific_weight_from_geopotential(gp_h_m)
+            v = isa.specific_weight_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "N*m^-3"
             )
           when :air_number_density
-            v = Isa::NormalPrecision.instance.air_number_density_from_geopotential(gp_h_m)
+            v = isa.air_number_density_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "m^-3"
             )
           when :mean_speed
-            v = Isa::NormalPrecision.instance.mean_air_particle_speed_from_geopotential(gp_h_m)
+            v = isa.mean_air_particle_speed_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? v.round(2) : v,
               unitsml: "m*s^-1"
             )
           when :frequency
-            v = Isa::NormalPrecision.instance.air_particle_collision_frequency_from_geopotential(gp_h_m)
+            v = isa.air_particle_collision_frequency_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "s^-1"
             )
           when :mean_free_path
-            v = Isa::NormalPrecision.instance.mean_free_path_of_air_particles_from_geopotential(gp_h_m)
+            v = isa.mean_free_path_of_air_particles_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "m"

data/lib/atmospheric/export/iso_25331975/group_two_attrs.rb

@@ -42,46 +42,47 @@ module Atmospheric
         end
 
         def calculate(gp_h_m, name, precision: :reduced)
-          case name
+          isa = precision == :high ? Isa::HighPrecision.instance : Isa::NormalPrecision.instance
 
+          case name
           when :ppn
-            v = Isa::NormalPrecision.instance.p_p_n_from_geopotential(gp_h_m)
+            v = isa.p_p_n_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: nil
             )
           when :rhorhon
-            v = Isa::NormalPrecision.instance.rho_rho_n_from_geopotential(gp_h_m)
+            v = isa.rho_rho_n_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: nil
             )
           when :sqrt_rhorhon
-            v = Isa::NormalPrecision.instance.root_rho_rho_n_from_geopotential(gp_h_m)
+            v = isa.root_rho_rho_n_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 6) : v,
               unitsml: nil
             )
           when :speed_of_sound
-            v = Isa::NormalPrecision.instance.speed_of_sound_from_geopotential(gp_h_m)
+            v = isa.speed_of_sound_from_geopotential(gp_h_m)
             UnitValueInteger.new(
               value: precision == :reduced ? (v * 1000.0).round : v,
               unitsml: "m*s^-1"
             )
           when :dynamic_viscosity
-            v = Isa::NormalPrecision.instance.dynamic_viscosity_from_geopotential(gp_h_m)
+            v = isa.dynamic_viscosity_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "Pa*s"
             )
           when :kinematic_viscosity
-            v = Isa::NormalPrecision.instance.kinematic_viscosity_from_geopotential(gp_h_m)
+            v = isa.kinematic_viscosity_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "m^2*s^-1"
             )
           when :thermal_conductivity
-            v = Isa::NormalPrecision.instance.thermal_conductivity_from_geopotential(gp_h_m)
+            v = isa.thermal_conductivity_from_geopotential(gp_h_m)
             UnitValueFloat.new(
               value: precision == :reduced ? round_to_sig_figs(v, 5) : v,
               unitsml: "W*m^-1*K^-1"

data/lib/atmospheric/export/iso_25332025.rb

@@ -60,20 +60,20 @@ module Atmospheric
       end
 
       class << self
-        def table_atmosphere_meters
-          AltitudesInMeters.new.set_attrs
+        def table_atmosphere_meters(precision: :reduced)
+          AltitudesInMeters.new.set_attrs(precision: precision)
         end
 
-        def table_atmosphere_feet
-          AltitudesInFeet.new.set_attrs
+        def table_atmosphere_feet(precision: :reduced)
+          AltitudesInFeet.new.set_attrs(precision: precision)
         end
 
-        def table_hypsometrical_altitude
-          AltitudesForPressure.new.set_attrs
+        def table_hypsometrical_altitude(precision: :reduced)
+          AltitudesForPressure.new.set_attrs(precision: precision)
         end
 
-        def table_hypsometrical_mbar
-          HypsometricalMbar.new.set_attrs
+        def table_hypsometrical_mbar(precision: :reduced)
+          HypsometricalMbar.new.set_attrs(precision: precision)
         end
       end
     end

data/lib/atmospheric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Atmospheric
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atmospheric
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal