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