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