src/meshTools/octree/treeElem.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::treeElem
  26
  27 Description
  28     Common functionality of treeNode and treeLeaf.
  29
  30 SourceFiles
  31     treeElem.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef treeElem_H
  36 #define treeElem_H
  37
  38 #include "treeBoundBox.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class treeElem Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template <class Type>
  50 class treeElem
  51 {
  52     // Private data
  53
  54         //- Bounding box of this node
  55         treeBoundBox bb_;
  56
  57 public:
  58
  59     // Constructors
  60
  61         //- Construct from bounding box
  62         treeElem(const treeBoundBox& bb)
  63         :
  64             bb_(bb)
  65         {}
  66
  67
  68     // Member Functions
  69
  70         // Access
  71
  72             //- Bounding box of this node
  73             const treeBoundBox& bb() const
  74             {
  75                 return bb_;
  76             }
  77
  78             //- Bounding box of this node
  79             treeBoundBox& bb()
  80             {
  81                 return bb_;
  82             }
  83 };
  84
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 } // End namespace Foam
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************************************************************* //