mom_internal_tides mom_internal_tides::int_tide_cs mom_internal_tides::loop_bounds_type subroutine, public subroutine, public mom_internal_tides::propagate_int_tide (h, tv, cn, TKE_itidal_input, vel_btTide, Nb, dt, G, GV, US, CS) propagate_int_tide h h tv tv cn cn TKE_itidal_input TKE_itidal_input vel_btTide vel_btTide Nb Nb dt dt G G GV GV US US CS CS Calls subroutines in this file that are needed to refract, propagate, and dissipate energy density of the internal tide. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] tv Pointer to thermodynamic variables (needed for wave structure). tke_itidal_input The energy input to the internal waves [R Z3 T-3 ~> W m-2]. vel_bttide Barotropic velocity read from file [L T-1 ~> m s-1]. nb Near-bottom buoyancy frequency [T-1 ~> s-1]. dt Length of time over which to advance the internal tides [T ~> s]. cs The control structure returned by a previous call to int_tide_init. cn The internal wave speeds of each mom_domains::complete_group_pass correct_halo_rotation itidal_lowmode_loss mom_error_handler::mom_error propagate refract mom_domains::start_group_pass sum_en mom_wave_structure::wave_structure subroutine subroutine mom_internal_tides::sum_en (G, CS, En, label) sum_en G G CS CS En En label label Checks for energy conservation on computational domain. g The ocean's grid structure. cs The control structure returned by a previous call to int_tide_init. en The energy density of the internal tides [R Z3 T-2 ~> J m-2]. label A label to use in error messages mom_spatial_means::global_area_mean propagate_int_tide subroutine subroutine mom_internal_tides::itidal_lowmode_loss (G, US, CS, Nb, Ub, En, TKE_loss_fixed, TKE_loss, dt, full_halos) itidal_lowmode_loss G G US US CS CS Nb Nb Ub Ub En En TKE_loss_fixed TKE_loss_fixed TKE_loss TKE_loss dt dt full_halos full_halos Calculates the energy lost from the propagating internal tide due to scattering over small-scale roughness along the lines of Jayne & St. Laurent (2001). g The ocean's grid structure. us A dimensional unit scaling type cs The control structure returned by a previous call to int_tide_init. nb Near-bottom stratification [T-1 ~> s-1]. ub RMS (over one period) near-bottom horizontal tke_loss_fixed Fixed part of energy loss [R L-2 Z3 ~> kg m-2] en Energy density of the internal waves [R Z3 T-2 ~> J m-2]. tke_loss Energy loss rate [R Z3 T-3 ~> W m-2] dt Time increment [T ~> s]. full_halos If true, do the calculation over the entirecomputational domain. propagate_int_tide subroutine, public subroutine, public mom_internal_tides::get_lowmode_loss (i, j, G, CS, mechanism, TKE_loss_sum) get_lowmode_loss i i j j G G CS CS mechanism mechanism TKE_loss_sum TKE_loss_sum This subroutine extracts the energy lost from the propagating internal which has been summed across all angles, frequencies, and modes for a given mechanism and location. It can be called from another module to get values from this module's (private) CS. i The i-index of the value to be reported. j The j-index of the value to be reported. g The ocean's grid structure cs The control structure returned by a previous call to int_tide_init. mechanism The named mechanism of loss to return tke_loss_sum Total energy loss rate due to specified mechanism [R Z3 T-3 ~> W m-2]. subroutine subroutine mom_internal_tides::refract (En, cn, freq, dt, G, US, NAngle, use_PPMang) refract En En cn cn freq freq dt dt G G US US NAngle NAngle use_PPMang use_PPMang Implements refraction on the internal waves at a single frequency. g The ocean's grid structure. nangle The number of wave orientations in the discretized wave energy spectrum. en The internal gravity wave energy density as a cn Baroclinic mode speed [L T-1 ~> m s-1]. freq Wave frequency [T-1 ~> s-1]. dt Time step [T ~> s]. us A dimensional unit scaling type use_ppmang If true, use PPM for advection rather than upwind. mom_error_handler::mom_error ppm_angular_advect propagate_int_tide subroutine subroutine mom_internal_tides::ppm_angular_advect (En2d, CFL_ang, Flux_En, NAngle, dt, halo_ang) ppm_angular_advect En2d En2d CFL_ang CFL_ang Flux_En Flux_En NAngle NAngle dt dt halo_ang halo_ang This subroutine calculates the 1-d flux for advection in angular space using a monotonic piecewise parabolic scheme. This needs to be called from within i and j spatial loops. nangle The number of wave orientations in the discretized wave energy spectrum. dt Time increment [T ~> s]. halo_ang The halo size in angular space en2d The internal gravity wave energy density as a cfl_ang The CFL number of the energy advection across angles flux_en The time integrated internal wave energy flux across angles [R Z3 T-2 ~> J m-2]. refract subroutine subroutine mom_internal_tides::propagate (En, cn, freq, dt, G, US, CS, NAngle) propagate En En cn cn freq freq dt dt G G US US CS CS NAngle NAngle Propagates internal waves at a single frequency. g The ocean's grid structure. nangle The number of wave orientations in the discretized wave energy spectrum. en The internal gravity wave energy density as a cn Baroclinic mode speed [L T-1 ~> m s-1]. freq Wave frequency [T-1 ~> s-1]. dt Time step [T ~> s]. us A dimensional unit scaling type cs The control structure returned by a previous call to int_tide_init. propagate_corner_spread propagate_x propagate_y propagate_int_tide subroutine subroutine mom_internal_tides::propagate_corner_spread (En, energized_wedge, NAngle, speed, dt, G, CS, LB) propagate_corner_spread En En energized_wedge energized_wedge NAngle NAngle speed speed dt dt G G CS CS LB LB This subroutine does first-order corner advection. It was written with the hopes of smoothing out the garden sprinkler effect, but is too numerically diffusive to be of much use as of yet. It is not yet compatible with reflection schemes (BDM). g The ocean's grid structure. en The energy density integrated over an angular speed The magnitude of the group velocity at the cell energized_wedge Index of current ray direction. nangle The number of wave orientations in the discretized wave energy spectrum. dt Time increment [T ~> s]. cs The control structure returned by a previous call to continuity_PPM_init. lb A structure with the active energy loop bounds. mom_error_handler::mom_error propagate subroutine subroutine mom_internal_tides::propagate_x (En, speed_x, Cgx_av, dCgx, dt, G, US, Nangle, CS, LB) propagate_x En En speed_x speed_x Cgx_av Cgx_av dCgx dCgx dt dt G G US US Nangle Nangle CS CS LB LB Propagates the internal wave energy in the logical x-direction. g The ocean's grid structure. nangle The number of wave orientations in the discretized wave energy spectrum. en The energy density integrated over an angular speed_x The magnitude of the group velocity at the cgx_av The average x-projection in each angular band. dcgx The difference in x-projections between the edges of each angular band. dt Time increment [T ~> s]. us A dimensional unit scaling type cs The control structure returned by a previous call to continuity_PPM_init. lb A structure with the active energy loop bounds. ppm_reconstruction_x reflect teleport zonal_flux_en propagate subroutine subroutine mom_internal_tides::propagate_y (En, speed_y, Cgy_av, dCgy, dt, G, US, Nangle, CS, LB) propagate_y En En speed_y speed_y Cgy_av Cgy_av dCgy dCgy dt dt G G US US Nangle Nangle CS CS LB LB Propagates the internal wave energy in the logical y-direction. g The ocean's grid structure. nangle The number of wave orientations in the discretized wave energy spectrum. en The energy density integrated over an angular speed_y The magnitude of the group velocity at the cgy_av The average y-projection in each angular band. dcgy The difference in y-projections between the edges of each angular band. dt Time increment [T ~> s]. us A dimensional unit scaling type cs The control structure returned by a previous call to continuity_PPM_init. lb A structure with the active energy loop bounds. merid_flux_en ppm_reconstruction_y reflect teleport propagate subroutine subroutine mom_internal_tides::zonal_flux_en (u, h, hL, hR, uh, dt, G, US, j, ish, ieh, vol_CFL) zonal_flux_en u u h h hL hL hR hR uh uh dt dt G G US US j j ish ish ieh ieh vol_CFL vol_CFL Evaluates the zonal mass or volume fluxes in a layer. g The ocean's grid structure. u The zonal velocity [L T-1 ~> m s-1]. h Energy density used to calculate the fluxes [R Z3 T-2 ~> J m-2]. hl Left- Energy densities in the reconstruction [R Z3 T-2 ~> J m-2]. hr Right- Energy densities in the reconstruction [R Z3 T-2 ~> J m-2]. uh The zonal energy transport [R Z3 L2 T-3 ~> J s-1]. dt Time increment [T ~> s]. us A dimensional unit scaling type j The j-index to work on. ish The start i-index range to work on. ieh The end i-index range to work on. vol_cfl If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. propagate_x subroutine subroutine mom_internal_tides::merid_flux_en (v, h, hL, hR, vh, dt, G, US, J, ish, ieh, vol_CFL) merid_flux_en v v h h hL hL hR hR vh vh dt dt G G US US J J ish ish ieh ieh vol_CFL vol_CFL Evaluates the meridional mass or volume fluxes in a layer. g The ocean's grid structure. v The meridional velocity [L T-1 ~> m s-1]. h Energy density used to calculate the fluxes [R Z3 T-2 ~> J m-2]. hl Left- Energy densities in the reconstruction [R Z3 T-2 ~> J m-2]. hr Right- Energy densities in the reconstruction [R Z3 T-2 ~> J m-2]. vh The meridional energy transport [R Z3 L2 T-3 ~> J s-1]. dt Time increment [T ~> s]. us A dimensional unit scaling type j The j-index to work on. ish The start i-index range to work on. ieh The end i-index range to work on. vol_cfl If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. propagate_y subroutine subroutine mom_internal_tides::reflect (En, NAngle, CS, G, LB) reflect En En NAngle NAngle CS CS G G LB LB Reflection of the internal waves at a single frequency. g The ocean's grid structure nangle The number of wave orientations in the discretized wave energy spectrum. en The internal gravity wave energy density as a cs The control structure returned by a previous call to int_tide_init. lb A structure with the active energy loop bounds. propagate_x propagate_y subroutine subroutine mom_internal_tides::teleport (En, NAngle, CS, G, LB) teleport En En NAngle NAngle CS CS G G LB LB Moves energy across lines of partial reflection to prevent reflection of energy that is supposed to get across. g The ocean's grid structure. nangle The number of wave orientations in the discretized wave energy spectrum. en The internal gravity wave energy density as a cs The control structure returned by a previous call to int_tide_init. lb A structure with the active energy loop bounds. mom_error_handler::mom_error propagate_x propagate_y subroutine subroutine mom_internal_tides::correct_halo_rotation (En, test, G, NAngle) correct_halo_rotation En En test test G G NAngle NAngle Rotates points in the halos where required to accommodate changes in grid orientation, such as at the tripolar fold. g The ocean's grid structure en The internal gravity wave energy density as a function of space, angular orientation, frequency, and vertical mode [R Z3 T-2 ~> J m-2]. test An x-unit vector that has been passed through nangle The number of wave orientations in the discretized wave energy spectrum. mom_error_handler::mom_error propagate_int_tide subroutine subroutine mom_internal_tides::ppm_reconstruction_x (h_in, h_l, h_r, G, LB, simple_2nd) ppm_reconstruction_x h_in h_in h_l h_l h_r h_r G G LB LB simple_2nd simple_2nd Calculates left/right edge values for PPM reconstruction in x-direction. g The ocean's grid structure. h_in Energy density in a sector (2D). h_l Left edge value of reconstruction (2D). h_r Right edge value of reconstruction (2D). lb A structure with the active loop bounds. simple_2nd If true, use the arithmetic mean energy densities as default edge values for a simple 2nd order scheme. mom_error_handler::mom_error ppm_limit_pos propagate_x subroutine subroutine mom_internal_tides::ppm_reconstruction_y (h_in, h_l, h_r, G, LB, simple_2nd) ppm_reconstruction_y h_in h_in h_l h_l h_r h_r G G LB LB simple_2nd simple_2nd Calculates left/right edge valus for PPM reconstruction in y-direction. g The ocean's grid structure. h_in Energy density in a sector (2D). h_l Left edge value of reconstruction (2D). h_r Right edge value of reconstruction (2D). lb A structure with the active loop bounds. simple_2nd If true, use the arithmetic mean energy densities as default edge values for a simple 2nd order scheme. mom_error_handler::mom_error ppm_limit_pos propagate_y subroutine subroutine mom_internal_tides::ppm_limit_pos (h_in, h_L, h_R, h_min, G, iis, iie, jis, jie) ppm_limit_pos h_in h_in h_L h_L h_R h_R h_min h_min G G iis iis iie iie jis jis jie jie Limits the left/right edge values of the PPM reconstruction to give a reconstruction that is positive-definite. Here this is reinterpreted as giving a constant thickness if the mean thickness is less than h_min, with a minimum of h_min otherwise. g The ocean's grid structure. h_in Thickness of layer (2D). h_l Left edge value (2D). h_r Right edge value (2D). h_min The minimum thickness that can be obtained by a concave parabolic fit. iis Start i-index for computations iie End i-index for computations jis Start j-index for computations jie End j-index for computations ppm_reconstruction_x ppm_reconstruction_y subroutine, public subroutine, public mom_internal_tides::internal_tides_init (Time, G, GV, US, param_file, diag, CS) internal_tides_init Time Time G G GV GV US US param_file param_file diag diag CS CS This subroutine initializes the internal tides module. time The current model time. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. diag A structure that is used to regulate diagnostic output. cs A pointer that is set to point to the control structure for this module. mom_diag_mediator::define_axes_group mom_error_handler::mom_error mom_error_handler::mom_mesg mom_wave_structure::wave_structure_init mom_diabatic_driver::diabatic_driver_init subroutine, public subroutine, public mom_internal_tides::internal_tides_end (CS) internal_tides_end CS CS This subroutine deallocates the memory associated with the internal tides control structure. cs A pointer to the control structure returned by a previous call to internal_tides_init, it will be deallocated here. Subroutines that use the ray-tracing equations to propagate the internal tide energy density. Benjamin Mater & Robert Hallberg, 2015