1 /*---------------------------------------------------------------------------*\
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
7 -------------------------------------------------------------------------------
9 This file is part of OpenFOAM.
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.
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
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/>.
25 Foam::tetherPotentials::restrainedHarmonicSpring
31 restrainedHarmonicSpring.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef restrainedHarmonicSpring_H
36 #define restrainedHarmonicSpring_H
38 #include "tetherPotential.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace tetherPotentials
47 /*---------------------------------------------------------------------------*\
48 Class restrainedHarmonicSpring Declaration
49 \*---------------------------------------------------------------------------*/
51 class restrainedHarmonicSpring
53 public tetherPotential
57 dictionary restrainedHarmonicSpringCoeffs_;
59 scalar springConstant_;
66 //- Runtime type information
67 TypeName("restrainedHarmonicSpring");
72 //- Construct from components
73 restrainedHarmonicSpring
76 const dictionary& tetherPotentialProperties
81 ~restrainedHarmonicSpring()
87 scalar energy(const vector r) const;
89 vector force(const vector r) const;
92 bool read(const dictionary& tetherPotentialProperties);
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 } // End namespace tetherPotentials
99 } // End namespace Foam
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 // ************************************************************************* //