src/lagrangian/distributionModels/exponential/exponential.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "exponential.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33     namespace distributionModels
  34     {
  35         defineTypeNameAndDebug(exponential, 0);
  36         addToRunTimeSelectionTable(distributionModel, exponential, dictionary);
  37     }
  38 }
  39
  40 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  41
  42 Foam::distributionModels::exponential::exponential
  43 (
  44     const dictionary& dict,
  45     cachedRandom& rndGen
  46 )
  47 :
  48     distributionModel(typeName, dict, rndGen),
  49     minValue_(readScalar(distributionModelDict_.lookup("minValue"))),
  50     maxValue_(readScalar(distributionModelDict_.lookup("maxValue"))),
  51     lambda_(readScalar(distributionModelDict_.lookup("lambda")))
  52 {
  53     check();
  54 }
  55
  56
  57 Foam::distributionModels::exponential::exponential(const exponential& p)
  58 :
  59     distributionModel(p),
  60     minValue_(p.minValue_),
  61     maxValue_(p.maxValue_),
  62     lambda_(p.lambda_)
  63 {}
  64
  65
  66 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  67
  68 Foam::distributionModels::exponential::~exponential()
  69 {}
  70
  71
  72 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  73
  74 Foam::scalar Foam::distributionModels::exponential::sample() const
  75 {
  76     scalar y = rndGen_.sample01<scalar>();
  77     scalar K = exp(-lambda_*maxValue_) - exp(-lambda_*minValue_);
  78     return -(1.0/lambda_)*log(exp(-lambda_*minValue_) + y*K);
  79 }
  80
  81
  82 Foam::scalar Foam::distributionModels::exponential::minValue() const
  83 {
  84     return minValue_;
  85 }
  86
  87
  88 Foam::scalar Foam::distributionModels::exponential::maxValue() const
  89 {
  90     return maxValue_;
  91 }
  92
  93
  94 // ************************************************************************* //