File: DMDACreate3d.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
links: PTS, VCS
area: main
in suites: buster
size: 209,064 kB
sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (117 lines) | stat: -rw-r--r-- 10,331 bytes
<!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/DMDACreate3d.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDACreate3d</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/DMDA/DMDACreate3d.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDACreate3d"><H1>DMDACreate3d</H1></A>
Creates an object that will manage the communication of three-dimensional regular array data that is distributed across some processors. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"    
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../DMDA/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DMBoundaryType</A> bx,<A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DMBoundaryType</A> by,<A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DMBoundaryType</A> bz,<A HREF="../DMDA/DMDAStencilType.html#DMDAStencilType">DMDAStencilType</A> stencil_type,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> M,
               <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> N,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> P,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> m,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> p,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> dof,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> s,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[],<A HREF="../DM/DM.html#DM">DM</A> *da)
</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>- MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bx,by,bz </B></TD><TD>- type of ghost nodes the array have.
Use one of <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_NONE</A>, <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_GHOSTED</A>, <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_PERIODIC</A>.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>stencil_type </B></TD><TD>- Type of stencil (<A HREF="../DMDA/DMDAStencilType.html#DMDAStencilType">DMDA_STENCIL_STAR</A> or <A HREF="../DMDA/DMDAStencilType.html#DMDAStencilType">DMDA_STENCIL_BOX</A>)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>M,N,P </B></TD><TD>- global dimension in each direction of the array 
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>m,n,p </B></TD><TD>- corresponding number of processors in each dimension
(or <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A> to have calculated)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dof </B></TD><TD>- number of degrees of freedom per node
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>s </B></TD><TD>- stencil width
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lx, ly, lz </B></TD><TD>- arrays containing the number of nodes in each cell along
the x, y, and z coordinates, or NULL. If non-null, these
must be of length as m,n,p and the corresponding
m,n, or p cannot be <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A>. Sum of the lx[] entries must be M, sum of
the ly[] must N, sum of the lz[] must be P
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>da </B> -the resulting distributed array object
<br>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-dm_view </B></TD><TD>- Calls <A HREF="../DM/DMView.html#DMView">DMView</A>() at the conclusion of <A HREF="../DMDA/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_grid_x &lt;nx&gt; </B></TD><TD>- number of grid points in x direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_grid_y &lt;ny&gt; </B></TD><TD>- number of grid points in y direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_grid_z &lt;nz&gt; </B></TD><TD>- number of grid points in z direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_processors_x &lt;MX&gt; </B></TD><TD>- number of processors in x direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_processors_y &lt;MY&gt; </B></TD><TD>- number of processors in y direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_processors_z &lt;MZ&gt; </B></TD><TD>- number of processors in z direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine_x &lt;rx&gt; </B></TD><TD>- refinement ratio in x direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine_y &lt;ry&gt; </B></TD><TD>- refinement ratio in y direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine_z &lt;rz&gt;</B></TD><TD>- refinement ratio in z directio
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine &lt;n&gt; </B></TD><TD>- refine the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> n times before creating it
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The stencil type <A HREF="../DMDA/DMDAStencilType.html#DMDAStencilType">DMDA_STENCIL_STAR</A> with width 1 corresponds to the
standard 7-pt stencil, while <A HREF="../DMDA/DMDAStencilType.html#DMDAStencilType">DMDA_STENCIL_BOX</A> with width 1 denotes
the standard 27-pt stencil.
<P>
The array data itself is NOT stored in the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A>, it is stored in <A HREF="../Vec/Vec.html#Vec">Vec</A> objects;
The appropriate vector objects can be obtained with calls to <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>()
and <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>() and calls to <A HREF="../Vec/VecDuplicate.html#VecDuplicate">VecDuplicate</A>() if more are needed.
<P>
You must call <A HREF="../DM/DMSetUp.html#DMSetUp">DMSetUp</A>() after this call before using this <A HREF="../DM/DM.html#DM">DM</A>.
<P>
If you wish to use the options database to change values in the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> call <A HREF="../DM/DMSetFromOptions.html#DMSetFromOptions">DMSetFromOptions</A>() after this call
but before <A HREF="../DM/DMSetUp.html#DMSetUp">DMSetUp</A>().
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 distributed array, create, three-dimensional
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DM/DMDestroy.html#DMDestroy">DMDestroy</A>(), <A HREF="../DM/DMView.html#DMView">DMView</A>(), <A HREF="../DMDA/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>(), <A HREF="../DMDA/DMDACreate2d.html#DMDACreate2d">DMDACreate2d</A>(), <A HREF="../DM/DMGlobalToLocalBegin.html#DMGlobalToLocalBegin">DMGlobalToLocalBegin</A>(), <A HREF="../DMDA/DMDAGetRefinementFactor.html#DMDAGetRefinementFactor">DMDAGetRefinementFactor</A>(),
<BR><A HREF="../DM/DMGlobalToLocalEnd.html#DMGlobalToLocalEnd">DMGlobalToLocalEnd</A>(), <A HREF="../DM/DMLocalToGlobalBegin.html#DMLocalToGlobalBegin">DMLocalToGlobalBegin</A>(), <A HREF="../DM/DMLocalToLocalBegin.html#DMLocalToLocalBegin">DMLocalToLocalBegin</A>(), <A HREF="../DM/DMLocalToLocalEnd.html#DMLocalToLocalEnd">DMLocalToLocalEnd</A>(), <A HREF="../DMDA/DMDASetRefinementFactor.html#DMDASetRefinementFactor">DMDASetRefinementFactor</A>(),
<A HREF="../DMDA/DMDAGetInfo.html#DMDAGetInfo">DMDAGetInfo</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>(), <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>(), <A HREF="../DMDA/DMDACreateNaturalVector.html#DMDACreateNaturalVector">DMDACreateNaturalVector</A>(), <A HREF="../DM/DMLoad.html#DMLoad">DMLoad</A>(), <A HREF="../DMDA/DMDAGetOwnershipRanges.html#DMDAGetOwnershipRanges">DMDAGetOwnershipRanges</A>()
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/da/da3.c.html#DMDACreate3d">src/dm/impls/da/da3.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/examples/tutorials/ex3.c.html">src/dm/examples/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/ex15.c.html">src/dm/examples/tutorials/ex15.c.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/ex20.c.html">src/dm/examples/tutorials/ex20.c.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/ex11f90.F90.html">src/dm/examples/tutorials/ex11f90.F90.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/ex13f90.F90.html">src/dm/examples/tutorials/ex13f90.F90.html</A><BR>
<A HREF="../../../src/dm/field/examples/tutorials/ex1.c.html">src/dm/field/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex34.c.html">src/ksp/ksp/examples/tutorials/ex34.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex42.c.html">src/ksp/ksp/examples/tutorials/ex42.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex45.c.html">src/ksp/ksp/examples/tutorials/ex45.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex22f.F90.html">src/ksp/ksp/examples/tutorials/ex22f.F90.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex14.c.html">src/snes/examples/tutorials/ex14.c.html</A><BR>
<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>