PageRenderTime 41ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/manualpages/DM/DMDACreate3d.html

https://bitbucket.org/alexei-matveev/petsc-debian-pkg
HTML | 111 lines | 110 code | 1 blank | 0 comment | 0 complexity | ceb9b41114492bffa4f90a0abab076e3 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
    2. 

  2. <HTML>
    3. 

  3. <HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMDACreate3d.html" />
    4. 

  4. <META NAME="GENERATOR" CONTENT="DOCTEXT">
    5. 

  5. <TITLE>DMDACreate3d</TITLE>
    6. 

  6. </HEAD>
    7. 

  7. <BODY BGCOLOR="FFFFFF">
    8. 

  8.    <div id="version" align=right><b>petsc-3.3-p3 2012-08-29</b></div>
    9. 

  9. <A NAME="DMDACreate3d"><H1>DMDACreate3d</H1></A>
    10. 

  10. Creates an object that will manage the communication of three-dimensional  regular array data that is distributed across some processors. 
    11. 

  11. <H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
    12. 

  12. <PRE>
    13. 

  13. #include "petscdmda.h"    
    14. 

  14. PetscErrorCode  DMDACreate3d(MPI_Comm comm,DMDABoundaryType bx,DMDABoundaryType by,DMDABoundaryType bz,DMDAStencilType stencil_type,PetscInt M,
    15. 

  15.                PetscInt N,PetscInt P,PetscInt m,PetscInt n,PetscInt p,PetscInt dof,PetscInt s,const PetscInt lx[],const PetscInt ly[],const PetscInt lz[],DM *da)
    16. 

  16. </PRE>
    17. 

  17. Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>
    18. 

  18. <P>
    19. 

  19. <H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
    20. 

  20. <TABLE border="0" cellpadding="0" cellspacing="0">
    21. 

  21. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- MPI communicator
    22. 

  22. </TD></TR>
    23. 

  23. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bx,by,bz </B></TD><TD>- type of ghost nodes the array have. 
    24. 

  24. Use one of DMDA_BOUNDARY_NONE, DMDA_BOUNDARY_GHOSTED, DMDA_BOUNDARY_PERIODIC.
    25. 

  25. </TD></TR>
    26. 

  26. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>stencil_type </B></TD><TD>- Type of stencil (<A HREF="../DM/DMDA_STENCIL_STAR.html#DMDA_STENCIL_STAR">DMDA_STENCIL_STAR</A> or <A HREF="../DM/DMDA_STENCIL_BOX.html#DMDA_STENCIL_BOX">DMDA_STENCIL_BOX</A>)
    27. 

  27. </TD></TR>
    28. 

  28. <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 (use -M, -N, and or -P to indicate that it may be set to a different value 
    29. 

  29. from the command line with -da_grid_x &lt;M&gt; -da_grid_y &lt;N&gt; -da_grid_z &lt;P&gt;)
    30. 

  30. </TD></TR>
    31. 

  31. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>m,n,p </B></TD><TD>- corresponding number of processors in each dimension 
    32. 

  32. (or <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A> to have calculated)
    33. 

  33. </TD></TR>
    34. 

  34. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dof </B></TD><TD>- number of degrees of freedom per node
    35. 

  35. </TD></TR>
    36. 

  36. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>s </B></TD><TD>- stencil width
    37. 

  37. </TD></TR>
    38. 

  38. <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
    39. 

  39. the x, y, and z coordinates, or <A HREF="../Sys/PETSC_NULL.html#PETSC_NULL">PETSC_NULL</A>. If non-null, these
    40. 

  40. must be of length as m,n,p and the corresponding
    41. 

  41. 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
    42. 

  42. the ly[] must N, sum of the lz[] must be P
    43. 

  43. </TD></TR></TABLE>
    44. 

  44. <P>
    45. 

  45. <H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
    46. 

  46. <DT><B>da </B> -the resulting distributed array object
    47. 

  47. <br>
    48. 

  48. <P>
    49. 

  49. <H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
    50. 

  50. <TABLE border="0" cellpadding="0" cellspacing="0">
    51. 

  51. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_view </B></TD><TD>- Calls <A HREF="../DM/DMView.html#DMView">DMView</A>() at the conclusion of <A HREF="../DM/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>()
    52. 

  52. </TD></TR>
    53. 

  53. <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, if M &lt; 0
    54. 

  54. </TD></TR>
    55. 

  55. <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, if N &lt; 0
    56. 

  56. </TD></TR>
    57. 

  57. <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, if P &lt; 0
    58. 

  58. </TD></TR>
    59. 

  59. <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
    60. 

  60. </TD></TR>
    61. 

  61. <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
    62. 

  62. </TD></TR>
    63. 

  63. <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
    64. 

  64. </TD></TR>
    65. 

  65. <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
    66. 

  66. </TD></TR>
    67. 

  67. <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
    68. 

  68. </TD></TR>
    69. 

  69. <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
    70. 

  70. </TD></TR>
    71. 

  71. <TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-da_refine &lt;n&gt; </B></TD><TD>- refine the DMDA n times before creating it, , if M, N, or P &lt; 0
    72. 

  72. </TD></TR></TABLE>
    73. 

  73. <P>
    74. 

  74. 

  75. <P>
    76. 

  76. <H3><FONT COLOR="#CC3333">Notes</FONT></H3>
    77. 

  77. The stencil type <A HREF="../DM/DMDA_STENCIL_STAR.html#DMDA_STENCIL_STAR">DMDA_STENCIL_STAR</A> with width 1 corresponds to the
    78. 

  78. standard 7-pt stencil, while <A HREF="../DM/DMDA_STENCIL_BOX.html#DMDA_STENCIL_BOX">DMDA_STENCIL_BOX</A> with width 1 denotes
    79. 

  79. the standard 27-pt stencil.
    80. 

  80. <P>
    81. 

  81. The array data itself is NOT stored in the DMDA, it is stored in <A HREF="../Vec/Vec.html#Vec">Vec</A> objects;
    82. 

  82. The appropriate vector objects can be obtained with calls to <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>()
    83. 

  83. and <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>() and calls to <A HREF="../Vec/VecDuplicate.html#VecDuplicate">VecDuplicate</A>() if more are needed.
    84. 

  84. <P>
    85. 

  85. <H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
    86. 

  86.  distributed array, create, three-dimensional
    87. 

  87. <BR>
    88. 

  88. <P>
    89. 

  89. <H3><FONT COLOR="#CC3333">See Also</FONT></H3>
    90. 

  90.  <A HREF="../DM/DMDestroy.html#DMDestroy">DMDestroy</A>(), <A HREF="../DM/DMView.html#DMView">DMView</A>(), <A HREF="../DM/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>(), <A HREF="../DM/DMDACreate2d.html#DMDACreate2d">DMDACreate2d</A>(), <A HREF="../DM/DMGlobalToLocalBegin.html#DMGlobalToLocalBegin">DMGlobalToLocalBegin</A>(), <A HREF="../DM/DMDAGetRefinementFactor.html#DMDAGetRefinementFactor">DMDAGetRefinementFactor</A>(),
    91. 

  91. <BR><A HREF="../DM/DMGlobalToLocalEnd.html#DMGlobalToLocalEnd">DMGlobalToLocalEnd</A>(), <A HREF="../DM/DMLocalToGlobalBegin.html#DMLocalToGlobalBegin">DMLocalToGlobalBegin</A>(), <A HREF="../DM/DMDALocalToLocalBegin.html#DMDALocalToLocalBegin">DMDALocalToLocalBegin</A>(), <A HREF="../DM/DMDALocalToLocalEnd.html#DMDALocalToLocalEnd">DMDALocalToLocalEnd</A>(), <A HREF="../DM/DMDASetRefinementFactor.html#DMDASetRefinementFactor">DMDASetRefinementFactor</A>(),
    92. 

  92. <A HREF="../DM/DMDAGetInfo.html#DMDAGetInfo">DMDAGetInfo</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>(), <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>(), <A HREF="../DM/DMDACreateNaturalVector.html#DMDACreateNaturalVector">DMDACreateNaturalVector</A>(), <A HREF="../DM/DMLoad.html#DMLoad">DMLoad</A>(), <A HREF="../DM/DMDAGetOwnershipRanges.html#DMDAGetOwnershipRanges">DMDAGetOwnershipRanges</A>()
    93. 

  93. <P>
    94. 

  94. <P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
    95. 

  95. <BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/dm/impls/da/da3.c.html#DMDACreate3d">src/dm/impls/da/da3.c</A>
    96. 

  96. <BR><A HREF="./index.html">Index of all DM routines</A>
    97. 

  97. <BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
    98. 

  98. <BR><A HREF="../singleindex.html">Index of all manual pages</A>
    99. 

  99. <P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
    100. 

  100. <A HREF="../../../src/dm/examples/tutorials/ex3.c.html">src/dm/examples/tutorials/ex3.c.html</A><BR>
    101. 

  101. <A HREF="../../../src/dm/examples/tutorials/ex11f90.F.html">src/dm/examples/tutorials/ex11f90.F.html</A><BR>
    102. 

  102. <A HREF="../../../src/ksp/ksp/examples/tutorials/ex34.c.html">src/ksp/ksp/examples/tutorials/ex34.c.html</A><BR>
    103. 

  103. <A HREF="../../../src/ksp/ksp/examples/tutorials/ex42.c.html">src/ksp/ksp/examples/tutorials/ex42.c.html</A><BR>
    104. 

  104. <A HREF="../../../src/ksp/ksp/examples/tutorials/ex45.c.html">src/ksp/ksp/examples/tutorials/ex45.c.html</A><BR>
    105. 

  105. <A HREF="../../../src/ksp/ksp/examples/tutorials/ex22f.F.html">src/ksp/ksp/examples/tutorials/ex22f.F.html</A><BR>
    106. 

  106. <A HREF="../../../src/snes/examples/tutorials/ex14.c.html">src/snes/examples/tutorials/ex14.c.html</A><BR>
    107. 

  107. <A HREF="../../../src/snes/examples/tutorials/ex20.c.html">src/snes/examples/tutorials/ex20.c.html</A><BR>
    108. 

  108. <A HREF="../../../src/snes/examples/tutorials/ex48.c.html">src/snes/examples/tutorials/ex48.c.html</A><BR>
    109. 

  109. <A HREF="../../../src/snes/examples/tutorials/ex633D_DB.c.html">src/snes/examples/tutorials/ex633D_DB.c.html</A><BR>
    110. 

  110. <A HREF="../../../src/ts/examples/tutorials/ex14.c.html">src/ts/examples/tutorials/ex14.c.html</A><BR>
    111. 

  111. </BODY></HTML>
    112. 

  112.