Constant.C
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-2018 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 \*---------------------------------------------------------------------------*/
25 
26 #include "Constant.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& entryName,
34  const Type& val
35 )
36 :
37  Function1<Type>(entryName),
38  value_(val)
39 {}
40 
41 
42 template<class Type>
44 (
45  const word& entryName,
46  const dictionary& dict
47 )
48 :
49  Function1<Type>(entryName),
50  value_(Zero)
51 {
52  Istream& is(dict.lookup(entryName));
53  word entryType(is);
54  is >> value_;
55 }
56 
57 
58 template<class Type>
60 (
61  const word& entryName,
62  Istream& is
63 )
64 :
65  Function1<Type>(entryName),
66  value_(pTraits<Type>(is))
67 {}
68 
69 
70 template<class Type>
72 :
73  Function1<Type>(cnst),
74  value_(cnst.value_)
75 {}
76 
77 
78 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
79 
80 template<class Type>
82 {}
83 
84 
85 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
86 
87 template<class Type>
89 (
90  const scalarField& x
91 ) const
92 {
93  return tmp<Field<Type>>(new Field<Type>(x.size(), value_));
94 }
95 
96 
97 template<class Type>
99 (
100  const scalarField& x1,
101  const scalarField& x2
102 ) const
103 {
104  return (x2 - x1)*value_;
105 }
106 
107 
108 template<class Type>
110 {
112 
113  os << token::SPACE << value_ << token::END_STATEMENT << nl;
114 }
115 
116 
117 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Constant(const word &entryName, const Type &val)
Construct from entry name and value.
Definition: Constant.C:32
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:163
virtual Type value(const scalar) const
Return constant value.
Definition: ConstantI.H:31
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
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:146
A class for handling words, derived from string.
Definition: word.H:59
Templated function that returns a constant value.
Definition: Constant.H:56
static const zero Zero
Definition: zero.H:97
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
static const char nl
Definition: Ostream.H:265
A class for managing temporary objects.
Definition: PtrList.H:53
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:576