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

Allow disabling reinterpolation in 1D plots #2258

Merged
merged 13 commits into from
Feb 6, 2025

Conversation

JoshuaLampert
Copy link
Member

For 1D plots the visualization nodes are currently always interpolated to uniformly distributed nodes. This can introduce spurious overshoots, which might not be within the solution data. This PR introduces a keyword argument, which allows to disable the interpolation therefore using the GLL nodes also for the visualization.
Below you can see a comparison.
with reinterpolate = true (current behavior and default with this PR):
with_interpolation
with reinterpolate = false:
without_interpolation

The plots are generated by the following code:

julia> using Trixi, Plots

julia> trixi_include(joinpath(examples_dir(), "tree_1d_fdsbp", "elixir_advection_upwind.jl"))
[...]
julia> plot(sol)

julia> plot(sol, reinterpolate = false)

Closes #1527.

Copy link
Contributor

github-actions bot commented Feb 3, 2025

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 Feb 3, 2025

Codecov Report

Attention: Patch coverage is 96.29630% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.87%. Comparing base (c24ce91) to head (cfa28ed).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/visualization/utilities.jl 96.15% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2258   +/-   ##
=======================================
  Coverage   96.87%   96.87%           
=======================================
  Files         490      490           
  Lines       39454    39458    +4     
=======================================
+ Hits        38220    38224    +4     
  Misses       1234     1234           
Flag Coverage Δ
unittests 96.87% <96.30%> (+<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.

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.

LGTM; I only added some comments aiming to improve semantics.

src/visualization/types.jl Outdated Show resolved Hide resolved
src/visualization/types.jl Outdated Show resolved Hide resolved
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.

Nice idea!

src/visualization/types.jl Outdated Show resolved Hide resolved
src/visualization/utilities.jl Outdated Show resolved Hide resolved
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

Thanks @JoshuaLampert! This is a nice feature to have because using the (partially) supported utils/trixi2txt.jl and ParaView is a bit unwieldy.

src/visualization/utilities.jl Outdated Show resolved Hide resolved
src/visualization/utilities.jl Outdated Show resolved Hide resolved
ranocha
ranocha previously approved these changes Feb 5, 2025
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! Please resolve the conflicts so that we can merge this PR. Nice feature 👍

src/visualization/types.jl Outdated Show resolved Hide resolved
Co-authored-by: Hendrik Ranocha <[email protected]>
@JoshuaLampert
Copy link
Member Author

JoshuaLampert commented Feb 5, 2025

Please resolve the conflicts

Done!

src/visualization/utilities.jl Outdated Show resolved Hide resolved
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for this new feature

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 8109845 into main Feb 6, 2025
38 of 39 checks passed
@ranocha ranocha deleted the disable-reinterpolation-1d-plot branch February 6, 2025 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request visualization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ability to turn off re-inteprolation in plot recipes
4 participants