Detailed Description

MOM_dynamics_unsplit_RK2 module control structure.

Definition at line 104 of file MOM_dynamics_unsplit_RK2.F90.

Collaboration diagram for mom_dynamics_unsplit_rk2::mom_dyn_unsplit_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(:,:), 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...

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	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_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...

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

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

type(cont_diag_ptrs), pointer	cdp => NULL()
	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(vertvisc_cs), pointer	vertvisc_csp => NULL()
	A pointer to the vertvisc 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...

Variables and constants

◆ adp

type(accel_diag_ptrs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::adp => NULL()

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

Definition at line 137 of file MOM_dynamics_unsplit_RK2.F90.

137 type(accel_diag_ptrs), pointer :: ADp => null() !< A structure pointing to the

◆ ale_csp

type(ale_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::ale_csp => NULL()

A pointer to the ALE control structure.

Definition at line 162 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ be

real mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::be

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

Definition at line 120 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ begw

real mom_dynamics_unsplit_rk2::mom_dyn_unsplit_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 122 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ cau

real, dimension( : , : , : ), allocatable mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::cau

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

Definition at line 105 of file MOM_dynamics_unsplit_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_unsplit_rk2::mom_dyn_unsplit_rk2_cs::cav

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

Definition at line 110 of file MOM_dynamics_unsplit_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_unsplit_rk2::mom_dyn_unsplit_rk2_cs::cdp => NULL()

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 141 of file MOM_dynamics_unsplit_RK2.F90.

141 type(cont_diag_ptrs), pointer :: CDp => null() !< A structure with pointers to

◆ continuity_csp

type(continuity_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::continuity_csp => NULL()

A pointer to the continuity control structure.

Definition at line 150 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ coriolisadv_csp

type(coriolisadv_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::coriolisadv_csp => NULL()

A pointer to the CoriolisAdv control structure.

Definition at line 152 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ debug

logical mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::debug

If true, write verbose checksums for debugging purposes.

Definition at line 126 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ diag

type(diag_ctrl), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::diag => NULL()

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

Definition at line 135 of file MOM_dynamics_unsplit_RK2.F90.

135 type(diag_ctrl), pointer :: diag => null() !< A structure that is used to

◆ diffu

real, dimension( : , : , : ), allocatable mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::diffu

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

Definition at line 105 of file MOM_dynamics_unsplit_RK2.F90.

◆ diffv

real, dimension( : , : , : ), allocatable mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::diffv

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

Definition at line 110 of file MOM_dynamics_unsplit_RK2.F90.

◆ hor_visc_csp

type(hor_visc_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::hor_visc_csp => NULL()

A pointer to the horizontal viscosity control structure.

Definition at line 148 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ id_cau

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_cau = -1

Diagnostic IDs.

Definition at line 132 of file MOM_dynamics_unsplit_RK2.F90.

◆ id_cav

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_cav = -1

Diagnostic IDs.

Definition at line 132 of file MOM_dynamics_unsplit_RK2.F90.

◆ id_pfu

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_pfu = -1

Diagnostic IDs.

Definition at line 132 of file MOM_dynamics_unsplit_RK2.F90.

132 integer :: id_PFu = -1, id_pfv = -1, id_cau = -1, id_cav = -1

◆ id_pfv

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_pfv = -1

Diagnostic IDs.

Definition at line 132 of file MOM_dynamics_unsplit_RK2.F90.

◆ id_uh

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_uh = -1

Diagnostic IDs.

Definition at line 131 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ id_vh

integer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::id_vh = -1

Diagnostic IDs.

Definition at line 131 of file MOM_dynamics_unsplit_RK2.F90.

◆ module_is_initialized

logical mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::module_is_initialized = .false.

Record whether this mouled has been initialzed.

Definition at line 128 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ obc

type(ocean_obc_type), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_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 164 of file MOM_dynamics_unsplit_RK2.F90.

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

◆ pfu

real, dimension( : , : , : ), allocatable mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::pfu

PFu = -dM/dx [L T-2 ~> m s-2].

Definition at line 105 of file MOM_dynamics_unsplit_RK2.F90.

◆ pfv

real, dimension( : , : , : ), allocatable mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::pfv

PFv = -dM/dy [L T-2 ~> m s-2].

Definition at line 110 of file MOM_dynamics_unsplit_RK2.F90.

◆ pressureforce_csp

type(pressureforce_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::pressureforce_csp => NULL()

A pointer to the PressureForce control structure.

Definition at line 154 of file MOM_dynamics_unsplit_RK2.F90.

154 type(PressureForce_CS), pointer :: PressureForce_CSp => null()

◆ set_visc_csp

type(set_visc_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::set_visc_csp => NULL()

A pointer to the set_visc control structure.

Definition at line 158 of file MOM_dynamics_unsplit_RK2.F90.

158 type(set_visc_CS), pointer :: set_visc_CSp => null()

◆ taux_bot

real, dimension(:,:), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::taux_bot => NULL()

frictional x-bottom stress from the ocean to the seafloor [R L Z T-2 ~> Pa]

Definition at line 115 of file MOM_dynamics_unsplit_RK2.F90.

115 real, pointer, dimension(:,:) :: taux_bot => null() !< frictional x-bottom stress from the ocean

◆ tauy_bot

real, dimension(:,:), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::tauy_bot => NULL()

frictional y-bottom stress from the ocean to the seafloor [R L Z T-2 ~> Pa]

Definition at line 117 of file MOM_dynamics_unsplit_RK2.F90.

117 real, pointer, dimension(:,:) :: tauy_bot => null() !< frictional y-bottom stress from the ocean

◆ tides_csp

type(tidal_forcing_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::tides_csp => NULL()

A pointer to the tidal forcing control structure.

Definition at line 160 of file MOM_dynamics_unsplit_RK2.F90.

160 type(tidal_forcing_CS), pointer :: tides_CSp => null()

◆ update_obc_csp

type(update_obc_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::update_obc_csp => NULL()

A pointer to the update_OBC control structure.

Definition at line 169 of file MOM_dynamics_unsplit_RK2.F90.

169 type(update_OBC_CS), pointer :: update_OBC_CSp => null()

◆ vertvisc_csp

type(vertvisc_cs), pointer mom_dynamics_unsplit_rk2::mom_dyn_unsplit_rk2_cs::vertvisc_csp => NULL()

A pointer to the vertvisc control structure.

Definition at line 156 of file MOM_dynamics_unsplit_RK2.F90.

156 type(vertvisc_CS), pointer :: vertvisc_CSp => null()

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/core/MOM_dynamics_unsplit_RK2.F90

Detailed Description

Public variables and constants

Variables and constants

◆ adp

◆ ale_csp

◆ be

◆ begw

◆ cau

◆ cav

◆ cdp

◆ continuity_csp

◆ coriolisadv_csp

◆ debug

◆ diag

◆ diffu

◆ diffv

◆ hor_visc_csp

◆ id_cau

◆ id_cav

◆ id_pfu

◆ id_pfv

◆ id_uh

◆ id_vh

◆ module_is_initialized

◆ obc

◆ pfu

◆ pfv

◆ pressureforce_csp

◆ set_visc_csp

◆ taux_bot

◆ tauy_bot

◆ tides_csp

◆ update_obc_csp

◆ vertvisc_csp