Feature: SFC-Based Tree Indexing

[tunxu]

Closes #2325

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!
• 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).

[codecov]

Codecov Report

❌ Patch coverage is 94.47853% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.95%. Comparing base (bfc4e39) to head (095a340).
⚠️ Report is 211 commits behind head on main.

Files with missing lines	Patch %	Lines
..._cmesh/t8_cmesh_internal/t8_cmesh_tree_reindex.cxx	94.30%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2324      +/-   ##
==========================================
+ Coverage   82.65%   82.95%   +0.30%     
==========================================
  Files         132      140       +8     
  Lines       21515    21747     +232     
==========================================
+ Hits        17783    18040     +257     
+ Misses       3732     3707      -25     

☔ View full report in Codecov by Harness.
📢 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.

[sandro-elsweijer]

std::array

[sandro-elsweijer]

Suggested change

	0.0f);
	0);

[sandro-elsweijer]

Suggested change

	t8_debugf ("starting tree reindexing\n");

[sandro-elsweijer]

this is never used

[sandro-elsweijer]

Suggested change

	t8_debugf ("Computed center for global tree %li: %f, %f, %.f\n", attr->id, center[0], center[1], center[2]);
	}
	t8_debugf ("received local cmesh bounding box\n");
	t8_debugf ("physical bbox bounds: x=[%.17g, %.17g], y=[%.17g, %.17g], z=[%.17g, %.17g]\n", min_coords[0],
	max_coords[0], min_coords[1], max_coords[1], min_coords[2], max_coords[2]);
	}

[sandro-elsweijer]

Suggested change

	const double eps = T8_PRECISION_SQRT_EPS;
	constexpr double eps = T8_PRECISION_SQRT_EPS;