From 10912109b7f889293f4c05ddcf71a99d974eb2e5 Mon Sep 17 00:00:00 2001 From: Robert Hallberg Date: Tue, 24 Apr 2018 16:17:18 -0400 Subject: [PATCH] MOM6: Merged dev/ncar into dev/master Merged an extensive set of changes from dev/ncar onto dev/master. The list of commits include: - NOAA-GFDL/MOM6@77a97ba Merge branch 'NCAR-dev/ncar' into dev/master - NOAA-GFDL/MOM6@8050958 Merge pull request #55 from gustavo-marques/deallocate_diabatic - NOAA-GFDL/MOM6@648f31b Replace cvmix with CVMix - NOAA-GFDL/MOM6@4b21263 Merge pull request #54 from gustavo-marques/deallocate_diabatic - NOAA-GFDL/MOM6@165a5eb Comment call diabatic_driver_end - NOAA-GFDL/MOM6@9f4ce3a Un-comment call diabatic_driver_end - NOAA-GFDL/MOM6@4671c07 Comment call diabatic_driver_end to check if Travis still fails - NOAA-GFDL/MOM6@e90fbe9 Return if CS is not associated - NOAA-GFDL/MOM6@65527d6 Set useKPP = .false. (default) and comment call to diag_grid_storage_end - NOAA-GFDL/MOM6@2800524 Uncomment calls to deallocate KPP related arrays - NOAA-GFDL/MOM6@dab30b6 Merge pull request #52 from alperaltuntas/initialize_tidal_ctrl_vars - NOAA-GFDL/MOM6@334f124 Merge remote-tracking branch 'gmarques/fix_travis_deallocation' into initialize_tidal_ctrl_vars - NOAA-GFDL/MOM6@5153869 initialize boolean control vars in tidal mixing mod - NOAA-GFDL/MOM6@43b7968 Commenting out call to diabatic_driver_end in MOM.F90 - NOAA-GFDL/MOM6@dde5a59 Commenting out deallocation of KPP related arrays - NOAA-GFDL/MOM6@dc82c48 Return call if CS is not allocated - NOAA-GFDL/MOM6@dabe31b Update CVMix - NOAA-GFDL/MOM6@5640daf Attempt to fix deallocating unallocated arrays - NOAA-GFDL/MOM6@93eee52 Merge pull request #49 from gustavo-marques/update_cvmix - NOAA-GFDL/MOM6@d07120c Remove trailing space - NOAA-GFDL/MOM6@69bf4fa Updates CVMix - NOAA-GFDL/MOM6@5f19507 Merge pull request #48 from gustavo-marques/fix_cvmix_convection - NOAA-GFDL/MOM6@caf1d1e Fixes bug and renames variables - NOAA-GFDL/MOM6@869d32f Merge pull request #47 from alperaltuntas/introduce_cvmix_tidal - NOAA-GFDL/MOM6@01578c5 fix tidal_mixing_init return - NOAA-GFDL/MOM6@86e7074 Merge pull request #46 from alperaltuntas/introduce_cvmix_tidal - NOAA-GFDL/MOM6@bf322c8 add tidal mixing-specific prandtl number - NOAA-GFDL/MOM6@81a5ef8 Merged with latest master - NOAA-GFDL/MOM6@696462c MOM_tidal_mixing. cleaanup - NOAA-GFDL/MOM6@3e7cab8 debug calculate_cvmix_tidal - NOAA-GFDL/MOM6@78bb40c Merge pull request #44 from NCAR/adding_cvmix - NOAA-GFDL/MOM6@4dde603 Avoided a possible seg. fault in set_diffusivity_end - NOAA-GFDL/MOM6@36f7a06 Changed kv to a pointer since it might not always be associated - NOAA-GFDL/MOM6@0ce9980 By pass reading BULKMIXEDLAYER via get_param - NOAA-GFDL/MOM6@1218973 Raname variables Kd -> kd_lay; visc%Kv_slow - > kv - NOAA-GFDL/MOM6@ea813b8 add tidal diagnostics for cvmix - NOAA-GFDL/MOM6@648018e Rename kv_conv -> kv_conv_const; kd_conv -> kd_conv_const - NOAA-GFDL/MOM6@c1acec8 Add vertical background viscosity into visc%Kv_slow - NOAA-GFDL/MOM6@a2498a1 Changed name in register_diag_field kd_shear -> kd_shear_cvmix; kv_shear -> kv_shear_cvmix - NOAA-GFDL/MOM6@37ca38f Renamed kd_bkgnd_3d -> kd_bkgnd; kv_bkgnd_3d -> kv_bkgnd - NOAA-GFDL/MOM6@105094f Add viscosities due to convection into visc%Kv_slow - NOAA-GFDL/MOM6@e544290 Allocated/deallocate visc%Kv_slow - NOAA-GFDL/MOM6@801a86a Added variable Kv_slow in visc type - NOAA-GFDL/MOM6@8977888 Move tidal diagnostics to MOM_tidal_mixing module - NOAA-GFDL/MOM6@2430f6e correct tidal energy file dir - NOAA-GFDL/MOM6@a3155d6 Add tidal parameter consistency checks. - NOAA-GFDL/MOM6@80c33a4 Replaced Kv_turb -> Kv_shear - NOAA-GFDL/MOM6@644f200 Replaced Kv_turb -> Kv_shear - NOAA-GFDL/MOM6@6a2e864 Replaced Kd_turb -> Kd_shear and Kv_turb -> Kv_shear - NOAA-GFDL/MOM6@7376f49 update Kd - NOAA-GFDL/MOM6@69ab998 Added a unique Prandtl # for convection and background - NOAA-GFDL/MOM6@4cac1e1 Renamed variables (KH to kd; KM to kv) and added diagnostics - NOAA-GFDL/MOM6@e992292 Added calculate_cvmix_tidal interface - NOAA-GFDL/MOM6@2c451c8 Merge pull request #43 from alperaltuntas/dev/ncar - NOAA-GFDL/MOM6@d1cee89 Add timestep initializations to calculate_cvmix_tidal - NOAA-GFDL/MOM6@7a81871 Re-structured MOM_bkgnd_mixing - NOAA-GFDL/MOM6@3fcdb4c Update to new CVMix tag with tidal mixing changes - NOAA-GFDL/MOM6@f361002 Read in tidal energy dissipation - NOAA-GFDL/MOM6@4e8dd5a Added a if statement to check if Int_tide_dissipation and Bryan_Lewis are used at the same time. - NOAA-GFDL/MOM6@8ef5a1b Renamed Bryan&Lewis coeffs and added a 3D array for depth - NOAA-GFDL/MOM6@08db85c Deleted code that has been moved to MOM_bkgnd_mixing.F90 - NOAA-GFDL/MOM6@1be0248 Added first version of MOM_bkgnd_mixing - NOAA-GFDL/MOM6@1116f49 Fixed a problem in cvmix_init_bkgnd_BryanLewis_low - NOAA-GFDL/MOM6@83089ff Updated CVMix - NOAA-GFDL/MOM6@a101e49 Reduced the numbers of characters in a line - NOAA-GFDL/MOM6@53004ec Deleted module MOM_diffConvection - NOAA-GFDL/MOM6@0bb899a uncomment cvmix_init_tidal - NOAA-GFDL/MOM6@22902de Mv add_int_tide_diffusivity to tidal_mixing module - NOAA-GFDL/MOM6@c34ab63 Move diags back from MOM_tidal_mixing to MOM_set_diffusivity (for now) - NOAA-GFDL/MOM6@76546aa Move tidal mixing initialization to MOM_tidal_mixing - NOAA-GFDL/MOM6@95406ff Rename MOM_cvmix_tidal module as MOM_tidal_mixing (for now) - NOAA-GFDL/MOM6@c2dea88 update diabatic driver for MOM_cvmix_tidal module - NOAA-GFDL/MOM6@bb7917a comment out call ocn_domain_mct to avoid uninitialized vars for now. more comprehensive cleanup is to come. - NOAA-GFDL/MOM6@941bfb6 Updated mixing coeff. due to convection - NOAA-GFDL/MOM6@ba2a0a4 Added function cvmix_conv_is_used and register restart fields. - NOAA-GFDL/MOM6@c78ac9a Add the new module MOM_cvmix_tidal - NOAA-GFDL/MOM6@1d850a6 Changed hbl to an optional pointer; do not apply mixing due to convection within the boundary layer - NOAA-GFDL/MOM6@afd8f59 Fixed a bug in the deallocate call - NOAA-GFDL/MOM6@a77d114 Fixed a bug in the deallocate call - NOAA-GFDL/MOM6@f12702c Dealocate memory via cvmix_shear_end and changed some var names to snake_case convention - NOAA-GFDL/MOM6@a209b7a Added a call to diabatic_driver_end - NOAA-GFDL/MOM6@e84f706 Fix array allocattion/dealocation - NOAA-GFDL/MOM6@7f6d8f1 Added call to KPP_get_BLD - NOAA-GFDL/MOM6@fc00e77 Added function to copy KPP surface boundary layer depth into BLD - NOAA-GFDL/MOM6@c99e94b Updates visc%Kd_turb and visc%Kv_turb after convection is applied - NOAA-GFDL/MOM6@97152b1 Adding first version of convection calls via CVMix - NOAA-GFDL/MOM6@dca5736 Add comments for adding additonal CVMix components and clean module - NOAA-GFDL/MOM6@c6327d6 Copy OBLdepth from KPP into visc%MLD and Hml - NOAA-GFDL/MOM6@71ff26b Changed multi-word names from camelCase to snake_case - NOAA-GFDL/MOM6@8095e8f Merge pull request #42 from gustavo-marques/merge-dev-master-2018-02-28 - NOAA-GFDL/MOM6@bd80a20 Merge branch 'dev/master' into merge-dev-master-2018-02-28 - NOAA-GFDL/MOM6@2f79ffc Merge pull request #41 from gustavo-marques/merge_dev_master_20feb2018 --- .../CM2G63L/MOM_parameter_doc.all | 163 +++++----- .../CM2G63L/MOM_parameter_doc.short | 71 +++-- .../AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all | 163 +++++----- .../MOM_parameter_doc.short | 71 +++-- .../Concurrent_ice_1deg/MOM_parameter_doc.all | 163 +++++----- .../MOM_parameter_doc.short | 71 +++-- ice_ocean_SIS2/Baltic/MOM_parameter_doc.all | 163 +++++----- ice_ocean_SIS2/Baltic/MOM_parameter_doc.short | 71 +++-- .../MOM_parameter_doc.all | 171 +++++----- .../MOM_parameter_doc.short | 71 +++-- .../Baltic_OM4_025/MOM_parameter_doc.all | 215 ++++++------- .../Baltic_OM4_025/MOM_parameter_doc.short | 91 +++--- .../Baltic_OM4_05/MOM_parameter_doc.all | 215 ++++++------- .../Baltic_OM4_05/MOM_parameter_doc.short | 91 +++--- ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all | 215 ++++++------- .../OM4_025/MOM_parameter_doc.short | 91 +++--- ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all | 215 ++++++------- ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short | 91 +++--- ice_ocean_SIS2/SIS2/MOM_parameter_doc.all | 165 +++++----- ice_ocean_SIS2/SIS2/MOM_parameter_doc.short | 73 +++-- .../SIS2_bergs_cgrid/MOM_parameter_doc.all | 165 +++++----- .../SIS2_bergs_cgrid/MOM_parameter_doc.short | 73 +++-- .../SIS2_cgrid/MOM_parameter_doc.all | 165 +++++----- .../SIS2_cgrid/MOM_parameter_doc.short | 73 +++-- .../OM_360x320_C180/MOM_parameter_doc.all | 215 ++++++------- .../OM_360x320_C180/MOM_parameter_doc.short | 81 +++-- .../cooling_only/BML/MOM_parameter_doc.all | 76 ++--- .../cooling_only/BML/MOM_parameter_doc.short | 19 +- .../cooling_only/EPBL/MOM_parameter_doc.all | 84 +++-- .../cooling_only/EPBL/MOM_parameter_doc.short | 19 +- .../cooling_only/KPP/MOM_parameter_doc.all | 90 +++--- .../cooling_only/KPP/MOM_parameter_doc.short | 21 +- .../mech_only/BML/MOM_parameter_doc.all | 76 ++--- .../mech_only/BML/MOM_parameter_doc.short | 19 +- .../mech_only/EPBL/MOM_parameter_doc.all | 84 +++-- .../mech_only/EPBL/MOM_parameter_doc.short | 19 +- .../mech_only/KPP/MOM_parameter_doc.all | 90 +++--- .../mech_only/KPP/MOM_parameter_doc.short | 21 +- .../BML/MOM_parameter_doc.all | 76 ++--- .../BML/MOM_parameter_doc.short | 19 +- .../EPBL/MOM_parameter_doc.all | 84 +++-- .../EPBL/MOM_parameter_doc.short | 19 +- .../KPP/MOM_parameter_doc.all | 90 +++--- .../KPP/MOM_parameter_doc.short | 21 +- .../wind_only/BML/MOM_parameter_doc.all | 76 ++--- .../wind_only/BML/MOM_parameter_doc.short | 19 +- .../wind_only/EPBL/MOM_parameter_doc.all | 84 +++-- .../wind_only/EPBL/MOM_parameter_doc.short | 19 +- .../wind_only/KPP/MOM_parameter_doc.all | 90 +++--- .../wind_only/KPP/MOM_parameter_doc.short | 21 +- ocean_only/DOME/MOM_parameter_doc.all | 82 +++-- ocean_only/DOME/MOM_parameter_doc.short | 17 +- .../Phillips_2layer/MOM_parameter_doc.all | 82 +++-- .../Phillips_2layer/MOM_parameter_doc.short | 17 +- .../MOM_parameter_doc.all | 90 +++--- .../MOM_parameter_doc.short | 21 +- .../adjustment2d/layer/MOM_parameter_doc.all | 84 +++-- .../layer/MOM_parameter_doc.short | 19 +- .../adjustment2d/rho/MOM_parameter_doc.all | 84 +++-- .../adjustment2d/rho/MOM_parameter_doc.short | 19 +- .../adjustment2d/z/MOM_parameter_doc.all | 84 +++-- .../adjustment2d/z/MOM_parameter_doc.short | 19 +- ocean_only/benchmark/MOM_parameter_doc.all | 76 ++--- ocean_only/benchmark/MOM_parameter_doc.short | 19 +- ocean_only/circle_obcs/MOM_parameter_doc.all | 82 +++-- .../circle_obcs/MOM_parameter_doc.short | 17 +- .../external_gwave/MOM_parameter_doc.all | 84 +++-- .../external_gwave/MOM_parameter_doc.short | 19 +- .../layer/MOM_parameter_doc.all | 84 +++-- .../layer/MOM_parameter_doc.short | 19 +- .../flow_downslope/rho/MOM_parameter_doc.all | 84 +++-- .../rho/MOM_parameter_doc.short | 19 +- .../sigma/MOM_parameter_doc.all | 84 +++-- .../sigma/MOM_parameter_doc.short | 19 +- .../flow_downslope/z/MOM_parameter_doc.all | 84 +++-- .../flow_downslope/z/MOM_parameter_doc.short | 19 +- .../global_ALE/hycom/MOM_parameter_doc.all | 171 +++++----- .../global_ALE/hycom/MOM_parameter_doc.short | 71 +++-- .../global_ALE/layer/MOM_parameter_doc.all | 163 +++++----- .../global_ALE/layer/MOM_parameter_doc.short | 71 +++-- .../global_ALE/layer/available_diags.000000 | 292 ++++++++++-------- ocean_only/global_ALE/z/MOM_parameter_doc.all | 171 +++++----- .../global_ALE/z/MOM_parameter_doc.short | 71 +++-- .../global_ALE/z/available_diags.000000 | 292 ++++++++++-------- .../lock_exchange/MOM_parameter_doc.all | 84 +++-- .../lock_exchange/MOM_parameter_doc.short | 19 +- .../MOM_parameter_doc.all | 84 +++-- .../MOM_parameter_doc.short | 19 +- .../nonBous_global/MOM_parameter_doc.all | 165 +++++----- .../nonBous_global/MOM_parameter_doc.short | 73 +++-- .../resting/layer/MOM_parameter_doc.all | 84 +++-- .../resting/layer/MOM_parameter_doc.short | 19 +- ocean_only/resting/z/MOM_parameter_doc.all | 84 +++-- ocean_only/resting/z/MOM_parameter_doc.short | 19 +- .../seamount/layer/MOM_parameter_doc.all | 84 +++-- .../seamount/layer/MOM_parameter_doc.short | 19 +- ocean_only/seamount/rho/MOM_parameter_doc.all | 84 +++-- .../seamount/rho/MOM_parameter_doc.short | 19 +- .../seamount/sigma/MOM_parameter_doc.all | 84 +++-- .../seamount/sigma/MOM_parameter_doc.short | 19 +- ocean_only/seamount/z/MOM_parameter_doc.all | 84 +++-- ocean_only/seamount/z/MOM_parameter_doc.short | 19 +- .../single_column/BML/MOM_parameter_doc.all | 80 +++-- .../single_column/BML/MOM_parameter_doc.short | 22 +- .../single_column/EPBL/MOM_parameter_doc.all | 88 +++--- .../EPBL/MOM_parameter_doc.short | 19 +- .../single_column/KPP/MOM_parameter_doc.all | 88 +++--- .../single_column/KPP/MOM_parameter_doc.short | 23 +- .../sloshing/layer/MOM_parameter_doc.all | 84 +++-- .../sloshing/layer/MOM_parameter_doc.short | 19 +- ocean_only/sloshing/rho/MOM_parameter_doc.all | 84 +++-- .../sloshing/rho/MOM_parameter_doc.short | 19 +- ocean_only/sloshing/z/MOM_parameter_doc.all | 84 +++-- ocean_only/sloshing/z/MOM_parameter_doc.short | 19 +- .../MOM_parameter_doc.all | 84 +++-- .../MOM_parameter_doc.short | 19 +- .../tracer_mixing/rho/MOM_parameter_doc.all | 84 +++-- .../tracer_mixing/rho/MOM_parameter_doc.short | 19 +- .../tracer_mixing/z/MOM_parameter_doc.all | 84 +++-- .../tracer_mixing/z/MOM_parameter_doc.short | 19 +- src/MOM6 | 2 +- 121 files changed, 4523 insertions(+), 4756 deletions(-) diff --git a/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.all index dbbfdd49fc..7e45f18603 100644 --- a/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.all @@ -1233,29 +1233,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1340,9 +1392,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1355,21 +1420,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1377,28 +1432,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1414,38 +1447,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.short index 0d51a08645..b8cdd4431c 100644 --- a/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS/CM2G63L/MOM_parameter_doc.short @@ -404,14 +404,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -449,24 +470,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -475,23 +491,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all index bb05daac46..8df032dec6 100644 --- a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.all @@ -1229,29 +1229,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1336,9 +1388,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1351,21 +1416,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1373,28 +1428,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1410,38 +1443,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short index c17674d7e7..f194de8ab0 100644 --- a/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS2/AM2_SIS2_MOM6i_1deg/MOM_parameter_doc.short @@ -401,14 +401,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -446,24 +467,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -472,23 +488,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all index bb05daac46..8df032dec6 100644 --- a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all +++ b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.all @@ -1229,29 +1229,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1336,9 +1388,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1351,21 +1416,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1373,28 +1428,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1410,38 +1443,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short index c17674d7e7..f194de8ab0 100644 --- a/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short +++ b/coupled_AM2_LM3_SIS2/Concurrent_ice_1deg/MOM_parameter_doc.short @@ -401,14 +401,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -446,24 +467,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -472,23 +488,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all index d827b5444e..b5ece584b1 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.all @@ -1229,29 +1229,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1336,9 +1388,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1351,21 +1416,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1373,28 +1428,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1410,38 +1443,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short index e13be7e811..36e663f8c0 100644 --- a/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic/MOM_parameter_doc.short @@ -413,14 +413,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -458,24 +479,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -484,23 +500,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all index 2520fbc05d..a5664b68a2 100644 --- a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all @@ -1472,29 +1472,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1561,9 +1613,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1576,21 +1645,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1598,32 +1657,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1639,38 +1672,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short index d7f40e7f0e..20987d713b 100644 --- a/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.short @@ -478,14 +478,35 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -516,45 +537,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all index 07c37bdbef..9d1a00b0aa 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.all @@ -1485,29 +1485,103 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 + ! When the Polzin decay profile is used, this is a + ! non-dimensional constant in the expression for the + ! vertical scale of decay for the tidal energy dissipation. +NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 + ! When the Polzin decay profile is used, this is the + ! Rreference value of the buoyancy frequency at the ocean + ! bottom in the Polzin formulation for the vertical + ! scale of decay for the tidal energy dissipation. +POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a + ! scale factor for the vertical scale of decay of the tidal + ! energy dissipation. +POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a factor + ! to limit the vertical scale of decay of the tidal + ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR + ! times the depth of the ocean. +POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 + ! When the Polzin decay profile is used, this is the + ! minimum vertical decay scale for the vertical profile + ! of internal tide dissipation with the Polzin (2009) formulation +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1574,9 +1648,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.5E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 + ! The minimum diapycnal diffusivity. +KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1589,21 +1680,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.5E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1611,54 +1692,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 - ! When the Polzin decay profile is used, this is a - ! non-dimensional constant in the expression for the - ! vertical scale of decay for the tidal energy dissipation. -NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 - ! When the Polzin decay profile is used, this is the - ! Rreference value of the buoyancy frequency at the ocean - ! bottom in the Polzin formulation for the vertical - ! scale of decay for the tidal energy dissipation. -POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a - ! scale factor for the vertical scale of decay of the tidal - ! energy dissipation. -POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a factor - ! to limit the vertical scale of decay of the tidal - ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR - ! times the depth of the ocean. -POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! When the Polzin decay profile is used, this is the - ! minimum vertical decay scale for the vertical profile - ! of internal tide dissipation with the Polzin (2009) formulation USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1674,38 +1707,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short index c98c72aef3..4ec7e40743 100644 --- a/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_OM4_025/MOM_parameter_doc.short @@ -588,14 +588,45 @@ EPBL_IS_ADDITIVE = False ! [Boolean] default = True ! shear and ePBL diffusivities are used. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === @@ -624,55 +655,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.5E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all index 1b62c5a5b8..d961b679d0 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.all @@ -1498,29 +1498,103 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 + ! When the Polzin decay profile is used, this is a + ! non-dimensional constant in the expression for the + ! vertical scale of decay for the tidal energy dissipation. +NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 + ! When the Polzin decay profile is used, this is the + ! Rreference value of the buoyancy frequency at the ocean + ! bottom in the Polzin formulation for the vertical + ! scale of decay for the tidal energy dissipation. +POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a + ! scale factor for the vertical scale of decay of the tidal + ! energy dissipation. +POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a factor + ! to limit the vertical scale of decay of the tidal + ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR + ! times the depth of the ocean. +POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 + ! When the Polzin decay profile is used, this is the + ! minimum vertical decay scale for the vertical profile + ! of internal tide dissipation with the Polzin (2009) formulation +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1587,9 +1661,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.5E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 + ! The minimum diapycnal diffusivity. +KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1602,21 +1693,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.5E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1624,54 +1705,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 - ! When the Polzin decay profile is used, this is a - ! non-dimensional constant in the expression for the - ! vertical scale of decay for the tidal energy dissipation. -NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 - ! When the Polzin decay profile is used, this is the - ! Rreference value of the buoyancy frequency at the ocean - ! bottom in the Polzin formulation for the vertical - ! scale of decay for the tidal energy dissipation. -POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a - ! scale factor for the vertical scale of decay of the tidal - ! energy dissipation. -POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a factor - ! to limit the vertical scale of decay of the tidal - ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR - ! times the depth of the ocean. -POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! When the Polzin decay profile is used, this is the - ! minimum vertical decay scale for the vertical profile - ! of internal tide dissipation with the Polzin (2009) formulation USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1687,38 +1720,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short index 82a66935dd..10b381f085 100644 --- a/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/Baltic_OM4_05/MOM_parameter_doc.short @@ -613,14 +613,45 @@ EPBL_IS_ADDITIVE = False ! [Boolean] default = True ! shear and ePBL diffusivities are used. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === @@ -649,55 +680,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.5E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all index b604006fc1..cdc6242bd2 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.all @@ -1485,29 +1485,103 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 + ! When the Polzin decay profile is used, this is a + ! non-dimensional constant in the expression for the + ! vertical scale of decay for the tidal energy dissipation. +NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 + ! When the Polzin decay profile is used, this is the + ! Rreference value of the buoyancy frequency at the ocean + ! bottom in the Polzin formulation for the vertical + ! scale of decay for the tidal energy dissipation. +POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a + ! scale factor for the vertical scale of decay of the tidal + ! energy dissipation. +POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a factor + ! to limit the vertical scale of decay of the tidal + ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR + ! times the depth of the ocean. +POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 + ! When the Polzin decay profile is used, this is the + ! minimum vertical decay scale for the vertical profile + ! of internal tide dissipation with the Polzin (2009) formulation +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1574,9 +1648,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.5E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 + ! The minimum diapycnal diffusivity. +KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1589,21 +1680,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.5E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1611,54 +1692,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 - ! When the Polzin decay profile is used, this is a - ! non-dimensional constant in the expression for the - ! vertical scale of decay for the tidal energy dissipation. -NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 - ! When the Polzin decay profile is used, this is the - ! Rreference value of the buoyancy frequency at the ocean - ! bottom in the Polzin formulation for the vertical - ! scale of decay for the tidal energy dissipation. -POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a - ! scale factor for the vertical scale of decay of the tidal - ! energy dissipation. -POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a factor - ! to limit the vertical scale of decay of the tidal - ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR - ! times the depth of the ocean. -POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! When the Polzin decay profile is used, this is the - ! minimum vertical decay scale for the vertical profile - ! of internal tide dissipation with the Polzin (2009) formulation USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1674,38 +1707,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short index 9f150b2d77..6f34637e59 100644 --- a/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/OM4_025/MOM_parameter_doc.short @@ -591,14 +591,45 @@ EPBL_IS_ADDITIVE = False ! [Boolean] default = True ! shear and ePBL diffusivities are used. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === @@ -627,55 +658,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.5E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v20140616.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all index 1f1066eded..6f680cc65e 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.all @@ -1504,29 +1504,103 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 + ! When the Polzin decay profile is used, this is a + ! non-dimensional constant in the expression for the + ! vertical scale of decay for the tidal energy dissipation. +NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 + ! When the Polzin decay profile is used, this is the + ! Rreference value of the buoyancy frequency at the ocean + ! bottom in the Polzin formulation for the vertical + ! scale of decay for the tidal energy dissipation. +POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a + ! scale factor for the vertical scale of decay of the tidal + ! energy dissipation. +POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a factor + ! to limit the vertical scale of decay of the tidal + ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR + ! times the depth of the ocean. +POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 + ! When the Polzin decay profile is used, this is the + ! minimum vertical decay scale for the vertical profile + ! of internal tide dissipation with the Polzin (2009) formulation +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1593,9 +1667,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.5E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 + ! The minimum diapycnal diffusivity. +KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1608,21 +1699,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.5E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1630,54 +1711,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.5E-05 ! [m2 s-1] default = 1.5E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 - ! When the Polzin decay profile is used, this is a - ! non-dimensional constant in the expression for the - ! vertical scale of decay for the tidal energy dissipation. -NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 - ! When the Polzin decay profile is used, this is the - ! Rreference value of the buoyancy frequency at the ocean - ! bottom in the Polzin formulation for the vertical - ! scale of decay for the tidal energy dissipation. -POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a - ! scale factor for the vertical scale of decay of the tidal - ! energy dissipation. -POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a factor - ! to limit the vertical scale of decay of the tidal - ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR - ! times the depth of the ocean. -POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! When the Polzin decay profile is used, this is the - ! minimum vertical decay scale for the vertical profile - ! of internal tide dissipation with the Polzin (2009) formulation USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1693,38 +1726,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short index 3af7566de3..b540aa32a2 100644 --- a/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/OM4_05/MOM_parameter_doc.short @@ -629,14 +629,45 @@ EPBL_IS_ADDITIVE = False ! [Boolean] default = True ! shear and ePBL diffusivities are used. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "ocean_topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === @@ -665,55 +696,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.5E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 1.5E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.v2015.12.03.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "ocean_topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all index 3259ca8771..86fa98b46d 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.all @@ -507,7 +507,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -1246,29 +1246,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1353,9 +1405,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1368,21 +1433,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1390,28 +1445,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1427,38 +1460,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short index 7496ba82aa..e71401e862 100644 --- a/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2/MOM_parameter_doc.short @@ -232,7 +232,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -436,14 +436,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -481,24 +502,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -507,23 +523,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all index 07cbded6e8..748bae078a 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.all @@ -507,7 +507,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -1246,29 +1246,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1353,9 +1405,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1368,21 +1433,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1390,28 +1445,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1427,38 +1460,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short index 9aaca54089..90da30a9e0 100644 --- a/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2_bergs_cgrid/MOM_parameter_doc.short @@ -232,7 +232,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -436,14 +436,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -481,24 +502,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -507,23 +523,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all index 07cbded6e8..748bae078a 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.all @@ -507,7 +507,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -1246,29 +1246,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1353,9 +1405,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1368,21 +1433,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1390,28 +1445,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1427,38 +1460,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short index 9aaca54089..90da30a9e0 100644 --- a/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short +++ b/ice_ocean_SIS2/SIS2_cgrid/MOM_parameter_doc.short @@ -232,7 +232,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -436,14 +436,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -481,24 +502,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -507,23 +523,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.all b/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.all index d13658e756..08cc21186b 100644 --- a/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.all +++ b/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.all @@ -1403,29 +1403,103 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 + ! When the Polzin decay profile is used, this is a + ! non-dimensional constant in the expression for the + ! vertical scale of decay for the tidal energy dissipation. +NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 + ! When the Polzin decay profile is used, this is the + ! Rreference value of the buoyancy frequency at the ocean + ! bottom in the Polzin formulation for the vertical + ! scale of decay for the tidal energy dissipation. +POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a + ! scale factor for the vertical scale of decay of the tidal + ! energy dissipation. +POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 + ! When the Polzin decay profile is used, this is a factor + ! to limit the vertical scale of decay of the tidal + ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR + ! times the depth of the ocean. +POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 + ! When the Polzin decay profile is used, this is the + ! minimum vertical decay scale for the vertical profile + ! of internal tide dissipation with the Polzin (2009) formulation +INT_TIDE_DECAY_SCALE = 500.0 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tidal_amplitude.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "topog.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1474,9 +1548,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1489,21 +1580,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1511,54 +1592,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "POLZIN_09" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -NU_POLZIN = 0.0697 ! [nondim] default = 0.0697 - ! When the Polzin decay profile is used, this is a - ! non-dimensional constant in the expression for the - ! vertical scale of decay for the tidal energy dissipation. -NBOTREF_POLZIN = 9.61E-04 ! [s-1] default = 9.61E-04 - ! When the Polzin decay profile is used, this is the - ! Rreference value of the buoyancy frequency at the ocean - ! bottom in the Polzin formulation for the vertical - ! scale of decay for the tidal energy dissipation. -POLZIN_DECAY_SCALE_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a - ! scale factor for the vertical scale of decay of the tidal - ! energy dissipation. -POLZIN_SCALE_MAX_FACTOR = 1.0 ! [nondim] default = 1.0 - ! When the Polzin decay profile is used, this is a factor - ! to limit the vertical scale of decay of the tidal - ! energy dissipation to POLZIN_DECAY_SCALE_MAX_FACTOR - ! times the depth of the ocean. -POLZIN_MIN_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! When the Polzin decay profile is used, this is the - ! minimum vertical decay scale for the vertical profile - ! of internal tide dissipation with the Polzin (2009) formulation USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1574,38 +1607,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 0.0 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.84 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tidal_amplitude.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "topog.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.short b/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.short index bdda9e8a02..52206be655 100644 --- a/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.short +++ b/land_ice_ocean_LM3_SIS2/OM_360x320_C180/MOM_parameter_doc.short @@ -502,48 +502,11 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION - -! === module MOM_entrain_diffusive === - -! === module MOM_set_diffusivity === -BBL_MIXING_AS_MAX = False ! [Boolean] default = True - ! If true, take the maximum of the diffusivity from the - ! BBL mixing and the other diffusivities. Otherwise, - ! diffusiviy from the BBL_mixing is simply added. -USE_LOTW_BBL_DIFFUSIVITY = True ! [Boolean] default = False - ! If true, uses a simple, imprecise but non-coordinate dependent, model - ! of BBL mixing diffusivity based on Law of the Wall. Otherwise, uses - ! the original BBL scheme. -SIMPLE_TKE_TO_KD = True ! [Boolean] default = False - ! If true, uses a simple estimate of Kd/TKE that will - ! work for arbitrary vertical coordinates. If false, - ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. -KD_MAX = 0.1 ! [m2 s-1] default = -1.0 - ! The maximum permitted increment for the diapycnal - ! diffusivity from TKE-based parameterizations, or a - ! negative value for no limit. +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization INT_TIDE_DISSIPATION = True ! [Boolean] default = False ! If true, use an internal tidal dissipation scheme to ! drive diapycnal mixing, along the lines of St. Laurent @@ -573,6 +536,42 @@ H2_FILE = "topog.nc" ! ! The path to the file containing the sub-grid-scale ! topographic roughness amplitude with INT_TIDE_DISSIPATION. +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix + +! === module MOM_entrain_diffusive === + +! === module MOM_set_diffusivity === +BBL_MIXING_AS_MAX = False ! [Boolean] default = True + ! If true, take the maximum of the diffusivity from the + ! BBL mixing and the other diffusivities. Otherwise, + ! diffusiviy from the BBL_mixing is simply added. +USE_LOTW_BBL_DIFFUSIVITY = True ! [Boolean] default = False + ! If true, uses a simple, imprecise but non-coordinate dependent, model + ! of BBL mixing diffusivity based on Law of the Wall. Otherwise, uses + ! the original BBL scheme. +SIMPLE_TKE_TO_KD = True ! [Boolean] default = False + ! If true, uses a simple estimate of Kd/TKE that will + ! work for arbitrary vertical coordinates. If false, + ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. +KD_MAX = 0.1 ! [m2 s-1] default = -1.0 + ! The maximum permitted increment for the diapycnal + ! diffusivity from TKE-based parameterizations, or a + ! negative value for no limit. + ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 USE_JACKSON_PARAM = True ! [Boolean] default = False diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all index c4316e7554..f59a118664 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.all @@ -442,7 +442,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -908,29 +908,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -976,9 +978,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -987,21 +1002,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1009,21 +1014,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.short index 42410fe947..571855e802 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/cooling_only/BML/MOM_parameter_doc.short @@ -199,7 +199,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -320,14 +320,14 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -337,6 +337,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all index 4187b02a64..71e104497d 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,29 +1012,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1080,9 +1082,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1091,21 +1110,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1113,25 +1122,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.short index 130a181965..b89e2aceda 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/cooling_only/EPBL/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -346,14 +346,14 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -363,6 +363,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all index d1498c3a9f..1ad2613502 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,10 +1012,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1070,10 +1070,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1094,7 +1094,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1102,20 +1102,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1161,9 +1163,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1172,21 +1191,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1194,25 +1203,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.short index 1d7160d1e2..83ec5400c1 100644 --- a/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/cooling_only/KPP/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -342,19 +342,19 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -364,6 +364,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all index 9b7ba8a8c5..1562b73a2f 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.all @@ -442,7 +442,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -908,29 +908,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -976,9 +978,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -987,21 +1002,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1009,21 +1014,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.short index cf82d37a46..8c1979d64d 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/mech_only/BML/MOM_parameter_doc.short @@ -199,7 +199,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -320,14 +320,14 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -337,6 +337,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all index 53547cbbcc..932a9c65c4 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,29 +1012,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1080,9 +1082,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1091,21 +1110,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1113,25 +1122,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.short index 88b5b55f85..42bef199be 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/mech_only/EPBL/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -346,14 +346,14 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -363,6 +363,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all index 7395c00c16..ebd3c1837d 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,10 +1012,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1070,10 +1070,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1094,7 +1094,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1102,20 +1102,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1161,9 +1163,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1172,21 +1191,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1194,25 +1203,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.short index 65d694c89f..fd45af6e1a 100644 --- a/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/mech_only/KPP/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -342,19 +342,19 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -364,6 +364,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all index 210a234f5f..df9b0e5c08 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.all @@ -442,7 +442,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -908,29 +908,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -976,9 +978,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -987,21 +1002,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1009,21 +1014,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.short index 31f0c3900a..a186cb8ea3 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/BML/MOM_parameter_doc.short @@ -199,7 +199,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -320,14 +320,14 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -337,6 +337,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all index c08f3d6cfc..f56ae7400d 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,29 +1012,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1080,9 +1082,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1091,21 +1110,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1113,25 +1122,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.short index ce1b4c628f..9f1e426079 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/EPBL/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -346,14 +346,14 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -363,6 +363,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all index 8cae722562..bee99bfd3a 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,10 +1012,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1070,10 +1070,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1094,7 +1094,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1102,20 +1102,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1161,9 +1163,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1172,21 +1191,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1194,25 +1203,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.short index 004dd8d293..52e1a69a19 100644 --- a/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/skin_warming_wind/KPP/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -342,19 +342,19 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -364,6 +364,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all index 1b73b71e0e..4590a353f5 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.all @@ -442,7 +442,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -908,29 +908,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -976,9 +978,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -987,21 +1002,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1009,21 +1014,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.short index 339b58cdc9..2a01248e2d 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/wind_only/BML/MOM_parameter_doc.short @@ -199,7 +199,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -320,14 +320,14 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -337,6 +337,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all index b48beb4183..e01139f822 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,29 +1012,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1080,9 +1082,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1091,21 +1110,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1113,25 +1122,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.short index d02decb6f0..5a83a9006e 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/wind_only/EPBL/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -346,14 +346,14 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -363,6 +363,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all index 24c57ce62d..81b82e4860 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all +++ b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1012,10 +1012,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1070,10 +1070,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1094,7 +1094,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1102,20 +1102,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1161,9 +1163,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1172,21 +1191,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1194,25 +1203,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.short b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.short index e6ab2d0d77..134c7ac3ff 100644 --- a/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.short +++ b/ocean_only/CVmix_SCM_tests/wind_only/KPP/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 15.0 ! [C] ! Reference surface temperature @@ -342,19 +342,19 @@ Z_OUTPUT_GRID_FILE = "zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -364,6 +364,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/DOME/MOM_parameter_doc.all b/ocean_only/DOME/MOM_parameter_doc.all index d0ef6e5659..0e06b32b64 100644 --- a/ocean_only/DOME/MOM_parameter_doc.all +++ b/ocean_only/DOME/MOM_parameter_doc.all @@ -1063,29 +1063,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1131,9 +1133,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.0E-04 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 + ! The minimum diapycnal diffusivity. +KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1142,21 +1161,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.0E-04 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1164,25 +1173,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/DOME/MOM_parameter_doc.short b/ocean_only/DOME/MOM_parameter_doc.short index 5ab914ac64..4059bbd01b 100644 --- a/ocean_only/DOME/MOM_parameter_doc.short +++ b/ocean_only/DOME/MOM_parameter_doc.short @@ -351,14 +351,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -368,6 +368,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 3.464101615137755E-05 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.0E-04 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.all b/ocean_only/Phillips_2layer/MOM_parameter_doc.all index 4fe73b94c0..e489e8f962 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.all +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.all @@ -1056,29 +1056,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1124,9 +1126,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.0E-04 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 + ! The minimum diapycnal diffusivity. +KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1135,21 +1154,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.0E-04 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1157,25 +1166,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/Phillips_2layer/MOM_parameter_doc.short b/ocean_only/Phillips_2layer/MOM_parameter_doc.short index 6e865f3907..469398a4a5 100644 --- a/ocean_only/Phillips_2layer/MOM_parameter_doc.short +++ b/ocean_only/Phillips_2layer/MOM_parameter_doc.short @@ -378,14 +378,14 @@ KHTH = 8000.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -395,6 +395,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 2.449489742783178E-05 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.0E-04 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all index ff23a45d88..b4c2a714bf 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.all @@ -537,7 +537,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_S_REF = 35.0 ! [1e-3] default = 35.0 ! Reference salinity @@ -1009,10 +1009,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1067,10 +1067,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1091,7 +1091,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1099,20 +1099,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1158,9 +1160,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1169,21 +1188,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1191,25 +1200,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.short b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.short index 98edc05fa0..ec8625bc35 100644 --- a/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.short +++ b/ocean_only/SCM_idealized_hurricane/MOM_parameter_doc.short @@ -223,7 +223,7 @@ TS_CONFIG = "SCM_ideal_hurr" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. SCM_SST_REF = 29.25 ! [C] ! Reference surface temperature @@ -341,10 +341,10 @@ MAXVEL = 6.0 ! [m s-1] default = 3.0E+08 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% APPLY_NONLOCAL_TRANSPORT = False ! [Boolean] default = True @@ -353,11 +353,11 @@ APPLY_NONLOCAL_TRANSPORT = False ! [Boolean] default = True ! purely for diagnostic purposes. %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -367,6 +367,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.0E-08 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all index ae5afa62e8..f977d7a82c 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.all @@ -466,7 +466,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -1107,29 +1107,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1175,9 +1177,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1186,21 +1205,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1208,25 +1217,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/adjustment2d/layer/MOM_parameter_doc.short b/ocean_only/adjustment2d/layer/MOM_parameter_doc.short index f89b12fd48..d0a05826bf 100644 --- a/ocean_only/adjustment2d/layer/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/layer/MOM_parameter_doc.short @@ -232,7 +232,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -388,14 +388,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -408,6 +408,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all index 21f35b9835..6f0e44afda 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.all @@ -608,7 +608,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -1253,29 +1253,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1321,9 +1323,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1332,21 +1351,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1354,25 +1363,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/adjustment2d/rho/MOM_parameter_doc.short b/ocean_only/adjustment2d/rho/MOM_parameter_doc.short index f8704697b0..bd8d318c46 100644 --- a/ocean_only/adjustment2d/rho/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/rho/MOM_parameter_doc.short @@ -280,7 +280,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -436,14 +436,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -456,6 +456,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.all b/ocean_only/adjustment2d/z/MOM_parameter_doc.all index e092dc5256..a24a413382 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.all +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.all @@ -562,7 +562,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -1207,29 +1207,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1275,9 +1277,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1286,21 +1305,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1308,25 +1317,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/adjustment2d/z/MOM_parameter_doc.short b/ocean_only/adjustment2d/z/MOM_parameter_doc.short index 26e91d5f88..a82e9ee6ad 100644 --- a/ocean_only/adjustment2d/z/MOM_parameter_doc.short +++ b/ocean_only/adjustment2d/z/MOM_parameter_doc.short @@ -256,7 +256,7 @@ TS_CONFIG = "adjustment2d" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 0.0 ! [1e-3] ! Reference salinity @@ -412,14 +412,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -432,6 +432,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/benchmark/MOM_parameter_doc.all b/ocean_only/benchmark/MOM_parameter_doc.all index 71bf806f6b..b257d9d07e 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.all +++ b/ocean_only/benchmark/MOM_parameter_doc.all @@ -484,7 +484,7 @@ TS_CONFIG = "benchmark" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. VELOCITY_CONFIG = "zero" ! default = "zero" ! A string that determines how the initial velocities @@ -1185,29 +1185,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1253,9 +1255,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-07 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1264,21 +1279,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-07 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1286,21 +1291,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/benchmark/MOM_parameter_doc.short b/ocean_only/benchmark/MOM_parameter_doc.short index 040ed52248..0dc6dc6af2 100644 --- a/ocean_only/benchmark/MOM_parameter_doc.short +++ b/ocean_only/benchmark/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "benchmark" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module MOM_diag_mediator === @@ -405,14 +405,14 @@ FOX_KEMPER_ML_RESTRAT_COEF = 5.0 ! [nondim] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -422,6 +422,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.341640786499874E-05 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.all b/ocean_only/circle_obcs/MOM_parameter_doc.all index 6d384979d6..8321757bb6 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.all +++ b/ocean_only/circle_obcs/MOM_parameter_doc.all @@ -1116,29 +1116,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1184,9 +1186,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 1.0E-04 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 + ! The minimum diapycnal diffusivity. +KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1195,21 +1214,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 1.0E-04 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1217,25 +1226,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 1.0E-04 ! [m2 s-1] default = 1.0E-04 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/circle_obcs/MOM_parameter_doc.short b/ocean_only/circle_obcs/MOM_parameter_doc.short index dc8c729d0f..22cfc4da54 100644 --- a/ocean_only/circle_obcs/MOM_parameter_doc.short +++ b/ocean_only/circle_obcs/MOM_parameter_doc.short @@ -355,14 +355,14 @@ DTBT = -0.95 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -372,6 +372,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 1.095445115010332E-05 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 1.0E-04 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/external_gwave/MOM_parameter_doc.all b/ocean_only/external_gwave/MOM_parameter_doc.all index a568516c6a..664c4b3607 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.all +++ b/ocean_only/external_gwave/MOM_parameter_doc.all @@ -454,7 +454,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_REF = 5.0 ! [degC] ! A reference temperature used in initialization. @@ -1088,29 +1088,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1156,9 +1158,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1167,21 +1186,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1189,25 +1198,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/external_gwave/MOM_parameter_doc.short b/ocean_only/external_gwave/MOM_parameter_doc.short index 57acb362bc..318023aae7 100644 --- a/ocean_only/external_gwave/MOM_parameter_doc.short +++ b/ocean_only/external_gwave/MOM_parameter_doc.short @@ -222,7 +222,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_REF = 5.0 ! [degC] ! A reference temperature used in initialization. @@ -367,14 +367,14 @@ DTBT = 20.0 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -392,6 +392,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all index 23b8816c40..489d7fae2b 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.all @@ -461,7 +461,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -1099,29 +1099,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1167,9 +1169,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1178,21 +1197,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1200,25 +1209,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/flow_downslope/layer/MOM_parameter_doc.short b/ocean_only/flow_downslope/layer/MOM_parameter_doc.short index 2886389e8a..4a4f39a3da 100644 --- a/ocean_only/flow_downslope/layer/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/layer/MOM_parameter_doc.short @@ -218,7 +218,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -385,14 +385,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -401,6 +401,9 @@ CORRECT_DENSITY = False ! [Boolean] default = True ! mixing, as described in Hallberg (MWR, 2000). ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all index 014af90a96..bafcfcc5f1 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.all @@ -605,7 +605,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -1247,29 +1247,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1315,9 +1317,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1326,21 +1345,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1348,25 +1357,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/flow_downslope/rho/MOM_parameter_doc.short b/ocean_only/flow_downslope/rho/MOM_parameter_doc.short index c1bf12286c..f7954993dc 100644 --- a/ocean_only/flow_downslope/rho/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/rho/MOM_parameter_doc.short @@ -268,7 +268,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -435,14 +435,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -451,6 +451,9 @@ CORRECT_DENSITY = False ! [Boolean] default = True ! mixing, as described in Hallberg (MWR, 2000). ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all index 30b5317e88..0ceba1a4d0 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.all @@ -559,7 +559,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -1201,29 +1201,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1269,9 +1271,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1280,21 +1299,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1302,25 +1311,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short index 81d84adf6a..3f49ab31fb 100644 --- a/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/sigma/MOM_parameter_doc.short @@ -241,7 +241,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -408,14 +408,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -424,6 +424,9 @@ CORRECT_DENSITY = False ! [Boolean] default = True ! mixing, as described in Hallberg (MWR, 2000). ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.all b/ocean_only/flow_downslope/z/MOM_parameter_doc.all index ae9f062789..f50331baf1 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.all +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.all @@ -559,7 +559,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -1201,29 +1201,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1269,9 +1271,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1280,21 +1299,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1302,25 +1311,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/flow_downslope/z/MOM_parameter_doc.short b/ocean_only/flow_downslope/z/MOM_parameter_doc.short index 35ddabe8fa..7b08178f56 100644 --- a/ocean_only/flow_downslope/z/MOM_parameter_doc.short +++ b/ocean_only/flow_downslope/z/MOM_parameter_doc.short @@ -241,7 +241,7 @@ TS_CONFIG = "DOME2D" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -408,14 +408,14 @@ KHTH = 1.0E-04 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -424,6 +424,9 @@ CORRECT_DENSITY = False ! [Boolean] default = True ! mixing, as described in Hallberg (MWR, 2000). ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all index 9f66ffa981..e94da5df05 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.all @@ -1516,29 +1516,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1605,9 +1657,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1620,21 +1689,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1642,32 +1701,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1683,38 +1716,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/hycom/MOM_parameter_doc.short b/ocean_only/global_ALE/hycom/MOM_parameter_doc.short index 172e6ef112..4994f60da6 100644 --- a/ocean_only/global_ALE/hycom/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/hycom/MOM_parameter_doc.short @@ -504,14 +504,35 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -542,45 +563,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.all b/ocean_only/global_ALE/layer/MOM_parameter_doc.all index d6d6b6cb5b..472cfe5b6b 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.all @@ -1332,29 +1332,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1421,9 +1473,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1436,21 +1501,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1458,28 +1513,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1495,38 +1528,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/layer/MOM_parameter_doc.short b/ocean_only/global_ALE/layer/MOM_parameter_doc.short index 735669ab59..19e2782bcb 100644 --- a/ocean_only/global_ALE/layer/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/layer/MOM_parameter_doc.short @@ -420,14 +420,35 @@ Z_OUTPUT_GRID_FILE = "analysis_vgrid_lev35.v1.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -454,45 +475,23 @@ USE_LOTW_BBL_DIFFUSIVITY = True ! [Boolean] default = False ! If true, uses a simple, imprecise but non-coordinate dependent, model ! of BBL mixing diffusivity based on Law of the Wall. Otherwise, uses ! the original BBL scheme. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/layer/available_diags.000000 b/ocean_only/global_ALE/layer/available_diags.000000 index fd83a90bce..02ae0b457f 100644 --- a/ocean_only/global_ALE/layer/available_diags.000000 +++ b/ocean_only/global_ALE/layer/available_diags.000000 @@ -2402,117 +2402,6 @@ ! long_name: Depth integrated heat tendency due to frazil formation ! units: W m-2 ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "Kd_effective" [Used] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_effective_xyave" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_effective" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_effective_xyave" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: z_l:mean -"ocean_model", "diff_work" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: xh:mean yh:mean zi:point area:mean -"ocean_model", "diff_work_xyave" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: zi:point -"ocean_model_z", "diff_work" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: xh:mean yh:mean z_i:point area:mean -"ocean_model_z", "diff_work_xyave" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: z_i:point -"ocean_model", "geo_heat" [Unused] - ! long_name: Geothermal heat flux into ocean - ! units: W m-2 -"ocean_model", "hfgeou" [Used] - ! long_name: Upward geothermal heat flux at sea floor - ! units: W m-2 - ! standard_name: upward_geothermal_heat_flux_at_sea_floor -"ocean_model", "Kd_BBL" [Used] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zi:point area:mean -"ocean_model", "Kd_BBL_xyave" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: zi:point -"ocean_model_z", "Kd_BBL" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_i:point area:mean -"ocean_model_z", "Kd_BBL_xyave" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: z_i:point -"ocean_model", "Kd_layer" [Used] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_layer_xyave" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_layer" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_layer_xyave" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: z_l:mean -"ocean_model", "TKE_itidal" [Unused] - ! long_name: Internal Tide Driven Turbulent Kinetic Energy - ! units: W m-2 - ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "maxTKE" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "maxTKE_xyave" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: zl:mean -"ocean_model_z", "maxTKE" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "maxTKE_xyave" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: z_l:mean -"ocean_model", "TKE_to_Kd" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "TKE_to_Kd_xyave" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: zl:mean -"ocean_model_z", "TKE_to_Kd" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "TKE_to_Kd_xyave" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: z_l:mean -"ocean_model", "Nb" [Unused] - ! long_name: Bottom Buoyancy Frequency - ! units: s-1 - ! cell_methods: xh:mean yh:mean area:mean "ocean_model", "Kd_itides" [Used] ! long_name: Internal Tide Driven Diffusivity ! units: m2 s-1 @@ -2529,6 +2418,14 @@ ! long_name: Internal Tide Driven Diffusivity ! units: m2 s-1 ! cell_methods: z_i:point +"ocean_model", "TKE_itidal" [Unused] + ! long_name: Internal Tide Driven Turbulent Kinetic Energy + ! units: W m-2 + ! cell_methods: xh:mean yh:mean area:mean +"ocean_model", "Nb" [Unused] + ! long_name: Bottom Buoyancy Frequency + ! units: s-1 + ! cell_methods: xh:mean yh:mean area:mean "ocean_model", "Kd_lowmode" [Unused] ! long_name: Internal Tide Driven Diffusivity (from propagating low modes) ! units: m2 s-1 @@ -2593,22 +2490,6 @@ ! long_name: Buoyancy frequency squared averaged over the water column ! units: s-2 ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "Kd_Work" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_Work_xyave" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_Work" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_Work_xyave" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: z_l:mean "ocean_model", "Kd_Itidal_Work" [Unused] ! long_name: Work done by Internal Tide Diapycnal Mixing ! units: W m-2 @@ -2657,6 +2538,160 @@ ! long_name: Work done by Internal Tide Diapycnal Mixing (low modes) ! units: W m-2 ! cell_methods: z_l:mean +"ocean_model_zold", "Kd_itides" [Unused] + ! long_name: Internal Tide Driven Diffusivity, interpolated to z + ! units: m2 s-1 +"ocean_model", "Kd_effective" [Used] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_effective_xyave" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_effective" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_effective_xyave" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: z_l:mean +"ocean_model", "diff_work" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "diff_work_xyave" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: zi:point +"ocean_model_z", "diff_work" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "diff_work_xyave" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: z_i:point +"ocean_model", "geo_heat" [Unused] + ! long_name: Geothermal heat flux into ocean + ! units: W m-2 +"ocean_model", "hfgeou" [Used] + ! long_name: Upward geothermal heat flux at sea floor + ! units: W m-2 + ! standard_name: upward_geothermal_heat_flux_at_sea_floor +"ocean_model", "Kd_BBL" [Used] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kd_BBL_xyave" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: zi:point +"ocean_model_z", "Kd_BBL" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kd_BBL_xyave" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: z_i:point +"ocean_model", "Kd_bkgnd" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kd_bkgnd_xyave" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: zi:point +"ocean_model_z", "Kd_bkgnd" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kd_bkgnd_xyave" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: z_i:point +"ocean_model", "Kv_bkgnd" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kv_bkgnd_xyave" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: zi:point +"ocean_model_z", "Kv_bkgnd" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kv_bkgnd_xyave" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: z_i:point +"ocean_model", "Kd_layer" [Used] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_layer_xyave" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_layer" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_layer_xyave" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: z_l:mean +"ocean_model", "Kd_Work" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_Work_xyave" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_Work" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_Work_xyave" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: z_l:mean +"ocean_model", "maxTKE" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "maxTKE_xyave" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: zl:mean +"ocean_model_z", "maxTKE" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "maxTKE_xyave" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: z_l:mean +"ocean_model", "TKE_to_Kd" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "TKE_to_Kd_xyave" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: zl:mean +"ocean_model_z", "TKE_to_Kd" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "TKE_to_Kd_xyave" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: z_l:mean "ocean_model", "N2" [Unused] (CMOR equivalent is "obvfsq") ! long_name: Buoyancy frequency squared ! units: s-2 @@ -2696,9 +2731,6 @@ "ocean_model_zold", "N2" [Unused] ! long_name: Buoyancy frequency, interpolated to z ! units: s-2 -"ocean_model_zold", "Kd_itides" [Unused] - ! long_name: Internal Tide Driven Diffusivity, interpolated to z - ! units: m2 s-1 "ocean_model", "Kd_shear" [Used] ! long_name: Shear-driven Diapycnal Diffusivity ! units: m2 s-1 diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.all b/ocean_only/global_ALE/z/MOM_parameter_doc.all index f6aff91353..bcc1c2f343 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.all +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.all @@ -1468,29 +1468,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1557,9 +1609,26 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1572,21 +1641,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1594,32 +1653,6 @@ KD_MAX = 0.1 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1635,38 +1668,6 @@ DISSIPATION_N1 = 0.0 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/z/MOM_parameter_doc.short b/ocean_only/global_ALE/z/MOM_parameter_doc.short index aaa6a21f48..af4a0d364e 100644 --- a/ocean_only/global_ALE/z/MOM_parameter_doc.short +++ b/ocean_only/global_ALE/z/MOM_parameter_doc.short @@ -478,14 +478,35 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -516,45 +537,23 @@ SIMPLE_TKE_TO_KD = True ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. KD_MAX = 0.1 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a ! negative value for no limit. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/global_ALE/z/available_diags.000000 b/ocean_only/global_ALE/z/available_diags.000000 index 3b2e0bdcaa..21c31df336 100644 --- a/ocean_only/global_ALE/z/available_diags.000000 +++ b/ocean_only/global_ALE/z/available_diags.000000 @@ -2684,117 +2684,6 @@ ! long_name: Depth integrated heat tendency due to frazil formation ! units: W m-2 ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "Kd_effective" [Used] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_effective_xyave" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_effective" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_effective_xyave" [Unused] - ! long_name: Diapycnal diffusivity as applied - ! units: m2 s-1 - ! cell_methods: z_l:mean -"ocean_model", "diff_work" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: xh:mean yh:mean zi:point area:mean -"ocean_model", "diff_work_xyave" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: zi:point -"ocean_model_z", "diff_work" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: xh:mean yh:mean z_i:point area:mean -"ocean_model_z", "diff_work_xyave" [Unused] - ! long_name: Work actually done by diapycnal diffusion across each interface - ! units: W m-2 - ! cell_methods: z_i:point -"ocean_model", "geo_heat" [Unused] - ! long_name: Geothermal heat flux into ocean - ! units: W m-2 -"ocean_model", "hfgeou" [Used] - ! long_name: Upward geothermal heat flux at sea floor - ! units: W m-2 - ! standard_name: upward_geothermal_heat_flux_at_sea_floor -"ocean_model", "Kd_BBL" [Used] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zi:point area:mean -"ocean_model", "Kd_BBL_xyave" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: zi:point -"ocean_model_z", "Kd_BBL" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_i:point area:mean -"ocean_model_z", "Kd_BBL_xyave" [Unused] - ! long_name: Bottom Boundary Layer Diffusivity - ! units: m2 s-1 - ! cell_methods: z_i:point -"ocean_model", "Kd_layer" [Used] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_layer_xyave" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_layer" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_layer_xyave" [Unused] - ! long_name: Diapycnal diffusivity of layers (as set) - ! units: m2 s-1 - ! cell_methods: z_l:mean -"ocean_model", "TKE_itidal" [Unused] - ! long_name: Internal Tide Driven Turbulent Kinetic Energy - ! units: W m-2 - ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "maxTKE" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "maxTKE_xyave" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: zl:mean -"ocean_model_z", "maxTKE" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "maxTKE_xyave" [Unused] - ! long_name: Maximum layer TKE - ! units: m3 s-3 - ! cell_methods: z_l:mean -"ocean_model", "TKE_to_Kd" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "TKE_to_Kd_xyave" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: zl:mean -"ocean_model_z", "TKE_to_Kd" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "TKE_to_Kd_xyave" [Unused] - ! long_name: Convert TKE to Kd - ! units: s2 m - ! cell_methods: z_l:mean -"ocean_model", "Nb" [Unused] - ! long_name: Bottom Buoyancy Frequency - ! units: s-1 - ! cell_methods: xh:mean yh:mean area:mean "ocean_model", "Kd_itides" [Used] ! long_name: Internal Tide Driven Diffusivity ! units: m2 s-1 @@ -2811,6 +2700,14 @@ ! long_name: Internal Tide Driven Diffusivity ! units: m2 s-1 ! cell_methods: z_i:point +"ocean_model", "TKE_itidal" [Unused] + ! long_name: Internal Tide Driven Turbulent Kinetic Energy + ! units: W m-2 + ! cell_methods: xh:mean yh:mean area:mean +"ocean_model", "Nb" [Unused] + ! long_name: Bottom Buoyancy Frequency + ! units: s-1 + ! cell_methods: xh:mean yh:mean area:mean "ocean_model", "Kd_lowmode" [Unused] ! long_name: Internal Tide Driven Diffusivity (from propagating low modes) ! units: m2 s-1 @@ -2875,22 +2772,6 @@ ! long_name: Buoyancy frequency squared averaged over the water column ! units: s-2 ! cell_methods: xh:mean yh:mean area:mean -"ocean_model", "Kd_Work" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: xh:mean yh:mean zl:mean area:mean -"ocean_model", "Kd_Work_xyave" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: zl:mean -"ocean_model_z", "Kd_Work" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: xh:mean yh:mean z_l:mean area:mean -"ocean_model_z", "Kd_Work_xyave" [Unused] - ! long_name: Work done by Diapycnal Mixing - ! units: W m-2 - ! cell_methods: z_l:mean "ocean_model", "Kd_Itidal_Work" [Unused] ! long_name: Work done by Internal Tide Diapycnal Mixing ! units: W m-2 @@ -2939,6 +2820,160 @@ ! long_name: Work done by Internal Tide Diapycnal Mixing (low modes) ! units: W m-2 ! cell_methods: z_l:mean +"ocean_model_zold", "Kd_itides" [Unused] + ! long_name: Internal Tide Driven Diffusivity, interpolated to z + ! units: m2 s-1 +"ocean_model", "Kd_effective" [Used] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_effective_xyave" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_effective" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_effective_xyave" [Unused] + ! long_name: Diapycnal diffusivity as applied + ! units: m2 s-1 + ! cell_methods: z_l:mean +"ocean_model", "diff_work" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "diff_work_xyave" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: zi:point +"ocean_model_z", "diff_work" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "diff_work_xyave" [Unused] + ! long_name: Work actually done by diapycnal diffusion across each interface + ! units: W m-2 + ! cell_methods: z_i:point +"ocean_model", "geo_heat" [Unused] + ! long_name: Geothermal heat flux into ocean + ! units: W m-2 +"ocean_model", "hfgeou" [Used] + ! long_name: Upward geothermal heat flux at sea floor + ! units: W m-2 + ! standard_name: upward_geothermal_heat_flux_at_sea_floor +"ocean_model", "Kd_BBL" [Used] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kd_BBL_xyave" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: zi:point +"ocean_model_z", "Kd_BBL" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kd_BBL_xyave" [Unused] + ! long_name: Bottom Boundary Layer Diffusivity + ! units: m2 s-1 + ! cell_methods: z_i:point +"ocean_model", "Kd_bkgnd" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kd_bkgnd_xyave" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: zi:point +"ocean_model_z", "Kd_bkgnd" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kd_bkgnd_xyave" [Unused] + ! long_name: Background diffusivity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: z_i:point +"ocean_model", "Kv_bkgnd" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean zi:point area:mean +"ocean_model", "Kv_bkgnd_xyave" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: zi:point +"ocean_model_z", "Kv_bkgnd" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: xh:mean yh:mean z_i:point area:mean +"ocean_model_z", "Kv_bkgnd_xyave" [Unused] + ! long_name: Background viscosity added by MOM_bkgnd_mixing module + ! units: m2/s + ! cell_methods: z_i:point +"ocean_model", "Kd_layer" [Used] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_layer_xyave" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_layer" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_layer_xyave" [Unused] + ! long_name: Diapycnal diffusivity of layers (as set) + ! units: m2 s-1 + ! cell_methods: z_l:mean +"ocean_model", "Kd_Work" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "Kd_Work_xyave" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: zl:mean +"ocean_model_z", "Kd_Work" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "Kd_Work_xyave" [Unused] + ! long_name: Work done by Diapycnal Mixing + ! units: W m-2 + ! cell_methods: z_l:mean +"ocean_model", "maxTKE" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "maxTKE_xyave" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: zl:mean +"ocean_model_z", "maxTKE" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "maxTKE_xyave" [Unused] + ! long_name: Maximum layer TKE + ! units: m3 s-3 + ! cell_methods: z_l:mean +"ocean_model", "TKE_to_Kd" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: xh:mean yh:mean zl:mean area:mean +"ocean_model", "TKE_to_Kd_xyave" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: zl:mean +"ocean_model_z", "TKE_to_Kd" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: xh:mean yh:mean z_l:mean area:mean +"ocean_model_z", "TKE_to_Kd_xyave" [Unused] + ! long_name: Convert TKE to Kd + ! units: s2 m + ! cell_methods: z_l:mean "ocean_model", "N2" [Unused] (CMOR equivalent is "obvfsq") ! long_name: Buoyancy frequency squared ! units: s-2 @@ -2978,9 +3013,6 @@ "ocean_model_zold", "N2" [Unused] ! long_name: Buoyancy frequency, interpolated to z ! units: s-2 -"ocean_model_zold", "Kd_itides" [Unused] - ! long_name: Internal Tide Driven Diffusivity, interpolated to z - ! units: m2 s-1 "ocean_model", "Kd_shear" [Used] ! long_name: Shear-driven Diapycnal Diffusivity ! units: m2 s-1 diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.all b/ocean_only/lock_exchange/MOM_parameter_doc.all index 6305004071..1820ed1665 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.all +++ b/ocean_only/lock_exchange/MOM_parameter_doc.all @@ -457,7 +457,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_REF = 5.0 ! [degC] ! A reference temperature used in initialization. @@ -1091,29 +1091,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1159,9 +1161,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1170,21 +1189,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1192,25 +1201,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/lock_exchange/MOM_parameter_doc.short b/ocean_only/lock_exchange/MOM_parameter_doc.short index ff4a183ae6..7fcffa03fd 100644 --- a/ocean_only/lock_exchange/MOM_parameter_doc.short +++ b/ocean_only/lock_exchange/MOM_parameter_doc.short @@ -214,7 +214,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_REF = 5.0 ! [degC] ! A reference temperature used in initialization. @@ -349,14 +349,14 @@ DTBT = 25.0 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -374,6 +374,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all index 98a432f305..6eeda5d5af 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.all @@ -552,7 +552,7 @@ TS_CONFIG = "rossby_front" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -1235,29 +1235,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1303,9 +1305,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1314,21 +1333,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1336,25 +1345,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.short b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.short index 0eabaec7c7..fc0911b34e 100644 --- a/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.short +++ b/ocean_only/mixed_layer_restrat_2d/MOM_parameter_doc.short @@ -224,7 +224,7 @@ TS_CONFIG = "rossby_front" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference salinity @@ -402,14 +402,14 @@ FOX_KEMPER_ML_RESTRAT_COEF = 10.0 ! [nondim] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -418,6 +418,9 @@ CORRECT_DENSITY = False ! [Boolean] default = True ! mixing, as described in Hallberg (MWR, 2000). ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.all b/ocean_only/nonBous_global/MOM_parameter_doc.all index 81d57cbba1..936160aee9 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.all +++ b/ocean_only/nonBous_global/MOM_parameter_doc.all @@ -456,7 +456,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -1252,29 +1252,81 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" + ! INT_TIDE_PROFILE selects the vertical profile of energy + ! dissipation with INT_TIDE_DISSIPATION. Valid values are: + ! STLAURENT_02 - Use the St. Laurent et al exponential + ! decay profile. + ! POLZIN_09 - Use the Polzin WKB-streched algebraic + ! decay profile. +LEE_WAVE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an lee wave driven dissipation scheme to + ! drive diapycnal mixing, along the lines of Nikurashin + ! (2010) and using the St. Laurent et al. (2002) + ! and Simmons et al. (2004) vertical profile +INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False + ! If true, consider mixing due to breaking low modes that + ! have been remotely generated; as with itidal drag on the + ! barotropic tide, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +MU_ITIDES = 0.2 ! [nondim] default = 0.2 + ! A dimensionless turbulent mixing efficiency used with + ! INT_TIDE_DISSIPATION, often 0.2. +GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 + ! The fraction of the internal tidal energy that is + ! dissipated locally with INT_TIDE_DISSIPATION. + ! THIS NAME COULD BE BETTER. +MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 + ! Turn off internal tidal dissipation when the total + ! ocean depth is less than this value. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +UTIDE = 0.0 ! [m s-1] default = 0.0 + ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" + ! The path to the file containing the spatially varying + ! tidal amplitudes with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1359,9 +1411,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1374,21 +1439,11 @@ HENYEY_N0_2OMEGA = 20.0 ! [nondim] default = 20.0 ! The ratio of the typical Buoyancy frequency to twice ! the Earth's rotation period, used with the Henyey ! scaling from the mixing. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1396,28 +1451,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -INT_TIDE_PROFILE = "STLAURENT_02" ! default = "STLAURENT_02" - ! INT_TIDE_PROFILE selects the vertical profile of energy - ! dissipation with INT_TIDE_DISSIPATION. Valid values are: - ! STLAURENT_02 - Use the St. Laurent et al exponential - ! decay profile. - ! POLZIN_09 - Use the Polzin WKB-streched algebraic - ! decay profile. -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 @@ -1433,38 +1466,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! bound of Kd (a floor): B in eps_min = A + B*N DISSIPATION_KD_MIN = 0.0 ! [m2 s-1] default = 0.0 ! The minimum vertical diffusivity applied as a floor. -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -MU_ITIDES = 0.2 ! [nondim] default = 0.2 - ! A dimensionless turbulent mixing efficiency used with - ! INT_TIDE_DISSIPATION, often 0.2. -GAMMA_ITIDES = 0.3333 ! [nondim] default = 0.3333 - ! The fraction of the internal tidal energy that is - ! dissipated locally with INT_TIDE_DISSIPATION. - ! THIS NAME COULD BE BETTER. -MIN_ZBOT_ITIDES = 0.0 ! [m] default = 0.0 - ! Turn off internal tidal dissipation when the total - ! ocean depth is less than this value. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -UTIDE = 0.0 ! [m s-1] default = 0.0 - ! The constant tidal amplitude used with INT_TIDE_DISSIPATION. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -TIDEAMP_FILE = "tideamp.nc" ! default = "tideamp.nc" - ! The path to the file containing the spatially varying - ! tidal amplitudes with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/nonBous_global/MOM_parameter_doc.short b/ocean_only/nonBous_global/MOM_parameter_doc.short index 2682d762e2..5185dbaf06 100644 --- a/ocean_only/nonBous_global/MOM_parameter_doc.short +++ b/ocean_only/nonBous_global/MOM_parameter_doc.short @@ -230,7 +230,7 @@ TS_CONFIG = "file" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. TS_FILE = "GOLD_IC.2010.11.15.nc" ! ! The initial condition file for temperature. @@ -442,14 +442,35 @@ Z_OUTPUT_GRID_FILE = "OM3_zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +INT_TIDE_DISSIPATION = True ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). +INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 500.0 + ! The decay scale away from the bottom for tidal TKE with + ! the new coding when INT_TIDE_DISSIPATION is used. +KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 + ! A topographic wavenumber used with INT_TIDE_DISSIPATION. + ! The default is 2pi/10 km, as in St.Laurent et al. 2002. +KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 + ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. +TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 + ! The maximum internal tide energy source availble to mix + ! above the bottom boundary layer with INT_TIDE_DISSIPATION. +READ_TIDEAMP = True ! [Boolean] default = False + ! If true, read a file (given by TIDEAMP_FILE) containing + ! the tidal amplitude with INT_TIDE_DISSIPATION. +H2_FILE = "sgs_h2.nc" ! + ! The path to the file containing the sub-grid-scale + ! topographic roughness amplitude with INT_TIDE_DISSIPATION. + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -487,24 +508,19 @@ BBL_MIXING_AS_MAX = False ! [Boolean] default = True ! If true, take the maximum of the diffusivity from the ! BBL mixing and the other diffusivities. Otherwise, ! diffusiviy from the BBL_mixing is simply added. -HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False - ! If true, use a latitude-dependent scaling for the near - ! surface background diffusivity, as described in - ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 0.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, ! may be used. KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 ! The minimum diapycnal diffusivity. -INT_TIDE_DISSIPATION = True ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). +HENYEY_IGW_BACKGROUND = True ! [Boolean] default = False + ! If true, use a latitude-dependent scaling for the near + ! surface background diffusivity, as described in + ! Harrison & Hallberg, JPO 2008. DISSIPATION_N0 = 1.0E-07 ! [W m-3] default = 0.0 ! The intercept when N=0 of the N-dependent expression ! used to set a minimum dissipation by which to determine @@ -513,23 +529,6 @@ DISSIPATION_N1 = 6.0E-04 ! [J m-3] default = 0.0 ! The coefficient multiplying N, following Gargett, used to ! set a minimum dissipation by which to determine a lower ! bound of Kd (a floor): B in eps_min = A + B*N -INT_TIDE_DECAY_SCALE = 300.3003003003003 ! [m] default = 0.0 - ! The decay scale away from the bottom for tidal TKE with - ! the new coding when INT_TIDE_DISSIPATION is used. -KAPPA_ITIDES = 6.28319E-04 ! [m-1] default = 6.283185307179586E-04 - ! A topographic wavenumber used with INT_TIDE_DISSIPATION. - ! The default is 2pi/10 km, as in St.Laurent et al. 2002. -KAPPA_H2_FACTOR = 0.75 ! [nondim] default = 1.0 - ! A scaling factor for the roughness amplitude with nINT_TIDE_DISSIPATION. -TKE_ITIDE_MAX = 0.1 ! [W m-2] default = 1000.0 - ! The maximum internal tide energy source availble to mix - ! above the bottom boundary layer with INT_TIDE_DISSIPATION. -READ_TIDEAMP = True ! [Boolean] default = False - ! If true, read a file (given by TIDEAMP_FILE) containing - ! the tidal amplitude with INT_TIDE_DISSIPATION. -H2_FILE = "sgs_h2.nc" ! - ! The path to the file containing the sub-grid-scale - ! topographic roughness amplitude with INT_TIDE_DISSIPATION. ! === module MOM_kappa_shear === ! Parameterization of shear-driven turbulence following Jackson, Hallberg and Legg, JPO 2008 diff --git a/ocean_only/resting/layer/MOM_parameter_doc.all b/ocean_only/resting/layer/MOM_parameter_doc.all index 125c4604db..c1561fc4ee 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.all +++ b/ocean_only/resting/layer/MOM_parameter_doc.all @@ -450,7 +450,7 @@ TS_CONFIG = "linear" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_TOP = 0.0 ! [degC] ! Initial temperature of the top surface. @@ -1088,29 +1088,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1156,9 +1158,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.1 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.001 ! [m2 s-1] default = 0.001 + ! The minimum diapycnal diffusivity. +KDML = 0.1 ! [m2 s-1] default = 0.1 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1167,21 +1186,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.1 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.001 ! [m2 s-1] default = 0.001 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1189,25 +1198,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.1 ! [m2 s-1] default = 0.1 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/resting/layer/MOM_parameter_doc.short b/ocean_only/resting/layer/MOM_parameter_doc.short index eb5ea54d70..009b9e0c32 100644 --- a/ocean_only/resting/layer/MOM_parameter_doc.short +++ b/ocean_only/resting/layer/MOM_parameter_doc.short @@ -204,7 +204,7 @@ TS_CONFIG = "linear" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_TOP = 0.0 ! [degC] ! Initial temperature of the top surface. @@ -366,14 +366,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -386,6 +386,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.1 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/resting/z/MOM_parameter_doc.all b/ocean_only/resting/z/MOM_parameter_doc.all index 0e29b97928..33b9176ce4 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.all +++ b/ocean_only/resting/z/MOM_parameter_doc.all @@ -548,7 +548,7 @@ TS_CONFIG = "linear" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_TOP = 0.0 ! [degC] ! Initial temperature of the top surface. @@ -1190,29 +1190,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1258,9 +1260,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.1 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.001 ! [m2 s-1] default = 0.001 + ! The minimum diapycnal diffusivity. +KDML = 0.1 ! [m2 s-1] default = 0.1 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1269,21 +1288,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.1 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.001 ! [m2 s-1] default = 0.001 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1291,25 +1300,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.1 ! [m2 s-1] default = 0.1 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/resting/z/MOM_parameter_doc.short b/ocean_only/resting/z/MOM_parameter_doc.short index 4c5d642465..9e7e382230 100644 --- a/ocean_only/resting/z/MOM_parameter_doc.short +++ b/ocean_only/resting/z/MOM_parameter_doc.short @@ -217,7 +217,7 @@ TS_CONFIG = "linear" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. T_TOP = 0.0 ! [degC] ! Initial temperature of the top surface. @@ -379,14 +379,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -399,6 +399,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.1 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.all b/ocean_only/seamount/layer/MOM_parameter_doc.all index f5c7e0091e..0fff579931 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.all +++ b/ocean_only/seamount/layer/MOM_parameter_doc.all @@ -478,7 +478,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. INITIAL_DENSITY_PROFILE = "linear" ! default = "linear" ! Initial profile shape. Valid values are "linear", "parabolic" @@ -1119,29 +1119,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1187,9 +1189,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1198,21 +1217,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1220,25 +1229,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/seamount/layer/MOM_parameter_doc.short b/ocean_only/seamount/layer/MOM_parameter_doc.short index 60d6416366..c6d92f6c9e 100644 --- a/ocean_only/seamount/layer/MOM_parameter_doc.short +++ b/ocean_only/seamount/layer/MOM_parameter_doc.short @@ -216,7 +216,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module MOM_diag_mediator === @@ -381,14 +381,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -401,6 +401,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.all b/ocean_only/seamount/rho/MOM_parameter_doc.all index 571c32d7f4..b7c08040af 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.all +++ b/ocean_only/seamount/rho/MOM_parameter_doc.all @@ -620,7 +620,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. INITIAL_DENSITY_PROFILE = "linear" ! default = "linear" ! Initial profile shape. Valid values are "linear", "parabolic" @@ -1265,29 +1265,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1333,9 +1335,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1344,21 +1363,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1366,25 +1375,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/seamount/rho/MOM_parameter_doc.short b/ocean_only/seamount/rho/MOM_parameter_doc.short index 8a39a58fab..3246314f88 100644 --- a/ocean_only/seamount/rho/MOM_parameter_doc.short +++ b/ocean_only/seamount/rho/MOM_parameter_doc.short @@ -264,7 +264,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module MOM_diag_mediator === @@ -432,14 +432,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -452,6 +452,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.all b/ocean_only/seamount/sigma/MOM_parameter_doc.all index 2da32c13b4..13229ced31 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.all +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.all @@ -574,7 +574,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. INITIAL_DENSITY_PROFILE = "linear" ! default = "linear" ! Initial profile shape. Valid values are "linear", "parabolic" @@ -1219,29 +1219,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1287,9 +1289,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1298,21 +1317,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1320,25 +1329,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/seamount/sigma/MOM_parameter_doc.short b/ocean_only/seamount/sigma/MOM_parameter_doc.short index 47023f8bae..6f7fe4913a 100644 --- a/ocean_only/seamount/sigma/MOM_parameter_doc.short +++ b/ocean_only/seamount/sigma/MOM_parameter_doc.short @@ -240,7 +240,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module MOM_diag_mediator === @@ -405,14 +405,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -425,6 +425,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/seamount/z/MOM_parameter_doc.all b/ocean_only/seamount/z/MOM_parameter_doc.all index debbabe306..2b98c99731 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.all +++ b/ocean_only/seamount/z/MOM_parameter_doc.all @@ -574,7 +574,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. INITIAL_DENSITY_PROFILE = "linear" ! default = "linear" ! Initial profile shape. Valid values are "linear", "parabolic" @@ -1219,29 +1219,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1287,9 +1289,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1298,21 +1317,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1320,25 +1329,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/seamount/z/MOM_parameter_doc.short b/ocean_only/seamount/z/MOM_parameter_doc.short index 041663bb5e..d8fc08c737 100644 --- a/ocean_only/seamount/z/MOM_parameter_doc.short +++ b/ocean_only/seamount/z/MOM_parameter_doc.short @@ -240,7 +240,7 @@ TS_CONFIG = "seamount" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module MOM_diag_mediator === @@ -405,14 +405,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -425,6 +425,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.all b/ocean_only/single_column/BML/MOM_parameter_doc.all index 308807a6bd..0047820ae5 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.all +++ b/ocean_only/single_column/BML/MOM_parameter_doc.all @@ -886,10 +886,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = True ! [Boolean] default = False @@ -944,10 +944,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -968,7 +968,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 1.0E-05 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -976,20 +976,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1060,9 +1062,22 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1071,21 +1086,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1093,21 +1098,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/single_column/BML/MOM_parameter_doc.short b/ocean_only/single_column/BML/MOM_parameter_doc.short index d0acda021d..84c78f8b8d 100644 --- a/ocean_only/single_column/BML/MOM_parameter_doc.short +++ b/ocean_only/single_column/BML/MOM_parameter_doc.short @@ -278,24 +278,21 @@ Z_OUTPUT_GRID_FILE = "../zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = True ! [Boolean] default = False ! If True, puts KPP into a passive-diagnostic mode. -CVMIX_ZERO_H_WORK_AROUND = 1.0E-05 ! [m] default = 0.0 - ! A minimum thickness used to avoid division by small numbers in the vicinity - ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -317,6 +314,9 @@ ML_OMEGA_FRAC = 1.0 ! [nondim] default = 0.0 ! When setting the decay scale for turbulence, use this ! fraction of the absolute rotation rate blended with the ! local value of f, as sqrt((1-of)*f^2 + of*4*omega^2). + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.all b/ocean_only/single_column/EPBL/MOM_parameter_doc.all index 044ba58c2e..1349cf6c42 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.all +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.all @@ -981,10 +981,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = True ! [Boolean] default = False @@ -1039,10 +1039,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "CVMIX" ! default = "CVMIX" +NLT_SHAPE = "CVMix" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1063,7 +1063,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1071,20 +1071,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1155,9 +1157,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1166,21 +1185,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1188,25 +1197,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/single_column/EPBL/MOM_parameter_doc.short b/ocean_only/single_column/EPBL/MOM_parameter_doc.short index bb60bbc780..5dca8ce10a 100644 --- a/ocean_only/single_column/EPBL/MOM_parameter_doc.short +++ b/ocean_only/single_column/EPBL/MOM_parameter_doc.short @@ -321,21 +321,21 @@ ENERGETICS_SFC_PBL = True ! [Boolean] default = False ! in the surface boundary layer. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = True ! [Boolean] default = False ! If True, puts KPP into a passive-diagnostic mode. %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -357,6 +357,9 @@ ML_OMEGA_FRAC = 1.0 ! [nondim] default = 0.0 ! When setting the decay scale for turbulence, use this ! fraction of the absolute rotation rate blended with the ! local value of f, as sqrt((1-of)*f^2 + of*4*omega^2). + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.all b/ocean_only/single_column/KPP/MOM_parameter_doc.all index 6a875ce23d..e488be30c8 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.all +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.all @@ -981,10 +981,10 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% PASSIVE = False ! [Boolean] default = False @@ -1039,10 +1039,10 @@ FIRST_GUESS_SURFACE_LAYER_DEPTH = 0.0 ! [m] default = 0.0 ! the surface layer properties. If =0, the top model level properties ! will be used for the surface layer. If CORRECT_SURFACE_LAYER_AVERAGE=True, a ! subsequent correction is applied. This parameter is obsolete -NLT_SHAPE = "PARABOLIC" ! default = "CVMIX" +NLT_SHAPE = "PARABOLIC" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) @@ -1063,7 +1063,7 @@ KPP_SHORTWAVE_METHOD = "MXL_SW" ! default = "MXL_SW" ! ALL_SW: use total shortwave radiation ! MXL_SW: use shortwave radiation absorbed by mixing layer ! LV1_SW: use shortwave radiation absorbed by top model layer -CVMIX_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 +CVMix_ZERO_H_WORK_AROUND = 0.0 ! [m] default = 0.0 ! A minimum thickness used to avoid division by small numbers in the vicinity ! of vanished layers. This is independent of MIN_THICKNESS used in other parts of MOM. %KPP @@ -1071,20 +1071,22 @@ SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = True ! [Boolean] default = True @@ -1155,9 +1157,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 2.0E-05 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 + ! The minimum diapycnal diffusivity. +KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1166,21 +1185,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 2.0E-05 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 2.0E-06 ! [m2 s-1] default = 2.0E-07 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1188,25 +1197,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 2.0E-05 ! [m2 s-1] default = 2.0E-05 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/single_column/KPP/MOM_parameter_doc.short b/ocean_only/single_column/KPP/MOM_parameter_doc.short index 5ab117d581..2c95a2a2a6 100644 --- a/ocean_only/single_column/KPP/MOM_parameter_doc.short +++ b/ocean_only/single_column/KPP/MOM_parameter_doc.short @@ -317,27 +317,27 @@ Z_OUTPUT_GRID_FILE = "../zgrid.nc" ! default = "" ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = True ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. KPP% -NLT_SHAPE = "PARABOLIC" ! default = "CVMIX" +NLT_SHAPE = "PARABOLIC" ! default = "CVMix" ! MOM6 method to set nonlocal transport profile. ! Over-rides the result from CVMix. Allowed values are: - ! CVMIX - Uses the profiles from CVmix specified by MATCH_TECHNIQUE + ! CVMix - Uses the profiles from CVMix specified by MATCH_TECHNIQUE ! LINEAR - A linear profile, 1-sigma ! PARABOLIC - A parablic profile, (1-sigma)^2 ! CUBIC - A cubic profile, (1-sigma)^2(1+2*sigma) ! CUBIC_LMD - The original KPP profile %KPP -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === MAX_ENT_IT = 20 ! default = 5 @@ -359,6 +359,9 @@ ML_OMEGA_FRAC = 1.0 ! [nondim] default = 0.0 ! When setting the decay scale for turbulence, use this ! fraction of the absolute rotation rate blended with the ! local value of f, as sqrt((1-of)*f^2 + of*4*omega^2). + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 2.0E-05 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.all b/ocean_only/sloshing/layer/MOM_parameter_doc.all index c5edb886d4..0ef3fcb650 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.all +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.all @@ -453,7 +453,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -1094,29 +1094,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1162,9 +1164,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1173,21 +1192,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1195,25 +1204,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/sloshing/layer/MOM_parameter_doc.short b/ocean_only/sloshing/layer/MOM_parameter_doc.short index d043371c6f..0d39434e11 100644 --- a/ocean_only/sloshing/layer/MOM_parameter_doc.short +++ b/ocean_only/sloshing/layer/MOM_parameter_doc.short @@ -207,7 +207,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -375,14 +375,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -395,6 +395,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.all b/ocean_only/sloshing/rho/MOM_parameter_doc.all index 4dbda13bab..06abc05dcc 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.all +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.all @@ -597,7 +597,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -1242,29 +1242,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1310,9 +1312,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1321,21 +1340,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1343,25 +1352,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/sloshing/rho/MOM_parameter_doc.short b/ocean_only/sloshing/rho/MOM_parameter_doc.short index d977f1d137..fc8e47b35c 100644 --- a/ocean_only/sloshing/rho/MOM_parameter_doc.short +++ b/ocean_only/sloshing/rho/MOM_parameter_doc.short @@ -254,7 +254,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -422,14 +422,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -442,6 +442,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.all b/ocean_only/sloshing/z/MOM_parameter_doc.all index 3a77efaa5f..28ac0774b3 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.all +++ b/ocean_only/sloshing/z/MOM_parameter_doc.all @@ -551,7 +551,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -1196,29 +1196,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1264,9 +1266,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1275,21 +1294,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1297,25 +1306,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/sloshing/z/MOM_parameter_doc.short b/ocean_only/sloshing/z/MOM_parameter_doc.short index ebe5ed1459..55908a78de 100644 --- a/ocean_only/sloshing/z/MOM_parameter_doc.short +++ b/ocean_only/sloshing/z/MOM_parameter_doc.short @@ -230,7 +230,7 @@ TS_CONFIG = "sloshing" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. S_REF = 34.0 ! [1e-3] ! Reference value for salinity @@ -398,14 +398,14 @@ KHTH = 500.0 ! [m2 s-1] default = 0.0 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -418,6 +418,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.all b/ocean_only/torus_advection_test/MOM_parameter_doc.all index fd47aded08..ba828982fe 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.all +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.all @@ -473,7 +473,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. FIT_SALINITY = False ! [Boolean] default = False ! If true, accept the prescribed temperature and fit the @@ -1093,29 +1093,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1144,9 +1146,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1155,21 +1174,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1177,25 +1186,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/torus_advection_test/MOM_parameter_doc.short b/ocean_only/torus_advection_test/MOM_parameter_doc.short index 8ec97bd5d4..15b3e1d4d5 100644 --- a/ocean_only/torus_advection_test/MOM_parameter_doc.short +++ b/ocean_only/torus_advection_test/MOM_parameter_doc.short @@ -223,7 +223,7 @@ TS_CONFIG = "fit" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. VELOCITY_CONFIG = "uniform" ! default = "zero" ! A string that determines how the initial velocities @@ -371,14 +371,14 @@ DTBT = -0.9 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -392,6 +392,9 @@ TOLERANCE_ENT = 1.0E-05 ! [m] default = 0.0 ! The tolerance with which to solve for entrainment values. ! === module MOM_set_diffusivity === + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all index ea2904e209..795bdae4cf 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.all @@ -594,7 +594,7 @@ TS_CONFIG = "baroclinic_zone" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module baroclinic_zone_initialization === @@ -1254,29 +1254,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1322,9 +1324,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1333,21 +1352,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1355,25 +1364,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.short b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.short index e23fbacc53..1b89c21a3f 100644 --- a/ocean_only/tracer_mixing/rho/MOM_parameter_doc.short +++ b/ocean_only/tracer_mixing/rho/MOM_parameter_doc.short @@ -268,7 +268,7 @@ TS_CONFIG = "baroclinic_zone" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module baroclinic_zone_initialization === @@ -431,14 +431,14 @@ DTBT = 5.0 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -451,6 +451,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all index bdd5f00227..0a23a3dce8 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.all +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.all @@ -548,7 +548,7 @@ TS_CONFIG = "baroclinic_zone" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module baroclinic_zone_initialization === @@ -1208,29 +1208,31 @@ DIAG_MLD_DENSITY_DIFF = 0.1 ! [kg/m3] default = 0.1 ! surface density by the specified amount. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ USE_KPP = False ! [Boolean] default = False - ! If true, turns on the [CVmix] KPP scheme of Large et al., 1994, + ! If true, turns on the [CVMix] KPP scheme of Large et al., 1994, ! to calculate diffusivities and non-local transport in the OBL. SALT_REJECT_BELOW_ML = False ! [Boolean] default = False ! If true, place salt from brine rejection below the mixed layer, ! into the first non-vanished layer for which the column remains stable -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -USE_CONVECTION = False ! [Boolean] default = False - ! If true, turns on the diffusive convection scheme that - ! increases diapycnal diffusivities at statically unstable - ! interfaces. Relevant parameters are contained in the - ! CONVECTION% parameter block. -CONVECTION% -PASSIVE = False ! [Boolean] default = False - ! If True, puts KPP into a passive-diagnostic mode. -KD_CONV = 1.0 ! [m2/s] default = 1.0 - ! DIffusivity used in statically unstable regions of column. -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization +USE_CVMix_TIDAL = False ! [Boolean] default = False + ! If true, turns on tidal mixing via CVMix +INT_TIDE_DISSIPATION = False ! [Boolean] default = False + ! If true, use an internal tidal dissipation scheme to + ! drive diapycnal mixing, along the lines of St. Laurent + ! et al. (2002) and Simmons et al. (2004). + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix +USE_CVMix_CONVECTION = False ! [Boolean] default = False + ! If true, turns on the enhanced mixing due to convection + ! via CVMix. This scheme increases diapycnal diffs./viscs. + ! at statically unstable interfaces. Relevant parameters are + ! contained in the CVMix_CONVECTION% parameter block. ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -1276,9 +1278,26 @@ SIMPLE_TKE_TO_KD = False ! [Boolean] default = False ! If true, uses a simple estimate of Kd/TKE that will ! work for arbitrary vertical coordinates. If false, ! calculates Kd/TKE and bounds based on exact energetics/nfor an isopycnal layer-formulation. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients +KD = 0.0 ! [m2 s-1] + ! The background diapycnal diffusivity of density in the + ! interior. Zero or the molecular value, ~1e-7 m2 s-1, + ! may be used. +KD_MIN = 0.0 ! [m2 s-1] default = 0.0 + ! The minimum diapycnal diffusivity. +KDML = 0.0 ! [m2 s-1] default = 0.0 + ! If BULKMIXEDLAYER is false, KDML is the elevated + ! diapycnal diffusivity in the topmost HMIX of fluid. + ! KDML is only used if BULKMIXEDLAYER is false. +PRANDTL_BKGND = 1.0 ! [nondim] default = 1.0 + ! Turbulent Prandtl number used to convert vertical + ! background diffusivities into viscosities. BRYAN_LEWIS_DIFFUSIVITY = False ! [Boolean] default = False ! If true, use a Bryan & Lewis (JGR 1979) like tanh ! profile of background diapycnal diffusivity with depth. + ! This is done via CVMix. HENYEY_IGW_BACKGROUND = False ! [Boolean] default = False ! If true, use a latitude-dependent scaling for the near ! surface background diffusivity, as described in @@ -1287,21 +1306,11 @@ HENYEY_IGW_BACKGROUND_NEW = False ! [Boolean] default = False ! If true, use a better latitude-dependent scaling for the ! background diffusivity, as described in ! Harrison & Hallberg, JPO 2008. -N2_FLOOR_IOMEGA2 = 1.0 ! [nondim] default = 1.0 - ! The floor applied to N2(k) scaled by Omega^2: - ! If =0., N2(k) is simply positive definite. - ! If =1., N2(k) > Omega^2 everywhere. KD_TANH_LAT_FN = False ! [Boolean] default = False ! If true, use a tanh dependence of Kd_sfc on latitude, ! like CM2.1/CM2M. There is no physical justification ! for this form, and it can not be used with ! HENYEY_IGW_BACKGROUND. -KD = 0.0 ! [m2 s-1] - ! The background diapycnal diffusivity of density in the - ! interior. Zero or the molecular value, ~1e-7 m2 s-1, - ! may be used. -KD_MIN = 0.0 ! [m2 s-1] default = 0.0 - ! The minimum diapycnal diffusivity. KD_MAX = -1.0 ! [m2 s-1] default = -1.0 ! The maximum permitted increment for the diapycnal ! diffusivity from TKE-based parameterizations, or a @@ -1309,25 +1318,6 @@ KD_MAX = -1.0 ! [m2 s-1] default = -1.0 KD_ADD = 0.0 ! [m2 s-1] default = 0.0 ! A uniform diapycnal diffusivity that is added ! everywhere without any filtering or scaling. -KDML = 0.0 ! [m2 s-1] default = 0.0 - ! If BULKMIXEDLAYER is false, KDML is the elevated - ! diapycnal diffusivity in the topmost HMIX of fluid. - ! KDML is only used if BULKMIXEDLAYER is false. -INT_TIDE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). -LEE_WAVE_DISSIPATION = False ! [Boolean] default = False - ! If true, use an lee wave driven dissipation scheme to - ! drive diapycnal mixing, along the lines of Nikurashin - ! (2010) and using the St. Laurent et al. (2002) - ! and Simmons et al. (2004) vertical profile -INT_TIDE_LOWMODE_DISSIPATION = False ! [Boolean] default = False - ! If true, consider mixing due to breaking low modes that - ! have been remotely generated; as with itidal drag on the - ! barotropic tide, use an internal tidal dissipation scheme to - ! drive diapycnal mixing, along the lines of St. Laurent - ! et al. (2002) and Simmons et al. (2004). USER_CHANGE_DIFFUSIVITY = False ! [Boolean] default = False ! If true, call user-defined code to change the diffusivity. DISSIPATION_MIN = 0.0 ! [W m-3] default = 0.0 diff --git a/ocean_only/tracer_mixing/z/MOM_parameter_doc.short b/ocean_only/tracer_mixing/z/MOM_parameter_doc.short index 7db5163a67..63dcb3ea5c 100644 --- a/ocean_only/tracer_mixing/z/MOM_parameter_doc.short +++ b/ocean_only/tracer_mixing/z/MOM_parameter_doc.short @@ -244,7 +244,7 @@ TS_CONFIG = "baroclinic_zone" ! ! dumbbell - sloshing channel ICs. ! rossby_front - a mixed layer front in thermal wind balance. ! SCM_ideal_hurr - used in the SCM idealized hurricane test. - ! SCM_CVmix_tests - used in the SCM CVmix tests. + ! SCM_CVMix_tests - used in the SCM CVMix tests. ! USER - call a user modified routine. ! === module baroclinic_zone_initialization === @@ -407,14 +407,14 @@ DTBT = 5.0 ! [s or nondim] default = -0.98 ! The following parameters are used for diabatic processes. ! === module MOM_KPP === -! This is the MOM wrapper to CVmix:KPP -! See http://code.google.com/p/cvmix/ +! This is the MOM wrapper to CVMix:KPP +! See http://cvmix.github.io/ -! === module MOM_diffConvection === -! This module implements enhanced diffusivity as a -! function of static stability, N^2. -CONVECTION% -%CONVECTION +! === module MOM_tidal_mixing === +! Vertical Tidal Mixing Parameterization + +! === module MOM_CVMix_conv === +! Parameterization of enhanced mixing due to convection via CVMix ! === module MOM_entrain_diffusive === CORRECT_DENSITY = False ! [Boolean] default = True @@ -427,6 +427,9 @@ BBL_EFFIC = 0.0 ! [nondim] default = 0.2 ! The efficiency with which the energy extracted by ! bottom drag drives BBL diffusion. This is only ! used if BOTTOMDRAGLAW is true. + +! === module MOM_bkgnd_mixing === +! Adding static vertical background mixing coefficients KD = 0.0 ! [m2 s-1] ! The background diapycnal diffusivity of density in the ! interior. Zero or the molecular value, ~1e-7 m2 s-1, diff --git a/src/MOM6 b/src/MOM6 index a1eac58130..77a97ba8b0 160000 --- a/src/MOM6 +++ b/src/MOM6 @@ -1 +1 @@ -Subproject commit a1eac581308e018b536fa06ca9db17023bd3e9b3 +Subproject commit 77a97ba8b0ef434a316a186d54f545ac7f187692