Skip to content

Commit

Permalink
*Eliminate CORRECT_DENSITY from MOM_input files
Browse files Browse the repository at this point in the history
  Removed lines setting CORRECT_DENSITY in all MOM_input files, which is the
same as setting CORRECT_DENSITY=True in cases that use MOM_entrain_diffusive,
and is eliminating an unused parameter in other cases.  This changes answers
in only one experiment, resting/layer, which uses CORRECT_DENSITY=False with
a non-zero value of Kd.  The MOM_parameter_doc files are changed in 7 other
examples, but the answers do not change.
  • Loading branch information
Hallberg-NOAA committed May 21, 2020
1 parent f695d2c commit 5c9f52b
Show file tree
Hide file tree
Showing 34 changed files with 9 additions and 102 deletions.
3 changes: 0 additions & 3 deletions ice_ocean_SIS/Amery/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -408,9 +408,6 @@ RHO_0 = 1035.0 ! RHO_0 is used in the Boussinesq
! pressure gradients, in units of kg m-3.
C_P = 3925.0 ! C_P is the heat capacity of sea water in
! J kg-1 K-1, approximated as a constant.
CORRECT_DENSITY = True ! If CORRECT_DENSITY is defined, the layer
! densities are restored toward their target
! values by the diapycnal mixing.

! Specify the properties of the surface forcing.
WIND_STAGGER = "B" ! "A", "B", or "C" to indicate the
Expand Down
3 changes: 0 additions & 3 deletions ice_ocean_SIS/GIS_0125/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -405,9 +405,6 @@ RHO_0 = 1035.0 ! RHO_0 is used in the Boussinesq
! pressure gradients, in units of kg m-3.
C_P = 3925.0 ! C_P is the heat capacity of sea water in
! J kg-1 K-1, approximated as a constant.
CORRECT_DENSITY = True ! If CORRECT_DENSITY is defined, the layer
! densities are restored toward their target
! values by the diapycnal mixing.

! Specify the properties of the surface forcing.
WIND_STAGGER = "B" ! "A", "B", or "C" to indicate the
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/ISOMIP/layer/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -497,10 +497,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to
! calculate the interior diapycnal entrainment.
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/ISOMIP/rho/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -590,10 +590,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to
! calculate the interior diapycnal entrainment.
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/MESO_025_23L/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -424,9 +424,6 @@ RHO_0 = 1035.0 ! RHO_0 is used in the Boussinesq
! pressure gradients, in units of kg m-3.
C_P = 3925.0 ! C_P is the heat capacity of sea water in
! J kg-1 K-1, approximated as a constant.
CORRECT_DENSITY = True ! If CORRECT_DENSITY is defined, the layer
! densities are restored toward their target
! values by the diapycnal mixing.

! Specify the properties of the passive tracers.
KHTR = 0.0 ! KHTR is the along-isopycnal tracer
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/adjustment2d/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -401,10 +401,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
2 changes: 1 addition & 1 deletion ocean_only/adjustment2d/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 5 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/adjustment2d/layer/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -362,9 +362,6 @@ DTBT = 5.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).

! === module MOM_set_diffusivity ===
BBL_EFFIC = 0.0 ! [nondim] default = 0.2
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/external_gwave/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to
! calculate the interior diapycnal entrainment.
Expand Down
2 changes: 1 addition & 1 deletion ocean_only/external_gwave/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1083,7 +1083,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/external_gwave/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,6 @@ DTBT = 20.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to calculate the interior
! diapycnal entrainment.
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/flow_downslope/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -394,10 +394,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
2 changes: 1 addition & 1 deletion ocean_only/flow_downslope/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1090,7 +1090,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 5 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/flow_downslope/layer/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -359,9 +359,6 @@ DTBT = 20.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).

! === module MOM_set_diffusivity ===

