Skip to content

Commit

Permalink
MOM6: Refactor Love_scaling calculation in SAL module
Browse files Browse the repository at this point in the history
- NOAA-GFDL/MOM6@8e0b83cda Refactor Love_scaling calculation in SAL module
- NOAA-GFDL/MOM6@73a625df7 Add answer date flag for tide/SAL
- NOAA-GFDL/MOM6@36f763c4f Remove rescaling bottom pressure in SAL
- NOAA-GFDL/MOM6@8039c3365 Alternative method for SAL and tides in Boussinesq
- NOAA-GFDL/MOM6@402949e6f Rename variables with tides in Pressure Force
- NOAA-GFDL/MOM6@89fec6e7f Add option for SAL to use bottom pressure anomaly
- NOAA-GFDL/MOM6@10d9523e1 Refactor SAL in MOM_PressureForce_FV
  • Loading branch information
mom6bot committed Jan 14, 2025
1 parent 7ba98f8 commit b706dd0
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 16 deletions.
19 changes: 16 additions & 3 deletions ice_ocean_SIS2/Baltic_ALE_z_offline_tracers/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,10 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_USE_BPA = False ! [Boolean] default = False
! If true, use bottom pressure anomaly to calculate self-attraction and loading
! (SAL). Otherwise sea surface height anomaly is used, which is only correct for
! homogenous flow.
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
Expand Down Expand Up @@ -1319,9 +1323,18 @@ RHO_PGF_REF = 1035.0 ! [kg m-3] default = 1035.0
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
! calculations. Setting dates before 20230701 recovers old answers (Boussinesq
! and non-Boussinesq modes) when SAL is part of the tidal forcing calculation.
! The answer difference is only at bit level and due to a reordered summation.
! Setting dates before 20250201 recovers answers (Boussinesq mode) that
! interface heights are modified before pressure force integrals are calculated.
BOUSSINESQ_SAL_TIDES = False ! [Boolean] default = False
! If true, in Boussinesq mode, use an alternative method to include
! self-attraction and loading (SAL) and tidal forcings in pressure gradient, in
! which their gradients are calculated separately, instead of adding
! geopotential anomalies as corrections to the interface height. This
! alternative method elimates a baroclinic component of the SAL and tidal
! forcings.
SSH_IN_EOS_PRESSURE_FOR_PGF = False ! [Boolean] default = False
! If true, include contributions from the sea surface height in the height-based
! pressure used in the equation of state calculations for the Boussinesq
Expand Down
19 changes: 16 additions & 3 deletions ocean_only/global_ALE/hycom/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1274,6 +1274,10 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_USE_BPA = False ! [Boolean] default = False
! If true, use bottom pressure anomaly to calculate self-attraction and loading
! (SAL). Otherwise sea surface height anomaly is used, which is only correct for
! homogenous flow.
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
Expand Down Expand Up @@ -1369,9 +1373,18 @@ RHO_PGF_REF = 1035.0 ! [kg m-3] default = 1035.0
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
! calculations. Setting dates before 20230701 recovers old answers (Boussinesq
! and non-Boussinesq modes) when SAL is part of the tidal forcing calculation.
! The answer difference is only at bit level and due to a reordered summation.
! Setting dates before 20250201 recovers answers (Boussinesq mode) that
! interface heights are modified before pressure force integrals are calculated.
BOUSSINESQ_SAL_TIDES = False ! [Boolean] default = False
! If true, in Boussinesq mode, use an alternative method to include
! self-attraction and loading (SAL) and tidal forcings in pressure gradient, in
! which their gradients are calculated separately, instead of adding
! geopotential anomalies as corrections to the interface height. This
! alternative method elimates a baroclinic component of the SAL and tidal
! forcings.
SSH_IN_EOS_PRESSURE_FOR_PGF = False ! [Boolean] default = False
! If true, include contributions from the sea surface height in the height-based
! pressure used in the equation of state calculations for the Boussinesq
Expand Down
19 changes: 16 additions & 3 deletions ocean_only/global_ALE/layer/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1158,6 +1158,10 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_USE_BPA = False ! [Boolean] default = False
! If true, use bottom pressure anomaly to calculate self-attraction and loading
! (SAL). Otherwise sea surface height anomaly is used, which is only correct for
! homogenous flow.
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
Expand Down Expand Up @@ -1253,9 +1257,18 @@ RHO_PGF_REF = 1035.0 ! [kg m-3] default = 1035.0
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
! calculations. Setting dates before 20230701 recovers old answers (Boussinesq
! and non-Boussinesq modes) when SAL is part of the tidal forcing calculation.
! The answer difference is only at bit level and due to a reordered summation.
! Setting dates before 20250201 recovers answers (Boussinesq mode) that
! interface heights are modified before pressure force integrals are calculated.
BOUSSINESQ_SAL_TIDES = False ! [Boolean] default = False
! If true, in Boussinesq mode, use an alternative method to include
! self-attraction and loading (SAL) and tidal forcings in pressure gradient, in
! which their gradients are calculated separately, instead of adding
! geopotential anomalies as corrections to the interface height. This
! alternative method elimates a baroclinic component of the SAL and tidal
! forcings.
SSH_IN_EOS_PRESSURE_FOR_PGF = False ! [Boolean] default = False
! If true, include contributions from the sea surface height in the height-based
! pressure used in the equation of state calculations for the Boussinesq
Expand Down
19 changes: 16 additions & 3 deletions ocean_only/global_ALE/z/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -1221,6 +1221,10 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_USE_BPA = False ! [Boolean] default = False
! If true, use bottom pressure anomaly to calculate self-attraction and loading
! (SAL). Otherwise sea surface height anomaly is used, which is only correct for
! homogenous flow.
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
Expand Down Expand Up @@ -1316,9 +1320,18 @@ RHO_PGF_REF = 1035.0 ! [kg m-3] default = 1035.0
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
! calculations. Setting dates before 20230701 recovers old answers (Boussinesq
! and non-Boussinesq modes) when SAL is part of the tidal forcing calculation.
! The answer difference is only at bit level and due to a reordered summation.
! Setting dates before 20250201 recovers answers (Boussinesq mode) that
! interface heights are modified before pressure force integrals are calculated.
BOUSSINESQ_SAL_TIDES = False ! [Boolean] default = False
! If true, in Boussinesq mode, use an alternative method to include
! self-attraction and loading (SAL) and tidal forcings in pressure gradient, in
! which their gradients are calculated separately, instead of adding
! geopotential anomalies as corrections to the interface height. This
! alternative method elimates a baroclinic component of the SAL and tidal
! forcings.
SSH_IN_EOS_PRESSURE_FOR_PGF = False ! [Boolean] default = False
! If true, include contributions from the sea surface height in the height-based
! pressure used in the equation of state calculations for the Boussinesq
Expand Down
12 changes: 9 additions & 3 deletions ocean_only/nonBous_global/MOM_parameter_doc.all
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,10 @@ PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_UPWIND1 - upwind, first order

