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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9  Copyright (C) 2019-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::zeroFieldField
29 
30 Description
31  A class representing the concept of a field of zeroFields used to
32  avoid unnecessary manipulations for objects which are known to be zero at
33  compile-time.
34 
35  Used for example as the density argument to a function written for
36  compressible to be used for incompressible flow.
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef zeroFieldField_H
41 #define zeroFieldField_H
42 
43 #include "zeroField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class zeroFieldField Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class zeroFieldField
55 :
56  public zero
57 {
58 public:
59 
60  // Constructors
61 
62  //- Default construct
63  zeroFieldField() noexcept = default;
64 
65 
66  // Member Operators
67 
68  zeroField operator[](const label) const noexcept
69  {
70  return zeroField{};
71  }
72 };
73 
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 } // End namespace Foam
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
Foam::zeroFieldField::operator[]
zeroField operator[](const label) const noexcept
Definition: zeroFieldField.H:67
Foam::zeroField
A class representing the concept of a field of 0 used to avoid unnecessary manipulations for objects ...
Definition: zeroField.H:53
zeroField.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::zeroFieldField::zeroFieldField
zeroFieldField() noexcept=default
Default construct.
Foam::zeroFieldField
A class representing the concept of a field of zeroFields used to avoid unnecessary manipulations for...
Definition: zeroFieldField.H:53
Foam::zero
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition: zero.H:62