xref: /petsc/src/sys/objects/pgname.c (revision 343722f2ee47ff3e9547109e3441e7d9bd1a75ca)
1e5c89e4eSSatish Balay 
2af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I    "petscsys.h"   I*/
3e5c89e4eSSatish Balay 
4e5c89e4eSSatish Balay /*@C
5e5c89e4eSSatish Balay    PetscObjectGetName - Gets a string name associated with a PETSc object.
6e5c89e4eSSatish Balay 
7199a6bf1SJed Brown    Not Collective unless object has not been named yet
8e5c89e4eSSatish Balay 
9e5c89e4eSSatish Balay    Input Parameters:
10e5c89e4eSSatish Balay +  obj - the Petsc variable
11e5c89e4eSSatish Balay          Thus must be cast with a (PetscObject), for example,
12e5c89e4eSSatish Balay          PetscObjectGetName((PetscObject)mat,&name);
13e5c89e4eSSatish Balay -  name - the name associated with obj
14e5c89e4eSSatish Balay 
15*343722f2SBarry Smith    Notes: Calls PetscObjectName() if a name has not yet been provided to the object.
16*343722f2SBarry Smith 
17e5c89e4eSSatish Balay    Level: intermediate
18e5c89e4eSSatish Balay 
19e5c89e4eSSatish Balay    Concepts: object name
20e5c89e4eSSatish Balay 
21*343722f2SBarry Smith .seealso: PetscObjectSetName(), PetscObjectName()
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