src/meshTools/sets/pointSources/pointToPoint/pointToPoint.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::pointToPoint
  26
  27 Description
  28     A topoSetSource to select points based on usage in pointSet.
  29
  30 SourceFiles
  31     pointToPoint.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef pointToPoint_H
  36 #define pointToPoint_H
  37
  38 #include "topoSetSource.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class pointToPoint Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class pointToPoint
  50 :
  51     public topoSetSource
  52 {
  53     // Private data
  54
  55         //- Add usage string
  56         static addToUsageTable usage_;
  57
  58         //- Name of set to use
  59         word setName_;
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("pointToPoint");
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         pointToPoint
  70         (
  71             const polyMesh& mesh,
  72             const word& setName
  73         );
  74
  75         //- Construct from dictionary
  76         pointToPoint
  77         (
  78             const polyMesh& mesh,
  79             const dictionary& dict
  80         );
  81
  82         //- Construct from Istream
  83         pointToPoint
  84         (
  85             const polyMesh& mesh,
  86             Istream&
  87         );
  88
  89
  90     // Destructor
  91
  92         virtual ~pointToPoint();
  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 // ************************************************************************* //