atmospheric 0.4.3 → 0.4.4

data/lib/atmospheric/export/iso_25332025.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "iso_25331975"
+require_relative "iso_25332025/combined_altitude_attrs_group"
+
+module Atmospheric
+  module Export
+    module Iso25332025
+      class AltitudesInMeters < CombinedAltitudeAttrsGroup
+        def steps
+          (
+            (-5000..31_950).step(50) +
+            (32_000..50_900).step(100) +
+            (51_000..80_000).step(200)
+          )
+        end
+      end
+
+      class AltitudesInFeet < CombinedAltitudeAttrsGroup
+        def steps
+          (
+            (-16_500..-13_750).step(250) +
+            (-14_000..104_800).step(200) +
+            (105_000..262_500).step(500)
+          )
+        end
+
+        def steps_unit
+          :feet
+        end
+      end
+
+      class AltitudesForPressure < CombinedAltitudeAttrsGroup
+        def steps
+          (-1000..4599).step(1)
+        end
+      end
+
+      class HypsometricalMbar < HypsometricalTable
+        # TODO: when Ruby's step does not create inaccurate floating point numbers
+        # This is a hack to solve a Ruby bug with floating point calcuations
+        # > (20.0..1770.9).step(0.1).to_a
+        #  ...
+        #  1769.4,
+        #  1769.5,
+        #  1769.6000000000001, # <== we need to clean these
+        #  1769.7,
+        #  1769.8000000000002, # <== we need to clean these
+        # The last `map` should be removed if this bug is fixed
+        def steps
+          (
+            (5.0..19.99).step(0.01).to_a.map { |v| v.round(2) } +
+            (20.0..1770.9).step(0.1).to_a.map { |v| v.round(1) }
+          )
+        end
+
+        def steps_unit
+          :mbar
+        end
+      end
+
+      class << self
+        def table_atmosphere_meters
+          AltitudesInMeters.new.set_attrs
+        end
+
+        def table_atmosphere_feet
+          AltitudesInFeet.new.set_attrs
+        end
+
+        def table_hypsometrical_altitude
+          AltitudesForPressure.new.set_attrs
+        end
+
+        def table_hypsometrical_mbar
+          HypsometricalMbar.new.set_attrs
+        end
+      end
+    end
+  end
+end

