Detailed Description

Ocean grid type. See mom_grid for details.

Definition at line 19 of file MOM_grid.F90.

Collaboration diagram for mom_grid::ocean_grid_type:

Public variables and constants
type(mom_domain_type), pointer	domain => NULL()
	Ocean model domain. More...

type(mom_domain_type), pointer	domain_aux => NULL()
	A non-symmetric auxiliary domain type. More...

type(hor_index_type)	hi
	Horizontal index ranges. More...

integer	isc
	The start i-index of cell centers within the computational domain. More...

integer	iec
	The end i-index of cell centers within the computational domain. More...

integer	jsc
	The start j-index of cell centers within the computational domain. More...

integer	jec
	The end j-index of cell centers within the computational domain. More...

integer	isd
	The start i-index of cell centers within the data domain. More...

integer	ied
	The end i-index of cell centers within the data domain. More...

integer	jsd
	The start j-index of cell centers within the data domain. More...

integer	jed
	The end j-index of cell centers within the data domain. More...

integer	isg
	The start i-index of cell centers within the global domain. More...

integer	ieg
	The end i-index of cell centers within the global domain. More...

integer	jsg
	The start j-index of cell centers within the global domain. More...

integer	jeg
	The end j-index of cell centers within the global domain. More...

integer	iscb
	The start i-index of cell vertices within the computational domain. More...

integer	iecb
	The end i-index of cell vertices within the computational domain. More...

integer	jscb
	The start j-index of cell vertices within the computational domain. More...

integer	jecb
	The end j-index of cell vertices within the computational domain. More...

integer	isdb
	The start i-index of cell vertices within the data domain. More...

integer	iedb
	The end i-index of cell vertices within the data domain. More...

integer	jsdb
	The start j-index of cell vertices within the data domain. More...

integer	jedb
	The end j-index of cell vertices within the data domain. More...

integer	isgb
	The start i-index of cell vertices within the global domain. More...

integer	iegb
	The end i-index of cell vertices within the global domain. More...

integer	jsgb
	The start j-index of cell vertices within the global domain. More...

integer	jegb
	The end j-index of cell vertices within the global domain. More...

integer	isd_global
	The value of isd in the global index space (decompoistion invariant). More...

integer	jsd_global
	The value of isd in the global index space (decompoistion invariant). More...

integer	idg_offset
	The offset between the corresponding global and local i-indices. More...

integer	jdg_offset
	The offset between the corresponding global and local j-indices. More...

integer	ke
	The number of layers in the vertical. More...

logical	symmetric
	True if symmetric memory is used. More...

logical	nonblocking_updates
	If true, non-blocking halo updates are allowed. The default is .false. (for now). More...

integer	first_direction
	An integer that indicates which direction is to be updated first in directionally split parts of the calculation. This can be altered during the course of the run via calls to set_first_direction. More...

real, dimension(:, :), allocatable	mask2dt
	0 for land points and 1 for ocean points on the h-grid. Nd. More...

real, dimension(:, :), allocatable	geolatt
	The geographic latitude at q points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geolont
	The geographic longitude at q points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxt
	dxT is delta x at h points, in m. More...

real, dimension(:, :), allocatable	idxt
	1/dxT in m-1. More...

real, dimension(:, :), allocatable	dyt
	dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1. More...

real, dimension(:, :), allocatable	idyt
	dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1. More...

real, dimension(:, :), allocatable	areat
	The area of an h-cell, in m2. More...

real, dimension(:, :), allocatable	iareat
	1/areaT, in m-2. More...

real, dimension(:, :), allocatable	sin_rot
	The sine of the angular rotation between the local model grid's northward. More...

real, dimension(:, :), allocatable	cos_rot
	The cosine of the angular rotation between the local model grid's northward. More...

real, dimension(:, :), allocatable	mask2dcu
	0 for boundary points and 1 for ocean points on the u grid. Nondim. More...

real, dimension(:, :), allocatable	geolatcu
	The geographic latitude at u points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geoloncu
	The geographic longitude at u points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxcu
	dxCu is delta x at u points, in m. More...

real, dimension(:, :), allocatable	idxcu
	1/dxCu in m-1. More...

real, dimension(:, :), allocatable	dycu
	dyCu is delta y at u points, in m. More...

real, dimension(:, :), allocatable	idycu
	1/dyCu in m-1. More...

real, dimension(:, :), allocatable	dy_cu
	The unblocked lengths of the u-faces of the h-cell in m. More...

