src/meshTools/sets/cellSources/cylinderToCell/cylinderToCell.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::cylinderToCell
  27
  28 Description
  29     A topoSetSource to select cells based on cell centres inside a cylinder.
  30
  31 SourceFiles
  32     cylinderToCell.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cylinderToCell_H
  37 #define cylinderToCell_H
  38
  39 #include "topoSetSource.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                        Class cylinderToCell Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class cylinderToCell
  51 :
  52     public topoSetSource
  53 {
  54
  55     // Private data
  56
  57         //- Add usage string
  58         static addToUsageTable usage_;
  59
  60         //- First point on cylinder axis
  61         vector p1_;
  62
  63         //- Second point on cylinder axis
  64         vector p2_;
  65
  66         //- Radius
  67         scalar radius_;
  68
  69
  70     // Private Member Functions
  71
  72         void combine(topoSet& set, const bool add) const;
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("cylinderToCell");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         cylinderToCell
  85         (
  86             const polyMesh& mesh,
  87             const vector& p1,
  88             const vector& p2,
  89             const scalar radius
  90         );
  91
  92         //- Construct from dictionary
  93         cylinderToCell
  94         (
  95             const polyMesh& mesh,
  96             const dictionary& dict
  97         );
  98
  99         //- Construct from Istream
 100         cylinderToCell
 101         (
 102             const polyMesh& mesh,
 103             Istream&
 104         );
 105
 106
 107     // Destructor
 108
 109         virtual ~cylinderToCell();
 110
 111
 112     // Member Functions
 113
 114         virtual void applyToSet
 115         (
 116             const topoSetSource::setAction action,
 117             topoSet&
 118         ) const;
 119
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //