Skip to content
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.

Sign up for GitHub

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

Enhancement cmesh trees data layout description #905

Merged
merged 4 commits into from
Jan 29, 2024
Merged

Enhancement cmesh trees data layout description #905

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
878e17f
improve description of data layout for cmesh_trees
lukasdreyer Feb 17, 2023
50dd8b6
Merge branch 'main' into enhancement-cmesh_trees_data_layout_description
lukasdreyer Jan 29, 2024
fdd1a95
Add documentation
lukasdreyer Jan 29, 2024
6597b55
Update src/t8_cmesh/t8_cmesh_trees.h
lukasdreyer Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions src/t8_cmesh/t8_cmesh_trees.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ T8_EXTERN_C_BEGIN ();
*
* Tree faces:
*
* The data of Tree faces looks for each tree:
* For each tree the data of the tree faces (where F is the number of faces of the tree) looks like this:
*
* | Treeid1 Treeid2 ... | ttf1 ttf2 ... | padding |
* | Treeid1 Treeid2 ... TreeidF | ttf1 ttf2 ... ttfN | padding |
*
* Where padding is a number of unused bytes that makes the whole block a multiple
* of 4 Bytes.
Expand All @@ -80,7 +80,7 @@ T8_EXTERN_C_BEGIN ();
*
* Ghost faces:
*
* | Treeid1 Treeid2 ... | ttf1 ttf2 ... | padding |
* | Treeid1 Treeid2 ... TreeidF | ttf1 ttf2 ... ttfF | padding |
*
* Where padding is a number of unused bytes that makes the whole block a multiple
* of sizeof (void*) Bytes.
Expand All @@ -90,14 +90,15 @@ T8_EXTERN_C_BEGIN ();
* class of the tree.
* Tree attributes:
*
* The data of Tree attributes looks like:
* The data of Tree attributes looks like, where N is the total number of attributes:
* The Attributes do not necessarily need to be sorted in a particular way, as they are
* accessed by offsets in the Att_descr.
*
* TODO: This description seems incomplete. Why is it not Attij_data?
*
* | Att00_descr | Att01_descr | ... | Att10_descr | ... | Attrend_descr | Att1_data | Att2_data | ... |
* | Att00_descr | Att01_descr | ... Att0 A_0_descr| Att10_descr | ... | AttrT A_T | Att0_data | Att2_data | ... AttN_data|
* TODO: maybe insert padding here ||
* Where Attij_descr is a descriptor of the j-th attribute data of tree i storing
* - an offset to Atti_data starting from Atti0_descr
* - an offset to Attk_data starting from Attij_descr, where k is the index in the dataarray.
* The actual data is put there in the order of the attribute descriptors, but this is not necessitated by the layout.
* - package id of the attribute (int)
* - key of the attribute (int)
* The data type is t8_attribute_info_struct_t
Expand Down