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