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
derived
harmonicSpring
harmonicSpring.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::tetherPotentials::harmonicSpring
26
27
Description
28
29
30
SourceFiles
31
harmonicSpring.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef harmonicSpring_H
36
#define harmonicSpring_H
37
38
#include <
potential/tetherPotential.H
>
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
namespace
tetherPotentials
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class harmonicSpring Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
harmonicSpring
52
:
53
public
tetherPotential
54
{
55
// Private data
56
57
dictionary
harmonicSpringCoeffs_;
58
59
scalar springConstant_;
60
61
62
public
:
63
64
//- Runtime type information
65
TypeName
(
"harmonicSpring"
);
66
67
68
// Constructors
69
70
//- Construct from components
71
harmonicSpring
72
(
73
const
word
&
name
,
74
const
dictionary
&
tetherPotentialProperties
75
);
76
77
78
// Destructor
79
80
~harmonicSpring
()
81
{}
82
83
84
// Member Functions
85
86
scalar
energy
(
const
vector
r)
const
;
87
88
vector
force
(
const
vector
r)
const
;
89
90
//- Read dictionary
91
bool
read
(
const
dictionary
& tetherPotentialProperties);
92
};
93
94
95
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97
}
// End namespace tetherPotentials
98
}
// End namespace Foam
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
#endif
103
104
// ************************ vim: set sw=4 sts=4 et: ************************ //