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