FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::boxToCell
00026 
00027 Description
00028     A topoSetSource to select cells based on cell centres inside box.
00029 
00030 SourceFiles
00031     boxToCell.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef boxToCell_H
00036 #define boxToCell_H
00037 
00038 #include <meshTools/topoSetSource.H>
00039 #include <meshTools/treeBoundBox.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                          Class boxToCell Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class boxToCell
00051 :
00052     public topoSetSource
00053 {
00054 
00055     // Private data
00056 
00057         //- Add usage string
00058         static addToUsageTable usage_;
00059 
00060 
00061         //- bounding box.
00062         treeBoundBox bb_;
00063 
00064 
00065     // Private Member Functions
00066 
00067         void combine(topoSet& set, const bool add) const;
00068 
00069 
00070 public:
00071 
00072     //- Runtime type information
00073     TypeName("boxToCell");
00074 
00075     // Constructors
00076 
00077         //- Construct from components
00078         boxToCell
00079         (
00080             const polyMesh& mesh,
00081             const treeBoundBox& bb
00082         );
00083 
00084         //- Construct from dictionary
00085         boxToCell
00086         (
00087             const polyMesh& mesh,
00088             const dictionary& dict
00089         );
00090 
00091         //- Construct from Istream
00092         boxToCell
00093         (
00094             const polyMesh& mesh,
00095             Istream&
00096         );
00097 
00098 
00099     // Destructor
00100 
00101         virtual ~boxToCell();
00102 
00103 
00104     // Member Functions
00105 
00106         virtual void applyToSet
00107         (
00108             const topoSetSource::setAction action,
00109             topoSet&
00110         ) const;
00111 
00112 };
00113 
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 } // End namespace Foam
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines