UniformField.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) 2013-2024 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::UniformField
26 
27 Description
28  A class representing the concept of a uniform field which stores only
29  the single value and providing the operator[] to return it.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef UniformField_H
34 #define UniformField_H
35 
36 #include "label.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class UniformField Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 template<class Type>
48 class UniformField
49 {
50  // Private Data
51 
52  Type value_;
53 
54 
55 public:
56 
57  // Public typedefs
58 
59  //- Component type
60  typedef typename pTraits<Type>::cmptType cmptType;
61 
62 
63  // Constructors
64 
65  //- Construct given value
66  inline UniformField(const Type& value);
67 
68 
69  // Member Operators
70 
71  inline operator Type() const;
72 
73  inline Type operator[](const label) const;
74 
75  inline UniformField primitiveField() const;
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #include "UniformFieldI.H"
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #endif
90 
91 // ************************************************************************* //
A class representing the concept of a uniform field which stores only the single value and providing ...
Definition: UniformField.H:48
UniformField(const Type &value)
Construct given value.
Definition: UniformFieldI.H:31
pTraits< Type >::cmptType cmptType
Component type.
Definition: UniformField.H:59
Type operator[](const label) const
Definition: UniformFieldI.H:45
UniformField primitiveField() const
Definition: UniformFieldI.H:52
Traits class for primitives.
Definition: pTraits.H:53
Namespace for OpenFOAM.
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