Skip to content

Feature: Feature mesh deformation#2196

Open
Lena-Richter wants to merge 25 commits intomainfrom
feature-mesh_deformation
Open

Feature: Feature mesh deformation#2196
Lena-Richter wants to merge 25 commits intomainfrom
feature-mesh_deformation

Conversation

@Lena-Richter
Copy link
Copy Markdown
Collaborator

@Lena-Richter Lena-Richter commented Mar 2, 2026

Closes #2197

Describe your changes here:
Added mesh deformation support using the new t8_cmesh_mesh_deformation files. This allows moving mesh vertices to new positions defined by a CAD geometry.
The calculation is currently done by focusing on surface vertices and comparing their current locations with the target CAD shape. The displacement for internal vertices is not yet included. A new example, t8_cmesh_mesh_deformation_example.cxx, was added to show how the deformation works.

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

@Lena-Richter Lena-Richter changed the title Feature mesh deformation Feature: Feature mesh deformation Mar 8, 2026
@Lena-Richter Lena-Richter marked this pull request as ready for review March 8, 2026 20:18
@Lena-Richter Lena-Richter marked this pull request as draft March 9, 2026 18:19
@Lena-Richter Lena-Richter marked this pull request as ready for review March 10, 2026 20:00
@Lena-Richter Lena-Richter marked this pull request as draft March 10, 2026 21:06
@Lena-Richter Lena-Richter marked this pull request as ready for review March 12, 2026 19:58
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.42%. Comparing base (3ed7e51) to head (374ecd6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2196   +/-   ##
=======================================
  Coverage   79.42%   79.42%           
=======================================
  Files         115      115           
  Lines       19285    19285           
=======================================
  Hits        15318    15318           
  Misses       3967     3967           

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

@@ -0,0 +1,121 @@
#include <fstream>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please include the license statement and file documentation

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment thread example/cmesh/t8_cmesh_mesh_deformation.cxx
Comment on lines +1 to +17
#include <fstream>
#include <iostream>
#include <string>
#include <algorithm>
#include <t8_cmesh/t8_cmesh.h>
#include <t8_cmesh/t8_cmesh.hxx>
#include <t8_cmesh/t8_cmesh_vertex_connectivity/t8_cmesh_vertex_connectivity.hxx>
#include <t8_cmesh/t8_cmesh_mesh_deformation/t8_cmesh_mesh_deformation.hxx>
#include <t8_schemes/t8_default/t8_default.hxx>
#include <t8_cmesh/t8_cmesh_io/t8_cmesh_readmshfile.h>
#include <t8_cad/t8_cad_handle.hxx>
#include <t8_vtk/t8_vtk_writer.h>
#include <vector>
#include <array>
#include <mpi.h>
#include <unordered_set>
#include <sc_options.h>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do you really need all those includes?
Can you also split them between t8code and std includes?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yup

SC_CHECK_MPI (mpiret);

/* Initialize the sc library, has to happen before we initialize t8code. */
sc_init (sc_MPI_COMM_WORLD, 1, 1, NULL, SC_LP_PRODUCTION);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
sc_init (sc_MPI_COMM_WORLD, 1, 1, NULL, SC_LP_PRODUCTION);
sc_init (sc_MPI_COMM_WORLD, 1, 1, NULL, SC_LP_ESSENTIAL);

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment thread example/cmesh/t8_cmesh_mesh_deformation.cxx
Comment on lines +155 to +157
/** Update the CAD manager with a new one.
* \param[in] new_cad_handle The new CAD handle to be used.
*/
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
/** Update the CAD manager with a new one.
* \param[in] new_cad_handle The new CAD handle to be used.
*/
/** Update the CAD handle with a new one.
* \param[in] new_cad_handle The new CAD handle to be used.
*/

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment thread src/t8_geometry/t8_geometry_handler.hxx
Comment thread src/CMakeLists.txt Outdated
t8_forest/t8_forest_partition_for_coarsening.cxx
t8_forest/t8_forest_pfc_helper.cxx
t8_forest/t8_forest.cxx
t8_forest/t8_forest.cxx
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
t8_forest/t8_forest.cxx
t8_forest/t8_forest.cxx

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

/* Moving plane loop */
while (adapt_data.t < steps) {
/* Adapt and balance the forest.
/* Adapt and balance the forest.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
/* Adapt and balance the forest.
/* Adapt and balance the forest.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment on lines +48 to +50
#include <t8_geometry/t8_geometry_implementations/t8_geometry_cad.hxx> /* Curved geometry calculation of trees */
#include <t8_cmesh/t8_cmesh_mesh_deformation/t8_cmesh_mesh_deformation.hxx> /* Mesh deformation struct */
#include <t8_cad/t8_cad_handle.hxx> /* CAD data structure */
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#include <t8_geometry/t8_geometry_implementations/t8_geometry_cad.hxx> /* Curved geometry calculation of trees */
#include <t8_cmesh/t8_cmesh_mesh_deformation/t8_cmesh_mesh_deformation.hxx> /* Mesh deformation struct */
#include <t8_cad/t8_cad_handle.hxx> /* CAD data structure */
#include <t8_geometry/t8_geometry_implementations/t8_geometry_cad.hxx> /* Curved geometry calculation of trees */

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

okidoki

@sandro-elsweijer sandro-elsweijer removed their assignment Mar 17, 2026
@@ -0,0 +1,156 @@

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

sc_options_destroy (opt);

#else
t8_global_productionf ("\n\t ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n\n");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
t8_global_productionf ("\n\t ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n\n");
t8_global_errorf ("ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n");

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

done

/* Cleanup. */
t8_forest_unref (&forest);

std::cout << "Mesh deformation completed." << std::endl;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
std::cout << "Mesh deformation completed." << std::endl;
t8_global_productionf ("Mesh deformation completed.");

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

okidoki

/* The usage string or help message was truncated */
/* Note: gcc >= 7.1 prints a warning if we
* do not check the return value of snprintf. */
t8_debugf ("Warning: Truncated usage string and help message to '%s' and '%s'\n", usage, help);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
t8_debugf ("Warning: Truncated usage string and help message to '%s' and '%s'\n", usage, help);
t8_debugf ("WARNING: Truncated usage string and help message to '%s' and '%s'\n", usage, help);

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

done

/* Initialize t8code with log level SC_LP_ESSENTIAL. See sc.h for more info on the log levels. */
t8_init (SC_LP_ESSENTIAL);

#ifdef T8CODE_ENABLE_OCC
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#ifdef T8CODE_ENABLE_OCC
#if T8CODE_ENABLE_OCC

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment on lines +86 to +87
int dim = 0;
int level = 2;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The default values are assigned by the options

Suggested change
int dim = 0;
int level = 2;
int dim, level;

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yes

Comment thread src/t8_geometry/t8_geometry_implementations/t8_geometry_cad.hxx
Comment thread src/t8_geometry/t8_geometry_handler.hxx
#if T8CODE_ENABLE_OCC
#include <t8_cad/t8_cad_handle.hxx>
#include <t8_cmesh/t8_cmesh_mesh_deformation/t8_cmesh_mesh_deformation.hxx>
#endif
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#endif
#endif /* T8CODE_ENABLE_OCC */

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

mpiret = sc_MPI_Finalize ();
SC_CHECK_MPI (mpiret);

#else
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#else
#else /* !T8CODE_ENABLE_OCC */

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

okidoki


#else
t8_global_errorf ("ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n\n");
#endif
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
#endif
#endif /* T8CODE_ENABLE_OCC */

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yes

SC_CHECK_MPI (mpiret);

#else
t8_global_errorf ("ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n\n");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
t8_global_errorf ("ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n\n");
t8_global_errorf ("ERROR: This example requires OpenCASCADE support to be enabled in t8code.\n");

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ok

Comment on lines +70 to +88
#if T8_ENABLE_DEBUG
/* Iterate over all trees and compare to the reference tree. */
for (const auto &[tree_id, local_corner_index] : tree_list) {

const int *geom_attribute = static_cast<const int *> (
t8_cmesh_get_attribute (associated_cmesh, t8_get_package_id (), T8_CMESH_NODE_GEOMETRY_ATTRIBUTE_KEY, tree_id));

const int entity_dim = geom_attribute[2 * local_corner_index];
const int entity_tag = geom_attribute[2 * local_corner_index + 1];

/* Check if the attribute of the vertex is the same in all trees. */
if (!(entity_dim == first_tree_entity_dim && entity_tag == first_tree_entity_tag)) {
t8_errorf (
"Error: Inconsistent entity info for global vertex %li: tree %d: dim=%d tag=%d, expected dim=%d tag=%d\n",
global_vertex_id, tree_id, entity_dim, entity_tag, first_tree_entity_dim, first_tree_entity_tag);
SC_ABORTF ("Inconsistency in vertex info.\n");
}
}
#endif /*T8_ENABLE_DEBUG */
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you add a comment at the start explaining what this check does?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

yup

Copy link
Copy Markdown
Member

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

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

almost there!

Comment on lines +81 to +82
/* Initialize t8code with log level SC_LP_ESSENTIAL. See sc.h for more info on the log levels. */
t8_init (SC_LP_ESSENTIAL);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

With this log level your t8_productionf prints wont work.

Suggested change
/* Initialize t8code with log level SC_LP_ESSENTIAL. See sc.h for more info on the log levels. */
t8_init (SC_LP_ESSENTIAL);
/* Initialize t8code with log level SC_LP_PRODUCTION. See sc.h for more info on the log levels. */
t8_init (SC_LP_PRODUCTION);

t8_global_errorf ("ERROR: Invalid mesh dimension: dim=%d. Dimension must be 1, 2 or 3.\n\n", dim);
sc_options_print_usage (t8_get_package_id (), SC_LP_ERROR, opt, NULL);
}
else if (parsed >= 0) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What would happen if parsed was -1? The program would terminate and the user has no clue why

Suggested change
else if (parsed >= 0) {
else {

t8_global_productionf ("%s\n", help);
sc_options_print_usage (t8_get_package_id (), SC_LP_ERROR, opt, NULL);
}
else if (msh_file == NULL || brep_file == NULL || dim == 0) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

if the user provides unknown options this also is a wrong usage

Suggested change
else if (msh_file == NULL || brep_file == NULL || dim == 0) {
else if (msh_file == NULL || brep_file == NULL || dim == 0 || parsed >= 0) {

sc_options_print_usage (t8_get_package_id (), SC_LP_ERROR, opt, NULL);
}
else if (msh_file == NULL || brep_file == NULL || dim == 0) {
t8_global_errorf ("ERROR: Missing required arguments: -m, -b, and -d are mandatory.\n\n");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We would have to keep this list updated twice, once in the options and once in this message. But the list is also in the usage you print in the next line

Suggested change
t8_global_errorf ("ERROR: Missing required arguments: -m, -b, and -d are mandatory.\n\n");
t8_global_errorf ("\n\t ERROR: Wrong usage.\n\n");

/* Check if the coordinates are available. */
if (old_coords == nullptr) {
t8_errorf ("Error: Coordinates attribute missing for tree %d\n.", first_tree_id);
SC_ABORTF ("Vertex coordinates are missing.");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
SC_ABORTF ("Vertex coordinates are missing.");
SC_ABORTF ("Vertex coordinates are missing.\n");

/* Check if the (u,v)-parameters are available. */
if (uv_attribute == nullptr) {
t8_errorf ("Error: (u,v)-parameters are missing for tree %d\n.", first_tree_id);
SC_ABORT ("(u,v)-parameters are missing.");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
SC_ABORT ("(u,v)-parameters are missing.");
SC_ABORT ("(u,v)-parameters are missing.\n");

/* Check if the geometry attribute is available for this tree. */
if (first_tree_geom_attribute == nullptr) {
t8_errorf ("Error: Geometry attribute missing for tree %d\n.", first_tree_id);
SC_ABORTF ("Geometry attribute is missing.");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
SC_ABORTF ("Geometry attribute is missing.");
SC_ABORTF ("Geometry attribute is missing.\n");

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.

Feature mesh deformation

2 participants