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