File: ISRegisterDynamic.html

package info (click to toggle)
petsc 3.2.dfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 124,660 kB
  • sloc: ansic: 342,250; cpp: 62,975; python: 32,761; fortran: 17,337; makefile: 15,867; xml: 621; objc: 594; sh: 492; java: 381; f90: 347; csh: 245
file content (65 lines) | stat: -rw-r--r-- 3,126 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISRegisterDynamic</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="ISRegisterDynamic"><H1>ISRegisterDynamic</H1></A>
Adds a new vector component implementation 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscErrorCode ISRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(IS))
</PRE>
Not Collective
<P>
<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>name        </B></TD><TD>- The name of a new user-defined creation routine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>path        </B></TD><TD>- The path (either absolute or relative) of the library containing this routine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func_name   </B></TD><TD>- The name of routine to create method context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>create_func </B></TD><TD>- The creation routine itself
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../IS/ISRegisterDynamic.html#ISRegisterDynamic">ISRegisterDynamic</A>() may be called multiple times to add several user-defined vectors
<P>
If dynamic libraries are used, then the fourth input argument (routine_create) is ignored.
<P>
<H3><FONT COLOR="#CC3333">Sample usage</FONT></H3>
<PRE>
    <A HREF="../IS/ISRegisterDynamic.html#ISRegisterDynamic">ISRegisterDynamic</A>("my_is","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyIStorCreate", MyIStorCreate);
</PRE>

<P>
Then, your vector type can be chosen with the procedural interface via
<PRE>
    <A HREF="../IS/ISCreate.html#ISCreate">ISCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>, <A HREF="../IS/IS.html#IS">IS</A> *);
    <A HREF="../IS/ISSetType.html#ISSetType">ISSetType</A>(<A HREF="../IS/IS.html#IS">IS</A>,"my_vector_name");
</PRE>

or at runtime via the option
<PRE>
    -vec_type my_vector_name
</PRE>

<P>
Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
If your function is not being put into a shared library then use <A HREF="../IS/ISRegister.html#ISRegister">ISRegister</A>() instead
<P>

<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 <A HREF="../IS/IS.html#IS">IS</A>, register
<BR>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../IS/ISRegisterAll.html#ISRegisterAll">ISRegisterAll</A>(), <A HREF="../IS/ISRegisterDestroy.html#ISRegisterDestroy">ISRegisterDestroy</A>(), <A HREF="../IS/ISRegister.html#ISRegister">ISRegister</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/is/../../../include/petscis.h.html#ISRegisterDynamic">src/vec/is/../../../include/petscis.h</A>
<BR><A HREF="./index.html">Index of all IS 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>