mom_energetic_pbl mom_energetic_pbl::energetic_pbl_cs mom_energetic_pbl::epbl_column_diags integer, parameter integer, parameter mom_energetic_pbl::use_fixed_mstar use_fixed_mstar = 0 Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init epbl_column find_mstar integer, parameter integer, parameter mom_energetic_pbl::mstar_from_ekman mstar_from_ekman = 2 The value of mstar_scheme to base mstar on the ratio of the Ekman layer depth to the Obukhov depth. energetic_pbl_init find_mstar integer, parameter integer, parameter mom_energetic_pbl::mstar_from_rh18 mstar_from_rh18 = 3 The value of mstar_scheme to base mstar of of RH18. energetic_pbl_init find_mstar integer, parameter integer, parameter mom_energetic_pbl::no_langmuir no_langmuir = 0 The value of LT_ENHANCE_FORM not use Langmuir turbolence. energetic_pbl_init mstar_langmuir integer, parameter integer, parameter mom_energetic_pbl::langmuir_rescale langmuir_rescale = 2 The value of LT_ENHANCE_FORM to use a multiplicative rescaling of mstar to account for Langmuir turbulence. energetic_pbl_init mstar_langmuir integer, parameter integer, parameter mom_energetic_pbl::langmuir_add langmuir_add = 3 The value of LT_ENHANCE_FORM to add a contribution to mstar from Langmuir turblence to other contributions. energetic_pbl_init mstar_langmuir integer, parameter integer, parameter mom_energetic_pbl::wt_from_croot_tke wt_from_croot_tke = 0 Use a constant times the cube root of remaining TKE to calculate the turbulent velocity. energetic_pbl_init epbl_column integer, parameter integer, parameter mom_energetic_pbl::wt_from_rh18 wt_from_rh18 = 1 Use a scheme based on a combination of w* and v* as documented in Reichl & Hallberg (2018) to calculate the turbulent velocity. energetic_pbl_init epbl_column character *(20), parameter character*(20), parameter mom_energetic_pbl::constant_string constant_string = "CONSTANT" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::om4_string om4_string = "OM4" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::rh18_string rh18_string = "REICHL_H18" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::root_tke_string root_tke_string = "CUBE_ROOT_TKE" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::none_string none_string = "NONE" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::rescaled_string rescaled_string = "RESCALE" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init character *(20), parameter character*(20), parameter mom_energetic_pbl::additive_string additive_string = "ADDITIVE" Enumeration values for mstar_Scheme. The value of mstar_scheme to use a constant mstar energetic_pbl_init logical logical mom_energetic_pbl::report_avg_its report_avg_its = .false. Report the average number of ePBL iterations for debugging. energetic_pbl_init epbl_column subroutine, public subroutine, public mom_energetic_pbl::energetic_pbl (h_3d, u_3d, v_3d, tv, fluxes, dt, Kd_int, G, GV, US, CS, dSV_dT, dSV_dS, TKE_forced, buoy_flux, dt_diag, last_call, dT_expected, dS_expected, Waves) energetic_pbl h_3d h_3d u_3d u_3d v_3d v_3d tv tv fluxes fluxes dt dt Kd_int Kd_int G G GV GV US US CS CS dSV_dT dSV_dT dSV_dS dSV_dS TKE_forced TKE_forced buoy_flux buoy_flux dt_diag dt_diag last_call last_call dT_expected dT_expected dS_expected dS_expected Waves Waves This subroutine determines the diffusivities from the integrated energetics mixed layer model. It assumes that heating, cooling and freshwater fluxes have already been applied. All calculations are done implicitly, and there is no stability limit on the time step. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h_3d Layer thicknesses [H ~> m or kg m-2]. u_3d Zonal velocities interpolated to h points v_3d Zonal velocities interpolated to h points dsv_dt The partial derivative of in-situ specific dsv_ds The partial derivative of in-situ specific tke_forced The forcing requirements to homogenize the tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. fluxes A structure containing pointers to any possible forcing fields. Unused fields have NULL ptrs. dt Time increment [T ~> s]. kd_int The diagnosed diffusivities at interfaces cs The control structure returned by a previous call to mixedlayer_init. buoy_flux The surface buoyancy flux [Z2 T-3 ~> m2 s-3]. dt_diag The diagnostic time step, which may be less than dt if there are two calls to mixedlayer [T ~> s]. last_call If true, this is the last call to mixedlayer in the current time step, so diagnostics will be written. The default is .true. dt_expected The values of temperature change that ds_expected The values of salinity change that waves Wave CS epbl_column mom_error_handler::mom_error subroutine subroutine mom_energetic_pbl::epbl_column (h, u, v, T0, S0, dSV_dT, dSV_dS, TKE_forcing, B_flux, absf, u_star, u_star_mean, dt, MLD_io, Kd, mixvel, mixlen, GV, US, CS, eCD, dt_diag, Waves, G, i, j) epbl_column h h u u v v T0 T0 S0 S0 dSV_dT dSV_dT dSV_dS dSV_dS TKE_forcing TKE_forcing B_flux B_flux absf absf u_star u_star u_star_mean u_star_mean dt dt MLD_io MLD_io Kd Kd mixvel mixvel mixlen mixlen GV GV US US CS CS eCD eCD dt_diag dt_diag Waves Waves G G i i j j This subroutine determines the diffusivities from the integrated energetics mixed layer model for a single column of water. gv The ocean's vertical grid structure. us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2]. u Zonal velocities interpolated to h points [L T-1 ~> m s-1]. v Zonal velocities interpolated to h points [L T-1 ~> m s-1]. t0 The initial layer temperatures [degC]. s0 The initial layer salinities [ppt]. dsv_dt The partial derivative of in-situ specific volume with potential temperature [R-1 degC-1 ~> m3 kg-1 degC-1]. dsv_ds The partial derivative of in-situ specific volume with salinity [R-1 ppt-1 ~> m3 kg-1 ppt-1]. tke_forcing The forcing requirements to homogenize the forcing that has been applied to each layer [R Z3 T-2 ~> J m-2]. b_flux The surface buoyancy flux [Z2 T-3 ~> m2 s-3] absf The absolute value of the Coriolis parameter [T-1 ~> s-1]. u_star The surface friction velocity [Z T-1 ~> m s-1]. u_star_mean The surface friction velocity without any contribution from unresolved gustiness [Z T-1 ~> m s-1]. mld_io A first guess at the mixed layer depth on input, and the calculated mixed layer depth on output [Z ~> m]. dt Time increment [T ~> s]. kd The diagnosed diffusivities at interfaces mixvel The mixing velocity scale used in Kd mixlen The mixing length scale used in Kd [Z ~> m]. cs The control structure returned by a previous call to mixedlayer_init. ecd A container for passing around diagnostics. dt_diag The diagnostic time step, which may be less than dt if there are two calls to mixedlayer [T ~> s]. waves Wave CS for Langmuir turbulence g The ocean's grid structure. i The i-index to work on (used for Waves) j The i-index to work on (used for Waves) find_mstar find_pe_chg find_pe_chg_orig mom_wave_interface::get_langmuir_number mom_error_handler::mom_error mom_coms::real_to_efp report_avg_its use_fixed_mstar wt_from_croot_tke wt_from_rh18 energetic_pbl subroutine subroutine mom_energetic_pbl::find_pe_chg (Kddt_h0, dKddt_h, hp_a, hp_b, Th_a, Sh_a, Th_b, Sh_b, dT_to_dPE_a, dS_to_dPE_a, dT_to_dPE_b, dS_to_dPE_b, pres_Z, dT_to_dColHt_a, dS_to_dColHt_a, dT_to_dColHt_b, dS_to_dColHt_b, PE_chg, dPEc_dKd, dPE_max, dPEc_dKd_0, PE_ColHt_cor) find_pe_chg Kddt_h0 Kddt_h0 dKddt_h dKddt_h hp_a hp_a hp_b hp_b Th_a Th_a Sh_a Sh_a Th_b Th_b Sh_b Sh_b dT_to_dPE_a dT_to_dPE_a dS_to_dPE_a dS_to_dPE_a dT_to_dPE_b dT_to_dPE_b dS_to_dPE_b dS_to_dPE_b pres_Z pres_Z dT_to_dColHt_a dT_to_dColHt_a dS_to_dColHt_a dS_to_dColHt_a dT_to_dColHt_b dT_to_dColHt_b dS_to_dColHt_b dS_to_dColHt_b PE_chg PE_chg dPEc_dKd dPEc_dKd dPE_max dPE_max dPEc_dKd_0 dPEc_dKd_0 PE_ColHt_cor PE_ColHt_cor This subroutine calculates the change in potential energy and or derivatives for several changes in an interfaces's diapycnal diffusivity times a timestep. kddt_h0 The previously used diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. dkddt_h The trial change in the diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. hp_a The effective pivot thickness of the layer above the interface, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. hp_b The effective pivot thickness of the layer below the interface, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. th_a An effective temperature times a thickness in the layer above, including implicit mixing effects with other yet higher layers [degC H ~> degC m or degC kg m-2]. sh_a An effective salinity times a thickness in the layer above, including implicit mixing effects with other yet higher layers [degC H ~> degC m or degC kg m-2]. th_b An effective temperature times a thickness in the layer below, including implicit mixfing effects with other yet lower layers [degC H ~> degC m or degC kg m-2]. sh_b An effective salinity times a thickness in the layer below, including implicit mixing effects with other yet lower layers [degC H ~> degC m or degC kg m-2]. dt_to_dpe_a A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers above [R Z3 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_a A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers above [R Z3 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dpe_b A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers below [R Z3 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_b A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers below [R Z3 T-2 ppt-1 ~> J m-2 ppt-1]. pres_z The rescaled hydrostatic interface pressure, which relates the changes in column thickness to the energy that is radiated as gravity waves and unavailable to drive mixing [R Z2 T-2 ~> J m-3]. dt_to_dcolht_a A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers above [Z degC-1 ~> m degC-1]. ds_to_dcolht_a A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers above [Z ppt-1 ~> m ppt-1]. dt_to_dcolht_b A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers below [Z degC-1 ~> m degC-1]. ds_to_dcolht_b A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers below [Z ppt-1 ~> m ppt-1]. pe_chg The change in column potential energy from applying Kddt_h at the present interface [R Z3 T-2 ~> J m-2]. dpec_dkd The partial derivative of PE_chg with Kddt_h [R Z3 T-2 H-1 ~> J m-3 or J kg-1]. dpe_max The maximum change in column potential energy that could be realizedd by applying a huge value of Kddt_h at the present interface [R Z3 T-2 ~> J m-2]. dpec_dkd_0 The partial derivative of PE_chg with Kddt_h in the limit where Kddt_h = 0 [R Z3 T-2 H-1 ~> J m-3 or J kg-1]. pe_colht_cor The correction to PE_chg that is made due to a net change in the column height [R Z3 T-2 ~> J m-2]. epbl_column subroutine subroutine mom_energetic_pbl::find_pe_chg_orig (Kddt_h, h_k, b_den_1, dTe_term, dSe_term, dT_km1_t2, dS_km1_t2, dT_to_dPE_k, dS_to_dPE_k, dT_to_dPEa, dS_to_dPEa, pres_Z, dT_to_dColHt_k, dS_to_dColHt_k, dT_to_dColHta, dS_to_dColHta, PE_chg, dPEc_dKd, dPE_max, dPEc_dKd_0) find_pe_chg_orig Kddt_h Kddt_h h_k h_k b_den_1 b_den_1 dTe_term dTe_term dSe_term dSe_term dT_km1_t2 dT_km1_t2 dS_km1_t2 dS_km1_t2 dT_to_dPE_k dT_to_dPE_k dS_to_dPE_k dS_to_dPE_k dT_to_dPEa dT_to_dPEa dS_to_dPEa dS_to_dPEa pres_Z pres_Z dT_to_dColHt_k dT_to_dColHt_k dS_to_dColHt_k dS_to_dColHt_k dT_to_dColHta dT_to_dColHta dS_to_dColHta dS_to_dColHta PE_chg PE_chg dPEc_dKd dPEc_dKd dPE_max dPE_max dPEc_dKd_0 dPEc_dKd_0 This subroutine calculates the change in potential energy and or derivatives for several changes in an interfaces's diapycnal diffusivity times a timestep using the original form used in the first version of ePBL. kddt_h The diffusivity at an interface times the time step and divided by the average of the thicknesses around the interface [H ~> m or kg m-2]. h_k The thickness of the layer below the interface [H ~> m or kg m-2]. b_den_1 The first term in the denominator of the pivot for the tridiagonal solver, given by h_k plus a term that is a fraction (determined from the tridiagonal solver) of Kddt_h for the interface above [H ~> m or kg m-2]. dte_term A diffusivity-independent term related to the temperature change in the layer below the interface [degC H ~> degC m or degC kg m-2]. dse_term A diffusivity-independent term related to the salinity change in the layer below the interface [ppt H ~> ppt m or ppt kg m-2]. dt_km1_t2 A diffusivity-independent term related to the temperature change in the layer above the interface [degC]. ds_km1_t2 A diffusivity-independent term related to the salinity change in the layer above the interface [ppt]. pres_z The rescaled hydrostatic interface pressure, which relates the changes in column thickness to the energy that is radiated as gravity waves and unavailable to drive mixing [R Z2 T-2 ~> J m-3]. dt_to_dpe_k A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers below [R Z3 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpe_k A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the in the salinities of all the layers below [R Z3 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dpea A factor (pres_lay*mass_lay*dSpec_vol/dT) relating a layer's temperature change to the change in column potential energy, including all implicit diffusive changes in the temperatures of all the layers above [R Z3 T-2 degC-1 ~> J m-2 degC-1]. ds_to_dpea A factor (pres_lay*mass_lay*dSpec_vol/dS) relating a layer's salinity change to the change in column potential energy, including all implicit diffusive changes in the salinities of all the layers above [R Z3 T-2 ppt-1 ~> J m-2 ppt-1]. dt_to_dcolht_k A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers below [Z degC-1 ~> m degC-1]. ds_to_dcolht_k A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers below [Z ppt-1 ~> m ppt-1]. dt_to_dcolhta A factor (mass_lay*dSColHtc_vol/dT) relating a layer's temperature change to the change in column height, including all implicit diffusive changes in the temperatures of all the layers above [Z degC-1 ~> m degC-1]. ds_to_dcolhta A factor (mass_lay*dSColHtc_vol/dS) relating a layer's salinity change to the change in column height, including all implicit diffusive changes in the salinities of all the layers above [Z ppt-1 ~> m ppt-1]. pe_chg The change in column potential energy from applying Kddt_h at the present interface [R Z3 T-2 ~> J m-2]. dpec_dkd The partial derivative of PE_chg with Kddt_h [R Z3 T-2 H-1 ~> J m-3 or J kg-1]. dpe_max The maximum change in column potential energy that could be realizedd by applying a huge value of Kddt_h at the present interface [R Z3 T-2 ~> J m-2]. dpec_dkd_0 The partial derivative of PE_chg with Kddt_h in the limit where Kddt_h = 0 [R Z3 T-2 H-1 ~> J m-3 or J kg-1]. epbl_column subroutine subroutine mom_energetic_pbl::find_mstar (CS, US, Buoyancy_Flux, UStar, UStar_Mean, BLD, Abs_Coriolis, MStar, Langmuir_Number, MStar_LT, Convect_Langmuir_Number) find_mstar CS CS US US Buoyancy_Flux Buoyancy_Flux UStar UStar UStar_Mean UStar_Mean BLD BLD Abs_Coriolis Abs_Coriolis MStar MStar Langmuir_Number Langmuir_Number MStar_LT MStar_LT Convect_Langmuir_Number Convect_Langmuir_Number This subroutine finds the Mstar value for ePBL. cs Energetic_PBL control structure. us A dimensional unit scaling type ustar ustar w/ gustiness [Z T-1 ~> m s-1] ustar_mean ustar w/o gustiness [Z T-1 ~> m s-1] abs_coriolis abolute value of the Coriolis parameter [T-1 ~> s-1] buoyancy_flux Buoyancy flux [Z2 T-3 ~> m2 s-3] bld boundary layer depth [Z ~> m] mstar Ouput mstar (Mixing/ustar**3) [nondim] langmuir_number Langmuir number [nondim] mstar_lt Mstar increase due to Langmuir turbulence [nondim] convect_langmuir_number Langmuir number including buoyancy flux [nondim] mstar_from_ekman mstar_from_rh18 mstar_langmuir use_fixed_mstar epbl_column subroutine subroutine mom_energetic_pbl::mstar_langmuir (CS, US, Abs_Coriolis, Buoyancy_Flux, UStar, BLD, Langmuir_Number, Mstar, MStar_LT, Convect_Langmuir_Number) mstar_langmuir CS CS US US Abs_Coriolis Abs_Coriolis Buoyancy_Flux Buoyancy_Flux UStar UStar BLD BLD Langmuir_Number Langmuir_Number Mstar Mstar MStar_LT MStar_LT Convect_Langmuir_Number Convect_Langmuir_Number This subroutine modifies the Mstar value if the Langmuir number is present. cs Energetic_PBL control structure. us A dimensional unit scaling type abs_coriolis Absolute value of the Coriolis parameter [T-1 ~> s-1] buoyancy_flux Buoyancy flux [Z2 T-3 ~> m2 s-3] ustar Surface friction velocity with? gustiness [Z T-1 ~> m s-1] bld boundary layer depth [Z ~> m] mstar Input/output mstar (Mixing/ustar**3) [nondim] langmuir_number Langmuir number [nondim] mstar_lt Mstar increase due to Langmuir turbulence [nondim] convect_langmuir_number Langmuir number including buoyancy flux [nondim] langmuir_add langmuir_rescale no_langmuir find_mstar subroutine, public subroutine, public mom_energetic_pbl::energetic_pbl_get_mld (CS, MLD, G, US, m_to_MLD_units) energetic_pbl_get_mld CS CS MLD MLD G G US US m_to_MLD_units m_to_MLD_units Copies the ePBL active mixed layer depth into MLD, in units of [Z ~> m] unless other units are specified. cs Control structure for ePBL g Grid structure us A dimensional unit scaling type mld Depth of ePBL active mixing layer [Z ~> m] or other units m_to_mld_units A conversion factor from meters to the desired units for MLD mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_lateral_boundary_diffusion::lateral_boundary_diffusion mom_neutral_diffusion::neutral_diffusion_calc_coeffs subroutine, public subroutine, public mom_energetic_pbl::energetic_pbl_init (Time, G, GV, US, param_file, diag, CS) energetic_pbl_init Time Time G G GV GV US US param_file param_file diag diag CS CS This subroutine initializes the energetic_PBL 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 additive_string constant_string langmuir_add langmuir_rescale mom_error_handler::mom_error mom_error_handler::mom_mesg mstar_from_ekman mstar_from_rh18 no_langmuir none_string om4_string mom_coms::real_to_efp report_avg_its rescaled_string rh18_string root_tke_string mom_string_functions::uppercase use_fixed_mstar wt_from_croot_tke wt_from_rh18 subroutine, public subroutine, public mom_energetic_pbl::energetic_pbl_end (CS) energetic_pbl_end CS CS Clean up and deallocate memory associated with the energetic_PBL module. cs Energetic_PBL control structure that will be deallocated in this subroutine. Energetically consistent planetary boundary layer parameterization.