src/meshTools/sets/cellSources/sphereToCell/sphereToCell.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::sphereToCell
  27
  28 Description
  29     A topoSetSource to select cells based on cell centres inside sphere.
  30
  31 SourceFiles
  32     sphereToCell.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef sphereToCell_H
  37 #define sphereToCell_H
  38
  39 #include "topoSetSource.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                        Class sphereToCell Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class sphereToCell
  51 :
  52     public topoSetSource
  53 {
  54
  55     // Private data
  56
  57         //- Add usage string
  58         static addToUsageTable usage_;
  59
  60         //- Centre
  61         vector centre_;
  62
  63         //- Radius
  64         scalar radius_;
  65
  66
  67     // Private Member Functions
  68
  69         void combine(topoSet& set, const bool add) const;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("sphereToCell");
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         sphereToCell
  82         (
  83             const polyMesh& mesh,
  84             const vector& centre,
  85             const scalar radius
  86         );
  87
  88         //- Construct from dictionary
  89         sphereToCell
  90         (
  91             const polyMesh& mesh,
  92             const dictionary& dict
  93         );
  94
  95         //- Construct from Istream
  96         sphereToCell
  97         (
  98             const polyMesh& mesh,
  99             Istream&
 100         );
 101
 102
 103     // Destructor
 104
 105         virtual ~sphereToCell();
 106
 107
 108     // Member Functions
 109
 110         virtual void applyToSet
 111         (
 112             const topoSetSource::setAction action,
 113             topoSet&
 114         ) const;
 115
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //