Documentation: README files /src and /src/t8_cmesh #1855
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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||
| # t8code/src | ||||||
|
|
||||||
| This folder contains the main source code of t8code. | ||||||
|
|
||||||
| Here is an overview over the different modules: | ||||||
|
|
||||||
| ### [src](https://github.com/DLR-AMR/t8code/tree/main/src) | ||||||
|
|
||||||
| The main source folder, it holds main header files like [t8.h](https://github.com/DLR-AMR/t8code/blob/main/src/t8.h), [t8_cmesh.hxx](https://github.com/DLR-AMR/t8code/blob/main/src/t8_cmesh.hxx) and more. | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| #### [src/t8_cmesh](https://github.com/DLR-AMR/t8code/tree/main/src/t8_cmesh) | ||||||
|
|
||||||
| Contains implementation details of algorithms and data structures related to the coarse mesh. | ||||||
| See [cmesh README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_cmesh/README) and the tutorial about coarse meshes: [Creating a coarse mesh](https://github.com/DLR-AMR/t8code/wiki/Step-1---Creating-a-coarse-mesh) | ||||||
| and [Building a Cmesh by hand](https://github.com/DLR-AMR/t8code/wiki/Building-a-Cmesh-by-hand). | ||||||
|
|
||||||
| #### [src/t8_data](https://github.com/DLR-AMR/t8code/tree/feature-folder_README/src/t8_data) | ||||||
|
|
||||||
| Contains data handling classes and algorithms related to data containers, including arrays to handle element data. | ||||||
| See [data README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_data/README) | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| #### [src/t8_forest](https://github.com/DLR-AMR/t8code/tree/main/src/t8_forest) | ||||||
|
|
||||||
| Contains implemenation details of algorithms and data structures related to the forest, i.e. the actual computational mesh. | ||||||
holke marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| See [forest README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_forest/README) and the tutorials, [Step 2](https://github.com/DLR-AMR/t8code/wiki/Step-2---Creating-a-uniform-forest), [Step 3](https://github.com/DLR-AMR/t8code/wiki/Step-3---Adapting-a-forest), [Step 4](https://github.com/DLR-AMR/t8code/wiki/Step-3---Adapting-a-forest). | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| #### [src/t8_geometry](https://github.com/DLR-AMR/t8code/tree/main/src/t8_geometry) | ||||||
|
|
||||||
| Contains data handling classes and algorithms for geometry handling, i.e. mapping the elements into a physical domain space. | ||||||
| See [geometry README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_geometry/README) and the tutorial [Curved Meshes](https://github.com/DLR-AMR/t8code/wiki/Feature---Curved-meshes) (note that the geometry also handles linear, non-curved meshes). | ||||||
|
|
||||||
| #### [src/t8_schemes](https://github.com/DLR-AMR/t8code/tree/main/src/t8_schemes) | ||||||
|
|
||||||
| Contains data handling classes and algorithms for schemes. Schemes are the implementation of the space-filling curve for each element shape. | ||||||
| A scheme describes how elements refine, construct their neighbors, etc. | ||||||
| See [scheme README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_schemes/README). | ||||||
|
|
||||||
| #### [src/t8_types](https://github.com/DLR-AMR/t8code/tree/main/src/t8_types) | ||||||
|
|
||||||
| Custom data types and strong types. Also contains t8_vec vector implementation. | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
| See [types README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_schemes/README). | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| #### [src/t8_vector_helper](https://github.com/DLR-AMR/t8code/tree/main/src/t8_vector_helper) | ||||||
|
|
||||||
| Contains specialized algorithms on std::vector in particular `vector_split`. | ||||||
| See [vector helper README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_vector_helper/README). | ||||||
|
|
||||||
| #### [src/t8_vtk](https://github.com/DLR-AMR/t8code/tree/main/src/t8_vtk) | ||||||
|
|
||||||
| Contains algorithms and data structures for the VTK interface. | ||||||
| See [vtk README](https://github.com/DLR-AMR/t8code/tree/main/src/t8_vtk/README). | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||||||
|
|
||||||
|
Collaborator
There was a problem hiding this comment.
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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 @@ | ||
| TODO |
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.
We talked about changing the references to only folder structures (Similar as you did for the cmesh readme in line 14). I think it would be better to use this everywhere instead of this reference to the main branch :)