data/lib/atmospheric/export/pressure_attrs.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+require_relative "utils"
+require_relative "../unit_value_float"
+require_relative "../unit_value_integer"
+
+module Atmospheric
+  module Export
+    class PressureAttrs < Lutaml::Model::Serializable
+      include Utils
+      attribute :pressure_mbar, UnitValueFloat
+      attribute :pressure_mmhg, UnitValueFloat
+      attribute :geometric_altitude_m, UnitValueFloat
+      attribute :geometric_altitude_ft, UnitValueInteger
+      attribute :geopotential_altitude_m, UnitValueFloat
+      attribute :geopotential_altitude_ft, UnitValueInteger
+
+      key_value do
+        map "pressure-mbar", to: :pressure_mbar
+        map "pressure-mmhg", to: :pressure_mmhg
+        map "geopotential-altitude-m", to: :geopotential_altitude_m
+        map "geopotential-altitude-ft", to: :geopotential_altitude_ft
+        map "geometric-altitude-m", to: :geometric_altitude_m
+        map "geometric-altitude-ft", to: :geometric_altitude_ft
+      end
+
+      xml do
+        root "hypsometrical-attributes"
+        map_element "pressure-mbar", to: :pressure_mbar
+        map_element "pressure-mmhg", to: :pressure_mmhg
+        map_element "geometric-altitude-m", to: :geometric_altitude_m
+        map_element "geometric-altitude-ft", to: :geometric_altitude_ft
+        map_element "geopotential-altitude-m", to: :geopotential_altitude_m
+        map_element "geopotential-altitude-ft", to: :geopotential_altitude_ft
+      end
+
+      def set_pressure(value:, unit: :mbar, precision: :reduced)
+        method_name = "geopotential_altitude_from_pressure_#{unit}"
+        gp_h_m = Isa::NormalPrecision.instance.send(method_name, value)
+        gp_h_ft = m_to_ft(gp_h_m)
+        gm_h_m = Isa::NormalPrecision.instance.geometric_altitude_from_geopotential(gp_h_m)
+        gm_h_ft = m_to_ft(gm_h_m)
+
+        realize_altitudes(gm_h_m, gm_h_ft, gp_h_m, gp_h_ft, precision: precision)
+        realize_pressures(value, unit: unit)
+
+        self
+      end
+
+      # TODO: Not sure why we need round(1) for meter values
+      def realize_altitudes(hgmm, hgmf, hgpm, hgpf, precision: :reduced)
+        self.geometric_altitude_m = UnitValueFloat.new(
+          value: precision == :reduced ? hgmm.round(1) : hgmm,
+          unitsml: "m"
+        )
+
+        self.geometric_altitude_ft = UnitValueInteger.new(
+          value: precision == :reduced ? hgmf.round : hgmf,
+          unitsml: "ft"
+        )
+
+        self.geopotential_altitude_m = UnitValueFloat.new(
+          value: precision == :reduced ? hgpm.round(1) : hgpm,
+          unitsml: "m"
+        )
+
+        self.geopotential_altitude_ft = UnitValueInteger.new(
+          value: precision == :reduced ? hgpf.round : hgpf,
+          unitsml: "ft"
+        )
+      end
+
+      def realize_pressures(input, unit:)
+        # pattern: [value in mbar, value in mmhg]
+        mbar, mmhg = case unit
+                     when :mbar
+                       [input,
+                        Isa::NormalPrecision.instance.mbar_to_mmhg(input)]
+                     when :mmhg
+                       [Isa::NormalPrecision.instance.mmhg_to_mbar(input),
+                        input]
+                     else
+                       raise ArgumentError,
+                             "Invalid unit: #{unit}. Use :mbar or :mmhg."
+                     end
+
+        self.pressure_mbar = UnitValueFloat.new(value: mbar, unitsml: "mbar")
+        self.pressure_mmhg = UnitValueFloat.new(value: mmhg, unitsml: "mmhg")
+      end
+    end
+  end
+end

data/lib/atmospheric/export/{target.rb → utils.rb}

@@ -1,9 +1,17 @@
-require "yaml"
+# frozen_string_literal: true
 
 module Atmospheric
   module Export
+    module Utils
+      def values_in_m_ft(value, unit: :meters)
+        case unit
+        when :meters
+          [value.to_f, m_to_ft(value)]
+        when :feet
+          [ft_to_m(value), value.to_f]
+        end
+      end
 
-    module Target
       def round_to_sig_figs(num, num_sig_figs)
         num.round(num_sig_figs - Math.log10(num).ceil).to_f
       end
@@ -15,17 +23,6 @@ module Atmospheric
       def ft_to_m(feet)
         feet * 0.3048
       end
-
-      def to_yaml
-        to_h
-          .to_yaml(indentation: 4)
-          .gsub("\n-   ", "\n\n  - ")
-          .gsub(/^(.*):\n/, "\n\\1:") # Make fancy
-      end
-
-      def to_file(hash = to_yaml)
-        File.write(filename, hash)
-      end
     end
   end
 end

data/lib/atmospheric/export.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Atmospheric
   module Export
   end
@@ -6,4 +8,4 @@ end
 require_relative "export/iso_25331975"
 require_relative "export/iso_25331997"
 require_relative "export/iso_25331985"
-require_relative "export/iso_25332024"
+require_relative "export/iso_25332025"

data/lib/atmospheric/isa.rb

@@ -1,104 +1,25 @@
+# frozen_string_literal: true
+
 require "bigdecimal"
 require "bigdecimal/math"
