src/meshTools/sets/cellSources/faceZoneToCell/faceZoneToCell.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::faceZoneToCell
  26
  27 Description
  28     A topoSetSource to select cells based on side of faceZone.
  29
  30 SourceFiles
  31     faceZoneToCell.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef faceZoneToCell_H
  36 #define faceZoneToCell_H
  37
  38 #include "topoSetSource.H"
  39 #include "wordRe.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class faceZoneToCell Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class faceZoneToCell
  51 :
  52     public topoSetSource
  53 {
  54 public:
  55         //- Enumeration defining the valid options
  56         enum faceAction
  57         {
  58             MASTER,
  59             SLAVE
  60         };
  61
  62 private:
  63
  64     // Private data
  65
  66         static const NamedEnum<faceAction, 2> faceActionNames_;
  67
  68         //- Add usage string
  69         static addToUsageTable usage_;
  70
  71         //- Name/regular expression of faceZone
  72         wordRe zoneName_;
  73
  74         //- Option
  75         faceAction option_;
  76
  77
  78     // Private Member Functions
  79
  80         void combine(topoSet& set, const bool add) const;
  81
  82
  83 public:
  84
  85     //- Runtime type information
  86     TypeName("faceZoneToCell");
  87
  88     // Constructors
  89
  90         //- Construct from components
  91         faceZoneToCell
  92         (
  93             const polyMesh& mesh,
  94             const word& zoneName,
  95             const faceAction option
  96         );
  97
  98         //- Construct from dictionary
  99         faceZoneToCell
 100         (
 101             const polyMesh& mesh,
 102             const dictionary& dict
 103         );
 104
 105         //- Construct from Istream
 106         faceZoneToCell
 107         (
 108             const polyMesh& mesh,
 109             Istream&
 110         );
 111
 112
 113     // Destructor
 114
 115         virtual ~faceZoneToCell();
 116
 117
 118     // Member Functions
 119
 120         virtual void applyToSet
 121         (
 122             const topoSetSource::setAction action,
 123             topoSet&
 124         ) const;
 125
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //