src/thermophysicalModels/pdfs/exponential/exponential.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
  27 #include "exponential.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34     defineTypeNameAndDebug(exponential, 0);
  35     addToRunTimeSelectionTable(pdf, exponential, dictionary);
  36 }
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40 Foam::exponential::exponential(const dictionary& dict, Random& rndGen)
  41 :
  42     pdf(dict, rndGen),
  43     pdfDict_(dict.subDict(typeName + "PDF")),
  44     minValue_(readScalar(pdfDict_.lookup("minValue"))),
  45     maxValue_(readScalar(pdfDict_.lookup("maxValue"))),
  46     lambda_(pdfDict_.lookup("lambda")),
  47     ls_(lambda_),
  48     range_(maxValue_-minValue_)
  49 {
  50     if (minValue_<0)
  51     {
  52         FatalErrorIn
  53         (
  54             "exponential::exponential(const dictionary& dict)"
  55         ) << " minValue = " << minValue_ << ", it must be >0." << abort(FatalError);
  56     }
  57
  58     scalar sMax = 0;
  59     label n = lambda_.size();
  60     for (label i=0; i<n; i++)
  61     {
  62         scalar s = lambda_[i]*exp(-lambda_[i]*minValue_);
  63         for (label j=0; j<n; j++)
  64         {
  65             if (i!=j)
  66             {
  67                 scalar y = lambda_[j]*exp(-lambda_[j]*minValue_);
  68                 s += y;
  69             }
  70         }
  71
  72         sMax = max(sMax, s);
  73     }
  74
  75     for(label i=0; i<n; i++)
  76     {
  77         ls_[i] /= sMax;
  78     }
  79 }
  80
  81
  82 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  83
  84 Foam::exponential::~exponential()
  85 {}
  86
  87
  88 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  89
  90 Foam::scalar Foam::exponential::sample() const
  91 {
  92     scalar y = 0;
  93     scalar x = 0;
  94     label n = lambda_.size();
  95     bool success = false;
  96
  97     while (!success)
  98     {
  99         x = minValue_ + range_*rndGen_.scalar01();
 100         y = rndGen_.scalar01();
 101         scalar p = 0.0;
 102
 103         for(label i=0; i<n; i++)
 104         {
 105             p += ls_[i]*exp(-lambda_[i]*x);
 106         }
 107
 108         if (y<p)
 109         {
 110             success = true;
 111         }
 112     }
 113
 114     return x;
 115 }
 116
 117
 118 Foam::scalar Foam::exponential::minValue() const
 119 {
 120     return minValue_;
 121 }
 122
 123
 124 Foam::scalar Foam::exponential::maxValue() const
 125 {
 126     return maxValue_;
 127 }
 128
 129
 130 // ************************************************************************* //