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

HLLE CEE 2D3D NonCartesian Meshes #1692

Merged

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Oct 27, 2023

This is an intermediate step towards HLLC on noncartesian meshes and is helpful for e.g. showcasing how to do the Roe averages right.
Essentially we have this already for e.g. SWE:

@inline function min_max_speed_einfeldt(u_ll, u_rr, normal_direction::AbstractVector,
equations::ShallowWaterEquations2D)
h_ll = waterheight(u_ll, equations)
v1_ll, v2_ll = velocity(u_ll, equations)
h_rr = waterheight(u_rr, equations)
v1_rr, v2_rr = velocity(u_rr, equations)
norm_ = norm(normal_direction)
c_ll = sqrt(equations.gravity * h_ll) * norm_
c_rr = sqrt(equations.gravity * h_rr) * norm_
v_normal_ll = (v1_ll * normal_direction[1] + v2_ll * normal_direction[2])
v_normal_rr = (v1_rr * normal_direction[1] + v2_rr * normal_direction[2])
v_roe, c_roe = calc_wavespeed_roe(u_ll, u_rr, normal_direction, equations)
λ_min = min(v_normal_ll - c_ll, v_roe - c_roe)
λ_max = max(v_normal_rr + c_rr, v_roe + c_roe)
return λ_min, λ_max
end

@inline function calc_wavespeed_roe(u_ll, u_rr, normal_direction::AbstractVector,
equations::ShallowWaterEquations2D)
h_ll = waterheight(u_ll, equations)
v1_ll, v2_ll = velocity(u_ll, equations)
h_rr = waterheight(u_rr, equations)
v1_rr, v2_rr = velocity(u_rr, equations)
norm_ = norm(normal_direction)
h_roe = 0.5 * (h_ll + h_rr)
c_roe = sqrt(equations.gravity * h_roe) * norm_
h_ll_sqrt = sqrt(h_ll)
h_rr_sqrt = sqrt(h_rr)
v1_roe = (h_ll_sqrt * v1_ll + h_rr_sqrt * v1_rr) / (h_ll_sqrt + h_rr_sqrt)
v2_roe = (h_ll_sqrt * v2_ll + h_rr_sqrt * v2_rr) / (h_ll_sqrt + h_rr_sqrt)
v_roe = (v1_roe * normal_direction[1] + v2_roe * normal_direction[2])
return v_roe, c_roe
end

and I generalized from there.

@github-actions
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 marked this pull request as ready for review October 27, 2023 08:10
test/test_unit.jl Outdated Show resolved Hide resolved
test/test_unit.jl Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (61c33b0) 94.25% compared to head (c34dc6e) 83.59%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1692       +/-   ##
===========================================
- Coverage   94.25%   83.59%   -10.66%     
===========================================
  Files         431      431               
  Lines       34690    34668       -22     
