climt.RRTMGShortwave

class climt.RRTMGShortwave(cloud_overlap_method=None, cloud_optical_properties='liquid_and_ice_clouds', cloud_ice_properties='ebert_curry_two', cloud_liquid_water_properties='radius_dependent_absorption', solar_variability_method=0, use_solar_constant_from_fortran=False, ignore_day_of_year=False, facular_sunspot_amplitude=None, solar_variability_by_band=None, aerosol_type='no_aerosol', mcica=False, random_number_generator='mersenne_twister', **kwargs)[source]

The Rapid Radiative Transfer Model (RRTMG).

This module wraps RRTMG for shortwave radiation (i.e, emission from the sun).

__init__(cloud_overlap_method=None, cloud_optical_properties='liquid_and_ice_clouds', cloud_ice_properties='ebert_curry_two', cloud_liquid_water_properties='radius_dependent_absorption', solar_variability_method=0, use_solar_constant_from_fortran=False, ignore_day_of_year=False, facular_sunspot_amplitude=None, solar_variability_by_band=None, aerosol_type='no_aerosol', mcica=False, random_number_generator='mersenne_twister', **kwargs)[source]
Parameters:
  • cloud_overlap_method (int) –

    Choose the method to do overlap with:

    • ’clear_only’ = Clear only (no clouds)
    • ’random’ = Random
    • ’maximum_random’ = Maximum/Random
    • ’maximum’ = Maximum.
  • cloud_optical_properties (string) –

    Choose how cloud optical properties are calculated:

    • direct_input = Cloud fraction, cloud optical depth, single scattering albedo, cloud asymmetry parameter and cloud forward scattering fraction are input. Cloud forward scattering fraction is used to scale the optical depth, single scattering albedo and asymmetry parameter. The latter three parameters are then used in the radiative transfer calculations. Other cloud properties (ie cloud particle size) are irrelevant.
    • single_cloud_type = Cloud fraction and cloud physical properties are input, ice and liquid clouds are treated together, cloud absorptivity is a constant value (0.060241). Not available with McICA.
    • liquid_and_ice_clouds = Cloud fraction and cloud physical properties are input, ice and liquid clouds are treated separately. Cloud optical depth, single scattering albedo and cloud asymmetry parameter are calculated from the cloud ice and water particle sizes and the mass content of cloud ice and cloud water.
  • cloud_ice_properties (string) –

    set bounds on ice particle size. This is not used if ‘cloud_optical_properties’ == ‘direct_input’.

    • ebert_curry_one = ice particle has effective radius >= 10.0 micron [Ebert and Curry 1992] Not available with McICA.
    • ebert_curry_two = ice particle has effective radius between 13.0 and 130.0 micron [Ebert and Curry 1992]
    • key_streamer_manual = ice particle has effective radius between 5.0 and 131.0 micron [Key, Streamer Ref. Manual, 1996]
    • fu = ice particle has generalised effective size (dge) between 5.0 and 140.0 micron [Fu, 1996]. (dge = 1.0315 * r_ec)

    Default value is 0.

  • cloud_liquid_water_properties (string) –

    set treatment of cloud liquid water. This is not used if ‘cloud_optical_properties’ == ‘direct_input’.

    • radius_independent_absorption = use radius independent absorption coefficient Not available with McICA.
    • radius_dependent_absorption = use radius dependent absorption coefficient (radius between 2.5 and 60 micron)
  • solar_variability_method (int) –

    set the solar variability model used by RRTMG.

    • solar_variability_method = -1:
      • If use_solar_constant_from_fortran = True: No solar variability and no solar cycle with a solar constant of 1368.22 \(W m^{-2}\).
      • If use_solar_constant_from_fortran = False: Solar variability defined by setting non-zero scale factors in solar_variability_by_band.
    • solar_variability_method = 0:
      • If use_solar_constant_from_fortran = True: No solar variability and no solar cycle with a solar constant of 1360.85 \(W m^{-2}\), with facular and sunspot effects fixed to the mean of solar cycles 13-24.
      • If use_solar_constant_from_fortran = False: No solar variability and no solar cycle.
    • solar_variability_method = 1: Solar variability using the NRLSSI2 solar model with solar cycle contribution determined by solar_cycle_fraction in the model state, and facular and sunspot adjustment scale factors specified in facular_sunspot_amplitude.
    • solar_variability_method = 2: Solar variability using the NRLSSI2 solar model using solar cycle determined by direct specification of Mg (facular) and SB (sunspot) indices provided in facular_sunspot_amplitude. solar_constant is ignored.
    • solar_variability_method = 3:
    • If use_internal_solar_constant = True: No solar variability and no solar cycle with a solar constant of 1360.85 \(W m^{-2}\).
    • If use_internal_solar_constant = False: scale factors in solar_variability_by_band.
  • use_solar_constant_from_fortran (bool) – If False, the solar constant is taken from the constants library. The default value is False.
  • ignore_day_of_year (bool) – If True, the solar output does not vary by day of year (i.e, higher close to the solstices and lesser close to the equinoxes). Default value is False.
  • facular_sunspot_amplitude (array of dimension 2) – Facular and Sunspot amplitude variability parameters, described previously.
  • solar_variability_by_band (array of dimension 14 = number of spectral bands) – scale factors for solar variability in all spectral bands.
  • aerosol_type (string) –

    Type of aerosol inputs to RRTMG.

    • no_aerosol: No Aerosol.
    • ecmwf: ECMWF method. Requires aerosol optical depth at 55 micron as the state quantity aerosol_optical_depth_at_55_micron.
    • all_aerosol_properties: Input all aerosol optical properties.
  • mcica (bool) –
    • mcica = True: use the McICA version for the shortwave component of RRTMG
    • mcica = False: use the nomcica version for the shortwave component of RRTMG
  • random_number_generator (string) – Different methods of generating random numbers for McICA. * kissvec * mersenne_twister

Methods

__init__([cloud_overlap_method, …])
param cloud_overlap_method:
 Choose the method to do overlap with:
array_call(state) Get heating tendencies and shortwave fluxes.

Attributes

diagnostic_properties
input_properties
name
num_ecmwf_aerosols
num_reduced_g_intervals
num_shortwave_bands
rrtm_iplon
tendencies_in_diagnostics
tendency_properties
tracer_tendency_time_unit
uses_tracers