OneConstant.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) 2017-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 "OneConstant.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 :
33  Function1<Type>(entryName)
34 {}
35 
36 
37 template<class Type>
39 (
40  const word& entryName,
41  const dictionary& dict
42 )
43 :
45 {}
46 
47 
48 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
49 
50 template<class Type>
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56 
57 template<class Type>
59 (
60  const scalarField& x
61 ) const
62 {
64 }
65 
66 
67 template<class Type>
69 (
70  const scalarField& x1,
71  const scalarField& x2
72 ) const
73 {
74  return (x2 - x1)*pTraits<Type>::one;
75 }
76 
77 
78 template<class Type>
80 {
82 
83  os << token::END_STATEMENT << nl;
84 }
85 
86 
87 // ************************************************************************* //
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:158
virtual Type value(const scalar) const
Return constant value.
Definition: OneConstantI.H:31
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:163
Traits class for primitives.
Definition: pTraits.H:50
const word & entryName
Definition: Function1.H:85
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:150
A class for handling words, derived from string.
Definition: word.H:59
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:265
virtual Type integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition: OneConstantI.H:39
virtual ~OneConstant()
Destructor.
Definition: OneConstant.C:51
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: OneConstant.C:79
OneConstant(const word &entryName)
Construct from entry name.
Definition: OneConstant.C:31