OneConstant.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "OneConstant.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class Type>
34 :
35  Function1<Type>(entryName)
36 {}
37 
38 
39 template<class Type>
41 (
42  const word& entryName,
43  const dictionary& dict
44 )
45 :
46  Function1<Type>(entryName, dict)
47 {}
48 
49 
50 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
51 
52 template<class Type>
54 (
55  const scalarField& x
56 ) const
57 {
58  return tmp<Field<Type>>::New(x.size(), pTraits<Type>::one);
59 }
60 
61 
62 template<class Type>
64 (
65  const scalarField& x1,
66  const scalarField& x2
67 ) const
68 {
69  return (x2 - x1)*pTraits<Type>::one;
70 }
71 
72 
73 template<class Type>
75 {
77 
78  os << token::END_STATEMENT << nl;
79 }
80 
81 
82 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::Function1Types::OneConstant::integrate
virtual Type integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition: OneConstantI.H:41
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:86
Foam::Function1Types::OneConstant::value
virtual Type value(const scalar) const
Return constant value.
Definition: OneConstantI.H:33
Foam::Field< scalar >
Foam::Function1::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: Function1.C:166
Foam::token::END_STATEMENT
End entry [isseparator].
Definition: token.H:121
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::Function1Types::OneConstant::OneConstant
OneConstant(const word &entryName)
Construct from entry name.
Definition: OneConstant.C:33
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::nl
constexpr char nl
Definition: Ostream.H:385
OneConstant.H
Foam::pTraits
Traits class for primitives.
Definition: pTraits.H:54
x
x
Definition: LISASMDCalcMethod2.H:52
Foam::Function1Types::OneConstant::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: OneConstant.C:74
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56