Loading...
Searching...
No Matches
UPstreamFile.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) 2025 Mark Olesen
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "fileName.H"
29#include "UPstreamFile.H"
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
33namespace Foam
34{
35
36/*---------------------------------------------------------------------------*\
37 Class UPstream::File::Impl Declaration
38\*---------------------------------------------------------------------------*/
39
41
42} // End namespace Foam
43
44
45// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
46
49 return false;
50}
51
52
53// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
54
56
57
58// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
61{} // Non-default in header (incomplete types)
62
63
64// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69}
70
73{
74 return false;
75}
76
77
79{
80 return false;
81}
82
83
84// * * * * * * * * * * * * Member Functions (Reading) * * * * * * * * * * * //
85
86#if 0
87bool Foam::UPstream::File::open_read
88(
89 const int communicator,
90 const fileName& pathname
91)
92{
94 return false;
95}
96#endif
97
98
99// * * * * * * * * * * * * Member Functions (Writing) * * * * * * * * * * * //
100
102(
103 const int communicator,
104 const fileName& pathname,
107{
109 return false;
110}
111
112
114(
115 const void* data,
116 std::streamsize count,
117 const UPstream::dataTypes dataTypeId
119{
121 return false;
122}
123
124
126(
127 std::streamsize offset,
128 const void* data,
129 std::streamsize count,
130 const UPstream::dataTypes dataTypeId
132{
134 return false;
135}
136
137
139(
140 const void* data,
141 std::streamsize count,
142 const UPstream::dataTypes dataTypeId
144{
146 return false;
147}
148
149
151(
152 std::streamsize offset,
153 const void* data,
154 std::streamsize count,
155 const UPstream::dataTypes dataTypeId
157{
159 return false;
160}
161
162
163bool Foam::UPstream::File::set_size(std::streamsize num_bytes)
164{
166 return false;
167}
168
169
170// ************************************************************************* //
atomicType
Atomic operations (output).
~File()
Destructor. Non-default in header (incomplete types).
bool is_open() const
True if allocated and open has been called.
bool open_write(const int communicator, const fileName &pathname, IOstreamOption::atomicType=IOstreamOption::NON_ATOMIC)
MPI_File_open [collective] : open file in write-only mode, no-append.
bool write_data_at_all(std::streamsize offset, const void *buffer, std::streamsize count, const UPstream::dataTypes dataTypeId)
MPI_File_write_at_all [collective] : write data at specified offset.
bool close()
MPI_File_close [collective].
const fileName & name() const
The name of the open stream.
static bool supported()
True if MPI/IO appears to be supported.
bool set_size(std::streamsize num_bytes)
Set the (output) file size [collective].
File()
Default construct.
bool write_data_at(std::streamsize offset, const void *buffer, std::streamsize count, const UPstream::dataTypes dataTypeId)
MPI_File_write_at [non-collective] : write data at specified offset.
bool write_data_all(const void *buffer, std::streamsize count, const UPstream::dataTypes dataTypeId)
MPI_File_write_all [collective] : write data.
bool write_data(const void *buffer, std::streamsize count, const UPstream::dataTypes dataTypeId)
MPI_File_write [non-collective] : write data.
Wrapper for internally indexed communicator label. Always invokes UPstream::allocateCommunicatorCompo...
Definition UPstream.H:2546
dataTypes
Mapping of some fundamental and aggregate types to MPI data types.
Definition UPstream.H:107
A class for handling file names.
Definition fileName.H:75
static const fileName null
An empty fileName.
Definition fileName.H:111
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition error.H:688
Namespace for OpenFOAM.