src/lagrangian/distributionModels/general/general.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 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
  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::general
  26
  27 Description
  28     general distribution model
  29
  30 SourceFiles
  31     general.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef general_H
  36 #define general_H
  37
  38 #include "distributionModel.H"
  39 #include "Vector.H"
  40 #include "VectorSpace.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace distributionModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class general Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class general
  54 :
  55     public distributionModel
  56 {
  57     // Private data
  58
  59         typedef VectorSpace<Vector<scalar>, scalar, 2> pair;
  60
  61         List<pair> xy_;
  62
  63         label nEntries_;
  64
  65         //- min and max values of the distribution
  66         scalar minValue_;
  67         scalar maxValue_;
  68
  69         List<scalar> integral_;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("general");
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         general(const dictionary& dict, cachedRandom& rndGen);
  82
  83         //- Construct copy
  84         general(const general& p);
  85
  86         //- Construct and return a clone
  87         virtual autoPtr<distributionModel> clone() const
  88         {
  89             return autoPtr<distributionModel>(new general(*this));
  90         }
  91
  92
  93     //- Destructor
  94     virtual ~general();
  95
  96
  97     // Member Functions
  98
  99         //- Sample the distributionModel
 100         virtual scalar sample() const;
 101
 102         //- Return the minimum value
 103         virtual scalar minValue() const;
 104
 105         //- Return the maximum value
 106         virtual scalar maxValue() const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace distributionModels
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //