Skip to content

UNST-9814: Rename SecchiDepth2 and SecchiDepth2Fraction keywords, add documentation #809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomas-pijls merged 8 commits into from
Apr 22, 2026
Merged

UNST-9814: Rename SecchiDepth2 and SecchiDepth2Fraction keywords, add documentation #809

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0f83f8
UNST-9814: Renamed SecchiDepth2 to SecchiDepthNonPenetrative and set …
thomas-pijls Apr 15, 2026
78533b5
UNST-9814: Renamed DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR to POOL_ATK…
thomas-pijls Apr 15, 2026
890024c
UNST-9814: Renamed POOL_ATKINS_PARAMETER to POOLE_ATKINS_PARAMETER
thomas-pijls Apr 20, 2026
d149f90
Merge branch 'main' into all/task/UNST-9814_rename_secchidepth2
thomas-pijls Apr 20, 2026
6e31ef3
UNST-9814: Fixed merge conflicts
thomas-pijls Apr 20, 2026
adb7f75
UNST-9814: Fixed build errors
thomas-pijls Apr 20, 2026
24c5617
Merge branch 'main' into all/task/UNST-9814_rename_secchidepth2
thomas-pijls Apr 21, 2026
eba1510
Merge branch 'main' into all/task/UNST-9814_rename_secchidepth2
thomas-pijls Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/fm_deprecated_keywords.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ subroutine default_fm_deprecated_keywords()
call add_deprecated_keyword(deprecated_mdu_keywords, 'Numerics', 'Vertadvtypsal', DEPRECATED, 'Use verticalAdvectionType instead.')
call add_deprecated_keyword(deprecated_mdu_keywords, 'Numerics', 'Vertadvtyptem', DEPRECATED, 'Use verticalAdvectionType instead.')
call add_deprecated_keyword(deprecated_mdu_keywords, 'Physics', 'Jadelvappos', DEPRECATED)
call add_deprecated_keyword(deprecated_mdu_keywords, 'Physics', 'SecchiDepth2', DEPRECATED, 'Use SecchiDepthNonPenetrative instead.')
call add_deprecated_keyword(deprecated_mdu_keywords, 'Physics', 'SecchiDepth2Fraction', DEPRECATED, 'Use SecchiDepthNonPenetrativeFraction instead.')
call add_deprecated_keyword(deprecated_mdu_keywords, 'Processes', 'ThetaVertical', DEPRECATED, 'Use VerticalAdvectionType instead.')
call add_deprecated_keyword(deprecated_mdu_keywords, 'Processes', 'dtMassBalance', DEPRECATED)
call add_deprecated_keyword(deprecated_mdu_keywords, 'Lateral', 'type', DEPRECATED, 'Use [Lateral] locationType instead.')
Expand Down
6 changes: 3 additions & 3 deletions src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/m_physcoef.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ module m_physcoef
real(kind=dp), dimension(2) :: secchi_depth !< [m] Constant Secchi depth; 1 = visible light and UV radiation, 2 = infrared radiation
real(kind=dp), dimension(2) :: secchi_radiation_fraction !< [-] Radiation fraction in (1) visible light and UV radiation, (2) infrared radiation used in Secchi computation
real(kind=dp), dimension(2) :: diffuse_attenuation_coefficient !< [m] Diffuse attenuation coefficient for radiation
real(kind=dp), parameter :: DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR = 1.7_dp !< factor to compute diffuse attenuation coefficient from secchi depth
real(kind=dp), parameter :: POOL_ATKINS_PARAMETER = 1.7_dp !< [-] Parameter for conversion of Secchi depth to diffuse attenuation coefficient

integer :: limiterhordif !< 0=No, 1=Horizontal gradient densitylimiter, 2=Finite volume

Expand Down Expand Up @@ -154,8 +154,8 @@ subroutine default_physcoef()
secchi_depth(2) = 0.0_dp
secchi_radiation_fraction(1) = 1.0_dp
secchi_radiation_fraction(2) = 0.0_dp
diffuse_attenuation_coefficient(1) = secchi_depth(1) / DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
diffuse_attenuation_coefficient(2) = secchi_depth(2) / DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
diffuse_attenuation_coefficient(1) = secchi_depth(1) / POOL_ATKINS_PARAMETER
Comment thread
KoenBussemakerDeltares marked this conversation as resolved.
Outdated
diffuse_attenuation_coefficient(2) = secchi_depth(2) / POOL_ATKINS_PARAMETER
vicwminb = 0.0_dp
xlozmidov = 0.0_dp
idensform = 2
Expand Down
18 changes: 9 additions & 9 deletions src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_data/unstruc_model.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1424,13 +1424,15 @@ subroutine readMDUFile(filename, istat)

