GeometricFieldI.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) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class Type, template<class> class PatchField, class GeoMesh>
33 {
34  return NullObjectRef<GeometricField<Type, PatchField, GeoMesh>>();
35 }
36 
37 
38 template<class Type, template<class> class PatchField, class GeoMesh>
39 inline
40 const typename
44 {
45  return *this;
46 }
47 
48 
49 template<class Type, template<class> class PatchField, class GeoMesh>
50 inline
51 const typename
54 {
55  return *this;
56 }
57 
58 
59 template<class Type, template<class> class PatchField, class GeoMesh>
61 Boundary&
63 {
64  return boundaryField_;
65 }
66 
67 
68 template<class Type, template<class> class PatchField, class GeoMesh>
69 inline Foam::label
71 {
72  return timeIndex_;
73 }
74 
75 
76 template<class Type, template<class> class PatchField, class GeoMesh>
77 inline Foam::label&
79 {
80  return timeIndex_;
81 }
82 
83 
84 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
85 
86 template<class Type, template<class> class PatchField, class GeoMesh>
87 inline
88 const typename
91 operator()() const
92 {
93  return *this;
94 }
95 
96 
97 // ************************************************************************* //
Foam::GeometricField::primitiveField
const Internal::FieldType & primitiveField() const
Return a const-reference to the internal field.
Definition: GeometricFieldI.H:53
Foam::GeometricField::internalField
const Internal & internalField() const
Return a const-reference to the dimensioned internal field.
Definition: GeometricFieldI.H:43
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:48
Foam::GeometricField::timeIndex
label timeIndex() const
Return the time index of the field.
Definition: GeometricFieldI.H:70
Foam::GeometricField::operator()
const Internal & operator()() const
Return a const-reference to the dimensioned internal field.
Definition: GeometricFieldI.H:91
Foam::GeometricField::null
static const GeometricField< Type, PatchField, GeoMesh > & null()
Return a null geometric field.
Definition: GeometricFieldI.H:32
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53
Foam::GeometricField::boundaryField
const Boundary & boundaryField() const
Return const-reference to the boundary field.
Definition: GeometricFieldI.H:62
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54