Skip to content

Improvement: Rename variables from t to element in t8 scheme default#1864

Merged
Davknapp merged 3 commits into1749-fix-t8_default_scheme-documentationfrom
rename-variables-in-t8_scheme-default
Sep 18, 2025
Merged

Improvement: Rename variables from t to element in t8 scheme default#1864
Davknapp merged 3 commits into1749-fix-t8_default_scheme-documentationfrom
rename-variables-in-t8_scheme-default

Conversation

@lenaploetzke
Copy link
Collaborator

@lenaploetzke lenaploetzke commented Sep 17, 2025

Describe your changes here:
Closes #1861
Rename variables from t to element in t8 scheme default. Additionally, this makes the variable naming of some functions in the .hxx and .cxx files consistent.
Hope that i catched all t's.

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

All these boxes must be checked by the REVIEWERS before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually.
  • The code follows the t8code coding guidelines.
  • New source/header files are properly added to the CMake files.
  • The code is well documented. In particular, all function declarations, structs/classes and their members have a proper doxygen documentation.
  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue).

Tests

  • The code is covered in an existing or new test case using Google Test.
  • The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

  • Should this use case be added to the github action?
  • If not, does the specific use case compile and all tests pass (check manually).

Scripts and Wiki

  • If a new directory with source files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example or tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one).

@lenaploetzke lenaploetzke changed the base branch from main to 1749-fix-t8_default_scheme-documentation September 17, 2025 12:16
@codecov
Copy link

codecov bot commented Sep 17, 2025

Codecov Report

❌ Patch coverage is 90.33079% with 38 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.41%. Comparing base (2c5eaa4) to head (f89bccf).
⚠️ Report is 4 commits behind head on 1749-fix-t8_default_scheme-documentation.

Files with missing lines Patch % Lines
...8_schemes/t8_default/t8_default_tri/t8_dtri_bits.c 89.47% 30 Missing ⚠️
...s/t8_default/t8_default_prism/t8_default_prism.cxx 50.00% 3 Missing ⚠️
..._default/t8_default_pyramid/t8_default_pyramid.cxx 66.66% 3 Missing ⚠️
...t8_default/t8_default_common/t8_default_common.hxx 0.00% 2 Missing ⚠️
Additional details and impacted files
@@                             Coverage Diff                              @@
##           1749-fix-t8_default_scheme-documentation    #1864      +/-   ##
============================================================================
- Coverage                                     74.41%   74.41%   -0.01%     
============================================================================
  Files                                           101      101              
  Lines                                         19197    19192       -5     
============================================================================
- Hits                                          14286    14282       -4     
+ Misses                                         4911     4910       -1     

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

@Davknapp
Copy link
Collaborator

Thanks a lot for upgrading the names!

@Davknapp Davknapp merged commit ee8c17b into 1749-fix-t8_default_scheme-documentation Sep 18, 2025
24 checks passed
@Davknapp Davknapp deleted the rename-variables-in-t8_scheme-default branch September 18, 2025 07:16
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.

Rename variables in t8_schemes/t8_default from t to elem

2 participants