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

Deprecate some DGMultiMesh constructors #1709

Merged

Conversation

jlchan
Copy link
Contributor

@jlchan jlchan commented Nov 6, 2023

One deprecated DGMultiMesh constructor remains:

# TODO: deprecations introduced in Trixi.jl v0.6
@deprecate DGMultiMesh(dg::DGMulti{NDIMS}; cells_per_dimension, kwargs...) where {NDIMS} DGMultiMesh(dg,
                                                                                                     cells_per_dimension;
                                                                                                     kwargs...)

However, since this was deprecated in the v0.5 lifecycle, I didn't remove it. Should it be removed, or should we leave this until v0.7?

Copy link
Contributor

github-actions bot commented Nov 6, 2023

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 Nov 6, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c79fa43) 72.65% compared to head (6b03020) 75.13%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1709      +/-   ##
==========================================
+ Coverage   72.65%   75.13%   +2.48%     
==========================================
  Files         431      431              
  Lines       34637    34657      +20     
==========================================
+ Hits        25164    26039     +875     
+ Misses       9473     8618     -855     
Flag Coverage Δ
unittests 75.13% <ø> (+2.48%) ⬆️

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

Files Coverage Δ
src/solvers/dgmulti/types.jl 98.12% <ø> (ø)

... and 60 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sloede
Copy link
Member

sloede commented Nov 7, 2023

Should it be removed, or should we leave this until v0.7?

I think it's OK to remove it. As the Germans say, we don't need to be more pontifical than the pope. Objections @ranocha @andrewwinters5000?

@andrewwinters5000
Copy link
Member

I think it is okay to remove it as well.

@ranocha
Copy link
Member

ranocha commented Nov 7, 2023

Yes, we can remove it in this breaking change 👍

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!

NEWS.md Outdated Show resolved Hide resolved
@ranocha ranocha changed the base branch from main to v0.6-dev November 7, 2023 06:19
@jlchan
Copy link
Contributor Author

jlchan commented Nov 8, 2023

Merging as per comments on Slack

@jlchan jlchan merged commit 46cc2e5 into trixi-framework:v0.6-dev Nov 8, 2023
21 of 29 checks passed
@sloede sloede mentioned this pull request Nov 9, 2023
2 tasks
ranocha pushed a commit that referenced this pull request Nov 10, 2023
* remove previously deprecated functions

* fix typo in NEWS.md about deprecation vs removal

* fix literate tutorial

* removing other deprecation

* format

* Revert "fix typo in NEWS.md about deprecation vs removal"

This reverts commit 6b03020.
ranocha added a commit that referenced this pull request Nov 10, 2023
* Breaking changes HLL MHD

* format

* format examples

* hlle

* fix

* news, tests, example changes

* fmt

* remove left-right-biased flux from test

* Set version to v0.6.0

* Migrate neural network-based indicators to new repository (#1701)

* Remove all neural network indicator stuff from `src/`

* Migrate neural network tests

* Migrate neural network examples

* Migrate test dependencies

* Update NEWS.md

* Fix typo

* Remove Requires.jl-based use of Flux.jl

* Fix formatting

* Add migration of indicators to section with breaking changes

---------

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

* fix hlle noncartesian 2d

* remove parantheses

* correct test vals

* Make parabolic terms nonexperimental (#1714)

* Make parabolic terms non-experimental

* Make NSE a separate item

* Add MPI to supported features

* Mention that parabolic terms are now officially supported in NEWS.md

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

* Deprecate some `DGMultiMesh` constructors  (#1709)

* remove previously deprecated functions

* fix typo in NEWS.md about deprecation vs removal

* fix literate tutorial

* removing other deprecation

* format

* Revert "fix typo in NEWS.md about deprecation vs removal"

This reverts commit 6b03020.

* add gradient variable type parameter to `AbstractEquationsParabolic` (#1409)

* add gradient variable type parameter

* fix parabolic literate test

* remove trailing comment

* remove unnecessary abstract type

* move gradient variable structs

* formatting

* fix dropped changes

* try to fix doc tests

* fixing navier stokes 1D

* formatting

* remove duplicate GradientVariablesPrimitive/Entropy definition

* update news

* bring downloads back

* fix failing test

* fmt

---------

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
ranocha pushed a commit that referenced this pull request Nov 11, 2023
* remove previously deprecated functions

* fix typo in NEWS.md about deprecation vs removal

* fix literate tutorial

* removing other deprecation

* format

* Revert "fix typo in NEWS.md about deprecation vs removal"

This reverts commit 6b03020.
ranocha added a commit that referenced this pull request Nov 11, 2023
* Breaking changes HLL MHD

* format

* format examples

* hlle

* fix

* news, tests, example changes

* fmt

* remove left-right-biased flux from test

* Set version to v0.6.0

* Migrate neural network-based indicators to new repository (#1701)

* Remove all neural network indicator stuff from `src/`

* Migrate neural network tests

* Migrate neural network examples

* Migrate test dependencies

* Update NEWS.md

* Fix typo

* Remove Requires.jl-based use of Flux.jl

* Fix formatting

* Add migration of indicators to section with breaking changes

---------

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

* fix hlle noncartesian 2d

* remove parantheses

* correct test vals

* Make parabolic terms nonexperimental (#1714)

* Make parabolic terms non-experimental

* Make NSE a separate item

* Add MPI to supported features

* Mention that parabolic terms are now officially supported in NEWS.md

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

* Deprecate some `DGMultiMesh` constructors  (#1709)

* remove previously deprecated functions

* fix typo in NEWS.md about deprecation vs removal

* fix literate tutorial

* removing other deprecation

* format

* Revert "fix typo in NEWS.md about deprecation vs removal"

This reverts commit 6b03020.

* add gradient variable type parameter to `AbstractEquationsParabolic` (#1409)

* add gradient variable type parameter

* fix parabolic literate test

* remove trailing comment

* remove unnecessary abstract type

* move gradient variable structs

* formatting

* fix dropped changes

* try to fix doc tests

* fixing navier stokes 1D

* formatting

* remove duplicate GradientVariablesPrimitive/Entropy definition

* update news

* bring downloads back

* fix failing test

* fmt

---------

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants