Skip to content
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

Output the mpi rank to element_variables (SaveSolutionCallback) for visualization with trixi2vtk #2132

Merged
merged 10 commits into from
Nov 18, 2024

Conversation

amrueda
Copy link
Contributor

@amrueda amrueda commented Oct 24, 2024

image

@amrueda amrueda marked this pull request as draft October 24, 2024 14:51
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.

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

Attention: Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.37%. Comparing base (9c2f326) to head (b884af7).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/solvers/dg.jl 33.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2132      +/-   ##
==========================================
- Coverage   96.37%   96.37%   -0.00%     
==========================================
  Files         480      480              
  Lines       38178    38184       +6     
==========================================
+ Hits        36793    36798       +5     
- Misses       1385     1386       +1     
Flag Coverage Δ
unittests 96.37% <66.67%> (-<0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@amrueda amrueda marked this pull request as ready for review October 24, 2024 15:59
@amrueda amrueda requested a review from sloede October 24, 2024 15:59
src/solvers/dg.jl Outdated Show resolved Hide resolved
src/solvers/dg.jl Outdated Show resolved Hide resolved
DanielDoehring
DanielDoehring previously approved these changes Oct 26, 2024
Co-authored-by: Joshua Lampert <[email protected]>
DanielDoehring
DanielDoehring previously approved these changes Oct 28, 2024
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

I like the idea but I have questions...

src/solvers/dgsem_tree/dg_parallel.jl Outdated Show resolved Hide resolved
@amrueda amrueda marked this pull request as draft October 28, 2024 09:43
Copy link
Contributor

@DanielDoehring DanielDoehring left a comment

Choose a reason for hiding this comment

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

Maybe you can smuggle this into one of the MPI tests to test this functionality?

@amrueda
Copy link
Contributor Author

amrueda commented Oct 29, 2024

Maybe you can smuggle this into one of the MPI tests to test this functionality?

Any suggestion how? none of the other element variables used for visualization (:indicator_shock_capturing, element_ids, levels, indicator_amr, etc.) is tested, as far as I can tell.

@ranocha
Copy link
Member

ranocha commented Oct 29, 2024

It could be tested together with Trixi2Vtk.jl (in the other repo and as downstream test here).

DanielDoehring
DanielDoehring previously approved these changes Oct 29, 2024
@amrueda
Copy link
Contributor Author

amrueda commented Nov 12, 2024

It could be tested together with Trixi2Vtk.jl (in the other repo and as downstream test here).

I am not very familiar with the downstream tests. Do I understand correctly that all Trixi2Vtk.jl's tests are run as downstream tests from here?

What is the best way to add a downstream test then? first merge the PR and then add a new test in Trixi2Vtk.jl? or is it possible to have the downstream tests run from a particular branch of Trixi2Vtk.jl?

@ranocha
Copy link
Member

ranocha commented Nov 13, 2024

Downstream tests use the version from the PR (or main) that triggers running them. The best way is probably to

  • test the stuff from the PR locally with Trixi2Vtk.jl
  • merge the Trixi.jl PR
  • create a Trixi2Vtk.jl PR with new tests and merge it

@amrueda amrueda marked this pull request as ready for review November 14, 2024 15:42
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
sloede
sloede previously approved these changes Nov 18, 2024
@sloede sloede enabled auto-merge (squash) November 18, 2024 09:00
@amrueda
Copy link
Contributor Author

amrueda commented Nov 18, 2024

I added a downstream test for Trixi2Vtk.jl in this PR.

@amrueda amrueda requested a review from sloede November 18, 2024 10:59
@sloede sloede merged commit db83c71 into trixi-framework:main Nov 18, 2024
35 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants