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