src/lagrangian/molecularDynamics/potential/tetherPotential/basic/tetherPotential.H

   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 Class
  26     Foam::tetherPotential
  27
  28 Description
  29
  30 SourceFiles
  31     tetherPotential.C
  32     newTetherPotential.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef tetherPotential_H
  37 #define tetherPotential_H
  38
  39 #include "IOdictionary.H"
  40 #include "typeInfo.H"
  41 #include "runTimeSelectionTables.H"
  42 #include "autoPtr.H"
  43 #include "vector.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class tetherPotential Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class tetherPotential
  55 {
  56
  57 protected:
  58
  59     // Protected data
  60
  61         word name_;
  62         dictionary tetherPotentialProperties_;
  63
  64
  65     // Private Member Functions
  66
  67         //- Disallow copy construct
  68         tetherPotential(const tetherPotential&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const tetherPotential&);
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("tetherPotential");
  78
  79
  80     // Declare run-time constructor selection table
  81
  82         declareRunTimeSelectionTable
  83         (
  84             autoPtr,
  85             tetherPotential,
  86             dictionary,
  87             (
  88                 const word& name,
  89                 const dictionary& tetherPotentialProperties
  90             ),
  91             (name, tetherPotentialProperties)
  92         );
  93
  94
  95     // Selectors
  96
  97         //- Return a reference to the selected viscosity model
  98         static autoPtr<tetherPotential> New
  99         (
 100             const word& name,
 101             const dictionary& tetherPotentialProperties
 102         );
 103
 104
 105     // Constructors
 106
 107         //- Construct from components
 108         tetherPotential
 109         (
 110             const word& name,
 111             const dictionary& tetherPotentialProperties
 112         );
 113
 114
 115     // Destructor
 116
 117         virtual ~tetherPotential()
 118         {}
 119
 120
 121     // Member Functions
 122
 123         virtual scalar energy (const vector r) const = 0;
 124
 125         virtual vector force (const vector r) const = 0;
 126
 127         const dictionary& tetherPotentialProperties() const
 128         {
 129             return tetherPotentialProperties_;
 130         }
 131
 132         //- Read tetherPotential dictionary
 133         virtual bool read(const dictionary& tetherPotentialProperties) = 0;
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************************************************************* //