All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UniformGeometricField.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::UniformGeometricField
26 
27 Description
28  Dimensioned<Type> registered with the database as a registered IOobject
29  which has the functionality of a uniform field and allows values from the
30  top-level code to be passed to boundary conditions etc.
31 
32 SourceFiles
33  UniformGeometricField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef UniformGeometricField_H
38 #define UniformGeometricField_H
39 
41 #include "UniformFieldField.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class UniformGeometricField Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public UniformDimensionedField<Type>
56 {
57 public:
58 
59  // Public Typedefs
60 
64  typedef Type cmptType;
65 
66 
67  //- Runtime type information
68  TypeName("UniformGeometricField");
69 
70 
71  // Constructors
72 
73  //- Construct from components. Either reads or uses supplied value.
75 
76  //- Copy constructor
78 
79  //- Construct from Istream
81 
82 
83  //- Destructor
84  virtual ~UniformGeometricField();
85 
86 
87  // Member Operators
88 
89  inline const UniformGeometricField<Type>& oldTime() const;
90 
91  inline const Internal& operator()() const;
92 
93  inline const Internal& v() const;
94 
95  inline typename Internal::FieldType primitiveField() const;
96 
97  inline Boundary boundaryField() const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #ifdef NoRepository
108  #include "UniformGeometricField.C"
109  #include "UniformGeometricFieldI.H"
110 #endif
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
A class representing the concept of a uniform field which stores only the single value and providing ...
Definition: UniformField.H:47
A class representing the concept of a field of uniform fields which stores only the single value and ...
Dimensioned<Type> registered with the database as a registered IOobject which has the functionality o...
const UniformGeometricField< Type > & oldTime() const
Generic dimensioned Type class.
Internal::FieldType primitiveField() const
UniformFieldField< Type > Boundary
Dimensioned<Type> registered with the database as a registered IOobject which has the functionality o...
const Internal & operator()() const
virtual ~UniformGeometricField()
Destructor.
UniformDimensionedField< Type > Internal
const Internal & v() const
TypeName("UniformGeometricField")
Runtime type information.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
Namespace for OpenFOAM.
UniformGeometricField(const IOobject &, const dimensioned< Type > &)
Construct from components. Either reads or uses supplied value.