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