-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvisit_writer.h
307 lines (282 loc) · 13.6 KB
/
visit_writer.h
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
/*****************************************************************************
*
* Copyright (c) 2000 - 2008, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-400142
* All rights reserved.
*
* This file is part of VisIt. For details, see https://visit.llnl.gov/. The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the disclaimer (as noted below) in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the LLNS/LLNL nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/
/* ************************************************************************* //
// visit_writer.h //
// ************************************************************************* */
/*
// This file contains function prototypes for writing out point meshes,
// unstructured meshes, rectilinear meshes, regular meshes, and
// structured/curvilinear meshes into files that can later be read by VisIt.
//
// Each routine assumes that the data being written is three-dimensional.
// If the data is two-dimensional, you must still write out the data
// as three-dimensional (ie pad arrays so that they are the correct size, etc).
// However: the VisIt reader will determine that the data is truly two-
// dimensional and visualize it as a two-dimensional dataset.
//
// All writers have an ASCII vs Binary decision. The tradeoffs are the
// standard ones: ASCII is human readable, but slow. The
// binary is much faster, but not human readable. Note: the binary format
// is portable, since it converts all data to be big-endian (this was a
// design decision for the format the visit_writer writes to -- the VTK
// format).
//
// If you have multiple grids, you can write out one file for each grid.
// There are potential pitfalls in doing this, where extra geometry and
// interpolation problems appear along grid boundaries. For additional
// help with this issue, e-mail [email protected]
*/
/* ****************************************************************************
// Function: write_point_mesh
//
// Purpose:
// Writes out a point mesh.
//
// Arguments:
// filename The name of the file to write. If the extension ".vtk" is
// not present, it will be added.
// useBinary '0' to write ASCII, !0 to write binary
// npts The number of points in the mesh.
// pts The spatial locations of the points. This array should
// be size 3*npts. The points should be encoded as:
// <x1, y1, z1, x2, y2, z2, ..., xn, yn, zn>
// nvars The number of variables.
// vardim The dimension of each variable. The size of vardim should
// be nvars. If var i is a scalar, then vardim[i] = 1.
// If var i is a vector, then vardim[i] = 3.
// vars An array of variables. The size of vars should be nvars.
// The size of vars[i] should be npts*vardim[i].
//
// Programmer: Hank Childs
// Creation: September 2, 2004
//
// ***************************************************************************/
void write_point_mesh(const char *filename, int useBinary, int npts,
double *pts, int nvars, int *vardim,
const char * const *varnames, double **vars);
/* ****************************************************************************
// Function: write_unstructured_mesh
//
// Purpose:
// Writes out a unstructured mesh.
//
//
// Arguments:
// filename The name of the file to write. If the extension ".vtk" is
// not present, it will be added.
// useBinary '0' to write ASCII, !0 to write binary
// npts The number of points in the mesh.
// pts The spatial locations of the points. This array should
// be size 3*npts. The points should be encoded as:
// <x1, y1, z1, x2, y2, z2, ..., xn, yn, zn>
// ncells The number of cells.
// celltypes The type of each cell.
// conn The connectivity array.
// nvars The number of variables.
// vardim The dimension of each variable. The size of vardim should
// be nvars. If var i is a scalar, then vardim[i] = 1.
// If var i is a vector, then vardim[i] = 3.
// centering The centering of each variable. The size of centering
// should be nvars. If centering[i] == 0, then the variable
// is cell-based. If centering[i] != 0, then the variable
// is point-based.
// vars An array of variables. The size of vars should be nvars.
// The size of vars[i] should be npts*vardim[i].
//
// Example:
// You have two triangles. The first has points (0,0,0), (0,1,0), and
// (1,1,0). The second has points (0,0,0), (1,1,0), and (1,0,0).
//
// There are four unique points.
//
// double pts[12] = { 0,0,0, 0,1,0, 1,1,0, 1,0,0 };
//
// It is important the points list contain only unique points,
// because VisIt is not able to correctly determine the connectivity of a
// dataset when points are duplicated.
//
// There are two triangles.
// int ncells = 2;
//
// The cells are both triangles.
// int celltypes[2] = { VISIT_TRIANGLE, VISIT_TRIANGLE };
//
// The connectivity contains indices into the points list. The indexing
// assumes that each point has size 3 (x,y,z).
//
// int conn[6] = { 0, 1, 2, 0, 2, 3 };
//
// Hint:
// When writing an unstructured mesh, it is easy to get the orientation
// of a cell backwards. VisIt typically does okay with this, but it
// can cause problems. To test if this is happening, bring up VisIt on
// your newly outputted dataset and make a Pseudocolor plot of
// "mesh_quality/volume" for 3D datasets or "mesh_quality/area" for 2D
// datasets. If the cells are inside-out, the volumes or areas will be
// negative.
//
//
// Programmer: Hank Childs
// Creation: September 2, 2004
//
// ***************************************************************************/
#define VISIT_VERTEX 1
#define VISIT_LINE 3
#define VISIT_TRIANGLE 5
#define VISIT_QUAD 9
#define VISIT_TETRA 10
#define VISIT_HEXAHEDRON 12
#define VISIT_WEDGE 13
#define VISIT_PYRAMID 14
void write_unstructured_mesh(const char *filename, int useBinary, int npts,
double *pts, int ncells, int *celltypes, int *conn,
int nvars, int *vardim, int *centering,
const char * const *varnames, double **vars);
/* ****************************************************************************
// Function: write_regular_mesh
//
// Purpose:
// Writes out a regular mesh. A regular mesh is one where the data lies
// along regular intervals. "Brick of bytes/doubles",
// "Block of bytes/doubles", and MRI data all are examples of data that
// lie on regular meshes.
//
//
// Arguments:
// filename The name of the file to write. If the extension ".vtk" is
// not present, it will be added.
// useBinary '0' to write ASCII, !0 to write binary
// dims An array of size 3 = { nX, nY, nZ }, where nX is the
// number of points in the X-dimension, etc.
// nvars The number of variables.
// vardim The dimension of each variable. The size of vardim should
// be nvars. If var i is a scalar, then vardim[i] = 1.
// If var i is a vector, then vardim[i] = 3.
// centering The centering of each variable. The size of centering
// should be nvars. If centering[i] == 0, then the variable
// is cell-based. If centering[i] != 0, then the variable
// is point-based.
// vars An array of variables. The size of vars should be nvars.
// The size of vars[i] should be npts*vardim[i].
//
//
// Programmer: Hank Childs
// Creation: September 2, 2004
//
// ***************************************************************************/
void write_regular_mesh(const char *filename, int useBinary, int *dims,
int* procGridLow, int nvars, int *vardim, int *centering,
const char * const *varnames, double **vars);
/* ****************************************************************************
// Function: write_rectilinear_mesh
//
// Purpose:
// Writes out a rectilinear mesh.
//
//
// Arguments:
// filename The name of the file to write. If the extension ".vtk" is
// not present, it will be added.
// useBinary '0' to write ASCII, !0 to write binary
// dims An array of size 3 = { nX, nY, nZ }, where nX is the
// number of points in the X-dimension, etc.
// x An array of size dims[0] that contains the x-coordinates.
// y An array of size dims[1] that contains the x-coordinates.
// z An array of size dims[2] that contains the x-coordinates.
// nvars The number of variables.
// vardim The dimension of each variable. The size of vardim should
// be nvars. If var i is a scalar, then vardim[i] = 1.
// If var i is a vector, then vardim[i] = 3.
// centering The centering of each variable. The size of centering
// should be nvars. If centering[i] == 0, then the variable
// is cell-based. If centering[i] != 0, then the variable
// is point-based.
// vars An array of variables. The size of vars should be nvars.
// The size of vars[i] should be npts*vardim[i].
//
//
// Example:
// You have a rectilinear mesh with x = { 0, 1, 2}, y = { 1, 1.5, 2, 3 },
// and z = { 2.5, 3.5 }.
//
// Then dims = { 3, 4, 2 }.
//
// Programmer: Hank Childs
// Creation: September 2, 2004
//
// ***************************************************************************/
void write_rectilinear_mesh(const char *filename, int useBinary,
int *dims, double *x, double *y, double *z,
int nvars, int *vardim, int *centering,
const char * const *varnames, double **vars);
/* ****************************************************************************
// Function: write_curvilinear_mesh
//
// Purpose:
// Writes out a curvilinear mesh.
//
//
// Arguments:
// filename The name of the file to write. If the extension ".vtk" is
// not present, it will be added.
// useBinary '0' to write ASCII, !0 to write binary
// dims An array of size 3 = { nI, nJ, nK }, where nI is the
// number of points in the logical I dimension, etc.
// pts An array of size nI*nJ*nK*3. The array should be layed
// out as (pt(i=0,j=0,k=0), pt(i=1,j=0,k=0), ...
// pt(i=nI-1,j=0,k=0), pt(i=0,j=1,k=0), ...).
// nvars The number of variables.
// vardim The dimension of each variable. The size of vardim should
// be nvars. If var i is a scalar, then vardim[i] = 1.
// If var i is a vector, then vardim[i] = 3.
// centering The centering of each variable. The size of centering
// should be nvars. If centering[i] == 0, then the variable
// is cell-based. If centering[i] != 0, then the variable
// is point-based.
// vars An array of variables. The size of vars should be nvars.
// The size of vars[i] should be npts*vardim[i].
//
//
// Programmer: Hank Childs
// Creation: September 2, 2004
//
// ***************************************************************************/
void write_curvilinear_mesh(const char *filename, int useBinary,
int *dims, double *pts,
int nvars, int *vardim, int *centering,
const char * const *varnames, double **vars);