FreeFOAM The Cross-Platform CFD Toolkit
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) 2010-2010 OpenCFD Ltd.
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 pdfFixedValue_H
36 #define pdfFixedValue_H
37 
38 #include <pdf/pdf.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace pdfs
45 {
46 /*---------------------------------------------------------------------------*\
47  Class fixedValue Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public pdf
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  const dictionary& dict,
72  Random& rndGen
73  );
74 
75 
76  //- Destructor
77  virtual ~fixedValue();
78 
79 
80  // Member Functions
81 
82  //- Sample the pdf
83  virtual scalar sample() const;
84 
85  //- Return the minimum value
86  virtual scalar minValue() const;
87 
88  //- Return the maximum value
89  virtual scalar maxValue() const;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace pdfs
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //