Improvement: Mesh handle tutorials#2348
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2348 +/- ##
=======================================
Coverage 82.28% 82.28%
=======================================
Files 125 125
Lines 20701 20701
=======================================
Hits 17033 17033
Misses 3668 3668 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
lenaploetzke
left a comment
There was a problem hiding this comment.
Partial review. Thank you for your work, this is really nice and my comments are mainly documentation! :)
| @@ -0,0 +1,138 @@ | |||
| /* | |||
There was a problem hiding this comment.
We should rename this as we try to hide the "forest". Do you have an idea? Also maybe we should write a Readme such that it is clear why this is "step3" although we have no step 1 and 2 in this folder. I removed the "step5" for the other mesh handle tutorial but maybe its good to keep the name but state it clearly in the readme (and link to steps 0-2 there as they are necessary to understand also for the mesh handle)
| * In this example we want to adapt in a spherical shape around a given point. */ | ||
| struct adapt_data | ||
| { | ||
| std::array<double, 3> midpoint; /**< midpoint of our sphere. */ |
There was a problem hiding this comment.
I prefer t8_3D_vec here (which is essentially the same but clearer)
| sc_MPI_Comm comm = sc_MPI_COMM_WORLD; | ||
|
|
||
| /* Print a starting message. */ | ||
| t8_global_productionf (" [tutorial] \n"); |
There was a problem hiding this comment.
We should also think of something different than "tutorial" here. Any ideas?
| t8_global_productionf (" [tutorial] \n"); | ||
| t8_global_productionf (" [tutorial] Writing adapted mesh to vtu file: adapted_mesh.vtu\n"); | ||
| t8_global_productionf (" [tutorial] \n"); | ||
| t8_mesh_handle::write_mesh_to_vtk (*mesh, "adapted_mesh.vtu"); |
There was a problem hiding this comment.
We should also add a step here such that the files are not overridden by the next step. Maybe we can do step_mh3 or smth like this? (for mesh handle). Maybe you have a better idea, i am not fully convinced of my idea.
Co-authored-by: lenaploetzke <70579874+lenaploetzke@users.noreply.github.com>
Describe your changes here:
All these boxes must be checked by the AUTHOR before requesting review:
Documentation:,Bugfix:,Feature:,Improvement:orOther:.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
Tests
If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):
Scripts and Wiki
scripts/internal/find_all_source_files.shto check the indentation of these files.License
doc/(or already has one).