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

Support of other real types (Float32, auxiliary) #1929

Closed
wants to merge 8 commits into from

Conversation

huiyuxie
Copy link
Member

@huiyuxie huiyuxie commented May 6, 2024

The first extra part of #1909, mainly addressing src/auxiliary.

TODO:
#1929 (comment)

@huiyuxie huiyuxie requested review from ranocha and sloede and removed request for ranocha May 6, 2024 04:34
Copy link
Contributor

github-actions bot commented May 6, 2024

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.

Copy link

codecov bot commented May 6, 2024

Codecov Report

Attention: Patch coverage is 0% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 91.13%. Comparing base (c221bca) to head (d7716cb).

Files Patch % Lines
src/auxiliary/math.jl 0.00% 12 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1929      +/-   ##
==========================================
- Coverage   96.09%   91.13%   -4.96%     
==========================================
  Files         453      453              
  Lines       36481    36489       +8     
==========================================
- Hits        35055    33252    -1803     
- Misses       1426     3237    +1811     
Flag Coverage Δ
unittests 91.13% <0.00%> (-4.96%) ⬇️

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.

src/auxiliary/math.jl Outdated Show resolved Hide resolved
src/auxiliary/math.jl Outdated Show resolved Hide resolved
@huiyuxie huiyuxie added the enhancement New feature or request label May 6, 2024
@huiyuxie
Copy link
Member Author

huiyuxie commented May 6, 2024

Thanks for the review @ranocha ! I am thinking about how to test these PRs. Generally, I would treat these smaller PRs as preliminary improvements (as the general PR is calling some basic functions here). So basically we could test and merge these smaller PRs first then merge and test the general PR. But what if some PRs are cross-referencing each other (for example, some PRs rely on the improvements from each other)?

I am not sure whether the case I mentioned above is going to happen in these improvements.

@ranocha
Copy link
Member

ranocha commented May 7, 2024

Thanks for the review @ranocha ! I am thinking about how to test these PRs. Generally, I would treat these smaller PRs as preliminary improvements (as the general PR is calling some basic functions here). So basically we could test and merge these smaller PRs first then merge and test the general PR. But what if some PRs are cross-referencing each other (for example, some PRs rely on the improvements from each other)?

I am not sure whether the case I mentioned above is going to happen in these improvements.

In this case, the PRs providing functionality required by other changes should be merged first.

@huiyuxie huiyuxie requested a review from ranocha May 8, 2024 20:46
@sloede
Copy link
Member

sloede commented May 9, 2024

This depends on #1909 (or at least similar issues apply), right? If yes, please re-request my review here once changes in #1909 that are also pertinent for this PR here have been applied here as well 🙂

@huiyuxie
Copy link
Member Author

#1909 depends on this PR (and possibly more small PRs like this in the future).

@huiyuxie
Copy link
Member Author

Rerun CI please (if you like). I locally ran CI when these were running here - hitting the limit and thus too many CI failures here.

@huiyuxie huiyuxie closed this May 17, 2024
@huiyuxie huiyuxie deleted the helper branch May 17, 2024 20:46
@huiyuxie huiyuxie restored the helper branch May 17, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants