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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2009 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 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 "pitchForkRing.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace tetherPotentials
  35 {
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 defineTypeNameAndDebug(pitchForkRing, 0);
  40
  41 addToRunTimeSelectionTable
  42 (
  43     tetherPotential,
  44     pitchForkRing,
  45     dictionary
  46 );
  47
  48
  49 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  50
  51 pitchForkRing::pitchForkRing
  52 (
  53     const word& name,
  54     const dictionary& tetherPotentialProperties
  55 )
  56 :
  57     tetherPotential(name, tetherPotentialProperties),
  58     pitchForkRingCoeffs_
  59     (
  60         tetherPotentialProperties.subDict(typeName + "Coeffs")
  61     ),
  62     mu_(readScalar(pitchForkRingCoeffs_.lookup("mu"))),
  63     alpha_(readScalar(pitchForkRingCoeffs_.lookup("alpha"))),
  64     rOrbit_(readScalar(pitchForkRingCoeffs_.lookup("rOrbit")))
  65 {}
  66
  67
  68 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  69
  70 scalar pitchForkRing::energy(const vector r) const
  71 {
  72     scalar p = sqrt(r.x()*r.x() + r.y()*r.y());
  73
  74     scalar pMinusRSqr = (p - rOrbit_)*(p - rOrbit_);
  75
  76     return -0.5 * mu_ * pMinusRSqr
  77       + 0.25 * pMinusRSqr * pMinusRSqr
  78       + 0.5 * alpha_ * r.z() * r.z();
  79 }
  80
  81
  82 vector pitchForkRing::force(const vector r) const
  83 {
  84     scalar p = sqrt(r.x()*r.x() + r.y()*r.y());
  85
  86     scalar pMinusR = (p - rOrbit_);
  87
  88     return vector
  89     (
  90         (mu_ - pMinusR * pMinusR) * pMinusR * r.x()/p,
  91         (mu_ - pMinusR * pMinusR) * pMinusR * r.y()/p,
  92         -alpha_ * r.z()
  93     );
  94 }
  95
  96
  97 bool pitchForkRing::read(const dictionary& tetherPotentialProperties)
  98 {
  99     tetherPotential::read(tetherPotentialProperties);
 100
 101     pitchForkRingCoeffs_ =
 102         tetherPotentialProperties.subDict(typeName + "Coeffs");
 103
 104     pitchForkRingCoeffs_.lookup("mu") >> mu_;
 105     pitchForkRingCoeffs_.lookup("alpha") >> alpha_;
 106     pitchForkRingCoeffs_.lookup("rOrbit") >> rOrbit_;
 107
 108     return true;
 109 }
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace tetherPotentials
 115 } // End namespace Foam
 116
 117 // ************************************************************************* //