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
lagrangian
molecularDynamics
molecularMeasurements
distribution
distribution.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) 2008-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::distribution
26
27
Description
28
29
SourceFiles
30
distributionI.H
31
distribution.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef distribution_H
36
#define distribution_H
37
38
#include <
OpenFOAM/Map.H
>
39
#include <
OpenFOAM/Pair.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class distribution Declaration
48
\*---------------------------------------------------------------------------*/
49
50
class
distribution
51
:
52
public
Map
<label>
53
{
54
// Private data
55
56
scalar binWidth_;
57
58
59
public
:
60
61
// Constructors
62
63
//- Construct null
64
distribution
();
65
66
//- Construct from binWidth
67
distribution
(
const
scalar
binWidth
);
68
69
//- Construct as copy
70
distribution
(
const
distribution
&);
71
72
73
// Destructor
74
75
~distribution
();
76
77
78
// Member Functions
79
80
label
totalEntries
()
const
;
81
82
scalar
approxTotalEntries
()
const
;
83
84
scalar
mean
()
const
;
85
86
scalar
median
();
87
88
//- Add a value to the appropriate bin of the distribution.
89
void
add
(
const
scalar valueToAdd);
90
91
void
add
(
const
label valueToAdd);
92
93
void
insertMissingKeys
();
94
95
List<Pair<scalar>
>
normalised
();
96
97
List<Pair<scalar>
>
normalisedMinusMean
();
98
99
List<Pair<scalar>
>
normalisedShifted
(
const
scalar shiftValue);
100
101
List<Pair<scalar>
>
raw
();
102
103
104
// Access
105
106
inline
scalar
binWidth
()
const
;
107
108
109
// Member Operators
110
111
void
operator=
(
const
distribution
&);
112
113
114
// IOstream Operators
115
116
friend
Ostream
&
operator<<
(
Ostream
&,
const
distribution
&);
117
};
118
119
120
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121
122
}
// End namespace Foam
123
124
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126
#include "
distributionI.H
"
127
128
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129
130
#endif
131
132
// ************************ vim: set sw=4 sts=4 et: ************************ //