src/lagrangian/molecularDynamics/molecule/interactionLists/directInteractionList/directInteractionList.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::directInteractionList
  27
  28 Description
  29
  30 SourceFiles
  31     directInteractionListI.H
  32     directInteractionList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef directInteractionList_H
  37 #define directInteractionList_H
  38
  39 #include "polyMesh.H"
  40 #include "List.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class interactionLists;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class directInteractionList Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class directInteractionList
  55 :
  56     public labelListList
  57 {
  58     // Private data
  59
  60         const interactionLists& il_;
  61
  62
  63     // Private Member Functions
  64
  65         void buildDirectInteractionList
  66         (
  67             bool pointPointListBuild
  68         );
  69
  70         //- Disallow default bitwise copy construct
  71         directInteractionList(const directInteractionList&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const directInteractionList&);
  75
  76
  77 public:
  78
  79     // Constructors
  80
  81         //- Construct lists by searching the mesh
  82         directInteractionList
  83         (
  84             const interactionLists& il,
  85             bool pointPointListBuild
  86         );
  87
  88         //- Construct from file
  89         directInteractionList
  90         (
  91             const interactionLists& il
  92         );
  93
  94
  95     // Destructor
  96
  97         ~directInteractionList();
  98
  99
 100     // Member Functions
 101
 102         // Access
 103
 104         inline const interactionLists& il() const;
 105
 106
 107     // IOstream Operators
 108
 109         friend Istream& operator>>(Istream&, directInteractionList&);
 110         friend Ostream& operator<<(Ostream&, const directInteractionList&);
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace Foam
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #include "directInteractionListI.H"
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //