OpenFOAM logo
Open Source CFD Toolkit

boxToCell.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     boxToCell
00027 
00028 Description
00029     Select cells based on cell centres inside box.
00030 
00031 SourceFiles
00032     boxToCell.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef boxToCell_H
00037 #define boxToCell_H
00038 
00039 #include "topoSetSource.H"
00040 #include "treeBoundBox.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class boxToCell Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class boxToCell
00052 :
00053     public topoSetSource
00054 {
00055 
00056     // Private data
00057 
00058         //- Add usage string
00059         static addToUsageTable usage_;
00060 
00061 
00062         //- bounding box.
00063         treeBoundBox bb_;
00064 
00065 
00066     // Private Member Functions
00067 
00068         void combine(topoSet& set, const bool add) const;
00069 
00070 
00071 public:
00072 
00073     //- Runtime type information
00074     TypeName("boxToCell");
00075 
00076     // Constructors
00077 
00078         //- Construct from components
00079         boxToCell
00080         (
00081             const polyMesh& mesh,
00082             const treeBoundBox& bb
00083         );
00084 
00085         //- Construct from dictionary
00086         boxToCell
00087         (
00088             const polyMesh& mesh,
00089             const dictionary& dict
00090         );
00091 
00092         //- Construct from Istream
00093         boxToCell
00094         (
00095             const polyMesh& mesh,
00096             Istream&
00097         );
00098 
00099 
00100     // Destructor
00101 
00102         virtual ~boxToCell();
00103 
00104 
00105     // Member Functions
00106 
00107         virtual void applyToSet(const topoSetSource::setAction action, topoSet&)
00108          const;
00109 
00110 };
00111 
00112 
00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00114 
00115 } // End namespace Foam
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 #endif
00120 
00121 // ************************************************************************* //
For further information go to www.openfoam.org