Salome HOME
New DS implementation
[modules/smesh.git] / src / SMDS / SMDS_MeshHexahedron.cdl
1 --  SMESH SMDS : implementaion of Salome mesh data structure
2 --
3 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
5 -- 
6 --  This library is free software; you can redistribute it and/or 
7 --  modify it under the terms of the GNU Lesser General Public 
8 --  License as published by the Free Software Foundation; either 
9 --  version 2.1 of the License. 
10 -- 
11 --  This library is distributed in the hope that it will be useful, 
12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of 
13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
14 --  Lesser General Public License for more details. 
15 -- 
16 --  You should have received a copy of the GNU Lesser General Public 
17 --  License along with this library; if not, write to the Free Software 
18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
19 -- 
20 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
21 --
22 --
23 --
24 --  File   : SMDS_MeshHexahedron.cdl
25 --  Author : Jean-Michel BOULCOURT
26 --  Module : SMESH
27
28 class MeshHexahedron from SMDS inherits MeshVolume from SMDS
29
30         ---Purpose: 
31
32 uses
33   MeshElement from SMDS
34
35     
36 raises 
37   ConstructionError   from Standard
38
39 is
40
41
42     Create (ID,idnode1,idnode2,idnode3,idnode4,idnode5,idnode6,idnode7,idnode8: Integer) 
43     returns mutable MeshHexahedron;
44         ---Purpose: constructor for a hexaedra
45
46     GetEdgeDefinedByNodes(me; rank: Integer; idnode1 : out Integer; idnode2: out Integer) 
47     is redefined static;
48     ---Purpose: returns the idnodes of the ith edge (rank) of the volume
49     --          rank must be comprised between 1 and myNbConnections included.
50     
51     GetFaceDefinedByNodes(me; rank: Integer; idnode : Address; nb: out Integer) 
52     is redefined static;
53     ---Purpose: returns the idnodes of the ith face (rank) of the volume
54     --          rank must be comprised between 1 and myNbConnections included.
55     
56     ComputeKey(me: mutable) is redefined static;
57     ---Purpose: compute the  ID of the volume  based on the  id's of its
58     --          bounding nodes
59     ---C++: inline
60
61     SetConnections(me: mutable; idnode1,idnode2,idnode3,idnode4,idnode5,idnode6,idnode7,idnode8: Integer) 
62     is private;
63
64     GetConnections(me) returns Address is redefined static;
65     ---C++: inline
66
67     GetConnection(me; rank: Integer) returns Integer is redefined static;
68     ---C++: inline
69
70     NbEdges(me) returns Integer
71     is redefined static;
72     ---C++: inline
73
74     NbFaces(me) returns Integer
75     is redefined static;
76     ---C++: inline
77
78     NodesOfFace(myclass; rankface,ranknode: Integer) 
79     returns Integer;
80     ---Purpose: returns the rank node in mynodes. Useful to extract faces from volume
81     --          
82     
83     NodesOfEdge(me;  rankedge: Integer; ranknode: Integer) returns Integer;
84
85 fields
86     
87     myNodes : Integer [8];
88
89 end MeshHexahedron;