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

Make error norm calculation optional #1755

Merged
merged 21 commits into from
Dec 6, 2023

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Nov 23, 2023

The calculation of the error norms is for non MPI runs (i.e., thread-parallel applications) not parallelized and can thus consume a tremendous fraction of computation time for large 2D, 3D systems.
While one might be interested in quantities computed by the analysis_callback such as the integrals of internal and kinetic energy, seldom $L^2$ and $L^\infty$ errors are for practical applications of interest.

Then, the computation of errors can be avoided by passing

analysis_callback = AnalysisCallback(semi, interval=analysis_interval, analysis_errors = Symbol[])

If only extra_analysis_errors are desired, one needs to pass in e.g.

analysis_callback = AnalysisCallback(semi, interval=analysis_interval, analysis_errors = [:conservation_error])

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.

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 DanielDoehring added the performance We are greedy label Nov 23, 2023
Copy link

codecov bot commented Nov 23, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7a7ce48) 96.24% compared to head (32172b0) 96.24%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1755   +/-   ##
=======================================
  Coverage   96.24%   96.24%           
=======================================
  Files         431      431           
  Lines       34895    34896    +1     
=======================================
+ Hits        33582    33583    +1     
  Misses       1313     1313           
Flag Coverage Δ
unittests 96.24% <100.00%> (+<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
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.

Sounds reasonable to me. Could you please document the new behavior in the docstring at the top of this file?

src/callbacks_step/analysis.jl Outdated Show resolved Hide resolved
test/test_tree_1d_advection.jl Show resolved Hide resolved
src/callbacks_step/analysis.jl Outdated Show resolved Hide resolved
src/callbacks_step/analysis.jl Outdated Show resolved Hide resolved
src/callbacks_step/analysis.jl Show resolved Hide resolved
src/callbacks_step/analysis.jl Outdated Show resolved Hide resolved
src/equations/equations.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.

Thanks!

@ranocha ranocha enabled auto-merge (squash) December 6, 2023 19:53
@ranocha ranocha merged commit 3d899bc into trixi-framework:main Dec 6, 2023
34 checks passed
@DanielDoehring DanielDoehring deleted the OptionalErrors branch December 6, 2023 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance We are greedy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants