Salome HOME
Initiating medtool
[modules/med.git] / src / medtool / src / INTERP_KERNEL / MeshElement.hxx
1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef __MESHELEMENT_HXX__
21 #define __MESHELEMENT_HXX__
22
23 #include "BoundingBox.hxx"
24
25 namespace INTERP_KERNEL
26 {
27
28   /**
29    * \brief Class representing a single element of a mesh together with its bounding box.
30    * It gives access to the element's global number, type and bounding box and allows
31    * easy bounding box intersection tests between MeshElements and collections of MeshElement (MeshRegions)
32    */
33   template<class ConnType>
34   class MeshElement
35   {
36
37   public:
38     template<class MyMeshType>
39     MeshElement(const ConnType index, const MyMeshType& mesh);
40     
41     ~MeshElement();
42     
43     ConnType getIndex() const { return _index; }
44     
45     unsigned char getNumberOfNodes() const { return _number; }
46     
47     const BoundingBox* getBoundingBox() const { return _box; }
48
49   private:
50     /// disallow copying
51     MeshElement(const MeshElement& elem);
52
53     /// disallow assignment
54     MeshElement& operator=(const MeshElement& elem);
55
56     /// global number of the element
57     const ConnType _index;
58
59     const unsigned char _number;
60     
61     /// bounding box of the element - does not change after having been initialised
62     BoundingBox* _box;
63   };
64
65   /**
66    * \brief Class defining an order for MeshElements based on their bounding boxes.
67    * The order defined between two elements is that between a given coordinate of 
68    * their bounding boxes. For instance, if the order is based on YMIN, an element whose boxes
69    * has a smaller YMIN is sorted before one with a larger YMIN.
70    *
71    */
72   class ElementBBoxOrder
73   {
74   public : 
75     
76     ElementBBoxOrder(BoundingBox::BoxCoord coord);
77     template<class ConnType>
78     bool operator()(MeshElement<ConnType>* elem1, MeshElement<ConnType>* elem2);
79     
80   private :
81     /// BoundingBox coordinate (XMIN, XMAX, etc) on which to base the ordering
82     BoundingBox::BoxCoord _coord;  
83   };
84
85 }
86
87 #endif