add function to overwrite several mdu keywords with coastal 2D/3D values

[veenstrajelmer]

Workflow was:

• improve mdu keywords (email FZ/SR 27-6-2024)
• resulted in jupyter notebook code
• manually edited in mdu file later on

Todo:

• add keywords from comment below
• also temporarily use stretchtype=-1 until there is a new hydrolib-core release containing mdu stretchtype should be -1 or 0 instead of 1 HYDROLIB-core#691 (and minimal version is updated in the dfm_tools pyproject.toml)
• Consider adding nchisdataprecision and ncmapdataprecision, but this will fail for old software versions
• consider mdu.wind.pavbnd = 101330 (from p:\dflowfm\maintenance\JIRA\07000-07999\07455\create_models.py)
• update modelbuilder example notebook and script, should simplify both significantly

[srodrigo-deltares]

The defaults that were changed independent of whether the model is 2D/3D:

# mdu.geometry.openboundarytolerance = 0.1 # should not have effect since we use izbndpos=1 (on net boundary) >> comment
mdu.geometry.bedlevuni = 5

mdu.numerics.izbndpos = 1
mdu.numerics.tlfsmo = 86400.
mdu.numerics.mintimestepbreak = 0.1 
mdu.numerics.vertadvtypsal = 4 # 3D? (default is 6) (generic?) >> discuss FZ
mdu.numerics.vertadvtyptem = 4 # 3D? (default is 6) (generic?) >> discuss FZ
# mdu.numerics.vertadvtypmom = 6 # 3D? (this is the default) >> comment

mdu.physics.vicoww = 0.0001 # 3D? (default is 5e-5) >> discuss FZ
mdu.physics.dicoww = 0.00001 # 3D? (default is 5e-5) >> discuss FZ
mdu.physics.rhomean = 1023.
mdu.physics.tidalforcing = 1
# mdu.physics.itcap = 1 # not generic, only DCSM? >> comment

mdu.wind.relativewind = 0.5 # generic? >> discuss FZ
mdu.wind.rhoair = 1.2265 # generic? >> discuss FZ
mdu.wind.icdtyp = 4 
mdu.wind.cdbreakpoints = ['0.025']

The 3D-specific settings are the following:

# z-sigma layer setup
mdu.geometry.kmx = 20
mdu.geometry.layertype = 2
mdu.geometry.numtopsig = 20
mdu.geometry.numtopsiguniform = 1
mdu.geometry.sigmagrowthfactor = 1.19
mdu.geometry.dztop = 5.0
mdu.geometry.floorlevtoplay = -5.0
mdu.geometry.dztopuniabovez = -100.0
mdu.geometry.keepzlayeringatbed = 2
mdu.geometry.dxwuimin2d = 0.1 # relevant? ('Smallest fraction dx/wu , set dx > Dxwuimin2D*wu') >> discuss FZ

mdu.numerics.keepstbndonoutflow = 1
mdu.numerics.barocponbnd = 1 # related to mdu.wind.pavbnd? (barocponbnd: 'Use baroclinic pressure correction on open boundaries (1: yes, 0: no)') >> in order to enable inverse barometer correction, pavbnd has to be realistic? >> discuss FZ

# support for initial sal/tem fields via iniwithnudge, this requires 3D model
mdu.physics.iniwithnudge = 2
mdu.physics.salinity = 1
mdu.physics.temperature = 5
mdu.physics.initialsalinity = 35.1 # generic? (default is 0) >> 30/35
mdu.physics.backgroundsalinity = 35 # generic? (default is 30) >> 30/35
# mdu.physics.initialtemperature = 5.5 # generic? (default is 6) >> comment
# mdu.physics.backgroundwatertemperature = 20. # generic? (default is 6) >> comment
# mdu.physics.tempmin = -999 >> not generic, comment
# mdu.physics.tempmax = 50. >> not generic, comment
mdu.physics.heat_eachstep = 1
mdu.physics.rhoairrhowater = 1