Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
thermophysicalModels
pdfs
general
general.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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
Class
25
Foam::general
26
27
Description
28
general pdf
29
30
SourceFiles
31
general.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef general_H
36
#define general_H
37
38
#include <
pdf/pdf.H
>
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
namespace
pdfs
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class general Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
general
52
:
53
public
pdf
54
{
55
// Private data
56
57
typedef
VectorSpace<Vector<scalar>
, scalar, 2>
pair
;
58
59
List<pair>
xy_;
60
61
label nEntries_;
62
63
//- min and max values of the distribution
64
scalar minValue_;
65
scalar maxValue_;
66
67
List<scalar>
integral_;
68
69
70
public
:
71
72
//- Runtime type information
73
TypeName
(
"general"
);
74
75
76
// Constructors
77
78
//- Construct from components
79
general
80
(
81
const
dictionary
& dict,
82
Random
& rndGen
83
);
84
85
86
//- Destructor
87
virtual
~general
();
88
89
90
// Member Functions
91
92
//- Sample the pdf
93
virtual
scalar
sample
()
const
;
94
95
//- Return the minimum value
96
virtual
scalar
minValue
()
const
;
97
98
//- Return the maximum value
99
virtual
scalar
maxValue
()
const
;
100
};
101
102
103
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105
}
// End namespace pdfs
106
}
// End namespace Foam
107
108
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110
#endif
111
112
// ************************ vim: set sw=4 sts=4 et: ************************ //