OpenFOAM: API Guide
v2112
The open source CFD toolbox
zeroField.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) 2011-2017 OpenFOAM Foundation
9
Copyright (C) 2019 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::zeroField
29
30
Description
31
A class representing the concept of a field of 0 used to avoid unnecessary
32
manipulations for objects which are known to be zero at compile-time.
33
34
Used for example as the argument to a function in which certain terms are
35
optional, see source terms in the MULES solvers.
36
37
\*---------------------------------------------------------------------------*/
38
39
#ifndef zeroField_H
40
#define zeroField_H
41
42
#include "
zero.H
"
43
#include "
scalar.H
"
44
45
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47
namespace
Foam
48
{
49
50
/*---------------------------------------------------------------------------*\
51
Class zeroField Declaration
52
\*---------------------------------------------------------------------------*/
53
54
class
zeroField
55
:
56
public
zero
57
{
58
public
:
59
60
// Constructors
61
62
//- Default construct
63
zeroField
() noexcept =
default
;
64
65
66
// Member Functions
67
68
zeroField
field
() const noexcept
69
{
70
return
zeroField
{};
71
}
72
73
74
// Member Operators
75
76
scalar
operator[]
(
const
label)
const
noexcept
77
{
78
return
scalar(0);
79
}
80
81
zeroField
operator()
() const noexcept
82
{
83
return
zeroField
{};
84
}
85
86
zeroField
operator-
() const noexcept
87
{
88
return
zeroField
{};
89
}
90
};
91
92
93
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94
95
}
// End namespace Foam
96
97
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99
// Global Operators
100
101
#include "
zeroFieldI.H
"
102
103
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105
#endif
106
107
// ************************************************************************* //
Foam::zeroField
A class representing the concept of a field of 0 used to avoid unnecessary manipulations for objects ...
Definition:
zeroField.H:53
Foam::zeroField::operator()
zeroField operator()() const noexcept
Definition:
zeroField.H:80
Foam::zeroField::field
zeroField field() const noexcept
Definition:
zeroField.H:67
Foam::zeroField::operator-
zeroField operator-() const noexcept
Definition:
zeroField.H:85
zero.H
scalar.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::zeroField::zeroField
zeroField() noexcept=default
Default construct.
Foam::zeroField::operator[]
scalar operator[](const label) const noexcept
Definition:
zeroField.H:75
zeroFieldI.H
Foam::zero
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition:
zero.H:62
src
OpenFOAM
fields
Fields
zeroField
zeroField.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.