/usr/include/freefoam/pdf/pdf.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
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.
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
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::pdf
Description
A library of runtime-selectable PDF's.
Returns a sampled value given the expectation (nu) and variance (sigma^2)
Current PDF's include:
- exponential
- fixedValue
- general
- multi-normal
- normal
- Rosin-Rammler
- uniform
The pdf is tabulated in equidistant nPoints, in an interval.
These values are integrated to obtain the cumulated PDF,
which is then used to change the distribution from unifrom to
the actual pdf.
SourceFiles
pdf.C
pdfNew.C
\*---------------------------------------------------------------------------*/
#ifndef pdf_H
#define pdf_H
#include <OpenFOAM/IOdictionary.H>
#include <OpenFOAM/autoPtr.H>
#include <OpenFOAM/Random.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace pdfs
{
/*---------------------------------------------------------------------------*\
Class pdf Declaration
\*---------------------------------------------------------------------------*/
class pdf
{
protected:
// Protected data
//- Coefficients dictionary
const dictionary pdfDict_;
//- Reference to the randmo number generator
Random& rndGen_;
// Protected Member Functions
//- Check that the PDF is valid
virtual void check() const;
public:
//-Runtime type information
TypeName("pdf");
//- Declare runtime constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
pdf,
dictionary,
(
const dictionary& dict,
Random& rndGen
),
(dict, rndGen)
);
// Constructors
//- Construct from dictionary
pdf(const word& name, const dictionary& dict, Random& rndGen);
//- Selector
static autoPtr<pdf> New(const dictionary& dict, Random& rndGen);
//- Destructor
virtual ~pdf();
// Member Functions
//- Sample the pdf
virtual scalar sample() const = 0;
//- Return the minimum value
virtual scalar minValue() const = 0;
//- Return the maximum value
virtual scalar maxValue() const = 0;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace pdfs
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|