Constant.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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 function that returns a constant value.
29 
30  Usage - for entry <entryName> returning 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 public:
68 
69  // Runtime type information
70  TypeName("constant");
71 
72 
73  // Constructors
74 
75  //- Construct from entry name and value
76  Constant(const word& entryName, const Type& val);
77 
78  //- Construct from entry name and dictionary
79  Constant(const word& entryName, const dictionary& dict);
80 
81  //- Construct from entry name and Istream
82  // Reads the constant value without the Function1 type
83  // for backward compatibility
84  Constant(const word& entryName, Istream& is);
85 
86  //- Copy constructor
87  Constant(const Constant<Type>& cnst);
88 
89  //- Construct and return a clone
90  virtual tmp<Function1<Type>> clone() const
91  {
92  return tmp<Function1<Type>>(new Constant<Type>(*this));
93  }
94 
95 
96  //- Destructor
97  virtual ~Constant();
98 
99 
100  // Member Functions
101 
102  //- Return constant value
103  virtual inline Type value(const scalar) const;
104 
105  //- Integrate between two values
106  virtual inline Type integrate(const scalar x1, const scalar x2) const;
107 
108  //- Return value as a function of (scalar) independent variable
109  virtual tmp<Field<Type>> value(const scalarField& x) const;
110 
111  //- Integrate between two (scalar) values
112  virtual tmp<Field<Type>> integrate
113  (
114  const scalarField& x1,
115  const scalarField& x2
116  ) const;
117 
118  //- Write in dictionary format
119  virtual void writeData(Ostream& os) const;
120 
121 
122  // Member Operators
123 
124  //- Disallow default bitwise assignment
125  void operator=(const Constant<Type>&) = delete;
126 };
127 
128 
129 template<>
131 (
132  const scalarField& x1,
133  const scalarField& x2
134 ) const;
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace Function1Types
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #include "ConstantI.H"
145 
146 #ifdef NoRepository
147  #include "Constant.C"
148  #include "Function1New.C"
149 #endif
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
Constant(const word &entryName, const Type &val)
Construct from entry name and value.
Definition: Constant.C:32
void operator=(const Constant< Type > &)=delete
Disallow default bitwise assignment.
const word const dictionary & dict
Definition: Function1.H:85
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual tmp< Function1< Type > > clone() const
Construct and return a clone.
Definition: Constant.H:89
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual Type value(const scalar) const
Return constant value.
Definition: ConstantI.H:31
const word & entryName
Definition: Function1.H:85
virtual Type integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition: ConstantI.H:39
virtual ~Constant()
Destructor.
Definition: Constant.C:81
A class for handling words, derived from string.
Definition: word.H:59
Templated function that returns 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 void writeData(Ostream &os) const
Write in dictionary format.
Definition: Constant.C:109
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.