src/SMDS/SMDS_MeshPrism.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_MeshPrism.cdl
  25 --  Author : Jean-Michel BOULCOURT
  26 --  Module : SMESH
  27
  28 class MeshPrism 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     Create (ID,idnode1,idnode2,idnode3,idnode4,idnode5,idnode6: Integer)
  42     returns mutable MeshPrism;
  43         ---Purpose: constructor for a prism
  44
  45     GetEdgeDefinedByNodes(me; rank: Integer; idnode1 : out Integer; idnode2: out Integer)
  46     is redefined static;
  47     ---Purpose: returns the idnodes of the ith edge (rank) of the volume
  48     --          rank must be comprised between 1 and myNbConnections included.
  49
  50     GetFaceDefinedByNodes(me; rank: Integer; idnode : Address; nb: out Integer)
  51     is redefined static;
  52     ---Purpose: returns the idnodes of the ith face (rank) of the volume
  53     --          rank must be comprised between 1 and myNbConnections included.
  54
  55     ComputeKey(me: mutable);
  56     ---Purpose: compute the  ID of the volume  based on the  id's of its
  57     --          bounding nodes
  58     ---C++: inline
  59
  60     SetConnections(me: mutable; idnode1,idnode2,idnode3,idnode4,idnode5,idnode6: Integer) is private;
  61
  62     GetConnections(me) returns Address is redefined static;
  63     ---C++: inline
  64
  65     GetConnection(me; rank: Integer) returns Integer is redefined static;
  66     ---C++: inline
  67
  68     NbEdges(me) returns Integer
  69     is redefined static;
  70     ---C++: inline
  71
  72     NbFaces(me) returns Integer
  73     is redefined static;
  74     ---C++: inline
  75
  76     NodesOfFace(myclass; rankface,ranknode: Integer)
  77     returns Integer;
  78     ---Purpose: returns the rank node in mynodes. Useful to extract faces from volume
  79     --
  80     NodesOfEdge(me;  rankedge: Integer; ranknode: Integer) returns Integer;
  81
  82
  83 fields
  84
  85     myNodes : Integer [6];
  86
  87 end MeshPrism;