OpenFOAM logo
Open Source CFD Toolkit

faceToCell.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     faceToCell
00027 
00028 Description
00029     TopoSetSource. Select cells based on usage in faces.
00030 
00031 SourceFiles
00032     faceToCell.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef faceToCell_H
00037 #define faceToCell_H
00038 
00039 #include "topoSetSource.H"
00040 #include "NamedEnum.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class faceToCell Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class faceToCell
00052 :
00053     public topoSetSource
00054 {
00055 public:
00056         //- Enumeration defining the valid options
00057         enum faceAction
00058         {
00059             NEIGHBOUR,
00060             OWNER,
00061             ANY,
00062             ALL
00063         };
00064 
00065 private:
00066 
00067         static const NamedEnum<faceAction, 4> faceActionNames_;
00068 
00069 
00070         //- Add usage string
00071         static addToUsageTable usage_;
00072 
00073         //- Name of set to use
00074         word setName_;
00075 
00076         //- Option
00077         faceAction option_;
00078 
00079 
00080     // Private Member Functions
00081 
00082         //- Depending on face to cell option add to or delete from cellSet.
00083         void combine(topoSet& set, const bool add) const;
00084 
00085 
00086 public:
00087 
00088     //- Runtime type information
00089     TypeName("faceToCell");
00090 
00091 
00092     // Constructors
00093 
00094         //- Construct from components
00095         faceToCell
00096         (
00097             const polyMesh& mesh,
00098             const word& setName,
00099             const faceAction option
00100         );
00101 
00102         //- Construct from dictionary
00103         faceToCell
00104         (
00105             const polyMesh& mesh,
00106             const dictionary& dict
00107         );
00108 
00109         //- Construct from Istream
00110         faceToCell
00111         (
00112             const polyMesh& mesh,
00113             Istream&
00114         );
00115 
00116 
00117     // Destructor
00118 
00119         virtual ~faceToCell();
00120 
00121 
00122     // Member Functions
00123 
00124         virtual void applyToSet(const topoSetSource::setAction action, topoSet&)
00125          const;
00126 
00127 };
00128 
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 } // End namespace Foam
00133 
00134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00135 
00136 #endif
00137 
00138 // ************************************************************************* //
For further information go to www.openfoam.org