Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
lagrangian
molecularDynamics
potential
tetherPotential
tetherPotentialList
tetherPotentialList.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 | Copyright (C) 2008-2010 OpenCFD Ltd.
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
Class
25
Foam::tetherPotentialList
26
27
Description
28
29
SourceFiles
30
tetherPotentialList.C
31
32
\*---------------------------------------------------------------------------*/
33
34
#ifndef tetherPotentialList_H
35
#define tetherPotentialList_H
36
37
#include <
OpenFOAM/ListOps.H
>
38
#include <
OpenFOAM/PtrList.H
>
39
#include <
OpenFOAM/word.H
>
40
#include <
potential/tetherPotential.H
>
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class tetherPotentialList Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
tetherPotentialList
52
:
53
public
PtrList
<tetherPotential>
54
{
55
// Private data
56
57
List<label>
idMap_;
58
59
60
// Private Member Functions
61
62
inline
label tetherPotentialIndex
63
(
64
const
label a
65
)
const
;
66
67
void
readTetherPotentialDict
68
(
69
const
List<word>
& siteIdList,
70
const
dictionary
& tetherPotentialDict,
71
const
List<word>
& tetherSiteIdList
72
);
73
74
//- Disallow default bitwise assignment
75
void
operator=(
const
tetherPotentialList
&);
76
77
//- Disallow default bitwise copy construct
78
tetherPotentialList
(
const
tetherPotentialList
&);
79
80
81
public
:
82
83
// Constructors
84
85
tetherPotentialList
();
86
87
//- Construct from siteIdList and potental dictionaries
88
tetherPotentialList
89
(
90
const
List<word>
& siteIdList,
91
const
dictionary
& tetherPotentialDict,
92
const
List<word>
& tetherSiteIdList
93
);
94
95
96
// Destructor
97
98
~tetherPotentialList
();
99
100
101
// Member Functions
102
103
void
buildPotentials
104
(
105
const
List<word>
& siteIdList,
106
const
dictionary
& tetherPotentialDict,
107
const
List<word>
& tetherSiteIdList
108
);
109
110
// Access
111
112
inline
const
List<word>
&
idMap
()
const
;
113
114
const
tetherPotential
&
tetherPotentialFunction
(
const
label a)
const
;
115
116
vector
force
(
const
label a,
const
vector
rIT)
const
;
117
118
scalar
energy
(
const
label a,
const
vector
rIT)
const
;
119
};
120
121
122
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124
}
// End namespace Foam
125
126
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127
128
#include "
tetherPotentialListI.H
"
129
130
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132
#endif
133
134
// ************************ vim: set sw=4 sts=4 et: ************************ //