atmospheric 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91653cc446f211fbec67bb75c9ca04fb3135e24bb7d1e1e52707e865508285d5
+  data.tar.gz: c7cb3677f1d0d1c896815a6607241a58b2649bc43313efc270ce8d124ddf44e7
+SHA512:
+  metadata.gz: f8233e299548737ac029e652c50effc3a94fccc83bf1038295429242f9554da545c0c9abdc8c57638da3abf5e91535ec29d01c9cb3e8d978c4d05411d9b30a6c
+  data.tar.gz: a8c034abf9efec7b006e9be2d22119083f2d46fbacda5b2592e6d0fcc1fd657e9d1894dcb5e0ec0b81ac07268be51baa29ee3d8e8d2c8f31a26bd0adb1b3330e

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,97 @@
+= Atmospheric for Ruby (International Standard Atmosphere / ICAO Standard Atmosphere (ISA))
+
+== Purpose
+
+This repository provides Ruby code for calculating values defined in the
+following documents:
+
+* International Standard Atmosphere (ISA) from ISO 2533:1975
+* ICAO Standard Atmosphere (ICAO Doc 7488/3, 1994)
+
+Which are technically identical documents but different in presentation and
+units (the ICAO document includes `ft` in addition to `m`).
+
+== Usage
+
+[source,ruby]
+----
+> require 'atmospheric'
+> instance = Atmospheric::Isa.method_name
+> # method_name is one of the following
+----
+
+The available methods are:
+
+* `geometric_altitude_from_geopotential(geopotential_altitude)`
+* `geopotential_altitude_from_geometric(geometric_altitude)`
+* `temperature_at_layer_from_H(geopotential_altitude)`
+* `temperature_at_layer_celcius(geopotential_altitude)`
+* `pressure_from_H_mbar(geopotential_altitude)`
+* `pressure_from_H_mmhg(geopotential_altitude)`
+* `density_from_H(geopotential_altitude)`
+* `gravity_at_geopotential(geopotential_altitude)`
+* `p_p_n_from_H(geopotential_altitude)`
+* `rho_rho_n_from_H(geopotential_altitude)`
+* `root_rho_rho_n_from_H(geopotential_altitude)`
+* `speed_of_sound_from_H(geopotential_altitude)`
+* `dynamic_viscosity_from_H(geopotential_altitude)`
+* `kinematic_viscosity_from_H(geopotential_altitude)`
+* `thermal_conductivity_from_H(geopotential_altitude)`
+* `pressure_scale_height_from_H(geopotential_altitude)`
+* `specific_weight_from_H(geopotential_altitude)`
+* `air_number_density_from_H(geopotential_altitude)`
+* `mean_air_particle_speed_from_H(geopotential_altitude)`
+* `air_particle_collision_frequency_from_H(geopotential_altitude)`
+* `mean_free_path_of_air_particles_from_H(geopotential_altitude)`
+
+
+== Testing
+
+[source,sh]
+----
+$ rspec
+----
+
+Tests are encoded in `spec/fixtures/tests.yml` in the following format:
+
+[source,yml]
+----
+- H: -2000.0
+  h: -1999.0
+  TK: 301.15
+  TC: 28.0
+  p_mbar: 1277.74
+  p_mmhg: 958.382
+  rho: 1.47808
+  g: 9.8128
+  p_p_n: 1.26103
+  rho_rho_n: 1.20659
+  root_rho_rho_n: 1.09845
+  a: 347.886
+  mu: 1.8514e-05
+  v: 1.2526e-05
+  lambda: 0.026359
+  H_p: 8809.5
+  gamma: 14.504
+  n: 3.0734e+25
+  v_bar: 469.18
+  omega: 8535100000.0
+  l: 549710000.0
+----
+
+Each of these values are associated with a cell in the tables of the source
+documents.
+
+The only defining value in a tests is `H` (geopotential altitude).
+It is used to generate all the other values.
+
+
+== License
+
+Copyright Ribose and its respective owners.
+
+
+== TODO
+
+* make into module
+* expose this as a plugin to LutaML / Metanorma YAML2text

data/lib/atmospheric/isa.rb

