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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/BV/BVTensorGetFactors.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>BVTensorGetFactors</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.14.2 2021-02-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.14.2 v3.14.2 docs/manualpages/BV/BVTensorGetFactors.html "><small>Report Typos and Errors</small></a></div>
<H1>BVTensorGetFactors</H1>
Returns the two factors involved in the definition of the tensor basis vectors object, V = (I otimes U) S.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcbv.h"
PetscErrorCode <A HREF="../BV/BVTensorGetFactors.html#BVTensorGetFactors">BVTensorGetFactors</A>(<A HREF="../BV/BV.html#BV">BV</A> V,<A HREF="../BV/BV.html#BV">BV</A> *U,Mat *S)
</PRE>
Logically Collective on V
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>V </B></TD><TD> - the basis vectors context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>U </B></TD><TD> - the <A HREF="../BV/BV.html#BV">BV</A> factor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>S </B></TD><TD> - the Mat factor
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The returned factors are references (not copies) of the internal factors,
so modifying them will change the tensor <A HREF="../BV/BV.html#BV">BV</A> as well. Some operations of the
tensor <A HREF="../BV/BV.html#BV">BV</A> assume that U has orthonormal columns, so if the user modifies U
this restriction must be taken into account.
<P>
The returned factors must not be destroyed. <A HREF="../BV/BVTensorRestoreFactors.html#BVTensorRestoreFactors">BVTensorRestoreFactors</A>() must
be called when they are no longer needed.
<P>
Pass a NULL vector for any of the arguments that is not needed.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../BV/BVTensorRestoreFactors.html#BVTensorRestoreFactors">BVTensorRestoreFactors</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/sys/classes/bv/impls/tensor/bvtensor.c.html#BVTensorGetFactors">src/sys/classes/bv/impls/tensor/bvtensor.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>
|
