potentialI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return idList_.size();
31 }
32 
33 
35 {
36  return idList_;
37 }
38 
39 
41 {
42  return siteIdList_;
43 }
44 
45 
46 inline Foam::scalar Foam::potential::potentialEnergyLimit() const
47 {
48  return potentialEnergyLimit_;
49 }
50 
51 
53 {
54  return pairPotentials_.size();
55 }
56 
57 
59 {
60  return removalOrder_;
61 }
62 
63 
65 {
66  return pairPotentials_;
67 }
68 
69 
70 inline const Foam::tetherPotentialList&
72 {
73  return tetherPotentials_;
74 }
75 
76 
78 {
79  return gravity_;
80 }
81 
82 
83 // ************************************************************************* //
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
scalar potentialEnergyLimit() const
Definition: potentialI.H:46
label nIds() const
Definition: potentialI.H:28
const tetherPotentialList & tetherPotentials() const
Definition: potentialI.H:71
const pairPotentialList & pairPotentials() const
Definition: potentialI.H:64
const List< word > & idList() const
Definition: potentialI.H:34
label nPairPotentials() const
Definition: potentialI.H:52
const labelList & removalOrder() const
Definition: potentialI.H:58
label size() const
Return the number of elements in the UPtrList.
Definition: UPtrListI.H:29
const vector & gravity() const
Definition: potentialI.H:77
const List< word > & siteIdList() const
Definition: potentialI.H:40