src/OpenFOAM/db/IOstreams/Pstreams/IPstream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-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::IPstream
  26
  27 Description
  28     Input inter-processor communications stream.
  29
  30 SourceFiles
  31     IPstream.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #include "Pstream.H"
  36
  37 #ifndef IPstream_H
  38 #define IPstream_H
  39
  40 #include "UIPstream.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class IPstream Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class IPstream
  52 :
  53     public Pstream,
  54     public UIPstream
  55 {
  56
  57     //- Receive index
  58     label externalBufPosition_;
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct given process index to read from and optional buffer size,
  65         //  read format and IO version
  66         IPstream
  67         (
  68             const commsTypes commsType,
  69             const int fromProcNo,
  70             const label bufSize = 0,
  71             streamFormat format=BINARY,
  72             versionNumber version=currentVersion
  73         );
  74
  75 };
  76
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 } // End namespace Foam
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 #endif
  85
  86 // ************************************************************************* //