Skip to content

Save additional node variables in SaveSolutionCallback #2298

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

Merged
merged 40 commits into from
May 27, 2025

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Feb 25, 2025

Save additional stuff in the solution callback for convenient visualization.

Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@DanielDoehring
Copy link
Contributor Author

Currently, the PR is somewhat inconsistent as for hyperbolic equations there is a dispatch based on the volume integral type, and for the parabolic equations we use an if-clause. This should be unified IMO.

@DanielDoehring DanielDoehring added enhancement New feature or request visualization labels Feb 25, 2025
Copy link
Contributor

@bennibolm bennibolm left a comment

Choose a reason for hiding this comment

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

In general, this looks good to me. Unfortunately, the correct export of the "limiting coefficient" is not CI tested extensively.
But, if you tested it locally and say it works properly, I'm fine with merging this after the one issue.

@DanielDoehring
Copy link
Contributor Author

Maybe it also makes sense to add new functions get_derived_solution_variables ?

@DanielDoehring
Copy link
Contributor Author

@JoshuaLampert could you maybe also take a look and leave your thoughts here?

Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

Thanks! I can image, this is a very useful feature. However, I would like to discuss the interface first, see my comment below.

@DanielDoehring DanielDoehring marked this pull request as ready for review May 23, 2025 10:15
@DanielDoehring
Copy link
Contributor Author

I generalized the implementation such that now users can supply their own functions to be stored in the solution file.

I need to test the mpi-implementations, but from my side this is ready for review.

Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

Thanks! I left two comments about documentation below.

JoshuaLampert
JoshuaLampert previously approved these changes May 25, 2025
Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

LGTM!

@DanielDoehring DanielDoehring mentioned this pull request May 26, 2025
11 tasks
Co-authored-by: Benjamin Bolm <[email protected]>
bennibolm
bennibolm previously approved these changes May 26, 2025
Copy link
Contributor

@bennibolm bennibolm left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

JoshuaLampert
JoshuaLampert previously approved these changes May 26, 2025
@JoshuaLampert JoshuaLampert marked this pull request as draft May 26, 2025 08:23
@JoshuaLampert
Copy link
Member

I have converted it to a draft so it's not accidentally merged because this is breaking.

@ranocha
Copy link
Member

ranocha commented May 27, 2025

Could you please merge main into your branch and resolve the conflicts so that we can prepare the breaking release? Please ping me afterwards.

@DanielDoehring DanielDoehring dismissed stale reviews from JoshuaLampert and bennibolm via 9be75aa May 27, 2025 12:52
@DanielDoehring DanielDoehring marked this pull request as ready for review May 27, 2025 12:55
@DanielDoehring
Copy link
Contributor Author

Ready to go @ranocha !

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks

@ranocha ranocha merged commit a51dade into trixi-framework:main May 27, 2025
37 of 40 checks passed
@DanielDoehring DanielDoehring deleted the AdditionalNodeVariables branch May 27, 2025 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants