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  Copyright (C) 2022 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 \*---------------------------------------------------------------------------*/
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
31 template<class Type, template<class> class PatchField, class GeoMesh>
34 {
35  return NullObjectRef<GeometricField<Type, PatchField, GeoMesh>>();
36 }
37 
38 
39 template<class Type, template<class> class PatchField, class GeoMesh>
40 inline const typename
43 {
44  return *this;
45 }
46 
47 
48 template<class Type, template<class> class PatchField, class GeoMesh>
49 inline const typename
52 {
53  return *this;
54 }
55 
56 
57 template<class Type, template<class> class PatchField, class GeoMesh>
58 inline const typename
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 // ************************************************************************* //
const Internal::FieldType & primitiveField() const noexcept
Return a const-reference to the internal field values.
const Internal & internalField() const noexcept
Return a const-reference to the dimensioned internal field.
Generic GeometricField class.
Definition: areaFieldsFwd.H:50
Generic templated field type.
Definition: Field.H:62
const direction noexcept
Definition: Scalar.H:258
Generic GeometricBoundaryField class.
Definition: areaFieldsFwd.H:46
static const GeometricField< Type, PatchField, GeoMesh > & null()
Return a null geometric field.
label timeIndex() const noexcept
Return the time index of the field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:42
const Boundary & boundaryField() const noexcept
Return const-reference to the boundary field.