xref: /petsc/src/sys/objects/pname.c (revision a3afe2d1ed14aa25e6e8bcdd861505b3816b69e5)
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
43 -     string - for example "Matrix Object"
44 
45    Level: developer
46 
47 .seealso: PetscObjectSetName(), PetscObjectName()
48 
49 @*/
50 PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject obj,PetscViewer viewer,const char string[])
51 {
52   PetscErrorCode ierr;
53   MPI_Comm       comm;
54   PetscMPIInt    size;
55 
56   PetscFunctionBegin;
57   ierr = PetscViewerASCIIPrintf(viewer,"%s:",string);CHKERRQ(ierr);
58   if (obj->name) {
59     ierr = PetscViewerASCIIPrintf(viewer,"%s",obj->name);CHKERRQ(ierr);
60   }
61   if (obj->prefix) {
62     ierr = PetscViewerASCIIPrintf(viewer,"(%s)",obj->prefix);CHKERRQ(ierr);
63   }
64   ierr = PetscObjectGetComm(obj,&comm);CHKERRQ(ierr);
65   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
66   ierr = PetscViewerASCIIPrintf(viewer," %d MPI processes\n",size);CHKERRQ(ierr);
67   if (obj->type_name) {
68     ierr = PetscViewerASCIIPrintf(viewer,"  type: %s\n",obj->type_name);CHKERRQ(ierr);
69   } else {
70     ierr = PetscViewerASCIIPrintf(viewer,"  type not yet set\n");CHKERRQ(ierr);
71   }
72   PetscFunctionReturn(0);
73 }
74 
75 #undef __FUNCT__
76 #define __FUNCT__ "PetscObjectName"
77 /*@C
78    PetscObjectName - Gives an object a name if it does not have one
79 
80    Collective
81 
82    Input Parameters:
83 .  obj - the Petsc variable
84          Thus must be cast with a (PetscObject), for example,
85          PetscObjectName((PetscObject)mat,name);
86 
87    Level: developer
88 
89    Concepts: object name^setting default
90 
91    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.
92           Use PetscObjectSetName() to set the name of an object to what you want. The AMS viewer requires that no two published objects
93           share the same name.
94 
95    Developer Note: this needs to generate the exact same string on all ranks that share the object. The current algorithm may not always work.
96 
97 
98 
99 .seealso: PetscObjectGetName(), PetscObjectSetName()
100 @*/
101 PetscErrorCode  PetscObjectName(PetscObject obj)
102 {
103   PetscErrorCode   ierr;
104   PetscCommCounter *counter;
105   PetscMPIInt      flg;
106   char             name[64];
107 
108   PetscFunctionBegin;
109   PetscValidHeader(obj,1);
110   if (!obj->name) {
111     union {MPI_Comm comm; void *ptr; char raw[sizeof(MPI_Comm)]; } ucomm;
112     ierr = MPI_Attr_get(obj->comm,Petsc_Counter_keyval,(void*)&counter,&flg);CHKERRQ(ierr);
113     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Bad MPI communicator supplied; must be a PETSc communicator");
114     ucomm.ptr = NULL;
115     ucomm.comm = obj->comm;
116     ierr = MPI_Bcast(ucomm.raw,sizeof(MPI_Comm),MPI_BYTE,0,obj->comm);CHKERRQ(ierr);
117     /* If the union has extra bytes, their value is implementation-dependent, but they will normally be what we set last
118      * in 'ucomm.ptr = NULL'.  This output is always implementation-defined (and varies from run to run) so the union
119      * abuse acceptable. */
120     ierr = PetscSNPrintf(name,64,"%s_%p_%D",obj->class_name,ucomm.ptr,counter->namecount++);CHKERRQ(ierr);
121     ierr = PetscStrallocpy(name,&obj->name);CHKERRQ(ierr);
122   }
123   PetscFunctionReturn(0);
124 }
125 
126 
127 
128 #undef __FUNCT__
129 #define __FUNCT__ "PetscObjectChangeTypeName"
130 PetscErrorCode  PetscObjectChangeTypeName(PetscObject obj,const char type_name[])
131 {
132   PetscErrorCode ierr;
133 
134   PetscFunctionBegin;
135   PetscValidHeader(obj,1);
136   ierr = PetscFree(obj->type_name);CHKERRQ(ierr);
137   ierr = PetscStrallocpy(type_name,&obj->type_name);CHKERRQ(ierr);
138   /* Clear all the old subtype callbacks so they can't accidentally be called (shouldn't happen anyway) */
139   ierr = PetscMemzero(obj->fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE],obj->num_fortrancallback[PETSC_FORTRAN_CALLBACK_SUBTYPE]*sizeof(PetscFortranCallback));CHKERRQ(ierr);
140   PetscFunctionReturn(0);
141 }
142 
143