Provide a better explanation of the max_change and min_change of TimeStepWizard
#3245
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
navidcy
reviewed
Aug 31, 2023
navidcy
approved these changes
Aug 31, 2023
navidcy
reviewed
Aug 31, 2023
navidcy
requested changes
Aug 31, 2023
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
iuryt
commented
Aug 31, 2023
Co-authored-by: iury simoes-sousa <iuryt@pm.me>
navidcy
approved these changes
Aug 31, 2023
glwagner
reviewed
Aug 31, 2023
Comment on lines
+36
to
+38
| `simulation.Δt` is not adapted "too quickly". In other words, `max_change` is the maximum | ||
| and `min_change` is the minimum relative change of the time step and are, therefore, non-dimensional | ||
| (`min_change * old_Δt ≤ new_Δt ≤ max_change * old_Δt`). |
There was a problem hiding this comment.
Note there is a grammatical error in the above as well. If we're seeking improved clarity, I suggest changing to something like
Callback function that adapts the simulation time step to a target
advective Courant-Freidrichs-Lewy (CFL) number `cfl`, within the limits
max(max_Δt, max_change * previous_Δt) ≤ new_Δt ≤ min(min_Δt, min_change * previous_Δt)
where `new_Δt` is the new time step calculated by `TimeStepWizard`.Or something along those lines...
Merged
siddharthabishnu
pushed a commit
that referenced
this pull request
Sep 11, 2023
…`TimeStepWizard` (#3245) * Update docstring of the TimeStepWizard * Update TimeStepWizard explanation in the horizontal_convection example * Change symbol for 'less than or equal' and 'greater than or equal' Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com> * Change symbol for 'less than or equal' and 'greater than or equal' Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com> * better phrasing Co-authored-by: iury simoes-sousa <iuryt@pm.me> --------- Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
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 #3244