xref: /petsc/src/sys/objects/pname.c (revision 074cc835faa3d6c800494dd2ea2bd8f95d70c354)
1 
2 #include <petscsys.h>        /*I    "petscsys.h"   I*/
3 
4 #undef __FUNCT__
5 #define __FUNCT__ "PetscObjectSetName"
6 /*@C
7    PetscObjectSetName - Sets a string name associated with a PETSc object.
8 
9    Not Collective
10 
11    Input Parameters:
12 +  obj - the Petsc variable
13          Thus must be cast with a (PetscObject), for example,
14          PetscObjectSetName((PetscObject)mat,name);
15 -  name - the name to give obj
16 
17    Level: advanced
18 
19    Concepts: object name^setting
20 
21 .seealso: PetscObjectGetName()
22 @*/
23 PetscErrorCode  PetscObjectSetName(PetscObject obj,const char name[])
24 {
25   PetscErrorCode ierr;
26 
27   PetscFunctionBegin;
28   PetscValidHeader(obj,1);
29   ierr = PetscFree(obj->name);CHKERRQ(ierr);
30   ierr = PetscStrallocpy(name,&obj->name);CHKERRQ(ierr);
31   PetscFunctionReturn(0);
32 }
33 
34 #undef __FUNCT__
35 #define __FUNCT__ "PetscObjectPrintClassNamePrefixType"
36 /*@C
37       PetscObjectPrintTypeNamePrefix - used in the XXXView() methods to display information about the class, name, prefix and type of an object
38 
39    Input Parameters:
40 +     obj - the PETSc object
41 .     viewer - ASCII viewer where the information is printed
42 -     string - for example "Matrix Object"
43 
44    Level: developer
45 
46 .seealso: PetscObjectSetName(), PetscObjectName()
47 
48 @*/
49 PetscErrorCode PetscObjectPrintClassNamePrefixType(PetscObject obj,PetscViewer viewer,const char string[])
50 {
51   PetscErrorCode ierr;
52   MPI_Comm       comm;
53   PetscMPIInt    size;
54 
55   PetscFunctionBegin;
56   ierr = PetscViewerASCIIPrintf(viewer,"%s:",string);CHKERRQ(ierr);
57   if (obj->name) {
58     ierr = PetscViewerASCIIPrintf(viewer,"%s",obj->name);CHKERRQ(ierr);
59   }
60   if (obj->prefix) {
61     ierr = PetscViewerASCIIPrintf(viewer,"(%s)",obj->prefix);CHKERRQ(ierr);
62   }
63   ierr = PetscObjectGetComm(obj,&comm);CHKERRQ(ierr);
64   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
65   ierr = PetscViewerASCIIPrintf(viewer," %d MPI processes",size);CHKERRQ(ierr);
66   ierr = PetscViewerASCIIPrintf(viewer,"\n");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    Not 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     void *commp = 0;
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     ierr = PetscMemcpy(&commp,&obj->comm,PetscMin(sizeof(commp),sizeof(obj->comm)));CHKERRQ(ierr);
115     ierr = MPI_Bcast(&commp,1,MPIU_SIZE_T,0,obj->comm);CHKERRQ(ierr);
116     ierr = PetscSNPrintf(name,64,"%s_%p_%D",obj->class_name,commp,counter->namecount++);CHKERRQ(ierr);
117     ierr = PetscStrallocpy(name,&obj->name);CHKERRQ(ierr);
118   }
119   PetscFunctionReturn(0);
120 }
121 
122 
123 
124 #undef __FUNCT__
125 #define __FUNCT__ "PetscObjectChangeTypeName"
126 PetscErrorCode  PetscObjectChangeTypeName(PetscObject obj,const char type_name[])
127 {
128   PetscErrorCode ierr;
129 
130   PetscFunctionBegin;
131   PetscValidHeader(obj,1);
132   ierr = PetscObjectTakeAccess(obj);CHKERRQ(ierr);
133   ierr = PetscFree(obj->type_name);CHKERRQ(ierr);
134   ierr = PetscStrallocpy(type_name,&obj->type_name);CHKERRQ(ierr);
135   ierr = PetscObjectGrantAccess(obj);CHKERRQ(ierr);
136   PetscFunctionReturn(0);
137 }
138 
139