FreeFOAM The Cross-Platform CFD Toolkit
directInteractionList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2008-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::directInteractionList
26 
27 Description
28 
29 SourceFiles
30  directInteractionListI.H
31  directInteractionList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef directInteractionList_H
36 #define directInteractionList_H
37 
38 #include <OpenFOAM/polyMesh.H>
39 #include <OpenFOAM/List.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 class interactionLists;
48 
49 /*---------------------------------------------------------------------------*\
50  Class directInteractionList Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public labelListList
56 {
57  // Private data
58 
59  const interactionLists& il_;
60 
61 
62  // Private Member Functions
63 
64  void buildDirectInteractionList
65  (
66  bool pointPointListBuild
67  );
68 
69  //- Disallow default bitwise copy construct
71 
72  //- Disallow default bitwise assignment
73  void operator=(const directInteractionList&);
74 
75 
76 public:
77 
78  // Constructors
79 
80  //- Construct lists by searching the mesh
82  (
83  const interactionLists& il,
84  bool pointPointListBuild
85  );
86 
87  //- Construct from file
89  (
90  const interactionLists& il
91  );
92 
93 
94  // Destructor
95 
97 
98 
99  // Member Functions
100 
101  // Access
102 
103  inline const interactionLists& il() const;
104 
105 
106  // IOstream Operators
107 
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #include "directInteractionListI.H"
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************ vim: set sw=4 sts=4 et: ************************ //