File: PCDiagonalScaleLeft.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (54 lines) | stat: -rw-r--r-- 2,946 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://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCDiagonalScaleLeft.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCDiagonalScaleLeft</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/PC/PCDiagonalScaleLeft.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCDiagonalScaleLeft"><H1>PCDiagonalScaleLeft</H1></A>
Scales a vector by the left scaling as needed by certain time-stepping codes. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../PC/PCDiagonalScaleLeft.html#PCDiagonalScaleLeft">PCDiagonalScaleLeft</A>(<A HREF="../PC/PC.html#PC">PC</A> pc,<A HREF="../Vec/Vec.html#Vec">Vec</A> in,<A HREF="../Vec/Vec.html#Vec">Vec</A> out)
</PRE>
Logically Collective on <A HREF="../PC/PC.html#PC">PC</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pc </B></TD><TD>- the preconditioner context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>in </B></TD><TD>- input vector
+  out - scaled vector (maybe the same as in)
</TD></TR>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The system solved via the Krylov method is
<pre>
          D M A D^{-1} y = D M b  for left preconditioning or
</pre>
<pre>
          D A M D^{-1} z = D b for right preconditioning
</pre>
<P>
<A HREF="../PC/PCDiagonalScaleLeft.html#PCDiagonalScaleLeft">PCDiagonalScaleLeft</A>() scales a vector by D. <A HREF="../PC/PCDiagonalScaleRight.html#PCDiagonalScaleRight">PCDiagonalScaleRight</A>() scales a vector by D^{-1}.
<P>
If diagonal scaling is turned off and in is not out then in is copied to out
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 <A HREF="../PC/PC.html#PC">PC</A>
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../PC/PCCreate.html#PCCreate">PCCreate</A>(), <A HREF="../PC/PCSetUp.html#PCSetUp">PCSetUp</A>(), PCDiagonalScaleSet(), <A HREF="../PC/PCDiagonalScaleRight.html#PCDiagonalScaleRight">PCDiagonalScaleRight</A>(), PCDiagonalScale()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/pc/interface/precon.c.html#PCDiagonalScaleLeft">src/ksp/pc/interface/precon.c</A>
<BR><A HREF="./index.html">Index of all PC 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>