MOM6
mom_verticalgrid::verticalgrid_type Type Reference

Detailed Description

Describes the vertical ocean grid, including unit conversion factors.

Definition at line 24 of file MOM_verticalGrid.F90.

Collaboration diagram for mom_verticalgrid::verticalgrid_type:
[legend]

Public variables and constants

integer ke
 The number of layers/levels in the vertical. More...
 
real max_depth
 The maximum depth of the ocean [Z ~> m]. More...
 
real mks_g_earth
 The gravitational acceleration in unscaled MKS units [m s-2]. More...
 
real g_earth
 The gravitational acceleration [L2 Z-1 T-2 ~> m s-2]. More...
 
real rho0
 The density used in the Boussinesq approximation or nominal density used to convert depths into mass units [kg m-3]. More...
 
character(len=40) zaxisunits
 The units that vertical coordinates are written in. More...
 
character(len=40) zaxislongname
 Coordinate name to appear in files, e.g. "Target Potential Density" or "Height". More...
 
real, dimension(:), allocatable slayer
 Coordinate values of layer centers. More...
 
real, dimension(:), allocatable sinterface
 Coordinate values on interfaces. More...
 
integer direction = 1
 Direction defaults to 1, positive up. More...
 
logical boussinesq
 If true, make the Boussinesq approximation. More...
 
real angstrom_h
 A one-Angstrom thickness in the model thickness units [H ~> m or kg m-2]. More...
 
real angstrom_z
 A one-Angstrom thickness in the model depth units [Z ~> m]. More...
 
real angstrom_m
 A one-Angstrom thickness [m]. More...
 
real h_subroundoff
 A thickness that is so small that it can be added to a thickness of Angstrom or larger without changing it at the bit level [H ~> m or kg m-2]. If Angstrom is 0 or exceedingly small, this is negligible compared to 1e-17 m. More...
 
real, dimension(:), allocatable g_prime
 The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. More...
 
real, dimension(:), allocatable rlay
 The target coordinate value (potential density) in each layer [R ~> kg m-3]. More...
 
integer nkml = 0
 The number of layers at the top that should be treated as parts of a homogeneous region. More...
 
integer nk_rho_varies = 0
 The number of layers at the top where the density does not track any target density. More...
 
real h_to_kg_m2
 A constant that translates thicknesses from the units of thickness to kg m-2. More...
 
real kg_m2_to_h
 A constant that translates thicknesses from kg m-2 to the units of thickness. More...
 
real m_to_h
 A constant that translates distances in m to the units of thickness. More...
 
real h_to_m
 A constant that translates distances in the units of thickness to m. More...
 
real h_to_pa
 A constant that translates the units of thickness to pressure [Pa]. More...
 
real h_to_z
 A constant that translates thickness units to the units of depth. More...
 
real z_to_h
 A constant that translates depth units to thickness units. More...
 
real h_to_rz
 A constant that translates thickness units to the units of mass per unit area. More...
 
real rz_to_h
 A constant that translates mass per unit area units to thickness units. More...
 
real h_to_mks
 A constant that translates thickness units to its MKS unit (m or kg m-2) based on GVBoussinesq. More...
 
real m_to_h_restart = 0.0
 A copy of the m_to_H that is used in restart files. More...
 

Variables and constants

◆ angstrom_h

real mom_verticalgrid::verticalgrid_type::angstrom_h

A one-Angstrom thickness in the model thickness units [H ~> m or kg m-2].

Definition at line 44 of file MOM_verticalGrid.F90.

44  real :: Angstrom_H !< A one-Angstrom thickness in the model thickness units [H ~> m or kg m-2].

◆ angstrom_m

real mom_verticalgrid::verticalgrid_type::angstrom_m

A one-Angstrom thickness [m].

Definition at line 46 of file MOM_verticalGrid.F90.

46  real :: Angstrom_m !< A one-Angstrom thickness [m].

◆ angstrom_z

real mom_verticalgrid::verticalgrid_type::angstrom_z

A one-Angstrom thickness in the model depth units [Z ~> m].

