geometricZeroField.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-2018 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::geometricZeroField
26 
27 Description
28  A class representing the concept of a GeometricField of 1 used to avoid
29  unnecessary manipulations for objects which are known to be zero at
30  compile-time.
31 
32  Used for example as the density argument to a function written for
33  compressible to be used for incompressible flow.
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef geometricZeroField_H
38 #define geometricZeroField_H
39 
40 #include "zeroFieldField.H"
41 #include "dimensionSet.H"
42 #include "scalar.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class geometricZeroField Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public zero
56 {
57 
58 public:
59 
60  // Constructors
61 
62  //- Construct null
64  {}
65 
66 
67  // Member Operators
68 
69  inline const dimensionSet& dimensions() const;
70 
71  inline scalar operator[](const label) const;
72 
73  inline zeroField field() const;
74 
75  inline zeroField operator()() const;
76 
77  inline zeroField oldTime() const;
78 
79  inline zeroFieldField boundaryField() const;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #include "geometricZeroFieldI.H"
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
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
A class representing the concept of a field of zeroFields used to avoid unnecessary manipulations for...
Dimension set for the base types.
Definition: dimensionSet.H:120
A class representing the concept of a field of 0 used to avoid unnecessary manipulations for objects ...
Definition: zeroField.H:50
zeroFieldField boundaryField() const
scalar operator[](const label) const
geometricZeroField()
Construct null.
const dimensionSet & dimensions() const
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:49
zeroField operator()() const
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
Namespace for OpenFOAM.