MOM6
user_surface_forcing::user_surface_forcing_cs Type Reference

Detailed Description

This control structure should be used to store any run-time variables associated with the user-specified forcing.

It can be readily modified for a specific case, and because it is private there will be no changes needed in other code (although they will have to be recompiled).

Definition at line 30 of file user_surface_forcing.F90.

Collaboration diagram for user_surface_forcing::user_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 s-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 [R L Z T-1 ~> Pa]. 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 user_surface_forcing::user_surface_forcing_cs::diag

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

Definition at line 42 of file user_surface_forcing.F90.

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

◆ flux_const

real user_surface_forcing::user_surface_forcing_cs::flux_const

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

Definition at line 38 of file user_surface_forcing.F90.

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

◆ g_earth

real user_surface_forcing::user_surface_forcing_cs::g_earth

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

Definition at line 37 of file user_surface_forcing.F90.

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

◆ gust_const

real user_surface_forcing::user_surface_forcing_cs::gust_const

A constant unresolved background gustiness that contributes to ustar [R L Z T-1 ~> Pa].

Definition at line 39 of file user_surface_forcing.F90.

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

◆ restorebuoy

logical user_surface_forcing::user_surface_forcing_cs::restorebuoy

If true, use restoring surface buoyancy forcing.

Definition at line 35 of file user_surface_forcing.F90.

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

◆ rho0

real user_surface_forcing::user_surface_forcing_cs::rho0

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

Definition at line 36 of file user_surface_forcing.F90.

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

◆ use_temperature

logical user_surface_forcing::user_surface_forcing_cs::use_temperature

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

Definition at line 34 of file user_surface_forcing.F90.

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

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