Definition at line 45 of file MOM_verticalGrid.F90.

45  real :: Angstrom_Z !< A one-Angstrom thickness in the model depth units [Z ~> m].

◆ boussinesq

logical mom_verticalgrid::verticalgrid_type::boussinesq

If true, make the Boussinesq approximation.

Definition at line 43 of file MOM_verticalGrid.F90.

43  logical :: Boussinesq !< If true, make the Boussinesq approximation.

◆ direction

integer mom_verticalgrid::verticalgrid_type::direction = 1

Direction defaults to 1, positive up.

Definition at line 40 of file MOM_verticalGrid.F90.

40  integer :: direction = 1 !< Direction defaults to 1, positive up.

◆ g_earth

real mom_verticalgrid::verticalgrid_type::g_earth

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

Definition at line 30 of file MOM_verticalGrid.F90.

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

◆ g_prime

real, dimension(:), allocatable mom_verticalgrid::verticalgrid_type::g_prime

The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

Definition at line 50 of file MOM_verticalGrid.F90.

50  real, allocatable, dimension(:) :: &
51  g_prime, & !< The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].
52  Rlay !< The target coordinate value (potential density) in each layer [R ~> kg m-3].

◆ h_subroundoff

real mom_verticalgrid::verticalgrid_type::h_subroundoff

A thickness that is so small that it can be added to a thickness of Angstrom or larger without changing it at the bit level [H ~> m or kg m-2]. If Angstrom is 0 or exceedingly small, this is negligible compared to 1e-17 m.

Definition at line 47 of file MOM_verticalGrid.F90.

47  real :: H_subroundoff !< A thickness that is so small that it can be added to a thickness of

◆ h_to_kg_m2

real mom_verticalgrid::verticalgrid_type::h_to_kg_m2

A constant that translates thicknesses from the units of thickness to kg m-2.

Definition at line 57 of file MOM_verticalGrid.F90.

57  real :: H_to_kg_m2 !< A constant that translates thicknesses from the units of thickness to kg m-2.

◆ h_to_m

real mom_verticalgrid::verticalgrid_type::h_to_m

A constant that translates distances in the units of thickness to m.

Definition at line 60 of file MOM_verticalGrid.F90.

60  real :: H_to_m !< A constant that translates distances in the units of thickness to m.

◆ h_to_mks

real mom_verticalgrid::verticalgrid_type::h_to_mks

A constant that translates thickness units to its MKS unit (m or kg m-2) based on GVBoussinesq.

Definition at line 66 of file MOM_verticalGrid.F90.

66  real :: H_to_MKS !< A constant that translates thickness units to its

◆ h_to_pa

real mom_verticalgrid::verticalgrid_type::h_to_pa

A constant that translates the units of thickness to pressure [Pa].

Definition at line 61 of file MOM_verticalGrid.F90.

61  real :: H_to_Pa !< A constant that translates the units of thickness to pressure [Pa].

◆ h_to_rz

real mom_verticalgrid::verticalgrid_type::h_to_rz

A constant that translates thickness units to the units of mass per unit area.

Definition at line 64 of file MOM_verticalGrid.F90.

64  real :: H_to_RZ !< A constant that translates thickness units to the units of mass per unit area.

◆ h_to_z

real mom_verticalgrid::verticalgrid_type::h_to_z

A constant that translates thickness units to the units of depth.

Definition at line 62 of file MOM_verticalGrid.F90.

62  real :: H_to_Z !< A constant that translates thickness units to the units of depth.

◆ ke

integer mom_verticalgrid::verticalgrid_type::ke

The number of layers/levels in the vertical.

Definition at line 27 of file MOM_verticalGrid.F90.

27  integer :: ke !< The number of layers/levels in the vertical

◆ kg_m2_to_h

real mom_verticalgrid::verticalgrid_type::kg_m2_to_h

A constant that translates thicknesses from kg m-2 to the units of thickness.

Definition at line 58 of file MOM_verticalGrid.F90.

58  real :: kg_m2_to_H !< A constant that translates thicknesses from kg m-2 to the units of thickness.

◆ m_to_h