real, dimension(:, :), allocatable	dy_cu_obc
	The unblocked lengths of the u-faces of the h-cell in m for OBC. More...

real, dimension(:, :), allocatable	iareacu
	The masked inverse areas of u-grid cells in m2. More...

real, dimension(:, :), allocatable	areacu
	The areas of the u-grid cells in m2. More...

real, dimension(:, :), allocatable	mask2dcv
	0 for boundary points and 1 for ocean points on the v grid. Nondim. More...

real, dimension(:, :), allocatable	geolatcv
	The geographic latitude at v points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geoloncv
	The geographic longitude at v points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxcv
	dxCv is delta x at v points, in m. More...

real, dimension(:, :), allocatable	idxcv
	1/dxCv in m-1. More...

real, dimension(:, :), allocatable	dycv
	dyCv is delta y at v points, in m. More...

real, dimension(:, :), allocatable	idycv
	1/dyCv in m-1. More...

real, dimension(:, :), allocatable	dx_cv
	The unblocked lengths of the v-faces of the h-cell in m. More...

real, dimension(:, :), allocatable	dx_cv_obc
	The unblocked lengths of the v-faces of the h-cell in m for OBC. More...

real, dimension(:, :), allocatable	iareacv
	The masked inverse areas of v-grid cells in m2. More...

real, dimension(:, :), allocatable	areacv
	The areas of the v-grid cells in m2. More...

real, dimension(:, :), allocatable	mask2dbu
	0 for boundary points and 1 for ocean points on the q grid. Nondim. More...

real, dimension(:, :), allocatable	geolatbu
	The geographic latitude at q points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geolonbu
	The geographic longitude at q points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxbu
	dxBu is delta x at q points, in m. More...

real, dimension(:, :), allocatable	idxbu
	1/dxBu in m-1. More...

real, dimension(:, :), allocatable	dybu
	dyBu is delta y at q points, in m. More...

real, dimension(:, :), allocatable	idybu
	1/dyBu in m-1. More...

real, dimension(:, :), allocatable	areabu
	areaBu is the area of a q-cell, in m2 More...

real, dimension(:, :), allocatable	iareabu
	IareaBu = 1/areaBu in m-2. More...

real, dimension(:), pointer	gridlatt => NULL()
	The latitude of T points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlatb => NULL()
	The latitude of B points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlont => NULL()
	The longitude of T points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlonb => NULL()
	The longitude of B points for the purpose of labeling the output axes. More...

character(len=40)	x_axis_units
	The units that are used in labeling the x coordinate axes. More...

character(len=40)	y_axis_units
	The units that are used in labeling the y coordinate axes. More...

real, dimension(:, :), allocatable	bathyt
	Ocean bottom depth at tracer points, in m. More...

logical	bathymetry_at_vel
	If true, there are separate values for the basin depths at velocity points. Otherwise the effects of of topography are entirely determined from thickness points. More...

real, dimension(:, :), allocatable	dblock_u
	Topographic depths at u-points at which the flow is blocked, in m. More...

real, dimension(:, :), allocatable	dopen_u
	Topographic depths at u-points at which the flow is open at width dy_Cu, in m. More...

real, dimension(:, :), allocatable	dblock_v
	Topographic depths at v-points at which the flow is blocked, in m. More...

real, dimension(:, :), allocatable	dopen_v
	Topographic depths at v-points at which the flow is open at width dx_Cv, in m. More...

real, dimension(:, :), allocatable	coriolisbu
	The Coriolis parameter at corner points, in s-1. More...

real, dimension(:, :), allocatable	df_dx
	Derivative d/dx f (Coriolis parameter) at h-points, in s-1 m-1. More...

real, dimension(:, :), allocatable	df_dy
	Derivative d/dy f (Coriolis parameter) at h-points, in s-1 m-1. More...

real	g_earth
	The gravitational acceleration in m s-2. More...

real	areat_global
	Global sum of h-cell area in m2. More...

real	iareat_global
	Global sum of inverse h-cell area (1/areaT_global) in m2. More...

integer	nblocks

type(hor_index_type), dimension(:), pointer	block => NULL()

real	south_lat
	The latitude (or y-coordinate) of the first v-line. More...

real	west_lon
	The longitude (or x-coordinate) of the first u-line. More...

real	len_lat = 0.
	The latitudinal (or y-coord) extent of physical domain. More...

