Detailed Description

Describes the horizontal ocean grid with only dynamic memory arrays.

Definition at line 23 of file MOM_dyn_horgrid.F90.

Collaboration diagram for mom_dyn_horgrid::dyn_horgrid_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...

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 [nondim]. More...

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

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

real, dimension(:,:), allocatable	dxt
	dxT is delta x at h points [L ~> m]. More...

real, dimension(:,:), allocatable	idxt
	1/dxT [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dyt
	dyT is delta y at h points [L ~> m]. More...

real, dimension(:,:), allocatable	idyt
	IdyT is 1/dyT [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	areat
	The area of an h-cell [L2 ~> m2]. More...

real, dimension(:,:), allocatable	iareat
	1/areaT [L-2 ~> m-2]. More...

real, dimension(:,:), allocatable	sin_rot
	The sine of the angular rotation between the local model grid's northward and the true northward directions [nondim]. More...

real, dimension(:,:), allocatable	cos_rot
	The cosine of the angular rotation between the local model grid's northward and the true northward directions [nondim]. 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 [degrees of latitude] or [m]. More...

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

real, dimension(:,:), allocatable	dxcu
	dxCu is delta x at u points [L ~> m]. More...

real, dimension(:,:), allocatable	idxcu
	1/dxCu [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dycu
	dyCu is delta y at u points [L ~> m]. More...

real, dimension(:,:), allocatable	idycu
	1/dyCu [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dy_cu
	The unblocked lengths of the u-faces of the h-cell [L ~> m]. More...

real, dimension(:,:), allocatable	iareacu
	The masked inverse areas of u-grid cells [L-2 ~> m-2]. More...

real, dimension(:,:), allocatable	areacu
	The areas of the u-grid cells [L2 ~> 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 [degrees of latitude] or [m]. More...

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

real, dimension(:,:), allocatable	dxcv
	dxCv is delta x at v points [L ~> m]. More...

real, dimension(:,:), allocatable	idxcv
	1/dxCv [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dycv
	dyCv is delta y at v points [L ~> m]. More...

real, dimension(:,:), allocatable	idycv
	1/dyCv [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dx_cv
	The unblocked lengths of the v-faces of the h-cell [L ~> m]. More...

real, dimension(:,:), allocatable	iareacv
	The masked inverse areas of v-grid cells [L-2 ~> m-2]. More...

real, dimension(:,:), allocatable	areacv
	The areas of the v-grid cells [L2 ~> 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 [degrees of latitude] or [m]. More...

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

real, dimension(:,:), allocatable	dxbu
	dxBu is delta x at q points [L ~> m]. More...

real, dimension(:,:), allocatable	idxbu
	1/dxBu [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	dybu
	dyBu is delta y at q points [L ~> m]. More...

real, dimension(:,:), allocatable	idybu
	1/dyBu [L-1 ~> m-1]. More...

real, dimension(:,:), allocatable	areabu
	areaBu is the area of a q-cell [L ~> m] More...

real, dimension(:,:), allocatable	iareabu
	IareaBu = 1/areaBu [L-2 ~> m-2]. More...

real, dimension(:), pointer	gridlatt => NULL()
	The latitude of T points for the purpose of labeling the output axes. On many grids this is the same as geoLatT. More...

real, dimension(:), pointer	gridlatb => NULL()
	The latitude of B points for the purpose of labeling the output axes. On many grids this is the same as geoLatBu. More...

real, dimension(:), pointer	gridlont => NULL()
	The longitude of T points for the purpose of labeling the output axes. On many grids this is the same as geoLonT. More...

real, dimension(:), pointer	gridlonb => NULL()
	The longitude of B points for the purpose of labeling the output axes. On many grids this is the same as geoLonBu. 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 depth units [Z ~> 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 [Z ~> m]. More...

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

real, dimension(:,:), allocatable	dblock_v
	Topographic depths at v-points at which the flow is blocked [Z ~> m]. More...

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

real, dimension(:,:), allocatable	coriolisbu
	The Coriolis parameter at corner points [T-1 ~> s-1]. More...

real, dimension(:,:), allocatable	df_dx
	Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1]. More...

real, dimension(:,:), allocatable	df_dy
	Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1]. More...

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

real	iareat_global
	Global sum of inverse h-cell area (1/areaT_global) [m-2]. More...

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 [m]. More...

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

Variables and constants

◆ areabu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::areabu

areaBu is the area of a q-cell [L ~> m]

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ areacu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::areacu

The areas of the u-grid cells [L2 ~> m2].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ areacv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::areacv

The areas of the v-grid cells [L2 ~> m2].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ areat

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::areat

The area of an h-cell [L2 ~> m2].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ areat_global

real mom_dyn_horgrid::dyn_horgrid_type::areat_global

Global sum of h-cell area [m2].

Definition at line 158 of file MOM_dyn_horgrid.F90.

158 real :: areaT_global !< Global sum of h-cell area [m2]

◆ bathymetry_at_vel

logical mom_dyn_horgrid::dyn_horgrid_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 142 of file MOM_dyn_horgrid.F90.

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

◆ bathyt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::bathyt

Ocean bottom depth at tracer points, in depth units [Z ~> m].

Definition at line 139 of file MOM_dyn_horgrid.F90.

139 real, allocatable, dimension(:,:) :: &

140 bathyT !< Ocean bottom depth at tracer points, in depth units [Z ~> m].

◆ coriolisbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::coriolisbu

The Coriolis parameter at corner points [T-1 ~> s-1].

Definition at line 151 of file MOM_dyn_horgrid.F90.

151 real, allocatable, dimension(:,:) :: &

152 CoriolisBu !< The Coriolis parameter at corner points [T-1 ~> s-1].

◆ cos_rot

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::cos_rot

The cosine of the angular rotation between the local model grid's northward and the true northward directions [nondim].

Definition at line 83 of file MOM_dyn_horgrid.F90.

83 real, allocatable, dimension(:,:) :: cos_rot

◆ dblock_u

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dblock_u

Topographic depths at u-points at which the flow is blocked [Z ~> m].

Definition at line 145 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     Dblock_u, &   !< Topographic depths at u-points at which the flow is blocked [Z ~> m].
     Dopen_u       !< Topographic depths at u-points at which the flow is open at width dy_Cu [Z ~> m].

◆ dblock_v

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dblock_v

Topographic depths at v-points at which the flow is blocked [Z ~> m].

Definition at line 148 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     Dblock_v, &   !< Topographic depths at v-points at which the flow is blocked [Z ~> m].
     Dopen_v       !< Topographic depths at v-points at which the flow is open at width dx_Cv [Z ~> m].

◆ df_dx

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::df_dx

Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

Definition at line 153 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     df_dx, &      !< Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].
     df_dy         !< Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

◆ df_dy

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::df_dy

Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

Definition at line 153 of file MOM_dyn_horgrid.F90.

◆ domain

type(mom_domain_type), pointer mom_dyn_horgrid::dyn_horgrid_type::domain => NULL()

Ocean model domain.

Definition at line 24 of file MOM_dyn_horgrid.F90.

24 type(MOM_domain_type), pointer :: Domain => null() !< Ocean model domain

◆ domain_aux

type(mom_domain_type), pointer mom_dyn_horgrid::dyn_horgrid_type::domain_aux => NULL()

A non-symmetric auxiliary domain type.

Definition at line 25 of file MOM_dyn_horgrid.F90.

25 type(MOM_domain_type), pointer :: Domain_aux => null() !< A non-symmetric auxiliary domain type.

◆ dopen_u

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dopen_u

Topographic depths at u-points at which the flow is open at width dy_Cu [Z ~> m].

Definition at line 145 of file MOM_dyn_horgrid.F90.

◆ dopen_v

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dopen_v

Topographic depths at v-points at which the flow is open at width dx_Cv [Z ~> m].

Definition at line 148 of file MOM_dyn_horgrid.F90.

◆ dx_cv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dx_cv

The unblocked lengths of the v-faces of the h-cell [L ~> m].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ dxbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dxbu

dxBu is delta x at q points [L ~> m].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ dxcu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dxcu

dxCu is delta x at u points [L ~> m].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ dxcv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dxcv

dxCv is delta x at v points [L ~> m].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ dxt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dxt

dxT is delta x at h points [L ~> m].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ dy_cu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dy_cu

The unblocked lengths of the u-faces of the h-cell [L ~> m].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ dybu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dybu

dyBu is delta y at q points [L ~> m].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ dycu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dycu

dyCu is delta y at u points [L ~> m].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ dycv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dycv

dyCv is delta y at v points [L ~> m].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ dyt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::dyt

dyT is delta y at h points [L ~> m].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ first_direction

integer mom_dyn_horgrid::dyn_horgrid_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 66 of file MOM_dyn_horgrid.F90.

66 integer :: first_direction !< An integer that indicates which direction is to be updated first in

◆ geolatbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolatbu

The geographic latitude at q points [degrees of latitude] or [m].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ geolatcu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolatcu

The geographic latitude at u points [degrees of latitude] or [m].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ geolatcv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolatcv

The geographic latitude at v points [degrees of latitude] or [m].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ geolatt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolatt

The geographic latitude at q points [degrees of latitude] or [m].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ geolonbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolonbu

The geographic longitude at q points [degrees of longitude] or [m].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ geoloncu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geoloncu

The geographic longitude at u points [degrees of longitude] or [m].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ geoloncv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geoloncv

The geographic longitude at v points [degrees of longitude] or [m].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ geolont

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::geolont

The geographic longitude at q points [degrees of longitude] or [m].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ gridlatb

real, dimension(:), pointer mom_dyn_horgrid::dyn_horgrid_type::gridlatb => NULL()

The latitude of B points for the purpose of labeling the output axes. On many grids this is the same as geoLatBu.

Definition at line 125 of file MOM_dyn_horgrid.F90.

125 real, pointer, dimension(:) :: gridLatB => null()

◆ gridlatt

real, dimension(:), pointer mom_dyn_horgrid::dyn_horgrid_type::gridlatt => NULL()

The latitude of T points for the purpose of labeling the output axes. On many grids this is the same as geoLatT.

Definition at line 122 of file MOM_dyn_horgrid.F90.

122 real, pointer, dimension(:) :: gridLatT => null()

◆ gridlonb

real, dimension(:), pointer mom_dyn_horgrid::dyn_horgrid_type::gridlonb => NULL()

The longitude of B points for the purpose of labeling the output axes. On many grids this is the same as geoLonBu.

Definition at line 131 of file MOM_dyn_horgrid.F90.

131 real, pointer, dimension(:) :: gridLonB => null()

◆ gridlont

real, dimension(:), pointer mom_dyn_horgrid::dyn_horgrid_type::gridlont => NULL()

The longitude of T points for the purpose of labeling the output axes. On many grids this is the same as geoLonT.

Definition at line 128 of file MOM_dyn_horgrid.F90.

128 real, pointer, dimension(:) :: gridLonT => null()

◆ hi

type(hor_index_type) mom_dyn_horgrid::dyn_horgrid_type::hi

Horizontal index ranges.

Definition at line 26 of file MOM_dyn_horgrid.F90.

26 type(hor_index_type) :: HI !< Horizontal index ranges

◆ iareabu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::iareabu

IareaBu = 1/areaBu [L-2 ~> m-2].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ iareacu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::iareacu

The masked inverse areas of u-grid cells [L-2 ~> m-2].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ iareacv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::iareacv

The masked inverse areas of v-grid cells [L-2 ~> m-2].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ iareat

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::iareat

1/areaT [L-2 ~> m-2].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ iareat_global

real mom_dyn_horgrid::dyn_horgrid_type::iareat_global

Global sum of inverse h-cell area (1/areaT_global) [m-2].

Definition at line 159 of file MOM_dyn_horgrid.F90.

159 real :: IareaT_global !< Global sum of inverse h-cell area (1/areaT_global) [m-2]

◆ idg_offset

integer mom_dyn_horgrid::dyn_horgrid_type::idg_offset

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

Definition at line 60 of file MOM_dyn_horgrid.F90.

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

◆ idxbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idxbu

1/dxBu [L-1 ~> m-1].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ idxcu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idxcu

1/dxCu [L-1 ~> m-1].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ idxcv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idxcv

1/dxCv [L-1 ~> m-1].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ idxt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idxt

1/dxT [L-1 ~> m-1].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ idybu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idybu

1/dyBu [L-1 ~> m-1].

Definition at line 111 of file MOM_dyn_horgrid.F90.

◆ idycu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idycu

1/dyCu [L-1 ~> m-1].

Definition at line 87 of file MOM_dyn_horgrid.F90.

◆ idycv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idycv

1/dyCv [L-1 ~> m-1].

Definition at line 99 of file MOM_dyn_horgrid.F90.

◆ idyt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::idyt

IdyT is 1/dyT [L-1 ~> m-1].

Definition at line 70 of file MOM_dyn_horgrid.F90.

◆ iec

integer mom_dyn_horgrid::dyn_horgrid_type::iec

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

Definition at line 29 of file MOM_dyn_horgrid.F90.

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

◆ iecb

integer mom_dyn_horgrid::dyn_horgrid_type::iecb

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

Definition at line 44 of file MOM_dyn_horgrid.F90.

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

◆ ied

integer mom_dyn_horgrid::dyn_horgrid_type::ied

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

Definition at line 34 of file MOM_dyn_horgrid.F90.

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

◆ iedb

integer mom_dyn_horgrid::dyn_horgrid_type::iedb

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

Definition at line 49 of file MOM_dyn_horgrid.F90.

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

◆ ieg

integer mom_dyn_horgrid::dyn_horgrid_type::ieg

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

Definition at line 39 of file MOM_dyn_horgrid.F90.

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

◆ iegb

integer mom_dyn_horgrid::dyn_horgrid_type::iegb

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

Definition at line 54 of file MOM_dyn_horgrid.F90.

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

◆ isc

integer mom_dyn_horgrid::dyn_horgrid_type::isc

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

Definition at line 28 of file MOM_dyn_horgrid.F90.

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

◆ iscb

integer mom_dyn_horgrid::dyn_horgrid_type::iscb

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

Definition at line 43 of file MOM_dyn_horgrid.F90.

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

◆ isd

integer mom_dyn_horgrid::dyn_horgrid_type::isd

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

Definition at line 33 of file MOM_dyn_horgrid.F90.

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

◆ isd_global

integer mom_dyn_horgrid::dyn_horgrid_type::isd_global

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

Definition at line 58 of file MOM_dyn_horgrid.F90.

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

◆ isdb

integer mom_dyn_horgrid::dyn_horgrid_type::isdb

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

Definition at line 48 of file MOM_dyn_horgrid.F90.

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

◆ isg

integer mom_dyn_horgrid::dyn_horgrid_type::isg

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

Definition at line 38 of file MOM_dyn_horgrid.F90.

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

◆ isgb

integer mom_dyn_horgrid::dyn_horgrid_type::isgb

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

Definition at line 53 of file MOM_dyn_horgrid.F90.

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

◆ jdg_offset

integer mom_dyn_horgrid::dyn_horgrid_type::jdg_offset

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

Definition at line 61 of file MOM_dyn_horgrid.F90.

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

◆ jec

integer mom_dyn_horgrid::dyn_horgrid_type::jec

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

Definition at line 31 of file MOM_dyn_horgrid.F90.

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

◆ jecb

integer mom_dyn_horgrid::dyn_horgrid_type::jecb

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

Definition at line 46 of file MOM_dyn_horgrid.F90.

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

◆ jed

integer mom_dyn_horgrid::dyn_horgrid_type::jed

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

Definition at line 36 of file MOM_dyn_horgrid.F90.

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

◆ jedb

integer mom_dyn_horgrid::dyn_horgrid_type::jedb

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

Definition at line 51 of file MOM_dyn_horgrid.F90.

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

◆ jeg

integer mom_dyn_horgrid::dyn_horgrid_type::jeg

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

Definition at line 41 of file MOM_dyn_horgrid.F90.

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

◆ jegb

integer mom_dyn_horgrid::dyn_horgrid_type::jegb

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

Definition at line 56 of file MOM_dyn_horgrid.F90.

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

◆ jsc

integer mom_dyn_horgrid::dyn_horgrid_type::jsc

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

Definition at line 30 of file MOM_dyn_horgrid.F90.

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

◆ jscb

integer mom_dyn_horgrid::dyn_horgrid_type::jscb

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

Definition at line 45 of file MOM_dyn_horgrid.F90.

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

◆ jsd

integer mom_dyn_horgrid::dyn_horgrid_type::jsd

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

Definition at line 35 of file MOM_dyn_horgrid.F90.

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

◆ jsd_global

integer mom_dyn_horgrid::dyn_horgrid_type::jsd_global

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

Definition at line 59 of file MOM_dyn_horgrid.F90.

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

◆ jsdb

integer mom_dyn_horgrid::dyn_horgrid_type::jsdb

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

Definition at line 50 of file MOM_dyn_horgrid.F90.

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

◆ jsg

integer mom_dyn_horgrid::dyn_horgrid_type::jsg

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

Definition at line 40 of file MOM_dyn_horgrid.F90.

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

◆ jsgb

integer mom_dyn_horgrid::dyn_horgrid_type::jsgb

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

Definition at line 55 of file MOM_dyn_horgrid.F90.

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

◆ len_lat

real mom_dyn_horgrid::dyn_horgrid_type::len_lat = 0.

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

Definition at line 165 of file MOM_dyn_horgrid.F90.

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

◆ len_lon

real mom_dyn_horgrid::dyn_horgrid_type::len_lon = 0.

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

Definition at line 166 of file MOM_dyn_horgrid.F90.

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

◆ mask2dbu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::mask2dbu

0 for boundary points and 1 for ocean points on the q grid [nondim].

Definition at line 111 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     mask2dBu, &  !< 0 for boundary points and 1 for ocean points on the q grid [nondim].
     geoLatBu, &  !< The geographic latitude at q points [degrees of latitude] or [m].
     geoLonBu, &  !< The geographic longitude at q points [degrees of longitude] or [m].
     dxBu, &      !< dxBu is delta x at q points [L ~> m].
     IdxBu, &     !< 1/dxBu [L-1 ~> m-1].
     dyBu, &      !< dyBu is delta y at q points [L ~> m].
     IdyBu, &     !< 1/dyBu [L-1 ~> m-1].
     areaBu, &    !< areaBu is the area of a q-cell [L ~> m]
     IareaBu      !< IareaBu = 1/areaBu [L-2 ~> m-2].

◆ mask2dcu

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::mask2dcu

0 for boundary points and 1 for ocean points on the u grid [nondim].

Definition at line 87 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     mask2dCu, &  !< 0 for boundary points and 1 for ocean points on the u grid [nondim].
     geoLatCu, &  !< The geographic latitude at u points [degrees of latitude] or [m].
     geoLonCu, &  !< The geographic longitude at u points [degrees of longitude] or [m].
     dxCu, &      !< dxCu is delta x at u points [L ~> m].
     IdxCu, &     !< 1/dxCu [L-1 ~> m-1].
     dyCu, &      !< dyCu is delta y at u points [L ~> m].
     IdyCu, &     !< 1/dyCu [L-1 ~> m-1].
     dy_Cu, &     !< The unblocked lengths of the u-faces of the h-cell [L ~> m].
     IareaCu, &   !< The masked inverse areas of u-grid cells [L-2 ~> m-2].
     areaCu       !< The areas of the u-grid cells [L2 ~> m2].

◆ mask2dcv

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::mask2dcv

0 for boundary points and 1 for ocean points on the v grid [nondim].

Definition at line 99 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     mask2dCv, &  !< 0 for boundary points and 1 for ocean points on the v grid [nondim].
     geoLatCv, &  !< The geographic latitude at v points [degrees of latitude] or [m].
     geoLonCv, &  !< The geographic longitude at v points [degrees of longitude] or [m].
     dxCv, &      !< dxCv is delta x at v points [L ~> m].
     IdxCv, &     !< 1/dxCv [L-1 ~> m-1].
     dyCv, &      !< dyCv is delta y at v points [L ~> m].
     IdyCv, &     !< 1/dyCv [L-1 ~> m-1].
     dx_Cv, &     !< The unblocked lengths of the v-faces of the h-cell [L ~> m].
     IareaCv, &   !< The masked inverse areas of v-grid cells [L-2 ~> m-2].
     areaCv       !< The areas of the v-grid cells [L2 ~> m2].

◆ mask2dt

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::mask2dt

0 for land points and 1 for ocean points on the h-grid [nondim].

Definition at line 70 of file MOM_dyn_horgrid.F90.

   real, allocatable, dimension(:,:) :: &
     mask2dT, &   !< 0 for land points and 1 for ocean points on the h-grid [nondim].
     geoLatT, &   !< The geographic latitude at q points [degrees of latitude] or [m].
     geoLonT, &   !< The geographic longitude at q points [degrees of longitude] or [m].
     dxT, &       !< dxT is delta x at h points [L ~> m].
     IdxT, &      !< 1/dxT [L-1 ~> m-1].
     dyT, &       !< dyT is delta y at h points [L ~> m].
     IdyT, &      !< IdyT is 1/dyT [L-1 ~> m-1].
     areaT, &     !< The area of an h-cell [L2 ~> m2].
     IareaT       !< 1/areaT [L-2 ~> m-2].

◆ max_depth

real mom_dyn_horgrid::dyn_horgrid_type::max_depth

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

Definition at line 168 of file MOM_dyn_horgrid.F90.

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

◆ nonblocking_updates

logical mom_dyn_horgrid::dyn_horgrid_type::nonblocking_updates

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

Definition at line 64 of file MOM_dyn_horgrid.F90.

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

◆ rad_earth

real mom_dyn_horgrid::dyn_horgrid_type::rad_earth = 6.378e6

The radius of the planet [m].

Definition at line 167 of file MOM_dyn_horgrid.F90.

167 real :: Rad_Earth = 6.378e6 !< The radius of the planet [m].

◆ sin_rot

real, dimension(:,:), allocatable mom_dyn_horgrid::dyn_horgrid_type::sin_rot

The sine of the angular rotation between the local model grid's northward and the true northward directions [nondim].

Definition at line 80 of file MOM_dyn_horgrid.F90.

80 real, allocatable, dimension(:,:) :: sin_rot

◆ south_lat

real mom_dyn_horgrid::dyn_horgrid_type::south_lat

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

Definition at line 163 of file MOM_dyn_horgrid.F90.

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

◆ symmetric

logical mom_dyn_horgrid::dyn_horgrid_type::symmetric

True if symmetric memory is used.

Definition at line 62 of file MOM_dyn_horgrid.F90.

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

◆ west_lon

real mom_dyn_horgrid::dyn_horgrid_type::west_lon

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

Definition at line 164 of file MOM_dyn_horgrid.F90.

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

◆ x_axis_units

character(len=40) mom_dyn_horgrid::dyn_horgrid_type::x_axis_units

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

Definition at line 134 of file MOM_dyn_horgrid.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_dyn_horgrid::dyn_horgrid_type::y_axis_units

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

Definition at line 134 of file MOM_dyn_horgrid.F90.

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_dyn_horgrid.F90

Detailed Description

Public variables and constants

Variables and constants

◆ areabu

◆ areacu

◆ areacv

◆ areat

◆ areat_global

◆ bathymetry_at_vel

◆ bathyt

◆ coriolisbu

◆ cos_rot

◆ dblock_u

◆ dblock_v

◆ df_dx

◆ df_dy

◆ domain

◆ domain_aux

◆ dopen_u

◆ dopen_v

◆ dx_cv

◆ dxbu

◆ dxcu

◆ dxcv

◆ dxt

◆ dy_cu

◆ dybu

◆ dycu

◆ dycv

◆ dyt

◆ first_direction

◆ 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

◆ jeg

◆ jegb

◆ jsc

◆ jscb