src/lagrangian/molecularDynamics/potential/pairPotential/pairPotentialList/pairPotentialList.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::pairPotentialList
  27
  28 Description
  29
  30 SourceFiles
  31     pairPotentialListI.H
  32     pairPotentialList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef pairPotentialList_H
  37 #define pairPotentialList_H
  38
  39 #include "PtrList.H"
  40 #include "word.H"
  41 #include "pairPotential.H"
  42 #include "polyMesh.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class pairPotentialList Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class pairPotentialList
  54 :
  55     public PtrList<pairPotential>
  56 {
  57     // Private data
  58
  59         label nIds_;
  60
  61         scalar rCutMax_;
  62
  63         scalar rCutMaxSqr_;
  64
  65         autoPtr<pairPotential> electrostaticPotential_;
  66
  67
  68     // Private Member Functions
  69
  70         inline label pairPotentialIndex
  71         (
  72             const label a,
  73             const label b
  74         ) const;
  75
  76         void readPairPotentialDict
  77         (
  78             const List<word>& idList,
  79             const dictionary& pairPotentialDict,
  80             const polyMesh& mesh
  81         );
  82
  83         //- Disallow default bitwise assignment
  84         void operator=(const pairPotentialList&);
  85
  86         //- Disallow default bitwise copy construct
  87         pairPotentialList(const pairPotentialList&);
  88
  89
  90 public:
  91
  92     // Constructors
  93
  94         pairPotentialList();
  95
  96         //- Construct from idList and potental dictionaries
  97         pairPotentialList
  98         (
  99             const List<word>& idList,
 100             const dictionary& pairPotentialDict,
 101             const polyMesh& mesh
 102         );
 103
 104
 105     // Destructor
 106
 107         ~pairPotentialList();
 108
 109
 110     // Member Functions
 111
 112         void buildPotentials
 113         (
 114             const List<word>& idList,
 115             const dictionary& pairPotentialDict,
 116             const polyMesh& mesh
 117         );
 118
 119
 120         // Access
 121
 122             inline scalar rCutMax() const;
 123
 124             inline scalar rCutMaxSqr() const;
 125
 126             bool rCutMaxSqr(scalar rIJMagSqr) const;
 127
 128             const pairPotential& pairPotentialFunction
 129             (
 130                 const label a,
 131                 const label b
 132             ) const;
 133
 134             // Return true if rIJ is within rCut for this pair.
 135             bool rCutSqr
 136             (
 137                 const label a,
 138                 const label b,
 139                 const scalar rIJMagSqr
 140             ) const;
 141
 142             scalar rMin(const label a, const label b) const;
 143
 144             scalar dr(const label a, const label b) const;
 145
 146             scalar rCutSqr(const label a, const label b) const;
 147
 148             scalar rCut(const label a, const label b) const;
 149
 150             scalar force
 151             (
 152                 const label a,
 153                 const label b,
 154                 const scalar rIJMag
 155             ) const;
 156
 157             scalar energy
 158             (
 159                 const label a,
 160                 const label b,
 161                 const scalar rIJMag
 162             ) const;
 163
 164             inline const pairPotential& electrostatic() const;
 165 };
 166
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 } // End namespace Foam
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #include "pairPotentialListI.H"
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #endif
 179
 180 // ************************************************************************* //