FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

fixedValue.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::fixedValue
00026 
00027 Description
00028     Returns a fixed value
00029 
00030 SourceFiles
00031     fixedValue.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef pdfFixedValue_H
00036 #define pdfFixedValue_H
00037 
00038 #include <pdf/pdf.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 namespace pdfs
00045 {
00046 /*---------------------------------------------------------------------------*\
00047                        Class fixedValue Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class fixedValue
00051 :
00052     public pdf
00053 {
00054     // Private data
00055 
00056         //- Fixed value
00057         scalar value_;
00058 
00059 
00060 public:
00061 
00062     //- Runtime type information
00063     TypeName("fixedValue");
00064 
00065 
00066     // Constructors
00067 
00068         //- Construct from components
00069         fixedValue
00070         (
00071             const dictionary& dict,
00072             Random& rndGen
00073         );
00074 
00075 
00076     //- Destructor
00077     virtual ~fixedValue();
00078 
00079 
00080     // Member Functions
00081 
00082          //- Sample the pdf
00083         virtual scalar sample() const;
00084 
00085         //- Return the minimum value
00086         virtual scalar minValue() const;
00087 
00088         //- Return the maximum value
00089         virtual scalar maxValue() const;
00090 };
00091 
00092 
00093 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00094 
00095 } // End namespace pdfs
00096 } // End namespace Foam
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 #endif
00101 
00102 // ************************************************************************* //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines