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
|
<!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/PetscLayoutCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscLayoutCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/IS/PetscLayoutCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscLayoutCreate"><H1>PetscLayoutCreate</H1></A>
Allocates <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> space and sets the map contents to the default.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"
PetscErrorCode PetscLayoutCreate(MPI_Comm comm,PetscLayout *map)
</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>comm </B></TD><TD>- the MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>map </B></TD><TD>- pointer to the map
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Typical calling sequence
<PRE>
<A HREF="../IS/PetscLayoutCreate.html#PetscLayoutCreate">PetscLayoutCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>,<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> *);
<A HREF="../IS/PetscLayoutSetBlockSize.html#PetscLayoutSetBlockSize">PetscLayoutSetBlockSize</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,1);
<A HREF="../IS/PetscLayoutSetSize.html#PetscLayoutSetSize">PetscLayoutSetSize</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,N) // or <A HREF="../IS/PetscLayoutSetLocalSize.html#PetscLayoutSetLocalSize">PetscLayoutSetLocalSize</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,n);
<A HREF="../IS/PetscLayoutSetUp.html#PetscLayoutSetUp">PetscLayoutSetUp</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>);
</PRE>
<H3><FONT COLOR="#CC3333">Optionally use any of the following</FONT></H3>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../IS/PetscLayoutGetSize.html#PetscLayoutGetSize">PetscLayoutGetSize</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *);</B></TD><TD>- . <A HREF="../IS/PetscLayoutGetLocalSize.html#PetscLayoutGetLocalSize">PetscLayoutGetLocalSize</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *);
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../IS/PetscLayoutGetRange.html#PetscLayoutGetRange">PetscLayoutGetRange</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *rstart,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *rend);</B></TD><TD>- . <A HREF="../IS/PetscLayoutGetRanges.html#PetscLayoutGetRanges">PetscLayoutGetRanges</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *range[]);
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../IS/PetscLayoutDestroy.html#PetscLayoutDestroy">PetscLayoutDestroy</A>(<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>*);</B></TD><TD>-
The <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> object and methods are intended to be used in the PETSc <A HREF="../Vec/Vec.html#Vec">Vec</A> and <A HREF="../Mat/Mat.html#Mat">Mat</A> implementions; it is often not needed in
user codes unless you really gain something in their use.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../IS/PetscLayoutSetLocalSize.html#PetscLayoutSetLocalSize">PetscLayoutSetLocalSize</A>(), <A HREF="../IS/PetscLayoutSetSize.html#PetscLayoutSetSize">PetscLayoutSetSize</A>(), <A HREF="../IS/PetscLayoutGetSize.html#PetscLayoutGetSize">PetscLayoutGetSize</A>(), <A HREF="../IS/PetscLayoutGetLocalSize.html#PetscLayoutGetLocalSize">PetscLayoutGetLocalSize</A>(), <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>, <A HREF="../IS/PetscLayoutDestroy.html#PetscLayoutDestroy">PetscLayoutDestroy</A>(),
<BR><A HREF="../IS/PetscLayoutGetRange.html#PetscLayoutGetRange">PetscLayoutGetRange</A>(), <A HREF="../IS/PetscLayoutGetRanges.html#PetscLayoutGetRanges">PetscLayoutGetRanges</A>(), <A HREF="../IS/PetscLayoutSetBlockSize.html#PetscLayoutSetBlockSize">PetscLayoutSetBlockSize</A>(), <A HREF="../IS/PetscLayoutGetBlockSize.html#PetscLayoutGetBlockSize">PetscLayoutGetBlockSize</A>(), <A HREF="../IS/PetscLayoutSetUp.html#PetscLayoutSetUp">PetscLayoutSetUp</A>()
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/is/utils/pmap.c.html#PetscLayoutCreate">src/vec/is/utils/pmap.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>
|
