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