src/meshTools/sets/faceSources/boundaryToFace/boundaryToFace.H

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