src/Pstream/gamma/PstreamGlobals.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Namespace
  25     Foam::PstreamGlobals
  26
  27 Description
  28     Global functions and variables for working with parallel streams,
  29     but principally for gamma/mpi
  30
  31 SourceFiles
  32     PstreamGlobals.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef PstreamGlobals_H
  37 #define PstreamGlobals_H
  38
  39 #include "FixedList.H"
  40 #include "labelList.H"
  41 #include "DynamicList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class PstreamGlobals Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 namespace PstreamGlobals
  53 {
  54
  55 //- Block wait for message on port procNo
  56 void gammaWait(const label procNo);
  57
  58 //- Helper routine to copy out newly received data
  59 label copyReceive
  60 (
  61     const label procNo,
  62     char* buf,
  63     const label bufSize
  64 );
  65
  66
  67 //- Receive buffers
  68 extern FixedList<List<List<char> >, 4> recvBuf;
  69
  70 //- Length of receive buffers
  71 extern FixedList<labelList, 4> recvBufLen;
  72
  73 //- Currently active buffer in receiving
  74 extern labelList recvIndex;
  75 //- Receive buffer that has to be consumed
  76 extern labelList consumeIndex;
  77
  78
  79 //- Special message to signal resizing
  80 const int resizeMessageLen = 6;
  81 extern uint64_t resizeMessage[];
  82 //- Initial buffer length. Should be able to contain the message comfortably.
  83 const int initialBufferLen = 2*resizeMessageLen*sizeof(uint64_t);
  84
  85 //- Helper routine to check if a message is a resize message.
  86 //  Returns -1 if not or the new size.
  87 label getSizeFromHeader(const char* buf, const label len);
  88 //- Change the resize message to contain the new length
  89 void setResizeMessage(const label len);
  90
  91 //- Get max size of all receive buffers to procNo
  92 label getMaxBufSize(const int procNo);
  93
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #endif
 104
 105 // ************************************************************************* //