! === module MOM_self_attr_load ===
SAL_USE_BPA = False ! [Boolean] default = False
! If true, use bottom pressure anomaly to calculate self-attraction and loading
! (SAL). Otherwise sea surface height anomaly is used, which is only correct for
! homogenous flow.
SAL_SCALAR_APPROX = True ! [Boolean] default = True
! If true, use the scalar approximation to calculate self-attraction and
! loading.
Expand Down Expand Up @@ -1083,9 +1087,11 @@ RHO_PGF_REF = 1024.0 ! [kg m-3] default = 1024.0
! non-Boussinesq mode. The default is RHO_0.
TIDES_ANSWER_DATE = 20230630 ! default = 20230630
! The vintage of self-attraction and loading (SAL) and tidal forcing
! calculations in Boussinesq mode. Values below 20230701 recover the old answers
! in which the SAL is part of the tidal forcing calculation. The change is due
! to a reordered summation and the difference is only at bit level.
! calculations. Setting dates before 20230701 recovers old answers (Boussinesq
! and non-Boussinesq modes) when SAL is part of the tidal forcing calculation.
! The answer difference is only at bit level and due to a reordered summation.
! Setting dates before 20250201 recovers answers (Boussinesq mode) that
! interface heights are modified before pressure force integrals are calculated.
MASS_WEIGHT_IN_PRESSURE_GRADIENT = False ! [Boolean] default = False
! If true, use mass weighting when interpolating T/S for integrals near the
! bathymetry in FV pressure gradient calculations.
Expand Down

0 comments on commit b706dd0

Please sign in to comment.