src/lagrangian/molecularDynamics/molecule/interactionLists/referredCellList/referredCellList.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::referredCellList
  27
  28 Description
  29
  30 SourceFiles
  31     referredCellListI.H
  32     referredCellList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef referredCellList_H
  37 #define referredCellList_H
  38
  39 #include "referredCell.H"
  40 #include "molecule.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class interactionLists;
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class referredCellList Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class referredCellList
  55 :
  56     public List<referredCell>
  57 {
  58     // Private data
  59
  60         const interactionLists& il_;
  61
  62
  63     // Private Member Functions
  64
  65         void buildReferredCellList
  66         (
  67             bool pointPointListBuild
  68         );
  69
  70
  71 public:
  72
  73     // Constructors
  74
  75         //- Construct lists by searching the mesh
  76         referredCellList
  77         (
  78             interactionLists& il,
  79             bool pointPointListBuild
  80         );
  81
  82         //- Construct from file
  83         referredCellList (interactionLists& il);
  84
  85
  86     // Destructor
  87
  88         ~referredCellList();
  89
  90
  91     // Member Functions
  92
  93         void referMolecules(const List<DynamicList<molecule*> >& cellOccupancy);
  94
  95         inline const interactionLists& il() const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #include "referredCellListI.H"
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //