File size: 6,143 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-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::fileOperations::collatedFileOperation
Description
Version of masterUncollatedFileOperation that collates regIOobjects
into a container in the processors/ subdirectory.
Uses threading if maxThreadFileBufferSize > 0.
See also
masterUncollatedFileOperation
SourceFiles
collatedFileOperation.C
\*---------------------------------------------------------------------------*/
#ifndef collatedFileOperation_fileOperation_H
#define collatedFileOperation_fileOperation_H
#include "masterUncollatedFileOperation.H"
#include "OFstreamCollator.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fileOperations
{
/*---------------------------------------------------------------------------*\
Class collatedFileOperation Declaration
\*---------------------------------------------------------------------------*/
class collatedFileOperation
:
public masterUncollatedFileOperation
{
protected:
// Protected data
//- Any communicator allocated by me
const label myComm_;
//- Threaded writer
mutable OFstreamCollator writer_;
// For non-parallel operation
//- Number of processors (overall)
label nProcs_;
//- Ranks of IO handlers
const labelList ioRanks_;
// Private Member Functions
static labelList ioRanks();
//- Is proci master of communicator (in parallel) or master of
// the io ranks (non-parallel)
bool isMasterRank(const label proci) const;
//- Append to processors/ file
bool appendObject
(
const regIOobject& io,
const fileName& filePath,
IOstream::streamFormat fmt,
IOstream::versionNumber ver,
IOstream::compressionType cmp
) const;
public:
//- Runtime type information
TypeName("collated");
// Static data
//- Max size of thread buffer size. This is the overall size of
// all files to be written. Starts blocking if not enough size.
// Read as float to enable easy specification of large sizes.
static float maxThreadFileBufferSize;
// Constructors
//- Construct null
collatedFileOperation(const bool verbose);
//- Construct from user communicator
collatedFileOperation
(
const label comm,
const labelList& ioRanks,
const word& typeName,
const bool verbose
);
//- Destructor
virtual ~collatedFileOperation();
// Member Functions
// (reg)IOobject functionality
//- Generate disk file name for object. Opposite of filePath.
virtual fileName objectPath
(
const IOobject& io
) const;
//- Writes a regIOobject (so header, contents and divider).
// Returns success state.
virtual bool writeObject
(
const regIOobject&,
IOstream::streamFormat format=IOstream::ASCII,
IOstream::versionNumber version=IOstream::currentVersion,
IOstream::compressionType compression=IOstream::UNCOMPRESSED,
const bool write = true
) const;
// Other
//- Forcibly wait until all output done. Flush any cached data
virtual void flush() const;
//- Actual name of processors dir
virtual word processorsDir(const IOobject&) const;
//- Actual name of processors dir
virtual word processorsDir(const fileName&) const;
//- Set number of processor directories/results. Only used in
// decomposePar
virtual void setNProcs(const label nProcs);
};
/*---------------------------------------------------------------------------*\
Class collatedFileOperationInitialise Declaration
\*---------------------------------------------------------------------------*/
class collatedFileOperationInitialise
:
public masterUncollatedFileOperationInitialise
{
public:
// Constructors
//- Construct from components
collatedFileOperationInitialise(int& argc, char**& argv)
:
masterUncollatedFileOperationInitialise(argc, argv)
{}
//- Destructor
virtual ~collatedFileOperationInitialise()
{}
// Member Functions
//- Needs threading
virtual bool needsThreading() const
{
return
collatedFileOperation::maxThreadFileBufferSize
> 0;
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fileOperations
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|