+require "singleton"
 
 module Atmospheric
   module Isa
     # International Standard Atmosphere (ISA) (ISO 2533:1975)
     # ICAO Standard Atmosphere (ICAO Doc 7488/3, 1994)
 
-    class << self
-      private
-
-      @precision = :normal # Note the initial make_constants run won't see this
-
-      def num(str)
-        if @precision == :high
-          BigDecimal(str)
-        else
-          str.to_f
-        end
-      end
-
-      def sqrt(num)
-        if @precision == :high
-          BigMath.sqrt(num, 100)
-        else
-          Math.sqrt(num)
-        end
-      end
-
-      def log10(num)
-        if @precision == :high
-          BigMath.log(num, 100) / BigMath.log(10, 100)
-        else
-          Math.log10(num)
-        end
-      end
-
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
-      def make_constants
-        # 2.1 Primary constants and characteristics
-        # Table 1 - Main constants and characteristics adopted for
-        #           the calculation of the ISO Standard Atmosphere
-        @constants = {
-          # g_n gravitation at mean sea level (m.s-2)
-          g_n: num("9.80665"),
-
-          # Avogadro constant (mol-1)
-          N_A: num("6.02257e+23"),
-
-          # p_n pressure at mean sea level (Pa)
-          p_n: num("101325"),
-
-          # rho_n standard air density
-          rho_n: num("1.225"),
-
-          # T_n standard thermodynamic air temperature at mean sea level
-          T_n: num("288.15"),
-
-          # universal gas constant
-          R_star: num("8.31432"),
-
-          # radius of the Earth (m)
-          radius: num("6356766"),
-
-          # adiabatic index (dimensionless)
-          k: num("1.4"),
-        }
-
-        # 2.2 The equation of the static atmosphere and the perfect gas law
-        # Formula (2)
-        # M: air molar mass at sea level, kg.kmol-1
-        # Value given in 2.1 as M: 28.964720
-        @constants[:M] =
-          (@constants[:rho_n] * @constants[:R_star] * @constants[:T_n]) \
-            / @constants[:p_n]
-
-        # Formula (3)
-        # R: specific gas constant, J.K-1.kg-1.
-        # Value given in 2.1 as R: 287.05287
-        @constants[:R] = @constants[:R_star] / @constants[:M]
-
-        @sqrt2 = sqrt(num("2"))
-        @pi = if @precision == :high then BigMath.PI(100) else Math::PI end
-      end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
-
-      public
+    class Algorithms
+      attr_accessor :precision
+      attr_reader :pressure_layers, :constants, :sqrt2, :pi
 
       def set_precision(precision)
-        @precision = if precision == :high then :high else :normal end
+        @precision = precision == :high ? :high : :normal
         remove_instance_variable(:@pressure_layers) \
           if defined?(@pressure_layers)
         make_constants
       end
-    end
 
-    make_constants
-
-    class << self
       # 2.3 Geopotential and geometric altitides; acceleration of free fall
 
       # 2.3 Formula (8)
@@ -149,11 +70,10 @@ module Atmospheric
 
       def temperature_at_layer_celcius(geopotential_alt)
         kelvin_to_celsius(
-          temperature_at_layer_from_geopotential(geopotential_alt),
+          temperature_at_layer_from_geopotential(geopotential_alt)
         )
       end
 
-      # rubocop:disable Metrics/AbcSize
       def locate_lower_layer(geopotential_alt)
         # Return first layer if lower than lowest
         return 0 if geopotential_alt < num(TEMPERATURE_LAYERS[0][:H])
@@ -169,7 +89,6 @@ module Atmospheric
 
         nil
       end
-      # rubocop:enable Metrics/AbcSize
 
       # Table 4 - Temperature and vertical temperature gradients
       #
@@ -190,15 +109,12 @@ module Atmospheric
         { H: "47000", T: "270.65", B: "0"       },
         { H: "51000", T: "270.65", B: "-0.0028" },
         { H: "71000", T: "214.65", B: "-0.002"  },