real	len_lon = 0.
	The longitudinal (or x-coord) extent of physical domain. More...

real	rad_earth = 6.378e6
	The radius of the planet in meters. More...

real	max_depth
	The maximum depth of the ocean in meters. More...

Variables and constants

◆ areabu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areabu

areaBu is the area of a q-cell, in m2

Definition at line 110 of file MOM_grid.F90.

◆ areacu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areacu

The areas of the u-grid cells in m2.

Definition at line 83 of file MOM_grid.F90.

◆ areacv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areacv

The areas of the v-grid cells in m2.

Definition at line 97 of file MOM_grid.F90.

◆ areat

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areat

The area of an h-cell, in m2.

Definition at line 68 of file MOM_grid.F90.

◆ areat_global

real mom_grid::ocean_grid_type::areat_global

Global sum of h-cell area in m2.

Definition at line 155 of file MOM_grid.F90.

155 real :: areat_global !< Global sum of h-cell area in m2

◆ bathymetry_at_vel

logical mom_grid::ocean_grid_type::bathymetry_at_vel

If true, there are separate values for the basin depths at velocity points. Otherwise the effects of of topography are entirely determined from thickness points.

Definition at line 138 of file MOM_grid.F90.

138 logical :: bathymetry_at_vel !< If true, there are separate values for the

◆ bathyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::bathyt

Ocean bottom depth at tracer points, in m.

Definition at line 135 of file MOM_grid.F90.

135 real allocable_, dimension(NIMEM_,NJMEM_) :: &

136 bathyt !< Ocean bottom depth at tracer points, in m.

◆ block

type(hor_index_type), dimension(:), pointer mom_grid::ocean_grid_type::block => NULL()

Definition at line 160 of file MOM_grid.F90.

160 type(hor_index_type), pointer :: block(:) => null() ! store indices for each block

◆ coriolisbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::coriolisbu

The Coriolis parameter at corner points, in s-1.

Definition at line 147 of file MOM_grid.F90.

147 real allocable_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &

148 coriolisbu !< The Coriolis parameter at corner points, in s-1.

◆ cos_rot

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::cos_rot

The cosine of the angular rotation between the local model grid's northward.

Definition at line 68 of file MOM_grid.F90.

◆ dblock_u

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dblock_u

Topographic depths at u-points at which the flow is blocked, in m.

Definition at line 141 of file MOM_grid.F90.

   real allocable_, dimension(NIMEMB_PTR_,NJMEM_) :: &
     dblock_u, &   !< Topographic depths at u-points at which the flow is blocked, in m.
     dopen_u       !< Topographic depths at u-points at which the flow is open at width dy_Cu, in m.

◆ dblock_v

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dblock_v

Topographic depths at v-points at which the flow is blocked, in m.

Definition at line 144 of file MOM_grid.F90.

   real allocable_, dimension(NIMEM_,NJMEMB_PTR_) :: &
     dblock_v, &   !< Topographic depths at v-points at which the flow is blocked, in m.
     dopen_v       !< Topographic depths at v-points at which the flow is open at width dx_Cv, in m.

◆ df_dx

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::df_dx

Derivative d/dx f (Coriolis parameter) at h-points, in s-1 m-1.

Definition at line 149 of file MOM_grid.F90.

   real allocable_, dimension(NIMEM_,NJMEM_) :: &
     df_dx, &      !< Derivative d/dx f (Coriolis parameter) at h-points, in s-1 m-1.
     df_dy         !< Derivative d/dy f (Coriolis parameter) at h-points, in s-1 m-1.

◆ df_dy

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::df_dy

Derivative d/dy f (Coriolis parameter) at h-points, in s-1 m-1.

Definition at line 149 of file MOM_grid.F90.

◆ domain

type(mom_domain_type), pointer mom_grid::ocean_grid_type::domain => NULL()

Ocean model domain.

Definition at line 20 of file MOM_grid.F90.

20 type(mom_domain_type), pointer :: domain => null() !< Ocean model domain

◆ domain_aux

type(mom_domain_type), pointer mom_grid::ocean_grid_type::domain_aux => NULL()

A non-symmetric auxiliary domain type.

Definition at line 21 of file MOM_grid.F90.

21 type(mom_domain_type), pointer :: domain_aux => null() !< A non-symmetric auxiliary domain type.

◆ dopen_u

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dopen_u

Topographic depths at u-points at which the flow is open at width dy_Cu, in m.

