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