File: ISCreateGeneralNC.html

package info (click to toggle)
petsc 2.3.3-14
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 79,788 kB
  • ctags: 339,579
  • sloc: ansic: 255,388; cpp: 27,384; python: 27,194; fortran: 18,468; makefile: 11,436; sh: 3,671; f90: 1,447; xml: 620; csh: 211
file content (52 lines) | stat: -rw-r--r-- 2,942 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISCreateGeneralNC</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="ISCreateGeneralNC"><H1>ISCreateGeneralNC</H1></A>
Creates a data structure for an index set  containing a list of integers. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"  
PetscErrorCode  ISCreateGeneralNC(MPI_Comm comm,PetscInt n,const PetscInt idx[],IS *is)
</PRE>
Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../Sys/comm.html#comm">comm</A> </B></TD><TD>- the MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the length of the index set
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>idx </B></TD><TD>- the list of integers
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>is </B> -the new index set
<br>
<P>
Notes: This routine does not copy the indices, just keeps the pointer to the
indices. The <A HREF="../IS/ISDestroy.html#ISDestroy">ISDestroy</A>() will free the space so it must be obtained
with <A HREF="../Sys/PetscMalloc.html#PetscMalloc">PetscMalloc</A>() and it must not be freed nor modified elsewhere.
Use <A HREF="../IS/ISCreateGeneral.html#ISCreateGeneral">ISCreateGeneral</A>() if you wish to copy the indices passed into the routine.
Use <A HREF="../IS/ISCreateGeneralWithArray.html#ISCreateGeneralWithArray">ISCreateGeneralWithArray</A>() to NOT copy the indices and NOT free the space when
<A HREF="../IS/ISDestroy.html#ISDestroy">ISDestroy</A>() is called.
<P>
When the communicator is not MPI_COMM_SELF, the operations on <A HREF="../IS/IS.html#IS">IS</A> are NOT
conceptually the same as MPI_Group operations. The <A HREF="../IS/IS.html#IS">IS</A> are then
distributed sets of indices and thus certain operations on them are
collective.
<P>

<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../IS/ISCreateGeneral.html#ISCreateGeneral">ISCreateGeneral</A>(), <A HREF="../IS/ISCreateGeneralWithArray.html#ISCreateGeneralWithArray">ISCreateGeneralWithArray</A>(), <A HREF="../IS/ISCreateStride.html#ISCreateStride">ISCreateStride</A>(), <A HREF="../IS/ISCreateBlock.html#ISCreateBlock">ISCreateBlock</A>(), <A HREF="../IS/ISAllGather.html#ISAllGather">ISAllGather</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/is/impls/general/general.c.html#ISCreateGeneralNC">src/vec/is/impls/general/general.c</A>
<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>