real mom_verticalgrid::verticalgrid_type::m_to_h

A constant that translates distances in m to the units of thickness.

Definition at line 59 of file MOM_verticalGrid.F90.

59  real :: m_to_H !< A constant that translates distances in m to the units of thickness.

◆ m_to_h_restart

real mom_verticalgrid::verticalgrid_type::m_to_h_restart = 0.0

A copy of the m_to_H that is used in restart files.

Definition at line 69 of file MOM_verticalGrid.F90.

69  real :: m_to_H_restart = 0.0 !< A copy of the m_to_H that is used in restart files.

◆ max_depth

real mom_verticalgrid::verticalgrid_type::max_depth

The maximum depth of the ocean [Z ~> m].

Definition at line 28 of file MOM_verticalGrid.F90.

28  real :: max_depth !< The maximum depth of the ocean [Z ~> m].

◆ mks_g_earth

real mom_verticalgrid::verticalgrid_type::mks_g_earth

The gravitational acceleration in unscaled MKS units [m s-2].

Definition at line 29 of file MOM_verticalGrid.F90.

29  real :: mks_g_Earth !< The gravitational acceleration in unscaled MKS units [m s-2].

◆ nk_rho_varies

integer mom_verticalgrid::verticalgrid_type::nk_rho_varies = 0

The number of layers at the top where the density does not track any target density.

Definition at line 55 of file MOM_verticalGrid.F90.

55  integer :: nk_rho_varies = 0 !< The number of layers at the top where the

◆ nkml

integer mom_verticalgrid::verticalgrid_type::nkml = 0

The number of layers at the top that should be treated as parts of a homogeneous region.

Definition at line 53 of file MOM_verticalGrid.F90.

53  integer :: nkml = 0 !< The number of layers at the top that should be treated

◆ rho0

real mom_verticalgrid::verticalgrid_type::rho0

The density used in the Boussinesq approximation or nominal density used to convert depths into mass units [kg m-3].

Definition at line 31 of file MOM_verticalGrid.F90.

31  real :: Rho0 !< The density used in the Boussinesq approximation or nominal

◆ rlay

real, dimension(:), allocatable mom_verticalgrid::verticalgrid_type::rlay

The target coordinate value (potential density) in each layer [R ~> kg m-3].

Definition at line 50 of file MOM_verticalGrid.F90.

◆ rz_to_h

real mom_verticalgrid::verticalgrid_type::rz_to_h

A constant that translates mass per unit area units to thickness units.

Definition at line 65 of file MOM_verticalGrid.F90.

65  real :: RZ_to_H !< A constant that translates mass per unit area units to thickness units.

◆ sinterface

real, dimension(:), allocatable mom_verticalgrid::verticalgrid_type::sinterface

Coordinate values on interfaces.

Definition at line 39 of file MOM_verticalGrid.F90.

39  real, allocatable, dimension(:) :: sInterface !< Coordinate values on interfaces

◆ slayer

real, dimension(:), allocatable mom_verticalgrid::verticalgrid_type::slayer

Coordinate values of layer centers.

Definition at line 38 of file MOM_verticalGrid.F90.

38  real, allocatable, dimension(:) :: sLayer !< Coordinate values of layer centers

◆ z_to_h

real mom_verticalgrid::verticalgrid_type::z_to_h

A constant that translates depth units to thickness units.

Definition at line 63 of file MOM_verticalGrid.F90.

63  real :: Z_to_H !< A constant that translates depth units to thickness units.

◆ zaxislongname

character(len=40) mom_verticalgrid::verticalgrid_type::zaxislongname

Coordinate name to appear in files, e.g. "Target Potential Density" or "Height".

Definition at line 36 of file MOM_verticalGrid.F90.

36  character(len=40) :: zAxisLongName !< Coordinate name to appear in files,

◆ zaxisunits

character(len=40) mom_verticalgrid::verticalgrid_type::zaxisunits

The units that vertical coordinates are written in.

Definition at line 35 of file MOM_verticalGrid.F90.

35  character(len=40) :: zAxisUnits !< The units that vertical coordinates are written in

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