File size: 8,345 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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2022 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::CompactIOList
Description
A List of objects of type \<Type\> with automated input and output using
a compact storage. Behaves like IOList except when binary output in
case it writes a CompactListList.
Useful for lists of small sublists e.g. faceList, cellList.
SourceFiles
CompactIOList.C
\*---------------------------------------------------------------------------*/
#ifndef CompactIOList_H
#define CompactIOList_H
#include "IOList.H"
#include "regIOobject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template
<
template<class> class Container,
template<class> class IOContainer,
template<class> class CompactIOContainer,
class Type
>
class CompactIOListBase;
template
<
template<class> class Container,
template<class> class IOContainer,
template<class> class CompactIOContainer,
class Type
>
void writeEntry
(
Ostream&,
const CompactIOListBase<Container, IOContainer, CompactIOContainer, Type>&
);
template
<
template<class> class Container,
template<class> class IOContainer,
template<class> class CompactIOContainer,
class Type
>
Istream& operator>>
(
Istream&,
CompactIOListBase<Container, IOContainer, CompactIOContainer, Type>&
);
template
<
template<class> class Container,
template<class> class IOContainer,
template<class> class CompactIOContainer,
class Type
>
Ostream& operator<<
(
Ostream&,
const CompactIOListBase<Container, IOContainer, CompactIOContainer, Type>&
);
/*---------------------------------------------------------------------------*\
Class CompactIOListBase Declaration
\*---------------------------------------------------------------------------*/
template
<
template<class> class Container,
template<class> class IOContainer,
template<class> class CompactIOContainer,
class Type
>
class CompactIOListBase
:
public regIOobject,
public Container<Type>
{
// Private Member Functions
//- Does the container have too many elements to represent with the
// current integer size type?
bool overflows() const;
//- Convert the data to a compact representation
void convertToCompact
(
labelList& start,
List<typename Type::value_type>& elems
) const;
//- Convert the data from a compact representation
void convertFromCompact
(
const labelList& start,
const List<typename Type::value_type>& elems
);
//- Read according to header type
void readFromStream(const bool read = true);
public:
// Constructors
//- Construct from IOobject
CompactIOListBase(const IOobject&);
//- Construct from IOobject; does local processor require reading?
CompactIOListBase(const IOobject&, const bool read);
//- Construct from IOobject and size of CompactIOListBase
CompactIOListBase(const IOobject&, const label);
//- Construct from IOobject and a Container
CompactIOListBase(const IOobject&, const Container<Type>&);
//- Move construct by transferring the Container contents
CompactIOListBase(const IOobject&, Container<Type>&&);
//- Move constructor
CompactIOListBase
(
CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&&
);
//- Destructor
virtual ~CompactIOListBase();
// Member Functions
//- WriteObject function. Changes the write type depending on whether
// the output is compact or not.
virtual bool writeObject
(
IOstream::streamFormat,
IOstream::versionNumber,
IOstream::compressionType,
const bool write
) const;
//- WriteData function required for regIOobject write operation
virtual bool writeData(Ostream&) const;
// Member Operators
//- Inherit assignment operators
using Container<Type>::operator=;
//- Assign to another CompactIOList
void operator=
(
const CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&
);
//- Move-assign to another CompactIOList
void operator=
(
CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&&
);
// IOstream functions
//- Write list to Ostream
friend void writeEntry
<
Container,
IOContainer,
CompactIOContainer,
Type
>
(
Ostream&,
const CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&
);
// IOstream Operators
//- Read list from Istream
friend Istream& operator>>
<
Container,
IOContainer,
CompactIOContainer,
Type
>
(
Istream&,
CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&
);
// Write list to Ostream
friend Ostream& operator<<
<
Container,
IOContainer,
CompactIOContainer,
Type
>
(
Ostream&,
const CompactIOListBase
<
Container,
IOContainer,
CompactIOContainer,
Type
>&
);
};
/*---------------------------------------------------------------------------*\
Class CompactIOList Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class CompactIOList
:
public CompactIOListBase<List, IOList, CompactIOList, Type>
{
public:
//- Runtime type information
TypeName("ListList");
// Constructors
//- Inherit constructors
using
CompactIOListBase<List, IOList, CompactIOList, Type>::
CompactIOListBase;
// Member Operators
//- Inherit assignment operators
using
CompactIOListBase<List, IOList, CompactIOList, Type>::
operator=;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "CompactIOList.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|