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/LME/LMESetSolution.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>LMESetSolution</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/LME/LMESetSolution.html "><small>Report Typos and Errors</small></a></div>
<H1>LMESetSolution</H1>
Sets the placeholder for the solution of the matrix equation, as a low-rank matrix.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepclme.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../LME/LMESetSolution.html#LMESetSolution">LMESetSolution</A>(<A HREF="../LME/LME.html#LME">LME</A> lme,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> X)
</PRE>
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>lme </B></TD><TD> - the matrix function context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD> - the solution matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The matrix equation takes the general form A*X*E+D*X*B=C, where the solution
matrix is of low rank and is written in factored form X = U*D*V'. This function
provides a <A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> object of type <A HREF="https://petsc.org/release/manualpages/Mat/MATLRC.html#MATLRC">MATLRC</A> that stores U, V and (optionally) D.
These factors will be computed during <A HREF="../LME/LMESolve.html#LMESolve">LMESolve</A>().
<P>
In equation types whose solution X is symmetric, such as Lyapunov, X must be
created with V=U (or V=NULL).
<P>
If the user provides X with this function, then the solver will
return a solution with rank at most the number of columns of U. Alternatively,
it is possible to let the solver choose the rank of the solution, by
setting X to NULL and then calling <A HREF="../LME/LMEGetSolution.html#LMEGetSolution">LMEGetSolution</A>() after <A HREF="../LME/LMESolve.html#LMESolve">LMESolve</A>().
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../LME/LMEGetSolution.html#LMEGetSolution">LMEGetSolution</A>(), <A HREF="../LME/LMESetRHS.html#LMESetRHS">LMESetRHS</A>(), <A HREF="../LME/LMESetProblemType.html#LMESetProblemType">LMESetProblemType</A>(), <A HREF="../LME/LMESolve.html#LMESolve">LMESolve</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/lme/interface/lmesetup.c.html#LMESetSolution">src/lme/interface/lmesetup.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/lme/tutorials/ex32.c.html">src/lme/tutorials/ex32.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all LME 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>
|
