OpenFOAM logo
Open Source CFD Toolkit

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