UOPstream.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2025 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::UOPstream
 
Description
    Output inter-processor communications stream operating on external
    buffer.
 
SourceFiles
    UOPstream.C
 
\*---------------------------------------------------------------------------*/
 
#include "Pstream.H"
 
#ifndef UOPstream_H
#define UOPstream_H
 
#include "UPstream.H"
#include "Ostream.H"
#include "DynamicList.H"
#include "PstreamBuffers.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                          Class UOPstream Declaration
\*---------------------------------------------------------------------------*/
 
class UOPstream
:
    public UPstream,
    public Ostream
{
    // Private Data
 
        int toProcNo_;
 
        DynamicList<char>& sendBuf_;
 
        const int tag_;
 
        const label comm_;
 
        const bool sendAtDestruct_;
 
 
    // Private Member Functions
 
        //- Write a T to the transfer buffer
        template<class T>
        inline void writeToBuffer(const T&);
 
        //- Write a char to the transfer buffer
        inline void writeToBuffer(const char&);
 
        //- Write data to the transfer buffer
        inline void writeToBuffer(const void* data, size_t count, size_t align);
 
 
public:
 
    // Constructors
 
        //- Construct given process index to send to and optional buffer size,
        //  write format and IO version
        UOPstream
        (
            const commsTypes commsType,
            const int toProcNo,
            DynamicList<char>& sendBuf,
            const int tag = UPstream::msgType(),
            const label comm = UPstream::worldComm,
            const bool sendAtDestruct = true,
            const streamFormat format = BINARY,
            const versionNumber version = currentVersion,
            const bool global = false
        );
 
        //- Construct given buffers
        UOPstream(const int toProcNo, PstreamBuffers&);
 
 
    //- Destructor
    ~UOPstream();
 
 
    // Member Functions
 
        // Inquiry
 
            //- Return flags of output stream
            ios_base::fmtflags flags() const
            {
                return ios_base::fmtflags(0);
            }
 
 
        // Write functions
 
            using Ostream::write;
 
            //- Write given buffer to given processor
            static bool write
            (
                const commsTypes commsType,
                const int toProcNo,
                const char* buf,
                const std::streamsize bufSize,
                const int tag = UPstream::msgType(),
                const label communicator = 0
            );
 
            //- Write character
            Ostream& write(const char);
 
            //- Write character string
            Ostream& write(const char*);
 
            //- Write word
            Ostream& write(const word&);
 
            //- Write string
            Ostream& write(const string&);
 
            //- Write keyType
            Ostream& write(const keyType&);
 
            //- Write verbatimString
            Ostream& write(const verbatimString&);
 
            //- Write std::string surrounded by quotes.
            //  Optional write without quotes.
            Ostream& writeQuoted
            (
                const std::string&,
                const bool quoted=true
            );
 
            //- Write int32_t
            Ostream& write(const int32_t);
 
            //- Write int64_t
            Ostream& write(const int64_t);
 
            //- Write uint32_t
            Ostream& write(const uint32_t);
 
            //- Write uint64_t
            Ostream& write(const uint64_t);
 
            //- Write floatScalar
            Ostream& write(const floatScalar);
 
            //- Write doubleScalar
            Ostream& write(const doubleScalar);
 
            //- Write longDoubleScalar
            Ostream& write(const longDoubleScalar);
 
            //- Write binary block
            Ostream& write(const char*, std::streamsize);
 
            //- Add indentation characters
            void indent()
            {}
 
 
        // Stream state functions
 
            //- Flush stream
            void flush()
            {}
 
            //- Add newline and flush stream
            void endl()
            {}
 
            //- Get width of output field
            int width() const
            {
                return 0;
            }
 
            //- Set width of output field (and return old width)
            int width(const int)
            {
                 return 0;
            }
 
            //- Get precision of output field
            int precision() const
            {
                 return 0;
            }
 
            //- Set precision of output field (and return old precision)
            int precision(const int)
            {
                 return 0;
            }
 
 
        // Edit
 
            //- Set flags of stream
            ios_base::fmtflags flags(const ios_base::fmtflags)
            {
                return ios_base::fmtflags(0);
            }
 
 
        // Print
 
            //- Print description of IOstream to Ostream
            void print(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //