1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscHeaderCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscHeaderCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/Sys/PetscHeaderCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscHeaderCreate"><H1>PetscHeaderCreate</H1></A>
Creates a PETSc object of a particular class
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#define <A HREF="../Sys/PetscHeaderCreate.html#PetscHeaderCreate">PetscHeaderCreate</A>(h,classid,class_name,descr,mansec,comm,destroy,view) \
(<A HREF="../Sys/PetscNew.html#PetscNew">PetscNew</A>(&(h)) || \
PetscHeaderCreate_Private((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)(h),classid,class_name,descr,mansec,comm,(PetscObjectDestroyFunction)(destroy),(PetscObjectViewFunction)(view)) || \
PetscLogObjectCreate(h) || \
<A HREF="../Profiling/PetscLogObjectMemory.html#PetscLogObjectMemory">PetscLogObjectMemory</A>((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)(h),sizeof(*(h))))
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscComposedQuantitiesDestroy(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> obj);
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscHeaderCreate_Private(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>,<A HREF="../Sys/PetscClassId.html#PetscClassId">PetscClassId</A>,const char[],const char[],const char[],<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>,PetscObjectDestroyFunction,PetscObjectViewFunction);
/*@C
<A HREF="../Sys/PetscHeaderDestroy.html#PetscHeaderDestroy">PetscHeaderDestroy</A> - Final step in destroying a <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>
Input Parameters:
. h - the header created with <A HREF="../Sys/PetscHeaderCreate.html#PetscHeaderCreate">PetscHeaderCreate</A>()
.seealso: <A HREF="../Sys/PetscHeaderCreate.html#PetscHeaderCreate">PetscHeaderCreate</A>()
@*/
#define <A HREF="../Sys/PetscHeaderDestroy.html#PetscHeaderDestroy">PetscHeaderDestroy</A>(h) (PetscHeaderDestroy_Private((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)(*(h))) || <A HREF="../Sys/PetscFree.html#PetscFree">PetscFree</A>(*(h)))
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscHeaderDestroy_Private(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>);
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscObjectCopyFortranFunctionPointers.html#PetscObjectCopyFortranFunctionPointers">PetscObjectCopyFortranFunctionPointers</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>,<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>);
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscObjectSetFortranCallback.html#PetscObjectSetFortranCallback">PetscObjectSetFortranCallback</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>,PetscFortranCallbackType,PetscFortranCallbackId*,void(*)(void),void *ctx);
PETSC_EXTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscObjectGetFortranCallback.html#PetscObjectGetFortranCallback">PetscObjectGetFortranCallback</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>,PetscFortranCallbackType,PetscFortranCallbackId,void(**)(void),void **ctx);
PETSC_INTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscCitationsInitialize(void);
PETSC_INTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscFreeMPIResources(void);
PETSC_INTERN <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscOptionsHasHelpIntro_Internal(PetscOptions,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A>*);
PETSC_EXTERN <A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> <A HREF="../Sys/PetscCheckPointer.html#PetscCheckPointer">PetscCheckPointer</A>(const void*,<A HREF="../Sys/PetscDataType.html#PetscDataType">PetscDataType</A>);
/*
Macros to test if a PETSc object is valid and if pointers are valid
*/
#if !defined(PETSC_USE_DEBUG)
#define PetscValidHeaderSpecific(h,ck,arg) do
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>classid </B></TD><TD>- the classid associated with this object (for example VEC_CLASSID)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>class_name </B></TD><TD>- string name of class; should be static (for example "<A HREF="../Vec/Vec.html#Vec">Vec</A>")
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>descr </B></TD><TD>- string containing short description; should be static (for example "Vector")
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mansec </B></TD><TD>- string indicating section in manual pages; should be static (for example "<A HREF="../Vec/Vec.html#Vec">Vec</A>")
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- the MPI Communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>destroy </B></TD><TD>- the destroy routine for this object (for example <A HREF="../Vec/VecDestroy.html#VecDestroy">VecDestroy</A>())
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>view </B></TD><TD>- the view routine for this object (for example <A HREF="../Vec/VecView.html#VecView">VecView</A>())
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>h </B></TD><TD>- the newly created object
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/PetscHeaderDestroy.html#PetscHeaderDestroy">PetscHeaderDestroy</A>(), <A HREF="../Profiling/PetscClassIdRegister.html#PetscClassIdRegister">PetscClassIdRegister</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../include/petsc/private/petscimpl.h.html#PetscHeaderCreate">include/petsc/private/petscimpl.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex48.c.html">src/snes/tutorials/ex48.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex14.c.html">src/ts/tutorials/ex14.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
