1 #include <../src/sys/classes/viewer/impls/vtk/vtkvimpl.h> /*I "petscviewer.h" I*/
2
3 /*MC
4 PetscViewerVTKWriteFunction - functional form used to provide writer to the PetscViewerVTK
5
6 Synopsis:
7 #include <petscviewer.h>
8 PetscViewerVTKWriteFunction(PetscObject object,PetscViewer viewer)
9
10 Input Parameters:
11 + object - the PETSc object to be written
12 - viewer - viewer it is to be written to
13
14 Level: developer
15
16 .seealso: PetscViewerVTKAddField()
17 M*/
18
19 /*@C
20 PetscViewerVTKAddField - Add a field to the viewer
21
22 Collective
23
24 Input Arguments:
25 + viewer - VTK viewer
26 . dm - DM on which Vec lives
27 . PetscViewerVTKWriteFunction - function to write this Vec
28 . fieldnum - which field of the DM to write (PETSC_DEFAULT if the whle vector should be written)
29 . fieldtype - Either PETSC_VTK_POINT_FIELD or PETSC_VTK_CELL_FIELD
30 . checkdm - whether to check for identical dm arguments as fields are added
31 - vec - Vec from which to write
32
33 Note:
34 This routine keeps exclusive ownership of the Vec. The caller should not use or destroy the Vec after adding it.
35
36 Level: developer
37
38 .seealso: PetscViewerVTKOpen(), DMDAVTKWriteAll(), PetscViewerVTKWriteFunction, PetscViewerVTKGetDM()
39 @*/
PetscViewerVTKAddField(PetscViewer viewer,PetscObject dm,PetscErrorCode (* PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt fieldnum,PetscViewerVTKFieldType fieldtype,PetscBool checkdm,PetscObject vec)40 PetscErrorCode PetscViewerVTKAddField(PetscViewer viewer,PetscObject dm,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt fieldnum,PetscViewerVTKFieldType fieldtype,PetscBool checkdm,PetscObject vec)
41 {
42 PetscErrorCode ierr;
43
44 PetscFunctionBegin;
45 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
46 PetscValidHeader(dm,2);
47 PetscValidHeader(vec,4);
48 ierr = PetscUseMethod(viewer,"PetscViewerVTKAddField_C",(PetscViewer,PetscObject,PetscErrorCode (*)(PetscObject,PetscViewer),PetscInt,PetscViewerVTKFieldType,PetscBool,PetscObject),(viewer,dm,PetscViewerVTKWriteFunction,fieldnum,fieldtype,checkdm,vec));CHKERRQ(ierr);
49 PetscFunctionReturn(0);
50 }
51
52 /*@C
53 PetscViewerVTKGetDM - get the DM associated with the viewer
54
55 Collective
56
57 Input Arguments:
58 + viewer - VTK viewer
59 - dm - DM associated with the viewer (as PetscObject)
60
61 Level: developer
62
63 .seealso: PetscViewerVTKOpen(), DMDAVTKWriteAll(), PetscViewerVTKWriteFunction, PetscViewerVTKAddField()
64 @*/
PetscViewerVTKGetDM(PetscViewer viewer,PetscObject * dm)65 PetscErrorCode PetscViewerVTKGetDM(PetscViewer viewer,PetscObject *dm)
66 {
67 PetscErrorCode ierr;
68
69 PetscFunctionBegin;
70 PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
71 ierr = PetscUseMethod(viewer,"PetscViewerVTKGetDM_C",(PetscViewer,PetscObject*),(viewer,dm));CHKERRQ(ierr);
72 PetscFunctionReturn(0);
73 }
74
PetscViewerDestroy_VTK(PetscViewer viewer)75 static PetscErrorCode PetscViewerDestroy_VTK(PetscViewer viewer)
76 {
77 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
78 PetscErrorCode ierr;
79
80 PetscFunctionBegin;
81 ierr = PetscFree(vtk->filename);CHKERRQ(ierr);
82 ierr = PetscFree(vtk);CHKERRQ(ierr);
83 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C",NULL);CHKERRQ(ierr);
84 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileGetName_C",NULL);CHKERRQ(ierr);
85 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetMode_C",NULL);CHKERRQ(ierr);
86 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileGetMode_C",NULL);CHKERRQ(ierr);
87 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerVTKAddField_C",NULL);CHKERRQ(ierr);
88 ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerVTKGetDM_C",NULL);CHKERRQ(ierr);
89 PetscFunctionReturn(0);
90 }
91
PetscViewerFlush_VTK(PetscViewer viewer)92 static PetscErrorCode PetscViewerFlush_VTK(PetscViewer viewer)
93 {
94 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
95 PetscErrorCode ierr;
96 PetscViewerVTKObjectLink link,next;
97
98 PetscFunctionBegin;
99 if (vtk->link && (!vtk->dm || !vtk->write)) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_WRONGSTATE,"No fields or no grid");
100 if (vtk->write) {ierr = (*vtk->write)(vtk->dm,viewer);CHKERRQ(ierr);}
101 for (link=vtk->link; link; link=next) {
102 next = link->next;
103 ierr = PetscObjectDestroy(&link->vec);CHKERRQ(ierr);
104 ierr = PetscFree(link);CHKERRQ(ierr);
105 }
106 ierr = PetscObjectDestroy(&vtk->dm);CHKERRQ(ierr);
107 vtk->write = NULL;
108 vtk->link = NULL;
109 PetscFunctionReturn(0);
110 }
111
PetscViewerFileSetName_VTK(PetscViewer viewer,const char name[])112 PetscErrorCode PetscViewerFileSetName_VTK(PetscViewer viewer,const char name[])
113 {
114 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
115 PetscErrorCode ierr;
116 PetscBool isvtk,isvts,isvtu,isvtr;
117 size_t len;
118
119 PetscFunctionBegin;
120 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
121 ierr = PetscFree(vtk->filename);CHKERRQ(ierr);
122 ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
123 if (!len) {
124 isvtk = PETSC_TRUE;
125 } else {
126 ierr = PetscStrcasecmp(name+len-4,".vtk",&isvtk);CHKERRQ(ierr);
127 ierr = PetscStrcasecmp(name+len-4,".vts",&isvts);CHKERRQ(ierr);
128 ierr = PetscStrcasecmp(name+len-4,".vtu",&isvtu);CHKERRQ(ierr);
129 ierr = PetscStrcasecmp(name+len-4,".vtr",&isvtr);CHKERRQ(ierr);
130 }
131 if (isvtk) {
132 if (viewer->format == PETSC_VIEWER_DEFAULT) viewer->format = PETSC_VIEWER_ASCII_VTK_DEPRECATED;
133 if (viewer->format != PETSC_VIEWER_ASCII_VTK_DEPRECATED) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vtk' extension",name,PetscViewerFormats[viewer->format]);
134 } else if (isvts) {
135 if (viewer->format == PETSC_VIEWER_DEFAULT) viewer->format = PETSC_VIEWER_VTK_VTS;
136 if (viewer->format != PETSC_VIEWER_VTK_VTS) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vts' extension",name,PetscViewerFormats[viewer->format]);
137 } else if (isvtu) {
138 if (viewer->format == PETSC_VIEWER_DEFAULT) viewer->format = PETSC_VIEWER_VTK_VTU;
139 if (viewer->format != PETSC_VIEWER_VTK_VTU) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vtu' extension",name,PetscViewerFormats[viewer->format]);
140 } else if (isvtr) {
141 if (viewer->format == PETSC_VIEWER_DEFAULT) viewer->format = PETSC_VIEWER_VTK_VTR;
142 if (viewer->format != PETSC_VIEWER_VTK_VTR) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vtr' extension",name,PetscViewerFormats[viewer->format]);
143 } else SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_UNKNOWN_TYPE,"File '%s' has unrecognized extension",name);
144 ierr = PetscStrallocpy(len ? name : "stdout",&vtk->filename);CHKERRQ(ierr);
145 PetscFunctionReturn(0);
146 }
147
PetscViewerFileGetName_VTK(PetscViewer viewer,const char ** name)148 PetscErrorCode PetscViewerFileGetName_VTK(PetscViewer viewer,const char **name)
149 {
150 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
151 PetscFunctionBegin;
152 *name = vtk->filename;
153 PetscFunctionReturn(0);
154 }
155
PetscViewerFileSetMode_VTK(PetscViewer viewer,PetscFileMode type)156 PetscErrorCode PetscViewerFileSetMode_VTK(PetscViewer viewer,PetscFileMode type)
157 {
158 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
159
160 PetscFunctionBegin;
161 vtk->btype = type;
162 PetscFunctionReturn(0);
163 }
164
PetscViewerFileGetMode_VTK(PetscViewer viewer,PetscFileMode * type)165 PetscErrorCode PetscViewerFileGetMode_VTK(PetscViewer viewer,PetscFileMode *type)
166 {
167 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
168
169 PetscFunctionBegin;
170 *type = vtk->btype;
171 PetscFunctionReturn(0);
172 }
173
PetscViewerVTKAddField_VTK(PetscViewer viewer,PetscObject dm,PetscErrorCode (* PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt fieldnum,PetscViewerVTKFieldType fieldtype,PetscBool checkdm,PetscObject vec)174 PetscErrorCode PetscViewerVTKAddField_VTK(PetscViewer viewer,PetscObject dm,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscInt fieldnum,PetscViewerVTKFieldType fieldtype,PetscBool checkdm,PetscObject vec)
175 {
176 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
177 PetscViewerVTKObjectLink link, tail = vtk->link;
178 PetscErrorCode ierr;
179
180 PetscFunctionBegin;
181 if (vtk->dm) {
182 if (checkdm && dm != vtk->dm) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Refusing to write a field from more than one grid to the same VTK file. Set checkdm = PETSC_FALSE to skip this check.");
183 } else {
184 ierr = PetscObjectReference(dm);CHKERRQ(ierr);
185 vtk->dm = dm;
186 }
187 vtk->write = PetscViewerVTKWriteFunction;
188 ierr = PetscNew(&link);CHKERRQ(ierr);
189 link->ft = fieldtype;
190 link->vec = vec;
191 link->field = fieldnum;
192 link->next = NULL;
193 /* Append to list */
194 if (tail) {
195 while (tail->next) tail = tail->next;
196 tail->next = link;
197 } else vtk->link = link;
198 PetscFunctionReturn(0);
199 }
200
PetscViewerVTKGetDM_VTK(PetscViewer viewer,PetscObject * dm)201 PetscErrorCode PetscViewerVTKGetDM_VTK(PetscViewer viewer,PetscObject *dm)
202 {
203 PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
204
205 PetscFunctionBegin;
206 *dm = vtk->dm;
207 PetscFunctionReturn(0);
208 }
209
210 /*MC
211 PETSCVIEWERVTK - A viewer that writes to a VTK file
212
213
214 .seealso: PetscViewerVTKOpen(), PetscViewerHDF5Open(), PetscViewerStringSPrintf(), PetscViewerSocketOpen(), PetscViewerDrawOpen(), PETSCVIEWERSOCKET,
215 PetscViewerCreate(), PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), PETSCVIEWERBINARY, PETSCVIEWERDRAW, PETSCVIEWERSTRING,
216 PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB,
217 PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType()
218
219 Level: beginner
220 M*/
221
PetscViewerCreate_VTK(PetscViewer v)222 PETSC_EXTERN PetscErrorCode PetscViewerCreate_VTK(PetscViewer v)
223 {
224 PetscViewer_VTK *vtk;
225 PetscErrorCode ierr;
226
227 PetscFunctionBegin;
228 ierr = PetscNewLog(v,&vtk);CHKERRQ(ierr);
229
230 v->data = (void*)vtk;
231 v->ops->destroy = PetscViewerDestroy_VTK;
232 v->ops->flush = PetscViewerFlush_VTK;
233 vtk->btype = (PetscFileMode) -1;
234 vtk->filename = NULL;
235
236 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C",PetscViewerFileSetName_VTK);CHKERRQ(ierr);
237 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C",PetscViewerFileGetName_VTK);CHKERRQ(ierr);
238 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C",PetscViewerFileSetMode_VTK);CHKERRQ(ierr);
239 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetMode_C",PetscViewerFileGetMode_VTK);CHKERRQ(ierr);
240 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerVTKAddField_C",PetscViewerVTKAddField_VTK);CHKERRQ(ierr);
241 ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerVTKGetDM_C",PetscViewerVTKGetDM_VTK);CHKERRQ(ierr);
242 PetscFunctionReturn(0);
243 }
244
245 /*@C
246 PetscViewerVTKOpen - Opens a file for VTK output.
247
248 Collective
249
250 Input Parameters:
251 + comm - MPI communicator
252 . name - name of file
253 - type - type of file
254 $ FILE_MODE_WRITE - create new file for binary output
255 $ FILE_MODE_READ - open existing file for binary input (not currently supported)
256 $ FILE_MODE_APPEND - open existing file for binary output (not currently supported)
257
258 Output Parameter:
259 . vtk - PetscViewer for VTK input/output to use with the specified file
260
261 Level: beginner
262
263 Note:
264 This PetscViewer should be destroyed with PetscViewerDestroy().
265
266
267 .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(),
268 VecView(), MatView(), VecLoad(), MatLoad(),
269 PetscFileMode, PetscViewer
270 @*/
PetscViewerVTKOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer * vtk)271 PetscErrorCode PetscViewerVTKOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer *vtk)
272 {
273 PetscErrorCode ierr;
274
275 PetscFunctionBegin;
276 ierr = PetscViewerCreate(comm,vtk);CHKERRQ(ierr);
277 ierr = PetscViewerSetType(*vtk,PETSCVIEWERVTK);CHKERRQ(ierr);
278 ierr = PetscViewerFileSetMode(*vtk,type);CHKERRQ(ierr);
279 ierr = PetscViewerFileSetName(*vtk,name);CHKERRQ(ierr);
280 PetscFunctionReturn(0);
281 }
282
283 /*@C
284 PetscViewerVTKFWrite - write binary data preceded by 32-bit int length (in bytes), does not do byte swapping.
285
286 Logically collective on PetscViewer
287
288 Input Parameters:
289 + viewer - logically collective viewer, data written from rank 0
290 . fp - file pointer valid on rank 0
291 . data - data pointer valid on rank 0
292 . n - number of data items
293 - dtype - data type
294
295 Level: developer
296
297 Notes:
298 If PetscScalar is __float128 then the binary files are written in double precision
299
300
301 .seealso: DMDAVTKWriteAll(), DMComplexVTKWriteAll(), PetscViewerPushFormat(), PetscViewerVTKOpen(), PetscBinaryWrite()
302 @*/
PetscViewerVTKFWrite(PetscViewer viewer,FILE * fp,const void * data,PetscInt n,MPI_Datatype dtype)303 PetscErrorCode PetscViewerVTKFWrite(PetscViewer viewer,FILE *fp,const void *data,PetscInt n,MPI_Datatype dtype)
304 {
305 PetscErrorCode ierr;
306 PetscMPIInt rank;
307 MPI_Datatype vdtype=dtype;
308 #if defined(PETSC_USE_REAL___FLOAT128)
309 double *tmp;
310 PetscInt i;
311 PetscReal *ttmp = (PetscReal*)data;
312 #endif
313
314 PetscFunctionBegin;
315 if (n < 0) SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
316 if (!n) PetscFunctionReturn(0);
317 ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
318 if (!rank) {
319 size_t count;
320 PetscMPIInt dsize;
321 PetscVTKInt bytes;
322
323 #if defined(PETSC_USE_REAL___FLOAT128)
324 if (dtype == MPIU___FLOAT128) {
325 ierr = PetscMalloc1(n,&tmp);CHKERRQ(ierr);
326 for (i=0; i<n; i++) tmp[i] = ttmp[i];
327 data = (void*) tmp;
328 vdtype = MPI_DOUBLE;
329 }
330 #endif
331 ierr = MPI_Type_size(vdtype,&dsize);CHKERRQ(ierr);
332 bytes = PetscVTKIntCast(dsize*n);
333
334 count = fwrite(&bytes,sizeof(int),1,fp);
335 if (count != 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing byte count");
336 count = fwrite(data,dsize,(size_t)n,fp);
337 if ((PetscInt)count != n) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Wrote %D/%D array members of size %d",(PetscInt)count,n,dsize);
338 #if defined(PETSC_USE_REAL___FLOAT128)
339 if (dtype == MPIU___FLOAT128) {
340 ierr = PetscFree(tmp);CHKERRQ(ierr);
341 }
342 #endif
343 }
344 PetscFunctionReturn(0);
345 }
346