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

   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 Class
  25     Foam::tetherPotentials::pitchForkRing
  26
  27 Description
  28
  29
  30 SourceFiles
  31     pitchForkRing.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef pitchForkRing_H
  36 #define pitchForkRing_H
  37
  38 #include "tetherPotential.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace tetherPotentials
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class pitchForkRing Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class pitchForkRing
  52 :
  53     public tetherPotential
  54 {
  55     // Private data
  56
  57         dictionary pitchForkRingCoeffs_;
  58
  59         scalar mu_;
  60         scalar alpha_;
  61         scalar rOrbit_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("pitchForkRing");
  68
  69
  70     // Constructors
  71
  72         //- Construct from components
  73         pitchForkRing
  74         (
  75             const word& name,
  76             const dictionary& tetherPotentialProperties
  77         );
  78
  79
  80     //- Destructor
  81     ~pitchForkRing()
  82     {}
  83
  84
  85     // Member Functions
  86
  87         scalar energy(const vector r) const;
  88
  89         vector force(const vector r) const;
  90
  91         //- Read dictionary
  92         bool read(const dictionary& tetherPotentialProperties);
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace tetherPotentials
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //