Profile_Utility_Parameters.f90

Go to the documentation of this file.

!
! Profile_Utility_Parameters
!
! Module containing parameters used in the profile utility modules.
!
!
! CREATION HISTORY:
!       Written by:     Paul van Delst, 30-Aug-2002
!                       paul.vandelst@noaa.gov
!

MODULE profile_utility_parameters

  ! -----------------
  ! Environment setup
  ! -----------------
  ! Modules used
  USE type_kinds, ONLY: fp
  USE fundamental_constants, ONLY : na => avogadro_constant,    &
                                    r0 => molar_gas_constant,   &
                                    l0 => loschmidt_constant,   &
                                    p0 => standard_atmosphere,  &
                                    t0 => standard_temperature, &
                                    g0 => standard_gravity,     &
                                    pi
  ! Disable all implicit typing
  IMPLICIT NONE


  ! ------------
  ! Visibilities
  ! ------------
  ! Everything is default private
  PRIVATE
  ! Make renamed fundamental constants public
  PUBLIC :: na
  PUBLIC :: r0
  PUBLIC :: l0
  PUBLIC :: p0
  PUBLIC :: t0
  PUBLIC :: g0
  PUBLIC :: pi


  ! ---------------------
  ! Parameter definitions
  ! ---------------------

  ! Literal constants
  REAL(fp), PUBLIC, PARAMETER :: zero      = 0.0_fp
  REAL(fp), PUBLIC, PARAMETER :: one       = 1.0_fp
  REAL(fp), PUBLIC, PARAMETER :: two       = 2.0_fp
  REAL(fp), PUBLIC, PARAMETER :: hundred   = 100.0_fp

  ! Precision... ~EPSILON(ONE) for double precision.
  REAL(fp), PUBLIC, PARAMETER :: tolerance = 2.0e-16_fp

  ! Conversion factors
  REAL(fp), PUBLIC, PARAMETER :: celsius_to_kelvin = t0
  REAL(fp), PUBLIC, PARAMETER :: g_to_kg           = 1.0e-03_fp
  REAL(fp), PUBLIC, PARAMETER :: kg_to_g           = 1.0e+03_fp
  REAL(fp), PUBLIC, PARAMETER :: pa_to_hpa         = 1.0e-02_fp
  REAL(fp), PUBLIC, PARAMETER :: hpa_to_pa         = 1.0e+02_fp
  REAL(fp), PUBLIC, PARAMETER :: ppmv_to_ppv       = 1.0e-06_fp
  REAL(fp), PUBLIC, PARAMETER :: ppv_to_ppmv       = 1.0e+06_fp
  REAL(fp), PUBLIC, PARAMETER :: cm_to_m           = 1.0e-02_fp
  REAL(fp), PUBLIC, PARAMETER :: m_to_cm           = 1.0e+02_fp
  REAL(fp), PUBLIC, PARAMETER :: from_percent      = 1.0e-02_fp
  REAL(fp), PUBLIC, PARAMETER :: to_percent        = 1.0e+02_fp

  ! Number of units specifiers. Same as for LBLRTM
  INTEGER, PUBLIC, PARAMETER :: n_absorber_units = 8

  ! Units specifiers. Same as for LBLRTM
  INTEGER, PUBLIC, PARAMETER :: invalid_units = 0  ! Invalid
  INTEGER, PUBLIC, PARAMETER :: ppmv_units    = 1  ! Volume mixing ratio (ppmv)
  INTEGER, PUBLIC, PARAMETER :: nd_units      = 2  ! Number density      (cm^-3)
  INTEGER, PUBLIC, PARAMETER :: mr_units      = 3  ! Mass mixing ratio   (g/kg)
  INTEGER, PUBLIC, PARAMETER :: md_units      = 4  ! Mass density        (g.m^-3)
  INTEGER, PUBLIC, PARAMETER :: pp_units      = 5  ! Partial pressure    (hPa)
  INTEGER, PUBLIC, PARAMETER :: dpk_units     = 6  ! Dew point           (Kelvin)  [H2O only]
  INTEGER, PUBLIC, PARAMETER :: dpc_units     = 7  ! Dew point           (Celsius) [H2O only]
  INTEGER, PUBLIC, PARAMETER :: rh_units      = 8  ! Relative humidity   (%)       [H2O only]

  INTEGER, PUBLIC, PARAMETER :: absorber_units_id(0:n_absorber_units) = &
    (/ invalid_units, &
       ppmv_units   , &
       nd_units     , &
       mr_units     , &
       md_units     , &
       pp_units     , &
       dpk_units    , &  ! [H2O only]
       dpc_units    , &  ! [H2O only]
       rh_units      /)  ! [H2O only]
  CHARACTER(*), PUBLIC, PARAMETER :: absorber_units_name(0:n_absorber_units) = &
    (/ 'Invalid', &
       'ppmv   ', &
       'cm^-3  ', &
       'g/kg   ', &
       'g.m^-3 ', &
       'hPa    ', &
       'DP, K  ', &  ! [H2O only]
       'DP, C  ', &  ! [H2O only]
       'RH, %  ' /)  ! [H2O only]
  CHARACTER(*), PUBLIC, PARAMETER :: absorber_units_char(0:n_absorber_units) = &
    (/ '-', &
       'A', &
       'B', &
       'C', &
       'D', &
       'E', &
       'F', &  ! [H2O only]
       'G', &  ! [H2O only]
       'H' /)  ! [H2O only]

  ! Maximum number of molecular species (as for HITRAN)
  INTEGER, PUBLIC, PARAMETER :: max_n_molecular_species = 32

  ! HITRAN molecular IDs and symbols
  INTEGER, PUBLIC, PARAMETER :: id_h2o   = 1
  INTEGER, PUBLIC, PARAMETER :: id_co2   = 2
  INTEGER, PUBLIC, PARAMETER :: id_o3    = 3
  INTEGER, PUBLIC, PARAMETER :: id_n2o   = 4
  INTEGER, PUBLIC, PARAMETER :: id_co    = 5
  INTEGER, PUBLIC, PARAMETER :: id_ch4   = 6
  INTEGER, PUBLIC, PARAMETER :: id_o2    = 7

  INTEGER, PUBLIC, PARAMETER :: id_no    = 8
  INTEGER, PUBLIC, PARAMETER :: id_so2   = 9
  INTEGER, PUBLIC, PARAMETER :: id_no2   = 10
  INTEGER, PUBLIC, PARAMETER :: id_nh3   = 11
  INTEGER, PUBLIC, PARAMETER :: id_hno3  = 12
  INTEGER, PUBLIC, PARAMETER :: id_oh    = 13
  INTEGER, PUBLIC, PARAMETER :: id_hf    = 14

  INTEGER, PUBLIC, PARAMETER :: id_hcl   = 15
  INTEGER, PUBLIC, PARAMETER :: id_hbr   = 16
  INTEGER, PUBLIC, PARAMETER :: id_hi    = 17
  INTEGER, PUBLIC, PARAMETER :: id_clo   = 18
  INTEGER, PUBLIC, PARAMETER :: id_ocs   = 19
  INTEGER, PUBLIC, PARAMETER :: id_h2co  = 20
  INTEGER, PUBLIC, PARAMETER :: id_hocl  = 21

  INTEGER, PUBLIC, PARAMETER :: id_n2    = 22
  INTEGER, PUBLIC, PARAMETER :: id_hcn   = 23
  INTEGER, PUBLIC, PARAMETER :: id_ch3cl = 24
  INTEGER, PUBLIC, PARAMETER :: id_h2o2  = 25
  INTEGER, PUBLIC, PARAMETER :: id_c2h2  = 26
  INTEGER, PUBLIC, PARAMETER :: id_c2h6  = 27
  INTEGER, PUBLIC, PARAMETER :: id_ph3   = 28

  INTEGER, PUBLIC, PARAMETER :: id_cof2  = 29
  INTEGER, PUBLIC, PARAMETER :: id_sf6   = 30
  INTEGER, PUBLIC, PARAMETER :: id_h2s   = 31
  INTEGER, PUBLIC, PARAMETER :: id_hcooh = 32

  CHARACTER(*), PUBLIC, PARAMETER :: molecular_symbol(max_n_molecular_species) = &
      (/ 'H2O  ','CO2  ','O3   ','N2O  ', &
         'CO   ','CH4  ','O2   ','NO   ', &
         'SO2  ','NO2  ','NH3  ','HNO3 ', &
         'OH   ','HF   ','HCL  ','HBR  ', &
         'HI   ','CLO  ','OCS  ','H2CO ', &
         'HOCL ','N2   ','HCN  ','CH3CL', &
         'H2O2 ','C2H2 ','C2H6 ','PH3  ', &
         'COF2 ','SF6  ','H2S  ','HCOOH' /)


  ! Molecular weights of first seven HITRAN molecular species
  REAL(fp), PUBLIC, PARAMETER :: mw_h2o = 18.01528_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_co2 = 44.00950_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_o3  = 47.99820_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_n2o = 44.01288_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_co  = 28.01010_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_ch4 = 16.04246_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_o2  = 31.99880_fp
  REAL(fp), PUBLIC, PARAMETER :: mw_n2  = 28.01348_fp

  ! Weights of all 32 HITRAN molecular species
  REAL(fp), PUBLIC, PARAMETER :: molecular_weight(max_n_molecular_species) = &
    (/       mw_h2o,        mw_co2,         mw_o3,        mw_n2o, &
             mw_co ,        mw_ch4,         mw_o2,   30.00614_fp, &
        64.06480_fp,   46.00554_fp,   17.03056_fp,   63.01288_fp, &
        17.00734_fp,   20.00634_fp,   36.46064_fp,   80.91194_fp, &
       127.91241_fp,   51.45210_fp,   60.07610_fp,   30.02598_fp, &
        52.46004_fp,        mw_n2 ,   27.02538_fp,   50.48722_fp, &
        34.01468_fp,   26.03728_fp,   30.06904_fp,   33.99758_fp, &
        66.00690_fp,  146.05643_fp,   34.08188_fp,   46.02538_fp /)

  ! Average molecular weight of dry air
  REAL(fp), PUBLIC, PARAMETER :: mw_dryair = 28.9648_fp

  ! Ratio of water vapor and dry air weights for conversion routines
  REAL(fp), PUBLIC, PARAMETER :: eps       = mw_h2o / mw_dryair

  ! Gas constant for dry air. Units are J.K-1.kg-1
  REAL(fp), PUBLIC, PARAMETER :: r_dryair  = r0 / ( mw_dryair * g_to_kg )

  ! Specific heat of dry air. Units are J.K-1.kg-1
  REAL(fp), PUBLIC, PARAMETER :: cp_dryair = ( 7.0_fp/two ) * r_dryair

END MODULE profile_utility_parameters