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 Notes: 17 If this routine is not called then the object may end up being name by PetscObjectName(). 18 Level: advanced 19 20 .seealso: `PetscObjectGetName()`, `PetscObjectName()` 21 @*/ 22 PetscErrorCode PetscObjectSetName(PetscObject obj,const char name[]) 23 { 24 PetscFunctionBegin; 25 PetscValidHeader(obj,1); 26 PetscCall(PetscFree(obj->name)); 27 PetscCall(PetscStrallocpy(name,&obj->name)); 28 PetscFunctionReturn(0); 29 } 30 31 /*@C 32 PetscObjectPrintClassNamePrefixType - used in the XXXView() methods to display information about the class, name, prefix and type of an object 33 34 Input Parameters: 35 + obj - the PETSc object 36 - viewer - ASCII viewer where the information is printed, function does nothing if the viewer is not PETSCVIEWERASCII type 37 38 Level: developer 39 40 Notes: 41 If the viewer format is PETSC_VIEWER_ASCII_MATLAB then the information is printed after a % symbol 42 so that MATLAB will treat it as a comment. 43 44 If the viewer format is PETSC_VIEWER_ASCII_VTK*, PETSC_VIEWER_ASCII_LATEX, or 45 PETSC_VIEWER_ASCII_MATRIXMARKET then don't print header information 46 as these formats can't process it. 47 48 Developer Note: The flag donotPetscObjectPrintClassNamePrefixType is useful to prevent double printing of the information when recursion is used 49 to actually print the object. 50 51 .seealso: `PetscObjectSetName()`, `PetscObjectName()` 52 53 @*/ 54 PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject obj,PetscViewer viewer) 55 { 56 PetscMPIInt size; 57 PetscViewerFormat format; 58 PetscBool flg; 59 60 PetscFunctionBegin; 61 PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&flg)); 62 if (obj->donotPetscObjectPrintClassNamePrefixType) PetscFunctionReturn(0); 63 if (!flg) PetscFunctionReturn(0); 64 65 PetscCall(PetscViewerGetFormat(viewer,&format)); 66 if (format == PETSC_VIEWER_ASCII_VTK_DEPRECATED || format == PETSC_VIEWER_ASCII_VTK_CELL_DEPRECATED || format == PETSC_VIEWER_ASCII_VTK_COORDS_DEPRECATED || format == PETSC_VIEWER_ASCII_MATRIXMARKET || format == PETSC_VIEWER_ASCII_LATEX || format == PETSC_VIEWER_ASCII_GLVIS) PetscFunctionReturn(0); 67 68 if (format == PETSC_VIEWER_ASCII_MATLAB) PetscCall(PetscViewerASCIIPrintf(viewer,"%%")); 69 PetscCallMPI(MPI_Comm_size(PetscObjectComm(obj),&size)); 70 PetscCall(PetscViewerASCIIPrintf(viewer,"%s Object:%s%s%s%s%s %d MPI process%s\n",obj->class_name,obj->name?" ":"",obj->name?obj->name:"",obj->prefix?" (":"",obj->prefix?obj->prefix:"",obj->prefix?")":"",size,size>1?"es":"")); 71 if (format == PETSC_VIEWER_ASCII_MATLAB) PetscCall(PetscViewerASCIIPrintf(viewer,"%%")); 72 if (obj->type_name) { 73 PetscCall(PetscViewerASCIIPrintf(viewer," type: %s\n",obj->type_name)); 74 } else { 75 PetscCall(PetscViewerASCIIPrintf(viewer," type not yet set\n")); 76 } 77 PetscFunctionReturn(0); 78 } 79 80 /*@C 81 PetscObjectName - Gives an object a name if it does not have one 82 83 Collective 84 85 Input Parameters: 86 . obj - the Petsc variable 87 Thus must be cast with a (PetscObject), for example, 88 PetscObjectName((PetscObject)mat,name); 89 90 Level: developer 91 92 Notes: 93 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. 94 Use PetscObjectSetName() to set the name of an object to what you want. The SAWs viewer requires that no two published objects 95 share the same name. 96 97 Developer Note: this needs to generate the exact same string on all ranks that share the object. The current algorithm may not always work. 98 99 .seealso: `PetscObjectGetName()`, `PetscObjectSetName()` 100 @*/ 101 PetscErrorCode PetscObjectName(PetscObject obj) 102 { 103 PetscCommCounter *counter; 104 PetscMPIInt flg; 105 char name[64]; 106 107 PetscFunctionBegin; 108 PetscValidHeader(obj,1); 109 if (!obj->name) { 110 union {MPI_Comm comm; void *ptr; char raw[sizeof(MPI_Comm)]; } ucomm; 111 PetscCallMPI(MPI_Comm_get_attr(obj->comm,Petsc_Counter_keyval,(void*)&counter,&flg)); 112 PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Bad MPI communicator supplied; must be a PETSc communicator"); 113 ucomm.ptr = NULL; 114 ucomm.comm = obj->comm; 115 PetscCallMPI(MPI_Bcast(ucomm.raw,sizeof(MPI_Comm),MPI_BYTE,0,obj->comm)); 116 /* If the union has extra bytes, their value is implementation-dependent, but they will normally be what we set last 117 * in 'ucomm.ptr = NULL'. This output is always implementation-defined (and varies from run to run) so the union 118 * abuse acceptable. */ 119 PetscCall(PetscSNPrintf(name,64,"%s_%p_%" PetscInt_FMT,obj->class_name,ucomm.ptr,counter->namecount++)); 120 PetscCall(PetscStrallocpy(name,&obj->name)); 121 } 122 PetscFunctionReturn(0); 123 } 124 125 PetscErrorCode PetscObjectChangeTypeName(PetscObject obj,const char type_name[]) 126 { 127 PetscFunctionBegin; 128 PetscValidHeader(obj,1); 129 PetscCall(PetscFree(obj->type_name)); 130 PetscCall(PetscStrallocpy(type_name,&obj->type_name)); 131 /* Clear all the old subtype callbacks so they can't accidentally be called (shouldn't happen anyway) */ 132 PetscCall(PetscMemzero(obj->fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE],obj->num_fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE]*sizeof(PetscFortranCallback))); 133 PetscFunctionReturn(0); 134 } 135