Salome HOME
MEDMEM suppression
[modules/med.git] / doc / doxygen / polygon.dox
1 /*!\page polygon Polyhedra and polygons
2
3 \section polygon_general General information
4
5 The methods described in section \ref mesh do not take into account information about
6   \c polygonal and \c polyhedral cells contained in a MESH object. 
7 Indeed, in the MEDMEM library, the connectivity data for these 
8 elements are stored the same way as connectivity of standard 
9 elements. Therefore, the methods that give access to this data are 
10 same as those of section \ref mesh.
11
12 The polygon and the polyhedra case differ in nature, 
13 because in 3D, the list of nodes is not sufficient 
14 to described the shape of an element. A descending 
15 cell>face>nodes connectivity has to be established 
16 to fully describe the elements. 
17
18 \section polygon_connectivity Polygon connectivity
19
20 Let us consider the case illustrated in figure \ref fig_polygon_connectivity .
21
22 \anchor fig_polygon_connectivity
23 \image html polygon_connectivity_small.png "Example for polygon connectivity"
24 \image latex polygon_connectivity_small.eps "Example for polygon connectivity"
25
26
27 - The connectivity table writes : {2, 6, 7, 3, 3, 7, 8, 4, 1, 2, 3, 4, 5 }
28 - The connectivity index table writes : {1, 5, 9, 14 }
29
30 \section polyhedron_conn Polyhedron connectivity
31
32 For polyhedra, in the nodal connectivity case, 
33 list of nodes does not suffice to describe a general polyhedron;
34 information of connectivity of each face is needed.
35 A general polyhedron is therefore described by a list of nodes of 
36 all faces with -1 as separator between faces.
37
38 Let us consider an example with the two tetrahedra represented on
39 figure \ref fig_polyhedron_connectivity , the left one
40 being stored as a \c MED_TETRA4 element, the right one being stored
41 as a \c MED_POLYHEDRA element.
42
43 \anchor fig_polyhedron_connectivity
44 \image html polyhedron_connectivity_small.png "Example for polyhedron connectivity. Node numbers are written with a normal font, while face numbers are written in italic font."
45 \image latex polyhedron_connectivity_small.eps "Example for polyhedron connectivity. Node numbers are written with a normal font, while face numbers are written in italic font."
46
47 - The connectivity table writes : {1, 2, 3, 4, 2, 5, 3, -1, 2, 4, 5, -1, 4, 3, 5, -1, 2, 3, 4}
48 - The index connectivity table writes : {1, 5, 20 }
49
50 If there are two \c MED_POLYHEDRA elements that share a common face, 
51 the list of nodes is repeated twice in the polyhedron connectivity
52 array but with reversed order.
53
54 \section poly_example Example
55 The following example illustrates the creation method for a mesh that
56 contains polygons and/or polyhedra :
57 \include test_MEDMEM_MeshingPoly.cxx
58 */