src/meshTools/sets/cellZoneSources/setToCellZone/setToCellZone.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::setToCellZone
  26
  27 Description
  28     A topoSetSource to select cells based on usage in a cellSet.
  29
  30 SourceFiles
  31     setToCellZone.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef setToCellZone_H
  36 #define setToCellZone_H
  37
  38 #include "topoSetSource.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                         Class setToCellZone Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class setToCellZone
  50 :
  51     public topoSetSource
  52 {
  53     // Private data
  54
  55         //- Add usage string
  56         static addToUsageTable usage_;
  57
  58         //- Name of set to use
  59         word setName_;
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("setToCellZone");
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         setToCellZone
  70         (
  71             const polyMesh& mesh,
  72             const word& setName
  73         );
  74
  75         //- Construct from dictionary
  76         setToCellZone
  77         (
  78             const polyMesh& mesh,
  79             const dictionary& dict
  80         );
  81
  82         //- Construct from Istream
  83         setToCellZone
  84         (
  85             const polyMesh& mesh,
  86             Istream&
  87         );
  88
  89
  90     //- Destructor
  91     virtual ~setToCellZone();
  92
  93
  94     // Member Functions
  95
  96         virtual sourceType setType() const
  97         {
  98             return CELLZONESOURCE;
  99         }
 100
 101         virtual void applyToSet
 102         (
 103             const topoSetSource::setAction action,
 104             topoSet&
 105         ) const;
 106
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //