OpenFOAM
v2312
The open source CFD toolbox
UniformField.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) 2013 OpenFOAM Foundation
9
Copyright (C) 2020 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
Class
28
Foam::UniformField
29
30
Description
31
A class representing the concept of a uniform field which stores only
32
the single value and providing the operator[] to return it.
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef Foam_UniformField_H
37
#define Foam_UniformField_H
38
39
#include "
UniformList.H
"
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class UniformField Declaration
48
\*---------------------------------------------------------------------------*/
49
50
template
<
class
Type>
51
class
UniformField
52
:
53
public
UniformList
<Type>
54
{
55
public
:
56
57
// Constructors
58
59
//- Inherit constructors from UniformList
60
using
UniformList<Type>::UniformList
;
61
62
63
// Member Functions
64
65
//- Method name compatibility with DimensionedField
66
UniformField
field
()
const
67
{
68
return
UniformField
(
UniformList<Type>::value
());
69
}
70
};
71
72
73
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74
75
}
// End namespace Foam
76
77
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78
79
#include "
UniformFieldI.H
"
80
81
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82
83
#endif
84
85
// ************************************************************************* //
Foam::UniformField
A class representing the concept of a uniform field which stores only the single value and providing ...
Definition:
UniformField.H:44
Foam::UniformField::field
UniformField field() const
Method name compatibility with DimensionedField.
Definition:
UniformField.H:63
UniformList.H
Foam::UniformList
A single value that is represented as a list with an operator[] to access the value. This can be useful for templated operations expecting a list accessor.
Definition:
UniformList.H:48
UniformFieldI.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
src
OpenFOAM
fields
Fields
UniformField
UniformField.H
Generated by
1.8.14