Definition at line 141 of file MOM_grid.F90.

◆ dopen_v

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dopen_v

Topographic depths at v-points at which the flow is open at width dx_Cv, in m.

Definition at line 144 of file MOM_grid.F90.

◆ dx_cv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dx_cv

The unblocked lengths of the v-faces of the h-cell in m.

Definition at line 97 of file MOM_grid.F90.

◆ dx_cv_obc

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dx_cv_obc

The unblocked lengths of the v-faces of the h-cell in m for OBC.

Definition at line 97 of file MOM_grid.F90.

◆ dxbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxbu

dxBu is delta x at q points, in m.

Definition at line 110 of file MOM_grid.F90.

◆ dxcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxcu

dxCu is delta x at u points, in m.

Definition at line 83 of file MOM_grid.F90.

◆ dxcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxcv

dxCv is delta x at v points, in m.

Definition at line 97 of file MOM_grid.F90.

◆ dxt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxt

dxT is delta x at h points, in m.

Definition at line 68 of file MOM_grid.F90.

◆ dy_cu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dy_cu

The unblocked lengths of the u-faces of the h-cell in m.

Definition at line 83 of file MOM_grid.F90.

◆ dy_cu_obc

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dy_cu_obc

The unblocked lengths of the u-faces of the h-cell in m for OBC.

Definition at line 83 of file MOM_grid.F90.

◆ dybu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dybu

dyBu is delta y at q points, in m.

Definition at line 110 of file MOM_grid.F90.

◆ dycu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dycu

dyCu is delta y at u points, in m.

Definition at line 83 of file MOM_grid.F90.

◆ dycv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dycv

dyCv is delta y at v points, in m.

Definition at line 97 of file MOM_grid.F90.

◆ dyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dyt

dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1.

Definition at line 68 of file MOM_grid.F90.

◆ first_direction

integer mom_grid::ocean_grid_type::first_direction

An integer that indicates which direction is to be updated first in directionally split parts of the calculation. This can be altered during the course of the run via calls to set_first_direction.

Definition at line 62 of file MOM_grid.F90.

62 integer :: first_direction !< An integer that indicates which direction is

◆ g_earth

real mom_grid::ocean_grid_type::g_earth

The gravitational acceleration in m s-2.

Definition at line 152 of file MOM_grid.F90.

152 real :: g_earth !< The gravitational acceleration in m s-2.

◆ geolatbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatbu

The geographic latitude at q points in degrees of latitude or m.

Definition at line 110 of file MOM_grid.F90.

◆ geolatcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatcu

The geographic latitude at u points in degrees of latitude or m.

Definition at line 83 of file MOM_grid.F90.

◆ geolatcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatcv

The geographic latitude at v points in degrees of latitude or m.

Definition at line 97 of file MOM_grid.F90.

◆ geolatt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatt

The geographic latitude at q points in degrees of latitude or m.

Definition at line 68 of file MOM_grid.F90.

◆ geolonbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolonbu

The geographic longitude at q points in degrees of longitude or m.

Definition at line 110 of file MOM_grid.F90.

◆ geoloncu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geoloncu

The geographic longitude at u points in degrees of longitude or m.

Definition at line 83 of file MOM_grid.F90.

◆ geoloncv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geoloncv

The geographic longitude at v points in degrees of longitude or m.

Definition at line 97 of file MOM_grid.F90.

◆ geolont

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolont

The geographic longitude at q points in degrees of longitude or m.

Definition at line 68 of file MOM_grid.F90.

◆ gridlatb

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlatb => NULL()

The latitude of B points for the purpose of labeling the output axes.

Definition at line 121 of file MOM_grid.F90.

◆ gridlatt

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlatt => NULL()

The latitude of T points for the purpose of labeling the output axes.

Definition at line 121 of file MOM_grid.F90.

   real, pointer, dimension(:) :: &
     gridlatt => null(), & !< The latitude of T points for the purpose of labeling the output axes.
                           !! On many grids this is the same as geoLatT.
     gridlatb => null()    !< The latitude of B points for the purpose of labeling the output axes.

◆ gridlonb

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlonb => NULL()

The longitude of B points for the purpose of labeling the output axes.

Definition at line 126 of file MOM_grid.F90.

◆ gridlont

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlont => NULL()

The longitude of T points for the purpose of labeling the output axes.

