File: DMDAGetGlobalIndices.html

package info (click to toggle)
petsc 3.4.2.dfsg1-8.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 129,104 kB
  • ctags: 516,422
  • sloc: ansic: 395,939; cpp: 47,201; python: 34,788; makefile: 17,193; fortran: 16,251; f90: 1,592; objc: 954; sh: 822; xml: 621; java: 381; lisp: 293; csh: 241
file content (73 lines) | stat: -rw-r--r-- 4,414 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
67
68
69
70
71
72
73
<!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/DMDAGetGlobalIndices.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDAGetGlobalIndices</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="DMDAGetGlobalIndices"><H1>DMDAGetGlobalIndices</H1></A>
Returns the global node number of all local nodes, including ghost nodes. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"   
PetscErrorCode  DMDAGetGlobalIndices(DM da,PetscInt *n,PetscInt **idx)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>da </B> -the distributed array
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the number of local elements, including ghost nodes (or NULL)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>idx </B></TD><TD>- the global indices
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
For <A HREF="../DM/DMDA_STENCIL_STAR.html#DMDA_STENCIL_STAR">DMDA_STENCIL_STAR</A> stencils the inactive corner ghost nodes are also included
in the list of local indices (even though those nodes are not updated
during calls to DMDAXXXToXXX().
<P>
Essentially the same data is returned in the form of a local-to-global mapping
with the routine DMDAGetISLocalToGlobalMapping();
<P>
<H3><FONT COLOR="#CC3333">Fortran Note</FONT></H3>
This routine is used differently from Fortran
<PRE>
        DM          da
        integer     n,da_array(1)
        <A HREF="../Sys/PetscOffset.html#PetscOffset">PetscOffset</A> i_da
        integer     ierr
        call <A HREF="../DM/DMDAGetGlobalIndices.html#DMDAGetGlobalIndices">DMDAGetGlobalIndices</A>(da,n,da_array,i_da,ierr)

   C Access first local entry in list
        value = da_array(i_da + 1)
</PRE>

<P>
See the &lt;A href="../../docs/manual.pdf#nameddest=<A HREF="../../manual.pdf#chapter.9">Chapter 9 PETSc for Fortran Users</A>"&gt;Fortran chapter&lt;/A&gt; of the users manual for details.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 distributed array, get, global, indices, local-to-global
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DM/DMDACreate2d.html#DMDACreate2d">DMDACreate2d</A>(), <A HREF="../DM/DMDAGetGhostCorners.html#DMDAGetGhostCorners">DMDAGetGhostCorners</A>(), <A HREF="../DM/DMDAGetCorners.html#DMDAGetCorners">DMDAGetCorners</A>(), <A HREF="../DM/DMLocalToGlobalBegin.html#DMLocalToGlobalBegin">DMLocalToGlobalBegin</A>()
<BR><A HREF="../DM/DMGlobalToLocalBegin.html#DMGlobalToLocalBegin">DMGlobalToLocalBegin</A>(), <A HREF="../DM/DMGlobalToLocalEnd.html#DMGlobalToLocalEnd">DMGlobalToLocalEnd</A>(), <A HREF="../DM/DMDALocalToLocalBegin.html#DMDALocalToLocalBegin">DMDALocalToLocalBegin</A>(), <A HREF="../DM/DMDAGetAO.html#DMDAGetAO">DMDAGetAO</A>(), <A HREF="../DM/DMDAGetGlobalIndicesF90.html#DMDAGetGlobalIndicesF90">DMDAGetGlobalIndicesF90</A>()
DMDAGetISLocalToGlobalMapping(), <A HREF="../DM/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>(), <A HREF="../DM/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>(), <A HREF="../DM/DMDALocalToLocalEnd.html#DMDALocalToLocalEnd">DMDALocalToLocalEnd</A>(), <A HREF="../DM/DMDAGetOwnershipRanges.html#DMDAGetOwnershipRanges">DMDAGetOwnershipRanges</A>()
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/dm/impls/da/daindex.c.html#DMDAGetGlobalIndices">src/dm/impls/da/daindex.c</A>
<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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex43.c.html">src/ksp/ksp/examples/tutorials/ex43.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex49.c.html">src/ksp/ksp/examples/tutorials/ex49.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex14f.F.html">src/ksp/ksp/examples/tutorials/ex14f.F.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex5f.F.html">src/snes/examples/tutorials/ex5f.F.html</A><BR>
</BODY></HTML>