Add ability to RunEventsAndTriggers at steps within a slab for local time-stepping #6360
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
wthrowe
requested changes
Nov 4, 2024
| AtSteps, /**< checked at time step boundaries */ | ||
| }; | ||
|
|
||
| /// Output operator for a Flag. |
|
|
||
| /// \ingroup EventsAndTriggersGroup | ||
| /// \brief Frequency at which Events and Triggers are checked | ||
| enum class WhenToCheck : uint8_t { |
|
|
||
| Arguments: | ||
| event_name: The name of an event like "ObserveTimeSteps". | ||
| event__and_triggers_name: The name of a list of events. |
There was a problem hiding this comment.
Typo: double underscore, missing "s".
| @@ -80,14 +84,18 @@ struct ObservationValue { | |||
| namespace Tags { | |||
| /// \ingroup EventsAndTriggersGroup | |||
| /// Contains the events and triggers | |||
| template <Triggers::WhenToCheck WhenToCheck> | |||
| struct EventsAndTriggers : db::SimpleTag { | |||
| using type = ::EventsAndTriggers; | |||
There was a problem hiding this comment.
From what I recall, the original plan was to template the Event class (and possibly Trigger) as well, since most events won't work if run AtSteps. Was that idea abandoned?
There was a problem hiding this comment.
No; that is what I plan to do in the next PR. I just thought it would be easier to break things up into separate PRs, as this one will be the one that requires changes to the input files, and I wanted to get the enum finalized before templating the Events on it.
kidder
force-pushed
the
new_lts_events_and_triggers
branch
from
38fb1a8
to
ac6507b
Compare
|
Looks good. Squash. |
WhenToCheck will be used to distinguish input file options for EventsAndTriggers that are checked at different frequencies (e.g. after every time slab or after every time step).
The previous hard-coded value for the name will not work for multiple sets of EventsAndTriggers in an input file.
In evolution executables, the current input option EventsAndTriggers is replaced with EventsAndTriggersAtSlabs. In elliptic executables, the current input option EventsAndTriggers is replaced with EventsAndTriggersAtIterations. In a future commit, an additional input file option will be added for evolution executables with local time stepping.
If using LTS, then check EventsAndTriggersAtSteps which can trigger at steps inside a Slab.
kidder
force-pushed
the
new_lts_events_and_triggers
branch
from
ac6507b
to
ca5e87d
Compare
wthrowe
approved these changes
Nov 6, 2024
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.
Proposed changes
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments