atmospheris 0.5.1

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331975
+      class GroupThreeAttrs < Lutaml::Model::Serializable
+        include AltitudeConvertableModel
+
+        attribute :pressure_scale_heights, UnitValueFloat, collection: true
+        attribute :specific_weights, UnitValueFloat, collection: true
+        attribute :air_number_densities, UnitValueFloat, collection: true
+        attribute :mean_speeds, UnitValueFloat, collection: true
+        attribute :frequencies, UnitValueFloat, collection: true
+        attribute :mean_free_paths, UnitValueFloat, collection: true
+
+        key_value do
+          map "geometric-altitude", to: :geometric_altitudes
+          map "geopotential-altitude", to: :geopotential_altitudes
+          map "pressure-scale-height", to: :pressure_scale_heights
+          map "specific-weight", to: :specific_weights
+          map "air-number-density", to: :air_number_densities
+          map "mean-speed", to: :mean_speeds
+          map "frequency", to: :frequencies
+          map "mean-free-path", to: :mean_free_paths
+        end
+
+        # In meters only
+        def realize_values_from_geopotential(gp_h_m, precision: :reduced)
+          self.pressure_scale_heights = [
+            calculate(gp_h_m, :pressure_scale_height, precision: precision)
+          ]
+
+          self.specific_weights = [
+            calculate(gp_h_m, :specific_weight, precision: precision)
+          ]
+
+          self.air_number_densities = [
+            calculate(gp_h_m, :air_number_density, precision: precision)
+          ]
+
+          self.mean_speeds = [
+            calculate(gp_h_m, :mean_speed, precision: precision)
+          ]
+
+          self.frequencies = [
+            calculate(gp_h_m, :frequency, precision: precision)
+          ]
+
+          self.mean_free_paths = [
+            calculate(gp_h_m, :mean_free_path, precision: precision)
+          ]
+        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.pressure_scale_height_from_geopotential(gp_h_m)
+            UnitValueFloat.new(
+              value: precision == :reduced ? v.round(1) : v,
+              unitsml: "m"
+            )
+          when :specific_weight
+            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.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.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.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.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"
+            )
+          else
+            raise ArgumentError, "Unknown attribute: #{name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331975/group_two.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331975
+      class GroupTwo < AltitudeTable
+        attribute :by_geometric_altitude, GroupTwoAttrs, collection: true
+        attribute :by_geopotential_altitude, GroupTwoAttrs, collection: true
+
+        key_value do
+          map "by-geometric-altitude", to: :by_geometric_altitude
+          map "by-geopotential-altitude", to: :by_geopotential_altitude
+        end
+
+        def set_attrs(klass: GroupTwoAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331975
+      class GroupTwoAttrs < Lutaml::Model::Serializable
+        include AltitudeConvertableModel
+
+        attribute :ppns, UnitValueFloat, collection: true
+        attribute :rhorhons, UnitValueFloat, collection: true
+        attribute :sqrt_rhorhons, UnitValueFloat, collection: true
+        attribute :speeds_of_sound, UnitValueInteger, collection: true
+        attribute :dynamic_viscosities, UnitValueFloat, collection: true
+        attribute :kinematic_viscosities, UnitValueFloat, collection: true
+        attribute :thermal_conductivities, UnitValueFloat, collection: true
+
+        key_value do
+          map "geometric-altitude", to: :geometric_altitudes
+          map "geopotential-altitude", to: :geopotential_altitudes
+          map "ppn", to: :ppns
+          map "rhorhon", to: :rhorhons
+          map "sqrt-rhorhon", to: :sqrt_rhorhons
+          map "speed-of-sound", to: :speeds_of_sound
+          map "dynamic-viscosity", to: :dynamic_viscosities
+          map "kinematic-viscosity", to: :kinematic_viscosities
+          map "thermal-conductivity", to: :thermal_conductivities
+        end
+
+        # In meters only
+        def realize_values_from_geopotential(gp_h_m, precision: :reduced)
+          self.ppns = [
+            calculate(gp_h_m, :ppn, precision: precision)
+          ]
+
+          self.rhorhons = [
+            calculate(gp_h_m, :rhorhon, precision: precision)
+          ]
+
+          self.sqrt_rhorhons = [
+            calculate(gp_h_m, :sqrt_rhorhon, precision: precision)
+          ]
+
+          self.speeds_of_sound = [
+            calculate(gp_h_m, :speed_of_sound, precision: precision)
+          ]
+
+          self.dynamic_viscosities = [
+            calculate(gp_h_m, :dynamic_viscosity, precision: precision)
+          ]
+
+          self.kinematic_viscosities = [
+            calculate(gp_h_m, :kinematic_viscosity, precision: precision)
+          ]
+
+          self.thermal_conductivities = [
+            calculate(gp_h_m, :thermal_conductivity, precision: precision)
+          ]
+        end
+
+        def calculate(gp_h_m, name, precision: :reduced)
+          isa = precision == :high ? Isa::HighPrecision.instance : Isa::NormalPrecision.instance
+
+          case name
+          when :ppn
+            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.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.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.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.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.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.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"
+            )
+          else
+            raise ArgumentError, "Unknown attribute: #{name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331975.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331975
+      autoload :GroupOne, "atmospheris/export/iso_25331975/group_one"
+      autoload :GroupTwo, "atmospheris/export/iso_25331975/group_two"
+      autoload :GroupThree, "atmospheris/export/iso_25331975/group_three"
+      autoload :GroupOneAttrs, "atmospheris/export/iso_25331975/group_one_attrs"
+      autoload :GroupTwoAttrs, "atmospheris/export/iso_25331975/group_two_attrs"
+      autoload :GroupThreeAttrs, "atmospheris/export/iso_25331975/group_three_attrs"
+
+      class << self
+        def table_5
+          GroupOne.new.set_attrs
+        end
+
+        def table_6
+          GroupTwo.new.set_attrs
+        end
+
+        def table_7
+          GroupThree.new.set_attrs
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331985/pressure_attrs.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# The purpose of this class is to trim the attributes used in the ISO 2533:1985
+# standard.
+module Atmospheris
+  module Export
+    module Iso25331985
+      class PressureAttrs < ::Atmospheris::Export::PressureAttrs
+        key_value do
+          map "pressure", to: :pressures
+          map "geopotential-altitude", to: :geopotential_altitudes
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331985/table_five_six_attrs.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331985
+      class TableFiveSixAttrs < ::Atmospheris::Export::Iso25331975::GroupOneAttrs
+        # TODO: Completely override other attributes / key value mappings so
+        # they don't show in YAML
+        key_value do
+          map "geopotential-altitude", to: :geopotential_altitudes
+          map "pressure", to: :pressures
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331985.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331985
+      autoload :PressureAttrs, "atmospheris/export/iso_25331985/pressure_attrs"
+      autoload :TableFiveSixAttrs, "atmospheris/export/iso_25331985/table_five_six_attrs"
+
+      class TableOne < 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
+
+        attribute :rows, PressureAttrs, collection: true
+
+        def steps
+          (5.0..19.99).step(0.01).to_a.map { |v| v.round(2) }
+        end
+
+        def steps_unit
+          :mbar
+        end
+
+        def set_attrs(klass: PressureAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class TableTwo < HypsometricalTable
+        attribute :rows, PressureAttrs, collection: true
+
+        def steps
+          (20.0..1199.9).step(0.1).to_a.map { |v| v.round(1) }
+        end
+
+        def set_attrs(klass: PressureAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class TableThree < TableOne
+        attribute :rows, PressureAttrs, collection: true
+
+        def steps
+          (4.0..9.99).step(0.01).to_a.map { |v| v.round(2) }
+        end
+
+        def steps_unit
+          :mmhg
+        end
+
+        def set_attrs(klass: PressureAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class TableFour < TableTwo
+        attribute :rows, PressureAttrs, collection: true
+
+        def steps
+          (10.0..899.9).step(0.1).to_a.map { |v| v.round(1) }
+        end
+
+        def steps_unit
+          :mmhg
+        end
+
+        def set_attrs(klass: PressureAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class TableFiveSix < Iso25331975::GroupOne
+        def steps
+          (-1000..4599).step(1)
+        end
+
+        def set_attrs(klass: TableFiveSixAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class << self
+        def table_1
+          TableOne.new.set_attrs
+        end
+
+        def table_2
+          TableTwo.new.set_attrs
+        end
+
+        def table_3
+          TableThree.new.set_attrs
+        end
+
+        def table_4
+          TableFour.new.set_attrs
+        end
+
+        def table_56
+          TableFiveSix.new.set_attrs
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25331997.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25331997
+      module GroupBaseMeters
+        def steps
+          (-5000..2000).step(50)
+        end
+      end
+
+      class GroupOne < Iso25331975::GroupOne
+        include Iso25331997::GroupBaseMeters
+      end
+
+      class GroupTwo < Iso25331975::GroupTwo
+        include Iso25331997::GroupBaseMeters
+      end
+
+      class GroupThree < Iso25331975::GroupThree
+        include Iso25331997::GroupBaseMeters
+      end
+
+      module GroupBaseFeet
+        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 GroupFour < Iso25331975::GroupOne
+        include Iso25331997::GroupBaseFeet
+        def set_attrs(klass: Iso25331975::GroupOneAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class GroupFive < Iso25331975::GroupTwo
+        include Iso25331997::GroupBaseFeet
+        def set_attrs(klass: Iso25331975::GroupTwoAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class GroupSix < Iso25331975::GroupThree
+        include Iso25331997::GroupBaseFeet
+        def set_attrs(klass: Iso25331975::GroupThreeAttrs, unit: steps_unit, precision: :reduced)
+          super
+        end
+      end
+
+      class << self
+        def table_1
+          GroupOne.new.set_attrs
+        end
+
+        def table_2
+          GroupTwo.new.set_attrs
+        end
+
+        def table_3
+          GroupThree.new.set_attrs
+        end
+
+        def table_4
+          GroupFour.new.set_attrs
+        end
+
+        def table_5
+          GroupFive.new.set_attrs
+        end
+
+        def table_6
+          GroupSix.new.set_attrs
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25332025/altitude_attrs_group.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# The purpose of this class is really for XML grouping.
+# It is not a table in the same sense as the other tables.
+# It is a collection of attributes grouped by altitude type.
+# This class is used to group the attributes by altitude type
+# and to serialize them to XML.
+
+# The class is used in the CombinedAltitudeAttrsGroup class
+# and is not intended to be used directly.
+module Atmospheris
+  module Export
+    module Iso25332025
+      class AltitudeAttrsGroup < Lutaml::Model::Serializable
+        attribute :rows, AltitudeAttrs, collection: true
+
+        xml do
+          element "attributes-group"
+          namespace Atmospheris::Iso2533Namespace
+          map_element "atmospheris-attributes", to: :rows
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25332025/combined_altitude_attrs_group.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25332025
+      class CombinedAltitudeAttrsGroup < AltitudeTable
+        attribute :by_geometric_altitude, AltitudeAttrsGroup
+        attribute :by_geopotential_altitude, AltitudeAttrsGroup
+
+        key_value do
+          map "by-geometric-altitude", to: :by_geometric_altitude
+          map "by-geopotential-altitude", to: :by_geopotential_altitude
+        end
+
+        xml do
+          element "atmospheris"
+          namespace Atmospheris::Iso2533Namespace
+          map_element "by-geometric-altitude", to: :by_geometric_altitude
+          map_element "by-geopotential-altitude", to: :by_geopotential_altitude
+        end
+
+        def add_to_geometric(item)
+          by_geometric_altitude.rows << item
+        end
+
+        def add_to_geopotential(item)
+          by_geopotential_altitude.rows << item
+        end
+
+        def initialize_attrs
+          self.by_geometric_altitude = AltitudeAttrsGroup.new(rows: [])
+          self.by_geopotential_altitude = AltitudeAttrsGroup.new(rows: [])
+        end
+
+        def set_attrs(klass: AltitudeAttrs, unit: steps_unit, precision: :normal)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/iso_25332025.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  module Export
+    module Iso25332025
+      autoload :AltitudeAttrsGroup, "atmospheris/export/iso_25332025/altitude_attrs_group"
+      autoload :CombinedAltitudeAttrsGroup, "atmospheris/export/iso_25332025/combined_altitude_attrs_group"
+
+      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(precision: :reduced)
+          AltitudesInMeters.new.set_attrs(precision: precision)
+        end
+
+        def table_atmosphere_feet(precision: :reduced)
+          AltitudesInFeet.new.set_attrs(precision: precision)
+        end
+
+        def table_hypsometrical_altitude(precision: :reduced)
+          AltitudesForPressure.new.set_attrs(precision: precision)
+        end
+
+        def table_hypsometrical_mbar(precision: :reduced)
+          HypsometricalMbar.new.set_attrs(precision: precision)
+        end
+      end
+    end
+  end
+end

data/lib/atmospheris/export/precision_value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Atmospheris
+  class PrecisionValue < Lutaml::Model::Type::String
+    xml do
+      namespace Atmospheris::Iso2533Namespace
+    end
+  end
+end