File: PetscLayoutCreateFromSizes.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 (61 lines) | stat: -rw-r--r-- 4,826 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
 
<!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/PetscLayoutCreateFromSizes.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscLayoutCreateFromSizes</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/PetscLayoutCreateFromSizes.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscLayoutCreateFromSizes"><H1>PetscLayoutCreateFromSizes</H1></A>
Allocates <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> space, sets the layout sizes, and sets the layout up. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/PetscLayoutCreateFromSizes.html#PetscLayoutCreateFromSizes">PetscLayoutCreateFromSizes</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> N,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> bs,<A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A> *map)
</PRE>
Collective
<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>n     </B></TD><TD>- the local size (or <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A>)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>N     </B></TD><TD>- the global size (or <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A>)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bs    </B></TD><TD>- the block size (or <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A>)
</TD></TR></TABLE>
<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>map </B></TD><TD>- the new <A HREF="../IS/PetscLayout.html#PetscLayout">PetscLayout</A>
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<pre>
<A HREF="../IS/PetscLayoutCreateFromSizes.html#PetscLayoutCreateFromSizes">PetscLayoutCreateFromSizes</A>(comm,n,N,bs,&amp;layout);
</pre>
is a shorthand for
<PRE>
  <A HREF="../IS/PetscLayoutCreate.html#PetscLayoutCreate">PetscLayoutCreate</A>(comm,&amp;layout);
  <A HREF="../IS/PetscLayoutSetLocalSize.html#PetscLayoutSetLocalSize">PetscLayoutSetLocalSize</A>(layout,n);
  <A HREF="../IS/PetscLayoutSetSize.html#PetscLayoutSetSize">PetscLayoutSetSize</A>(layout,N);
  <A HREF="../IS/PetscLayoutSetBlockSize.html#PetscLayoutSetBlockSize">PetscLayoutSetBlockSize</A>(layout,bs);
  <A HREF="../IS/PetscLayoutSetUp.html#PetscLayoutSetUp">PetscLayoutSetUp</A>(layout);
</PRE>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../IS/PetscLayoutCreate.html#PetscLayoutCreate">PetscLayoutCreate</A>(), <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>(), <A HREF="../IS/PetscLayoutCreateFromRanges.html#PetscLayoutCreateFromRanges">PetscLayoutCreateFromRanges</A>()
<P>
<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/pmap.c.html#PetscLayoutCreateFromSizes">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>