Definition at line 126 of file MOM_grid.F90.

   real, pointer, dimension(:) :: &
     gridlont => null(), & !< The longitude of T points for the purpose of labeling the output axes.
                           !! On many grids this is the same as geoLonT.
     gridlonb => null()    !< The longitude of B points for the purpose of labeling the output axes.

◆ hi

type(hor_index_type) mom_grid::ocean_grid_type::hi

Horizontal index ranges.

Definition at line 22 of file MOM_grid.F90.

22 type(hor_index_type) :: hi !< Horizontal index ranges

◆ iareabu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareabu

IareaBu = 1/areaBu in m-2.

Definition at line 110 of file MOM_grid.F90.

◆ iareacu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareacu

The masked inverse areas of u-grid cells in m2.

Definition at line 83 of file MOM_grid.F90.

◆ iareacv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareacv

The masked inverse areas of v-grid cells in m2.

Definition at line 97 of file MOM_grid.F90.

◆ iareat

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareat

1/areaT, in m-2.

Definition at line 68 of file MOM_grid.F90.

◆ iareat_global

real mom_grid::ocean_grid_type::iareat_global

Global sum of inverse h-cell area (1/areaT_global) in m2.

Definition at line 156 of file MOM_grid.F90.

156 real :: iareat_global !< Global sum of inverse h-cell area (1/areaT_global) in m2.

◆ idg_offset

integer mom_grid::ocean_grid_type::idg_offset

The offset between the corresponding global and local i-indices.

Definition at line 56 of file MOM_grid.F90.

56 integer :: idg_offset !< The offset between the corresponding global and local i-indices.

◆ idxbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxbu

1/dxBu in m-1.

Definition at line 110 of file MOM_grid.F90.

◆ idxcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxcu

1/dxCu in m-1.

Definition at line 83 of file MOM_grid.F90.

◆ idxcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxcv

1/dxCv in m-1.

Definition at line 97 of file MOM_grid.F90.

◆ idxt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxt

1/dxT in m-1.

Definition at line 68 of file MOM_grid.F90.

◆ idybu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idybu

1/dyBu in m-1.

Definition at line 110 of file MOM_grid.F90.

◆ idycu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idycu

1/dyCu in m-1.

Definition at line 83 of file MOM_grid.F90.

◆ idycv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idycv

1/dyCv in m-1.

Definition at line 97 of file MOM_grid.F90.

◆ idyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idyt

dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1.

Definition at line 68 of file MOM_grid.F90.

◆ iec

integer mom_grid::ocean_grid_type::iec

The end i-index of cell centers within the computational domain.

Definition at line 25 of file MOM_grid.F90.

25 integer :: iec !< The end i-index of cell centers within the computational domain

◆ iecb

integer mom_grid::ocean_grid_type::iecb

The end i-index of cell vertices within the computational domain.

Definition at line 40 of file MOM_grid.F90.

40 integer :: iecb !< The end i-index of cell vertices within the computational domain

◆ ied

integer mom_grid::ocean_grid_type::ied

The end i-index of cell centers within the data domain.

Definition at line 30 of file MOM_grid.F90.

30 integer :: ied !< The end i-index of cell centers within the data domain

◆ iedb

integer mom_grid::ocean_grid_type::iedb

The end i-index of cell vertices within the data domain.

Definition at line 45 of file MOM_grid.F90.

45 integer :: iedb !< The end i-index of cell vertices within the data domain

◆ ieg

integer mom_grid::ocean_grid_type::ieg

The end i-index of cell centers within the global domain.

Definition at line 35 of file MOM_grid.F90.

35 integer :: ieg !< The end i-index of cell centers within the global domain

◆ iegb

integer mom_grid::ocean_grid_type::iegb

The end i-index of cell vertices within the global domain.

Definition at line 50 of file MOM_grid.F90.

50 integer :: iegb !< The end i-index of cell vertices within the global domain

◆ isc

integer mom_grid::ocean_grid_type::isc

The start i-index of cell centers within the computational domain.

Definition at line 24 of file MOM_grid.F90.

24 integer :: isc !< The start i-index of cell centers within the computational domain

◆ iscb

integer mom_grid::ocean_grid_type::iscb

The start i-index of cell vertices within the computational domain.

Definition at line 39 of file MOM_grid.F90.

39 integer :: iscb !< The start i-index of cell vertices within the computational domain

◆ isd

integer mom_grid::ocean_grid_type::isd

The start i-index of cell centers within the data domain.

Definition at line 29 of file MOM_grid.F90.

