geometricOneField.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-2019 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::geometricOneField
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 one 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 geometricOneField_H
38 #define geometricOneField_H
39 
40 #include "oneFieldField.H"
41 #include "dimensionSet.H"
42 #include "scalar.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class geometricOneField Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public one
56 {
57 
58 public:
59 
60  // Public Typedefs
61 
62  typedef oneField Internal;
63  typedef oneField Patch;
65  typedef one cmptType;
66 
67  // Constructors
68 
69  //- Construct null
71  {}
72 
73 
74  // Member Operators
75 
76  inline const dimensionSet& dimensions() const;
77 
78  inline one operator[](const label) const;
79 
80  inline oneField field() const;
81 
82  inline oneField oldTime() const;
83 
84  inline Internal operator()() const;
85 
86  inline Internal v() const;
87 
88  inline typename Internal::FieldType primitiveField() const;
89 
90  inline Boundary boundaryField() const;
91 };
92 
93 
94 inline const geometricOneField& operator*
95 (
96  const geometricOneField&,
97  const geometricOneField&
98 );
99 
100 inline const geometricOneField::Internal& operator*
101 (
103  const geometricOneField&
104 );
105 
106 inline const geometricOneField::Internal& operator*
107 (
108  const geometricOneField&,
109  const geometricOneField::Internal&
110 );
111 
112 inline const geometricOneField& operator/
113 (
114  const geometricOneField&,
115  const geometricOneField&
116 );
117 
118 inline const geometricOneField::Internal& operator/
119 (
120  const geometricOneField::Internal&,
121  const geometricOneField&
122 );
123 
124 inline const geometricOneField::Internal& operator/
125 (
126  const geometricOneField&,
127  const geometricOneField::Internal&
128 );
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #include "geometricOneFieldI.H"
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Internal operator()() const
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 oneFields used to avoid unnecessary manipulations for ...
Definition: oneFieldField.H:50
Dimension set for the base types.
Definition: dimensionSet.H:120
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
const dimensionSet & dimensions() const
geometricOneField()
Construct null.
one operator[](const label) const
Internal::FieldType primitiveField() const
A class representing the concept of a field of 1 used to avoid unnecessary manipulations for objects ...
Definition: oneField.H:50
Boundary boundaryField() const
Namespace for OpenFOAM.
A class representing the concept of 1 (scalar(1)) used to avoid unnecessary manipulations for objects...
Definition: one.H:50