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-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, class GeoMesh>
34 {
35  return NullObjectRef<DimensionedField<Type, GeoMesh>>();
36 }
37 
38 
39 template<class Type, class GeoMesh>
40 inline const typename GeoMesh::Mesh&
42 {
43  return mesh_;
44 }
45 
46 
47 template<class Type, class GeoMesh>
48 inline const Foam::dimensionSet&
50 {
51  return dimensions_;
52 }
53 
54 
55 template<class Type, class GeoMesh>
56 inline Foam::dimensionSet&
58 {
59  return dimensions_;
60 }
61 
62 
63 template<class Type, class GeoMesh>
64 inline Foam::orientedType
66 {
67  return oriented_;
68 }
69 
70 
71 template<class Type, class GeoMesh>
72 inline Foam::orientedType&
74 {
75  return oriented_;
76 }
77 
78 
79 template<class Type, class GeoMesh>
81 {
82  return oriented_.is_oriented();
83 }
84 
85 
86 template<class Type, class GeoMesh>
88 {
89  oriented_.setOriented(on);
90 }
91 
92 
93 template<class Type, class GeoMesh>
94 inline const Foam::Field<Type>&
96 {
97  return *this;
98 }
99 
100 
101 template<class Type, class GeoMesh>
102 inline Foam::Field<Type>&
104 {
105  return *this;
106 }
107 
108 
109 // ************************************************************************* //
bool is_oriented() const noexcept
True if field is ORIENTED.
orientedType oriented() const noexcept
Return oriented type.
Class to determine the &#39;oriented&#39; status of surface fields.
Definition: orientedType.H:52
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:105
static const DimensionedField< Type, GeoMesh > & null()
Return a NullObjectRef DimensionedField.
Generic templated field type.
Definition: Field.H:62
void setOriented(bool on=true) noexcept
Set the oriented flag: on/off.
const Mesh & mesh() const noexcept
Return mesh.
const direction noexcept
Definition: Scalar.H:258
MESH Mesh
Definition: GeoMesh.H:58
const Field< Type > & field() const noexcept
Return const-reference to the field values.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
const dimensionSet & dimensions() const noexcept
Return dimensions.