src/thermophysicalModels/pdfs/normal/normal.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::normal
  27
  28 Description
  29     A normal pdf
  30
  31     @verbatim
  32         pdf = strength * exp(-0.5*((x - expectation)/variance)^2 )
  33     @endverbatim
  34
  35     strength only has meaning if there's more than one pdf
  36
  37 SourceFiles
  38     normalI.H
  39     normal.C
  40     normalIO.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef normal_H
  45 #define normal_H
  46
  47 #include "pdf.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class normal Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class normal
  59 :
  60     public pdf
  61 {
  62     // Private data
  63
  64         dictionary pdfDict_;
  65
  66         //- min and max values of the distribution
  67         scalar minValue_;
  68         scalar maxValue_;
  69
  70         List<scalar> expectation_;
  71         List<scalar> variance_;
  72         List<scalar> strength_;
  73
  74         scalar range_;
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("normal");
  81
  82
  83     // Constructors
  84
  85         //- Construct from components
  86         normal
  87         (
  88             const dictionary& dict,
  89             Random& rndGen
  90         );
  91
  92
  93     //- Destructor
  94     virtual ~normal();
  95
  96
  97     // Member Functions
  98
  99         //- Sample the pdf
 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 Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //