#368 modify iterate method to allow timestep control #387
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or timestep control'
stephankramer
requested changes
Jan 17, 2025
thetis/solver2d.py
Outdated
| export_func=None): | ||
| """ | ||
| Creates a generator to iterate through the simulation and return access | ||
| to time advancing function when time control is handled eternally. |
There was a problem hiding this comment.
Typo:
Suggested change
| to time advancing function when time control is handled eternally. | |
| to time advancing function when time control is handled externally. |
thetis/solver2d.py
Outdated
|
|
||
| .. code-block:: python | ||
|
|
||
| for t in solver_obj.generator(): |
There was a problem hiding this comment.
Suggested change
| for t in solver_obj.generator(): | |
| for t in solver_obj.create_iterator(): |
thetis/solver2d.py
Outdated
|
|
||
| .. code-block:: python | ||
|
|
||
| thetis_timestepper = solver_obj.generator() |
There was a problem hiding this comment.
Suggested change
| thetis_timestepper = solver_obj.generator() | |
| thetis_timestepper = solver_obj.create_iterator() |
| @@ -87,6 +89,7 @@ | |||
|
|
|||
| # The velocity field is set up using a simple analytic expression. :: | |||
|
|
|||
| x, y = SpatialCoordinate(mesh2d) | |||
There was a problem hiding this comment.
Hm, that's a good demo to showcase the use of the iterator but it brings up another issue. Apparently the demo's aren't tested - demonstrated by the fact that you had to add this line - which is bad! See #389. The reason I asked for the create_iterator() method to be used in a example or test, is precisely because we intend it to be public API so we want to know when it breaks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #368
Implements the 2nd option proposed by @stephankramer in #368 by splitting
iterateinto two parts:create_iterator- which gives a facelift refactor to the existingiteratefunctionality as a generatoriterate- which wrapscreate_iteratorand preserves the existing accessibility/structure