Deltares / Deltares/imod-python
Support `CONTINUE` option in `Modflow6Simulation`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
Description
The MODFLOW 6 simulation name file (mfsim.nam) supports a CONTINUE option in its OPTIONS block. When set, MODFLOW 6 will continue the simulation even if the solver does not converge, instead of stopping with an error.
Currently, imod-python does not expose this option when writing mfsim.nam via Modflow6Simulation. As a workaround, users have to manually patch the written mfsim.nam file after calling simulation.write(...).
Requested behaviour
Allow setting CONTINUE on the simulation level, for example:
simulation = imod.mf6.Modflow6Simulation("example", continue_on_nonconvergence=True)
Additional context
Continue will be supported in iMOD-coupler via https://github.com/Deltares/imod_coupler/pull/479, currently the testmodel need to be updated manually.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Modflow6Simulation entry point and follow the writer that produces mfsim.nam, focusing on how simulation-level OPTIONS are represented. Add support for setting CONTINUE through the requested constructor option, then verify that simulation.write(...) emits it in the name file and that the option remains absent when not enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100