src/meshTools/sets/cellSources/labelToCell/labelToCell.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::labelToCell
  26
  27 Description
  28     A topoSetSource to select cells based on explicitly given labels.
  29
  30 SourceFiles
  31     labelToCell.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef labelToCell_H
  36 #define labelToCell_H
  37
  38 #include "topoSetSource.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                         Class labelToCell Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class labelToCell
  50 :
  51     public topoSetSource
  52 {
  53
  54     // Private data
  55
  56         //- Add usage string
  57         static addToUsageTable usage_;
  58
  59         //- cell labels read from dictionary
  60         labelList labels_;
  61
  62
  63     // Private Member Functions
  64
  65         void combine(topoSet& set, const bool add) const;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("labelToCell");
  72
  73     // Constructors
  74
  75         //- Construct from components
  76         labelToCell
  77         (
  78             const polyMesh& mesh,
  79             const labelList& labels
  80         );
  81
  82         //- Construct from dictionary
  83         labelToCell
  84         (
  85             const polyMesh& mesh,
  86             const dictionary& dict
  87         );
  88
  89         //- Construct from Istream
  90         labelToCell
  91         (
  92             const polyMesh& mesh,
  93             Istream&
  94         );
  95
  96
  97     // Destructor
  98
  99         virtual ~labelToCell();
 100
 101
 102     // Member Functions
 103
 104         virtual void applyToSet
 105         (
 106             const topoSetSource::setAction action,
 107             topoSet&
 108         ) const;
 109
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //