xref: /petsc/src/sys/objects/pgname.c (revision 7709abecfd3447e77490ede6f39dca2c8cc9a3fb)
1e5c89e4eSSatish Balay #define PETSC_DLL
2e5c89e4eSSatish Balay 
3d382aafbSBarry Smith #include "petscsys.h"        /*I    "petscsys.h"   I*/
4e5c89e4eSSatish Balay 
5e5c89e4eSSatish Balay #undef __FUNCT__
6e5c89e4eSSatish Balay #define __FUNCT__ "PetscObjectGetName"
7e5c89e4eSSatish Balay /*@C
8e5c89e4eSSatish Balay    PetscObjectGetName - Gets a string name associated with a PETSc object.
9e5c89e4eSSatish Balay 
10e5c89e4eSSatish Balay    Not Collective
11e5c89e4eSSatish Balay 
12e5c89e4eSSatish Balay    Input Parameters:
13e5c89e4eSSatish Balay +  obj - the Petsc variable
14e5c89e4eSSatish Balay          Thus must be cast with a (PetscObject), for example,
15e5c89e4eSSatish Balay          PetscObjectGetName((PetscObject)mat,&name);
16e5c89e4eSSatish Balay -  name - the name associated with obj
17e5c89e4eSSatish Balay 
18e5c89e4eSSatish Balay    Level: intermediate
19e5c89e4eSSatish Balay 
20e5c89e4eSSatish Balay    Concepts: object name
21e5c89e4eSSatish Balay 
22e5c89e4eSSatish Balay .seealso: PetscObjectSetName()
23e5c89e4eSSatish Balay @*/
248738c821SJed Brown PetscErrorCode PETSCSYS_DLLEXPORT PetscObjectGetName(PetscObject obj,const char *name[])
25e5c89e4eSSatish Balay {
26e5c89e4eSSatish Balay   PetscErrorCode ierr;
27e5c89e4eSSatish Balay 
28e5c89e4eSSatish Balay   PetscFunctionBegin;
293cfa8680SLisandro Dalcin   PetscValidHeader(obj,1);
303cfa8680SLisandro Dalcin   PetscValidPointer(name,2);
31*7709abecSJed Brown   ierr = PetscObjectName(obj);CHKERRQ(ierr);
32e5c89e4eSSatish Balay   *name = obj->name;
33e5c89e4eSSatish Balay   PetscFunctionReturn(0);
34e5c89e4eSSatish Balay }
35e5c89e4eSSatish Balay 
36