Detailed Description

MOM_dynamics_split_RK2 module control structure.

Definition at line 70 of file MOM_dynamics_split_RK2.F90.

Collaboration diagram for mom_dynamics_split_rk2::mom_dyn_split_rk2_cs:

Public variables and constants
real, dimension(:, :, :), allocatable	cau
	CAu = f*v - u.grad(u) [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	pfu
	PFu = -dM/dx [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	diffu
	Zonal acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	cav
	CAv = -f*u - u.grad(v) [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	pfv
	PFv = -dM/dy [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	diffv
	Meridional acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	visc_rem_u
	Both the fraction of the zonal momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step worth of a barotropic acceleration that a layer experiences after viscosity is applied. Nondimensional between 0 (at the bottom) and 1 (far above). More...

real, dimension(:, :, :), allocatable	u_accel_bt
	The zonal layer accelerations due to the difference between the barotropic accelerations and the baroclinic accelerations that were fed into the barotopic calculation [L T-2 ~> m s-2]. More...

real, dimension(:, :, :), allocatable	visc_rem_v
	Both the fraction of the meridional momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step worth of a barotropic acceleration that a layer experiences after viscosity is applied. Nondimensional between 0 (at the bottom) and 1 (far above). More...

real, dimension(:, :, :), allocatable	v_accel_bt
	The meridional layer accelerations due to the difference between the barotropic accelerations and the baroclinic accelerations that were fed into the barotopic calculation [L T-2 ~> m s-2]. More...

real, dimension(:, :), allocatable	eta
	Instantaneous free surface height (in Boussinesq mode) or column mass anomaly (in non-Boussinesq mode) [H ~> m or kg m-2]. More...

real, dimension(:, :, :), allocatable	u_av
	layer x-velocity with vertical mean replaced by time-mean barotropic velocity over a baroclinic timestep [L T-1 ~> m s-1] More...

real, dimension(:, :, :), allocatable	v_av
	layer y-velocity with vertical mean replaced by time-mean barotropic velocity over a baroclinic timestep [L T-1 ~> m s-1] More...

real, dimension(:, :, :), allocatable	h_av
	arithmetic mean of two successive layer thicknesses [H ~> m or kg m-2] More...

real, dimension(:, :), allocatable	eta_pf
	instantaneous SSH used in calculating PFu and PFv [H ~> m or kg m-2] More...

real, dimension(:, :), allocatable	uhbt
	average x-volume or mass flux determined by the barotropic solver [H L2 T-1 ~> m3 s-1 or kg s-1]. uhbt is roughly equal to the vertical sum of uh. More...

real, dimension(:, :), allocatable	vhbt
	average y-volume or mass flux determined by the barotropic solver [H L2 T-1 ~> m3 s-1 or kg s-1]. vhbt is roughly equal to vertical sum of vh. More...

real, dimension(:, :, :), allocatable	pbce
	pbce times eta gives the baroclinic pressure anomaly in each layer due to free surface height anomalies [L2 H-1 T-2 ~> m s-2 or m4 kg-1 s-2]. More...

real, dimension(:,:), pointer	taux_bot => NULL()
	frictional x-bottom stress from the ocean to the seafloor [R L Z T-2 ~> Pa] More...

real, dimension(:,:), pointer	tauy_bot => NULL()
	frictional y-bottom stress from the ocean to the seafloor [R L Z T-2 ~> Pa] More...

type(bt_cont_type), pointer	bt_cont => NULL()
	A structure with elements that describe the effective summed open face areas as a function of barotropic flow. More...

logical	bt_use_layer_fluxes
	If true, use the summed layered fluxes plus an adjustment due to a changed barotropic velocity in the barotropic continuity equation. More...

logical	split_bottom_stress
	If true, provide the bottom stress calculated by the vertical viscosity to the barotropic solver. More...

logical	calc_dtbt
	If true, calculate the barotropic time-step dynamically. More...

real	be
	A nondimensional number from 0.5 to 1 that controls the backward weighting of the time stepping scheme. More...

real	begw
	A nondimensional number from 0 to 1 that controls the extent to which the treatment of gravity waves is forward-backward (0) or simulated backward Euler (1). 0 is almost always used. More...

logical	debug
	If true, write verbose checksums for debugging purposes. More...

logical	debug_obc
	If true, do debugging calls for open boundary conditions. More...

logical	module_is_initialized = .false.
	Record whether this mouled has been initialzed. More...


integer	id_uh = -1
	Diagnostic IDs. More...

integer	id_vh = -1
	Diagnostic IDs. More...

integer	id_umo = -1
	Diagnostic IDs. More...

integer	id_vmo = -1
	Diagnostic IDs. More...

integer	id_umo_2d = -1
	Diagnostic IDs. More...

integer	id_vmo_2d = -1
	Diagnostic IDs. More...

integer	id_pfu = -1
	Diagnostic IDs. More...

integer	id_pfv = -1
	Diagnostic IDs. More...

integer	id_cau = -1
	Diagnostic IDs. More...

integer	id_cav = -1
	Diagnostic IDs. More...

integer	id_uav = -1
	Diagnostic IDs. More...

integer	id_vav = -1
	Diagnostic IDs. More...

integer	id_u_bt_accel = -1
	Diagnostic IDs. More...

integer	id_v_bt_accel = -1
	Diagnostic IDs. More...

type(diag_ctrl), pointer	diag
	A structure that is used to regulate the timing of diagnostic output. More...

type(accel_diag_ptrs), pointer	adp
	A structure pointing to the various accelerations in the momentum equations, which can later be used to calculate derived diagnostics like energy budgets. More...

type(cont_diag_ptrs), pointer	cdp
	A structure with pointers to various terms in the continuity equations, which can later be used to calculate derived diagnostics like energy budgets. More...

type(hor_visc_cs), pointer	hor_visc_csp => NULL()
	A pointer to the horizontal viscosity control structure. More...

type(continuity_cs), pointer	continuity_csp => NULL()
	A pointer to the continuity control structure. More...

type(coriolisadv_cs), pointer	coriolisadv_csp => NULL()
	A pointer to the CoriolisAdv control structure. More...

type(pressureforce_cs), pointer	pressureforce_csp => NULL()
	A pointer to the PressureForce control structure. More...

type(barotropic_cs), pointer	barotropic_csp => NULL()
	A pointer to the barotropic stepping control structure. More...

type(thickness_diffuse_cs), pointer	thickness_diffuse_csp => NULL()
	A pointer to a structure containing interface height diffusivities. More...

type(vertvisc_cs), pointer	vertvisc_csp => NULL()
	A pointer to the vertical viscosity control structure. More...

type(set_visc_cs), pointer	set_visc_csp => NULL()
	A pointer to the set_visc control structure. More...

type(tidal_forcing_cs), pointer	tides_csp => NULL()
	A pointer to the tidal forcing control structure. More...

type(ale_cs), pointer	ale_csp => NULL()
	A pointer to the ALE control structure. More...

type(ocean_obc_type), pointer	obc => NULL()
	A pointer to an open boundary condition type that specifies whether, where, and what open boundary conditions are used. If no open BCs are used, this pointer stays nullified. Flather OBCs use open boundary_CS as well. More...

type(update_obc_cs), pointer	update_obc_csp => NULL()
	A pointer to the update_OBC control structure. More...

type(group_pass_type)	pass_eta
	Structure for group halo pass. More...

type(group_pass_type)	pass_visc_rem
	Structure for group halo pass. More...

type(group_pass_type)	pass_uvp
	Structure for group halo pass. More...

type(group_pass_type)	pass_hp_uv
	Structure for group halo pass. More...

type(group_pass_type)	pass_uv
	Structure for group halo pass. More...

type(group_pass_type)	pass_h
	Structure for group halo pass. More...

type(group_pass_type)	pass_av_uvh
	Structure for group halo pass. More...

Variables and constants

◆ adp

type(accel_diag_ptrs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::adp

A structure pointing to the various accelerations in the momentum equations, which can later be used to calculate derived diagnostics like energy budgets.

Definition at line 170 of file MOM_dynamics_split_RK2.F90.

170 type(accel_diag_ptrs), pointer :: ADp !< A structure pointing to the various

◆ ale_csp

type(ale_cs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::ale_csp => NULL()

A pointer to the ALE control structure.

Definition at line 199 of file MOM_dynamics_split_RK2.F90.

199 type(ALE_CS), pointer :: ALE_CSp => null()

◆ barotropic_csp

type(barotropic_cs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::barotropic_csp => NULL()

A pointer to the barotropic stepping control structure.

Definition at line 189 of file MOM_dynamics_split_RK2.F90.

189 type(barotropic_CS), pointer :: barotropic_CSp => null()

◆ be

real mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::be

A nondimensional number from 0.5 to 1 that controls the backward weighting of the time stepping scheme.

Definition at line 145 of file MOM_dynamics_split_RK2.F90.

145 real :: be !< A nondimensional number from 0.5 to 1 that controls

◆ begw

real mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::begw

A nondimensional number from 0 to 1 that controls the extent to which the treatment of gravity waves is forward-backward (0) or simulated backward Euler (1). 0 is almost always used.

Definition at line 147 of file MOM_dynamics_split_RK2.F90.

147 real :: begw !< A nondimensional number from 0 to 1 that controls

◆ bt_cont

type(bt_cont_type), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::bt_cont => NULL()

A structure with elements that describe the effective summed open face areas as a function of barotropic flow.

Definition at line 130 of file MOM_dynamics_split_RK2.F90.

130 type(BT_cont_type), pointer :: BT_cont => null() !< A structure with elements that describe the

◆ bt_use_layer_fluxes

logical mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::bt_use_layer_fluxes

If true, use the summed layered fluxes plus an adjustment due to a changed barotropic velocity in the barotropic continuity equation.

Definition at line 136 of file MOM_dynamics_split_RK2.F90.

136 logical :: BT_use_layer_fluxes !< If true, use the summed layered fluxes plus

◆ calc_dtbt

logical mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::calc_dtbt

If true, calculate the barotropic time-step dynamically.

Definition at line 142 of file MOM_dynamics_split_RK2.F90.

142 logical :: calc_dtbt !< If true, calculate the barotropic time-step

◆ cau

real, dimension( : , : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::cau

CAu = f*v - u.grad(u) [L T-2 ~> m s-2].

Definition at line 71 of file MOM_dynamics_split_RK2.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEM_,NKMEM_) :: &
     CAu, &    !< CAu = f*v - u.grad(u) [L T-2 ~> m s-2]
     PFu, &    !< PFu = -dM/dx [L T-2 ~> m s-2]
     diffu     !< Zonal acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2]

◆ cav

real, dimension( : , : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::cav

CAv = -f*u - u.grad(v) [L T-2 ~> m s-2].

Definition at line 76 of file MOM_dynamics_split_RK2.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEMB_PTR_,NKMEM_) :: &
     CAv, &    !< CAv = -f*u - u.grad(v) [L T-2 ~> m s-2]
     PFv, &    !< PFv = -dM/dy [L T-2 ~> m s-2]
     diffv     !< Meridional acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2]

◆ cdp

type(cont_diag_ptrs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::cdp

A structure with pointers to various terms in the continuity equations, which can later be used to calculate derived diagnostics like energy budgets.

Definition at line 174 of file MOM_dynamics_split_RK2.F90.

174 type(cont_diag_ptrs), pointer :: CDp !< A structure with pointers to various

◆ continuity_csp

type(continuity_cs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::continuity_csp => NULL()

A pointer to the continuity control structure.

Definition at line 183 of file MOM_dynamics_split_RK2.F90.

183 type(continuity_CS), pointer :: continuity_CSp => null()

◆ coriolisadv_csp

type(coriolisadv_cs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::coriolisadv_csp => NULL()

A pointer to the CoriolisAdv control structure.

Definition at line 185 of file MOM_dynamics_split_RK2.F90.

185 type(CoriolisAdv_CS), pointer :: CoriolisAdv_CSp => null()

◆ debug

logical mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::debug

If true, write verbose checksums for debugging purposes.

Definition at line 151 of file MOM_dynamics_split_RK2.F90.

151 logical :: debug !< If true, write verbose checksums for debugging purposes.

◆ debug_obc

logical mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::debug_obc

If true, do debugging calls for open boundary conditions.

Definition at line 152 of file MOM_dynamics_split_RK2.F90.

152 logical :: debug_OBC !< If true, do debugging calls for open boundary conditions.

◆ diag

type(diag_ctrl), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::diag

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

Definition at line 168 of file MOM_dynamics_split_RK2.F90.

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

◆ diffu

real, dimension( : , : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::diffu

Zonal acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2].

Definition at line 71 of file MOM_dynamics_split_RK2.F90.

◆ diffv

real, dimension( : , : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::diffv

Meridional acceleration due to convergence of the along-isopycnal stress tensor [L T-2 ~> m s-2].

Definition at line 76 of file MOM_dynamics_split_RK2.F90.

◆ eta

real, dimension( : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::eta

Instantaneous free surface height (in Boussinesq mode) or column mass anomaly (in non-Boussinesq mode) [H ~> m or kg m-2].

Definition at line 103 of file MOM_dynamics_split_RK2.F90.

103 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: eta !< Instantaneous free surface height (in Boussinesq

◆ eta_pf

real, dimension( : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::eta_pf

instantaneous SSH used in calculating PFu and PFv [H ~> m or kg m-2]

Definition at line 114 of file MOM_dynamics_split_RK2.F90.

114 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: eta_PF !< instantaneous SSH used in calculating PFu and

◆ h_av

real, dimension( : , : , : ), allocatable mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::h_av

arithmetic mean of two successive layer thicknesses [H ~> m or kg m-2]

Definition at line 112 of file MOM_dynamics_split_RK2.F90.

112 real ALLOCABLE_, dimension(NIMEM_,NJMEM_,NKMEM_) :: h_av !< arithmetic mean of two successive layer

◆ hor_visc_csp

type(hor_visc_cs), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::hor_visc_csp => NULL()

A pointer to the horizontal viscosity control structure.

Definition at line 181 of file MOM_dynamics_split_RK2.F90.

181 type(hor_visc_CS), pointer :: hor_visc_CSp => null()

◆ id_cau

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_cau = -1

Diagnostic IDs.

Definition at line 161 of file MOM_dynamics_split_RK2.F90.

161 integer :: id_CAu = -1, id_cav = -1

◆ id_cav

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_cav = -1

Diagnostic IDs.

Definition at line 161 of file MOM_dynamics_split_RK2.F90.

◆ id_pfu

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_pfu = -1

Diagnostic IDs.

Definition at line 160 of file MOM_dynamics_split_RK2.F90.

160 integer :: id_PFu = -1, id_pfv = -1

◆ id_pfv

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_pfv = -1

Diagnostic IDs.

Definition at line 160 of file MOM_dynamics_split_RK2.F90.

◆ id_u_bt_accel

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_u_bt_accel = -1

Diagnostic IDs.

Definition at line 165 of file MOM_dynamics_split_RK2.F90.

165 integer :: id_u_BT_accel = -1, id_v_bt_accel = -1

◆ id_uav

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_uav = -1

Diagnostic IDs.

Definition at line 164 of file MOM_dynamics_split_RK2.F90.

164 integer :: id_uav = -1, id_vav = -1

◆ id_uh

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_uh = -1

Diagnostic IDs.

Definition at line 157 of file MOM_dynamics_split_RK2.F90.

157 integer :: id_uh = -1, id_vh = -1

◆ id_umo

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_umo = -1

Diagnostic IDs.

Definition at line 158 of file MOM_dynamics_split_RK2.F90.

158 integer :: id_umo = -1, id_vmo = -1

◆ id_umo_2d

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_umo_2d = -1

Diagnostic IDs.

Definition at line 159 of file MOM_dynamics_split_RK2.F90.

159 integer :: id_umo_2d = -1, id_vmo_2d = -1

◆ id_v_bt_accel

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_v_bt_accel = -1

Diagnostic IDs.

Definition at line 165 of file MOM_dynamics_split_RK2.F90.

◆ id_vav

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_vav = -1

Diagnostic IDs.

Definition at line 164 of file MOM_dynamics_split_RK2.F90.

◆ id_vh

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_vh = -1

Diagnostic IDs.

Definition at line 157 of file MOM_dynamics_split_RK2.F90.

◆ id_vmo

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_vmo = -1

Diagnostic IDs.

Definition at line 158 of file MOM_dynamics_split_RK2.F90.

◆ id_vmo_2d

integer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::id_vmo_2d = -1

Diagnostic IDs.

Definition at line 159 of file MOM_dynamics_split_RK2.F90.

◆ module_is_initialized

logical mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::module_is_initialized = .false.

Record whether this mouled has been initialzed.

Definition at line 154 of file MOM_dynamics_split_RK2.F90.

154 logical :: module_is_initialized = .false. !< Record whether this mouled has been initialzed.

◆ obc

type(ocean_obc_type), pointer mom_dynamics_split_rk2::mom_dyn_split_rk2_cs::obc => NULL()

A pointer to an open boundary condition type that specifies whether, where, and what open boundary conditions are used. If no open BCs are used, this pointer stays nullified. Flather OBCs use open boundary_CS as well.

Definition at line 201 of file MOM_dynamics_split_RK2.F90.

201 type(ocean_OBC_type), pointer :: OBC => null() !< A pointer to an open boundary