xref: /petsc/src/sys/classes/viewer/impls/vtk/vtkv.c (revision 3e1910f1ab6113d8365e15c6b8c907ccce7ce4ea) !
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 #undef __FUNCT__
20 #define __FUNCT__ "PetscViewerVTKAddField"
21 /*@C
22    PetscViewerVTKAddField - Add a field to the viewer
23 
24    Collective
25 
26    Input Arguments:
27 + viewer - VTK viewer
28 . dm - DM on which Vec lives
29 . PetscViewerVTKWriteFunction - function to write this Vec
30 . fieldtype - Either PETSC_VTK_POINT_FIELD or PETSC_VTK_CELL_FIELD
31 - vec - Vec to write
32 
33    Level: developer
34 
35    Note:
36    This routine keeps exclusive ownership of the Vec. The caller should not use or destroy the Vec after adding it.
37 
38 .seealso: PetscViewerVTKOpen(), DMDAVTKWriteAll(), PetscViewerVTKWriteFunction
39 @*/
40 PetscErrorCode PetscViewerVTKAddField(PetscViewer viewer,PetscObject dm,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType fieldtype,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),PetscViewerVTKFieldType,PetscObject),(viewer,dm,PetscViewerVTKWriteFunction,fieldtype,vec));CHKERRQ(ierr);
49   PetscFunctionReturn(0);
50 }
51 
52 #undef __FUNCT__
53 #define __FUNCT__ "PetscViewerDestroy_VTK"
54 static PetscErrorCode PetscViewerDestroy_VTK(PetscViewer viewer)
55 {
56   PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
57   PetscErrorCode  ierr;
58 
59   PetscFunctionBegin;
60   ierr = PetscFree(vtk->filename);CHKERRQ(ierr);
61   ierr = PetscFree(vtk);CHKERRQ(ierr);
62   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C",NULL);CHKERRQ(ierr);
63   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetMode_C",NULL);CHKERRQ(ierr);
64   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerVTKAddField_C",NULL);CHKERRQ(ierr);
65   PetscFunctionReturn(0);
66 }
67 
68 #undef __FUNCT__
69 #define __FUNCT__ "PetscViewerFlush_VTK"
70 static PetscErrorCode PetscViewerFlush_VTK(PetscViewer viewer)
71 {
72   PetscViewer_VTK          *vtk = (PetscViewer_VTK*)viewer->data;
73   PetscErrorCode           ierr;
74   PetscViewerVTKObjectLink link,next;
75 
76   PetscFunctionBegin;
77   if (vtk->link && (!vtk->dm || !vtk->write)) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_WRONGSTATE,"No fields or no grid");
78   if (vtk->write) {ierr = (*vtk->write)(vtk->dm,viewer);CHKERRQ(ierr);}
79   for (link=vtk->link; link; link=next) {
80     next = link->next;
81     ierr = PetscObjectDestroy(&link->vec);CHKERRQ(ierr);
82     ierr = PetscFree(link);CHKERRQ(ierr);
83   }
84   ierr       = PetscObjectDestroy(&vtk->dm);CHKERRQ(ierr);
85   vtk->write = NULL;
86   PetscFunctionReturn(0);
87 }
88 
89 #undef __FUNCT__
90 #define __FUNCT__ "PetscViewerFileSetName_VTK"
91 PetscErrorCode  PetscViewerFileSetName_VTK(PetscViewer viewer,const char name[])
92 {
93   PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
94   PetscErrorCode  ierr;
95   PetscBool       isvtk,isvts,isvtu;
96   size_t          len;
97 
98   PetscFunctionBegin;
99   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
100   ierr = PetscFree(vtk->filename);CHKERRQ(ierr);
101   ierr = PetscStrlen(name,&len);CHKERRQ(ierr);
102   ierr = PetscStrcasecmp(name+len-4,".vtk",&isvtk);CHKERRQ(ierr);
103   ierr = PetscStrcasecmp(name+len-4,".vts",&isvts);CHKERRQ(ierr);
104   ierr = PetscStrcasecmp(name+len-4,".vtu",&isvtu);CHKERRQ(ierr);
105   if (isvtk) {
106     if (viewer->format == PETSC_VIEWER_DEFAULT) {ierr = PetscViewerSetFormat(viewer,PETSC_VIEWER_ASCII_VTK);CHKERRQ(ierr);}
107     if (viewer->format != PETSC_VIEWER_ASCII_VTK) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vtk' extension",name,PetscViewerFormats[viewer->format]);
108   } else if (isvts) {
109     if (viewer->format == PETSC_VIEWER_DEFAULT) {ierr = PetscViewerSetFormat(viewer,PETSC_VIEWER_VTK_VTS);CHKERRQ(ierr);}
110     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]);
111   } else if (isvtu) {
112     if (viewer->format == PETSC_VIEWER_DEFAULT) {ierr = PetscViewerSetFormat(viewer,PETSC_VIEWER_VTK_VTU);CHKERRQ(ierr);}
113     if (viewer->format != PETSC_VIEWER_VTK_VTU) SETERRQ2(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot use file '%s' with format %s, should have '.vts' extension",name,PetscViewerFormats[viewer->format]);
114   } else SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_UNKNOWN_TYPE,"File '%s' has unrecognized extension",name);
115   ierr = PetscStrallocpy(name,&vtk->filename);CHKERRQ(ierr);
116   PetscFunctionReturn(0);
117 }
118 
119 #undef __FUNCT__
120 #define __FUNCT__ "PetscViewerFileSetMode_VTK"
121 PetscErrorCode  PetscViewerFileSetMode_VTK(PetscViewer viewer,PetscFileMode type)
122 {
123   PetscViewer_VTK *vtk = (PetscViewer_VTK*)viewer->data;
124 
125   PetscFunctionBegin;
126   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
127   vtk->btype = type;
128   PetscFunctionReturn(0);
129 }
130 
131 #undef __FUNCT__
132 #define __FUNCT__ "PetscViewerVTKAddField_VTK"
133 PetscErrorCode  PetscViewerVTKAddField_VTK(PetscViewer viewer,PetscObject dm,PetscErrorCode (*PetscViewerVTKWriteFunction)(PetscObject,PetscViewer),PetscViewerVTKFieldType fieldtype,PetscObject vec)
134 {
135   PetscViewer_VTK          *vtk = (PetscViewer_VTK*)viewer->data;
136   PetscViewerVTKObjectLink link, tail = vtk->link;
137   PetscErrorCode           ierr;
138 
139   PetscFunctionBegin;
140   if (vtk->dm) {
141     if (dm != vtk->dm) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_INCOMP,"Cannot write a field from more than one grid to the same VTK file");
142   }
143   vtk->dm    = dm;
144   vtk->write = PetscViewerVTKWriteFunction;
145   ierr       = PetscMalloc(sizeof(struct _n_PetscViewerVTKObjectLink),&link);CHKERRQ(ierr);
146   link->ft   = fieldtype;
147   link->vec  = vec;
148   link->next = NULL;
149   /* Append to list */
150   if (tail) {
151     while (tail->next) tail = tail->next;
152     tail->next = link;
153   } else vtk->link = link;
154   PetscFunctionReturn(0);
155 }
156 
157 #undef __FUNCT__
158 #define __FUNCT__ "PetscViewerCreate_VTK"
159 PETSC_EXTERN PetscErrorCode PetscViewerCreate_VTK(PetscViewer v)
160 {
161   PetscViewer_VTK *vtk;
162   PetscErrorCode  ierr;
163 
164   PetscFunctionBegin;
165   ierr = PetscNewLog(v,PetscViewer_VTK,&vtk);CHKERRQ(ierr);
166 
167   v->data         = (void*)vtk;
168   v->ops->destroy = PetscViewerDestroy_VTK;
169   v->ops->flush   = PetscViewerFlush_VTK;
170   vtk->btype      = (PetscFileMode) -1;
171   vtk->filename   = 0;
172 
173   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C",PetscViewerFileSetName_VTK);CHKERRQ(ierr);
174   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C",PetscViewerFileSetMode_VTK);CHKERRQ(ierr);
175   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerVTKAddField_C",PetscViewerVTKAddField_VTK);CHKERRQ(ierr);
176   PetscFunctionReturn(0);
177 }
178 
179 #undef __FUNCT__
180 #define __FUNCT__ "PetscViewerVTKOpen"
181 /*@C
182    PetscViewerVTKOpen - Opens a file for VTK output.
183 
184    Collective on MPI_Comm
185 
186    Input Parameters:
187 +  comm - MPI communicator
188 .  name - name of file
189 -  type - type of file
190 $    FILE_MODE_WRITE - create new file for binary output
191 $    FILE_MODE_READ - open existing file for binary input (not currently supported)
192 $    FILE_MODE_APPEND - open existing file for binary output (not currently supported)
193 
194    Output Parameter:
195 .  vtk - PetscViewer for VTK input/output to use with the specified file
196 
197    Level: beginner
198 
199    Note:
200    This PetscViewer should be destroyed with PetscViewerDestroy().
201 
202    Concepts: VTK files
203    Concepts: PetscViewer^creating
204 
205 .seealso: PetscViewerASCIIOpen(), PetscViewerSetFormat(), PetscViewerDestroy(),
206           VecView(), MatView(), VecLoad(), MatLoad(),
207           PetscFileMode, PetscViewer
208 @*/
209 PetscErrorCode PetscViewerVTKOpen(MPI_Comm comm,const char name[],PetscFileMode type,PetscViewer *vtk)
210 {
211   PetscErrorCode ierr;
212 
213   PetscFunctionBegin;
214   ierr = PetscViewerCreate(comm,vtk);CHKERRQ(ierr);
215   ierr = PetscViewerSetType(*vtk,PETSCVIEWERVTK);CHKERRQ(ierr);
216   ierr = PetscViewerFileSetMode(*vtk,type);CHKERRQ(ierr);
217   ierr = PetscViewerFileSetName(*vtk,name);CHKERRQ(ierr);
218   PetscFunctionReturn(0);
219 }
220 
221 #undef __FUNCT__
222 #define __FUNCT__ "PetscViewerVTKFWrite"
223 /*@C
224    PetscViewerVTKFWrite - write binary data preceded by 32-bit int length (in bytes), does not do byte swapping.
225 
226    Logically collective on PetscViewer
227 
228    Input Parameters:
229 +  viewer - logically collective viewer, data written from rank 0
230 .  fp - file pointer valid on rank 0
231 .  data - data pointer valid on rank 0
232 .  n - number of data items
233 -  dtype - data type
234 
235    Level: developer
236 
237    Concepts: VTK files
238    Concepts: PetscViewer^creating
239 
240 .seealso: DMDAVTKWriteAll(), DMComplexVTKWriteAll(), PetscViewerSetFormat(), PetscViewerVTKOpen(), PetscBinaryWrite()
241 @*/
242 PetscErrorCode PetscViewerVTKFWrite(PetscViewer viewer,FILE *fp,const void *data,PetscInt n,PetscDataType dtype)
243 {
244   PetscErrorCode ierr;
245   PetscMPIInt    rank;
246 
247   PetscFunctionBegin;
248   if (n < 0) SETERRQ1(PetscObjectComm((PetscObject)viewer),PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
249   if (!n) PetscFunctionReturn(0);
250   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
251   if (!rank) {
252     size_t      count;
253     PetscInt    size;
254     PetscVTKInt bytes;
255     switch (dtype) {
256     case PETSC_DOUBLE:
257       size = sizeof(double);
258       break;
259     case PETSC_FLOAT:
260       size = sizeof(float);
261       break;
262     case PETSC_INT:
263       size = sizeof(PetscInt);
264       break;
265     case PETSC_ENUM:
266       size = sizeof(PetscEnum);
267       break;
268     case PETSC_CHAR:
269       size = sizeof(char);
270       break;
271     default: SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Data type not supported");
272     }
273     bytes = PetscVTKIntCast(size*n);
274 
275     count = fwrite(&bytes,sizeof(int),1,fp);
276     if (count != 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing byte count");
277     count = fwrite(data,size,(size_t)n,fp);
278     if ((PetscInt)count != n) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Wrote %D/%D array members of size %D",(PetscInt)count,n,(PetscInt)size);
279   }
280   PetscFunctionReturn(0);
281 }
282