MOM6
meso_surface_forcing::meso_surface_forcing_cs Type Reference

Detailed Description

This control structure is used to store parameters associated with the MESO forcing.

Definition at line 26 of file MESO_surface_forcing.F90.

Collaboration diagram for meso_surface_forcing::meso_surface_forcing_cs:
[legend]

Public variables and constants

logical use_temperature
 If true, temperature and salinity are used as state variables. More...
 
logical restorebuoy
 If true, use restoring surface buoyancy forcing. More...
 
real rho0
 The density used in the Boussinesq approximation [R ~> kg m-3]. More...
 
real g_earth
 The gravitational acceleration [L2 Z-1 T-2 ~> m s-2]. More...
 
real flux_const
 The restoring rate at the surface [Z T-1 ~> m s-1]. More...
 
real gust_const
 A constant unresolved background gustiness that contributes to ustar [Pa]. More...
 
real, dimension(:,:), pointer t_restore => NULL()
 The temperature to restore the SST toward [degC]. More...
 
real, dimension(:,:), pointer s_restore => NULL()
 The salinity to restore the sea surface salnity toward [ppt]. More...
 
real, dimension(:,:), pointer pme => NULL()
 The prescribed precip minus evap [m s-1]. More...
 
real, dimension(:,:), pointer solar => NULL()
 The shortwave forcing into the ocean [W m-2]. More...
 
real, dimension(:,:), pointer heat => NULL()
 The prescribed longwave, latent and sensible heat flux into the ocean [W m-2]. More...
 
character(len=200) inputdir
 The directory where NetCDF input files are. More...
 
character(len=200) salinityrestore_file
 The file with the target sea surface salinity. More...
 
character(len=200) sstrestore_file
 The file with the target sea surface temperature. More...
 
character(len=200) solar_file
 The file with the shortwave forcing. More...
 
character(len=200) heating_file
 The file with the longwave, latent, and sensible heating. More...
 
character(len=200) pme_file
 The file with precipitation minus evaporation. More...
 
type(diag_ctrl), pointer diag
 A structure that is used to regulate the timing of diagnostic output. More...
 

Variables and constants

◆ diag

type(diag_ctrl), pointer meso_surface_forcing::meso_surface_forcing_cs::diag

A structure that is used to regulate the timing of diagnostic output.

Definition at line 48 of file MESO_surface_forcing.F90.

48  type(diag_ctrl), pointer :: diag !< A structure that is used to regulate the

◆ flux_const

real meso_surface_forcing::meso_surface_forcing_cs::flux_const

The restoring rate at the surface [Z T-1 ~> m s-1].

Definition at line 32 of file MESO_surface_forcing.F90.

32  real :: Flux_const !< The restoring rate at the surface [Z T-1 ~> m s-1].

◆ g_earth

real meso_surface_forcing::meso_surface_forcing_cs::g_earth

The gravitational acceleration [L2 Z-1 T-2 ~> m s-2].

Definition at line 31 of file MESO_surface_forcing.F90.

31  real :: G_Earth !< The gravitational acceleration [L2 Z-1 T-2 ~> m s-2].

◆ gust_const

real meso_surface_forcing::meso_surface_forcing_cs::gust_const

A constant unresolved background gustiness that contributes to ustar [Pa].

Definition at line 33 of file MESO_surface_forcing.F90.

33  real :: gust_const !< A constant unresolved background gustiness

◆ heat

real, dimension(:,:), pointer meso_surface_forcing::meso_surface_forcing_cs::heat => NULL()

The prescribed longwave, latent and sensible heat flux into the ocean [W m-2].

Definition at line 40 of file MESO_surface_forcing.F90.

40  real, dimension(:,:), pointer :: Heat(:,:) => null() !< The prescribed longwave, latent and sensible

◆ heating_file

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::heating_file

The file with the longwave, latent, and sensible heating.

Definition at line 46 of file MESO_surface_forcing.F90.

46  character(len=200) :: heating_file !< The file with the longwave, latent, and sensible heating

◆ inputdir

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::inputdir

The directory where NetCDF input files are.

Definition at line 42 of file MESO_surface_forcing.F90.

42  character(len=200) :: inputdir !< The directory where NetCDF input files are.

◆ pme

real, dimension(:,:), pointer meso_surface_forcing::meso_surface_forcing_cs::pme => NULL()

The prescribed precip minus evap [m s-1].

Definition at line 35 of file MESO_surface_forcing.F90.

◆ pme_file

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::pme_file

The file with precipitation minus evaporation.

Definition at line 47 of file MESO_surface_forcing.F90.

47  character(len=200) :: PmE_file !< The file with precipitation minus evaporation

◆ restorebuoy

logical meso_surface_forcing::meso_surface_forcing_cs::restorebuoy

If true, use restoring surface buoyancy forcing.

Definition at line 29 of file MESO_surface_forcing.F90.

29  logical :: restorebuoy !< If true, use restoring surface buoyancy forcing.

◆ rho0

real meso_surface_forcing::meso_surface_forcing_cs::rho0

The density used in the Boussinesq approximation [R ~> kg m-3].

Definition at line 30 of file MESO_surface_forcing.F90.

30  real :: Rho0 !< The density used in the Boussinesq approximation [R ~> kg m-3].

◆ s_restore

real, dimension(:,:), pointer meso_surface_forcing::meso_surface_forcing_cs::s_restore => NULL()

The salinity to restore the sea surface salnity toward [ppt].

Definition at line 35 of file MESO_surface_forcing.F90.

◆ salinityrestore_file

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::salinityrestore_file

The file with the target sea surface salinity.

Definition at line 43 of file MESO_surface_forcing.F90.

43  character(len=200) :: salinityrestore_file !< The file with the target sea surface salinity

◆ solar

real, dimension(:,:), pointer meso_surface_forcing::meso_surface_forcing_cs::solar => NULL()

The shortwave forcing into the ocean [W m-2].

Definition at line 35 of file MESO_surface_forcing.F90.

◆ solar_file

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::solar_file

The file with the shortwave forcing.

Definition at line 45 of file MESO_surface_forcing.F90.

45  character(len=200) :: Solar_file !< The file with the shortwave forcing

◆ sstrestore_file

character(len=200) meso_surface_forcing::meso_surface_forcing_cs::sstrestore_file

The file with the target sea surface temperature.

Definition at line 44 of file MESO_surface_forcing.F90.

44  character(len=200) :: SSTrestore_file !< The file with the target sea surface temperature

◆ t_restore

real, dimension(:,:), pointer meso_surface_forcing::meso_surface_forcing_cs::t_restore => NULL()

The temperature to restore the SST toward [degC].

Definition at line 35 of file MESO_surface_forcing.F90.

35  real, dimension(:,:), pointer :: &
36  T_Restore(:,:) => null(), & !< The temperature to restore the SST toward [degC].
37  s_restore(:,:) => null(), & !< The salinity to restore the sea surface salnity toward [ppt]
38  pme(:,:) => null(), & !< The prescribed precip minus evap [m s-1].
39  solar(:,:) => null() !< The shortwave forcing into the ocean [W m-2].

◆ use_temperature

logical meso_surface_forcing::meso_surface_forcing_cs::use_temperature

If true, temperature and salinity are used as state variables.

Definition at line 28 of file MESO_surface_forcing.F90.

28  logical :: use_temperature !< If true, temperature and salinity are used as state variables.

The documentation for this type was generated from the following file: