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

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