File size: 6,404 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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021 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::vtkWritePolyData

Description
    General write functions for vtk polygonal data files

SourceFiles
    vtkWritePolyData.C

\*---------------------------------------------------------------------------*/

#ifndef vtkWritePolyData_H
#define vtkWritePolyData_H

#include "vtkWriteOps.H"
#include "boolList.H"
#include "fileName.H"
#include "Field.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                     Namespace vtkWritePolyData Declaration
\*---------------------------------------------------------------------------*/

namespace vtkWritePolyData
{

//- Helper for templated write
template<class Types, class Type>
inline void setFieldTypeValue
(
    UPtrList<const Field<Types>>& fieldTypeValues,
    const label fieldi,
    const Field<Type>& fieldTypeValue
)
{}


//- Helper for templated write
template<class Type>
inline void setFieldTypeValue
(
    UPtrList<const Field<Type>>& fieldTypeValues,
    const label fieldi,
    const Field<Type>& fieldTypeValue
)
{
    fieldTypeValues.set(fieldi, &fieldTypeValue);
}


//- Helper for templated write
inline void unpackFieldTypeValues
(
    wordList& fieldNames,
    boolList& fieldIsPointValues,
    UPtrList<const Field<label>>& fieldLabelValues
    #define FieldTypeValuesNonConstArg(Type, nullArg) \
    , UPtrList<const Field<Type>>& field##Type##Values
    FOR_ALL_FIELD_TYPES(FieldTypeValuesNonConstArg)
    #undef FieldTypeValuesNonConstArg
)
{}


//- Helper for templated write
template<class Type, class ... Args>
inline void unpackFieldTypeValues
(
    wordList& fieldNames,
    boolList& fieldIsPointValues,
    UPtrList<const Field<label>>& fieldLabelValues
    #define FieldTypeValuesNonConstArg(Type, nullArg) \
    , UPtrList<const Field<Type>>& field##Type##Values
    FOR_ALL_FIELD_TYPES(FieldTypeValuesNonConstArg),
    #undef FieldTypeValuesNonConstArg
    const word& fieldName,
    const bool fieldIsPointValue,
    const Field<Type>& fieldTypeValue,
    Args& ... args
)
{
    const label fieldi = fieldNames.size() - 1 - sizeof...(Args)/3;

    fieldNames[fieldi] = fieldName;
    fieldIsPointValues[fieldi] = fieldIsPointValue;
    setFieldTypeValue(fieldLabelValues, fieldi, fieldTypeValue);
    #define SetFieldTypeValue(Type, nullArg) \
        setFieldTypeValue(field##Type##Values, fieldi, fieldTypeValue);
    FOR_ALL_FIELD_TYPES(SetFieldTypeValue);
    #undef SetFieldTypeValue

    unpackFieldTypeValues
    (
        fieldNames,
        fieldIsPointValues,
        fieldLabelValues
        #define FieldTypeValuesParameter(Type, nullArg) , field##Type##Values
        FOR_ALL_FIELD_TYPES(FieldTypeValuesParameter),
        #undef FieldTypeValuesParameter
        args ...
    );
}


//- Write the field values out for a type
template<class Type, class DataType>
void writeFieldTypeValues
(
    std::ostream& os,
    const bool binary,
    const wordList& fieldNames,
    const boolList& fieldIsPointValues,
    const UPtrList<const Field<Type>>& fieldTypeValues,
    const bool writePointValues
);


//- Write VTK polygonal data to a file. Takes a PtrList of fields of labels and
//  of every primitive type. Each PtrList should be the length of the total
//  number of fields and only one PtrList should be non-null for each field
//  index.
template<class PointField, class VertexList, class LineList, class FaceList>
void write
(
    const fileName& file,
    const word& title,
    const bool binary,
    const PointField& points,
    const VertexList& vertices,
    const LineList& lines,
    const FaceList& faces,
    const wordList& fieldNames,
    const boolList& fieldIsPointValues,
    const UPtrList<const Field<label>>& fieldLabelValues
    #define FieldTypeValuesConstArg(Type, nullArg) \
        , const UPtrList<const Field<Type>>& field##Type##Values
    FOR_ALL_FIELD_TYPES(FieldTypeValuesConstArg)
    #undef FieldTypeValuesConstArg
);


//- Write VTK polygonal data to a file. Takes any number of name,
//  isPointValues, values arguments at the end. E.g.;
//
//  write
//  (
//      // Output options
//      "myPolyData.vtk", "myPolyData", false,
//
//      // Geometry
//      pp.localPoints(), labelList(), labelListList(), pp.localFaces(),
//
//      // Fields
//      "faceIDs", true, pp.addressing(),
//      "facePressures", false, Field<scalar>(pp.size(), ...),
//      "pointVelocities", true, Field<vector>(pp.nPoints(), ...)
//  );
//
template
<
    class PointField,
    class VertexList,
    class LineList,
    class FaceList,
    class ... Args
>
inline void write
(
    const fileName& file,
    const word& title,
    const bool binary,
    const PointField& points,
    const VertexList& vertices,
    const LineList& lines,
    const FaceList& faces,
    const Args& ... args
);

};

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
    #include "vtkWritePolyDataTemplates.C"
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //