src/meshTools/sets/cellSources/regionToCell/regionToCell.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::regionToCell
  27
  28 Description
  29     TopoSetSource. Select cells belonging to topological connected region
  30     (that contains given point)
  31
  32 SourceFiles
  33     regionToCell.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef regionToCell_H
  38 #define regionToCell_H
  39
  40 #include "topoSetSource.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class regionToCell Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class regionToCell
  52 :
  53     public topoSetSource
  54 {
  55
  56     // Private data
  57
  58         //- Add usage string
  59         static addToUsageTable usage_;
  60
  61         //- Name of cellSet to keep to
  62         word setName_;
  63
  64         //- Coordinate that is inside connected region
  65         point insidePoint_;
  66
  67
  68     // Private Member Functions
  69
  70         void combine(topoSet& set, const bool add) const;
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("regionToCell");
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         regionToCell
  82         (
  83             const polyMesh& mesh,
  84             const word& setName,
  85             const point& insidePoint
  86         );
  87
  88         //- Construct from dictionary
  89         regionToCell
  90         (
  91             const polyMesh& mesh,
  92             const dictionary& dict
  93         );
  94
  95         //- Construct from Istream
  96         regionToCell
  97         (
  98             const polyMesh& mesh,
  99             Istream&
 100         );
 101
 102
 103     // Destructor
 104
 105         virtual ~regionToCell();
 106
 107
 108     // Member Functions
 109
 110         virtual void applyToSet(const topoSetSource::setAction action, topoSet&)
 111          const;
 112
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //