Actual source code: pname.c

      2: #include <petsc/private/petscimpl.h>
      3: #include <petscviewer.h>

      5: /*@C
      6:    PetscObjectSetName - Sets a string name associated with a PETSc object.

      8:    Not Collective

     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

     16:    Notes:
     17:     If this routine is not called then the object may end up being name by PetscObjectName().
     18:    Level: advanced

     20: .seealso: PetscObjectGetName(), PetscObjectName()
     21: @*/
     22: PetscErrorCode  PetscObjectSetName(PetscObject obj,const char name[])
     23: {

     28:   PetscFree(obj->name);
     29:   PetscStrallocpy(name,&obj->name);
     30:   return(0);
     31: }

     33: /*@C
     34:       PetscObjectPrintClassNamePrefixType - used in the XXXView() methods to display information about the class, name, prefix and type of an object

     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

     40:    Level: developer

     42:    Notes:
     43:     If the viewer format is PETSC_VIEWER_ASCII_MATLAB then the information is printed after a % symbol
     44:           so that MATLAB will treat it as a comment.

     46:           If the viewer format is PETSC_VIEWER_ASCII_VTK*, PETSC_VIEWER_ASCII_LATEX, or
     47:           PETSC_VIEWER_ASCII_MATRIXMARKET then don't print header information
     48:           as these formats can't process it.

     50:    Developer Note: The flag donotPetscObjectPrintClassNamePrefixType is useful to prevent double printing of the information when recursion is used
     51:                    to actually print the object.

     53: .seealso: PetscObjectSetName(), PetscObjectName()

     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;

     65:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&flg);
     66:   if (obj->donotPetscObjectPrintClassNamePrefixType) return(0);
     67:   if (!flg) return(0);

     69:   PetscViewerGetFormat(viewer,&format);
     70:   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) return(0);

     72:   if (format == PETSC_VIEWER_ASCII_MATLAB) {PetscViewerASCIIPrintf(viewer,"%%");}
     73:   PetscViewerASCIIPrintf(viewer,"%s Object:",obj->class_name);
     74:   PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);
     75:   if (obj->name) {
     76:     PetscViewerASCIIPrintf(viewer," %s",obj->name);
     77:   }
     78:   if (obj->prefix) {
     79:     PetscViewerASCIIPrintf(viewer," (%s)",obj->prefix);
     80:   }
     81:   PetscObjectGetComm(obj,&comm);
     82:   MPI_Comm_size(comm,&size);
     83:   PetscViewerASCIIPrintf(viewer," %d MPI processes\n",size);
     84:   PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);
     85:   if (format == PETSC_VIEWER_ASCII_MATLAB) {PetscViewerASCIIPrintf(viewer,"%%");}
     86:   if (obj->type_name) {
     87:     PetscViewerASCIIPrintf(viewer,"  type: %s\n",obj->type_name);
     88:   } else {
     89:     PetscViewerASCIIPrintf(viewer,"  type not yet set\n");
     90:   }
     91:   return(0);
     92: }

     94: /*@C
     95:    PetscObjectName - Gives an object a name if it does not have one

     97:    Collective

     99:    Input Parameters:
    100: .  obj - the Petsc variable
    101:          Thus must be cast with a (PetscObject), for example,
    102:          PetscObjectName((PetscObject)mat,name);

    104:    Level: developer

    106:    Notes:
    107:     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.
    108:           Use PetscObjectSetName() to set the name of an object to what you want. The SAWs viewer requires that no two published objects
    109:           share the same name.

    111:    Developer Note: this needs to generate the exact same string on all ranks that share the object. The current algorithm may not always work.

    115: .seealso: PetscObjectGetName(), PetscObjectSetName()
    116: @*/
    117: PetscErrorCode  PetscObjectName(PetscObject obj)
    118: {
    119:   PetscErrorCode   ierr;
    120:   PetscCommCounter *counter;
    121:   PetscMPIInt      flg;
    122:   char             name[64];

    126:   if (!obj->name) {
    127:     union {MPI_Comm comm; void *ptr; char raw[sizeof(MPI_Comm)]; } ucomm;
    128:     MPI_Comm_get_attr(obj->comm,Petsc_Counter_keyval,(void*)&counter,&flg);
    129:     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Bad MPI communicator supplied; must be a PETSc communicator");
    130:     ucomm.ptr = NULL;
    131:     ucomm.comm = obj->comm;
    132:     MPI_Bcast(ucomm.raw,sizeof(MPI_Comm),MPI_BYTE,0,obj->comm);
    133:     /* If the union has extra bytes, their value is implementation-dependent, but they will normally be what we set last
    134:      * in 'ucomm.ptr = NULL'.  This output is always implementation-defined (and varies from run to run) so the union
    135:      * abuse acceptable. */
    136:     PetscSNPrintf(name,64,"%s_%p_%D",obj->class_name,ucomm.ptr,counter->namecount++);
    137:     PetscStrallocpy(name,&obj->name);
    138:   }
    139:   return(0);
    140: }

    144: PetscErrorCode  PetscObjectChangeTypeName(PetscObject obj,const char type_name[])
    145: {

    150:   PetscFree(obj->type_name);
    151:   PetscStrallocpy(type_name,&obj->type_name);
    152:   /* Clear all the old subtype callbacks so they can't accidentally be called (shouldn't happen anyway) */
    153:   PetscMemzero(obj->fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE],obj->num_fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE]*sizeof(PetscFortranCallback));
    154:   return(0);
    155: }