exponential.C 2.63 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
15
16
17
18
19
20
21

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    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
27
28
29
30

\*---------------------------------------------------------------------------*/

#include "exponential.H"
#include "addToRunTimeSelectionTable.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

Andrew Heather's avatar
Andrew Heather committed
31
32
namespace Foam
{
33
34
35
36
37
    namespace pdfs
    {
        defineTypeNameAndDebug(exponential, 0);
        addToRunTimeSelectionTable(pdf, exponential, dictionary);
    }
Andrew Heather's avatar
Andrew Heather committed
38
}
39
40
41

// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

42
43
44
45
46
Foam::pdfs::exponential::exponential
(
    const dictionary& dict,
    cachedRandom& rndGen
)
47
:
48
    pdf(typeName, dict, rndGen),
49
50
    minValue_(readScalar(pdfDict_.lookup("minValue"))),
    maxValue_(readScalar(pdfDict_.lookup("maxValue"))),
51
    lambda_(readScalar(pdfDict_.lookup("lambda")))
52
{
53
    check();
54
55
56
}


57
58
59
60
61
62
63
64
65
Foam::pdfs::exponential::exponential(const exponential& p)
:
    pdf(p),
    minValue_(p.minValue_),
    maxValue_(p.maxValue_),
    lambda_(p.lambda_)
{}


66
67
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

68
Foam::pdfs::exponential::~exponential()
69
70
71
72
73
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

74
Foam::scalar Foam::pdfs::exponential::sample() const
75
{
76
    scalar y = rndGen_.sample01<scalar>();
77
78
    scalar K = exp(-lambda_*maxValue_) - exp(-lambda_*minValue_);
    return -(1.0/lambda_)*log(exp(-lambda_*minValue_) + y*K);
79
80
}

Andrew Heather's avatar
Andrew Heather committed
81

82
Foam::scalar Foam::pdfs::exponential::minValue() const
83
84
85
86
{
    return minValue_;
}

Andrew Heather's avatar
Andrew Heather committed
87

88
Foam::scalar Foam::pdfs::exponential::maxValue() const
89
90
91
92
93
{
    return maxValue_;
}


Andrew Heather's avatar
Andrew Heather committed
94
// ************************************************************************* //