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
|
<!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/ISLocalToGlobalMappingCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISLocalToGlobalMappingCreate</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/ISLocalToGlobalMappingCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="ISLocalToGlobalMappingCreate"><H1>ISLocalToGlobalMappingCreate</H1></A>
Creates a mapping between a local (0 to n) ordering and a global parallel ordering.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/ISLocalToGlobalMappingCreate.html#ISLocalToGlobalMappingCreate">ISLocalToGlobalMappingCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> bs,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> indices[],<A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A> mode,<A HREF="../IS/ISLocalToGlobalMapping.html#ISLocalToGlobalMapping">ISLocalToGlobalMapping</A> *mapping)
</PRE>
Not Collective, but communicator may have more than one process
<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>comm </B></TD><TD>- MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bs </B></TD><TD>- the block size
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the number of local elements divided by the block size, or equivalently the number of block indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>indices </B></TD><TD>- the global index for each local element, these do not need to be in increasing order (sorted), these values should not be scaled (i.e. multiplied) by the blocksize bs
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mode </B></TD><TD>- see <A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A>
</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>mapping </B></TD><TD>- new mapping data structure
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
There is one integer value in indices per block and it represents the actual indices bs*idx + j, where j=0,..,bs-1
<P>
For "small" problems when using <A HREF="../IS/ISGlobalToLocalMappingApply.html#ISGlobalToLocalMappingApply">ISGlobalToLocalMappingApply</A>() and <A HREF="../IS/ISGlobalToLocalMappingApplyBlock.html#ISGlobalToLocalMappingApplyBlock">ISGlobalToLocalMappingApplyBlock</A>(), the <A HREF="../IS/ISLocalToGlobalMappingType.html#ISLocalToGlobalMappingType">ISLocalToGlobalMappingType</A> of <A HREF="../IS/ISLOCALTOGLOBALMAPPINGBASIC.html#ISLOCALTOGLOBALMAPPINGBASIC">ISLOCALTOGLOBALMAPPINGBASIC</A> will be used;
this uses more memory but is faster; this approach is not scalable for extremely large mappings. For large problems <A HREF="../IS/ISLOCALTOGLOBALMAPPINGHASH.html#ISLOCALTOGLOBALMAPPINGHASH">ISLOCALTOGLOBALMAPPINGHASH</A> is used, this is scalable.
Use <A HREF="../IS/ISLocalToGlobalMappingSetType.html#ISLocalToGlobalMappingSetType">ISLocalToGlobalMappingSetType</A>() or call <A HREF="../IS/ISLocalToGlobalMappingSetFromOptions.html#ISLocalToGlobalMappingSetFromOptions">ISLocalToGlobalMappingSetFromOptions</A>() with the option -islocaltoglobalmapping_type <basic,hash> to control which is used.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../IS/ISLocalToGlobalMappingDestroy.html#ISLocalToGlobalMappingDestroy">ISLocalToGlobalMappingDestroy</A>(), <A HREF="../IS/ISLocalToGlobalMappingCreateIS.html#ISLocalToGlobalMappingCreateIS">ISLocalToGlobalMappingCreateIS</A>(), <A HREF="../IS/ISLocalToGlobalMappingSetFromOptions.html#ISLocalToGlobalMappingSetFromOptions">ISLocalToGlobalMappingSetFromOptions</A>(), <A HREF="../IS/ISLOCALTOGLOBALMAPPINGBASIC.html#ISLOCALTOGLOBALMAPPINGBASIC">ISLOCALTOGLOBALMAPPINGBASIC</A>, <A HREF="../IS/ISLOCALTOGLOBALMAPPINGHASH.html#ISLOCALTOGLOBALMAPPINGHASH">ISLOCALTOGLOBALMAPPINGHASH</A>
<BR><A HREF="../IS/ISLocalToGlobalMappingSetType.html#ISLocalToGlobalMappingSetType">ISLocalToGlobalMappingSetType</A>(), <A HREF="../IS/ISLocalToGlobalMappingType.html#ISLocalToGlobalMappingType">ISLocalToGlobalMappingType</A>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/is/utils/isltog.c.html#ISLocalToGlobalMappingCreate">src/vec/is/utils/isltog.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/vec/tutorials/ex8.c.html">src/vec/vec/tutorials/ex8.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex4.c.html">src/vec/is/is/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/vec/is/is/tutorials/ex5.c.html">src/vec/is/is/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex59.c.html">src/ksp/ksp/tutorials/ex59.c.html</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>
|
