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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscMapRegisterDynamic</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="PetscMapRegisterDynamic"><H1>PetscMapRegisterDynamic</H1></A>
Adds a new map component implementation
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscMapRegisterDynamic(char *name, char *path, char *func_name, int (*create_func)(PetscMap))
</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>
PetscMapRegister() may be called multiple times to add several user-defined maptors
<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="../Vec/PetscMapRegisterDynamic.html#PetscMapRegisterDynamic">PetscMapRegisterDynamic</A>("my_map","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyPetscMapCreate", MyPetscMapCreate);
</PRE>
<P>
Then, your map type can be chosen with the procedural interface via
<PRE>
<A HREF="../Vec/PetscMapCreate.html#PetscMapCreate">PetscMapCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>, <A HREF="../Vec/PetscMap.html#PetscMap">PetscMap</A> *);
<A HREF="../Vec/PetscMapSetType.html#PetscMapSetType">PetscMapSetType</A>(<A HREF="../Vec/PetscMap.html#PetscMap">PetscMap</A>,"my_map_name");
</PRE>
or at runtime via the option
<PRE>
-map_type my_map_name
</PRE>
<P>
Note: $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../Vec/PetscMap.html#PetscMap">PetscMap</A>, register
<BR>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/PetscMapRegisterAll.html#PetscMapRegisterAll">PetscMapRegisterAll</A>(), <A HREF="../Vec/PetscMapRegisterDestroy.html#PetscMapRegisterDestroy">PetscMapRegisterDestroy</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/interface/mapreg.c.html#PetscMapRegisterDynamic">src/vec/interface/mapreg.c</A>
<BR><A HREF="./index.html">Index of all Vec 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>
|
