FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

receivingReferralList.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::receivingReferralList
00026 
00027 Description
00028 
00029 SourceFiles
00030     receivingReferralListI.H
00031     receivingReferralList.C
00032     receivingReferralListIO.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef receivingReferralList_H
00037 #define receivingReferralList_H
00038 
00039 #include <OpenFOAM/labelList.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                     Class receivingReferralList Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class receivingReferralList
00051 :
00052     public labelListList
00053 {
00054     // Private data
00055 
00056         label sourceProc_;
00057 
00058 
00059 public:
00060 
00061     // Constructors
00062 
00063         //- Construct null
00064         receivingReferralList();
00065 
00066         //- Construct from components
00067         receivingReferralList
00068         (
00069             const label sourceProc,
00070             const labelListList& refCellsToSendTo
00071         );
00072 
00073         //- Construct as copy
00074         receivingReferralList(const receivingReferralList&);
00075 
00076 
00077     // Destructor
00078 
00079         ~receivingReferralList();
00080 
00081 
00082     // Member Functions
00083 
00084         // Access
00085 
00086             inline label sourceProc() const;
00087 
00088 
00089     // Member Operators
00090 
00091         void operator=(const receivingReferralList&);
00092 
00093 
00094     // Friend Operators
00095 
00096         friend bool operator==
00097         (
00098             const receivingReferralList& a,
00099             const receivingReferralList& b
00100         );
00101 
00102         inline friend bool operator!=
00103         (
00104             const receivingReferralList& a,
00105             const receivingReferralList& b
00106         );
00107 
00108 
00109     // IOstream Operators
00110 
00111         friend Istream& operator>>
00112         (
00113             Istream&,
00114             receivingReferralList&
00115         );
00116 
00117         friend Ostream& operator<<
00118         (
00119             Ostream&,
00120             const receivingReferralList&
00121         );
00122 };
00123 
00124 
00125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00126 
00127 } // End namespace Foam
00128 
00129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00130 
00131 #include <molecule/receivingReferralListI.H>
00132 
00133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00134 
00135 #endif
00136 
00137 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines