Skip to content

feat: implements healpix geometry#2327

Open
faouziH21 wants to merge 2 commits into
mainfrom
implement-healpix-geometry
Open

feat: implements healpix geometry#2327
faouziH21 wants to merge 2 commits into
mainfrom
implement-healpix-geometry

Conversation

@faouziH21
Copy link
Copy Markdown
Collaborator

@faouziH21 faouziH21 commented May 21, 2026

Closes #2329

Describe your changes here:

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. Make sure to add a file documentation for each file!
  • README.md files are updated if necessary.
  • 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 scripts/internal/find_all_source_files.sh 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).

@faouziH21 faouziH21 requested a review from Davknapp May 21, 2026 12:34
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

❌ Patch coverage is 0% with 125 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.02%. Comparing base (c1a2993) to head (06586f8).
⚠️ Report is 520 commits behind head on main.

Files with missing lines Patch % Lines
src/t8_cmesh/t8_cmesh_healpix/t8_cmesh_healpix.cxx 0.00% 83 Missing ⚠️
.../t8_cmesh/t8_cmesh_healpix/t8_geometry_healpix.cxx 0.00% 28 Missing ⚠️
.../t8_cmesh/t8_cmesh_healpix/t8_geometry_healpix.hxx 0.00% 14 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2327      +/-   ##
==========================================
+ Coverage   78.45%   82.02%   +3.57%     
==========================================
  Files         115      119       +4     
  Lines       19184    18678     -506     
==========================================
+ Hits        15050    15320     +270     
+ Misses       4134     3358     -776     

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

Copy link
Copy Markdown
Collaborator

@Davknapp Davknapp 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 addition! Please address my comments. I am looking forward to merge it!

t8code is a C library to manage a collection (a forest) of multiple
connected adaptive space-trees of general element classes in parallel.

Copyright (C) 2015 the developers
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Copyright (C) 2015 the developers
Copyright (C) 2026 the developers

}

const double phi = M_PI / 2;
std::vector<double> coords(3);
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
std::vector<double> coords(3);
std::array<double, 3> coords = { ... };

Bei coords kannst du dann noch die entsprechenden Berechnungen einfügen.

#include <t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx>
#include <t8_cmesh/t8_cmesh_healpix/t8_geometry_healpix.hxx>

std::vector<double> getCoordsUpperRing(int k) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
std::vector<double> getCoordsUpperRing(int k) {
constexpr
std::array<double, 3> getCoordsUpperRing(const int k) {

Dokumentier die Funktion noch bitte. Kannst du für "k" einen besseren Namen nutzen?

return coords;
}

std::vector<double> getCoordsBottomRing (int k){
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
std::vector<double> getCoordsBottomRing (int k){
constexpr
std::array<double, 3> getCoordsBottomRing (const int k){

Hier auch: Dokumentation und einen besseren Namen.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bitte pflege die anderen Änderungen auch hier und in getCoordsEquator ein

connected adaptive space-trees of general element classes in parallel.

Copyright (C) 2026 the developers
Copyright (C) 2015 the developers
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Copyright (C) 2015 the developers
Copyright (C) 2026 the developers

const int ntrees = 12;
const int nverts = 4; /* Number of vertices per cmesh element. */
std::vector <double> verts;
t8_eclass_t *all_eclasses = T8_ALLOC (t8_eclass_t, ntrees);
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The eclasses are already known, so you could either use an std::array or plain c-style array.

t8_cmesh_set_tree_class (cmesh, itree, T8_ECLASS_QUAD);
all_eclasses[itree] = T8_ECLASS_QUAD;
}
std::vector <double> northPole = {0,0,1};
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use a std::array for the north- and southpole?

int itree = 0;
// every side section has 4 quads, this builds the upper layer
// build upper section
for (int k = 0; k < 4; k++) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a more descriptive name than k.

}

// build middle section
for (int k = 0; k < 4; k++) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a more descriptive name than k.

}

// build lower section
for (int k = 0; k < 4; k++) {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a more descriptive name than k.

@Davknapp
Copy link
Copy Markdown
Collaborator

Please use our indentation script to fix the indentation. Also have a look at the output of the doxygen check to see which functions need documentation.

@Davknapp Davknapp assigned Davknapp and faouziH21 and unassigned Davknapp May 21, 2026
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.

feat: implements healpix geometry

2 participants