OpenFOAM: API Guide
v2012
The open source CFD toolbox
UniformValueFieldI.H
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) 2018-2020 OpenCFD Ltd.
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 "
UniformValueField.H
"
29
#include "
SubField.H
"
30
#include "
Constant.H
"
31
32
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
33
34
template
<
class
Type>
35
inline
bool
36
Foam::PatchFunction1Types::UniformValueField<Type>::constant
()
const
37
{
38
return
uniformValuePtr_->type() ==
Function1Types::Constant<Type>::typeName
;
39
}
40
41
42
template
<
class
Type>
43
inline
Foam::tmp<Foam::Field<Type>
>
44
Foam::PatchFunction1Types::UniformValueField<Type>::value
45
(
46
const
scalar
x
47
)
const
48
{
49
auto
tfld =
50
tmp<Field<Type>
>
::New
51
(
52
this->size(),
53
uniformValuePtr_->value(
x
)
54
);
55
56
return
this->
transform
(tfld);
57
}
58
59
60
template
<
class
Type>
61
inline
Foam::tmp<Foam::Field<Type>
>
62
Foam::PatchFunction1Types::UniformValueField<Type>::integrate
63
(
64
const
scalar x1,
65
const
scalar x2
66
)
const
67
{
68
auto
tfld =
69
tmp<Field<Type>
>
::New
70
(
71
this->size(),
72
uniformValuePtr_->integrate(x1, x2)
73
);
74
75
return
this->
transform
(tfld);
76
}
77
78
79
// ************************************************************************* //
UniformValueField.H
SubField.H
Foam::tmp
A class for managing temporary objects.
Definition:
PtrList.H:61
Foam::PatchFunction1Types::UniformValueField::value
virtual tmp< Field< Type > > value(const scalar x) const
Return UniformValueField value.
Definition:
UniformValueFieldI.H:45
Foam::transform
dimensionSet transform(const dimensionSet &ds)
Return the argument; transformations do not change the dimensions.
Definition:
dimensionSet.C:519
Foam::PatchFunction1Types::UniformValueField::constant
virtual bool constant() const
Is value constant (i.e. independent of x)
Definition:
UniformValueFieldI.H:36
Foam::Function1Types::Constant
Templated function that returns a constant value.
Definition:
Constant.H:59
Foam::PatchFunction1Types::UniformValueField::integrate
virtual tmp< Field< Type > > integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition:
UniformValueFieldI.H:63
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
x
x
Definition:
LISASMDCalcMethod2.H:52
Constant.H
src
meshTools
PatchFunction1
UniformValueField
UniformValueFieldI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.