src/meshTools/sets/faceSources/zoneToFace/zoneToFace.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
   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::zoneToFace
  26
  27 Description
  28     A topoSetSource to select faces based on faceZone.
  29
  30 SourceFiles
  31     zoneToFace.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef zoneToFace_H
  36 #define zoneToFace_H
  37
  38 #include "topoSetSource.H"
  39 #include "wordRe.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class zoneToFace Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class zoneToFace
  51 :
  52     public topoSetSource
  53 {
  54
  55     // Private data
  56
  57         //- Add usage string
  58         static addToUsageTable usage_;
  59
  60         //- Name/regular expression of cellZone
  61         wordRe zoneName_;
  62
  63
  64     // Private Member Functions
  65
  66         void combine(topoSet& set, const bool add) const;
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("zoneToFace");
  73
  74     // Constructors
  75
  76         //- Construct from components
  77         zoneToFace
  78         (
  79             const polyMesh& mesh,
  80             const word& zoneName
  81         );
  82
  83         //- Construct from dictionary
  84         zoneToFace
  85         (
  86             const polyMesh& mesh,
  87             const dictionary& dict
  88         );
  89
  90         //- Construct from Istream
  91         zoneToFace
  92         (
  93             const polyMesh& mesh,
  94             Istream&
  95         );
  96
  97
  98     //- Destructor
  99     virtual ~zoneToFace();
 100
 101
 102     // Member Functions
 103
 104         virtual sourceType setType() const
 105         {
 106             return FACESETSOURCE;
 107         }
 108
 109         virtual void applyToSet
 110         (
 111             const topoSetSource::setAction action,
 112             topoSet&
 113         ) const;
 114
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //