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