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