File: DMCompositeGetLocalISs.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (55 lines) | stat: -rw-r--r-- 3,895 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMCompositeGetLocalISs.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMCompositeGetLocalISs</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/DM/DMCompositeGetLocalISs.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMCompositeGetLocalISs"><H1>DMCompositeGetLocalISs</H1></A>
Gets index sets for each component of a composite local vector 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmcomposite.h"  
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../DM/DMCompositeGetLocalISs.html#DMCompositeGetLocalISs">DMCompositeGetLocalISs</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../IS/IS.html#IS">IS</A> **is)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- composite <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>is </B></TD><TD>- array of serial index sets for each each component of the DMComposite
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
At present, a composite local vector does not normally exist.  This function is used to provide index sets for
<A HREF="../Mat/MatGetLocalSubMatrix.html#MatGetLocalSubMatrix">MatGetLocalSubMatrix</A>().  In the future, the scatters for each entry in the DMComposite may be be merged into a single
scatter to a composite local vector.  The user should not typically need to know which is being done.
<P>
To get the composite global indices at all local points (including ghosts), use <A HREF="../DM/DMCompositeGetISLocalToGlobalMappings.html#DMCompositeGetISLocalToGlobalMappings">DMCompositeGetISLocalToGlobalMappings</A>().
<P>
To get index sets for pieces of the composite global vector, use <A HREF="../DM/DMCompositeGetGlobalISs.html#DMCompositeGetGlobalISs">DMCompositeGetGlobalISs</A>().
<P>
Each returned <A HREF="../IS/IS.html#IS">IS</A> should be destroyed with <A HREF="../IS/ISDestroy.html#ISDestroy">ISDestroy</A>(), the array should be freed with <A HREF="../Sys/PetscFree.html#PetscFree">PetscFree</A>().
<P>
Not available from Fortran
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DM/DMCompositeGetGlobalISs.html#DMCompositeGetGlobalISs">DMCompositeGetGlobalISs</A>(), <A HREF="../DM/DMCompositeGetISLocalToGlobalMappings.html#DMCompositeGetISLocalToGlobalMappings">DMCompositeGetISLocalToGlobalMappings</A>(), <A HREF="../Mat/MatGetLocalSubMatrix.html#MatGetLocalSubMatrix">MatGetLocalSubMatrix</A>(), <A HREF="../Mat/MatCreateLocalRef.html#MatCreateLocalRef">MatCreateLocalRef</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/composite/pack.c.html#DMCompositeGetLocalISs">src/dm/impls/composite/pack.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex28.c.html">src/snes/tutorials/ex28.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex14.c.html">src/ts/tutorials/ex14.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DM 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>