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