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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<!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/DMDACreate1d.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDACreate1d</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/DMDACreate1d.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDACreate1d"><H1>DMDACreate1d</H1></A>
Creates an object that will manage the communication of one-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/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm, <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DMBoundaryType</A> bx, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> M, <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[], <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 </B></TD><TD>- type of ghost cells at the boundary the array should have, if any. Use
<A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_NONE</A>, <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_GHOSTED</A>, or <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_PERIODIC</A>.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>M </B></TD><TD>- global dimension of the array (that is the number of grid points)
from the command line with -da_grid_x <M>)
</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 </B></TD><TD>- array containing number of nodes in the X direction on each processor,
or NULL. If non-null, must be of length as the number of processes in the <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>.
The sum of these entries must equal M
</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/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_grid_x <nx> </B></TD><TD>- number of grid points in x direction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine_x <rx> </B></TD><TD>- refinement factor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine <n> </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 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, one-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/DMDACreate2d.html#DMDACreate2d">DMDACreate2d</A>(), <A HREF="../DMDA/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>(), <A HREF="../DM/DMGlobalToLocalBegin.html#DMGlobalToLocalBegin">DMGlobalToLocalBegin</A>(), <A HREF="../DMDA/DMDASetRefinementFactor.html#DMDASetRefinementFactor">DMDASetRefinementFactor</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/DMDAGetRefinementFactor.html#DMDAGetRefinementFactor">DMDAGetRefinementFactor</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/da1.c.html#DMDACreate1d">src/dm/impls/da/da1.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/ex51.c.html">src/dm/examples/tutorials/ex51.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/field/examples/tutorials/ex1.c.html">src/dm/field/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex25.c.html">src/ksp/ksp/examples/tutorials/ex25.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex28.c.html">src/ksp/ksp/examples/tutorials/ex28.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex65.c.html">src/ksp/ksp/examples/tutorials/ex65.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex67.c.html">src/ksp/ksp/examples/tutorials/ex67.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex69.c.html">src/ksp/ksp/examples/tutorials/ex69.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex44f.F90.html">src/ksp/ksp/examples/tutorials/ex44f.F90.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex3.c.html">src/snes/examples/tutorials/ex3.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>
|
