File: NEPSetTwoSided.html

package info (click to toggle)
slepc 3.23.1%2Bdfsg1-1exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 48,276 kB
  • sloc: ansic: 103,363; python: 6,078; f90: 3,286; cpp: 1,528; makefile: 772; sh: 311
file content (52 lines) | stat: -rw-r--r-- 3,375 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/NEP/NEPSetTwoSided.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>NEPSetTwoSided</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.23.1 2025-05-01</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.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/NEP/NEPSetTwoSided.html "><small>Report Typos and Errors</small></a></div>
<H1>NEPSetTwoSided</H1>
Sets the solver to use a two-sided variant so that left eigenvectors are also computed. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../NEP/NEPSetTwoSided.html#NEPSetTwoSided">NEPSetTwoSided</A>(<A HREF="../NEP/NEP.html#NEP">NEP</A> nep,<A HREF="https://petsc.org/release/manualpages/Sys/PetscBool.html#PetscBool">PetscBool</A> twosided)
</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>nep      </B></TD><TD>&nbsp;- the eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>twosided </B></TD><TD>&nbsp;- whether the two-sided variant is to be used or not
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-nep_two_sided &lt;boolean&gt; </B></TD><TD>&nbsp;- Sets/resets the twosided flag
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
If the user sets twosided=<A HREF="https://petsc.org/release/manualpages/Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> then the solver uses a variant of
the algorithm that computes both right and left eigenvectors. This is
usually much more costly. This option is not available in all solvers.
<P>
When using two-sided solvers, the problem matrices must have both the
<A HREF="https://petsc.org/release/manualpages/Mat/MatMult.html#MatMult">MatMult</A> and <A HREF="https://petsc.org/release/manualpages/Mat/MatMultTranspose.html#MatMultTranspose">MatMultTranspose</A> operations defined.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../NEP/NEPGetTwoSided.html#NEPGetTwoSided">NEPGetTwoSided</A>(), <A HREF="../NEP/NEPGetLeftEigenvector.html#NEPGetLeftEigenvector">NEPGetLeftEigenvector</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/nep/interface/nepopts.c.html#NEPSetTwoSided">src/nep/interface/nepopts.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/nep/tutorials/ex42.c.html">src/nep/tutorials/ex42.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all NEP 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>