OpenFOAM logo
Open Source CFD Toolkit

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