FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

exponential.C

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 \*---------------------------------------------------------------------------*/
00025 
00026 #include "exponential.H"
00027 #include <OpenFOAM/addToRunTimeSelectionTable.H>
00028 
00029 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
00030 
00031 namespace Foam
00032 {
00033     namespace pdfs
00034     {
00035         defineTypeNameAndDebug(exponential, 0);
00036         addToRunTimeSelectionTable(pdf, exponential, dictionary);
00037     }
00038 }
00039 
00040 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
00041 
00042 Foam::pdfs::exponential::exponential(const dictionary& dict, Random& rndGen)
00043 :
00044     pdf(typeName, dict, rndGen),
00045     minValue_(readScalar(pdfDict_.lookup("minValue"))),
00046     maxValue_(readScalar(pdfDict_.lookup("maxValue"))),
00047     lambda_(readScalar(pdfDict_.lookup("lambda")))
00048 {
00049     check();
00050 }
00051 
00052 
00053 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
00054 
00055 Foam::pdfs::exponential::~exponential()
00056 {}
00057 
00058 
00059 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
00060 
00061 Foam::scalar Foam::pdfs::exponential::sample() const
00062 {
00063     scalar y = rndGen_.scalar01();
00064     scalar K = exp(-lambda_*maxValue_) - exp(-lambda_*minValue_);
00065     return -(1.0/lambda_)*log(exp(-lambda_*minValue_) + y*K);
00066 }
00067 
00068 
00069 Foam::scalar Foam::pdfs::exponential::minValue() const
00070 {
00071     return minValue_;
00072 }
00073 
00074 
00075 Foam::scalar Foam::pdfs::exponential::maxValue() const
00076 {
00077     return maxValue_;
00078 }
00079 
00080 
00081 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines