RosinRammler.H 3 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    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.
15
16
17
18
19
20
21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23
24
25
26
27
28
29
30

Class
    Foam::RosinRammler

Description
    Rosin-Rammler pdf

   @f[
31
32
33
       cumulative pdf =
           (1.0 - exp( -(( x - d0)/d)^n )
         / (1.0 - exp( -((d1 - d0)/d)^n )
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
   @f]


SourceFiles
    RosinRammler.C

\*---------------------------------------------------------------------------*/

#ifndef RosinRammler_H
#define RosinRammler_H

#include "pdf.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
51
52
namespace pdfs
{
53
54

/*---------------------------------------------------------------------------*\
55
                       Class RosinRammler Declaration
56
57
58
59
60
61
62
63
\*---------------------------------------------------------------------------*/

class RosinRammler
:
    public pdf
{
    // Private data

64
        //- Distribution minimum
65
        scalar minValue_;
66
67

        //- Distribution maximum
68
69
        scalar maxValue_;

70
        // Model coefficients
71

72
73
            scalar d_;
            scalar n_;
74

Andrew Heather's avatar
Andrew Heather committed
75

76
77
78
public:

    //- Runtime type information
Andrew Heather's avatar
Andrew Heather committed
79
    TypeName("RosinRammler");
80
81
82
83
84


    // Constructors

        //- Construct from components
85
86
87
88
89
90
91
92
93
94
        RosinRammler(const dictionary& dict, cachedRandom& rndGen);

        //- Construct copy
        RosinRammler(const RosinRammler& p);

        //- Construct and return a clone
        virtual autoPtr<pdf> clone() const
        {
            return autoPtr<pdf>(new RosinRammler(*this));
        }
95
96


Andrew Heather's avatar
Andrew Heather committed
97
98
    //- Destructor
    virtual ~RosinRammler();
99
100
101
102


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
103
104
         //- Sample the pdf
        virtual scalar sample() const;
105

Andrew Heather's avatar
Andrew Heather committed
106
107
        //- Return the minimum value
        virtual scalar minValue() const;
108

Andrew Heather's avatar
Andrew Heather committed
109
110
        //- Return the maximum value
        virtual scalar maxValue() const;
111
112
113
114
115
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

116
} // End namespace pdfs
117
118
119
120
121
122
123
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //