Constant.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::Function1Types::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 "Function1.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace Function1Types
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class Constant Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Type>
57 class Constant
58 :
59  public Function1<Type>
60 {
61  // Private data
62 
63  //- Constant value
64  Type value_;
65 
66 
67  // Private Member Functions
68 
69  //- Disallow default bitwise assignment
70  void operator=(const Constant<Type>&);
71 
72 
73 public:
74 
75  // Runtime type information
76  TypeName("constant");
77 
78 
79  // Constructors
80 
81  //- Construct from entry name and dictionary
82  Constant(const word& entryName, const dictionary& dict);
83 
84  //- Construct from entry name and Istream
85  // Reads the constant value without the Function1 type
86  // for backward compatibility
87  Constant(const word& entryName, Istream& is);
88 
89  //- Copy constructor
90  Constant(const Constant<Type>& cnst);
91 
92  //- Construct and return a clone
93  virtual tmp<Function1<Type>> clone() const
94  {
95  return tmp<Function1<Type>>(new Constant<Type>(*this));
96  }
97 
98 
99  //- Destructor
100  virtual ~Constant();
101 
102 
103  // Member Functions
104 
105  //- Return constant value
106  Type value(const scalar) const;
107 
108  //- Integrate between two values
109  Type integrate(const scalar x1, const scalar x2) const;
110 
111  //- Write in dictionary format
112  virtual void writeData(Ostream& os) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Function1Types
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #ifdef NoRepository
124  #include "Constant.C"
125  #include "Function1New.C"
126 #endif
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
const word const dictionary & dict
Definition: Function1.H:88
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Constant(const word &entryName, const dictionary &dict)
Construct from entry name and dictionary.
Definition: Constant.C:32
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Type value(const scalar) const
Return constant value.
Definition: Constant.C:76
const word & entryName
Definition: Function1.H:88
Type integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition: Constant.C:84
virtual ~Constant()
Destructor.
Definition: Constant.C:69
A class for handling words, derived from string.
Definition: word.H:59
Templated basic entry that holds a constant value.
Definition: Constant.H:56
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual tmp< Function1< Type > > clone() const
Construct and return a clone.
Definition: Constant.H:92
A class for managing temporary objects.
Definition: PtrList.H:54
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Constant.C:94
Namespace for OpenFOAM.