src/lagrangian/molecularDynamics/potential/tetherPotential/derived/restrainedHarmonicSpring/restrainedHarmonicSpring.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::tetherPotentials::restrainedHarmonicSpring
  27
  28 Description
  29
  30
  31 SourceFiles
  32     restrainedHarmonicSpring.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef restrainedHarmonicSpring_H
  37 #define restrainedHarmonicSpring_H
  38
  39 #include "tetherPotential.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace tetherPotentials
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                   Class restrainedHarmonicSpring Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class restrainedHarmonicSpring
  53 :
  54     public tetherPotential
  55 {
  56     // Private data
  57
  58         dictionary restrainedHarmonicSpringCoeffs_;
  59
  60         scalar springConstant_;
  61
  62         scalar rR_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("restrainedHarmonicSpring");
  69
  70
  71     // Constructors
  72
  73         //- Construct from components
  74         restrainedHarmonicSpring
  75         (
  76             const word& name,
  77             const dictionary& tetherPotentialProperties
  78         );
  79
  80
  81     // Destructor
  82
  83         ~restrainedHarmonicSpring()
  84         {}
  85
  86
  87     // Member Functions
  88
  89         scalar energy(const vector r) const;
  90
  91         vector force(const vector r) const;
  92
  93         //- Read dictionary
  94         bool read(const dictionary& tetherPotentialProperties);
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace tetherPotentials
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //