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