DimensionedFieldI.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) 2017-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
31template<class Type, class GeoMesh>
34{
35 return NullObjectRef<DimensionedField<Type, GeoMesh>>();
36}
37
38
39template<class Type, class GeoMesh>
40inline const typename GeoMesh::Mesh&
42{
43 return mesh_;
44}
45
46
47template<class Type, class GeoMesh>
48inline const Foam::dimensionSet&
50{
51 return dimensions_;
52}
53
54
55template<class Type, class GeoMesh>
57{
58 return dimensions_;
59}
60
61
62template<class Type, class GeoMesh>
63inline const Foam::orientedType&
65{
66 return oriented_;
67}
68
69
70template<class Type, class GeoMesh>
73{
74 return oriented_;
75}
76
77
78template<class Type, class GeoMesh>
80(
81 const bool oriented
82) noexcept
83{
84 oriented_.setOriented(oriented);
85}
86
87
88template<class Type, class GeoMesh>
89inline const Foam::Field<Type>&
91{
92 return *this;
93}
94
95
96template<class Type, class GeoMesh>
99{
100 return *this;
101}
102
103
104// ************************************************************************* //
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 NullObjectRef DimensionedField.
const Mesh & mesh() const
Return mesh.
void setOriented(const bool oriented=true) noexcept
Set the oriented flag.
const Field< Type > & field() const
Return field.
const orientedType & oriented() const noexcept
Return oriented type.
Generic templated field type.
Definition: Field.H:82
MESH Mesh
Definition: GeoMesh.H:62
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:109
Class to determine the 'oriented' status of surface fields.
Definition: orientedType.H:57