petsc-3.10.5 2019-03-28

DMDACreate1d

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

Synopsis

#include "petscdmda.h"   
PetscErrorCode  DMDACreate1d(MPI_Comm comm, DMBoundaryType bx, PetscInt M, PetscInt dof, PetscInt s, const PetscInt lx[], DM *da)

Collective on MPI_Comm

Input Parameters

	comm	- MPI communicator
	bx	- type of ghost cells at the boundary the array should have, if any. Use DM_BOUNDARY_NONE, DM_BOUNDARY_GHOSTED, or DM_BOUNDARY_PERIODIC.
	M	- global dimension of the array (that is the number of grid points) from the command line with -da_grid_x <M>)
	dof	- number of degrees of freedom per node
	s	- stencil width
	lx	- 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 MPI_Comm. The sum of these entries must equal M

Output Parameter

da -the resulting distributed array object

Options Database Key

	-dm_view	- Calls DMView() at the conclusion of DMDACreate1d()
	-da_grid_x <nx>	- number of grid points in x direction
	-da_refine_x <rx>	- refinement factor
	-da_refine <n>	- refine the DMDA n times before creating it

Notes

The array data itself is NOT stored in the DMDA, it is stored in Vec objects; The appropriate vector objects can be obtained with calls to DMCreateGlobalVector() and DMCreateLocalVector() and calls to VecDuplicate() if more are needed.

You must call DMSetUp() after this call before using this DM.

If you wish to use the options database to change values in the DMDA call DMSetFromOptions() after this call but before DMSetUp().

Keywords

distributed array, create, one-dimensional

Level

beginner

Location

src/dm/impls/da/da1.c

Examples