OpenFOAM: API Guide
v1912
The open source CFD toolbox
potentialI.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 OpenFOAM Foundation
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
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29
30
inline
Foam::label
Foam::potential::nIds
()
const
31
{
32
return
idList_.size();
33
}
34
35
36
inline
const
Foam::List<Foam::word>
&
Foam::potential::idList
()
const
37
{
38
return
idList_;
39
}
40
41
42
inline
const
Foam::List<Foam::word>
&
Foam::potential::siteIdList
()
const
43
{
44
return
siteIdList_;
45
}
46
47
48
inline
Foam::scalar
Foam::potential::potentialEnergyLimit
()
const
49
{
50
return
potentialEnergyLimit_;
51
}
52
53
54
inline
Foam::label
Foam::potential::nPairPotentials
()
const
55
{
56
return
pairPotentials_.size();
57
}
58
59
60
inline
const
Foam::labelList
&
Foam::potential::removalOrder
()
const
61
{
62
return
removalOrder_;
63
}
64
65
66
inline
const
Foam::pairPotentialList
&
Foam::potential::pairPotentials
()
const
67
{
68
return
pairPotentials_;
69
}
70
71
72
inline
const
Foam::tetherPotentialList
&
73
Foam::potential::tetherPotentials
()
const
74
{
75
return
tetherPotentials_;
76
}
77
78
79
inline
const
Foam::vector
&
Foam::potential::gravity
()
const
80
{
81
return
gravity_;
82
}
83
84
85
// ************************************************************************* //
Foam::pairPotentialList
Definition:
pairPotentialList.H:53
Foam::potential::gravity
const vector & gravity() const
Definition:
potentialI.H:79
Foam::potential::pairPotentials
const pairPotentialList & pairPotentials() const
Definition:
potentialI.H:66
Foam::potential::siteIdList
const List< word > & siteIdList() const
Definition:
potentialI.H:42
Foam::potential::tetherPotentials
const tetherPotentialList & tetherPotentials() const
Definition:
potentialI.H:73
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::potential::nIds
label nIds() const
Definition:
potentialI.H:30
Foam::potential::nPairPotentials
label nPairPotentials() const
Definition:
potentialI.H:54
Foam::potential::removalOrder
const labelList & removalOrder() const
Definition:
potentialI.H:60
Foam::tetherPotentialList
Definition:
tetherPotentialList.H:52
Foam::Vector< scalar >
Foam::List< Foam::word >
Foam::potential::potentialEnergyLimit
scalar potentialEnergyLimit() const
Definition:
potentialI.H:48
Foam::potential::idList
const List< word > & idList() const
Definition:
potentialI.H:36
src
lagrangian
molecularDynamics
potential
potential
potentialI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.