fixedValue.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 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::fixedValue
26 
27 Description
28  Returns a fixed value
29 
30 SourceFiles
31  fixedValue.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef distributionModelFixedValue_H
36 #define distributionModelFixedValue_H
37 
38 #include "distributionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace distributionModels
45 {
46 /*---------------------------------------------------------------------------*\
47  Class fixedValue Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class fixedValue
51 :
52  public distributionModel
53 {
54  // Private data
55 
56  //- Fixed value
57  scalar value_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("fixedValue");
64 
65 
66  // Constructors
67 
68  //- Construct from components
70 
71  //- Construct copy
72  fixedValue(const fixedValue& p);
73 
74  //- Construct and return a clone
75  virtual autoPtr<distributionModel> clone() const
76  {
77  return autoPtr<distributionModel>(new fixedValue(*this));
78  }
79 
80 
81  //- Destructor
82  virtual ~fixedValue();
83 
84 
85  // Member Functions
86 
87  //- Sample the distributionModel
88  virtual scalar sample() const;
89 
90  //- Return the minimum value
91  virtual scalar minValue() const;
92 
93  //- Return the maximum value
94  virtual scalar maxValue() const;
95 
96  //- Return the mean value
97  virtual scalar meanValue() const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace distributionModels
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
dictionary dict
virtual scalar maxValue() const
Return the maximum value.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
fixedValue(const dictionary &dict, cachedRandom &rndGen)
Construct from components.
Definition: fixedValue.C:43
Random number generator.
Definition: cachedRandom.H:63
virtual autoPtr< distributionModel > clone() const
Construct and return a clone.
Definition: fixedValue.H:74
virtual scalar sample() const
Sample the distributionModel.
cachedRandom rndGen(label(0), -1)
virtual scalar minValue() const
Return the minimum value.
TypeName("fixedValue")
Runtime type information.
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
virtual ~fixedValue()
Destructor.
Definition: fixedValue.C:62
Namespace for OpenFOAM.
virtual scalar meanValue() const
Return the mean value.