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
|
<!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/PetscRandomRegister.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscRandomRegister</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/Sys/PetscRandomRegister.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscRandomRegister"><H1>PetscRandomRegister</H1></A>
Adds a new <A HREF="../Sys/PetscRandom.html#PetscRandom">PetscRandom</A> component implementation
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
PetscErrorCode PetscRandomRegister(const char sname[], PetscErrorCode (*function)(PetscRandom))
</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>create_func </B></TD><TD>- The creation routine itself
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../Sys/PetscRandomRegister.html#PetscRandomRegister">PetscRandomRegister</A>() may be called multiple times to add several user-defined randome number generators
<P>
<H3><FONT COLOR="#CC3333">Sample usage</FONT></H3>
<PRE>
<A HREF="../Sys/PetscRandomRegister.html#PetscRandomRegister">PetscRandomRegister</A>("my_rand", MyPetscRandomtorCreate);
</PRE>
<P>
Then, your random type can be chosen with the procedural interface via
<PRE>
<A HREF="../Sys/PetscRandomCreate.html#PetscRandomCreate">PetscRandomCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>, <A HREF="../Sys/PetscRandom.html#PetscRandom">PetscRandom</A> *);
<A HREF="../Sys/PetscRandomSetType.html#PetscRandomSetType">PetscRandomSetType</A>(<A HREF="../Sys/PetscRandom.html#PetscRandom">PetscRandom</A>,"my_random_name");
</PRE>
or at runtime via the option
<PRE>
-random_type my_random_name
</PRE>
<P>
Notes: For an example of the code needed to interface your own random number generator see
src/sys/random/impls/rand/rand.c
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../Sys/PetscRandom.html#PetscRandom">PetscRandom</A>, register
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/PetscRandomRegisterAll.html#PetscRandomRegisterAll">PetscRandomRegisterAll</A>(), PetscRandomRegisterDestroy(), <A HREF="../Sys/PetscRandomRegister.html#PetscRandomRegister">PetscRandomRegister</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/classes/random/interface/randreg.c.html#PetscRandomRegister">src/sys/classes/random/interface/randreg.c</A>
<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>
|
