zeroFieldField.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 | Copyright (C) 2011 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::zeroFieldField
26 
27 Description
28  A class representing the concept of a field of zeroFields used to
29  avoid 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 zeroFieldField_H
38 #define zeroFieldField_H
39 
40 #include "zeroField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class zeroField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class zeroFieldField
52 :
53  public zero
54 {
55 
56 public:
57 
58  // Constructors
59 
60  //- Construct null
62  {}
63 
64 
65  // Member Operators
66 
67  inline zeroField operator[](const label) const;
68 };
69 
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 } // End namespace Foam
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 # include "zeroFieldFieldI.H"
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
zeroFieldField()
Construct null.
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 0 used to avoid unnecessary manipulations for objects ...
Definition: zeroField.H:50
Namespace for OpenFOAM.
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:47
zeroField operator[](const label) const
A class representing the concept of a field of zeroFields used to avoid unnecessary manipulations for...