OpenFOAM logo
Open Source CFD Toolkit

treeElem.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     treeElem
00027 
00028 Description
00029     Common functionality of treeNode and treeLeaf.
00030 
00031 SourceFiles
00032     treeElem.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef treeElem_H
00037 #define treeElem_H
00038 
00039 #include "treeBoundBox.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class treeElem Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template <class Type>
00051 class treeElem
00052 {
00053     // Private data
00054 
00055         //- Bounding box of this node
00056         treeBoundBox bb_;
00057 
00058 public:
00059 
00060     // Constructors
00061 
00062         //- Construct from bb
00063         treeElem(const treeBoundBox& bb)
00064         :
00065             bb_(bb)
00066         {}
00067 
00068 
00069     // Member Functions
00070 
00071         // Access
00072 
00073             const treeBoundBox& bb() const
00074             {
00075                 return bb_;
00076             }
00077 
00078             treeBoundBox& bb()
00079             {
00080                 return bb_;
00081             }
00082 };
00083 
00084 
00085 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00086 
00087 } // End namespace Foam
00088 
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 #endif
00093 
00094 // ************************************************************************* //
For further information go to www.openfoam.org