-        { H: "80000", T: "196.65" },
+        { H: "80000", T: "196.65" }
       ].freeze
 
       # 2.7 Pressure
 
       # Base pressure values given defined `TEMPERATURE_LAYERS` and constants
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/PerceivedComplexity
-      # rubocop:disable Metrics/MethodLength
       def pressure_layers
         return @pressure_layers if @pressure_layers
 
@@ -225,22 +141,19 @@ module Atmospheric
           temp = num(current_layer[:T])
           height_diff = geopotential_alt - capital_h_b
 
-          p_i = if beta != 0
+          p_i = if beta.zero?
+                  # Formula (13)
+                  pressure_formula_beta_zero(p_b, temp, height_diff)
+                else
                   # Formula (12)
                   pressure_formula_beta_nonzero(p_b, beta, capital_t_b,
                                                 height_diff)
-                else
-                  # Formula (13)
-                  pressure_formula_beta_zero(p_b, temp, height_diff)
                 end
           p[i] = p_i
         end
 
         @pressure_layers = p
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Metrics/MethodLength
 
       # Formula (12)
       def pressure_formula_beta_nonzero(p_b, beta, temp, height_diff)
@@ -265,8 +178,6 @@ module Atmospheric
         pascal * num("0.01")
       end
 
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       # Pressure for a given geopotential altitude `H` (m) above mean sea level
       def pressure_from_geopotential(geopotential_alt)
         i = locate_lower_layer(geopotential_alt)
@@ -278,16 +189,14 @@ module Atmospheric
         p_b = pressure_layers[i]
         height_diff = geopotential_alt - capital_h_b
 
-        if beta != 0
-          # Formula (12)
-          pressure_formula_beta_nonzero(p_b, beta, capital_t_b, height_diff)
-        else
+        if beta.zero?
           # Formula (13)
           pressure_formula_beta_zero(p_b, temp, height_diff)
+        else
+          # Formula (12)
+          pressure_formula_beta_nonzero(p_b, beta, capital_t_b, height_diff)
         end
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
 
       def pressure_from_geopotential_mbar(geopotential_alt)
         pa_to_mbar(pressure_from_geopotential(geopotential_alt))
@@ -452,8 +361,6 @@ module Atmospheric
       # ADD 1
       # Formulae used in the calculation of the relationships
       # between geopotential altitude and pressure
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       def geopotential_altitude_from_pressure_mbar(pressure)
         if pressure >= pa_to_mbar(pressure_layers[2]) # H <= 11 000 m
           (num("3.731444") - pressure**num("0.1902631")) / num("8.41728e-5")
@@ -461,10 +368,10 @@ module Atmospheric
           (num("3.1080387") - log10(pressure)) / num("6.848325e-5")
         elsif pressure >= pa_to_mbar(pressure_layers[4]) # H <= 32 000 m
           (num("1.2386515") - pressure**num("0.02927125")) \
-            / (num("5.085177e-6") * pressure**num("0.02927125"))
+/ (num("5.085177e-6") * pressure**num("0.02927125"))
         elsif pressure >= pa_to_mbar(pressure_layers[5]) # H <= 47 000 m
           (num("1.9630052") - pressure**num("0.08195949")) \
-            / (num("2.013664e-5") * pressure**num("0.08195949"))
+/ (num("2.013664e-5") * pressure**num("0.08195949"))
         end
       end
 
