File size: 14,237 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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 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::setWriter
Description
Base class for writing coordinate sets with data
Example:
\verbatim
setWriter::New("vtk")->write
(
"myDirectory",
"mySet",
coordSet(true, "position", points),
"p", p,
"U", U
);
\endverbatim
SourceFiles
setWriter.C
\*---------------------------------------------------------------------------*/
#ifndef setWriter_H
#define setWriter_H
#include "runTimeSelectionTables.H"
#include "autoPtr.H"
#include "fieldTypes.H"
#include "coordSet.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class setWriter Declaration
\*---------------------------------------------------------------------------*/
class setWriter
{
public:
// Public Static Functions
//- Helper for variadic write
template<class Types, class Type>
static inline void appendTypeValueSet
(
UPtrList<const Field<Types>>& valueSets,
const Field<Type>& valueSet
)
{
valueSets.resize(valueSets.size() + 1);
valueSets.set(valueSets.size() - 1, nullptr);
}
//- Helper for variadic write
template<class Type>
static inline void appendTypeValueSet
(
UPtrList<const Field<Type>>& valueSets,
const Field<Type>& valueSet
)
{
valueSets.resize(valueSets.size() + 1);
valueSets.set(valueSets.size() - 1, &valueSet);
}
//- Helper for variadic write
static inline void unpackTypeValueSets
(
wordList& valueSetNames
#define TypeValueSetsNonConstArg(Type, nullArg) \
, UPtrList<const Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg)
#undef TypeValueSetsNonConstArg
)
{}
//- Helper for variadic write
template<class Type, class ... Args>
static inline void unpackTypeValueSets
(
wordList& valueSetNames
#define TypeValueSetsNonConstArg(Type, nullArg) \
, UPtrList<const Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg),
#undef TypeValueSetsNonConstArg
const word& valueSetName,
const Field<Type>& valueSet,
Args& ... args
)
{
valueSetNames.append(valueSetName);
#define AppendTypeValueSet(Type, nullArg) \
appendTypeValueSet(Type##ValueSets, valueSet);
FOR_ALL_FIELD_TYPES(AppendTypeValueSet);
#undef AppendTypeValueSet
unpackTypeValueSets
(
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter),
#undef TypeValueSetsParameter
args ...
);
}
//- Helper for variadic write
template<class Type, class ... Args>
static inline void unpackTypeValueSets
(
wordList& valueSetNames
#define TypeValueSetsNonConstArg(Type, nullArg) \
, UPtrList<const Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg),
#undef TypeValueSetsNonConstArg
const wordList& valueSetNamesPart,
const UPtrList<const Field<Type>>& valueSetsPart,
Args& ... args
)
{
forAll(valueSetNamesPart, i)
{
valueSetNames.append(valueSetNamesPart[i]);
#define AppendTypeValueSet(Type, nullArg) \
appendTypeValueSet(Type##ValueSets, valueSetsPart[i]);
FOR_ALL_FIELD_TYPES(AppendTypeValueSet);
#undef AppendTypeValueSet
}
unpackTypeValueSets
(
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter),
#undef TypeValueSetsParameter
args ...
);
}
//- Helper for variadic write
template<class Type, class ... Args>
static inline void unpackTypeValueSets
(
wordList& valueSetNames
#define TypeValueSetsNonConstArg(Type, nullArg) \
, UPtrList<const Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg),
#undef TypeValueSetsNonConstArg
const wordList& valueSetNamesPart,
const PtrList<Field<Type>>& valueSetsPart,
Args& ... args
)
{
unpackTypeValueSets
(
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter),
#undef TypeValueSetsParameter
valueSetNamesPart,
reinterpret_cast<const UPtrList<const Field<Type>>&>
(valueSetsPart),
args ...
);
}
protected:
// Protected Data
//- Write format
IOstream::streamFormat writeFormat_;
//- Write compression
IOstream::compressionType writeCompression_;
//- Possible delimiters that need quoting. Constructed on demand from
// the write.*Separator functions.
mutable autoPtr<List<string>> delimiters_;
// Protected Member Functions
//- Write a value separator
virtual void writeValueSeparator(Ostream& os) const;
//- Write a coordinate separator
virtual void writeCoordSeparator(Ostream& os) const;
//- Write a segment separator
virtual void writeSegmentSeparator(Ostream& os) const;
//- Possible delimiters that need quoting
const List<string>& delimiters() const;
//- Width of columns in tabulated output
static inline unsigned long columnWidth(Ostream& os)
{
return os.precision() + 7;
}
//- Write a word
inline Ostream& writeWord
(
const word& w,
Ostream& os,
const bool align = false,
const unsigned long alignPad = 0
) const;
//- Write a value
template<class Type>
Ostream& writeValue
(
const Type& value,
Ostream& os,
const bool align = false
) const;
//- Write multi-column table header
void writeTableHeader
(
const coordSet& set,
const wordList& valueSetNames,
#define TypeValueSetsConstArg(Type, nullArg) \
const UPtrList<const Field<Type>>& Type##ValueSets ,
FOR_ALL_FIELD_TYPES(TypeValueSetsConstArg)
#undef TypeValueSetsConstArg
Ostream& os,
const bool align = false,
const unsigned long alignPad = 0
) const;
//- Write multi-column table of data
void writeTable
(
const coordSet& set,
#define TypeValueSetsConstArg(Type, nullArg) \
const UPtrList<const Field<Type>>& Type##ValueSets ,
FOR_ALL_FIELD_TYPES(TypeValueSetsConstArg)
#undef TypeValueSetsConstArg
Ostream& os,
const bool align = false
) const;
public:
//- Runtime type information
TypeName("setWriter");
// Declare run-time constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
setWriter,
word,
(
const IOstream::streamFormat writeFormat,
const IOstream::compressionType writeCompression
),
(writeFormat, writeCompression)
);
declareRunTimeSelectionTable
(
autoPtr,
setWriter,
dict,
(
const dictionary& dict
),
(dict)
);
// Selectors
//- Select given write options
static autoPtr<setWriter> New
(
const word& writeType,
const IOstream::streamFormat writeFormat =
IOstream::ASCII,
const IOstream::compressionType writeCompression =
IOstream::UNCOMPRESSED
);
//- Select given a dictionary
static autoPtr<setWriter> New
(
const word& writeType,
const dictionary& dict
);
// Constructors
//- Construct given write options
setWriter
(
const IOstream::streamFormat writeFormat,
const IOstream::compressionType writeCompression
);
//- Construct from dictionary
setWriter(const dictionary& dict);
//- Construct copy
setWriter(const setWriter& writer);
//- Construct and return a clone
virtual autoPtr<setWriter> clone() const = 0;
//- Destructor
virtual ~setWriter() = 0;
// Member Functions
//- Write a coordSet and associated data
virtual void write
(
const fileName& outputDir,
const fileName& setName,
const coordSet& set,
const wordList& valueSetNames
#define TypeValueSetsConstArg(Type, nullArg) \
, const UPtrList<const Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsConstArg)
#undef TypeValueSetsConstArg
) const = 0;
//- Write a coordSet and associated data
virtual void write
(
const fileName& outputDir,
const fileName& setName,
const coordSet& set,
const wordList& valueSetNames
#define TypeValueSetsConstArg(Type, nullArg) \
, const PtrList<Field<Type>>& Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsConstArg)
#undef TypeValueSetsConstArg
) const
{
write
(
outputDir,
setName,
set,
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, reinterpret_cast<const UPtrList<const Field<Type>>&> \
(Type##ValueSets)
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter)
#undef TypeValueSetsParameter
);
}
//- Write fields for a single surface to file. For use in code where
// the fields that are to be written are known. Takes any number of
// name, values arguments at the end. E.g.:
//
// write
// (
// // Output options
// "myDirectory", "mySet",
//
// // Geometry
// coordSet(true, "position", points),
//
// // Fields
// "p", Field<scalar>(points.size(), ...),
// "U", Field<vector>(points.size(), ...)
// );
//
template<class ... Args>
void inline write
(
const fileName& outputDir,
const fileName& setName,
const coordSet& set,
const Args& ... args
) const
{
wordList valueSetNames;
#define DeclareTypeValueSets(Type, nullArg) \
UPtrList<const Field<Type>> Type##ValueSets;
FOR_ALL_FIELD_TYPES(DeclareTypeValueSets);
#undef DeclareTypeValueSets
unpackTypeValueSets
(
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter),
#undef TypeValueSetsParameter
args ...
);
write
(
outputDir,
setName,
set,
valueSetNames
#define TypeValueSetsParameter(Type, nullArg) \
, Type##ValueSets
FOR_ALL_FIELD_TYPES(TypeValueSetsParameter)
#undef TypeValueSetsParameter
);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "setWriterTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|