29 integer :: isd !< The start i-index of cell centers within the data domain

◆ isd_global

integer mom_grid::ocean_grid_type::isd_global

The value of isd in the global index space (decompoistion invariant).

Definition at line 54 of file MOM_grid.F90.

54 integer :: isd_global !< The value of isd in the global index space (decompoistion invariant).

◆ isdb

integer mom_grid::ocean_grid_type::isdb

The start i-index of cell vertices within the data domain.

Definition at line 44 of file MOM_grid.F90.

44 integer :: isdb !< The start i-index of cell vertices within the data domain

◆ isg

integer mom_grid::ocean_grid_type::isg

The start i-index of cell centers within the global domain.

Definition at line 34 of file MOM_grid.F90.

34 integer :: isg !< The start i-index of cell centers within the global domain

◆ isgb

integer mom_grid::ocean_grid_type::isgb

The start i-index of cell vertices within the global domain.

Definition at line 49 of file MOM_grid.F90.

49 integer :: isgb !< The start i-index of cell vertices within the global domain

◆ jdg_offset

integer mom_grid::ocean_grid_type::jdg_offset

The offset between the corresponding global and local j-indices.

Definition at line 57 of file MOM_grid.F90.

57 integer :: jdg_offset !< The offset between the corresponding global and local j-indices.

◆ jec

integer mom_grid::ocean_grid_type::jec

The end j-index of cell centers within the computational domain.

Definition at line 27 of file MOM_grid.F90.

27 integer :: jec !< The end j-index of cell centers within the computational domain

◆ jecb

integer mom_grid::ocean_grid_type::jecb

The end j-index of cell vertices within the computational domain.

Definition at line 42 of file MOM_grid.F90.

42 integer :: jecb !< The end j-index of cell vertices within the computational domain

◆ jed

integer mom_grid::ocean_grid_type::jed

The end j-index of cell centers within the data domain.

Definition at line 32 of file MOM_grid.F90.

32 integer :: jed !< The end j-index of cell centers within the data domain

◆ jedb

integer mom_grid::ocean_grid_type::jedb

The end j-index of cell vertices within the data domain.

Definition at line 47 of file MOM_grid.F90.

47 integer :: jedb !< The end j-index of cell vertices within the data domain

◆ jeg

integer mom_grid::ocean_grid_type::jeg

The end j-index of cell centers within the global domain.

Definition at line 37 of file MOM_grid.F90.

37 integer :: jeg !< The end j-index of cell centers within the global domain

◆ jegb

integer mom_grid::ocean_grid_type::jegb

The end j-index of cell vertices within the global domain.

Definition at line 52 of file MOM_grid.F90.

52 integer :: jegb !< The end j-index of cell vertices within the global domain

◆ jsc

integer mom_grid::ocean_grid_type::jsc

The start j-index of cell centers within the computational domain.

Definition at line 26 of file MOM_grid.F90.

26 integer :: jsc !< The start j-index of cell centers within the computational domain

◆ jscb

integer mom_grid::ocean_grid_type::jscb

The start j-index of cell vertices within the computational domain.

Definition at line 41 of file MOM_grid.F90.

41 integer :: jscb !< The start j-index of cell vertices within the computational domain

◆ jsd

integer mom_grid::ocean_grid_type::jsd

The start j-index of cell centers within the data domain.

Definition at line 31 of file MOM_grid.F90.

31 integer :: jsd !< The start j-index of cell centers within the data domain

◆ jsd_global

integer mom_grid::ocean_grid_type::jsd_global

The value of isd in the global index space (decompoistion invariant).

Definition at line 55 of file MOM_grid.F90.

55 integer :: jsd_global !< The value of isd in the global index space (decompoistion invariant).

◆ jsdb

integer mom_grid::ocean_grid_type::jsdb

The start j-index of cell vertices within the data domain.

Definition at line 46 of file MOM_grid.F90.

46 integer :: jsdb !< The start j-index of cell vertices within the data domain

◆ jsg

integer mom_grid::ocean_grid_type::jsg

The start j-index of cell centers within the global domain.

Definition at line 36 of file MOM_grid.F90.

36 integer :: jsg !< The start j-index of cell centers within the global domain

◆ jsgb

integer mom_grid::ocean_grid_type::jsgb

The start j-index of cell vertices within the global domain.

Definition at line 51 of file MOM_grid.F90.

51 integer :: jsgb !< The start j-index of cell vertices within the global domain

