oneField.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-2020 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::oneField
26 
27 Description
28  A class representing the concept of a field of 1 used to avoid unnecessary
29  manipulations for objects which are known to be one at compile-time.
30 
31  Used for example as the density argument to a function written for
32  compressible to be used for incompressible flow.
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef oneField_H
37 #define oneField_H
38 
39 #include "one.H"
40 #include "scalar.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class oneField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class oneField
52 :
53  public one
54 {
55 
56 public:
57 
58  // Public Typedefs
59 
60  typedef oneField FieldType;
61 
62 
63  // Constructors
64 
65  //- Construct null
66  oneField()
67  {}
68 
69 
70  // Member Operators
71 
72  inline one operator[](const label) const;
73 
74  inline oneField field() const;
75 };
76 
77 
78 inline const oneField& operator*(const oneField&, const oneField&);
79 
80 inline const oneField& operator/(const oneField&, const oneField&);
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #include "oneFieldI.H"
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
one operator[](const label) const
Definition: oneFieldI.H:30
tmp< fvMatrix< Type > > operator*(const volScalarField::Internal &, const fvMatrix< Type > &)
oneField FieldType
Definition: oneField.H:59
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
oneField()
Construct null.
Definition: oneField.H:65
tmp< fvMatrix< Type > > operator/(const fvMatrix< Type > &, const volScalarField::Internal &)
A class representing the concept of a field of 1 used to avoid unnecessary manipulations for objects ...
Definition: oneField.H:50
oneField field() const
Definition: oneFieldI.H:36
Namespace for OpenFOAM.
A class representing the concept of 1 (scalar(1)) used to avoid unnecessary manipulations for objects...
Definition: one.H:50