File: DSTruncate.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 (53 lines) | stat: -rw-r--r-- 3,340 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//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/DS/DSTruncate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>DSTruncate</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/DS/DSTruncate.html "><small>Report Typos and Errors</small></a></div>
<H1>DSTruncate</H1>
Truncates the system represented in the <A HREF="../DS/DS.html#DS">DS</A> object. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcds.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DS/DSTruncate.html#DSTruncate">DSTruncate</A>(<A HREF="../DS/DS.html#DS">DS</A> ds,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> n,<A HREF="https://petsc.org/release/manualpages/Sys/PetscBool.html#PetscBool">PetscBool</A> trim)
</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>ds   </B></TD><TD>&nbsp;- the direct solver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n    </B></TD><TD>&nbsp;- the new size
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>trim </B></TD><TD>&nbsp;- a flag to indicate if the factorization must be trimmed
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
The new size is set to n. Note that in some cases the new size could
be n+1 or n-1 to avoid breaking a 2x2 diagonal block (e.g. in real
Schur form). In cases where the extra row is meaningful, the first
n elements are kept as the extra row for the new system.
<P>
If the flag trim is turned on, it resets the locked and intermediate
dimensions to zero, see <A HREF="../DS/DSSetDimensions.html#DSSetDimensions">DSSetDimensions</A>(), and sets the state to RAW.
It also cleans the extra row if being used.
<P>
The typical usage of trim=true is to truncate the Schur decomposition
at the end of a Krylov iteration. In this case, the state must be
changed to RAW so that <A HREF="../DS/DSVectors.html#DSVectors">DSVectors</A>() computes eigenvectors from scratch.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../DS/DSSetDimensions.html#DSSetDimensions">DSSetDimensions</A>(), <A HREF="../DS/DSSetExtraRow.html#DSSetExtraRow">DSSetExtraRow</A>(), <A HREF="../DS/DSStateType.html#DSStateType">DSStateType</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/sys/classes/ds/interface/dsops.c.html#DSTruncate">src/sys/classes/ds/interface/dsops.c</A>
<BR><BR><A HREF="./index.html">Index of all DS 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>