◆ ke

integer mom_grid::ocean_grid_type::ke

The number of layers in the vertical.

Definition at line 58 of file MOM_grid.F90.

58 integer :: ke !< The number of layers in the vertical.

◆ len_lat

real mom_grid::ocean_grid_type::len_lat = 0.

The latitudinal (or y-coord) extent of physical domain.

Definition at line 166 of file MOM_grid.F90.

166 real :: len_lat = 0. !< The latitudinal (or y-coord) extent of physical domain

◆ len_lon

real mom_grid::ocean_grid_type::len_lon = 0.

The longitudinal (or x-coord) extent of physical domain.

Definition at line 167 of file MOM_grid.F90.

167 real :: len_lon = 0. !< The longitudinal (or x-coord) extent of physical domain

◆ mask2dbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dbu

0 for boundary points and 1 for ocean points on the q grid. Nondim.

Definition at line 110 of file MOM_grid.F90.

   real allocable_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
     mask2dbu, &  !< 0 for boundary points and 1 for ocean points on the q grid.  Nondim.
     geolatbu, &  !< The geographic latitude at q points in degrees of latitude or m.
     geolonbu, &  !< The geographic longitude at q points in degrees of longitude or m.
     dxbu, &      !< dxBu is delta x at q points, in m.
     idxbu, &     !< 1/dxBu in m-1.
     dybu, &      !< dyBu is delta y at q points, in m.
     idybu, &     !< 1/dyBu in m-1.
     areabu, &    !< areaBu is the area of a q-cell, in m2
     iareabu      !< IareaBu = 1/areaBu in m-2.

◆ mask2dcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dcu

0 for boundary points and 1 for ocean points on the u grid. Nondim.

Definition at line 83 of file MOM_grid.F90.

   real allocable_, dimension(NIMEMB_PTR_,NJMEM_) :: &
     mask2dcu, &  !< 0 for boundary points and 1 for ocean points on the u grid.  Nondim.
     geolatcu, &  !< The geographic latitude at u points in degrees of latitude or m.
     geoloncu, &  !< The geographic longitude at u points in degrees of longitude or m.
     dxcu, &      !< dxCu is delta x at u points, in m.
     idxcu, &     !< 1/dxCu in m-1.
     dycu, &      !< dyCu is delta y at u points, in m.
     idycu, &     !< 1/dyCu in m-1.
     dy_cu, &     !< The unblocked lengths of the u-faces of the h-cell in m.
     dy_cu_obc, & !< The unblocked lengths of the u-faces of the h-cell in m for OBC.
     iareacu, &   !< The masked inverse areas of u-grid cells in m2.
     areacu       !< The areas of the u-grid cells in m2.

◆ mask2dcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dcv

0 for boundary points and 1 for ocean points on the v grid. Nondim.

Todo:: dy_Cu_obc is not used?

Definition at line 97 of file MOM_grid.F90.

   real allocable_, dimension(NIMEM_,NJMEMB_PTR_) :: &
     mask2dcv, &  !< 0 for boundary points and 1 for ocean points on the v grid.  Nondim.
     geolatcv, &  !< The geographic latitude at v points in degrees of latitude or m.
     geoloncv, &  !< The geographic longitude at v points in degrees of longitude or m.
     dxcv, &      !< dxCv is delta x at v points, in m.
     idxcv, &     !< 1/dxCv in m-1.
     dycv, &      !< dyCv is delta y at v points, in m.
     idycv, &     !< 1/dyCv in m-1.
     dx_cv, &     !< The unblocked lengths of the v-faces of the h-cell in m.
     dx_cv_obc, & !< The unblocked lengths of the v-faces of the h-cell in m for OBC.
     iareacv, &   !< The masked inverse areas of v-grid cells in m2.
     areacv       !< The areas of the v-grid cells in m2.

◆ mask2dt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dt

0 for land points and 1 for ocean points on the h-grid. Nd.

Definition at line 68 of file MOM_grid.F90.

   real allocable_, dimension(NIMEM_,NJMEM_) :: &
     mask2dt, &   !< 0 for land points and 1 for ocean points on the h-grid. Nd.
     geolatt, &   !< The geographic latitude at q points in degrees of latitude or m.
     geolont, &   !< The geographic longitude at q points in degrees of longitude or m.
     dxt, &       !< dxT is delta x at h points, in m.
     idxt, &      !< 1/dxT in m-1.
     dyt, &       !< dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1.
     idyt, &      !< dyT is delta y at h points, in m, and IdyT is 1/dyT in m-1.
     areat, &     !< The area of an h-cell, in m2.
     iareat, &    !< 1/areaT, in m-2.
     sin_rot, &   !< The sine of the angular rotation between the local model grid's northward
                  !! and the true northward directions.
     cos_rot      !< The cosine of the angular rotation between the local model grid's northward

