src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2011 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::Constant
  26
  27 Description
  28     Templated basic entry that holds a constant value.
  29
  30     Usage - for entry \<entryName\> having the value <value>:
  31     \verbatim
  32         <entryName>    constant  <value>
  33     \endverbatim
  34
  35 SourceFiles
  36     Constant.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef Constant_H
  41 #define Constant_H
  42
  43 #include "DataEntry.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 template<class Type>
  51 class Constant;
  52
  53 template<class Type>
  54 Ostream& operator<<(Ostream&, const Constant<Type>&);
  55
  56 /*---------------------------------------------------------------------------*\
  57                            Class Constant Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 template<class Type>
  61 class Constant
  62 :
  63     public DataEntry<Type>
  64 {
  65     // Private data
  66
  67         //- Constant value
  68         Type value_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const Constant<Type>&);
  75
  76
  77 public:
  78
  79     // Runtime type information
  80     TypeName("constant");
  81
  82
  83     // Constructors
  84
  85         //- Construct from entry name and Istream
  86         Constant(const word& entryName, Istream& is);
  87
  88         //- Copy constructor
  89         Constant(const Constant<Type>& cnst);
  90
  91         //- Construct and return a clone
  92         virtual tmp<DataEntry<Type> > clone() const
  93         {
  94             return tmp<DataEntry<Type> >(new Constant<Type>(*this));
  95         }
  96
  97
  98     //- Destructor
  99     virtual ~Constant();
 100
 101
 102     // Member Functions
 103
 104         //- Return constant value
 105         Type value(const scalar) const;
 106
 107         //- Integrate between two values
 108         Type integrate(const scalar x1, const scalar x2) const;
 109
 110
 111     //- Ostream Operator
 112     friend Ostream& operator<< <Type>(Ostream&, const Constant<Type>&);
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #ifdef NoRepository
 123 #   include "Constant.C"
 124 #endif
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //