File size: 4,407 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2024 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::standardNormal
Description
Standard normal distribution. Not selectable.
\f[
PDF(x) = \frac{1}{\sqrt{2 \pi}} \exp \left( - \frac{1}{2} x^2 \right)
\f]
SourceFiles
standardNormal.C
See also
Foam::distribution
\*---------------------------------------------------------------------------*/
#ifndef standardNormal_H
#define standardNormal_H
#include "unintegrable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace distributions
{
/*---------------------------------------------------------------------------*\
Class standardNormal Declaration
\*---------------------------------------------------------------------------*/
class standardNormal
:
public FieldDistribution<distribution, standardNormal>
{
// Private Data
//- Constant for approximate error function and inverse error function
static const scalar a_;
public:
//- Runtime type information
TypeName("standardNormal");
//- Permit the multiNormal distribution to use private parts of this class
friend class multiNormal;
// Static Member Functions
//- Approximate error function
static tmp<scalarField> approxErf(const scalarField& x);
//- Approximate error function inverse
static scalar approxErfInv(const scalar y);
// Constructors
//- Construct from a random generator
standardNormal(randomGenerator&& rndGen);
//- Construct from a seed
standardNormal
(
const randomGenerator::seed& s,
const bool global = false
);
//- Construct copy
standardNormal(const standardNormal& d);
//- Construct and return a clone
virtual autoPtr<distribution> clone(const label sampleQ) const
{
return autoPtr<distribution>(new standardNormal(*this));
}
//- Destructor
virtual ~standardNormal();
// Member Functions
//- Sample the distribution
virtual scalar sample() const;
//- Sample the distribution
using FieldDistribution<distribution, standardNormal>::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 integral of the PDF multiplied by an integer power of x
virtual tmp<scalarField> integralPDFxPow
(
const scalarField& x,
const label e,
const bool consistent = false
) const;
//- Return coordinates to plot across the range of the distribution
virtual tmp<scalarField> plotX(const label n) const;
//- Return values to plot the probability density function
virtual tmp<scalarField> plotPDF(const scalarField& x) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace distributions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|