Constant.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "Constant.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& entryName,
34  const dictionary& dict
35 )
36 :
37  Function1<Type>(entryName),
38  value_(Zero)
39 {
40  Istream& is(dict.lookup(entryName));
41  word entryType(is);
42  is >> value_;
43 }
44 
45 
46 template<class Type>
48 (
49  const word& entryName,
50  Istream& is
51 )
52 :
53  Function1<Type>(entryName),
54  value_(pTraits<Type>(is))
55 {}
56 
57 
58 template<class Type>
60 :
61  Function1<Type>(cnst),
62  value_(cnst.value_)
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
68 template<class Type>
70 {}
71 
72 
73 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
74 
75 template<class Type>
77 {
78  return value_;
79 }
80 
81 
82 template<class Type>
84 (
85  const scalar x1,
86  const scalar x2
87 ) const
88 {
89  return (x2 - x1)*value_;
90 }
91 
92 
93 template<class Type>
95 {
97 
98  os << token::SPACE << value_ << token::END_STATEMENT << nl;
99 }
100 
101 
102 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:53
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
Traits class for primitives.
Definition: pTraits.H:50
Type value(const scalar) const
Return constant value.
Definition: Constant.C:76
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:121
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
static const zero Zero
Definition: zero.H:91
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:262
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Constant.C:94
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:451