File size: 3,705 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-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::unintegrableForNonZeroQ
Description
Base class for distributions that have a closed integral form for the
cumulative density function (CDF) when the effective size exponent is zero,
but not otherwise.
SourceFiles
unintegrableForNonZeroQ.C
See also
Foam::distribution
\*---------------------------------------------------------------------------*/
#ifndef unintegrableForNonZeroQ_H
#define unintegrableForNonZeroQ_H
#include "unintegrable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace distributions
{
/*---------------------------------------------------------------------------*\
Class unintegrableForNonZeroQ Declaration
\*---------------------------------------------------------------------------*/
class unintegrableForNonZeroQ
:
public unintegrable
{
protected:
// Protected Member Functions
//- Return values of the un-normalised CDF 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 = 0;
//- Return values of the un-normalised CDF at the minimum and maximum
// x-coordinates for the given size exponent.
virtual Pair<scalar> Phi01(const label q) const;
//- Access cached values of the un-normalised CDF at the minimum and
// maximum x-coordinates.
using unintegrable::Phi01;
public:
// Constructors
//- Inherit constructors
using unintegrable::unintegrable;
// Member Functions
//- Sample the distribution
virtual scalar sample() const;
//- Sample the distribution
virtual scalar sampleForZeroQ() const = 0;
//- 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;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace distributions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|