File: NEPRegister.html

package info (click to toggle)
slepc 3.7.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,788 kB
  • ctags: 100,221
  • sloc: ansic: 79,324; makefile: 3,897; python: 2,734; fortran: 1,139; f90: 225; sh: 100
file content (54 lines) | stat: -rw-r--r-- 2,370 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/NEP/NEPRegister.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>NEPRegister</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.7.3 2016-09-29</b></div>
   <div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.7.3 v3.7.3 docs/manualpages/NEP/NEPRegister.html "><small>Report Typos and Errors</small></a></div>

<H1>NEPRegister</H1>
Adds a method to the nonlinear eigenproblem solver package. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h" 
PetscErrorCode NEPRegister(const char *name,PetscErrorCode (*function)(NEP))
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">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>&nbsp;- name of a new user-defined solver
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>function </B></TD><TD>&nbsp;- routine to create the solver context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
<A HREF="../NEP/NEPRegister.html#NEPRegister">NEPRegister</A>() may be called multiple times to add several user-defined solvers.
<P>
<H3><FONT COLOR="#883300">Sample usage</FONT></H3>
<PRE>
    <A HREF="../NEP/NEPRegister.html#NEPRegister">NEPRegister</A>("my_solver",MySolverCreate);
</PRE>

<P>
Then, your solver can be chosen with the procedural interface via
<pre>
    <A HREF="../NEP/NEPSetType.html#NEPSetType">NEPSetType</A>(nep,"my_solver")
</pre>
or at runtime via the option
<pre>
    -nep_type my_solver
</pre>
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../NEP/NEPRegisterAll.html#NEPRegisterAll">NEPRegisterAll</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/nep/interface/nepbasic.c.html#NEPRegister">src/nep/interface/nepbasic.c</A>
<BR><A HREF="./index.html">Index of all NEP 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>