petsc-3.5.1 2014-08-06
Report Typos and Errors

PetscObjectCompose

Associates another PETSc object with a given PETSc object.

Synopsis

#include "petscsys.h"    
PetscErrorCode  PetscObjectCompose(PetscObject obj,const char name[],PetscObject ptr)
Not Collective

Input Parameters

obj - the PETSc object; this must be cast with (PetscObject), for example, PetscObjectCompose((PetscObject)mat,...);
name - name associated with the child object
ptr - the other PETSc object to associate with the PETSc object; this must also be cast with (PetscObject)

Notes

The second objects reference count is automatically increased by one when it is composed.

Replaces any previous object that had the same name.

If ptr is null and name has previously been composed using an object, then that entry is removed from the obj.

PetscObjectCompose() can be used with any PETSc object (such as Mat, Vec, KSP, SNES, etc.) or any user-provided object. See PetscContainerCreate() for info on how to create an object from a user-provided pointer that may then be composed with PETSc objects.

See Also

PetscObjectQuery(), PetscContainerCreate()

Level:advanced
Location:
src/sys/objects/inherit.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages

Examples

src/snes/examples/tutorials/ex12.c.html
src/snes/examples/tutorials/ex48.c.html
src/snes/examples/tutorials/ex62.c.html