Skip to content
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.

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

Complete support for MDU output keywords #525

Closed
arthurvd opened this issue Apr 12, 2023 · 4 comments
Closed

Complete support for MDU output keywords #525

arthurvd opened this issue Apr 12, 2023 · 4 comments
Labels
priority: high type: compatibility Changes needed to be compatible with the computational core type: enhancement Improvements to existing functionality
Milestone

Comments

@arthurvd
Copy link
Member

arthurvd commented Apr 12, 2023

Is your feature request related to a problem? Please describe.
There are still missing fields for MDU keywords (in the [Output] section, in particular several Wrimap_* keywords.)
Make this complete.

Describe the solution you'd like
Check hydrolib-core support against FM kernel code and User manual.
Bring all three in sync.

@arthurvd arthurvd added the type: enhancement Improvements to existing functionality label Apr 12, 2023
@arthurvd arthurvd added this to the Release 1.0 milestone Apr 12, 2023
@arthurvd arthurvd added this to To do in HYDROLIB-core via automation Apr 12, 2023
@veenstrajelmer
Copy link
Collaborator

veenstrajelmer commented Apr 12, 2023

Also take the default values into account, these are sometimes incorrectly documented in the manual. More info in #520 (comment)

Currently, these wrihis/wrimap keywords default to 1, I would say most of them can be 0 (to be discussed):

rstinterval = 0.0
wrihis_balance = 1
wrihis_sourceSink = 1
wrihis_structure_gen = 1
wrihis_structure_dam = 1
wrihis_structure_pump = 1
wrihis_structure_gate = 1
wrihis_structure_weir = 1
wrihis_structure_orifice = 1
wrihis_structure_bridge = 1
wrihis_structure_culvert = 1
wrihis_structure_longCulvert = 1
wrihis_structure_damBreak = 1
wrihis_structure_uniWeir = 1
wrihis_structure_compound = 1
wrihis_turbulence = 1
wrihis_wind = 1
wrihis_rain = 1
wrihis_infiltration = 1
wrihis_temperature = 1
wrihis_waves = 1
wrihis_heat_fluxes = 1
wrihis_salinity = 1
wrihis_density = 1
wrihis_waterlevel_s1 = 1
wrihis_bedlevel = 1
wrihis_velocity_vector = 1
wrihis_sediment = 1
wrihis_constituents = 1
wrihis_zcor = 1
wrihis_lateral = 1
wrihis_taucurrent = 1
wrimap_waterLevel_s0 = 1
wrimap_waterLevel_s1 = 1
wrimap_waterdepth = 1
wrimap_velocity_component_u0 = 1
wrimap_velocity_component_u1 = 1
wrimap_velocity_vector = 1
wrimap_velocity_magnitude = 1
wrimap_density_rho = 1
wrimap_horizontal_viscosity_viu = 1
wrimap_horizontal_diffusivity_diu = 1
wrimap_flow_flux_q1 = 1
wrimap_spiral_flow = 1
wrimap_numLimdt = 1
wrimap_tauCurrent = 1
wrimap_chezy = 1
wrimap_turbulence = 1
wrimap_wind = 1
wrimap_tidal_potential = 1
wrimap_SAL_potential = 1
wrimap_internal_tides_dissipation = 1

The keyword rstinterval=0.0 is hydrolib-core default, which is different for the FM kernel than rstinterval=0. The first one translates to [0.0 start end], the second one translates to [0]. Fix this default

Lastly, when there are unknown keywords in the mdu, a warning should be given instead of them being silently dropped.

@priscavdsluis priscavdsluis added type: compatibility Changes needed to be compatible with the computational core priority: high labels Apr 10, 2024
@MRVermeulenDeltares
Copy link
Contributor

As we understand, the goal for this issue is:

  1. Add the keywords described above, with default values.
    (The above mentioned default will be used, we assume these are correct when the issue is picked up. Please update them accordingly.)
  2. Resolve the default of rstinterval to be in line with the FM kernel.
  3. Unknown keywords give a warning and are then dropped. (should this be splitup in a different issue?)

@veenstrajelmer & @rhutten is this correct?

@tim-vd-aardweg
Copy link
Contributor

tim-vd-aardweg commented Apr 16, 2024

Let's wait until #571 is implemented @MRVermeulenDeltares
I made a separate issue for the last request: When there are unknown keywords in the mdu, a warning should be given instead of them being silently dropped.

@veenstrajelmer veenstrajelmer moved this from To do to In progress in HYDROLIB-core Jun 7, 2024
@veenstrajelmer
Copy link
Collaborator

With the current main branch, the entire list of keywords in #525 (comment) is now implemented in hydrolib-core

HYDROLIB-core automation moved this from In progress to Done Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high type: compatibility Changes needed to be compatible with the computational core type: enhancement Improvements to existing functionality
Projects
HYDROLIB-core
  
Done
Development

No branches or pull requests

5 participants