MOM6
mom_internal_tides::int_tide_cs Type Reference

Detailed Description

This control structure has parameters for the MOM_internal_tides module.

Definition at line 38 of file MOM_internal_tides.F90.

Collaboration diagram for mom_internal_tides::int_tide_cs:
[legend]

Public variables and constants

logical do_int_tides
 If true, use the internal tide code.
 
integer nfreq = 0
 The number of internal tide frequency bands.
 
integer nmode = 1
 The number of internal tide vertical modes.
 
integer nangle = 24
 The number of internal tide angular orientations.
 
integer energized_angle = -1
 If positive, only this angular band is energized for debugging purposes.
 
logical corner_adv
 If true, use a corner advection rather than PPM.
 
logical upwind_1st
 If true, use a first-order upwind scheme.
 
logical simple_2nd
 If true, use a simple second order (arithmetic mean) interpolation of the edge values instead of the higher order interpolation.
 
logical vol_cfl
 If true, use the ratio of the open face lengths to the tracer cell areas when estimating CFL numbers. Without aggress_adjust, the default is false; it is always true with aggress_adjust.
 
logical use_ppmang
 If true, use PPM for advection of energy in angular space.
 
real, dimension(:,:), allocatable refl_angle
 local coastline/ridge/shelf angles read from file
 
real nullangle = -999.9
 placeholder value in cells with no reflection
 
real, dimension(:,:), allocatable refl_pref
 partial reflection coeff for each "coast cell"
 
logical, dimension(:,:), allocatable refl_pref_logical
 true if reflecting cell with partial reflection
 
logical, dimension(:,:), allocatable refl_dbl
 identifies reflection cells where double reflection is possible (i.e. ridge cells)
 
real, dimension(:,:,:,:), allocatable cp
 horizontal phase speed [m s-1]
 
real, dimension(:,:,:,:,:), allocatable tke_leak_loss
 energy lost due to misc background processes [W m-2]
 
real, dimension(:,:,:,:,:), allocatable tke_quad_loss
 energy lost due to quadratic bottom drag [W m-2]
 
real, dimension(:,:,:,:,:), allocatable tke_froude_loss
 energy lost due to wave breaking [W m-2]
 
real, dimension(:,:), allocatable tke_itidal_loss_fixed
 fixed part of the energy lost due to small-scale drag [kg Z-2 ~> kg m-2] here; will be multiplied by N and En to get into [W m-2]
 
real, dimension(:,:,:,:,:), allocatable tke_itidal_loss
 energy lost due to small-scale wave drag [W m-2]
 
real, dimension(:,:), allocatable tot_leak_loss
 Energy loss rates due to misc bakground processes, summed over angle, frequency and mode [W m-2].
 
real, dimension(:,:), allocatable tot_quad_loss
 Energy loss rates due to quadratic bottom drag, summed over angle, frequency and mode [W m-2].
 
real, dimension(:,:), allocatable tot_itidal_loss
 Energy loss rates due to small-scale drag, summed over angle, frequency and mode [W m-2].
 
real, dimension(:,:), allocatable tot_froude_loss
 Energy loss rates due to wave breaking, summed over angle, frequency and mode [W m-2].
 
real, dimension(:,:), allocatable tot_allprocesses_loss
 Energy loss rates due to all processes, summed over angle, frequency and mode [W m-2].
 
real q_itides
 fraction of local dissipation [nondim]
 
real en_sum
 global sum of energy for use in debugging
 
type(time_type), pointer time => NULL()
 A pointer to the model's clock.
 
character(len=200) inputdir
 directory to look for coastline angle file
 
real decay_rate
 A constant rate at which internal tide energy is lost to the interior ocean internal wave field.
 
real cdrag
 The bottom drag coefficient [nondim].
 
logical apply_background_drag
 If true, apply a drag due to background processes as a sink.
 
logical apply_bottom_drag
 If true, apply a quadratic bottom drag as a sink.
 
logical apply_wave_drag
 If true, apply scattering due to small-scale roughness as a sink.
 
logical apply_froude_drag
 If true, apply wave breaking as a sink.
 
real, dimension(:,:,:,:,:), pointer en => NULL()
 The internal wave energy density as a function of (i,j,angle,frequency,mode)
 
real, dimension(:,:,:), pointer en_restart => NULL()
 The internal wave energy density as a function of (i,j,angle); temporary for restart.
 
real, dimension(:), allocatable frequency
 The frequency of each band [s-1].
 
type(diag_ctrl), pointer diag => NULL()
 A structure that is used to regulate the timing of diagnostic output.
 
type(wave_structure_cs), pointer wave_structure_csp => NULL()
 A pointer to the wave_structure module control structure.
 
integer id_tot_en = -1
 Diag handles.
 
integer id_tke_itidal_input = -1
 Diag handles.
 
integer id_itide_drag = -1
 Diag handles.
 
integer id_refl_pref = -1
 Diag handles.
 
integer id_refl_ang = -1
 Diag handles.
 
integer id_land_mask = -1
 Diag handles.
 
integer id_dx_cv = -1
 Diag handles.
 
integer id_dy_cu = -1
 Diag handles.
 
integer id_tot_leak_loss = -1
 Diag handles.
 
integer id_tot_quad_loss = -1
 Diag handles.
 
integer id_tot_itidal_loss = -1
 Diag handles.
 
integer id_tot_froude_loss = -1
 Diag handles.
 
integer id_tot_allprocesses_loss = -1
 Diag handles.
 
integer, dimension(:,:), allocatable id_en_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_itidal_loss_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_allprocesses_loss_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_ub_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_cp_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_en_ang_mode
 Diag handles.
 
integer, dimension(:,:), allocatable id_itidal_loss_ang_mode
 Diag handles.
 

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