xref: /petsc/src/sys/objects/gcookie.c (revision af0996ce37bc06907c37d8d91773840993d61e62)
17d0a6c19SBarry Smith 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay      Provides utility routines for manulating any type of PETSc object.
4e5c89e4eSSatish Balay */
5*af0996ceSBarry Smith #include <petsc/private/petscimpl.h>  /*I   "petscsys.h"    I*/
6e5c89e4eSSatish Balay 
7e5c89e4eSSatish Balay #undef __FUNCT__
8903b9019SMatthew G Knepley #define __FUNCT__ "PetscObjectGetClassId"
9e5c89e4eSSatish Balay /*@C
10609db0e0SLisandro Dalcin    PetscObjectGetClassId - Gets the classid for any PetscObject
11e5c89e4eSSatish Balay 
12e5c89e4eSSatish Balay    Not Collective
13e5c89e4eSSatish Balay 
14e5c89e4eSSatish Balay    Input Parameter:
15e5c89e4eSSatish Balay .  obj - any PETSc object, for example a Vec, Mat or KSP.
16e5c89e4eSSatish Balay          Thus must be cast with a (PetscObject), for example,
17903b9019SMatthew G Knepley          PetscObjectGetClassId((PetscObject)mat,&classid);
18e5c89e4eSSatish Balay 
19e5c89e4eSSatish Balay    Output Parameter:
200700a824SBarry Smith .  classid - the classid
21e5c89e4eSSatish Balay 
22e5c89e4eSSatish Balay    Level: developer
23e5c89e4eSSatish Balay 
24e5c89e4eSSatish Balay @*/
257087cfbeSBarry Smith PetscErrorCode  PetscObjectGetClassId(PetscObject obj,PetscClassId *classid)
26e5c89e4eSSatish Balay {
27e5c89e4eSSatish Balay   PetscFunctionBegin;
283cfa8680SLisandro Dalcin   PetscValidHeader(obj,1);
290700a824SBarry Smith   *classid = obj->classid;
30e5c89e4eSSatish Balay   PetscFunctionReturn(0);
31e5c89e4eSSatish Balay }
32e5c89e4eSSatish Balay 
33609db0e0SLisandro Dalcin #undef __FUNCT__
34609db0e0SLisandro Dalcin #define __FUNCT__ "PetscObjectGetClassName"
35609db0e0SLisandro Dalcin /*@C
36609db0e0SLisandro Dalcin    PetscObjectGetClassName - Gets the class name for any PetscObject
37609db0e0SLisandro Dalcin 
38609db0e0SLisandro Dalcin    Not Collective
39609db0e0SLisandro Dalcin 
40609db0e0SLisandro Dalcin    Input Parameter:
41609db0e0SLisandro Dalcin .  obj - any PETSc object, for example a Vec, Mat or KSP.
42609db0e0SLisandro Dalcin          Thus must be cast with a (PetscObject), for example,
43609db0e0SLisandro Dalcin          PetscObjectGetClassName((PetscObject)mat,&classname);
44609db0e0SLisandro Dalcin 
45609db0e0SLisandro Dalcin    Output Parameter:
46609db0e0SLisandro Dalcin .  classname - the class name
47609db0e0SLisandro Dalcin 
48609db0e0SLisandro Dalcin    Level: developer
49609db0e0SLisandro Dalcin 
50609db0e0SLisandro Dalcin @*/
51609db0e0SLisandro Dalcin PetscErrorCode  PetscObjectGetClassName(PetscObject obj, const char *classname[])
52609db0e0SLisandro Dalcin {
53609db0e0SLisandro Dalcin   PetscFunctionBegin;
54609db0e0SLisandro Dalcin   PetscValidHeader(obj,1);
55609db0e0SLisandro Dalcin   PetscValidPointer(classname,2);
56609db0e0SLisandro Dalcin   *classname = obj->class_name;
57609db0e0SLisandro Dalcin   PetscFunctionReturn(0);
58609db0e0SLisandro Dalcin }
59