Skip to content

remove n_cells_max argument from TreeMesh constructor#3021

Draft
ranocha wants to merge 4 commits into
mainfrom
hr/remove_n_cells_max
Draft

remove n_cells_max argument from TreeMesh constructor#3021
ranocha wants to merge 4 commits into
mainfrom
hr/remove_n_cells_max

Conversation

@ranocha
Copy link
Copy Markdown
Member

@ranocha ranocha commented May 19, 2026

This is a follow-up to #3010; here, I removed n_cells_max completely (as a breaking change).

This PR was created with the help of AI tools but supervised and reviewed by me.

TODO

  • Update Trixi2Vtk.jl
  • Update TrixiShallowWater.jl

@ranocha ranocha added breaking refactoring Refactoring code without functional changes labels May 19, 2026
@github-actions
Copy link
Copy Markdown
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.

Comment thread src/meshes/tree_mesh.jl Outdated
Comment thread test/test_unit.jl Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.10%. Comparing base (4eb6a6b) to head (fe0f791).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3021   +/-   ##
=======================================
  Coverage   97.10%   97.10%           
=======================================
  Files         630      630           
  Lines       48851    48825   -26     
=======================================
- Hits        47434    47411   -23     
+ Misses       1417     1414    -3     
Flag Coverage Δ
unittests 97.10% <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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ranocha ranocha mentioned this pull request May 19, 2026
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking refactoring Refactoring code without functional changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant