src/meshTools/sets/pointSources/pointToPoint/pointToPoint.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::pointToPoint
  27
  28 Description
  29     A topoSetSource to select points based on usage in pointSet.
  30
  31 SourceFiles
  32     pointToPoint.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef pointToPoint_H
  37 #define pointToPoint_H
  38
  39 #include "topoSetSource.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                        Class pointToPoint Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class pointToPoint
  51 :
  52     public topoSetSource
  53 {
  54     // Private data
  55
  56         //- Add usage string
  57         static addToUsageTable usage_;
  58
  59         //- Name of set to use
  60         word setName_;
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("pointToPoint");
  66
  67     // Constructors
  68
  69         //- Construct from components
  70         pointToPoint
  71         (
  72             const polyMesh& mesh,
  73             const word& setName
  74         );
  75
  76         //- Construct from dictionary
  77         pointToPoint
  78         (
  79             const polyMesh& mesh,
  80             const dictionary& dict
  81         );
  82
  83         //- Construct from Istream
  84         pointToPoint
  85         (
  86             const polyMesh& mesh,
  87             Istream&
  88         );
  89
  90
  91     // Destructor
  92
  93         virtual ~pointToPoint();
  94
  95
  96     // Member Functions
  97
  98         virtual void applyToSet
  99         (
 100             const topoSetSource::setAction action,
 101             topoSet&
 102         ) const;
 103
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //