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