OPstreams.C
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 OpenFOAM Foundation
9  Copyright (C) 2022-2023 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 \*---------------------------------------------------------------------------*/
28 
29 #include "UOPstream.H"
30 #include "OPstream.H"
31 
32 // * * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * //
33 
35 (
36  const UPstream::commsTypes commsType,
37  const int toProcNo,
38  DynamicList<char>& sendBuf,
39  const int tag,
40  const label comm,
41  const bool sendAtDestruct,
43 )
44 :
45  UOPstreamBase(commsType, toProcNo, sendBuf, tag, comm, sendAtDestruct, fmt)
46 {}
47 
48 
49 Foam::UOPstream::UOPstream(const int toProcNo, PstreamBuffers& buffers)
50 :
51  UOPstreamBase(toProcNo, buffers)
52 {}
53 
54 
56 (
57  DynamicList<char>& sendBuf,
59 )
60 :
61  UOPstreamBase(sendBuf, fmt)
62 {}
63 
64 
66 (
67  const UPstream::commsTypes commsType,
68  const int toProcNo,
69  const label bufSize,
70  const int tag,
71  const label comm,
73 )
74 :
75  Pstream(commsType, bufSize),
76  UOPstream
77  (
78  commsType,
79  toProcNo,
80  Pstream::transferBuf_,
81  tag,
82  comm,
83  true, // sendAtDestruct
84  fmt
85  )
86 {}
87 
88 
89 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
90 
92 {
93  if (sendAtDestruct_)
94  {
95  if (!bufferIPCsend())
96  {
98  << "Failed sending outgoing message of size "
99  << sendBuf_.size() << " to processor " << toProcNo_
101  }
102  }
103 }
104 
105 
106 // ************************************************************************* //
OPstream(const UPstream::commsTypes commsType, const int toProcNo, const label bufSize=0, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
Construct for given process index to send to and optional buffer size, write format.
Definition: OPstreams.C:59
commsTypes
Communications types.
Definition: UPstream.H:72
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
UOPstream(const UPstream::commsTypes commsType, const int toProcNo, DynamicList< char > &sendBuf, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool sendAtDestruct=true, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
Construct given process index to write to using the given attached send buffer, optional communicatio...
Definition: OPstreams.C:28
Inter-processor communications stream.
Definition: Pstream.H:57
errorManip< error > abort(error &err)
Definition: errorManip.H:139
Output inter-processor communications stream using MPI send/recv etc. - operating on external buffer...
Definition: UOPstream.H:395
virtual ~UOPstream()
Destructor, usually sends buffer on destruct.
Definition: OPstreams.C:84
Buffers for inter-processor communications streams (UOPstream, UIPstream).
streamFormat
Data format (ascii | binary)
Base class for output inter-processor communications stream (ie, parallel streams). Not to be used directly, thus contructors are protected.
Definition: UOPstream.H:54