src/sampling/sampledSet/midPoint/midPointSet.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::midPointSet
  27
  28 Description
  29
  30 SourceFiles
  31     midPointSet.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef midPointSet_H
  36 #define midPointSet_H
  37
  38 #include "faceOnlySet.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // Forward declaration of classes
  46 class passiveParticle;
  47 template<class Type> class particle;
  48 class meshSearch;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class midPointSet Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class midPointSet
  55 :
  56     public faceOnlySet
  57 {
  58     // Private Member Functions
  59
  60         void genSamples();
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("midPoint");
  66
  67
  68     // Constructors
  69
  70         //- Construct from components
  71         midPointSet
  72         (
  73             const word& name,
  74             const polyMesh& mesh,
  75             meshSearch& searchEngine,
  76             const word& axis,
  77             const point& start,
  78             const point& end
  79         );
  80
  81         //- Construct from dictionary
  82         midPointSet
  83         (
  84             const word& name,
  85             const polyMesh& mesh,
  86             meshSearch& searchEngine,
  87             const dictionary& dict
  88         );
  89
  90
  91     // Destructor
  92
  93         virtual ~midPointSet();
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //