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

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