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

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