File: ISGetIndices.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 (110 lines) | stat: -rw-r--r-- 5,294 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/IS/ISGetIndices.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISGetIndices</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/IS/ISGetIndices.html "><small>Report Typos and Errors</small></a></div>
<A NAME="ISGetIndices"><H1>ISGetIndices</H1></A>
Returns a pointer to the indices.  The user should call <A HREF="../IS/ISRestoreIndices.html#ISRestoreIndices">ISRestoreIndices</A>() after having looked at the indices.  The user should NOT change the indices. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../IS/ISGetIndices.html#ISGetIndices">ISGetIndices</A>(<A HREF="../IS/IS.html#IS">IS</A> is,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ptr[])
</PRE>
Not Collective
<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>is </B></TD><TD>- the index set
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ptr </B></TD><TD>- the location to put the pointer to the indices
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Fortran Note</FONT></H3>
This routine has two different interfaces from Fortran; the first is not recommend, it does not require Fortran 90
<pre>
   <A HREF="../IS/IS.html#IS">IS</A>          is
</pre>
<pre>
   integer     is_array(1)
</pre>
<pre>
   <A HREF="../Sys/PetscOffset.html#PetscOffset">PetscOffset</A> i_is
</pre>
<pre>
   int         ierr
</pre>
<pre>
      call <A HREF="../IS/ISGetIndices.html#ISGetIndices">ISGetIndices</A>(is,is_array,i_is,ierr)
</pre>
<pre>
</pre>
<pre>
  Access first local entry in list
</pre>
<pre>
     value = is_array(i_is + 1)
</pre>
<pre>
</pre>
<pre>
     ...... other code
</pre>
<pre>
      call <A HREF="../IS/ISRestoreIndices.html#ISRestoreIndices">ISRestoreIndices</A>(is,is_array,i_is,ierr)
</pre>
The second Fortran interface is recommended.
<pre>
         use petscisdef
</pre>
<pre>
         <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>, pointer :: array(:)
</pre>
<pre>
         <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  ierr
</pre>
<pre>
         <A HREF="../IS/IS.html#IS">IS</A>       i
</pre>
<pre>
         call <A HREF="../IS/ISGetIndicesF90.html#ISGetIndicesF90">ISGetIndicesF90</A>(i,array,ierr)
</pre>
<P>
<P>
<P>
See the Fortran chapter of the users manual and
petsc/src/is/[tutorials,tests] for details.
<P>

<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../IS/ISRestoreIndices.html#ISRestoreIndices">ISRestoreIndices</A>(), <A HREF="../IS/ISGetIndicesF90.html#ISGetIndicesF90">ISGetIndicesF90</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/vec/is/is/interface/index.c.html#ISGetIndices">src/vec/is/is/interface/index.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/vec/utils/tagger/tutorials/ex1.c.html">src/vec/vec/utils/tagger/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex1.c.html">src/vec/is/is/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex2.c.html">src/vec/is/is/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex3.c.html">src/vec/is/is/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex1f.F.html">src/vec/is/is/tutorials/ex1f.F.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex2f.F.html">src/vec/is/is/tutorials/ex2f.F.html</A><BR>
<A HREF="../../../src/dm/tutorials/swarm_ex3.c.html">src/dm/tutorials/swarm_ex3.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex71.c.html">src/ksp/ksp/tutorials/ex71.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex76.c.html">src/ksp/ksp/tutorials/ex76.c.html</A><BR>
<A HREF="../../../src/snes/tutorials/ex56.c.html">src/snes/tutorials/ex56.c.html</A><BR>
<A HREF="../../../src/snes/tutorials/ex77.c.html">src/snes/tutorials/ex77.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/vec/is/is/impls/block/block.c.html#ISGetIndices_Block">ISGetIndices_Block in src/vec/is/is/impls/block/block.c</A><BR>
<A HREF="../../../src/vec/is/is/impls/general/general.c.html#ISGetIndices_General">ISGetIndices_General in src/vec/is/is/impls/general/general.c</A><BR>
<A HREF="../../../src/vec/is/is/impls/stride/stride.c.html#ISGetIndices_Stride">ISGetIndices_Stride in src/vec/is/is/impls/stride/stride.c</A><BR>
<BR><A HREF="./index.html">Index of all IS 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>