===========================================
- Hits        32694    28979     -3715     
- Misses       1996     5689     +3693     
Flag Coverage Δ
unittests 83.59% <100.00%> (-10.66%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/Trixi.jl 43.48% <ø> (ø)
src/equations/compressible_euler_1d.jl 52.24% <100.00%> (-45.12%) ⬇️
src/equations/compressible_euler_2d.jl 97.54% <100.00%> (+0.46%) ⬆️
src/equations/compressible_euler_3d.jl 97.95% <100.00%> (+0.91%) ⬆️

... and 109 files with indirect coverage changes

☔ 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.

Thanks for the contribution! Is this technically an HLL flux such that we basically only need to provide an min_max_speed_einfeldt similar to min_max_speed_davis?

@DanielDoehring
Copy link
Contributor Author

Yes exactly, it is a HLL-type 2 wave solver. See #1545 and #1525 for a discussion on that.

@ranocha
Copy link
Member

ranocha commented Oct 28, 2023

Can't we use the same approach as with the Davis estimates to just provide the wave speed estimates in a new function and let the generic FluxHLL implementation handle the construction of the fluxes based thereon?

@DanielDoehring
Copy link
Contributor Author

DanielDoehring commented Oct 28, 2023

Can't we use the same approach as with the Davis estimates to just provide the wave speed estimates in a new function and let the generic FluxHLL implementation handle the construction of the fluxes based thereon?

Absolutely, I think this would a good idea in terms of Code consistency, made the concept clearer and also shorten the code.

Since no elixirs use hlle this would also be no breaking change.

@ranocha
Copy link
Member

ranocha commented Oct 30, 2023

I guess we should also use the same pattern we use for flux_hll - define a flux_hlle based on the FluxHLL with the appropriate wave speed estimates. That would be fully backwards compatible and allows re-using the wave speed estimates elsewhere.

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! I think we are close to the last iteration.

src/Trixi.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_1d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_3d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_3d.jl Outdated Show resolved Hide resolved
test/test_unit.jl Outdated Show resolved Hide resolved
test/test_unit.jl Outdated Show resolved Hide resolved
test/test_unit.jl Outdated Show resolved Hide resolved
test/test_unit.jl Outdated Show resolved Hide resolved
test/test_p4est_3d.jl Outdated Show resolved Hide resolved
@ranocha ranocha enabled auto-merge (squash) October 31, 2023 15:15
@DanielDoehring DanielDoehring removed the request for review from andrewwinters5000 November 1, 2023 11:20
@ranocha ranocha disabled auto-merge November 1, 2023 14:41
@ranocha ranocha merged commit c438d34 into trixi-framework:main Nov 1, 2023
28 of 29 checks passed
@DanielDoehring DanielDoehring deleted the HLLE_CEE_2D3D_NonCartesian branch November 1, 2023 16:01
bennibolm added a commit to bennibolm/Trixi.jl that referenced this pull request Nov 6, 2023
* Revise bounds check for MCL

* Rename `idp_bounds_delta` for MCL to `mcl_bounds_delta`

* Remove comment

* Fix allocs (trixi-framework#1695)

* Fix allocs

* remove unnecessary code

* rerun fmt

* format

* Allocation tests dgmulti 2d (trixi-framework#1698)

* HLLE CEE 2D3D NonCartesian Meshes (trixi-framework#1692)

* HLLE CEE 2D3D NonCartesian Meshes

* format

* hlle via hll

* format test

* format test

* format

* do not export hlle

* Correct test vals

* test values CI

* Update src/equations/compressible_euler_2d.jl

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update src/equations/compressible_euler_1d.jl

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update src/equations/compressible_euler_2d.jl

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update src/equations/compressible_euler_3d.jl

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update src/equations/compressible_euler_3d.jl

Co-authored-by: Hendrik Ranocha <[email protected]>

* apply suggestions

* additional sentence

* Fix typo

* typos

* correct test vals

---------

Co-authored-by: Hendrik Ranocha <[email protected]>

* Bump crate-ci/typos from 1.16.15 to 1.16.21 (trixi-framework#1700)

Bumps [crate-ci/typos](https://github.com/crate-ci/typos) from 1.16.15 to 1.16.21.
- [Release notes](https://github.com/crate-ci/typos/releases)
- [Changelog](https://github.com/crate-ci/typos/blob/master/CHANGELOG.md)
- [Commits](crate-ci/typos@v1.16.15...v1.16.21)

---
updated-dependencies:
- dependency-name: crate-ci/typos
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add NumFOCUS + ACTRIX to acknowledgments (trixi-framework#1697)

* Add NumFOCUS + ACTRIX to acknowledgments

* Try to avoid spaces

* Another try to avoid gaps between images

* Hopefully fix image alignment in docs

* Try new logo formats

* Use smaller DUBS logo and add DUBS funding statement

* Add markdown-based table for logos in docs

* Try another table approach

* Hopefully get a layout that finally *works*...

* Arrrrrrgggggghhhhh

* format examples (trixi-framework#1531)

* format examples

* check formatting of examples in CI

* update style guide

* fix weird formatting

* fix formatting of binary operators

* format again

* Update differentiable_programming.jl (trixi-framework#1704)

* Format subcell elixirs

* Add warning for missing bounds check for entropy limiter (MCL)

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Daniel Doehring <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Co-authored-by: ArseniyKholod <[email protected]>
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