File: BVSetOrthogonalization.html

package info (click to toggle)
slepc 3.7.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,788 kB
  • ctags: 100,221
  • sloc: ansic: 79,324; makefile: 3,897; python: 2,734; fortran: 1,139; f90: 225; sh: 100
file content (65 lines) | stat: -rw-r--r-- 4,143 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/BV/BVSetOrthogonalization.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>BVSetOrthogonalization</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.7.3 2016-09-29</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.7.3 v3.7.3 docs/manualpages/BV/BVSetOrthogonalization.html "><small>Report Typos and Errors</small></a></div>

<H1>BVSetOrthogonalization</H1>
Specifies the method used for the orthogonalization of vectors (classical or modified Gram-Schmidt with or without refinement), and for the block-orthogonalization (simultaneous orthogonalization of a set of vectors). 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcbv.h" 
PetscErrorCode BVSetOrthogonalization(BV bv,BVOrthogType type,BVOrthogRefineType refine,PetscReal eta,BVOrthogBlockType block)
</PRE>
Logically Collective on <A HREF="../BV/BV.html#BV">BV</A>
<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>bv     </B></TD><TD>&nbsp;- the basis vectors context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type   </B></TD><TD>&nbsp;- the method of vector orthogonalization
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>refine </B></TD><TD>&nbsp;- type of refinement
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eta    </B></TD><TD>&nbsp;- parameter for selective refinement
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>block  </B></TD><TD>&nbsp;- the method of block orthogonalization
</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>-bv_orthog_type &lt;type&gt; </B></TD><TD>&nbsp;- Where &lt;type&gt; is cgs for Classical Gram-Schmidt orthogonalization
(default) or mgs for Modified Gram-Schmidt orthogonalization
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-bv_orthog_refine &lt;ref&gt; </B></TD><TD>&nbsp;- Where &lt;ref&gt; is one of never, ifneeded (default) or always
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-bv_orthog_eta &lt;eta&gt; </B></TD><TD>&nbsp;- For setting the value of eta
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-bv_orthog_block &lt;block&gt; </B></TD><TD>&nbsp;- Where &lt;block&gt; is the block-orthogonalization method
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The default settings work well for most problems.
<P>
The parameter eta should be a real value between 0 and 1 (or PETSC_DEFAULT).
The value of eta is used only when the refinement type is "ifneeded".
<P>
When using several processors, MGS is likely to result in bad scalability.
<P>
If the method set for block orthogonalization is GS, then the computation
is done column by column with the vector orthogonalization.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../BV/BVOrthogonalizeColumn.html#BVOrthogonalizeColumn">BVOrthogonalizeColumn</A>(), <A HREF="../BV/BVGetOrthogonalization.html#BVGetOrthogonalization">BVGetOrthogonalization</A>(), <A HREF="../BV/BVOrthogType.html#BVOrthogType">BVOrthogType</A>, <A HREF="../BV/BVOrthogRefineType.html#BVOrthogRefineType">BVOrthogRefineType</A>, <A HREF="../BV/BVOrthogBlockType.html#BVOrthogBlockType">BVOrthogBlockType</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/sys/classes/bv/interface/bvbasic.c.html#BVSetOrthogonalization">src/sys/classes/bv/interface/bvbasic.c</A>
<BR><A HREF="./index.html">Index of all BV 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>