climt.HeldSuarez

class climt.HeldSuarez(sigma_boundary_layer_top=0.7, k_f=1.1574074074074073e-05, k_a=2.8935185185185185e-07, k_s=2.8935185185185184e-06, equator_pole_temperature_difference=60, delta_theta_z=10, **kwargs)[source]

Provide the Held-Suarez forcing.

Produces the forcings proposed by Held and Suarez for the intercomparison of dynamical cores of AGCMs. Relaxes the temperature field to a zonally symmetric equilibrium state, and uses Rayleigh damping of low-level winds to represent boundary-layer friction. Details can be found in [Held and Suarez (1994)].

References

Held, I. and M. Suarez, 1994:
A Proposal for the Intercomparison of the Dynamical Cores of Atmospheric General Circulation Models. Bull. Amer. Meteor. Soc., 75, 1825-1830, doi: 10.1175/1520-0477(1994)075<1825:APFTIO>2.0.CO;2.
__init__(sigma_boundary_layer_top=0.7, k_f=1.1574074074074073e-05, k_a=2.8935185185185185e-07, k_s=2.8935185185185184e-06, equator_pole_temperature_difference=60, delta_theta_z=10, **kwargs)[source]
Parameters:
  • sigma_boundary_layer_top (float) – The height of the boundary layer top in sigma coordinates. Corresponds to $sigma_b$ in Held and Suarez, 1994. Default is 0.7.
  • k_f (float) – Velocity damping coefficient at the surface in \(s^{-1}\). Default is \(1\ day^{-1}\).
  • k_a (float) – Parameter used in defining vertical profile of the temperature damping in \(s^{-1}\), as outlined in Held and Suarez, 1994. Default is \(1/40\ day^{-1}\).
  • k_s (float) – Parameter used in defining vertical profile of the temperature damping in \(s^{-1}\), as outlined in Held and Suarez, 1994. Default is \(1/4\ day^{-1}\).
  • equator_pole_temperature_difference (float) – Equator to pole temperature difference, in K. Default is 60K.
  • delta_theta_z (float) – Parameter used in defining the equilibrium temperature profile as outlined in Held and Suarez, 1994, in K. Default is 10K.

Methods

__init__([sigma_boundary_layer_top, k_f, …])
param sigma_boundary_layer_top:
 The height of the boundary
array_call(raw_state) Get the Held-Suarez forcing tendencies

Attributes

diagnostic_properties
input_properties
name
tendencies_in_diagnostics
tendency_properties
tracer_tendency_time_unit
uses_tracers