src/thermophysicalModels/pdfs/normal/normal.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "normal.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33     defineTypeNameAndDebug(normal, 0);
  34     addToRunTimeSelectionTable(pdf, normal, dictionary);
  35 }
  36
  37 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  38
  39 Foam::normal::normal(const dictionary& dict, Random& rndGen)
  40 :
  41     pdf(dict, rndGen),
  42     pdfDict_(dict.subDict(typeName + "PDF")),
  43     minValue_(readScalar(pdfDict_.lookup("minValue"))),
  44     maxValue_(readScalar(pdfDict_.lookup("maxValue"))),
  45     expectation_(pdfDict_.lookup("expectation")),
  46     variance_(pdfDict_.lookup("variance")),
  47     strength_(pdfDict_.lookup("strength")),
  48     range_(maxValue_-minValue_)
  49 {
  50     scalar sMax = 0;
  51     label n = strength_.size();
  52     for (label i=0; i<n; i++)
  53     {
  54         scalar x = expectation_[i];
  55         scalar s = strength_[i];
  56         for (label j=0; j<n; j++)
  57         {
  58             if (i!=j)
  59             {
  60                 scalar x2 = (x-expectation_[j])/variance_[j];
  61                 scalar y = exp(-0.5*x2*x2);
  62                 s += strength_[j]*y;
  63             }
  64         }
  65
  66         sMax = max(sMax, s);
  67     }
  68
  69     for (label i=0; i<n; i++)
  70     {
  71         strength_[i] /= sMax;
  72     }
  73 }
  74
  75
  76 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  77
  78 Foam::normal::~normal()
  79 {}
  80
  81
  82 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  83
  84 Foam::scalar Foam::normal::sample() const
  85 {
  86     scalar y = 0;
  87     scalar x = 0;
  88     label n = expectation_.size();
  89     bool success = false;
  90
  91     while (!success)
  92     {
  93         x = minValue_ + range_*rndGen_.scalar01();
  94         y = rndGen_.scalar01();
  95         scalar p = 0.0;
  96
  97         for (label i=0; i<n; i++)
  98         {
  99             scalar nu = expectation_[i];
 100             scalar sigma = variance_[i];
 101             scalar s = strength_[i];
 102             scalar v = (x-nu)/sigma;
 103             p += s*exp(-0.5*v*v);
 104         }
 105
 106         if (y<p)
 107         {
 108             success = true;
 109         }
 110     }
 111
 112     return x;
 113 }
 114
 115
 116 Foam::scalar Foam::normal::minValue() const
 117 {
 118     return minValue_;
 119 }
 120
 121
 122 Foam::scalar Foam::normal::maxValue() const
 123 {
 124     return maxValue_;
 125 }
 126
 127
 128 // ************************************************************************* //