@@ -0,0 +1,350 @@
+module Atmospheric
+  module Isa
+    # International Standard Atmosphere (ISA) (ISO 2533:1975)
+    # ICAO Standard Atmosphere (ICAO Doc 7488/3, 1994)
+
+    # 2.1 Primary constants and characteristics
+    # Table 1 - Main constants and characteristics adopted for
+    #           the calculation of the ISO Standard Atmosphere
+    CONST = {
+      g_n: 9.80665, # m.s-2
+      N_A: 602.257e21, # Avogadro constant, mol-1
+      p_n: 101325, # In Pascal
+      rho_n: 1.225, # rho_n standard air density
+      T_n: 288.15, # T_n standard thermodynamic air temperature at mean sea level
+      R_star: 8.31432, # universal gas constant
+
+      radius: 6356766, # radius of the Earth (m)
+      k: 1.4 # adiabatic index, dimensionless
+    }
+
+    # 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
+    CONST[:M] = (CONST[:rho_n] * CONST[:R_star] * CONST[:T_n]) / CONST[:p_n]
+
+    # Formula (3)
+    # R: specific gas constant, J.K-1.kg-1.
+    # Value given in 2.1 as R: 287.05287
+    CONST[:R] = CONST[:R_star] / CONST[:M]
+
+
+    class << self
+      # 2.3 Geopotential and geometric altitides; acceleration of free fall
+
+      # 2.3 Formula (8)
+      # H to h
+      # h(m)
+      def geometric_altitude_from_geopotential(geopotential_alt)
+        CONST[:radius] * geopotential_alt / (CONST[:radius] - geopotential_alt)
+      end
+
+      # 2.3 Formula (9)
+      # h to H
+      # H(m)
+      def geopotential_altitude_from_geometric(geometric_alt)
+        CONST[:radius] * geometric_alt / (CONST[:radius] + geometric_alt)
+      end
+
+      # 2.3 Formula (7)
+      # g(h)
+      def gravity_at_geometric(geometric_alt)
+        temp = CONST[:radius] / (CONST[:radius] + geometric_alt)
+        CONST[:g_n] * temp * temp
+      end
+
+      def gravity_at_geopotential(geopotential_alt)
+        geometric_h = geometric_altitude_from_geopotential(geopotential_alt)
+        gravity_at_geometric(geometric_h)
+      end
+
+      # 2.4 Atmospheric composition and air molar mass
+
+      # 2.5 Physical characteristics of the atmosphere at mean sea level
+
+      # 2.6 Temperature and vertical temperature gradient
+
+      # Formula (11)
+      # T
+      def temperature_at_layer_from_H(geopotential_alt)
+        lower_layer_index = locate_lower_layer(geopotential_alt)
+        lower_layer = TEMPERATURE_LAYERS[lower_layer_index]
+        beta = lower_layer[:B]
+        capital_t_b = lower_layer[:T]
+        capital_h_b = lower_layer[:H]
+
+        capital_t_b + (beta * (geopotential_alt - capital_h_b))
+      end
+
+      def temperature_at_layer_celcius(geopotential_alt)
+        kelvin_to_celsius(temperature_at_layer_from_H(geopotential_alt))
+      end
+
+      def locate_lower_layer(geopotential_alt)
+        # Return first layer if lower than lowest
+        return 0 if geopotential_alt < TEMPERATURE_LAYERS[0][:H]
+
+        # Return second last layer if beyond last layer
+        i = TEMPERATURE_LAYERS.length - 1
+        return i - 1 if geopotential_alt >= TEMPERATURE_LAYERS[i][:H]
+
+        # find last layer with H larger than our H
+        TEMPERATURE_LAYERS.each_with_index do |layer, i|
+          return i if layer[:H] > geopotential_alt
+        end
+
+        nil
+      end
+
+      # Table 4 - Temperature and vertical temperature gradients
+      #
+      TEMPERATURE_LAYERS = [
+        # H is Geopotential altitude (base altitude) above mean sea level, m
+        # T is Temperature, K
+        # B is Temperature gradient, "beta", K m^-1
+
+        # This line is from ICAO 7488/3
+        # [H: -5000, T: 320.65, B: -0.0065 ],
+
+        # This line is from ISO 2533:1975
+        {H: -2000, T: 301.15, B: -0.0065 },
+        {H: 0,     T: 288.15, B: -0.0065 },
+        {H: 11000, T: 216.65, B: 0       },
+        {H: 20000, T: 216.65, B: 0.001   },
+        {H: 32000, T: 228.65, B: 0.0028  },
+        {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},
+      ]
+
+
+      # 2.7 Pressure
+
+      # Base pressure values given defined `TEMPERATURE_LAYERS` and constants
+      def pressure_layers
+        return @pressure_layers if @pressure_layers
+
+        # assuming TEMPERATURE_LAYERS index 1 base altitude is zero (mean sea level)
+        p = []
+
+        TEMPERATURE_LAYERS.each_with_index do |x, i|
+          last_i = (i == 0) ? 0 : i - 1
+          last_layer = TEMPERATURE_LAYERS[last_i]
+          beta = last_layer[:B]
+
+          if last_layer[:H] <= 0
+            pb = CONST[:p_n]
+            capital_h_b = 0
+            capital_t_b = CONST[:T_n]
+          else
+            pb = p[last_i]
+            capital_h_b = last_layer[:H]
+            capital_t_b = last_layer[:T]
+          end
+
+          current_layer = TEMPERATURE_LAYERS[i]
+          geopotential_alt = current_layer[:H]
+          temp = current_layer[:T]
+
+          p[i] = if beta != 0
+            # Formula (12)
+            pb * (1 + ((beta / capital_t_b) * (geopotential_alt - capital_h_b))) ** (-CONST[:g_n] / (beta * CONST[:R]))
+          else
+            # Formula (13)
+            pb * Math.exp(-(CONST[:g_n] / (CONST[:R] * temp)) * (geopotential_alt - capital_h_b))
+          end
+        end
+
+        @pressure_layers = p
+      end
+
+      # puts "PRE-CALCULATED PRESSURE LAYERS:"
+      # pp @pressure_layers
+
+      def pa_to_mmhg(pascal)
+        pascal * 0.007500616827
+      end
+
+      def pa_to_mbar(pascal)
+        pascal * 0.01
+      end
+
+      # Pressure for a given geopotential altitude `H` (m) above mean sea level
+      def pressure_from_H(geopotential_alt)
+        i = locate_lower_layer(geopotential_alt)
+        lower_temperature_layer = TEMPERATURE_LAYERS[i]
+        beta = lower_temperature_layer[:B]
+        capital_h_b = lower_temperature_layer[:H]
+        capital_t_b = lower_temperature_layer[:T]
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        pb = pressure_layers[i]
+
+        if beta != 0
+          # Formula (12)
+          pb * (1 + ((beta / capital_t_b) * (geopotential_alt - capital_h_b))) ** (-CONST[:g_n] / (beta * CONST[:R]))
+        else
+          # Formula (13)
+          pb * Math.exp(-(CONST[:g_n] / (CONST[:R] * temp)) * (geopotential_alt - capital_h_b))
+        end
+      end
+
+      def pressure_from_H_mbar(geopotential_alt)
+        pa_to_mbar(pressure_from_H(geopotential_alt))
+      end
+
+      def pressure_from_H_mmhg(geopotential_alt)
+        pa_to_mmhg(pressure_from_H(geopotential_alt))
+      end
+
+      def p_p_n_from_H(geopotential_alt)
+        pressure_from_H(geopotential_alt) / CONST[:p_n]
+      end
+
+      # 2.8 Density and specific weight
+
+      # Calculate density for a given geopotential altitude `H` (m) above mean sea level
+      # Formula (14)
+      # rho
+      def density_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        p = pressure_from_H(geopotential_alt)
+
+        p / (CONST[:R] * temp)
+      end
+
+      def rho_rho_n_from_H(geopotential_alt)
+        density_from_H(geopotential_alt) / CONST[:rho_n]
+      end
+
+      def root_rho_rho_n_from_H(geopotential_alt)
+        Math.sqrt(rho_rho_n_from_H(geopotential_alt))
+      end
+
+
+      # Specific weight
+      # Formula (15)
+      # gamma
+      def specific_weight_from_H(geopotential_alt)
+        density_from_H(geopotential_alt) * gravity_at_geopotential(geopotential_alt)
+      end
+
+      # 2.9 Pressure scale height
+      # Formula (16)
+      # H_p
+      def pressure_scale_height_from_temp(temp)
+        (CONST[:R] * temp) / CONST[:g_n]
+      end
+
+      def pressure_scale_height_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        (CONST[:R] * temp) / gravity_at_geopotential(geopotential_alt)
+      end
+
+      # 2.10 Air number density
+      # Formula (17)
+      # n
+      def air_number_density_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        p = pressure_from_H(geopotential_alt)
+
+        CONST[:N_A] * p / (CONST[:R_star] * temp)
+      end
+
+      # 2.11 Mean air-particle speed
+      # Formula (18)
+      # v_bar
+      # CORRECT
+      def mean_air_particle_speed_from_temp(temp)
+        1.595769 * Math.sqrt(CONST[:R] * temp)
+      end
+
+      def mean_air_particle_speed_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        mean_air_particle_speed_from_temp(temp)
+      end
+
+      # 2.12 Mean free path of air particles
+      # Formula (19)
+      # l
+      def mean_free_path_of_air_particles_from_H(geopotential_alt)
+        1 / (1.414213562 * 3.141592654 * (0.365e-9 ** 2) * air_number_density_from_H(geopotential_alt))
+      end
+
+      # 2.13 Air-particle collision frequency
+      # Formula (20)
+      # omega
+      def air_particle_collision_frequency_from_temp(n, temp)
+        4 * (0.365e-9 ** 2) * ((3.141592654 / (CONST[:R_star] * CONST[:M])) ** 0.5) * n * CONST[:R_star] * (temp ** 0.5)
+      end
+
+      def air_particle_collision_frequency_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        n = air_number_density_from_H(geopotential_alt)
+        air_particle_collision_frequency_from_temp(n, temp)
+      end
+
+      # 2.14 Speed of sound
+      # Formula (21)
+      # a (ms-1)
+      # CORRECT
+      def speed_of_sound_from_temp(temp)
+        # `kappa` (ratio of c_p / c_v) = 1.4 (see 2.14)
+        kappa = 1.4
+        Math.sqrt(kappa * CONST[:R] * temp)
+      end
+
+      def speed_of_sound_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        speed_of_sound_from_temp(temp)
+      end
+
+
+      # 2.15 Dynamic viscosity
+      # Formula (22)
+      # mu (Pa s)
+      def dynamic_viscosity(temp)
+        # Sutherland's empirical constants in the equation for dynamic viscosity
+        capital_b_s = 1.458e-6
+        capital_s = 110.4
+
+        (capital_b_s * (temp ** (1.5))) / (temp + capital_s)
+      end
+
+      def dynamic_viscosity_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        dynamic_viscosity(temp)
+      end
+
+      # 2.16 Kinematic viscosity
+      # Formula (23)
+      # v
+      def kinematic_viscosity(temp)
+        dynamic_viscosity(temp) / CONST[:rho_n]
+      end
+
+      def kinematic_viscosity_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        dynamic_viscosity(temp) / density_from_H(geopotential_alt)
+      end
+
+      # 2.17 Thermal conductivity
+      # Formula (24)
+      # lambda
+      def thermal_conductivity_from_temp(temp)
+        (2.648151e-3 * (temp ** (1.5))) / (temp + (245.4 * (10 ** (-12.0/temp))))
+      end
+
+      def thermal_conductivity_from_H(geopotential_alt)
+        temp = temperature_at_layer_from_H(geopotential_alt)
+        thermal_conductivity_from_temp(temp)
+      end
+
+      def kelvin_to_celsius(kelvin)
+        kelvin - 273.15
+      end
+
+    end
+  end
+end

data/lib/atmospheric/version.rb

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

data/lib/atmospheric.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "atmospheric/version"
+require_relative "atmospheric/isa"
+
+module Atmospheric
+  class Error < StandardError; end
+  # Your code goes here...
+end