! Secchi parameter readout
call prop_get(md_ptr, 'physics', 'SecchiDepth', secchi_depth(1))
call prop_get(md_ptr, 'physics', 'SecchiDepth2', secchi_depth(2))
call prop_get(md_ptr, 'physics', 'SecchiDepth2Fraction', secchi_radiation_fraction(2))
call prop_get(md_ptr, 'physics', 'SecchiDepth2', secchi_depth(2)) ! Deprecated, use SecchiDepthNonPenetrative instead
call prop_get(md_ptr, 'physics', 'SecchiDepthNonPenetrative', secchi_depth(2))
call prop_get(md_ptr, 'physics', 'SecchiDepth2Fraction', secchi_radiation_fraction(2)) ! Deprecated, use SecchiDepthNonPenetrativeFraction instead
call prop_get(md_ptr, 'physics', 'SecchiDepthNonPenetrativeFraction', secchi_radiation_fraction(2))

diffuse_attenuation_coefficient(1) = secchi_depth(1) / DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
diffuse_attenuation_coefficient(1) = secchi_depth(1) / POOL_ATKINS_PARAMETER

if (secchi_depth(2) > 0) then
diffuse_attenuation_coefficient(2) = secchi_depth(2) / DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
diffuse_attenuation_coefficient(2) = secchi_depth(2) / POOL_ATKINS_PARAMETER
secchi_radiation_fraction(1) = 1.0_dp - secchi_radiation_fraction(2)
end if

Expand Down Expand Up @@ -3445,12 +3447,10 @@ subroutine writeMDUFilepointer(mout, writeall, istat)

call prop_set(prop_ptr, 'physics', 'Temperature', temperature_model, 'Include temperature (0: no, 1: only transport, 3: excess model of D3D, 5: composite (ocean) model)')
if (writeall .or. (temperature_model /= TEMPERATURE_MODEL_NONE)) then
call prop_set(prop_ptr, 'physics', 'InitialTemperature', temini, 'Uniform initial water temperature (degC)')
call prop_set(prop_ptr, 'physics', 'InitialTemperature', temini, 'Uniform initial water temperature (deg C)')
call prop_set(prop_ptr, 'physics', 'SecchiDepth', secchi_depth(1), 'Water clarity parameter (m)')
if (secchi_depth(2) > 0) then
call prop_set(prop_ptr, 'physics', 'SecchiDepth2', secchi_depth(2), 'Water clarity parameter for infrared radiation (m), only used if > 0')
call prop_set(prop_ptr, 'physics', 'SecchiDepth2Fraction', secchi_radiation_fraction(2), 'Fraction of total absorbed by profile 2')
end if
call prop_set(prop_ptr, 'physics', 'SecchiDepthNonPenetrative', secchi_depth(2), 'Water clarity parameter for non-penetrative radiation (m).')
Comment thread
KoenBussemakerDeltares marked this conversation as resolved.
call prop_set(prop_ptr, 'physics', 'SecchiDepthNonPenetrativeFraction', secchi_radiation_fraction(2), 'Fraction of solar radiation that is non-penetrative (-).')

call prop_set(prop_ptr, 'physics', 'Stanton', Stanton, 'Coefficient for convective heat flux, if negative, Ccon = abs(Stanton)*Cdwind')
call prop_set(prop_ptr, 'physics', 'Dalton', Dalton, 'Coefficient for evaporative heat flux, if negative, Ceva = abs(Dalton)*Cdwind')
Expand Down
4 changes: 2 additions & 2 deletions src/engines_gpl/dflowfm/packages/dflowfm_kernel/src/dflowfm_kernel/compute/heatun.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ subroutine heatun(n, time_in_hours, nominal_solar_radiation)
use m_physcoef, only: ag, rhomean, backgroundsalinity, backgroundwatertemperature, dalton, epshstem, stanton, secchi_depth, &
soiltempthick, BACKGROUND_AIR_PRESSURE, BACKGROUND_HUMIDITY, BACKGROUND_CLOUDINESS, surftempsmofac, &
jadelvappos, free_convection_coefficient, secchi_radiation_fraction, diffuse_attenuation_coefficient, &
DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
POOL_ATKINS_PARAMETER
use m_heatfluxes, only: em, albedo, cpa, spatial_secchi_depth_is_available, spatial_secchi_depth, jamapheatflux, rcpi, fwind, qtotmap, qsunmap, qevamap, &
qconmap, qlongmap, qfrevamap, qfrconmap, qsunav, qlongav, qconav, qevaav, qfrconav, qfrevaav
use m_flow, only: kmx, hs, solar_radiation_factor, zws, ucx, ucy, ktop
Expand Down Expand Up @@ -218,7 +218,7 @@ subroutine heatun(n, time_in_hours, nominal_solar_radiation)
do j = j2, 1, -1

if (j == 1 .and. spatial_secchi_depth_is_available) then
diffuse_attenuation_coefficient_in_cell(1) = spatial_secchi_depth(n) / DIFFUSE_ATTENUATION_COEFFICIENT_FACTOR
diffuse_attenuation_coefficient_in_cell(1) = spatial_secchi_depth(n) / POOL_ATKINS_PARAMETER
end if

zlo = 0.0_dp
Expand Down
Loading