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

Add 1D DGMulti GaussSBP solver #1930

Closed
wants to merge 8 commits into from
Closed

Conversation

jlchan
Copy link
Contributor

@jlchan jlchan commented May 7, 2024

GaussSBP solvers previously were only implemented in 2D and 3D. This PR adds 1D capabilities (using that sum factorization just reduces to mul! in 1D).

Copy link
Contributor

github-actions bot commented May 7, 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
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! I just have a minor suggestion

@jlchan jlchan requested a review from ranocha May 7, 2024 14:23
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) May 7, 2024 14:30
@jlchan
Copy link
Contributor Author

jlchan commented May 7, 2024

Thanks for the quick review!

@ranocha
Copy link
Member

ranocha commented May 7, 2024

Codecov is failing but I would like to see whether CI covers the new code...

@ranocha
Copy link
Member

ranocha commented May 7, 2024

Maybe you can push this branch to a branch in the main repo and open a new PR so that we don't have the problem with codecov?

@jlchan
Copy link
Contributor Author

jlchan commented May 7, 2024

Maybe you can push this branch to a branch in the main repo and open a new PR so that we don't have the problem with codecov?

Sure, no problem

@jlchan jlchan mentioned this pull request May 7, 2024
jlchan added a commit that referenced this pull request May 7, 2024
* add 1D Gauss tensor product functionality

* add 1D kronecker product fallback

* add Burgers' shock capturing example

* add test

* format

* Update examples/dgmulti_1d/elixir_burgers_gauss_shock_capturing.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* add DOI

---------

Co-authored-by: Hendrik Ranocha <mail@ranocha.de>
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
@jlchan
Copy link
Contributor Author

jlchan commented May 7, 2024

Superceded by #1932

@jlchan jlchan closed this May 7, 2024
auto-merge was automatically disabled May 7, 2024 15:15

Pull request was closed

ranocha added a commit that referenced this pull request May 7, 2024
* add 1D Gauss tensor product functionality

* add 1D kronecker product fallback

* add Burgers' shock capturing example

* add test

* format

* Update examples/dgmulti_1d/elixir_burgers_gauss_shock_capturing.jl



* add DOI

---------

Co-authored-by: Hendrik Ranocha <mail@ranocha.de>
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
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