@@ -481,8 +388,106 @@ module Atmospheric
             / (num("2.013664e-5") * pressure**num("0.08195949"))
         end
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
+
+      def mbar_to_mmhg(mbar)
+        # Convert mbar to Pa, then Pa to mmHg
+        pa = mbar / num("0.01") # or mbar * 100
+        pa_to_mmhg(pa)
+      end
+
+      def mmhg_to_mbar(mmhg)
+        # Convert mmHg to Pa, then Pa to mbar
+        pa = mmhg / num("0.007500616827")
+        pa_to_mbar(pa)
+      end
+
+      private
+
+      def num(str)
+        if @precision == :high
+          BigDecimal(str)
+        else
+          str.to_f
+        end
+      end
+
+      def sqrt(num)
+        if @precision == :high
+          BigMath.sqrt(num, 100)
+        else
+          Math.sqrt(num)
+        end
+      end
+
+      def log10(num)
+        if @precision == :high
+          BigMath.log(num, 100) / BigMath.log(10, 100)
+        else
+          Math.log10(num)
+        end
+      end
+
+      def make_constants
+        # 2.1 Primary constants and characteristics
+        # Table 1 - Main constants and characteristics adopted for
+        #           the calculation of the ISO Standard Atmosphere
+        @constants = {
+          # g_n gravitation at mean sea level (m.s-2)
+          g_n: num("9.80665"),
+
+          # Avogadro constant (mol-1)
+          N_A: num("6.02257e+23"),
+
+          # p_n pressure at mean sea level (Pa)
+          p_n: num("101325"),
+
+          # rho_n standard air density
+          rho_n: num("1.225"),
+
+          # T_n standard thermodynamic air temperature at mean sea level
+          T_n: num("288.15"),
+
+          # universal gas constant
+          R_star: num("8.31432"),
+
+          # radius of the Earth (m)
+          radius: num("6356766"),
+
+          # adiabatic index (dimensionless)
+          k: num("1.4")
+        }
+
+        # 2.2 The equation of the static atmosphere and the perfect gas law
+        # Formula (2)
+        # M: air molar mass at sea level, kg.kmol-1
+        # Value given in 2.1 as M: 28.964720
+        @constants[:M] =
+          (@constants[:rho_n] * @constants[:R_star] * @constants[:T_n]) / @constants[:p_n]
+
+        # Formula (3)
+        # R: specific gas constant, J.K-1.kg-1.
+        # Value given in 2.1 as R: 287.05287
+        @constants[:R] = @constants[:R_star] / @constants[:M]
+
+        @sqrt2 = sqrt(num("2"))
+        @pi = @precision == :high ? BigMath.PI(100) : Math::PI
+      end
+    end
+
+    class HighPrecision < Algorithms
+      include Singleton
+
+      def initialize
+        set_precision(:high)
+      end
+    end
+
+    class NormalPrecision < Algorithms
+      include Singleton
+
+      def initialize
+        set_precision(:normal)
+      end
     end
   end
 end

data/lib/atmospheric/unit_value_float.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Atmospheric
+  class UnitValueFloat < Lutaml::Model::Serializable
+    attribute :value, :float
+    attribute :unitsml, :string
+    attribute :type, :string, default: -> { "float" }
+
+    key_value do
+      map "value", to: :value
+      map "unitsml", to: :unitsml
+      map "type", to: :type, render_default: true
+    end
+
+    xml do
+      root "unitl-value-float"
+      map_content to: :value
+      map_attribute :unitsml, to: :unitsml
+      map_attribute :type, to: :type, render_default: true
+    end
+  end
+end

data/lib/atmospheric/unit_value_integer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Atmospheric
+  class UnitValueInteger < Lutaml::Model::Serializable
+    attribute :value, :integer
+    attribute :unitsml, :string
+    attribute :type, :string, default: -> { "integer" }
+
+    key_value do
+      map "value", to: :value
+      map "unitsml", to: :unitsml
+      map "type", to: :type, render_default: true
+    end
+
+    xml do
+      root "unit-value-integer"
+      map_content to: :value
+      map_attribute :unitsml, to: :unitsml
+      map_attribute :type, to: :type, render_default: true
+    end
+  end
+end

data/lib/atmospheric/version.rb

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

data/lib/atmospheric.rb

@@ -3,6 +3,7 @@
 require_relative "atmospheric/version"
 require_relative "atmospheric/isa"
 require_relative "atmospheric/export"
+require "lutaml/model"
 
 module Atmospheric
   class Error < StandardError; end