File: DMStagPopulateLocalToGlobalInjective.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 (56 lines) | stat: -rw-r--r-- 4,141 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMSTAG/DMStagPopulateLocalToGlobalInjective.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMStagPopulateLocalToGlobalInjective</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/DMSTAG/DMStagPopulateLocalToGlobalInjective.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMStagPopulateLocalToGlobalInjective"><H1>DMStagPopulateLocalToGlobalInjective</H1></A>
populate an internal 1-to-1 local-to-global map 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSTAG/DMStagPopulateLocalToGlobalInjective.html#DMStagPopulateLocalToGlobalInjective">DMStagPopulateLocalToGlobalInjective</A>(<A HREF="../DM/DM.html#DM">DM</A> dm)
</PRE>
Collective
<P>
Creates an internal object which explicitly maps a single local degree of
freedom to each global degree of freedom. This is used, if populated,
instead of <A HREF="../Vec/SCATTER_REVERSE_LOCAL.html#SCATTER_REVERSE_LOCAL">SCATTER_REVERSE_LOCAL</A> with the (1-to-many, in general)
global-to-local map, when <A HREF="../DM/DMLocalToGlobal.html#DMLocalToGlobal">DMLocalToGlobal</A>() is called with <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>.
This allows usage, for example, even in the periodic, 1-rank case, where
the inverse of the global-to-local map, even when restricted to on-rank
communication, is non-injective. This is at the cost of storing an additional
<A HREF="../Vec/VecScatter.html#VecScatter">VecScatter</A> object inside each DMStag object.
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- the DMStag object
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
In normal usage, library users shouldn't be concerned with this function,
as it is called during <A HREF="../DM/DMSetUp.html#DMSetUp">DMSetUp</A>(), when required.
<P>
Returns immediately if the internal map is already populated.
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
This could, if desired, be moved up to a general <A HREF="../DM/DM.html#DM">DM</A> routine. It would allow,
for example, <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> to support <A HREF="../DM/DMLocalToGlobal.html#DMLocalToGlobal">DMLocalToGlobal</A>() with <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>,
even in the single-rank periodic case.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DMSTAG/DMSTAG.html#DMSTAG">DMSTAG</A>, <A HREF="../DM/DMLocalToGlobal.html#DMLocalToGlobal">DMLocalToGlobal</A>(), <A HREF="../Vec/VecScatter.html#VecScatter">VecScatter</A>
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/stag/stagutils.c.html#DMStagPopulateLocalToGlobalInjective">src/dm/impls/stag/stagutils.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/stag/stag1d.c.html#DMStagPopulateLocalToGlobalInjective_1d">DMStagPopulateLocalToGlobalInjective_1d in src/dm/impls/stag/stag1d.c</A><BR>
<A HREF="../../../src/dm/impls/stag/stag2d.c.html#DMStagPopulateLocalToGlobalInjective_2d">DMStagPopulateLocalToGlobalInjective_2d in src/dm/impls/stag/stag2d.c</A><BR>
<A HREF="../../../src/dm/impls/stag/stag3d.c.html#DMStagPopulateLocalToGlobalInjective_3d">DMStagPopulateLocalToGlobalInjective_3d in src/dm/impls/stag/stag3d.c</A><BR>
<BR><A HREF="./index.html">Index of all DMSTAG 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>