t8code icon indicating copy to clipboard operation
t8code copied to clipboard

Feature: Very first version of the unstructured mesh interface

Open lenaploetzke opened this issue 4 months ago • 2 comments

Describe your changes here:

Closes #1655 This PR implements the very basic structure of the unstructured mesh interface. It provides only the level variable. Other variables should be implemented in future PRs.

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

  • [x] The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • [x] The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • [x] If the PR is related to an issue, make sure to link it.
  • [x] 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 avatar Aug 12 '25 07:08 lenaploetzke

Codecov Report

:x: Patch coverage is 98.63014% with 1 line in your changes missing coverage. Please review. :white_check_mark: Project coverage is 76.60%. Comparing base (41a06b6) to head (5147546).

Files with missing lines Patch % Lines
api/t8_mesh_handle/mesh.hxx 96.15% 1 Missing :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1829      +/-   ##
==========================================
+ Coverage   76.52%   76.60%   +0.08%     
==========================================
  Files         106      109       +3     
  Lines       18655    18728      +73     
==========================================
+ Hits        14275    14347      +72     
- Misses       4380     4381       +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Aug 12 '25 09:08 codecov[bot]

For me, the APIs of t8code are the C, Fortran, Python... APIs. So interfaces to different programming languages. The mesh handle is more like a part of the actual library and less a separate API. At least it is different than the language APIs. So I would either put it in src or create a whole new folder. For me at least it does not fit in the api folder

sandro-elsweijer avatar Nov 12 '25 13:11 sandro-elsweijer

For me, the APIs of t8code are the C, Fortran, Python... APIs. So interfaces to different programming languages. The mesh handle is more like a part of the actual library and less a separate API. At least it is different than the language APIs. So I would either put it in src or create a whole new folder. For me at least it does not fit in the api folder

It does not feel right for me to put the handle in the src folder but i am fine with putting it in its own. The idea was that the mesh handle is an api for other software so i think it is not really wrong in the folder. What do you think @spenke91 ?

lenaploetzke avatar Nov 21 '25 12:11 lenaploetzke