Expand Down
4 changes: 0 additions & 4 deletions ocean_only/lock_exchange/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -377,10 +377,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to
! calculate the interior diapycnal entrainment.
Expand Down
2 changes: 1 addition & 1 deletion ocean_only/lock_exchange/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1086,7 +1086,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/lock_exchange/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -329,9 +329,6 @@ DTBT = 25.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to calculate the interior
! diapycnal entrainment.
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/mixed_layer_restrat_2d/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -416,10 +416,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
4 changes: 0 additions & 4 deletions ocean_only/resting/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -378,10 +378,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
2 changes: 1 addition & 1 deletion ocean_only/resting/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1079,7 +1079,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 5 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/resting/layer/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -337,9 +337,6 @@ DTBT = 60.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).

! === module MOM_set_diffusivity ===
BBL_EFFIC = 0.0 ! [nondim] default = 0.2
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/rotating_gravity_current/Layersetup_2D/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -462,10 +462,6 @@ KD = 1.0E-5 ! [m2 s-1]
! may be used.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_tracer_hor_diff ===
KHTR = 1.0E-4 ! [m2 s-1] default = 0.0
Expand Down
5 changes: 0 additions & 5 deletions ocean_only/rotating_gravity_current/Layersetup_3D/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -463,11 +463,6 @@ KD = 1.0E-5 ! [m2 s-1]
! interior. Zero or the molecular value, ~1e-7 m2 s-1,
! may be used.
! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).


! === module MOM_tracer_hor_diff ===
KHTR = 1.0E-4 ! [m2 s-1] default = 0.0
Expand Down
5 changes: 1 addition & 4 deletions ocean_only/rotating_gravity_current/Zsetup_2D/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -439,10 +439,7 @@ KD = 1.0E-5 ! [m2 s-1]
! may be used.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_tracer_hor_diff ===
KHTR = 1.0E-4 ! [m2 s-1] default = 0.0
! The background along-isopycnal tracer diffusivity.
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/seamount/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -402,10 +402,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
2 changes: 1 addition & 1 deletion ocean_only/seamount/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1112,7 +1112,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 5 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/seamount/layer/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,6 @@ DTBT = 10.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).

! === module MOM_set_diffusivity ===
BBL_EFFIC = 0.0 ! [nondim] default = 0.2
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/sloshing/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -387,10 +387,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down
2 changes: 1 addition & 1 deletion ocean_only/sloshing/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 5 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/sloshing/layer/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,6 @@ DTBT = 10.0 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).

! === module MOM_set_diffusivity ===
BBL_EFFIC = 0.0 ! [nondim] default = 0.2
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/torus_advection_test/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -394,10 +394,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to
! calculate the interior diapycnal entrainment.
Expand Down
2 changes: 1 addition & 1 deletion ocean_only/torus_advection_test/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1085,7 +1085,7 @@ USE_CVMix_CONVECTION = False ! [Boolean] default = False
! parameters are contained in the CVMix_CONVECTION% parameter block.

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
CORRECT_DENSITY = True ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
Expand Down
3 changes: 0 additions & 3 deletions ocean_only/torus_advection_test/MOM_parameter_doc.short
Original file line number Diff line number Diff line change
Expand Up @@ -345,9 +345,6 @@ DTBT = -0.9 ! [s or nondim] default = -0.98
! Parameterization of enhanced mixing due to convection via CVMix

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are restored toward their
! target values by the diapycnal mixing, as described in Hallberg (MWR, 2000).
MAX_ENT_IT = 20 ! default = 5
! The maximum number of iterations that may be used to calculate the interior
! diapycnal entrainment.
Expand Down
4 changes: 0 additions & 4 deletions ocean_only/tracer_mixing/common/MOM_input
Original file line number Diff line number Diff line change
Expand Up @@ -409,10 +409,6 @@ CONVECTION%
%CONVECTION

! === module MOM_entrain_diffusive ===
CORRECT_DENSITY = False ! [Boolean] default = True
! If true, and USE_EOS is true, the layer densities are
! restored toward their target values by the diapycnal
! mixing, as described in Hallberg (MWR, 2000).

! === module MOM_regularize_layers ===

Expand Down

0 comments on commit 5c9f52b

Please sign in to comment.