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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/sys/MatCreateBSE.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>MatCreateBSE</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/sys/MatCreateBSE.html "><small>Report Typos and Errors</small></a></div>
<H1>MatCreateBSE</H1>
Create a matrix that can be used to define a structured eigenvalue problem of type BSE (Bethe-Salpeter Equation).
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcsys.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../sys/MatCreateBSE.html#MatCreateBSE">MatCreateBSE</A>(<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> R,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> C,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> *H)
</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>R </B></TD><TD> - matrix for the diagonal block (resonant)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>C </B></TD><TD> - matrix for the off-diagonal block (coupling)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>H </B></TD><TD> - the resulting matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The resulting matrix has the block form H = [ R C; -C^H -R^T ], where R is assumed
to be (complex) Hermitian and C complex symmetric. Note that this function does
not check these properties, so if the matrices provided by the user do not satisfy
them, then the solver will not behave as expected.
<P>
The obtained matrix can be used as an input matrix to <A HREF="../EPS/EPS.html#EPS">EPS</A> eigensolvers via
<A HREF="../EPS/EPSSetOperators.html#EPSSetOperators">EPSSetOperators</A>() for the case that the problem type is <A HREF="../EPS/EPSProblemType.html#EPSProblemType">EPS_BSE</A>. Note that the user
cannot just build a matrix with the required structure, it must be done via this
function.
<P>
In the current implementation, H is a <A HREF="https://petsc.org/release/manualpages/Mat/MATNEST.html#MATNEST">MATNEST</A> matrix, where R and C form the top
block row, while the bottom block row is composed of matrices of type
<A HREF="https://petsc.org/release/manualpages/Mat/MATTRANSPOSEVIRTUAL.html#MATTRANSPOSEVIRTUAL">MATTRANSPOSEVIRTUAL</A> and <A HREF="https://petsc.org/release/manualpages/Mat/MATHERMITIANTRANSPOSEVIRTUAL.html#MATHERMITIANTRANSPOSEVIRTUAL">MATHERMITIANTRANSPOSEVIRTUAL</A> scaled by -1.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="https://petsc.org/release/manualpages/Mat/MatCreateNest.html#MatCreateNest">MatCreateNest</A>(), <A HREF="../EPS/EPSSetOperators.html#EPSSetOperators">EPSSetOperators</A>(), <A HREF="../EPS/EPSSetProblemType.html#EPSSetProblemType">EPSSetProblemType</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/sys/mat/matstruct.c.html#MatCreateBSE">src/sys/mat/matstruct.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/eps/tutorials/ex55.c.html">src/eps/tutorials/ex55.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all sys 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>
|
