OpenFOAM: API Guide
v2012
The open source CFD toolbox
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 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>
32
inline
const
Foam::DimensionedField<Type, GeoMesh>
&
33
Foam::DimensionedField<Type, GeoMesh>::null
()
34
{
35
return
NullObjectRef<DimensionedField<Type, GeoMesh>>();
36
}
37
38
39
template
<
class
Type,
class
GeoMesh>
40
inline
const
typename
GeoMesh::Mesh
&
41
Foam::DimensionedField<Type, GeoMesh>::mesh
()
const
42
{
43
return
mesh_;
44
}
45
46
47
template
<
class
Type,
class
GeoMesh>
48
inline
const
Foam::dimensionSet
&
49
Foam::DimensionedField<Type, GeoMesh>::dimensions
()
const
50
{
51
return
dimensions_;
52
}
53
54
55
template
<
class
Type,
class
GeoMesh>
56
inline
Foam::dimensionSet
&
Foam::DimensionedField<Type, GeoMesh>::dimensions
()
57
{
58
return
dimensions_;
59
}
60
61
62
template
<
class
Type,
class
GeoMesh>
63
inline
const
Foam::orientedType
&
64
Foam::DimensionedField<Type, GeoMesh>::oriented
()
const
65
{
66
return
oriented_;
67
}
68
69
70
template
<
class
Type,
class
GeoMesh>
71
inline
Foam::orientedType
&
Foam::DimensionedField<Type, GeoMesh>::oriented
()
72
{
73
return
oriented_;
74
}
75
76
77
template
<
class
Type,
class
GeoMesh>
78
inline
void
Foam::DimensionedField<Type, GeoMesh>::setOriented
79
(
80
const
bool
oriented
81
)
82
{
83
oriented_.setOriented(oriented);
84
}
85
86
87
template
<
class
Type,
class
GeoMesh>
88
inline
const
Foam::Field<Type>
&
89
Foam::DimensionedField<Type, GeoMesh>::field
()
const
90
{
91
return
*
this
;
92
}
93
94
95
template
<
class
Type,
class
GeoMesh>
96
inline
Foam::Field<Type>
&
97
Foam::DimensionedField<Type, GeoMesh>::field
()
98
{
99
return
*
this
;
100
}
101
102
103
// ************************************************************************* //
Foam::DimensionedField::field
const Field< Type > & field() const
Return field.
Definition:
DimensionedFieldI.H:89
Foam::DimensionedField::null
static const DimensionedField< Type, GeoMesh > & null()
Return a NullObjectRef DimensionedField.
Definition:
DimensionedFieldI.H:33
Foam::dimensionSet
Dimension set for the base types.
Definition:
dimensionSet.H:65
Foam::Field
Generic templated field type.
Definition:
Field.H:63
Foam::DimensionedField::mesh
const Mesh & mesh() const
Return mesh.
Definition:
DimensionedFieldI.H:41
Foam::DimensionedField::dimensions
const dimensionSet & dimensions() const
Return dimensions.
Definition:
DimensionedFieldI.H:49
Foam::DimensionedField::oriented
const orientedType & oriented() const
Return oriented type.
Definition:
DimensionedFieldI.H:64
Foam::DimensionedField::setOriented
void setOriented(const bool oriented=true)
Set the oriented flag.
Definition:
DimensionedFieldI.H:79
Foam::GeoMesh::Mesh
MESH Mesh
Definition:
GeoMesh.H:63
Foam::orientedType
Class to determine the 'oriented' status of surface fields.
Definition:
orientedType.H:61
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition:
DimensionedField.H:54
src
OpenFOAM
fields
DimensionedFields
DimensionedField
DimensionedFieldI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.