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> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMDA/DMDAGetProcessorSubset.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDAGetProcessorSubset</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/DMDA/DMDAGetProcessorSubset.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDAGetProcessorSubset"><H1>DMDAGetProcessorSubset</H1></A>
Returns a communicator consisting only of the processors in a <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> that own a particular global x, y, or z grid point (corresponding to a logical plane in a 3D grid or a line in a 2D grid).
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMDA/DMDAGetProcessorSubset.html#DMDAGetProcessorSubset">DMDAGetProcessorSubset</A>(<A HREF="../DM/DM.html#DM">DM</A> da,<A HREF="../DM/DMDirection.html#DMDirection">DMDirection</A> dir,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> gp,<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> *comm)
</PRE>
Collective on da
<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>da </B></TD><TD>- the distributed array
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dir </B></TD><TD>- Cartesian direction, either <A HREF="../DM/DMDirection.html#DMDirection">DM_X</A>, <A HREF="../DM/DMDirection.html#DMDirection">DM_Y</A>, or <A HREF="../DM/DMDirection.html#DMDirection">DM_Z</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gp </B></TD><TD>- global grid point number in this direction
</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>comm </B></TD><TD>- new communicator
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
All processors that share the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> must call this with the same gp value
<P>
After use, comm should be freed with MPI_Comm_free()
<P>
This routine is particularly useful to compute boundary conditions
or other application-specific calculations that require manipulating
sets of data throughout a logical plane of grid points.
<P>
Not supported from Fortran
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/da/dasub.c.html#DMDAGetProcessorSubset">src/dm/impls/da/dasub.c</A>
<BR><A HREF="./index.html">Index of all DMDA 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>
|
