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

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