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