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