updated vertex description in docu

hopr-framework · Nov 22, 2023 · 9db3cea · 9db3cea
1 parent c813fbd
commit 9db3cea
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/docs/documentation/userguide/meshformat.md b/docs/documentation/userguide/meshformat.md
@@ -225,6 +225,18 @@ name: tab:side_info_array
 The **VertexInfo** array includes the `FEMVertexID` of each local element vertex in the same order as the CGNS corners as well as the `offsetIndVertexConnect` and the `lastIndVertexConnect`
 which refer to the corresponding position in the additional **VertexConnectInfo** array. Here, the `nbElemID` as well as the `localNodeID` in the corresponding `nbElemID` are saved. Therefore, the multiplicity is given as `multiplicity = lastIndVertexConnect- offsetIndVertexConnect + 1.`
 
+```{table} Vertex Information
+---
+name: tab:vertex_info
+---
+|               |                                                                                                               |
+|      :---     |                                                      :---                                                     |
+| Name in file: |                                                 **VertexInfo**                                                |
+|     Type:     |                                 INTEGER, Size: Array(1:3,1:**nVertices**$^*$)                                 |
+|  Description: | Vertex array, all information of one element is a set of all element Vertices (CGNS ordering, \rf{fig:CGNS}). |
+|               |    *offsetIndVertex/lastIndVertex* in **ElemInfo** refers to the row index of one set of element Vertices.    |
+```
+
 ```{table} **VertexInfo** array for example mesh with 4 elements.
 ---
 name: tab:vertex_info_array
@@ -249,6 +261,18 @@ name: tab:vertex_info_array
 | 16 |      50     |           28           |          30          |   (lastIndVertex,4)   |
 ```
 
+```{table} VertexConnect Information
+---
+name: tab:vertex_connect_info
+---
+|               |                                                                                                |
+|      :---     |                                              :---                                              |
+| Name in file: |                                      **VertexConnectInfo**                                     |
+|     Type:     |                                  INTEGER, Size: Array(1:2,1:?)                                 |
+|  Description: | Array of connected vertices, all information of one vertex is stored continuously in the range |
+|               |                *offsetIndVertexConnect+1:lastIndVertexConnect* in **VertexInfo**               |
+```
+
 ```{table} **VertexConnecInfo** array for example mesh with 4 elements.
 ---
 name: tab:vertex_connect_info_array