1 2 #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/ 3 #include <petscviewer.h> 4 5 /*@C 6 PetscObjectSetName - Sets a string name associated with a PETSc object. 7 8 Not Collective 9 10 Input Parameters: 11 + obj - the Petsc variable 12 Thus must be cast with a (PetscObject), for example, 13 PetscObjectSetName((PetscObject)mat,name); 14 - name - the name to give obj 15 16 Level: advanced 17 18 Concepts: object name^setting 19 20 .seealso: PetscObjectGetName() 21 @*/ 22 PetscErrorCode PetscObjectSetName(PetscObject obj,const char name[]) 23 { 24 PetscErrorCode ierr; 25 26 PetscFunctionBegin; 27 PetscValidHeader(obj,1); 28 ierr = PetscFree(obj->name);CHKERRQ(ierr); 29 ierr = PetscStrallocpy(name,&obj->name);CHKERRQ(ierr); 30 PetscFunctionReturn(0); 31 } 32 33 /*@C 34 PetscObjectPrintTypeNamePrefix - used in the XXXView() methods to display information about the class, name, prefix and type of an object 35 36 Input Parameters: 37 + obj - the PETSc object 38 - viewer - ASCII viewer where the information is printed, function does nothing if the viewer is not PETSCVIEWERASCII type 39 40 Level: developer 41 42 Notes: If the viewer format is PETSC_VIEWER_ASCII_MATLAB then the information is printed after a % symbol 43 so that MATLAB will treat it as a comment. 44 45 If the viewer format is PETSC_VIEWER_ASCII_VTK*, PETSC_VIEWER_ASCII_LATEX, or 46 PETSC_VIEWER_ASCII_MATRIXMARKET then don't print header information 47 as these formats can't process it. 48 49 .seealso: PetscObjectSetName(), PetscObjectName() 50 51 @*/ 52 PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject obj,PetscViewer viewer) 53 { 54 PetscErrorCode ierr; 55 MPI_Comm comm; 56 PetscMPIInt size; 57 PetscViewerFormat format; 58 PetscBool flg; 59 60 PetscFunctionBegin; 61 ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr); 62 if (!flg) PetscFunctionReturn(0); 63 64 ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 65 if (format == PETSC_VIEWER_ASCII_VTK || format == PETSC_VIEWER_ASCII_VTK_CELL || format == PETSC_VIEWER_ASCII_VTK_COORDS || format == PETSC_VIEWER_ASCII_MATRIXMARKET || format == PETSC_VIEWER_ASCII_LATEX) PetscFunctionReturn(0); 66 67 if (format == PETSC_VIEWER_ASCII_MATLAB) {ierr = PetscViewerASCIIPrintf(viewer,"%%");CHKERRQ(ierr);} 68 ierr = PetscViewerASCIIPrintf(viewer,"%s Object:",obj->class_name);CHKERRQ(ierr); 69 ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr); 70 if (obj->name) { 71 ierr = PetscViewerASCIIPrintf(viewer," %s",obj->name);CHKERRQ(ierr); 72 } 73 if (obj->prefix) { 74 ierr = PetscViewerASCIIPrintf(viewer," (%s)",obj->prefix);CHKERRQ(ierr); 75 } 76 ierr = PetscObjectGetComm(obj,&comm);CHKERRQ(ierr); 77 ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 78 ierr = PetscViewerASCIIPrintf(viewer," %d MPI processes\n",size);CHKERRQ(ierr); 79 ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr); 80 if (format == PETSC_VIEWER_ASCII_MATLAB) {ierr = PetscViewerASCIIPrintf(viewer,"%%");CHKERRQ(ierr);} 81 if (obj->type_name) { 82 ierr = PetscViewerASCIIPrintf(viewer," type: %s\n",obj->type_name);CHKERRQ(ierr); 83 } else { 84 ierr = PetscViewerASCIIPrintf(viewer," type not yet set\n");CHKERRQ(ierr); 85 } 86 PetscFunctionReturn(0); 87 } 88 89 /*@C 90 PetscObjectName - Gives an object a name if it does not have one 91 92 Collective 93 94 Input Parameters: 95 . obj - the Petsc variable 96 Thus must be cast with a (PetscObject), for example, 97 PetscObjectName((PetscObject)mat,name); 98 99 Level: developer 100 101 Concepts: object name^setting default 102 103 Notes: This is used in a small number of places when an object NEEDS a name, for example when it is saved to MATLAB with that variable name. 104 Use PetscObjectSetName() to set the name of an object to what you want. The SAWs viewer requires that no two published objects 105 share the same name. 106 107 Developer Note: this needs to generate the exact same string on all ranks that share the object. The current algorithm may not always work. 108 109 110 111 .seealso: PetscObjectGetName(), PetscObjectSetName() 112 @*/ 113 PetscErrorCode PetscObjectName(PetscObject obj) 114 { 115 PetscErrorCode ierr; 116 PetscCommCounter *counter; 117 PetscMPIInt flg; 118 char name[64]; 119 120 PetscFunctionBegin; 121 PetscValidHeader(obj,1); 122 if (!obj->name) { 123 union {MPI_Comm comm; void *ptr; char raw[sizeof(MPI_Comm)]; } ucomm; 124 ierr = MPI_Attr_get(obj->comm,Petsc_Counter_keyval,(void*)&counter,&flg);CHKERRQ(ierr); 125 if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Bad MPI communicator supplied; must be a PETSc communicator"); 126 ucomm.ptr = NULL; 127 ucomm.comm = obj->comm; 128 ierr = MPI_Bcast(ucomm.raw,sizeof(MPI_Comm),MPI_BYTE,0,obj->comm);CHKERRQ(ierr); 129 /* If the union has extra bytes, their value is implementation-dependent, but they will normally be what we set last 130 * in 'ucomm.ptr = NULL'. This output is always implementation-defined (and varies from run to run) so the union 131 * abuse acceptable. */ 132 ierr = PetscSNPrintf(name,64,"%s_%p_%D",obj->class_name,ucomm.ptr,counter->namecount++);CHKERRQ(ierr); 133 ierr = PetscStrallocpy(name,&obj->name);CHKERRQ(ierr); 134 } 135 PetscFunctionReturn(0); 136 } 137 138 139 140 PetscErrorCode PetscObjectChangeTypeName(PetscObject obj,const char type_name[]) 141 { 142 PetscErrorCode ierr; 143 144 PetscFunctionBegin; 145 PetscValidHeader(obj,1); 146 ierr = PetscFree(obj->type_name);CHKERRQ(ierr); 147 ierr = PetscStrallocpy(type_name,&obj->type_name);CHKERRQ(ierr); 148 /* Clear all the old subtype callbacks so they can't accidentally be called (shouldn't happen anyway) */ 149 ierr = PetscMemzero(obj->fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE],obj->num_fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE]*sizeof(PetscFortranCallback));CHKERRQ(ierr); 150 PetscFunctionReturn(0); 151 } 152 153