File: MatCreateTile.html

package info (click to toggle)
slepc 3.22.2%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 49,376 kB
  • sloc: ansic: 118,012; python: 4,887; f90: 3,620; cpp: 1,526; makefile: 811; sh: 311
file content (66 lines) | stat: -rw-r--r-- 4,341 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
66
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/sys/MatCreateTile.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>MatCreateTile</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/MatCreateTile.html "><small>Report Typos and Errors</small></a></div>
<H1>MatCreateTile</H1>
Explicitly build a matrix from four blocks, G = [ a*A b*B; c*C d*D ]. 
<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/MatCreateTile.html#MatCreateTile">MatCreateTile</A>(<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> a,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> A,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> b,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> B,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> c,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> C,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> d,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> D,<A HREF="https://petsc.org/release/manualpages/Mat/Mat.html#Mat">Mat</A> *G)
</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>A </B></TD><TD>&nbsp;- matrix for top-left block
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>a </B></TD><TD>&nbsp;- scaling factor for block A
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>B </B></TD><TD>&nbsp;- matrix for top-right block
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>b </B></TD><TD>&nbsp;- scaling factor for block B
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>C </B></TD><TD>&nbsp;- matrix for bottom-left block
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>c </B></TD><TD>&nbsp;- scaling factor for block C
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>D </B></TD><TD>&nbsp;- matrix for bottom-right block
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>d </B></TD><TD>&nbsp;- scaling factor for block D
</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>G  </B></TD><TD>&nbsp;- the resulting matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
In the case of a parallel matrix, a permuted version of G is returned. The permutation
is a perfect shuffle such that the local parts of A, B, C, D remain in the local part of
G for the same process.
<P>
Matrix G must be destroyed by the user.
<P>
The blocks can be of different type. They can be either ConstantDiagonal, or a standard
type such as AIJ, or any other type provided that it supports the <A HREF="https://petsc.org/release/manualpages/Mat/MatGetRow.html#MatGetRow">MatGetRow</A> operation.
The type of the output matrix will be the same as the first block that is not
ConstantDiagonal (checked in the A,B,C,D order).
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="https://petsc.org/release/manualpages/Mat/MatCreateNest.html#MatCreateNest">MatCreateNest</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/sys/mat/matutil.c.html#MatCreateTile">src/sys/mat/matutil.c</A>
<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>