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