Add an observer for tracking the size of DataBox items #5858
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
nilsdeppe
requested changes
Mar 18, 2024
| auto& observer_writer_proxy = Parallel::get_parallel_component< | ||
| observers::ObserverWriter<Metavariables>>(cache); | ||
| const std::string subfile_name = | ||
| "/ObserveDataBox/" + pretty_type::name<ContributingComponent>(); |
There was a problem hiding this comment.
Should we make this file name be specified in ObserveDataBox like we do for other observations? Maybe otherwise name this ObserveDataBoxSizeInMb? Long, but extremely unlikely to conflict with anything
| }; | ||
| } // namespace detail | ||
|
|
||
| class ObserveDataBox : public Event { |
There was a problem hiding this comment.
Could you add some doxygen comment so this shows up?
How difficult would it be to write a simple test that just verifies this works with say 1 singleton, 1 nodegroup, and 1 array (with 3 elements?)? If it's difficult, I'm happy to defer since this feature is very necessary
nilsdeppe
reviewed
Apr 12, 2024
- Adds a function to observe the size in bytes of all non-reference items in a DataBox - Adds an observer to gather the sizes in MB of each item (summed over all elements) for the DataBoxes of each component
nilsdeppe
approved these changes
Apr 15, 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
This adds an event that can be used to track the sizes of DataBox items. It is not added to any executable, as it seems to add some compilation time. To use it, add it as an Event similar to the MonitorMemory event.
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