src/lagrangian/molecularDynamics/potential/potential/potential.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::potential
  27
  28 Description
  29
  30 SourceFiles
  31     potentialI.H
  32     potential.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef potential_H
  37 #define potential_H
  38
  39 #include "polyMesh.H"
  40 #include "IOdictionary.H"
  41 #include "Time.H"
  42 #include "pairPotentialList.H"
  43 #include "electrostaticPotential.H"
  44 #include "tetherPotentialList.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class potential Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class potential
  56 {
  57     // Private data
  58
  59         const polyMesh& mesh_;
  60
  61         List<word> idList_;
  62
  63         List<word> siteIdList_;
  64
  65         label nPairPotIds_;
  66
  67         scalar potentialEnergyLimit_;
  68
  69         labelList removalOrder_;
  70
  71         pairPotentialList pairPotentials_;
  72
  73         tetherPotentialList tetherPotentials_;
  74
  75         vector gravity_;
  76
  77
  78     // Private Member Functions
  79
  80         void setSiteIdList(const IOdictionary& moleculePropertiesDict);
  81
  82         void readPotentialDict();
  83
  84         void readMdInitialiseDict
  85         (
  86             const IOdictionary& mdInitialiseDict,
  87             IOdictionary& idListDict
  88         );
  89
  90         //- Disallow default bitwise copy construct
  91         potential(const potential&);
  92
  93         //- Disallow default bitwise assignment
  94         void operator=(const potential&);
  95
  96
  97 public:
  98
  99     // Constructors
 100
 101         //- Construct from mesh reference
 102         potential(const polyMesh& mesh);
 103
 104         //- Construct from mdInitialiseDict
 105         potential
 106         (
 107             const polyMesh& mesh,
 108             const IOdictionary& mdInitialiseDict,
 109             IOdictionary& idListDict
 110         );
 111
 112
 113     // Destructor
 114
 115         ~potential();
 116
 117
 118     // Member Functions
 119
 120         // Access
 121
 122             inline label nIds() const;
 123
 124             inline const List<word>& idList() const;
 125
 126             inline const List<word>& siteIdList() const;
 127
 128             inline scalar potentialEnergyLimit() const;
 129
 130             inline label nPairPotentials() const;
 131
 132             inline const labelList& removalOrder() const;
 133
 134             inline const pairPotentialList& pairPotentials() const;
 135
 136             inline const tetherPotentialList& tetherPotentials() const;
 137
 138             inline const vector& gravity() const;
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace Foam
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #include "potentialI.H"
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //