src/lagrangian/molecularDynamics/potential/tetherPotential/derived/harmonicSpring/harmonicSpring.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "harmonicSpring.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace tetherPotentials
  35 {
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 defineTypeNameAndDebug(harmonicSpring, 0);
  40
  41 addToRunTimeSelectionTable
  42 (
  43     tetherPotential,
  44     harmonicSpring,
  45     dictionary
  46 );
  47
  48
  49 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  50
  51 harmonicSpring::harmonicSpring
  52 (
  53     const word& name,
  54     const dictionary& tetherPotentialProperties
  55 )
  56 :
  57     tetherPotential(name, tetherPotentialProperties),
  58     harmonicSpringCoeffs_
  59     (
  60         tetherPotentialProperties.subDict(typeName + "Coeffs")
  61     ),
  62     springConstant_(readScalar(harmonicSpringCoeffs_.lookup("springConstant")))
  63 {}
  64
  65
  66 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  67
  68 scalar harmonicSpring::energy(const vector r) const
  69 {
  70     return 0.5*springConstant_*magSqr(r);
  71 }
  72
  73
  74 vector harmonicSpring::force(const vector r) const
  75 {
  76     return -springConstant_*r;
  77 }
  78
  79
  80 bool harmonicSpring::read(const dictionary& tetherPotentialProperties)
  81 {
  82     tetherPotential::read(tetherPotentialProperties);
  83
  84     harmonicSpringCoeffs_ =
  85         tetherPotentialProperties.subDict(typeName + "Coeffs");
  86
  87     harmonicSpringCoeffs_.lookup("springConstant") >> springConstant_;
  88
  89     return true;
  90 }
  91
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 } // End namespace tetherPotentials
  96 } // End namespace Foam
  97
  98 // ************************************************************************* //