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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::tetherPotentialList
  27
  28 Description
  29
  30 SourceFiles
  31     tetherPotentialList.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef tetherPotentialList_H
  36 #define tetherPotentialList_H
  37
  38 #include "ListOps.H"
  39 #include "PtrList.H"
  40 #include "word.H"
  41 #include "tetherPotential.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class tetherPotentialList Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class tetherPotentialList
  53 :
  54     public PtrList<tetherPotential>
  55 {
  56     // Private data
  57
  58         List<label> idMap_;
  59
  60
  61     // Private Member Functions
  62
  63         inline label tetherPotentialIndex
  64         (
  65             const label a
  66         ) const;
  67
  68         void readTetherPotentialDict
  69         (
  70             const List<word>& siteIdList,
  71             const dictionary& tetherPotentialDict,
  72             const List<word>& tetherSiteIdList
  73         );
  74
  75         //- Disallow default bitwise assignment
  76         void operator=(const tetherPotentialList&);
  77
  78         //- Disallow default bitwise copy construct
  79         tetherPotentialList(const tetherPotentialList&);
  80
  81
  82 public:
  83
  84     // Constructors
  85
  86         tetherPotentialList();
  87
  88         //- Construct from siteIdList and potental dictionaries
  89         tetherPotentialList
  90         (
  91             const List<word>& siteIdList,
  92             const dictionary& tetherPotentialDict,
  93             const List<word>& tetherSiteIdList
  94         );
  95
  96
  97     // Destructor
  98
  99         ~tetherPotentialList();
 100
 101
 102     // Member Functions
 103
 104         void buildPotentials
 105         (
 106             const List<word>& siteIdList,
 107             const dictionary& tetherPotentialDict,
 108             const List<word>& tetherSiteIdList
 109         );
 110
 111         // Access
 112
 113             inline const List<word>& idMap() const;
 114
 115             const tetherPotential& tetherPotentialFunction(const label a) const;
 116
 117             vector force(const label a, const vector rIT) const;
 118
 119             scalar energy (const label a, const vector rIT) const;
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #include "tetherPotentialListI.H"
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //