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

fix(prt): make extended tracking opt-in #1888

Merged
merged 3 commits into from
Jun 21, 2024

Conversation

wpbonelli
Copy link
Contributor

@wpbonelli wpbonelli commented Jun 20, 2024

Previously the PRT model's default behavior was to track particles until termination, as with MODPATH 7 stop time option 2 (extend). Under extended tracking, the program may not halt if particles enter a cycle in the flow system. This PR changes the default to the equivalent of MP7 stop time option 1 (final), terminating at simulation end unless a new Particle Release Point (PRP) package keyword option EXTEND is provided. This is meant to provide a stronger guarantee that the program halts under default settings.

The extend option is stored as an integer rather than logical in case we need to enumerate more alternatives in future.

This PR also avoids unnecessary iterations in MethodSubcellPollock/Ternary, and changes the default visibility of ParticleStore members to private, as per style conventions.


Checklist of items for pull request

  • Added new test or modified an existing test
  • Ran black on new and modified autotests
  • Formatted new and modified Fortran source files with fprettify
  • Added doxygen comments to new and modified procedures
  • Updated definition files
  • Updated develop.tex with a plain-language description of the bug fix, change, feature; required for changes that may affect users
  • Updated input and output guide
  • Removed checklist items not relevant to this pull request

Previously the default behavior was to track particles until termination, as with MODPATH 7 stop time option 'extend'. Under extended tracking, the program may never halt if particles enter a cycle in the flow system. This PR changes the default behavior to the equivalent of MP7 stop time option 'final', terminating particles when the simulation ends unless new PRP keyword option  is provided. This is meant to provide a (stronger) guarantee that the program halts under default settings.

Internally, the extend option is stored as an integer rather than logical in case we need to enumerate more alternatives in future.

This PR also avoids unnecessary iterations in , and changes the default visibility of  members to private, as per style conventions.
@wpbonelli wpbonelli added bug documentation Documentation changes option MF6 IO related labels Jun 20, 2024
@wpbonelli wpbonelli marked this pull request as ready for review June 20, 2024 20:58
Copy link
Contributor

@langevin-usgs langevin-usgs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wpbonelli, thanks for doing this. I think this will save some trouble. One thing that that jumps out at me is if there is a clearer keyword to use for this option. Certainly "EXTEND" is fine and is clearly described. Maybe "EXTEND_TRACKING" or something with TIME in it?

Also wonder if it would be worth explicitly mentioning that if the extend option is specified that particles will continue to be tracked using the flows from the last time step. This is probably obvious but I think it's good to mention. For a transient simulation with a changing flow field, flows from the last time step may not be a good indicator of conditions past the end of the simulation.

@wpbonelli
Copy link
Contributor Author

Thanks @langevin-usgs, renamed EXTEND -> EXTEND_TRACKING and mentioned that the flows from the final time step are used for extended tracking.

@wpbonelli wpbonelli merged commit ba29c04 into MODFLOW-USGS:develop Jun 21, 2024
18 checks passed
@wpbonelli wpbonelli deleted the prt-extend branch June 21, 2024 12:16
wpbonelli added a commit to wpbonelli/modflow6-examples that referenced this pull request Jun 22, 2024
wpbonelli added a commit to MODFLOW-USGS/modflow6-examples that referenced this pull request Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Documentation changes option MF6 IO related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants