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

cylinderToCell.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::cylinderToCell
00026 
00027 Description
00028     A topoSetSource to select cells based on cell centres inside a cylinder.
00029 
00030 SourceFiles
00031     cylinderToCell.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef cylinderToCell_H
00036 #define cylinderToCell_H
00037 
00038 #include <meshTools/topoSetSource.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                        Class cylinderToCell Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class cylinderToCell
00050 :
00051     public topoSetSource
00052 {
00053 
00054     // Private data
00055 
00056         //- Add usage string
00057         static addToUsageTable usage_;
00058 
00059         //- First point on cylinder axis
00060         vector p1_;
00061 
00062         //- Second point on cylinder axis
00063         vector p2_;
00064 
00065         //- Radius
00066         scalar radius_;
00067 
00068 
00069     // Private Member Functions
00070 
00071         void combine(topoSet& set, const bool add) const;
00072 
00073 
00074 public:
00075 
00076     //- Runtime type information
00077     TypeName("cylinderToCell");
00078 
00079 
00080     // Constructors
00081 
00082         //- Construct from components
00083         cylinderToCell
00084         (
00085             const polyMesh& mesh,
00086             const vector& p1,
00087             const vector& p2,
00088             const scalar radius
00089         );
00090 
00091         //- Construct from dictionary
00092         cylinderToCell
00093         (
00094             const polyMesh& mesh,
00095             const dictionary& dict
00096         );
00097 
00098         //- Construct from Istream
00099         cylinderToCell
00100         (
00101             const polyMesh& mesh,
00102             Istream&
00103         );
00104 
00105 
00106     // Destructor
00107 
00108         virtual ~cylinderToCell();
00109 
00110 
00111     // Member Functions
00112 
00113         virtual void applyToSet
00114         (
00115             const topoSetSource::setAction action,
00116             topoSet&
00117         ) const;
00118 
00119 };
00120 
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 } // End namespace Foam
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 #endif
00129 
00130 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines