File: DMStagGetOwnershipRanges.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 (50 lines) | stat: -rw-r--r-- 3,706 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMSTAG/DMStagGetOwnershipRanges.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMStagGetOwnershipRanges</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/DMSTAG/DMStagGetOwnershipRanges.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMStagGetOwnershipRanges"><H1>DMStagGetOwnershipRanges</H1></A>
get elements per rank in each direction 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSTAG/DMStagGetOwnershipRanges.html#DMStagGetOwnershipRanges">DMStagGetOwnershipRanges</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *lx[],const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ly[],const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *lz[])
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- the DMStag object
</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>lx </B></TD><TD>- ownership along x direction (optional)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ly </B></TD><TD>- ownership along y direction (optional)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lz </B></TD><TD>- ownership along z direction (optional)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
These correspond to the optional final arguments passed to <A HREF="../DMSTAG/DMStagCreate1d.html#DMStagCreate1d">DMStagCreate1d</A>(), <A HREF="../DMSTAG/DMStagCreate2d.html#DMStagCreate2d">DMStagCreate2d</A>(), and <A HREF="../DMSTAG/DMStagCreate3d.html#DMStagCreate3d">DMStagCreate3d</A>().
<P>
Arguments corresponding to higher dimensions are ignored for 1D and 2D grids. These arguments may be set to NULL in this case.
<P>
In C you should not free these arrays, nor change the values in them.
They will only have valid values while the DMStag they came from still exists (has not been destroyed).
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DMSTAG/DMSTAG.html#DMSTAG">DMSTAG</A>, <A HREF="../DMSTAG/DMStagSetGlobalSizes.html#DMStagSetGlobalSizes">DMStagSetGlobalSizes</A>(), <A HREF="../DMSTAG/DMStagSetOwnershipRanges.html#DMStagSetOwnershipRanges">DMStagSetOwnershipRanges</A>(), <A HREF="../DMSTAG/DMStagCreate1d.html#DMStagCreate1d">DMStagCreate1d</A>(), <A HREF="../DMSTAG/DMStagCreate2d.html#DMStagCreate2d">DMStagCreate2d</A>(), <A HREF="../DMSTAG/DMStagCreate3d.html#DMStagCreate3d">DMStagCreate3d</A>(), <A HREF="../DMDA/DMDAGetOwnershipRanges.html#DMDAGetOwnershipRanges">DMDAGetOwnershipRanges</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/stag/stagutils.c.html#DMStagGetOwnershipRanges">src/dm/impls/stag/stagutils.c</A>
<BR><A HREF="./index.html">Index of all DMSTAG 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>