File: PEPSetTarget.html

package info (click to toggle)
slepc 3.22.2%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 49,376 kB
  • sloc: ansic: 118,012; python: 4,887; f90: 3,620; cpp: 1,526; makefile: 811; sh: 311
file content (53 lines) | stat: -rw-r--r-- 3,072 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPSetTarget.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPSetTarget</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/PEP/PEPSetTarget.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPSetTarget</H1>
Sets the value of the target. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcpep.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PEP/PEPSetTarget.html#PEPSetTarget">PEPSetTarget</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> target)
</PRE>
Logically 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>pep    </B></TD><TD>&nbsp;- eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>target </B></TD><TD>&nbsp;- the value of the target
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_target &lt;scalar&gt; </B></TD><TD>&nbsp;- the value of the target
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The target is a scalar value used to determine the portion of the spectrum
of interest. It is used in combination with <A HREF="../PEP/PEPSetWhichEigenpairs.html#PEPSetWhichEigenpairs">PEPSetWhichEigenpairs</A>().
<P>
In the case of complex scalars, a complex value can be provided in the
command line with [+/-][realnumber][+/-]realnumberi with no spaces, e.g.
-pep_target 1.0+2.0i
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../PEP/PEPGetTarget.html#PEPGetTarget">PEPGetTarget</A>(), <A HREF="../PEP/PEPSetWhichEigenpairs.html#PEPSetWhichEigenpairs">PEPSetWhichEigenpairs</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/pep/interface/pepbasic.c.html#PEPSetTarget">src/pep/interface/pepbasic.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/pep/tutorials/ex40.c.html">src/pep/tutorials/ex40.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex50.c.html">src/pep/tutorials/ex50.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all PEP routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>