File size: 5,424 Bytes
5a600cf | 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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ 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::distributions::normal
Description
Normal distribution, scaled so that it spans between a specified
minimum and maximum value, rather than from zero to infinity
\f[
PDF(x) = \frac{1}{\sigma \sqrt{2 \pi}} \exp \\
\left( - \frac{1}{2} \left( \frac{x - \mu}{\sigma} \right)^2 \right)
\f]
Usage
Example usage:
\verbatim
{
type normal;
Q 0;
min 0.001;
max 0.019;
mu 0.011;
sigma 0.003;
}
\endverbatim
SourceFiles
normal.C
See also
Foam::distribution
\*---------------------------------------------------------------------------*/
#ifndef normal_H
#define normal_H
#include "unintegrableForNonZeroQ.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace distributions
{
/*---------------------------------------------------------------------------*\
Class normal Declaration
\*---------------------------------------------------------------------------*/
class normal
:
public FieldDistribution<unintegrableForNonZeroQ, normal>
{
// Private Data
//- Minimum value
const scalar min_;
//- Maximum value
const scalar max_;
//- Mean
const scalar mu_;
//- Standard deviation
const scalar sigma_;
// Private Member Functions
//- Return values of the un-normalised PDF for the given size exponent
// and x-coordinates.
virtual tmp<scalarField> phi
(
const label q,
const scalarField& x
) const;
//- Return values of the un-normalised CDF for zero effective size
// exponent and given x-coordinates
virtual tmp<scalarField> PhiForZeroQ(const scalarField& x) const;
public:
//- Runtime type information
TypeName("normal");
//- Permit the multiNormal distribution to use private parts of this class
friend class multiNormal;
// Constructors
//- Construct from a dictionary
normal
(
const unitSet& units,
const dictionary& dict,
const label sampleQ,
randomGenerator&& rndGen
);
//- Construct from components
normal
(
const label Q,
const label sampleQ,
randomGenerator&& rndGen,
const label n,
const scalar min,
const scalar max,
const scalar mu,
const scalar sigma
);
//- Construct copy
normal(const normal& d, const label sampleQ);
//- Construct and return a clone
virtual autoPtr<distribution> clone(const label sampleQ) const
{
return autoPtr<distribution>(new normal(*this, sampleQ));
}
//- Destructor
virtual ~normal();
// Member Functions
//- Sample the distribution for zero effective size exponent
virtual scalar sampleForZeroQ() const;
//- Sample the distribution for zero effective size exponent
scalar sampleForZeroQ(const scalar s) const;
//- Sample the distribution
using FieldDistribution<unintegrableForNonZeroQ, normal>::sample;
//- Return the minimum value
virtual scalar min() const;
//- Return the maximum value
virtual scalar max() const;
//- Return the mean value
virtual scalar mean() const;
//- Return the mean value
inline scalar mu() const
{
return mu_;
}
//- Return the standard deviation
inline scalar sigma() const
{
return sigma_;
}
//- Write to a stream
virtual void write(Ostream& os, const unitSet& units) const;
//- Return coordinates to plot across the range of the distribution
virtual tmp<scalarField> plotX(const label n) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace distributions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|