FreeFOAM The Cross-Platform CFD Toolkit
receivingReferralList.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::receivingReferralList
26 
27 Description
28 
29 SourceFiles
30  receivingReferralListI.H
31  receivingReferralList.C
32  receivingReferralListIO.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef receivingReferralList_H
37 #define receivingReferralList_H
38 
39 #include <OpenFOAM/labelList.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class receivingReferralList Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public labelListList
53 {
54  // Private data
55 
56  label sourceProc_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct null
65 
66  //- Construct from components
68  (
69  const label sourceProc,
70  const labelListList& refCellsToSendTo
71  );
72 
73  //- Construct as copy
75 
76 
77  // Destructor
78 
80 
81 
82  // Member Functions
83 
84  // Access
85 
86  inline label sourceProc() const;
87 
88 
89  // Member Operators
90 
91  void operator=(const receivingReferralList&);
92 
93 
94  // Friend Operators
95 
96  friend bool operator==
97  (
98  const receivingReferralList& a,
100  );
101 
102  inline friend bool operator!=
103  (
104  const receivingReferralList& a,
105  const receivingReferralList& b
106  );
107 
108 
109  // IOstream Operators
110 
111  friend Istream& operator>>
112  (
113  Istream&,
115  );
116 
117  friend Ostream& operator<<
118  (
119  Ostream&,
120  const receivingReferralList&
121  );
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************ vim: set sw=4 sts=4 et: ************************ //