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-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, class GeoMesh>
31 {
32  return NullObjectRef<DimensionedField<Type, GeoMesh>>();
33 }
34 
35 
36 template<class Type, class GeoMesh>
37 inline const typename GeoMesh::Mesh&
39 {
40  return mesh_;
41 }
42 
43 
44 template<class Type, class GeoMesh>
45 inline const Foam::dimensionSet&
47 {
48  return dimensions_;
49 }
50 
51 template<class Type, class GeoMesh>
52 inline Foam::dimensionSet&
54 {
55  return dimensions_;
56 }
57 
58 
59 template<class Type, class GeoMesh>
60 inline const Foam::Field<Type>&
62 {
63  return *this;
64 }
65 
66 template<class Type, class GeoMesh>
67 inline Foam::Field<Type>&
69 {
70  return *this;
71 }
72 
73 
74 // ************************************************************************* //
const dimensionSet & dimensions() const
Return dimensions.
Dimension set for the base types.
Definition: dimensionSet.H:120
static const DimensionedField< Type, GeoMesh > & null()
Return a null DimensionedField.
Pre-declare SubField and related Field type.
Definition: Field.H:56
const Mesh & mesh() const
Return mesh.
MESH Mesh
Definition: GeoMesh.H:61
const Field< Type > & field() const
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...