OpenFOAM logo
Open Source CFD Toolkit

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