OpenFOAM: API Guide
v2112
The open source CFD toolbox
IPstream.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2011-2013 OpenFOAM Foundation
9
Copyright (C) 2021 OpenCFD Ltd.
10
-------------------------------------------------------------------------------
11
License
12
This file is part of OpenFOAM.
13
14
OpenFOAM is free software: you can redistribute it and/or modify it
15
under the terms of the GNU General Public License as published by
16
the Free Software Foundation, either version 3 of the License, or
17
(at your option) any later version.
18
19
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22
for more details.
23
24
You should have received a copy of the GNU General Public License
25
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27
Class
28
Foam::IPstream
29
30
Description
31
Input inter-processor communications stream.
32
33
SourceFiles
34
IPstream.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#include "
Pstream.H
"
39
40
#ifndef IPstream_H
41
#define IPstream_H
42
43
#include "
UIPstream.H
"
44
45
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47
namespace
Foam
48
{
49
50
/*---------------------------------------------------------------------------*\
51
Class IPstream Declaration
52
\*---------------------------------------------------------------------------*/
53
54
class
IPstream
55
:
56
public
Pstream
,
57
public
UIPstream
58
{
59
// Private Data
60
61
//- Receive index into Pstream::transferBuf_
62
label transferBufPosition_;
63
64
public
:
65
66
// Constructors
67
68
//- Construct given process index to read from
69
//- and optional buffer size, read format
70
IPstream
71
(
72
const
commsTypes
commsType
,
73
const
int
fromProcNo,
74
const
label bufSize = 0,
75
const
int
tag =
UPstream::msgType
(),
76
const
label comm =
UPstream::worldComm
,
77
IOstreamOption::streamFormat
fmt =
IOstreamOption::BINARY
78
);
79
};
80
81
82
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83
84
}
// End namespace Foam
85
86
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88
#endif
89
90
// ************************************************************************* //
Foam::UPstream::commsType
commsTypes commsType() const noexcept
Get the communications type of the stream.
Definition:
UPstream.H:547
Foam::IOstreamOption::streamFormat
streamFormat
Data format (ascii | binary)
Definition:
IOstreamOption.H:70
Pstream.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition:
UPstream.H:69
Foam::IPstream::IPstream
IPstream(const commsTypes commsType, const int fromProcNo, const label bufSize=0, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
Definition:
IPstream.C:34
Foam::IOstreamOption::BINARY
"binary"
Definition:
IOstreamOption.H:73
Foam::UPstream::msgType
static int & msgType() noexcept
Message tag of standard messages.
Definition:
UPstream.H:540
Foam::Pstream
Inter-processor communications stream.
Definition:
Pstream.H:56
Foam::UPstream::worldComm
static label worldComm
Default communicator (all processors)
Definition:
UPstream.H:293
Foam::IPstream
Input inter-processor communications stream.
Definition:
IPstream.H:53
Foam::UIPstream
Input inter-processor communications stream operating on external buffer.
Definition:
UIPstream.H:56
UIPstream.H
src
OpenFOAM
db
IOstreams
Pstreams
IPstream.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.