DimensionedFieldI.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-2024 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 #include "DimensionedField.H"
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class Type, class GeoMesh>
33 {
34  return NullObjectRef<DimensionedField<Type, GeoMesh>>();
35 }
36 
37 
38 template<class Type, class GeoMesh>
39 inline const typename GeoMesh::Mesh&
41 {
42  return mesh_;
43 }
44 
45 
46 template<class Type, class GeoMesh>
47 inline const Foam::dimensionSet&
49 {
50  return dimensions_;
51 }
52 
53 template<class Type, class GeoMesh>
54 inline Foam::dimensionSet&
56 {
57  return dimensions_;
58 }
59 
60 
61 template<class Type, class GeoMesh>
62 inline const Foam::Field<Type>&
64 {
65  return *this;
66 }
67 
68 
69 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const dimensionSet & dimensions() const
Return dimensions.
static const DimensionedField< Type, GeoMesh > & null()
Return a null DimensionedField.
const Field< Type > & primitiveField() const
Return a const-reference to the primitive field.
const Mesh & mesh() const
Return mesh.
Pre-declare SubField and related Field type.
Definition: Field.H:83
MESH Mesh
Definition: GeoMesh.H:61
Dimension set for the base types.
Definition: dimensionSet.H:125