Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / conversion / meshReader / README
blobbf24eb65a181fa838c6dd9313813480f4b0439be
1 With pro-STAR version v4, the input formats have changed radically.
2   * Easier to parse space-delimited input formats
3   * No arbitrary or integral couples
4   * No trimmed or degenerate cells
5   * Support for polyhedral cells
6   * Boundaries are directly connected to cell and faces
8 Since the boundaries are now connected directly to the faces,
9 we now must be concerned with cell face notation otherwise we perform the
10 incorrect lookup.
11 Fortunately, there are only 4 primitive shapes to be concerned with.
13 Hexa:
14    Foam                  pro-STAR
15    ~~~~~~~~~~~~~~        ~~~~~~~~~~~
16    Face 0 (0 4 7 3)  ->  F5: (0 4 7 3)
17    Face 1 (1 2 6 5)  ->  F6: (1 2 6 5)
18    Face 2 (0 1 5 4)  ->  F3: (0 1 5 4)
19    Face 3 (3 7 6 2)  ->  F4: (2 3 7 6)
20    Face 4 (0 3 2 1)  ->  F1: (0 3 2 1)
21    Face 5 (4 5 6 7)  ->  F2: (4 5 6 7)
24 Prism:
25    Foam                  pro-STAR
26    ~~~~~~~~~~~~~~        ~~~~~~~~~~~
27    Face 0 (0 2 1)    ->  F1: (0 2 1)
28    Face 1 (3 4 5)    ->  F2: (3 4 5)
29    Face 2 (0 3 5 2)  ->  F5: (0 3 5 2)
30    Face 3 (1 2 5 4)  ->  F6: (1 2 5 4)
31    Face 4 (0 1 4 3)  ->  F3: (0 1 4 3)
34 Tetra:
35    Foam                  pro-STAR
36    ~~~~~~~~~~~~~~        ~~~~~~~~~~~
37    Face 0 (1 2 3)    ->  F6: (1 2 3)
38    Face 1 (0 3 2)    ->  F5: (0 3 2)
39    Face 2 (0 1 3)    ->  F3: (0 1 3)
40    Face 3 (0 2 1)    ->  F1: (0 2 1)
43 Pyramid:
44    Foam                  pro-STAR
45    ~~~~~~~~~~~~~~        ~~~~~~~~~~~
46    Face 0 (0 3 2 1)  ->  F1: (0 3 2 1)
47    Face 1 (0 4 3)    ->  F5: (0 4 3)
48    Face 2 (3 4 2)    ->  F4: (2 3 4)
49    Face 3 (1 2 4)    ->  F6: (1 2 4)
50    Face 4 (0 1 4)    ->  F3: (0 1 4)
52 Noting that several faces are skipped over in the pro-STAR definitions,
53 simply introducing a new cell modeller will be a problem.
54 Instead, subtract 1 from the pro-STAR faces and use lookup tables.
57 Here are the pro-STAR macro snippets used for creating the primitive cells:
59 ! hexa
60 v 10 0 0 0
61 v 11 1 0 0
62 v 12 1 1 0
63 v 13 0 1 0
64 v 14 0 0 1
65 v 15 1 0 1
66 v 16 1 1 1
67 v 17 0 1 1
68 c hexa 10 11 12 13 14 15 16 17
70 ! prism
71 v 20 0 0 0
72 v 21 1 0 0
73 v 22 1 1 0
74 v 23 0 0 1
75 v 24 1 0 1
76 v 25 1 1 1
77 c prism 20 21 22 23 24 25
79 ! tet
80 v 30 0 0 0
81 v 31 1 0 0
82 v 32 1 1 0
83 v 33 0.75 0.75 1
84 c tetra 30 31 32 33
86 ! pyramid
87 v 40 0 0 0
88 v 41 1 0 0
89 v 42 1 1 0
90 v 43 0 1 0
91 v 44 0.5 0.5 1
92 c pyra 40 41 42 43 44
94 ! list faces
95 flist all