harmonicSpring.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-2019 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 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 "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
72  (
73  const word& name,
75  );
76 
77 
78  //- Destructor
80  {}
81 
82 
83  // Member Functions
84 
85  scalar energy(const vector r) const;
86 
87  vector force(const vector r) const;
88 
89  //- Read dictionary
90  bool read(const dictionary& tetherPotentialProperties);
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace tetherPotentials
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
TypeName("harmonicSpring")
Runtime type information.
scalar energy(const vector r) const
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
bool read(const dictionary &tetherPotentialProperties)
Read dictionary.
A class for handling words, derived from string.
Definition: word.H:59
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
vector force(const vector r) const
const dictionary & tetherPotentialProperties() const
harmonicSpring(const word &name, const dictionary &tetherPotentialProperties)
Construct from components.
Namespace for OpenFOAM.