File size: 8,398 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::surfaceWriter
Description
Base class for surface writers
SourceFiles
surfaceWriter.C
\*---------------------------------------------------------------------------*/
#ifndef surfaceWriter_H
#define surfaceWriter_H
#include "typeInfo.H"
#include "autoPtr.H"
#include "pointField.H"
#include "faceList.H"
#include "fileName.H"
#include "setWriter.H"
#include "runTimeSelectionTables.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class surfaceWriter Declaration
\*---------------------------------------------------------------------------*/
class surfaceWriter
{
protected:
// Protected Data
//- Write format
IOstream::streamFormat writeFormat_;
//- Write compression
IOstream::compressionType writeCompression_;
public:
//- Runtime type information
TypeName("surfaceWriter");
// Declare run-time constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
surfaceWriter,
word,
(
const IOstream::streamFormat writeFormat,
const IOstream::compressionType writeCompression
),
(writeFormat, writeCompression)
);
declareRunTimeSelectionTable
(
autoPtr,
surfaceWriter,
dict,
(
const dictionary& dict
),
(dict)
);
// Selectors
//- Select given write options
static autoPtr<surfaceWriter> New
(
const word& writeType,
const IOstream::streamFormat writeFormat,
const IOstream::compressionType writeCompression
);
//- Select given a dictionary
static autoPtr<surfaceWriter> New
(
const word& writeType,
const dictionary& dict
);
// Constructors
//- Construct given write options
surfaceWriter
(
const IOstream::streamFormat writeFormat,
const IOstream::compressionType writeCompression
);
//- Construct from dictionary
surfaceWriter(const dictionary& dict);
//- Destructor
virtual ~surfaceWriter();
// Member Functions
//- Write fields for a single surface to file.
virtual void write
(
const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
const wordList& fieldNames, // names of fields
const bool writePointValues
#define FieldTypeValuesConstArg(Type, nullArg) \
, const UPtrList<const Field<Type>>& field##Type##Values
FOR_ALL_FIELD_TYPES(FieldTypeValuesConstArg)
#undef FieldTypeValuesConstArg
) const = 0;
//- Write fields for a single surface to file.
virtual void write
(
const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
const wordList& fieldNames, // names of fields
const bool writePointValues
#define FieldTypeValuesConstArg(Type, nullArg) \
, const PtrList<Field<Type>>& field##Type##Values
FOR_ALL_FIELD_TYPES(FieldTypeValuesConstArg)
#undef FieldTypeValuesConstArg
) const
{
write
(
outputDir,
surfaceName,
points,
faces,
fieldNames,
writePointValues
#define FieldTypeValuesParameter(Type, nullArg) \
, reinterpret_cast<const UPtrList<const Field<Type>>&> \
(field##Type##Values)
FOR_ALL_FIELD_TYPES(FieldTypeValuesParameter)
#undef FieldTypeValuesParameter
);
}
//- Write the surface geometry only.
void inline write
(
const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces
) const
{
write
(
outputDir,
surfaceName,
points,
faces,
wordList(),
false
#define FieldTypeValuesParameter(Type, nullArg) \
, UPtrList<const Field<Type>>()
FOR_ALL_FIELD_TYPES(FieldTypeValuesParameter)
#undef FieldTypeValuesParameter
);
}
//- 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", "mySurface",
//
// // Geometry
// pp.localPoints(), pp.localFaces(),
//
// // Fields
// "p", Field<scalar>(pp.size(), ...),
// "U", Field<vector>(pp.size(), ...)
// );
//
template<class ... Args>
void inline write
(
const fileName& outputDir, // <case>/surface/TIME
const fileName& surfaceName, // name of surface
const pointField& points,
const faceList& faces,
const bool writePointValues,
const Args& ... args
) const
{
wordList fieldNames;
#define DeclareFieldTypeValues(Type, nullArg) \
UPtrList<const Field<Type>> field##Type##Values;
FOR_ALL_FIELD_TYPES(DeclareFieldTypeValues);
#undef DeclareFieldTypeValues
setWriter::unpackTypeValueSets
(
fieldNames
#define FieldTypeValuesParameter(Type, nullArg) \
, field##Type##Values
FOR_ALL_FIELD_TYPES(FieldTypeValuesParameter),
#undef FieldTypeValuesParameter
args ...
);
write
(
outputDir,
surfaceName,
points,
faces,
fieldNames,
writePointValues
#define FieldTypeValuesParameter(Type, nullArg) \
, field##Type##Values
FOR_ALL_FIELD_TYPES(FieldTypeValuesParameter)
#undef FieldTypeValuesParameter
);
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|