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