File: PEPSetProblemType.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 (68 lines) | stat: -rw-r--r-- 4,528 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPSetProblemType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPSetProblemType</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/PEPSetProblemType.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPSetProblemType</H1>
Specifies the type of the polynomial eigenvalue problem. 
<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/PEPSetProblemType.html#PEPSetProblemType">PEPSetProblemType</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEPProblemType</A> type)
</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;- the polynomial eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type </B></TD><TD>&nbsp;- a known type of polynomial eigenvalue problem
</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>-pep_general </B></TD><TD>&nbsp;- general problem with no particular structure
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_hermitian </B></TD><TD>&nbsp;- problem whose coefficient matrices are Hermitian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_hyperbolic </B></TD><TD>&nbsp;- Hermitian problem that satisfies the definition of hyperbolic
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_gyroscopic </B></TD><TD>&nbsp;- problem with Hamiltonian structure
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
Allowed values for the problem type are general (<A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEP_GENERAL</A>), Hermitian
(<A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEP_HERMITIAN</A>), hyperbolic (<A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEP_HYPERBOLIC</A>), and gyroscopic (<A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEP_GYROSCOPIC</A>).
<P>
This function is used to instruct SLEPc to exploit certain structure in
the polynomial eigenproblem. By default, no particular structure is assumed.
<P>
If the problem matrices are Hermitian (symmetric in the real case) or
Hermitian/skew-Hermitian then the solver can exploit this fact to perform
less operations or provide better stability. Hyperbolic problems are a
particular case of Hermitian problems, some solvers may treat them simply as
Hermitian.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../PEP/PEPSetOperators.html#PEPSetOperators">PEPSetOperators</A>(), <A HREF="../PEP/PEPSetType.html#PEPSetType">PEPSetType</A>(), <A HREF="../PEP/PEPGetProblemType.html#PEPGetProblemType">PEPGetProblemType</A>(), <A HREF="../PEP/PEPProblemType.html#PEPProblemType">PEPProblemType</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/pepopts.c.html#PEPSetProblemType">src/pep/interface/pepopts.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/pep/tutorials/ex16.c.html">src/pep/tutorials/ex16.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex16f.F90.html">src/pep/tutorials/ex16f.F90</A><BR>
<A HREF="../../../src/pep/tutorials/ex38.c.html">src/pep/tutorials/ex38.c</A><BR>
<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>
<A HREF="../../../src/pep/tutorials/nlevp/wiresaw.c.html">src/pep/tutorials/nlevp/wiresaw.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>