GeometricFieldI.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-2018 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
28 template<class Type, template<class> class PatchField, class GeoMesh>
31 {
32  return NullObjectRef<GeometricField<Type, PatchField, GeoMesh>>();
33 }
34 
35 
36 template<class Type, template<class> class PatchField, class GeoMesh>
37 inline
38 const typename
41 internalField() const
42 {
43  return *this;
44 }
45 
46 
47 template<class Type, template<class> class PatchField, class GeoMesh>
48 inline
49 const typename
52 {
53  return *this;
54 }
55 
56 
57 template<class Type, template<class> class PatchField, class GeoMesh>
59 Boundary&
61 {
62  return boundaryField_;
63 }
64 
65 
66 template<class Type, template<class> class PatchField, class GeoMesh>
67 inline Foam::label
69 {
70  return timeIndex_;
71 }
72 
73 
74 template<class Type, template<class> class PatchField, class GeoMesh>
75 inline Foam::label&
77 {
78  return timeIndex_;
79 }
80 
81 
82 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
83 
84 template<class Type, template<class> class PatchField, class GeoMesh>
85 inline
86 const typename
89 operator()() const
90 {
91  return *this;
92 }
93 
94 
95 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Pre-declare SubField and related Field type.
Definition: Field.H:82
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:47
Generic GeometricField class.
label timeIndex() const
Return the time index of the field.
const Internal::FieldType & primitiveField() const
Return a const-reference to the internal field.
const Boundary & boundaryField() const
Return const-reference to the boundary field.
static const GeometricField< Type, PatchField, GeoMesh > & null()
Return a null geometric field.
const Internal & operator()() const
Return a const-reference to the dimensioned internal field.
const Internal & internalField() const
Return a const-reference to the dimensioned internal field.
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