zeroField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::zeroField
26 
27 Description
28  A class representing the concept of a field of 0 used to avoid unnecessary
29  manipulations for objects which are known to be zero at compile-time.
30 
31  Used for example as the argument to a function in which certain terms are
32  optional, see source terms in the MULES solvers.
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef zeroField_H
37 #define zeroField_H
38 
39 #include "zero.H"
40 #include "scalar.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class zeroField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class zeroField
52 :
53  public zero
54 {
55 public:
56 
57  // Public Typedefs
58 
59  typedef zeroField FieldType;
60 
61 
62  // Constructors
63 
64  //- Construct null
65  zeroField()
66  {}
67 
68 
69  // Member Operators
70 
71  inline scalar operator[](const label) const;
72 
73  inline zeroField primitiveField() const;
74 
75  inline zeroField operator()() const;
76 
77  inline zeroField operator-() const;
78 };
79 
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 } // End namespace Foam
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 #include "zeroFieldI.H"
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
A class representing the concept of a field of 0 used to avoid unnecessary manipulations for objects ...
Definition: zeroField.H:53
zeroField operator-() const
Definition: zeroFieldI.H:48
scalar operator[](const label) const
Definition: zeroFieldI.H:30
zeroField primitiveField() const
Definition: zeroFieldI.H:36
zeroField FieldType
Definition: zeroField.H:58
zeroField operator()() const
Definition: zeroFieldI.H:42
zeroField()
Construct null.
Definition: zeroField.H:64
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:50
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59