Issue #1116 fix imod5 well import (#1142)

Fixes #1116

# Description
- ``open_projectfile_data`` now groups wells by ipf name
- ``GridAgnosticWell.from_imod5_data`` now validates associated IPFs
whether they meet our requirements
- ``GridAgnosticWell.from_imod5_data`` deactivates unassociated IPFs if
not present in certain timestep anymore
- Remove imod.formats.prj.convert_to_disv
- Adds lots of test cases to test the well import from projectfiles

# Checklist
- [x] Links to correct issue
- [x] Update changelog, if changes affect users
- [x] PR title starts with ``Issue #nr``, e.g. ``Issue #737``
- [x] Unit tests were added
- [ ] **If feature added**: Added/extended example

Author: JoerivanEngelen

docs/api/changelog.rst

@@ -19,7 +19,8 @@ Fixed
 
 Changed
 ~~~~~~~
-- :class:`imod.mf6.Well` now also validates that well filter top is above well filter bottom
+- :class:`imod.mf6.Well` now also validates that well filter top is above well
+  filter bottom
 - :func:`open_projectfile_data` now also imports well filter top and bottom.
 - :class:`imod.mf6.Well` now logs a warning if any wells are removed during writing.
 - :class:`imod.mf6.HorizontalFlowBarrierResistance`,
@@ -30,19 +31,31 @@ Changed
   :func:`imod.prepare.linestring_to_square_zpolygons` and
   :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate these
   polygons.
+- :func:`open_projectfile_data` now returns well data grouped by ipf name,
+  instead of generic, separate number per entry.
 
 Added
 ~~~~~
 
+- :meth:`imod.mf6.Modflow6Simulation.from_imod5_data` to import imod5 data
+  loaded with :func:`imod.formats.prj.open_projectfile_data` as a MODFLOW 6
+  simulation.
 - :func:`imod.prepare.linestring_to_square_zpolygons` and
-  :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate
-  vertical polygons that can be used to specify horizontal flow barriers, specifically:
+  :func:`imod.prepare.linestring_to_trapezoid_zpolygons` to generate vertical
+  polygons that can be used to specify horizontal flow barriers, specifically:
   :class:`imod.mf6.HorizontalFlowBarrierResistance`,
   :class:`imod.mf6.HorizontalFlowBarrierMultiplier`,
   :class:`imod.mf6.HorizontalFlowBarrierHydraulicCharacteristic`.
 - :class:`imod.mf6.LayeredWell` to specify wells directly to layers instead
   assigning them with filter depths.
 
+Removed
+~~~~~~~
+
+- :func:`imod.formats.prj.convert_to_disv` has been removed. This functionality
+  has been replaced by :meth:`imod.mf6.Modflow6Simulation.from_imod5_data`. To
+  convert a structured simulation to an unstructured simulation, call:
+  :meth:`imod.mf6.Modflow6Simulation.regrid_like`
 
 [Unreleased]
 ------------

docs/api/io.rst

@@ -29,4 +29,3 @@ Input/output
     prj.read_projectfile
     prj.open_projectfile_data
     prj.read_timfile
-    prj.convert_to_disv

docs/api/mf6.rst

@@ -74,6 +74,11 @@ Flow Packages
     HorizontalFlowBarrierHydraulicCharacteristic
     HorizontalFlowBarrierMultiplier
     HorizontalFlowBarrierResistance
+    LayeredWell
+    LayeredWell.from_imod5_data
+    LayeredWell.mask
+    LayeredWell.regrid_like
+    LayeredWell.to_mf6_pkg
     InitialConditions
     NodePropertyFlow
     Recharge
@@ -82,6 +87,10 @@ Flow Packages
     StorageCoefficient
     UnsaturatedZoneFlow
     Well
+    Well.from_imod5_data
+    Well.mask
+    Well.regrid_like
+    Well.to_mf6_pkg
     WellDisStructured
     WellDisVertices
 

examples/imod5-backwards-compatibility/imod5_conversion.py

@@ -1,2 +1 @@
-from imod.formats.prj.disv_conversion import convert_to_disv
 from imod.formats.prj.prj import open_projectfile_data, read_projectfile, read_timfile