src/meshTools/sets/cellSources/pointToCell/pointToCell.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::pointToCell
  26
  27 Description
  28     A topoSetSource to select cells based on usage of points.
  29
  30 SourceFiles
  31     pointToCell.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef pointToCell_H
  36 #define pointToCell_H
  37
  38 #include "topoSetSource.H"
  39 #include "NamedEnum.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                         Class pointToCell Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class pointToCell
  51 :
  52     public topoSetSource
  53 {
  54 public:
  55         //- Enumeration defining the valid options
  56         enum pointAction
  57         {
  58             ANY     // Cells using any point in set
  59             //ALL   // Possible extension: cells whose all points are in set
  60         };
  61
  62 private:
  63
  64         //- Add usage string
  65         static addToUsageTable usage_;
  66
  67         static const NamedEnum<pointAction, 1> pointActionNames_;
  68
  69         //- Name of set to use
  70         word setName_;
  71
  72         //- Option
  73         pointAction option_;
  74
  75
  76     // Private Member Functions
  77
  78         //- Depending on point-to-cell option add to or delete from cellSet.
  79         void combine(topoSet& set, const bool add) const;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("pointToCell");
  86
  87     // Constructors
  88
  89         //- Construct from components
  90         pointToCell
  91         (
  92             const polyMesh& mesh,
  93             const word& setName,
  94             const pointAction option
  95         );
  96
  97         //- Construct from dictionary
  98         pointToCell
  99         (
 100             const polyMesh& mesh,
 101             const dictionary& dict
 102         );
 103
 104         //- Construct from Istream
 105         pointToCell
 106         (
 107             const polyMesh& mesh,
 108             Istream&
 109         );
 110
 111
 112     //- Destructor
 113     virtual ~pointToCell();
 114
 115
 116     // Member Functions
 117
 118         virtual sourceType setType() const
 119         {
 120             return CELLSETSOURCE;
 121         }
 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 // ************************************************************************* //