src/meshTools/sets/cellSources/boxToCell/boxToCell.H

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