Mesh competence tutorial by Vyp3er · Pull Request #2370 · DLR-AMR/t8code

Vyp3er · 2026-07-20T11:03:11Z

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

…rientation

codecov · 2026-07-20T11:51:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.28%. Comparing base (66cd94f) to head (744a0ab).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2370   +/-   ##
=======================================
  Coverage   82.28%   82.28%           
=======================================
  Files         125      125           
  Lines       20701    20701           
=======================================
  Hits        17033    17033           
  Misses       3668     3668

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

lenaploetzke

Nice tutorial! Maybe a bit more of explanation would help :)

lenaploetzke · 2026-07-27T10:42:39Z

+
+if( T8CODE_BUILD_MESH_HANDLE )
+    add_mesh_handle_tutorial( NAME t8_mesh_step3_adapt_forest SOURCES mesh_handle/t8_mesh_step3_adapt_forest.cxx )
+endif()
+
+if( T8CODE_BUILD_MESH_HANDLE )
+    add_mesh_handle_tutorial( NAME t8_mesh_step4_partition_balance_ghost SOURCES mesh_handle/t8_mesh_step4_partition_balance_ghost.cxx )
+endif()


lenaploetzke · 2026-07-27T10:42:55Z

+  t8code is a C library to manage a collection (a forest) of multiple
+  connected adaptive space-trees of general element types in parallel.
+
+  Copyright (C) 2015 the developers


lenaploetzke · 2026-07-27T10:43:28Z

@@ -0,0 +1,227 @@
+/*


As stated in the README Pr, we should maybe assign to this tutorial also a step (maybe step A??)

lenaploetzke · 2026-07-27T10:43:40Z

+  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*/
+
+/** \file t8_mesh_step3_adapt_forest.cxx


lenaploetzke · 2026-07-27T10:48:36Z

+*/
+
+/** \file t8_mesh_step3_adapt_forest.cxx
+ * This tutorial will explain the the use of competences native to the mesh_handle while explaining the already given competences but also going deeper in how to


Please explain what competences can be used for here and why they are cool for the mesh handle

lenaploetzke · 2026-07-27T11:41:07Z

+  t8_global_productionf (" [tutorial] \n");
+
+  demonstrate_cache_competences (*default_mesh->cbegin ()); /**< Calling the cache competence function defined above. */
+


Maybe you write a short exlaination here what is happening next: We now define a second mesh to demonstrate a user defined competence.

lenaploetzke · 2026-07-27T11:41:50Z

+
+  /* Defining a competence pack with the volume cache competence and our custom defined competence. */
+  using custom_element_competences = element_competence_pack<cache_volume,    /**< Volume cache competence. */
+                                                             volume_squared>; /**< Our custom competence. */


Maybe its cool if you also name it volume_squared_custom_competence or so? Then you would not need both comments

lenaploetzke · 2026-07-27T11:42:14Z

+
+  t8_global_productionf (" [tutorial] \n");
+  t8_global_productionf (
+    " [tutorial] Creating a custom mesh for the custom competence with initial refinement level of 2.\n");


Same as above

lenaploetzke · 2026-07-27T11:42:26Z

+  /* Creating a custom mesh with the mesh_type including our custom competence pack and the initial refinement level 2. */
+  auto custom = handle_hypercube_hybrid_uniform_default<custom_mesh> (level, comm, false, false);
+
+  custom->commit (); /**< Committing the custom mesh. */


lenaploetzke · 2026-07-27T11:42:40Z

+  t8_global_productionf (" [tutorial] Demonstrating the custom competence 'Squared Value'.\n");
+  t8_global_productionf (" [tutorial] \n");
+
+  demonstrate_custom_competence (*custom); /**< Calling the custom competence function defined above. */


Suggested change

demonstrate_custom_competence (*custom); /**< Calling the custom competence function defined above. */

demonstrate_custom_competence (*custom);

Schmitt and others added 12 commits June 19, 2026 09:37

First Changes and File Creation

05c741b

Spellchecking correct

53199cb

Mesh_handle_tutorial Step3

665d24c

Mesh_handle_tutorial Step3

9523fc5

Mesh_handle_tutorial Step3 fixed and Step4 added.

604e003

added bsd license

282f592

Merge remote-tracking branch 'origin/main' into mesh_handle_tutorials

9f7696b

spell checking corrected

bd84430

Added get_reference_coordinates, element_is_equal, forest_leaf_face_o…

4042c00

…rientation

Added a tutorial to demonstrate the core competences of the mesh handle.

e796ce3

deleted unnecessary files.

6ac480e

Merge branch 'main' into mesh_competence_tutorial

744a0ab

Vyp3er marked this pull request as ready for review July 20, 2026 11:33

lenaploetzke self-requested a review July 20, 2026 12:14

lenaploetzke self-assigned this Jul 21, 2026

lenaploetzke requested changes Jul 27, 2026

View reviewed changes

lenaploetzke assigned Vyp3er and unassigned lenaploetzke Jul 27, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Mesh competence tutorial - #2370

Mesh competence tutorial#2370
Vyp3er wants to merge 12 commits into
DLR-AMR:mainfrom
Vyp3er:mesh_competence_tutorial

Vyp3er commented Jul 20, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Jul 20, 2026

Uh oh!

lenaploetzke left a comment

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

lenaploetzke Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		t8_global_productionf (" [tutorial] \n");

		demonstrate_cache_competences (default_mesh->cbegin ()); /< Calling the cache competence function defined above. /

	demonstrate_custom_competence (custom); /< Calling the custom competence function defined above. /
	demonstrate_custom_competence (*custom);

Uh oh!

Conversation

Vyp3er commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

General

Tests

Scripts and Wiki

License

Uh oh!

codecov Bot commented Jul 20, 2026

Codecov Report

Uh oh!

lenaploetzke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Vyp3er commented Jul 20, 2026 •

edited

Loading