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

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