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-2021 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& name,
34  const Type& val
35 )
36 :
38  value_(val)
39 {}
40 
41 
42 template<class Type>
44 (
45  const word& name,
46  const dictionary& dict
47 )
48 :
50  value_(Zero)
51 {
52  if (name == "value" || !dict.found(name))
53  {
54  dict.lookup("value") >> value_;
55  }
56  else
57  {
58  Istream& is(dict.lookup(name));
59  word entryType(is);
60 
61  if (is.eof())
62  {
63  dict.lookup("value") >> value_;
64  }
65  else
66  {
67  is >> value_;
68  }
69  }
70 }
71 
72 
73 template<class Type>
75 (
76  const word& name,
77  Istream& is
78 )
79 :
81  value_(pTraits<Type>(is))
82 {}
83 
84 
85 template<class Type>
87 :
88  FieldFunction1<Type, Constant<Type>>(cnst),
89  value_(cnst.value_)
90 {}
91 
92 
93 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
94 
95 template<class Type>
97 {}
98 
99 
100 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
101 
102 template<class Type>
104 {
105  writeEntry(os, "value", value_);
106 }
107 
108 
109 // ************************************************************************* i/
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:663
Constant(const word &name, const Type &val)
Construct from 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:156
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
static const zero Zero
Definition: zero.H:97
bool eof() const
Return true if end of input seen.
Definition: IOstream.H:336
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void write(Ostream &os) const
Write in dictionary format.
Definition: Constant.C:103
virtual ~Constant()
Destructor.
Definition: Constant.C:96
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Templated function that returns a constant value.
Definition: Constant.H:57
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:864