-
Notifications
You must be signed in to change notification settings - Fork 74
Improvement: Added Readme for mesh handle tutorials, wiki links still missing. #2372
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Vyp3er
wants to merge
10
commits into
DLR-AMR:main
Choose a base branch
from
Vyp3er:mesh_handle_tutorial_readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+37
−1
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d06077d
Added Readme for mesh handle tutorials, wiki links still missing.
baa202a
Fixed spelling and added references to the original tutorials/Readme.md.
6c5a1c7
Fixed Spelling and sentences in both readmes
5b0ed20
Merge branch 'main' into mesh_handle_tutorial_readme
Vyp3er 1a01ae8
Apply suggestions from code review
Vyp3er f44d7a1
Merge remote-tracking branch 'origin/main' into mesh_handle_tutorial_…
dbb2e3c
Solved Merge conflict
3afc630
Merge remote-tracking branch 'Vincent/mesh_handle_tutorial_readme' in…
16cf03b
Apply suggestions from code review
Vyp3er a4672a0
added ../
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -45,4 +45,7 @@ Creating a user defined mesh in two- and three dimensions. | |||||
| A tutorial about the generation of curved adaptive meshes. | ||||||
|
|
||||||
| ## Mesh handle | ||||||
| [mesh_handle_element_data](mesh_handle/t8_mesh_element_data.cxx) Recreating [step5](./general/t8_step5_element_data.cxx) of the general tutorials but using the mesh handle. | ||||||
| [Mesh Handle Tutorials](../tutorials/mesh_handle/README.md) | ||||||
| These tutorials can be followed instead of the general t8code tutorials. They explain working with t8code with the help of the | ||||||
| [mesh_handle](../mesh_handle/README.md) interface. | ||||||
| Please note, that the mesh handle tutorials start at step 2, because steps 0 and 1 are the same as in the general tutorials. Please complete these first and then come back to the [Mesh Handle Tutorial Overview](../tutorials/mesh_handle/README.md) | ||||||
|
Vyp3er marked this conversation as resolved.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Mesh handle tutorials | ||
|
|
||
| This is the tutorial collection for the [mesh_handle](../../mesh_handle/README.md) interface of `t8code`. | ||
|
|
||
| The `mesh handle` interface acts as a bridge between the user and the tree-based t8code library. When using the mesh handle, t8code acts as if it is working with usual unstructured meshes. | ||
| Have a look at the [mesh handle README](../../mesh_handle/README.md) for more information. | ||
|
|
||
| There are corresponding articles for every tutorial in this folder in the [Wiki](https://github.com/DLR-AMR/t8code/wiki/Tutorial---Overview). The article can be used as a step-by-step guide for each tutorial. | ||
|
|
||
| Please note, that the mesh handle tutorials start at step 2. This is because [step0](https://github.com/DLR-AMR/t8code/wiki/Step-0---Hello-World) and [step1](https://github.com/DLR-AMR/t8code/wiki/Step-1---Creating-a-coarse-mesh) are identical to the [general t8code tutorials](../general). Complete these steps before switching to the mesh handle tutorials. | ||
|
|
||
| ## Steps | ||
|
|
||
| [step0](https://github.com/DLR-AMR/t8code/wiki/Step-0---Hello-World) - | ||
| Initialize t8code and print a welcome message. | ||
|
|
||
| [step1](https://github.com/DLR-AMR/t8code/wiki/Step-1---Creating-a-coarse-mesh) - | ||
| Create a coarse mesh, output it to vtu and destroy it. We need a coarse mesh to initialize our mesh handle mesh. | ||
|
|
||
| [step2] - | ||
| Create a uniform mesh, get its number of local and global elements and output it to vtu. | ||
|
|
||
| [step3] - | ||
| Adapt a mesh according to a user defined criterion. | ||
|
|
||
| [step4] - | ||
| Partitioning, balancing and creating a ghost layer for a mesh. | ||
|
|
||
| [step5](mesh_handle/t8_mesh_step5_element_data.cxx) - | ||
| Associating user data with the elements of a mesh. Exchanging ghost values for element user data. Writing element user data to vtu. | ||
|
|
||
| [stepA] - | ||
| Going into more detail about mesh handle competence packs to use additional features accessible through the mesh handle competence architecture. Explaining element data competences and caching. Creating a custom competence. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks werid in the preview as it is not interpreted as a title. Maybe like this?