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  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "OneConstant.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  const word& entryName,
37  const objectRegistry* obrPtr
38 )
39 :
40  Function1<Type>(entryName, obrPtr)
41 {}
42 
43 
44 template<class Type>
46 (
47  const word& entryName,
48  const dictionary& dict,
49  const objectRegistry* obrPtr
50 )
51 :
52  Function1<Type>(entryName, dict, obrPtr)
53 {}
54 
55 
56 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
57 
58 template<class Type>
60 (
61  const scalarField& x
62 ) const
63 {
64  return tmp<Field<Type>>::New(x.size(), pTraits<Type>::one);
65 }
66 
67 
68 template<class Type>
70 (
71  const scalarField& x1,
72  const scalarField& x2
73 ) const
74 {
75  return (x2 - x1)*pTraits<Type>::one;
76 }
77 
78 
79 template<class Type>
81 {
83  os.endEntry();
84 }
85 
86 
87 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::Function1Types::OneConstant::OneConstant
OneConstant(const word &entryName, const objectRegistry *obrPtr=nullptr)
Construct from entry name and optional registry.
Definition: OneConstant.C:35
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
writeData
const bool writeData(pdfDictionary.get< bool >("writeData"))
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: propellerInfo.H:291
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
Foam::Function1Types::OneConstant::value
virtual Type value(const scalar) const
Return constant value.
Definition: OneConstantI.H:33
Foam::Field< scalar >
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:123
os
OBJstream os(runTime.globalPath()/outputName)
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
OneConstant.H
Foam::pTraits
A traits class, which is primarily used for primitives.
Definition: pTraits.H:56
x
x
Definition: LISASMDCalcMethod2.H:52
Foam::Function1Types::OneConstant::writeData
virtual void writeData(Ostream &os) const
Write as primitive (inline) format.
Definition: OneConstant.C:80
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56