src/sampling/sampledSet/cloud/cloudSet.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::cloudSet
  27
  28 Description
  29
  30 SourceFiles
  31     cloudSet.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cloudSet_H
  36 #define cloudSet_H
  37
  38 #include "sampledSet.H"
  39 #include "DynamicList.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of classes
  47 class passiveParticle;
  48 template<class Type> class particle;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class cloudSet Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class cloudSet
  55 :
  56     public sampledSet
  57 {
  58     // Private data
  59
  60         //- Sampling points
  61         List<point> sampleCoords_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Samples all points in sampleCoords.
  67         void calcSamples
  68         (
  69             DynamicList<point>& samplingPts,
  70             DynamicList<label>& samplingCells,
  71             DynamicList<label>& samplingFaces,
  72             DynamicList<label>& samplingSegments,
  73             DynamicList<scalar>& samplingCurveDist
  74         ) const;
  75
  76         //- Uses calcSamples to obtain samples. Copies them into *this.
  77         void genSamples();
  78
  79 public:
  80
  81     //- Runtime type information
  82     TypeName("cloud");
  83
  84
  85     // Constructors
  86
  87         //- Construct from components
  88         cloudSet
  89         (
  90             const word& name,
  91             const polyMesh& mesh,
  92             meshSearch& searchEngine,
  93             const word& axis,
  94             const List<point>& sampleCoords
  95         );
  96
  97         //- Construct from dictionary
  98         cloudSet
  99         (
 100             const word& name,
 101             const polyMesh& mesh,
 102             meshSearch& searchEngine,
 103             const dictionary& dict
 104         );
 105
 106
 107     // Destructor
 108
 109         virtual ~cloudSet();
 110
 111
 112     // Member Functions
 113
 114         //- Get reference point
 115         virtual point getRefPoint(const List<point>&) const;
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //