src/meshTools/octree/treeElem.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::treeElem
  27
  28 Description
  29     Common functionality of treeNode and treeLeaf.
  30
  31 SourceFiles
  32     treeElem.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef treeElem_H
  37 #define treeElem_H
  38
  39 #include "treeBoundBox.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class treeElem Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template <class Type>
  51 class treeElem
  52 {
  53     // Private data
  54
  55         //- Bounding box of this node
  56         treeBoundBox bb_;
  57
  58 public:
  59
  60     // Constructors
  61
  62         //- Construct from bounding box
  63         treeElem(const treeBoundBox& bb)
  64         :
  65             bb_(bb)
  66         {}
  67
  68
  69     // Member Functions
  70
  71         // Access
  72
  73             //- Bounding box of this node
  74             const treeBoundBox& bb() const
  75             {
  76                 return bb_;
  77             }
  78
  79             //- Bounding box of this node
  80             treeBoundBox& bb()
  81             {
  82                 return bb_;
  83             }
  84 };
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //