IPstream.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 #include "IPstream.H"
27 
28 // * * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * //
29 
31 (
32  const commsTypes commsType,
33  const int fromProcNo,
34  const label bufSize,
35  const int tag,
36  const label comm,
37  streamFormat format,
38  versionNumber version
39 )
40 :
41  Pstream(commsType, bufSize),
42  UIPstream
43  (
44  commsType,
45  fromProcNo,
46  buf_,
47  externalBufPosition_,
48  tag, // tag
49  comm,
50  false, // do not clear buf_ if at end
51  format,
52  version
53  ),
54  externalBufPosition_(0)
55 {}
56 
57 
58 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
commsTypes
Types of communications.
Definition: UPstream.H:64
Input inter-processor communications stream operating on external buffer.
Definition: UIPstream.H:53
Inter-processor communications stream.
Definition: Pstream.H:53
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
IPstream(const commsTypes commsType, const int fromProcNo, const label bufSize=0, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, streamFormat format=BINARY, versionNumber version=currentVersion)
Construct given process index to read from and optional buffer size,.
Definition: IPstream.C:31
Version number type.
Definition: IOstream.H:96