exponential.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  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 Class
25  Foam::distributionModels::exponential
26 
27 Description
28  exponential distribution model
29 
30 SourceFiles
31  exponential.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef exponential_H
36 #define exponential_H
37 
38 #include "distributionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace distributionModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class exponential Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class exponential
52 :
53  public distributionModel
54 {
55  // Private Data
56 
57  //- Distribution minimum
58  scalar minValue_;
59 
60  //- Distribution maximum
61  scalar maxValue_;
62 
63 
64  // Model coefficients
65 
66  scalar lambda_;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("exponential");
73 
74 
75  // Constructors
76 
77  //- Construct from components
79 
80  //- Construct copy
81  exponential(const exponential& p);
82 
83  //- Construct and return a clone
84  virtual autoPtr<distributionModel> clone() const
85  {
86  return autoPtr<distributionModel>(new exponential(*this));
87  }
88 
89 
90  //- Destructor
91  virtual ~exponential();
92 
93 
94  // Member Functions
95 
96  //- Sample the distributionModel
97  virtual scalar sample() const;
98 
99  //- Return the minimum value
100  virtual scalar minValue() const;
101 
102  //- Return the maximum value
103  virtual scalar maxValue() const;
104 
105  //- Return the mean value
106  virtual scalar meanValue() const;
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace distributionModels
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
dictionary dict
virtual scalar minValue() const
Return the minimum value.
Definition: exponential.C:83
TypeName("exponential")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual scalar maxValue() const
Return the maximum value.
Definition: exponential.C:89
virtual scalar sample() const
Sample the distributionModel.
Definition: exponential.C:75
Random rndGen(label(0))
virtual ~exponential()
Destructor.
Definition: exponential.C:69
exponential distribution model
Definition: exponential.H:50
virtual scalar meanValue() const
Return the mean value.
Definition: exponential.C:95
Random number generator.
Definition: Random.H:57
virtual autoPtr< distributionModel > clone() const
Construct and return a clone.
Definition: exponential.H:83
A library of runtime-selectable distribution models.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
exponential(const dictionary &dict, Random &rndGen)
Construct from components.
Definition: exponential.C:43
Namespace for OpenFOAM.