mom_wave_interface mom_wave_interface::wave_parameters_cs integer, parameter integer, parameter mom_wave_interface::testprof testprof = 0 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. get_langmuir_number mom_wave_interface_init update_stokes_drift update_surface_waves integer, parameter integer, parameter mom_wave_interface::surfbands surfbands = 1 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. get_langmuir_number mom_wave_interface_init update_stokes_drift update_surface_waves integer, parameter integer, parameter mom_wave_interface::dhh85 dhh85 = 2 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. get_langmuir_number mom_wave_interface_init update_stokes_drift integer, parameter integer, parameter mom_wave_interface::lf17 lf17 = 3 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. get_langmuir_number mom_wave_interface_init mom_wave_interface_init_lite integer, parameter integer, parameter mom_wave_interface::null_wavemethod null_wavemethod =-99 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. get_langmuir_number mom_wave_interface_init_lite integer, parameter integer, parameter mom_wave_interface::dataovr dataovr = 1 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_surface_waves integer, parameter integer, parameter mom_wave_interface::coupler coupler = 2 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_surface_waves integer, parameter integer, parameter mom_wave_interface::input input = 3 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_surface_waves real real mom_wave_interface::tp_stkx0 tp_stkx0 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_stokes_drift real real mom_wave_interface::tp_stky0 tp_stky0 Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_stokes_drift real real mom_wave_interface::tp_wvl tp_wvl Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_stokes_drift logical logical mom_wave_interface::waveagepeakfreq waveagepeakfreq Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. dhh85_mid mom_wave_interface_init logical logical mom_wave_interface::staticwaves staticwaves Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. mom_wave_interface_init update_stokes_drift logical logical mom_wave_interface::dhh85_is_set dhh85_is_set Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. update_stokes_drift real real mom_wave_interface::waveage waveage Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. dhh85_mid mom_wave_interface_init real real mom_wave_interface::wavewind wavewind Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. dhh85_mid mom_wave_interface_init real real mom_wave_interface::pi pi Undocumented parameters. TodoThese module variables need to be documented as static/private variables or moved into a control structure. dhh85_mid get_stokessl_lifoxkemper mom_wave_interface_init mom_wave_interface_init_lite surface_bands_by_data_override update_stokes_drift integer integer mom_wave_interface::wavemethod wavemethod =-99 Options for including wave information Valid (tested) choices are: 0 - Test Profile 1 - Surface Stokes Drift Bands 2 - DHH85 3 - LF17 -99 - No waves computed, but empirical Langmuir number used. TodoModule variable! Move into a control structure. get_langmuir_number mom_wave_interface_init mom_wave_interface_init_lite update_stokes_drift update_surface_waves integer, public integer, public mom_wave_interface::numbands numbands =0 Number of wavenumber/frequency partitions to receive This needs to match the number of bands provided via either coupling or file. TodoModule variable! Move into a control structure. get_langmuir_number mom_wave_interface_init surface_bands_by_data_override update_stokes_drift update_surface_waves integer, public integer, public mom_wave_interface::partitionmode partitionmode Method for partition mode (meant to check input) 0 - wavenumbers 1 - frequencies. TodoModule variable! Move into a control structure. mom_wave_interface_init surface_bands_by_data_override update_stokes_drift integer integer mom_wave_interface::datasource datasource Integer that specifies where the Model Looks for Data Valid choices are: 1 - FMS DataOverride Routine 2 - Reserved For Coupler 3 - User input (fixed values, useful for 1d testing) TodoModule variable! Move into a control structure. mom_wave_interface_init update_surface_waves character(len=40) character(len=40) mom_wave_interface::surfbandfilename surfbandfilename Filename if using DataOverride. TodoModule variable! Move into a control structure. mom_wave_interface_init surface_bands_by_data_override logical logical mom_wave_interface::dataoverrideisinitialized dataoverrideisinitialized Flag for DataOverride Initialization. TodoModule variable! Move into a control structure. mom_wave_interface_init surface_bands_by_data_override real real mom_wave_interface::la_frachbl la_frachbl Fraction of OSBL for averaging Langmuir number. TodoModule variable! Move into a control structure. get_langmuir_number mom_wave_interface_init mom_wave_interface_init_lite logical logical mom_wave_interface::la_misalignment la_misalignment = .false. Flag to use misalignment in Langmuir number. TodoModule variable! Move into a control structure. get_langmuir_number mom_wave_interface_init character(len=40) character(len=40) mom_wave_interface::mdl mdl = "MOM_wave_interface" This module's name. mom_wave_interface_init mom_wave_interface_init_lite subroutine, public subroutine, public mom_wave_interface::mom_wave_interface_init (time, G, GV, US, param_file, CS, diag) mom_wave_interface_init time time G G GV GV US US param_file param_file CS CS diag diag Initializes parameters related to MOM_wave_interface. time Model time g Grid structure gv Vertical grid structure us A dimensional unit scaling type param_file Input parameter structure cs Wave parameter control structure diag Diagnostic Pointer coupler dataoverrideisinitialized dataovr datasource dhh85 input la_frachbl la_misalignment lf17 mdl mom_error_handler::mom_error numbands partitionmode pi staticwaves surfbandfilename surfbands testprof tp_stkx0 tp_stky0 tp_wvl waveage waveagepeakfreq wavemethod wavewind mom_main subroutine, public subroutine, public mom_wave_interface::mom_wave_interface_init_lite (param_file) mom_wave_interface_init_lite param_file param_file A 'lite' init subroutine to initialize a few inputs needed if using wave information with the wind-speed dependent Stokes drift formulation of LF17. param_file Input parameter structure la_frachbl lf17 mdl null_wavemethod pi wavemethod mom_main ocean_model_mod::ocean_model_init subroutine, public subroutine, public mom_wave_interface::update_surface_waves (G, GV, US, Day, dt, CS) update_surface_waves G G GV GV US US Day Day dt dt CS CS Subroutine that handles updating of surface wave/Stokes drift related properties. cs Wave parameter Control structure g Grid structure gv Vertical grid structure us A dimensional unit scaling type day Current model time dt Timestep as a time-type coupler dataovr datasource input numbands surface_bands_by_data_override surfbands testprof wavemethod mom_main ocean_model_mod::update_ocean_model subroutine, public subroutine, public mom_wave_interface::update_stokes_drift (G, GV, US, CS, h, ustar) update_stokes_drift G G GV GV US US CS CS h h ustar ustar Constructs the Stokes Drift profile on the model grid based on desired coupling options. cs Wave parameter Control structure g Grid structure gv Vertical grid structure us A dimensional unit scaling type h Thickness [H ~> m or kg m-2] ustar Wind friction velocity [Z T-1 ~> m s-1]. dhh85 dhh85_is_set dhh85_mid get_langmuir_number numbands partitionmode pi staticwaves surfbands testprof tp_stkx0 tp_stky0 tp_wvl wavemethod mom::step_mom subroutine subroutine mom_wave_interface::surface_bands_by_data_override (day_center, G, GV, US, CS) surface_bands_by_data_override day_center day_center G G GV GV US US CS CS A subroutine to fill the Stokes drift from a NetCDF file using the data_override procedures. day_center Center of timestep cs Wave structure g Grid structure gv Vertical grid structure us A dimensional unit scaling type dataoverrideisinitialized mom_error_handler::mom_error numbands partitionmode pi surfbandfilename mom_domains::to_all update_surface_waves subroutine, public subroutine, public mom_wave_interface::get_langmuir_number (LA, G, GV, US, HBL, ustar, i, j, H, U_H, V_H, Override_MA, Waves) get_langmuir_number LA LA G G GV GV US US HBL HBL ustar ustar i i j j H H U_H U_H V_H V_H Override_MA Override_MA Waves Waves Interface to get Langmuir number based on options stored in wave structure. Note this can be called with an unallocated Waves pointer, which is okay if we want the wind-speed only dependent Langmuir number. Therefore, we need to be careful about what we try to access here. g Ocean grid structure gv Ocean vertical grid structure us A dimensional unit scaling type i Meridional index of h-point j Zonal index of h-point ustar Friction velocity [Z T-1 ~> m s-1]. hbl (Positive) thickness of boundary layer [Z ~> m]. override_ma Override to use misalignment in LA calculation. This can be used if diagnostic LA outputs are desired that are different than those used by the dynamical model. h Grid layer thickness [H ~> m or kg m-2] u_h Zonal velocity at H point [m s-1] v_h Meridional velocity at H point [m s-1] waves Surface wave control structure. la Langmuir number dhh85 get_sl_average_band get_sl_average_prof get_stokessl_lifoxkemper la_frachbl la_misalignment lf17 mom_error_handler::mom_error null_wavemethod numbands surfbands testprof wavemethod mom_energetic_pbl::epbl_column mom_cvmix_kpp::kpp_compute_bld update_stokes_drift subroutine subroutine mom_wave_interface::get_stokessl_lifoxkemper (ustar, hbl, GV, US, UStokes_SL, LA) get_stokessl_lifoxkemper ustar ustar hbl hbl GV GV US US UStokes_SL UStokes_SL LA LA Get SL averaged Stokes drift from Li/FK 17 method. Original description: This function returns the enhancement factor, given the 10-meter wind [m s-1], friction velocity [m s-1] and the boundary layer depth [m]. Update (Jan/25): Converted from function to subroutine, now returns Langmuir number. Computs 10m wind internally, so only ustar and hbl need passed to subroutine. Qing Li, 160606 BGR port from CVMix to MOM6 Jan/25/2017 BGR change output to LA from Efactor BGR remove u10 input BGR note: fixed parameter values should be changed to "get_params" ustar water-side surface friction velocity [Z T-1 ~> m s-1]. hbl boundary layer depth [Z ~> m]. gv Ocean vertical grid structure us A dimensional unit scaling type ustokes_sl Surface layer averaged Stokes drift [m s-1] la Langmuir number pi ust_2_u10_coare3p5 get_langmuir_number subroutine subroutine mom_wave_interface::get_sl_average_prof (GV, AvgDepth, H, Profile, Average) get_sl_average_prof GV GV AvgDepth AvgDepth H H Profile Profile Average Average Get SL Averaged Stokes drift from a Stokes drift Profile. gv Ocean vertical grid structure avgdepth Depth to average over (negative) [Z ~> m]. h Grid thickness [H ~> m or kg m-2] profile Profile of quantity to be averaged [arbitrary] average Output quantity averaged over depth AvgDepth [arbitrary] (used here for Stokes drift) get_langmuir_number subroutine subroutine mom_wave_interface::get_sl_average_band (GV, AvgDepth, NB, WaveNumbers, SurfStokes, Average) get_sl_average_band GV GV AvgDepth AvgDepth NB NB WaveNumbers WaveNumbers SurfStokes SurfStokes Average Average Get SL averaged Stokes drift from the banded Spectrum method. gv Ocean vertical grid avgdepth Depth to average over [Z ~> m]. nb Number of bands used wavenumbers Wavenumber corresponding to each band [Z-1 ~> m-1] surfstokes Surface Stokes drift for each band [m s-1] average Output average Stokes drift over depth AvgDepth [m s-1] get_langmuir_number subroutine subroutine mom_wave_interface::dhh85_mid (GV, US, zpt, UStokes) dhh85_mid GV GV US US zpt zpt UStokes UStokes Compute the Stokes drift at a given depth. Taken from Qing Li (Brown) use for comparing MOM6 simulation to his LES computed at z mid point (I think) and not depth averaged. Should be fine to integrate in frequency from 0.1 to sqrt(-0.2*grav*2pi/dz gv Ocean vertical grid us A dimensional unit scaling type zpt Depth to get Stokes drift [Z ~> m]. ustokes Stokes drift [m s-1] pi waveage waveagepeakfreq wavewind update_stokes_drift subroutine, public subroutine, public mom_wave_interface::stokesmixing (G, GV, dt, h, u, v, Waves) stokesmixing G G GV GV dt dt h h u u v v Waves Waves Explicit solver for Stokes mixing. Still in development do not use. g Ocean grid gv Ocean vertical grid dt Time step of MOM6 [T ~> s] for explicit solver h Layer thicknesses [H ~> m or kg m-2] u Velocity i-component [m s-1] v Velocity j-component [m s-1] waves Surface wave related control structure. subroutine, public subroutine, public mom_wave_interface::coriolisstokes (G, GV, DT, h, u, v, WAVES, US) coriolisstokes G G GV GV DT DT h h u u v v WAVES WAVES US US Solver to add Coriolis-Stokes to model Still in development and not meant for general use. Can be activated (with code intervention) for LES comparison CHECK THAT RIGHT TIMESTEP IS PASSED IF YOU USE THIS**. Not accessed in the standard code. g Ocean grid gv Ocean vertical grid dt Time step of MOM6 [s] CHECK IF PASSING RIGHT TIMESTEP h Layer thicknesses [H ~> m or kg m-2] u Velocity i-component [m s-1] v Velocity j-component [m s-1] waves Surface wave related control structure. us A dimensional unit scaling type subroutine subroutine mom_wave_interface::ust_2_u10_coare3p5 (USTair, U10, GV, US) ust_2_u10_coare3p5 USTair USTair U10 U10 GV GV US US Computes wind speed from ustar_air based on COARE 3.5 Cd relationship Probably doesn't belong in this module, but it is used here to estimate wind speed for wind-wave relationships. Should be a fine way to estimate the neutral wind-speed as written here. ustair Wind friction velocity [m s-1] u10 10-m neutral wind speed [m s-1] gv vertical grid type us A dimensional unit scaling type get_stokessl_lifoxkemper subroutine, public subroutine, public mom_wave_interface::waves_end (CS) waves_end CS CS Clear pointers, deallocate memory. cs Control structure Interface for surface waves. Brandon Reichl, 2018. This module should be moved as wave coupling progresses and likely will should mirror the iceberg or sea-ice model set-up. This module is meant to contain the routines to read in and interpret surface wave data for MOM6. In its original form, the capabilities include setting the Stokes drift in the model (from a variety of sources including prescribed, empirical, and input files). In short order, the plan is to also ammend the subroutine to accept Stokes drift information from an external coupler. Eventually, it will be necessary to break this file apart so that general wave information may be stored in the control structure and the Stokes drift effect can be isolated from processes such as sea-state dependent momentum fluxes, gas fluxes, and other wave related air-sea interaction and boundary layer phenomenon. The Stokes drift are stored on the C-grid with the conventional protocol to interpolate to the h-grid to compute Langmuir number, the primary quantity needed for Langmuir turbulence parameterizations in both the ePBL and KPP approach. This module also computes full 3d Stokes drift profiles, which will be useful if second-order type boundary layer parameterizations are implemented (perhaps via GOTM, work in progress).