File size: 8,121 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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-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::unintegrable
Description
Base class for distributions that do not have a closed integral form for
the cumulative density function (CDF) for some or all effective size
exponents.
SourceFiles
unintegrable.C
See also
Foam::distribution
\*---------------------------------------------------------------------------*/
#ifndef unintegrable_H
#define unintegrable_H
#include "distribution.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace distributions
{
/*---------------------------------------------------------------------------*\
Class unintegrable Declaration
\*---------------------------------------------------------------------------*/
class unintegrable
:
public distribution
{
private:
// Private Data
//- Number of intervals to use over the range of the distribution
const label n_;
//- X-coordinates. These are spaced to contain equal increments of the
// CDF. Sampling is a inversion of the CDF; i.e., solve CDF(x) = s for
// x, where s is a random sample between 0 and 1. Uniform increments
// of CDF make this inversion trivial.
mutable autoPtr<scalarField> xPtr_;
//- Values of Phi (i.e., the un-normalised CDF) at the minimum and
// maximum x-coordinates
mutable autoPtr<Pair<scalar>> Phi01Ptr_;
//- Values of the PDF at the X-coordinates
mutable autoPtr<scalarField> PDFPtr_;
// Private Member Functions
//- X-coordinates
const scalarField& x() const;
//- Values of the PDF at the X-coordinates
const scalarField& PDF() const;
protected:
// Protected Member Functions
//- Return values of the un-normalised PDF for the given size exponent
// and x-coordinates. Must be provided by derivations.
virtual tmp<scalarField> phi
(
const label q,
const scalarField& x
) const = 0;
//- Return values of the un-normalised CDF for the given size exponent
// and x-coordinates. Can be overloaded by derivations, for example, if
// there is a simpler analytic solution for certain effective size
// exponents (probably zero).
virtual tmp<scalarField> Phi
(
const label q,
const scalarField& x
) const;
//- Return values of the un-normalised CDF at the minimum and maximum
// x-coordinates for the given size exponent. Can be overloaded by
// derivations, for example, if there is a simpler analytic solution
// for certain effective size exponents (probably zero).
virtual Pair<scalar> Phi01(const label q) const;
//- Access cached values of the un-normalised CDF at the minimum and
// maximum x-coordinates.
const Pair<scalar>& Phi01() const;
public:
// Static Member Functions
//- Integrate the values y with respect to the coordinates x
static tmp<scalarField> integrate
(
const scalarField& x,
const scalarField& y
);
//- Integrate the values x*y with respect to the coordinates x
static tmp<scalarField> integrateX
(
const scalarField& x,
const scalarField& y
);
//- Integrate the values x^e*y with respect to the coordinates x,
// and interpolating onto a separate set of x coordinates
static tmp<scalarField> interpolateIntegrateXPow
(
const scalarField& xStar,
const label e,
const scalarField& yStar,
const scalarField& x
);
//- Sample an interval, given the interval's bounding x-coordinates,
// values Phi (the un-normalised CDF), and a random sample. First
// order interpolation.
static scalar sampleInterval
(
const Pair<scalar>& x,
const Pair<scalar>& Phi,
const scalar s
);
//- Sample an interval, given the interval's bounding x-coordinates,
// values phi and Phi (the un-normalised PDF and CDF), and a random
// sample. Second order interpolation.
static scalar sampleInterval
(
const Pair<scalar>& x,
const Pair<scalar>& phi,
const Pair<scalar>& Phi,
const scalar s
);
//- Sample a discretised distribution, given the x-coordinates,
// values Phi (the un-normalised CDF), and a random sample. First
// order interpolation.
static scalar sample
(
const scalarField& x,
const scalarField& Phi,
const scalar s
);
//- Sample a discretised distribution, given the x-coordinates, values
// phi and Phi (the un-normalised PDF and CDF), and a random sample.
// Second order interpolation.
static scalar sample
(
const scalarField& x,
const scalarField& phi,
const scalarField& Phi,
const scalar s
);
// Constructors
//- Construct from a dictionary
unintegrable
(
const word& name,
const unitSet& units,
const dictionary& dict,
const label sampleQ,
randomGenerator&& rndGen
);
//- Construct from components
unintegrable
(
const label Q,
const label sampleQ,
randomGenerator&& rndGen,
const label n
);
//- Construct copy
unintegrable(const unintegrable& d, const label sampleQ);
//- Destructor
virtual ~unintegrable();
// Member Functions
//- Sample the distribution
virtual scalar sample() const;
//- Sample the distribution
using distribution::sample;
//- 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;
//- Write to a stream
virtual void write(Ostream& os, const unitSet& units) const;
//- Return coordinates to plot across the range of the distribution
using distribution::plotX;
//- Return values to plot the probability density function
virtual tmp<scalarField> plotPDF(const scalarField& x) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace distributions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|