UniformField.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) 2013 OpenFOAM Foundation
9  Copyright (C) 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::UniformField
29 
30 Description
31  A class representing the concept of a uniform field which stores only
32  the single value and providing the operator[] to return it.
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef UniformField_H
37 #define UniformField_H
38 
39 #include "label.H"
40 #include "UniformList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class UniformField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
52 class UniformField
53 :
54  public UniformList<Type>
55 {
56 public:
57 
58  // Constructors
59 
60  //- Inherit constructors from UniformList
61  using UniformList<Type>::UniformList;
62 
63 
64  // Member Functions
65 
66  UniformField field() const
67  {
68  return UniformField(UniformList<Type>::value());
69  }
70 };
71 
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 } // End namespace Foam
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 #include "UniformFieldI.H"
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
Foam::UniformField::field
UniformField field() const
Definition: UniformField.H:65
Foam::UniformList
A single value that is represented as a list with an operator[] to access the value....
Definition: UniformList.H:54
Foam::UniformField
A class representing the concept of a uniform field which stores only the single value and providing ...
Definition: UniformField.H:51
UniformList.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
UniformFieldI.H
label.H