◆ max_depth

real mom_grid::ocean_grid_type::max_depth

The maximum depth of the ocean in meters.

Definition at line 169 of file MOM_grid.F90.

169 real :: max_depth !< The maximum depth of the ocean in meters.

◆ nblocks

integer mom_grid::ocean_grid_type::nblocks

Definition at line 159 of file MOM_grid.F90.

159 integer :: nblocks

◆ nonblocking_updates

logical mom_grid::ocean_grid_type::nonblocking_updates

If true, non-blocking halo updates are allowed. The default is .false. (for now).

Definition at line 60 of file MOM_grid.F90.

60 logical :: nonblocking_updates !< If true, non-blocking halo updates are

◆ rad_earth

real mom_grid::ocean_grid_type::rad_earth = 6.378e6

The radius of the planet in meters.

Definition at line 168 of file MOM_grid.F90.

168 real :: rad_earth = 6.378e6 !< The radius of the planet in meters.

◆ sin_rot

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::sin_rot

The sine of the angular rotation between the local model grid's northward.

Definition at line 68 of file MOM_grid.F90.

◆ south_lat

real mom_grid::ocean_grid_type::south_lat

The latitude (or y-coordinate) of the first v-line.

Definition at line 164 of file MOM_grid.F90.

164 real :: south_lat !< The latitude (or y-coordinate) of the first v-line

◆ symmetric

logical mom_grid::ocean_grid_type::symmetric

True if symmetric memory is used.

Definition at line 59 of file MOM_grid.F90.

59 logical :: symmetric !< True if symmetric memory is used.

◆ west_lon

real mom_grid::ocean_grid_type::west_lon

The longitude (or x-coordinate) of the first u-line.

Definition at line 165 of file MOM_grid.F90.

165 real :: west_lon !< The longitude (or x-coordinate) of the first u-line

◆ x_axis_units

character(len=40) mom_grid::ocean_grid_type::x_axis_units

The units that are used in labeling the x coordinate axes.

Definition at line 131 of file MOM_grid.F90.

   character(len=40) :: &
     x_axis_units, &     !< The units that are used in labeling the x coordinate axes.
     y_axis_units        !< The units that are used in labeling the y coordinate axes.

◆ y_axis_units

character(len=40) mom_grid::ocean_grid_type::y_axis_units

The units that are used in labeling the y coordinate axes.

Definition at line 131 of file MOM_grid.F90.

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

/home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/core/MOM_grid.F90

Detailed Description

Public variables and constants

Variables and constants

◆ areabu

◆ areacu

◆ areacv

◆ areat

◆ areat_global

◆ bathymetry_at_vel

◆ bathyt

◆ block

◆ coriolisbu

◆ cos_rot

◆ dblock_u

◆ dblock_v

◆ df_dx

◆ df_dy

◆ domain

◆ domain_aux

◆ dopen_u

◆ dopen_v

◆ dx_cv

◆ dx_cv_obc

◆ dxbu

◆ dxcu

◆ dxcv

◆ dxt

◆ dy_cu

◆ dy_cu_obc

◆ dybu

◆ dycu

◆ dycv

◆ dyt

◆ first_direction

◆ g_earth

◆ geolatbu

◆ geolatcu

◆ geolatcv

◆ geolatt

◆ geolonbu

◆ geoloncu

◆ geoloncv

◆ geolont

◆ gridlatb

◆ gridlatt

◆ gridlonb

◆ gridlont

◆ hi

◆ iareabu

◆ iareacu

◆ iareacv

◆ iareat

◆ iareat_global

◆ idg_offset

◆ idxbu

◆ idxcu

◆ idxcv

◆ idxt

◆ idybu

◆ idycu

◆ idycv

◆ idyt

◆ iec

◆ iecb

◆ ied

◆ iedb

◆ ieg

◆ iegb

◆ isc

◆ iscb

◆ isd

◆ isd_global

◆ isdb

◆ isg

◆ isgb

◆ jdg_offset

◆ jec

◆ jecb

◆ jed

◆ jedb