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

Type stability of functions from examples tree_1d_dgsem #2133

Merged
merged 13 commits into from
Nov 8, 2024

Conversation

huiyuxie
Copy link
Member

Like #2122 - fix type instability of self-defined functions from examples.

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.

@huiyuxie huiyuxie marked this pull request as draft October 26, 2024 09:11
Copy link

codecov bot commented Oct 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.36%. Comparing base (9fa4e27) to head (e82cf3e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2133   +/-   ##
=======================================
  Coverage   96.36%   96.36%           
=======================================
  Files         480      480           
  Lines       38042    38067   +25     
=======================================
+ Hits        36657    36682   +25     
  Misses       1385     1385           
Flag Coverage Δ
unittests 96.36% <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.

@huiyuxie huiyuxie requested a review from ranocha November 6, 2024 03:46
@huiyuxie
Copy link
Member Author

huiyuxie commented Nov 6, 2024

Please review carefully @ranocha

@huiyuxie huiyuxie marked this pull request as ready for review November 6, 2024 03:46
@huiyuxie
Copy link
Member Author

huiyuxie commented Nov 6, 2024

I'm worried about cases like exp(Int) and log(Int) causing Float64 outputs.

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 a lot

examples/tree_1d_dgsem/elixir_advection_diffusion.jl Outdated Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_advection_diffusion.jl Outdated Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_burgers_rarefaction.jl Outdated Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_burgers_shock.jl Outdated Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_shallowwater_ec.jl Outdated Show resolved Hide resolved
huiyuxie and others added 2 commits November 7, 2024 13:55
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
@huiyuxie huiyuxie requested a review from ranocha November 7, 2024 23:59
@huiyuxie
Copy link
Member Author

huiyuxie commented Nov 8, 2024

Sorry I forgot the type stability for the whole function - thanks for the review 😊

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

@huiyuxie huiyuxie requested a review from ranocha November 8, 2024 05:13
@ranocha ranocha merged commit 806c1b9 into trixi-framework:main Nov 8, 2024
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.

2 participants