OpenFOAM: API Guide
v1912
The open source CFD toolbox
lumpedPointStateI.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) 2017 OpenCFD Ltd.
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
\*---------------------------------------------------------------------------*/
27
28
inline
bool
Foam::lumpedPointState::valid
()
const
29
{
30
return
points_.size() && points_.size() == angles_.size();
31
}
32
33
34
inline
bool
Foam::lumpedPointState::empty
()
const
35
{
36
return
points_.empty();
37
}
38
39
40
inline
Foam::label
Foam::lumpedPointState::size
()
const
41
{
42
return
points_.size();
43
}
44
45
46
inline
const
Foam::pointField
&
Foam::lumpedPointState::points
()
const
47
{
48
return
points_;
49
}
50
51
52
inline
const
Foam::vectorField
&
Foam::lumpedPointState::angles
()
const
53
{
54
return
angles_;
55
}
56
57
58
inline
const
Foam::tensorField
&
Foam::lumpedPointState::rotations
()
const
59
{
60
if
(!rotationPtr_)
61
{
62
calcRotations();
63
}
64
65
return
*rotationPtr_;
66
}
67
68
69
// ************************************************************************* //
Foam::lumpedPointState::points
const pointField & points() const
The points corresponding to mass centres.
Definition:
lumpedPointStateI.H:46
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition:
label.H:62
Foam::Field< vector >
Foam::lumpedPointState::angles
const vectorField & angles() const
The orientation of the points (mass centres)
Definition:
lumpedPointStateI.H:52
Foam::lumpedPointState::empty
bool empty() const
If no points were specified.
Definition:
lumpedPointStateI.H:34
Foam::lumpedPointState::valid
bool valid() const
Has positions and consistent number of rotations?
Definition:
lumpedPointStateI.H:28
Foam::lumpedPointState::rotations
const tensorField & rotations() const
The local-to-global transformation for each point.
Definition:
lumpedPointStateI.H:58
Foam::lumpedPointState::size
label size() const
The number of points.
Definition:
lumpedPointStateI.H:40
src
lumpedPointMotion
state
lumpedPointStateI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.