MOM6
mom_dynamics_split_rk2::mom_dyn_split_rk2_cs Type Reference

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:
[legend]

Public variables and constants

real, dimension(:, :, :), allocatable cau
 CAu = f*v - u.grad(u) [m s-2].
 
real, dimension(:, :, :), allocatable pfu
 PFu = -dM/dx [m s-2].
 
real, dimension(:, :, :), allocatable diffu
 Zonal acceleration due to convergence of the along-isopycnal stress tensor [m s-1 T-1 ~> m s-2].
 
real, dimension(:, :, :), allocatable cav
 CAv = -f*u - u.grad(v) [m s-2].
 
real, dimension(:, :, :), allocatable pfv
 PFv = -dM/dy [m s-2].
 
real, dimension(:, :, :), allocatable diffv
 Meridional acceleration due to convergence of the along-isopycnal stress tensor [m s-1 T-1 ~> m s-2].
 
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).
 
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 [m s-2].
 
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).
 
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 [m s-2].
 
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].
 
real, dimension(:, :, :), allocatable u_av
 layer x-velocity with vertical mean replaced by time-mean barotropic velocity over a baroclinic timestep [m s-1]
 
real, dimension(:, :, :), allocatable v_av
 layer y-velocity with vertical mean replaced by time-mean barotropic velocity over a baroclinic timestep [m s-1]
 
real, dimension(:, :, :), allocatable h_av
 arithmetic mean of two successive layer thicknesses [H ~> m or kg m-2]
 
real, dimension(:, :), allocatable eta_pf
 instantaneous SSH used in calculating PFu and PFv [H ~> m or kg m-2]
 
real, dimension(:, :), allocatable uhbt
 average x-volume or mass flux determined by the barotropic solver [H m2 s-1 ~> m3 s-1 or kg s-1]. uhbt is roughly equal to the vertical sum of uh.
 
real, dimension(:, :), allocatable vhbt
 average y-volume or mass flux determined by the barotropic solver [H m2 s-1 ~> m3 s-1 or kg s-1]. vhbt is roughly equal to vertical sum of vh.
 
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].
 
real, dimension(:,:), pointer taux_bot => NULL()
 frictional x-bottom stress from the ocean to the seafloor [Pa]
 
real, dimension(:,:), pointer tauy_bot => NULL()
 frictional y-bottom stress from the ocean to the seafloor [Pa]
 
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.
 
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.
 
logical split_bottom_stress
 If true, provide the bottom stress calculated by the vertical viscosity to the barotropic solver.
 
logical calc_dtbt
 If true, calculate the barotropic time-step dynamically.
 
real be
 A nondimensional number from 0.5 to 1 that controls the backward weighting of the time stepping scheme.
 
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.
 
logical debug
 If true, write verbose checksums for debugging purposes.
 
logical debug_obc
 If true, do debugging calls for open boundary conditions.
 
logical module_is_initialized = .false.
 Record whether this mouled has been initialzed.
 
integer id_uh = -1
 Diagnostic IDs.
 
integer id_vh = -1
 Diagnostic IDs.
 
integer id_umo = -1
 Diagnostic IDs.
 
integer id_vmo = -1
 Diagnostic IDs.
 
integer id_umo_2d = -1
 Diagnostic IDs.
 
integer id_vmo_2d = -1
 Diagnostic IDs.
 
integer id_pfu = -1
 Diagnostic IDs.
 
integer id_pfv = -1
 Diagnostic IDs.
 
integer id_cau = -1
 Diagnostic IDs.
 
integer id_cav = -1
 Diagnostic IDs.
 
integer id_uav = -1
 Diagnostic IDs.
 
integer id_vav = -1
 Diagnostic IDs.
 
integer id_u_bt_accel = -1
 Diagnostic IDs.
 
integer id_v_bt_accel = -1
 Diagnostic IDs.
 
type(diag_ctrl), pointer diag
 A structure that is used to regulate the timing of diagnostic output.
 
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.
 
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.
 
type(hor_visc_cs), pointer hor_visc_csp => NULL()
 A pointer to the horizontal viscosity control structure.
 
type(continuity_cs), pointer continuity_csp => NULL()
 A pointer to the continuity control structure.
 
type(coriolisadv_cs), pointer coriolisadv_csp => NULL()
 A pointer to the CoriolisAdv control structure.
 
type(pressureforce_cs), pointer pressureforce_csp => NULL()
 A pointer to the PressureForce control structure.
 
type(barotropic_cs), pointer barotropic_csp => NULL()
 A pointer to the barotropic stepping control structure.
 
type(thickness_diffuse_cs), pointer thickness_diffuse_csp => NULL()
 A pointer to a structure containing interface height diffusivities.
 
type(vertvisc_cs), pointer vertvisc_csp => NULL()
 A pointer to the vertical viscosity control structure.
 
type(set_visc_cs), pointer set_visc_csp => NULL()
 A pointer to the set_visc control structure.
 
type(tidal_forcing_cs), pointer tides_csp => NULL()
 A pointer to the tidal forcing control structure.
 
type(ale_cs), pointer ale_csp => NULL()
 A pointer to the ALE control structure.
 
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.
 
type(update_obc_cs), pointer update_obc_csp => NULL()
 A pointer to the update_OBC control structure.
 
type(group_pass_type) pass_eta
 Structure for group halo pass.
 
type(group_pass_type) pass_visc_rem
 Structure for group halo pass.
 
type(group_pass_type) pass_uvp
 Structure for group halo pass.
 
type(group_pass_type) pass_hp_uv
 Structure for group halo pass.
 
type(group_pass_type) pass_uv
 Structure for group halo pass.
 
type(group_pass_type) pass_h
 Structure for group halo pass.
 
type(group_pass_type) pass_av_uvh
 Structure for group halo pass.
 

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