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