xref: /petsc/src/dm/impls/da/da2.c (revision 8b0a50948724f1d2b06baec14a01c4a2cc1171db)
19a42bb27SBarry Smith 
2c6db04a5SJed Brown #include <private/daimpl.h>    /*I   "petscdmda.h"   I*/
347c6ae99SBarry Smith 
447c6ae99SBarry Smith #undef __FUNCT__
59a42bb27SBarry Smith #define __FUNCT__ "DMView_DA_2d"
69a42bb27SBarry Smith PetscErrorCode DMView_DA_2d(DM da,PetscViewer viewer)
747c6ae99SBarry Smith {
847c6ae99SBarry Smith   PetscErrorCode ierr;
947c6ae99SBarry Smith   PetscMPIInt    rank;
109a42bb27SBarry Smith   PetscBool      iascii,isdraw,isbinary;
1147c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
129a42bb27SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
139a42bb27SBarry Smith   PetscBool      ismatlab;
149a42bb27SBarry Smith #endif
1547c6ae99SBarry Smith 
1647c6ae99SBarry Smith   PetscFunctionBegin;
1747c6ae99SBarry Smith   ierr = MPI_Comm_rank(((PetscObject)da)->comm,&rank);CHKERRQ(ierr);
1847c6ae99SBarry Smith 
1947c6ae99SBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
2047c6ae99SBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
219a42bb27SBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
229a42bb27SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
239a42bb27SBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERMATLAB,&ismatlab);CHKERRQ(ierr);
249a42bb27SBarry Smith #endif
2547c6ae99SBarry Smith   if (iascii) {
2647c6ae99SBarry Smith     PetscViewerFormat format;
2747c6ae99SBarry Smith 
2847c6ae99SBarry Smith     ierr = PetscViewerGetFormat(viewer, &format);CHKERRQ(ierr);
2947c6ae99SBarry Smith     if (format != PETSC_VIEWER_ASCII_VTK && format != PETSC_VIEWER_ASCII_VTK_CELL) {
30aa219208SBarry Smith       DMDALocalInfo info;
31aa219208SBarry Smith       ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
327b23a99aSBarry Smith       ierr = PetscViewerASCIISynchronizedAllow(viewer,PETSC_TRUE);CHKERRQ(ierr);
3347c6ae99SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Processor [%d] M %D N %D m %D n %D w %D s %D\n",rank,dd->M,dd->N,dd->m,dd->n,dd->w,dd->s);CHKERRQ(ierr);
3447c6ae99SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"X range of indices: %D %D, Y range of indices: %D %D\n",info.xs,info.xs+info.xm,info.ys,info.ys+info.ym);CHKERRQ(ierr);
3547c6ae99SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
367b23a99aSBarry Smith       ierr = PetscViewerASCIISynchronizedAllow(viewer,PETSC_FALSE);CHKERRQ(ierr);
373da9ae13SJed Brown     } else {
383da9ae13SJed Brown       ierr = DMView_DA_VTK(da,viewer);CHKERRQ(ierr);
3947c6ae99SBarry Smith     }
4047c6ae99SBarry Smith   } else if (isdraw) {
4147c6ae99SBarry Smith     PetscDraw  draw;
4247c6ae99SBarry Smith     double     ymin = -1*dd->s-1,ymax = dd->N+dd->s;
4347c6ae99SBarry Smith     double     xmin = -1*dd->s-1,xmax = dd->M+dd->s;
4447c6ae99SBarry Smith     double     x,y;
4547c6ae99SBarry Smith     PetscInt   base,*idx;
4647c6ae99SBarry Smith     char       node[10];
4747c6ae99SBarry Smith     PetscBool  isnull;
4847c6ae99SBarry Smith 
4947c6ae99SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
5047c6ae99SBarry Smith     ierr = PetscDrawIsNull(draw,&isnull);CHKERRQ(ierr); if (isnull) PetscFunctionReturn(0);
5147c6ae99SBarry Smith     if (!dd->coordinates) {
5247c6ae99SBarry Smith       ierr = PetscDrawSetCoordinates(draw,xmin,ymin,xmax,ymax);CHKERRQ(ierr);
5347c6ae99SBarry Smith     }
5447c6ae99SBarry Smith     ierr = PetscDrawSynchronizedClear(draw);CHKERRQ(ierr);
5547c6ae99SBarry Smith 
5647c6ae99SBarry Smith     /* first processor draw all node lines */
5747c6ae99SBarry Smith     if (!rank) {
5847c6ae99SBarry Smith       ymin = 0.0; ymax = dd->N - 1;
5947c6ae99SBarry Smith       for (xmin=0; xmin<dd->M; xmin++) {
6047c6ae99SBarry Smith         ierr = PetscDrawLine(draw,xmin,ymin,xmin,ymax,PETSC_DRAW_BLACK);CHKERRQ(ierr);
6147c6ae99SBarry Smith       }
6247c6ae99SBarry Smith       xmin = 0.0; xmax = dd->M - 1;
6347c6ae99SBarry Smith       for (ymin=0; ymin<dd->N; ymin++) {
6447c6ae99SBarry Smith         ierr = PetscDrawLine(draw,xmin,ymin,xmax,ymin,PETSC_DRAW_BLACK);CHKERRQ(ierr);
6547c6ae99SBarry Smith       }
6647c6ae99SBarry Smith     }
6747c6ae99SBarry Smith     ierr = PetscDrawSynchronizedFlush(draw);CHKERRQ(ierr);
6847c6ae99SBarry Smith     ierr = PetscDrawPause(draw);CHKERRQ(ierr);
6947c6ae99SBarry Smith 
7047c6ae99SBarry Smith     /* draw my box */
7147c6ae99SBarry Smith     ymin = dd->ys; ymax = dd->ye - 1; xmin = dd->xs/dd->w;
7247c6ae99SBarry Smith     xmax =(dd->xe-1)/dd->w;
7347c6ae99SBarry Smith     ierr = PetscDrawLine(draw,xmin,ymin,xmax,ymin,PETSC_DRAW_RED);CHKERRQ(ierr);
7447c6ae99SBarry Smith     ierr = PetscDrawLine(draw,xmin,ymin,xmin,ymax,PETSC_DRAW_RED);CHKERRQ(ierr);
7547c6ae99SBarry Smith     ierr = PetscDrawLine(draw,xmin,ymax,xmax,ymax,PETSC_DRAW_RED);CHKERRQ(ierr);
7647c6ae99SBarry Smith     ierr = PetscDrawLine(draw,xmax,ymin,xmax,ymax,PETSC_DRAW_RED);CHKERRQ(ierr);
7747c6ae99SBarry Smith 
7847c6ae99SBarry Smith     /* put in numbers */
7947c6ae99SBarry Smith     base = (dd->base)/dd->w;
8047c6ae99SBarry Smith     for (y=ymin; y<=ymax; y++) {
8147c6ae99SBarry Smith       for (x=xmin; x<=xmax; x++) {
8247c6ae99SBarry Smith         sprintf(node,"%d",(int)base++);
8347c6ae99SBarry Smith         ierr = PetscDrawString(draw,x,y,PETSC_DRAW_BLACK,node);CHKERRQ(ierr);
8447c6ae99SBarry Smith       }
8547c6ae99SBarry Smith     }
8647c6ae99SBarry Smith 
8747c6ae99SBarry Smith     ierr = PetscDrawSynchronizedFlush(draw);CHKERRQ(ierr);
8847c6ae99SBarry Smith     ierr = PetscDrawPause(draw);CHKERRQ(ierr);
8947c6ae99SBarry Smith     /* overlay ghost numbers, useful for error checking */
9047c6ae99SBarry Smith     /* put in numbers */
9147c6ae99SBarry Smith 
9247c6ae99SBarry Smith     base = 0; idx = dd->idx;
9347c6ae99SBarry Smith     ymin = dd->Ys; ymax = dd->Ye; xmin = dd->Xs; xmax = dd->Xe;
9447c6ae99SBarry Smith     for (y=ymin; y<ymax; y++) {
9547c6ae99SBarry Smith       for (x=xmin; x<xmax; x++) {
9647c6ae99SBarry Smith         if ((base % dd->w) == 0) {
9747c6ae99SBarry Smith           sprintf(node,"%d",(int)(idx[base]/dd->w));
9847c6ae99SBarry Smith           ierr = PetscDrawString(draw,x/dd->w,y,PETSC_DRAW_BLUE,node);CHKERRQ(ierr);
9947c6ae99SBarry Smith         }
10047c6ae99SBarry Smith         base++;
10147c6ae99SBarry Smith       }
10247c6ae99SBarry Smith     }
10347c6ae99SBarry Smith     ierr = PetscDrawSynchronizedFlush(draw);CHKERRQ(ierr);
10447c6ae99SBarry Smith     ierr = PetscDrawPause(draw);CHKERRQ(ierr);
1059a42bb27SBarry Smith   } else if (isbinary){
1069a42bb27SBarry Smith     ierr = DMView_DA_Binary(da,viewer);CHKERRQ(ierr);
1079a42bb27SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
1089a42bb27SBarry Smith   } else if (ismatlab) {
1099a42bb27SBarry Smith     ierr = DMView_DA_Matlab(da,viewer);CHKERRQ(ierr);
1109a42bb27SBarry Smith #endif
111aa219208SBarry Smith   } else SETERRQ1(((PetscObject)da)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for DMDA 1d",((PetscObject)viewer)->type_name);
11247c6ae99SBarry Smith   PetscFunctionReturn(0);
11347c6ae99SBarry Smith }
11447c6ae99SBarry Smith 
11547c6ae99SBarry Smith /*
11647c6ae99SBarry Smith       M is number of grid points
11747c6ae99SBarry Smith       m is number of processors
11847c6ae99SBarry Smith 
11947c6ae99SBarry Smith */
12047c6ae99SBarry Smith #undef __FUNCT__
121aa219208SBarry Smith #define __FUNCT__ "DMDASplitComm2d"
1227087cfbeSBarry Smith PetscErrorCode  DMDASplitComm2d(MPI_Comm comm,PetscInt M,PetscInt N,PetscInt sw,MPI_Comm *outcomm)
12347c6ae99SBarry Smith {
12447c6ae99SBarry Smith   PetscErrorCode ierr;
12547c6ae99SBarry Smith   PetscInt       m,n = 0,x = 0,y = 0;
12647c6ae99SBarry Smith   PetscMPIInt    size,csize,rank;
12747c6ae99SBarry Smith 
12847c6ae99SBarry Smith   PetscFunctionBegin;
12947c6ae99SBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
13047c6ae99SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
13147c6ae99SBarry Smith 
13247c6ae99SBarry Smith   csize = 4*size;
13347c6ae99SBarry Smith   do {
13447c6ae99SBarry Smith     if (csize % 4) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Cannot split communicator of size %d tried %d %D %D",size,csize,x,y);
13547c6ae99SBarry Smith     csize   = csize/4;
13647c6ae99SBarry Smith 
13747c6ae99SBarry Smith     m = (PetscInt)(0.5 + sqrt(((double)M)*((double)csize)/((double)N)));
13847c6ae99SBarry Smith     if (!m) m = 1;
13947c6ae99SBarry Smith     while (m > 0) {
14047c6ae99SBarry Smith       n = csize/m;
14147c6ae99SBarry Smith       if (m*n == csize) break;
14247c6ae99SBarry Smith       m--;
14347c6ae99SBarry Smith     }
14447c6ae99SBarry Smith     if (M > N && m < n) {PetscInt _m = m; m = n; n = _m;}
14547c6ae99SBarry Smith 
14647c6ae99SBarry Smith     x = M/m + ((M % m) > ((csize-1) % m));
14747c6ae99SBarry Smith     y = (N + (csize-1)/m)/n;
14847c6ae99SBarry Smith   } while ((x < 4 || y < 4) && csize > 1);
14947c6ae99SBarry Smith   if (size != csize) {
15047c6ae99SBarry Smith     MPI_Group    entire_group,sub_group;
15147c6ae99SBarry Smith     PetscMPIInt  i,*groupies;
15247c6ae99SBarry Smith 
15347c6ae99SBarry Smith     ierr = MPI_Comm_group(comm,&entire_group);CHKERRQ(ierr);
15447c6ae99SBarry Smith     ierr = PetscMalloc(csize*sizeof(PetscInt),&groupies);CHKERRQ(ierr);
15547c6ae99SBarry Smith     for (i=0; i<csize; i++) {
15647c6ae99SBarry Smith       groupies[i] = (rank/csize)*csize + i;
15747c6ae99SBarry Smith     }
15847c6ae99SBarry Smith     ierr = MPI_Group_incl(entire_group,csize,groupies,&sub_group);CHKERRQ(ierr);
15947c6ae99SBarry Smith     ierr = PetscFree(groupies);CHKERRQ(ierr);
16047c6ae99SBarry Smith     ierr = MPI_Comm_create(comm,sub_group,outcomm);CHKERRQ(ierr);
16147c6ae99SBarry Smith     ierr = MPI_Group_free(&entire_group);CHKERRQ(ierr);
16247c6ae99SBarry Smith     ierr = MPI_Group_free(&sub_group);CHKERRQ(ierr);
163aa219208SBarry Smith     ierr = PetscInfo1(0,"DMDASplitComm2d:Creating redundant coarse problems of size %d\n",csize);CHKERRQ(ierr);
16447c6ae99SBarry Smith   } else {
16547c6ae99SBarry Smith     *outcomm = comm;
16647c6ae99SBarry Smith   }
16747c6ae99SBarry Smith   PetscFunctionReturn(0);
16847c6ae99SBarry Smith }
16947c6ae99SBarry Smith 
17047c6ae99SBarry Smith #undef __FUNCT__
171644e2e5bSBarry Smith #define __FUNCT__ "DMDAFunction"
172644e2e5bSBarry Smith static PetscErrorCode DMDAFunction(DM dm,Vec x,Vec F)
173644e2e5bSBarry Smith {
174644e2e5bSBarry Smith   PetscErrorCode ierr;
175644e2e5bSBarry Smith   Vec            localX;
176644e2e5bSBarry Smith 
177644e2e5bSBarry Smith   PetscFunctionBegin;
178644e2e5bSBarry Smith   ierr = DMGetLocalVector(dm,&localX);CHKERRQ(ierr);
179644e2e5bSBarry Smith   ierr = DMGlobalToLocalBegin(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
180644e2e5bSBarry Smith   ierr = DMGlobalToLocalEnd(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
181644e2e5bSBarry Smith   ierr = DMDAFormFunction1(dm,localX,F,dm->ctx);CHKERRQ(ierr);
182644e2e5bSBarry Smith   ierr = DMRestoreLocalVector(dm,&localX);CHKERRQ(ierr);
183644e2e5bSBarry Smith   PetscFunctionReturn(0);
184644e2e5bSBarry Smith }
185644e2e5bSBarry Smith 
186644e2e5bSBarry Smith #undef __FUNCT__
187aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalFunction"
18847c6ae99SBarry Smith /*@C
189aa219208SBarry Smith        DMDASetLocalFunction - Caches in a DM a local function.
19047c6ae99SBarry Smith 
191aa219208SBarry Smith    Logically Collective on DMDA
19247c6ae99SBarry Smith 
19347c6ae99SBarry Smith    Input Parameter:
19447c6ae99SBarry Smith +  da - initial distributed array
19547c6ae99SBarry Smith -  lf - the local function
19647c6ae99SBarry Smith 
19747c6ae99SBarry Smith    Level: intermediate
19847c6ae99SBarry Smith 
19947c6ae99SBarry Smith    Notes: The routine SNESDAFormFunction() uses this the cached function to evaluate the user provided function.
20047c6ae99SBarry Smith 
20147c6ae99SBarry Smith .keywords:  distributed array, refine
20247c6ae99SBarry Smith 
203aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunctioni()
20447c6ae99SBarry Smith @*/
2057087cfbeSBarry Smith PetscErrorCode  DMDASetLocalFunction(DM da,DMDALocalFunction1 lf)
20647c6ae99SBarry Smith {
207644e2e5bSBarry Smith   PetscErrorCode ierr;
20847c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
209644e2e5bSBarry Smith 
21047c6ae99SBarry Smith   PetscFunctionBegin;
21147c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
212644e2e5bSBarry Smith   ierr = DMSetFunction(da,DMDAFunction);CHKERRQ(ierr);
21347c6ae99SBarry Smith   dd->lf       = lf;
21447c6ae99SBarry Smith   PetscFunctionReturn(0);
21547c6ae99SBarry Smith }
21647c6ae99SBarry Smith 
21747c6ae99SBarry Smith #undef __FUNCT__
218aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalFunctioni"
21947c6ae99SBarry Smith /*@C
220aa219208SBarry Smith        DMDASetLocalFunctioni - Caches in a DM a local function that evaluates a single component
22147c6ae99SBarry Smith 
222aa219208SBarry Smith    Logically Collective on DMDA
22347c6ae99SBarry Smith 
22447c6ae99SBarry Smith    Input Parameter:
22547c6ae99SBarry Smith +  da - initial distributed array
22647c6ae99SBarry Smith -  lfi - the local function
22747c6ae99SBarry Smith 
22847c6ae99SBarry Smith    Level: intermediate
22947c6ae99SBarry Smith 
23047c6ae99SBarry Smith .keywords:  distributed array, refine
23147c6ae99SBarry Smith 
232aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction()
23347c6ae99SBarry Smith @*/
2347087cfbeSBarry Smith PetscErrorCode  DMDASetLocalFunctioni(DM da,PetscErrorCode (*lfi)(DMDALocalInfo*,MatStencil*,void*,PetscScalar*,void*))
23547c6ae99SBarry Smith {
23647c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
23747c6ae99SBarry Smith   PetscFunctionBegin;
23847c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
23947c6ae99SBarry Smith   dd->lfi = lfi;
24047c6ae99SBarry Smith   PetscFunctionReturn(0);
24147c6ae99SBarry Smith }
24247c6ae99SBarry Smith 
24347c6ae99SBarry Smith #undef __FUNCT__
244aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalFunctionib"
24547c6ae99SBarry Smith /*@C
246aa219208SBarry Smith        DMDASetLocalFunctionib - Caches in a DM a block local function that evaluates a single component
24747c6ae99SBarry Smith 
248aa219208SBarry Smith    Logically Collective on DMDA
24947c6ae99SBarry Smith 
25047c6ae99SBarry Smith    Input Parameter:
25147c6ae99SBarry Smith +  da - initial distributed array
25247c6ae99SBarry Smith -  lfi - the local function
25347c6ae99SBarry Smith 
25447c6ae99SBarry Smith    Level: intermediate
25547c6ae99SBarry Smith 
25647c6ae99SBarry Smith .keywords:  distributed array, refine
25747c6ae99SBarry Smith 
258aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction()
25947c6ae99SBarry Smith @*/
2607087cfbeSBarry Smith PetscErrorCode  DMDASetLocalFunctionib(DM da,PetscErrorCode (*lfi)(DMDALocalInfo*,MatStencil*,void*,PetscScalar*,void*))
26147c6ae99SBarry Smith {
26247c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
26347c6ae99SBarry Smith   PetscFunctionBegin;
26447c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
26547c6ae99SBarry Smith   dd->lfib = lfi;
26647c6ae99SBarry Smith   PetscFunctionReturn(0);
26747c6ae99SBarry Smith }
26847c6ae99SBarry Smith 
26947c6ae99SBarry Smith #undef __FUNCT__
270aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicFunction_Private"
271aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicFunction_Private(DM da,DMDALocalFunction1 ad_lf)
27247c6ae99SBarry Smith {
27347c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
27447c6ae99SBarry Smith   PetscFunctionBegin;
27547c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
27647c6ae99SBarry Smith   dd->adic_lf = ad_lf;
27747c6ae99SBarry Smith   PetscFunctionReturn(0);
27847c6ae99SBarry Smith }
27947c6ae99SBarry Smith 
28047c6ae99SBarry Smith /*MC
281aa219208SBarry Smith        DMDASetLocalAdicFunctioni - Caches in a DM a local functioni computed by ADIC/ADIFOR
28247c6ae99SBarry Smith 
28347c6ae99SBarry Smith    Synopsis:
284aa219208SBarry Smith    PetscErrorCode DMDASetLocalAdicFunctioni(DM da,PetscInt (ad_lf*)(DMDALocalInfo*,MatStencil*,void*,void*,void*)
28547c6ae99SBarry Smith 
286aa219208SBarry Smith    Logically Collective on DMDA
28747c6ae99SBarry Smith 
28847c6ae99SBarry Smith    Input Parameter:
28947c6ae99SBarry Smith +  da - initial distributed array
29047c6ae99SBarry Smith -  ad_lfi - the local function as computed by ADIC/ADIFOR
29147c6ae99SBarry Smith 
29247c6ae99SBarry Smith    Level: intermediate
29347c6ae99SBarry Smith 
29447c6ae99SBarry Smith .keywords:  distributed array, refine
29547c6ae99SBarry Smith 
296aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction(),
297aa219208SBarry Smith           DMDASetLocalJacobian(), DMDASetLocalFunctioni()
29847c6ae99SBarry Smith M*/
29947c6ae99SBarry Smith 
30047c6ae99SBarry Smith #undef __FUNCT__
301aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicFunctioni_Private"
302aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicFunctioni_Private(DM da,PetscErrorCode (*ad_lfi)(DMDALocalInfo*,MatStencil*,void*,void*,void*))
30347c6ae99SBarry Smith {
30447c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
30547c6ae99SBarry Smith   PetscFunctionBegin;
30647c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
30747c6ae99SBarry Smith   dd->adic_lfi = ad_lfi;
30847c6ae99SBarry Smith   PetscFunctionReturn(0);
30947c6ae99SBarry Smith }
31047c6ae99SBarry Smith 
31147c6ae99SBarry Smith /*MC
312aa219208SBarry Smith        DMDASetLocalAdicMFFunctioni - Caches in a DM a local functioni computed by ADIC/ADIFOR
31347c6ae99SBarry Smith 
31447c6ae99SBarry Smith    Synopsis:
315aa219208SBarry Smith    PetscErrorCode  DMDASetLocalAdicFunctioni(DM da,int (ad_lf*)(DMDALocalInfo*,MatStencil*,void*,void*,void*)
31647c6ae99SBarry Smith 
317aa219208SBarry Smith    Logically Collective on DMDA
31847c6ae99SBarry Smith 
31947c6ae99SBarry Smith    Input Parameter:
32047c6ae99SBarry Smith +  da - initial distributed array
32147c6ae99SBarry Smith -  admf_lfi - the local matrix-free function as computed by ADIC/ADIFOR
32247c6ae99SBarry Smith 
32347c6ae99SBarry Smith    Level: intermediate
32447c6ae99SBarry Smith 
32547c6ae99SBarry Smith .keywords:  distributed array, refine
32647c6ae99SBarry Smith 
327aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction(),
328aa219208SBarry Smith           DMDASetLocalJacobian(), DMDASetLocalFunctioni()
32947c6ae99SBarry Smith M*/
33047c6ae99SBarry Smith 
33147c6ae99SBarry Smith #undef __FUNCT__
332aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicMFFunctioni_Private"
333aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicMFFunctioni_Private(DM da,PetscErrorCode (*admf_lfi)(DMDALocalInfo*,MatStencil*,void*,void*,void*))
33447c6ae99SBarry Smith {
33547c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
33647c6ae99SBarry Smith   PetscFunctionBegin;
33747c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
33847c6ae99SBarry Smith   dd->adicmf_lfi = admf_lfi;
33947c6ae99SBarry Smith   PetscFunctionReturn(0);
34047c6ae99SBarry Smith }
34147c6ae99SBarry Smith 
34247c6ae99SBarry Smith /*MC
343aa219208SBarry Smith        DMDASetLocalAdicFunctionib - Caches in a DM a block local functioni computed by ADIC/ADIFOR
34447c6ae99SBarry Smith 
34547c6ae99SBarry Smith    Synopsis:
346aa219208SBarry Smith    PetscErrorCode DMDASetLocalAdicFunctionib(DM da,PetscInt (ad_lf*)(DMDALocalInfo*,MatStencil*,void*,void*,void*)
34747c6ae99SBarry Smith 
348aa219208SBarry Smith    Logically Collective on DMDA
34947c6ae99SBarry Smith 
35047c6ae99SBarry Smith    Input Parameter:
35147c6ae99SBarry Smith +  da - initial distributed array
35247c6ae99SBarry Smith -  ad_lfi - the local function as computed by ADIC/ADIFOR
35347c6ae99SBarry Smith 
35447c6ae99SBarry Smith    Level: intermediate
35547c6ae99SBarry Smith 
35647c6ae99SBarry Smith .keywords:  distributed array, refine
35747c6ae99SBarry Smith 
358aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction(),
359aa219208SBarry Smith           DMDASetLocalJacobian(), DMDASetLocalFunctionib()
36047c6ae99SBarry Smith M*/
36147c6ae99SBarry Smith 
36247c6ae99SBarry Smith #undef __FUNCT__
363aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicFunctionib_Private"
364aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicFunctionib_Private(DM da,PetscErrorCode (*ad_lfi)(DMDALocalInfo*,MatStencil*,void*,void*,void*))
36547c6ae99SBarry Smith {
36647c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
36747c6ae99SBarry Smith   PetscFunctionBegin;
36847c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
36947c6ae99SBarry Smith   dd->adic_lfib = ad_lfi;
37047c6ae99SBarry Smith   PetscFunctionReturn(0);
37147c6ae99SBarry Smith }
37247c6ae99SBarry Smith 
37347c6ae99SBarry Smith /*MC
374aa219208SBarry Smith        DMDASetLocalAdicMFFunctionib - Caches in a DM a block local functioni computed by ADIC/ADIFOR
37547c6ae99SBarry Smith 
37647c6ae99SBarry Smith    Synopsis:
377aa219208SBarry Smith    PetscErrorCode  DMDASetLocalAdicFunctionib(DM da,int (ad_lf*)(DMDALocalInfo*,MatStencil*,void*,void*,void*)
37847c6ae99SBarry Smith 
379aa219208SBarry Smith    Logically Collective on DMDA
38047c6ae99SBarry Smith 
38147c6ae99SBarry Smith    Input Parameter:
38247c6ae99SBarry Smith +  da - initial distributed array
38347c6ae99SBarry Smith -  admf_lfi - the local matrix-free function as computed by ADIC/ADIFOR
38447c6ae99SBarry Smith 
38547c6ae99SBarry Smith    Level: intermediate
38647c6ae99SBarry Smith 
38747c6ae99SBarry Smith .keywords:  distributed array, refine
38847c6ae99SBarry Smith 
389aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction(),
390aa219208SBarry Smith           DMDASetLocalJacobian(), DMDASetLocalFunctionib()
39147c6ae99SBarry Smith M*/
39247c6ae99SBarry Smith 
39347c6ae99SBarry Smith #undef __FUNCT__
394aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicMFFunctionib_Private"
395aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicMFFunctionib_Private(DM da,PetscErrorCode (*admf_lfi)(DMDALocalInfo*,MatStencil*,void*,void*,void*))
39647c6ae99SBarry Smith {
39747c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
39847c6ae99SBarry Smith   PetscFunctionBegin;
39947c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
40047c6ae99SBarry Smith   dd->adicmf_lfib = admf_lfi;
40147c6ae99SBarry Smith   PetscFunctionReturn(0);
40247c6ae99SBarry Smith }
40347c6ae99SBarry Smith 
40447c6ae99SBarry Smith /*MC
405aa219208SBarry Smith        DMDASetLocalAdicMFFunction - Caches in a DM a local function computed by ADIC/ADIFOR
40647c6ae99SBarry Smith 
40747c6ae99SBarry Smith    Synopsis:
408aa219208SBarry Smith    PetscErrorCode DMDASetLocalAdicMFFunction(DM da,DMDALocalFunction1 ad_lf)
40947c6ae99SBarry Smith 
410aa219208SBarry Smith    Logically Collective on DMDA
41147c6ae99SBarry Smith 
41247c6ae99SBarry Smith    Input Parameter:
41347c6ae99SBarry Smith +  da - initial distributed array
41447c6ae99SBarry Smith -  ad_lf - the local function as computed by ADIC/ADIFOR
41547c6ae99SBarry Smith 
41647c6ae99SBarry Smith    Level: intermediate
41747c6ae99SBarry Smith 
41847c6ae99SBarry Smith .keywords:  distributed array, refine
41947c6ae99SBarry Smith 
420aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction(),
421aa219208SBarry Smith           DMDASetLocalJacobian()
42247c6ae99SBarry Smith M*/
42347c6ae99SBarry Smith 
42447c6ae99SBarry Smith #undef __FUNCT__
425aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalAdicMFFunction_Private"
426aa219208SBarry Smith PetscErrorCode DMDASetLocalAdicMFFunction_Private(DM da,DMDALocalFunction1 ad_lf)
42747c6ae99SBarry Smith {
42847c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
42947c6ae99SBarry Smith   PetscFunctionBegin;
43047c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
43147c6ae99SBarry Smith   dd->adicmf_lf = ad_lf;
43247c6ae99SBarry Smith   PetscFunctionReturn(0);
43347c6ae99SBarry Smith }
43447c6ae99SBarry Smith 
435644e2e5bSBarry Smith #undef __FUNCT__
4362533e041SBarry Smith #define __FUNCT__ "DMDAJacobianDefaultLocal"
4372533e041SBarry Smith PetscErrorCode DMDAJacobianLocal(DM dm,Vec x,Mat A,Mat B, MatStructure *str)
4382533e041SBarry Smith {
4392533e041SBarry Smith   PetscErrorCode ierr;
4402533e041SBarry Smith   Vec            localX;
4412533e041SBarry Smith 
4422533e041SBarry Smith   PetscFunctionBegin;
4432533e041SBarry Smith   ierr = DMGetLocalVector(dm,&localX);CHKERRQ(ierr);
4442533e041SBarry Smith   ierr = DMGlobalToLocalBegin(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
4452533e041SBarry Smith   ierr = DMGlobalToLocalEnd(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
4462533e041SBarry Smith   ierr = MatFDColoringApply(B,dm->fd,localX,str,dm);CHKERRQ(ierr);
4472533e041SBarry Smith   ierr = DMRestoreLocalVector(dm,&localX);CHKERRQ(ierr);
4482533e041SBarry Smith   /* Assemble true Jacobian; if it is different */
4492533e041SBarry Smith   if (A != B) {
4502533e041SBarry Smith     ierr  = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4512533e041SBarry Smith     ierr  = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
4522533e041SBarry Smith   }
4532533e041SBarry Smith   ierr  = MatSetOption(B,MAT_NEW_NONZERO_LOCATION_ERR,PETSC_TRUE);CHKERRQ(ierr);
4542533e041SBarry Smith   *str = SAME_NONZERO_PATTERN;
4552533e041SBarry Smith   PetscFunctionReturn(0);
4562533e041SBarry Smith }
4572533e041SBarry Smith 
4582533e041SBarry Smith 
4592533e041SBarry Smith #undef __FUNCT__
460644e2e5bSBarry Smith #define __FUNCT__ "DMDAJacobian"
461644e2e5bSBarry Smith static PetscErrorCode DMDAJacobian(DM dm,Vec x,Mat A,Mat B, MatStructure *str)
462644e2e5bSBarry Smith {
463644e2e5bSBarry Smith   PetscErrorCode ierr;
464644e2e5bSBarry Smith   Vec            localX;
465644e2e5bSBarry Smith 
466644e2e5bSBarry Smith   PetscFunctionBegin;
467644e2e5bSBarry Smith   ierr = DMGetLocalVector(dm,&localX);CHKERRQ(ierr);
468644e2e5bSBarry Smith   ierr = DMGlobalToLocalBegin(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
469644e2e5bSBarry Smith   ierr = DMGlobalToLocalEnd(dm,x,INSERT_VALUES,localX);CHKERRQ(ierr);
470644e2e5bSBarry Smith   ierr = DMDAComputeJacobian1(dm,localX,B,dm->ctx);CHKERRQ(ierr);
471644e2e5bSBarry Smith   ierr = DMRestoreLocalVector(dm,&localX);CHKERRQ(ierr);
472644e2e5bSBarry Smith   /* Assemble true Jacobian; if it is different */
473644e2e5bSBarry Smith   if (A != B) {
474644e2e5bSBarry Smith     ierr  = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
475644e2e5bSBarry Smith     ierr  = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
476644e2e5bSBarry Smith   }
477644e2e5bSBarry Smith   ierr  = MatSetOption(B,MAT_NEW_NONZERO_LOCATION_ERR,PETSC_TRUE);CHKERRQ(ierr);
478644e2e5bSBarry Smith   *str = SAME_NONZERO_PATTERN;
479644e2e5bSBarry Smith   PetscFunctionReturn(0);
480644e2e5bSBarry Smith }
481644e2e5bSBarry Smith 
48247c6ae99SBarry Smith /*@C
483aa219208SBarry Smith        DMDASetLocalJacobian - Caches in a DM a local Jacobian computation function
48447c6ae99SBarry Smith 
485aa219208SBarry Smith    Logically Collective on DMDA
48647c6ae99SBarry Smith 
48747c6ae99SBarry Smith 
48847c6ae99SBarry Smith    Input Parameter:
48947c6ae99SBarry Smith +  da - initial distributed array
49047c6ae99SBarry Smith -  lj - the local Jacobian
49147c6ae99SBarry Smith 
49247c6ae99SBarry Smith    Level: intermediate
49347c6ae99SBarry Smith 
49447c6ae99SBarry Smith    Notes: The routine SNESDAFormFunction() uses this the cached function to evaluate the user provided function.
49547c6ae99SBarry Smith 
49647c6ae99SBarry Smith .keywords:  distributed array, refine
49747c6ae99SBarry Smith 
498aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalFunction()
49947c6ae99SBarry Smith @*/
50047c6ae99SBarry Smith #undef __FUNCT__
501aa219208SBarry Smith #define __FUNCT__ "DMDASetLocalJacobian"
5027087cfbeSBarry Smith PetscErrorCode  DMDASetLocalJacobian(DM da,DMDALocalFunction1 lj)
50347c6ae99SBarry Smith {
504644e2e5bSBarry Smith   PetscErrorCode ierr;
50547c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
506644e2e5bSBarry Smith 
50747c6ae99SBarry Smith   PetscFunctionBegin;
50847c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
509644e2e5bSBarry Smith   ierr = DMSetJacobian(da,DMDAJacobian);CHKERRQ(ierr);
51047c6ae99SBarry Smith   dd->lj    = lj;
51147c6ae99SBarry Smith   PetscFunctionReturn(0);
51247c6ae99SBarry Smith }
51347c6ae99SBarry Smith 
51447c6ae99SBarry Smith #undef __FUNCT__
515aa219208SBarry Smith #define __FUNCT__ "DMDAGetLocalFunction"
51647c6ae99SBarry Smith /*@C
517aa219208SBarry Smith        DMDAGetLocalFunction - Gets from a DM a local function and its ADIC/ADIFOR Jacobian
51847c6ae99SBarry Smith 
51947c6ae99SBarry Smith    Note Collective
52047c6ae99SBarry Smith 
52147c6ae99SBarry Smith    Input Parameter:
52247c6ae99SBarry Smith .  da - initial distributed array
52347c6ae99SBarry Smith 
52447c6ae99SBarry Smith    Output Parameter:
52547c6ae99SBarry Smith .  lf - the local function
52647c6ae99SBarry Smith 
52747c6ae99SBarry Smith    Level: intermediate
52847c6ae99SBarry Smith 
52947c6ae99SBarry Smith .keywords:  distributed array, refine
53047c6ae99SBarry Smith 
531aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalJacobian(), DMDASetLocalFunction()
53247c6ae99SBarry Smith @*/
5337087cfbeSBarry Smith PetscErrorCode  DMDAGetLocalFunction(DM da,DMDALocalFunction1 *lf)
53447c6ae99SBarry Smith {
53547c6ae99SBarry Smith   DM_DA *dd = (DM_DA*)da->data;
53647c6ae99SBarry Smith   PetscFunctionBegin;
53747c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
53847c6ae99SBarry Smith   if (lf) *lf = dd->lf;
53947c6ae99SBarry Smith   PetscFunctionReturn(0);
54047c6ae99SBarry Smith }
54147c6ae99SBarry Smith 
54247c6ae99SBarry Smith #undef __FUNCT__
543aa219208SBarry Smith #define __FUNCT__ "DMDAGetLocalJacobian"
54447c6ae99SBarry Smith /*@C
545aa219208SBarry Smith        DMDAGetLocalJacobian - Gets from a DM a local jacobian
54647c6ae99SBarry Smith 
54747c6ae99SBarry Smith    Not Collective
54847c6ae99SBarry Smith 
54947c6ae99SBarry Smith    Input Parameter:
55047c6ae99SBarry Smith .  da - initial distributed array
55147c6ae99SBarry Smith 
55247c6ae99SBarry Smith    Output Parameter:
55347c6ae99SBarry Smith .  lj - the local jacobian
55447c6ae99SBarry Smith 
55547c6ae99SBarry Smith    Level: intermediate
55647c6ae99SBarry Smith 
55747c6ae99SBarry Smith .keywords:  distributed array, refine
55847c6ae99SBarry Smith 
559aa219208SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDestroy(), DMDAGetLocalFunction(), DMDASetLocalJacobian()
56047c6ae99SBarry Smith @*/
5617087cfbeSBarry Smith PetscErrorCode  DMDAGetLocalJacobian(DM da,DMDALocalFunction1 *lj)
56247c6ae99SBarry Smith {
56347c6ae99SBarry Smith   DM_DA *dd = (DM_DA*)da->data;
56447c6ae99SBarry Smith   PetscFunctionBegin;
56547c6ae99SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
56647c6ae99SBarry Smith   if (lj) *lj = dd->lj;
56747c6ae99SBarry Smith   PetscFunctionReturn(0);
56847c6ae99SBarry Smith }
56947c6ae99SBarry Smith 
57047c6ae99SBarry Smith #undef __FUNCT__
571aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunction"
57247c6ae99SBarry Smith /*@
573aa219208SBarry Smith     DMDAFormFunction - Evaluates a user provided function on each processor that
574aa219208SBarry Smith         share a DMDA
57547c6ae99SBarry Smith 
57647c6ae99SBarry Smith    Input Parameters:
5779a42bb27SBarry Smith +    da - the DM that defines the grid
57847c6ae99SBarry Smith .    vu - input vector
57947c6ae99SBarry Smith .    vfu - output vector
58047c6ae99SBarry Smith -    w - any user data
58147c6ae99SBarry Smith 
58247c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
58347c6ae99SBarry Smith 
584aa219208SBarry Smith            This should eventually replace DMDAFormFunction1
58547c6ae99SBarry Smith 
58647c6ae99SBarry Smith     Level: advanced
58747c6ae99SBarry Smith 
588aa219208SBarry Smith .seealso: DMDAComputeJacobian1WithAdic()
58947c6ae99SBarry Smith 
59047c6ae99SBarry Smith @*/
5917087cfbeSBarry Smith PetscErrorCode  DMDAFormFunction(DM da,PetscErrorCode (*lf)(void),Vec vu,Vec vfu,void *w)
59247c6ae99SBarry Smith {
59347c6ae99SBarry Smith   PetscErrorCode ierr;
59447c6ae99SBarry Smith   void           *u,*fu;
595aa219208SBarry Smith   DMDALocalInfo  info;
596aa219208SBarry Smith   PetscErrorCode (*f)(DMDALocalInfo*,void*,void*,void*) = (PetscErrorCode (*)(DMDALocalInfo*,void*,void*,void*))lf;
59747c6ae99SBarry Smith 
59847c6ae99SBarry Smith   PetscFunctionBegin;
599aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
600aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vu,&u);CHKERRQ(ierr);
601aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vfu,&fu);CHKERRQ(ierr);
60247c6ae99SBarry Smith 
60339d508bbSBarry Smith   ierr = (*f)(&info,u,fu,w);CHKERRQ(ierr);
60447c6ae99SBarry Smith 
605aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vu,&u);CHKERRQ(ierr);
606aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vfu,&fu);CHKERRQ(ierr);
60747c6ae99SBarry Smith   PetscFunctionReturn(0);
60847c6ae99SBarry Smith }
60947c6ae99SBarry Smith 
61047c6ae99SBarry Smith #undef __FUNCT__
611aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunctionLocal"
61247c6ae99SBarry Smith /*@C
613aa219208SBarry Smith    DMDAFormFunctionLocal - This is a universal function evaluation routine for
6149a42bb27SBarry Smith    a local DM function.
61547c6ae99SBarry Smith 
616aa219208SBarry Smith    Collective on DMDA
61747c6ae99SBarry Smith 
61847c6ae99SBarry Smith    Input Parameters:
6199a42bb27SBarry Smith +  da - the DM context
62047c6ae99SBarry Smith .  func - The local function
62147c6ae99SBarry Smith .  X - input vector
62247c6ae99SBarry Smith .  F - function vector
62347c6ae99SBarry Smith -  ctx - A user context
62447c6ae99SBarry Smith 
62547c6ae99SBarry Smith    Level: intermediate
62647c6ae99SBarry Smith 
627aa219208SBarry Smith .seealso: DMDASetLocalFunction(), DMDASetLocalJacobian(), DMDASetLocalAdicFunction(), DMDASetLocalAdicMFFunction(),
62847c6ae99SBarry Smith           SNESSetFunction(), SNESSetJacobian()
62947c6ae99SBarry Smith 
63047c6ae99SBarry Smith @*/
6317087cfbeSBarry Smith PetscErrorCode  DMDAFormFunctionLocal(DM da, DMDALocalFunction1 func, Vec X, Vec F, void *ctx)
63247c6ae99SBarry Smith {
63347c6ae99SBarry Smith   Vec            localX;
634aa219208SBarry Smith   DMDALocalInfo  info;
63547c6ae99SBarry Smith   void           *u;
63647c6ae99SBarry Smith   void           *fu;
63747c6ae99SBarry Smith   PetscErrorCode ierr;
63847c6ae99SBarry Smith 
63947c6ae99SBarry Smith   PetscFunctionBegin;
6409a42bb27SBarry Smith   ierr = DMGetLocalVector(da,&localX);CHKERRQ(ierr);
64147c6ae99SBarry Smith   /*
64247c6ae99SBarry Smith      Scatter ghost points to local vector, using the 2-step process
6439a42bb27SBarry Smith         DMGlobalToLocalBegin(), DMGlobalToLocalEnd().
64447c6ae99SBarry Smith   */
6459a42bb27SBarry Smith   ierr = DMGlobalToLocalBegin(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
6469a42bb27SBarry Smith   ierr = DMGlobalToLocalEnd(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
647aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
648aa219208SBarry Smith   ierr = DMDAVecGetArray(da,localX,&u);CHKERRQ(ierr);
649aa219208SBarry Smith   ierr = DMDAVecGetArray(da,F,&fu);CHKERRQ(ierr);
65039d508bbSBarry Smith   ierr = (*func)(&info,u,fu,ctx);CHKERRQ(ierr);
651aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,localX,&u);CHKERRQ(ierr);
652aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,F,&fu);CHKERRQ(ierr);
6539a42bb27SBarry Smith   ierr = DMRestoreLocalVector(da,&localX);CHKERRQ(ierr);
65447c6ae99SBarry Smith   PetscFunctionReturn(0);
65547c6ae99SBarry Smith }
65647c6ae99SBarry Smith 
65747c6ae99SBarry Smith #undef __FUNCT__
658aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunctionLocalGhost"
65947c6ae99SBarry Smith /*@C
660aa219208SBarry Smith    DMDAFormFunctionLocalGhost - This is a universal function evaluation routine for
6619a42bb27SBarry Smith    a local DM function, but the ghost values of the output are communicated and added.
66247c6ae99SBarry Smith 
663aa219208SBarry Smith    Collective on DMDA
66447c6ae99SBarry Smith 
66547c6ae99SBarry Smith    Input Parameters:
6669a42bb27SBarry Smith +  da - the DM context
66747c6ae99SBarry Smith .  func - The local function
66847c6ae99SBarry Smith .  X - input vector
66947c6ae99SBarry Smith .  F - function vector
67047c6ae99SBarry Smith -  ctx - A user context
67147c6ae99SBarry Smith 
67247c6ae99SBarry Smith    Level: intermediate
67347c6ae99SBarry Smith 
674aa219208SBarry Smith .seealso: DMDASetLocalFunction(), DMDASetLocalJacobian(), DMDASetLocalAdicFunction(), DMDASetLocalAdicMFFunction(),
67547c6ae99SBarry Smith           SNESSetFunction(), SNESSetJacobian()
67647c6ae99SBarry Smith 
67747c6ae99SBarry Smith @*/
6787087cfbeSBarry Smith PetscErrorCode  DMDAFormFunctionLocalGhost(DM da, DMDALocalFunction1 func, Vec X, Vec F, void *ctx)
67947c6ae99SBarry Smith {
68047c6ae99SBarry Smith   Vec            localX, localF;
681aa219208SBarry Smith   DMDALocalInfo  info;
68247c6ae99SBarry Smith   void           *u;
68347c6ae99SBarry Smith   void           *fu;
68447c6ae99SBarry Smith   PetscErrorCode ierr;
68547c6ae99SBarry Smith 
68647c6ae99SBarry Smith   PetscFunctionBegin;
6879a42bb27SBarry Smith   ierr = DMGetLocalVector(da,&localX);CHKERRQ(ierr);
6889a42bb27SBarry Smith   ierr = DMGetLocalVector(da,&localF);CHKERRQ(ierr);
68947c6ae99SBarry Smith   /*
69047c6ae99SBarry Smith      Scatter ghost points to local vector, using the 2-step process
6919a42bb27SBarry Smith         DMGlobalToLocalBegin(), DMGlobalToLocalEnd().
69247c6ae99SBarry Smith   */
6939a42bb27SBarry Smith   ierr = DMGlobalToLocalBegin(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
6949a42bb27SBarry Smith   ierr = DMGlobalToLocalEnd(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
69547c6ae99SBarry Smith   ierr = VecSet(F, 0.0);CHKERRQ(ierr);
69647c6ae99SBarry Smith   ierr = VecSet(localF, 0.0);CHKERRQ(ierr);
697aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
698aa219208SBarry Smith   ierr = DMDAVecGetArray(da,localX,&u);CHKERRQ(ierr);
699aa219208SBarry Smith   ierr = DMDAVecGetArray(da,localF,&fu);CHKERRQ(ierr);
70039d508bbSBarry Smith   ierr = (*func)(&info,u,fu,ctx);CHKERRQ(ierr);
7019a42bb27SBarry Smith   ierr = DMLocalToGlobalBegin(da,localF,ADD_VALUES,F);CHKERRQ(ierr);
7029a42bb27SBarry Smith   ierr = DMLocalToGlobalEnd(da,localF,ADD_VALUES,F);CHKERRQ(ierr);
703aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,localX,&u);CHKERRQ(ierr);
704aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,localF,&fu);CHKERRQ(ierr);
7059a42bb27SBarry Smith   ierr = DMRestoreLocalVector(da,&localX);CHKERRQ(ierr);
7069a42bb27SBarry Smith   ierr = DMRestoreLocalVector(da,&localF);CHKERRQ(ierr);
70747c6ae99SBarry Smith   PetscFunctionReturn(0);
70847c6ae99SBarry Smith }
70947c6ae99SBarry Smith 
71047c6ae99SBarry Smith #undef __FUNCT__
711aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunction1"
71247c6ae99SBarry Smith /*@
713aa219208SBarry Smith     DMDAFormFunction1 - Evaluates a user provided function on each processor that
714aa219208SBarry Smith         share a DMDA
71547c6ae99SBarry Smith 
71647c6ae99SBarry Smith    Input Parameters:
7179a42bb27SBarry Smith +    da - the DM that defines the grid
71847c6ae99SBarry Smith .    vu - input vector
71947c6ae99SBarry Smith .    vfu - output vector
72047c6ae99SBarry Smith -    w - any user data
72147c6ae99SBarry Smith 
72247c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
72347c6ae99SBarry Smith 
72447c6ae99SBarry Smith     Level: advanced
72547c6ae99SBarry Smith 
726aa219208SBarry Smith .seealso: DMDAComputeJacobian1WithAdic()
72747c6ae99SBarry Smith 
72847c6ae99SBarry Smith @*/
7297087cfbeSBarry Smith PetscErrorCode  DMDAFormFunction1(DM da,Vec vu,Vec vfu,void *w)
73047c6ae99SBarry Smith {
73147c6ae99SBarry Smith   PetscErrorCode ierr;
73247c6ae99SBarry Smith   void           *u,*fu;
733aa219208SBarry Smith   DMDALocalInfo  info;
73447c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
73547c6ae99SBarry Smith 
73647c6ae99SBarry Smith   PetscFunctionBegin;
7378b0a5094SBarry Smith   if (!dd->lf) SETERRQ(((PetscObject)da)->comm,PETSC_ERR_ARG_NULL,"DMDASetLocalFunction() never called");
738aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
739aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vu,&u);CHKERRQ(ierr);
740aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vfu,&fu);CHKERRQ(ierr);
74147c6ae99SBarry Smith 
74247c6ae99SBarry Smith   CHKMEMQ;
74339d508bbSBarry Smith   ierr = (*dd->lf)(&info,u,fu,w);CHKERRQ(ierr);
74447c6ae99SBarry Smith   CHKMEMQ;
74547c6ae99SBarry Smith 
746aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vu,&u);CHKERRQ(ierr);
747aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vfu,&fu);CHKERRQ(ierr);
74847c6ae99SBarry Smith   PetscFunctionReturn(0);
74947c6ae99SBarry Smith }
75047c6ae99SBarry Smith 
75147c6ae99SBarry Smith #undef __FUNCT__
752aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunctioniTest1"
7537087cfbeSBarry Smith PetscErrorCode  DMDAFormFunctioniTest1(DM da,void *w)
75447c6ae99SBarry Smith {
75547c6ae99SBarry Smith   Vec            vu,fu,fui;
75647c6ae99SBarry Smith   PetscErrorCode ierr;
75747c6ae99SBarry Smith   PetscInt       i,n;
75847c6ae99SBarry Smith   PetscScalar    *ui;
75947c6ae99SBarry Smith   PetscRandom    rnd;
76047c6ae99SBarry Smith   PetscReal      norm;
76147c6ae99SBarry Smith 
76247c6ae99SBarry Smith   PetscFunctionBegin;
7639a42bb27SBarry Smith   ierr = DMGetLocalVector(da,&vu);CHKERRQ(ierr);
76447c6ae99SBarry Smith   ierr = PetscRandomCreate(PETSC_COMM_SELF,&rnd);CHKERRQ(ierr);
76547c6ae99SBarry Smith   ierr = PetscRandomSetFromOptions(rnd);CHKERRQ(ierr);
76647c6ae99SBarry Smith   ierr = VecSetRandom(vu,rnd);CHKERRQ(ierr);
767fcfd50ebSBarry Smith   ierr = PetscRandomDestroy(&rnd);CHKERRQ(ierr);
76847c6ae99SBarry Smith 
7699a42bb27SBarry Smith   ierr = DMGetGlobalVector(da,&fu);CHKERRQ(ierr);
7709a42bb27SBarry Smith   ierr = DMGetGlobalVector(da,&fui);CHKERRQ(ierr);
77147c6ae99SBarry Smith 
772aa219208SBarry Smith   ierr = DMDAFormFunction1(da,vu,fu,w);CHKERRQ(ierr);
77347c6ae99SBarry Smith 
77447c6ae99SBarry Smith   ierr = VecGetArray(fui,&ui);CHKERRQ(ierr);
77547c6ae99SBarry Smith   ierr = VecGetLocalSize(fui,&n);CHKERRQ(ierr);
77647c6ae99SBarry Smith   for (i=0; i<n; i++) {
777aa219208SBarry Smith     ierr = DMDAFormFunctioni1(da,i,vu,ui+i,w);CHKERRQ(ierr);
77847c6ae99SBarry Smith   }
77947c6ae99SBarry Smith   ierr = VecRestoreArray(fui,&ui);CHKERRQ(ierr);
78047c6ae99SBarry Smith 
78147c6ae99SBarry Smith   ierr = VecAXPY(fui,-1.0,fu);CHKERRQ(ierr);
78247c6ae99SBarry Smith   ierr = VecNorm(fui,NORM_2,&norm);CHKERRQ(ierr);
78347c6ae99SBarry Smith   ierr = PetscPrintf(((PetscObject)da)->comm,"Norm of difference in vectors %G\n",norm);CHKERRQ(ierr);
78447c6ae99SBarry Smith   ierr = VecView(fu,0);CHKERRQ(ierr);
78547c6ae99SBarry Smith   ierr = VecView(fui,0);CHKERRQ(ierr);
78647c6ae99SBarry Smith 
7879a42bb27SBarry Smith   ierr = DMRestoreLocalVector(da,&vu);CHKERRQ(ierr);
7889a42bb27SBarry Smith   ierr = DMRestoreGlobalVector(da,&fu);CHKERRQ(ierr);
7899a42bb27SBarry Smith   ierr = DMRestoreGlobalVector(da,&fui);CHKERRQ(ierr);
79047c6ae99SBarry Smith   PetscFunctionReturn(0);
79147c6ae99SBarry Smith }
79247c6ae99SBarry Smith 
79347c6ae99SBarry Smith #undef __FUNCT__
794aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunctioni1"
79547c6ae99SBarry Smith /*@
796aa219208SBarry Smith     DMDAFormFunctioni1 - Evaluates a user provided point-wise function
79747c6ae99SBarry Smith 
79847c6ae99SBarry Smith    Input Parameters:
7999a42bb27SBarry Smith +    da - the DM that defines the grid
80047c6ae99SBarry Smith .    i - the component of the function we wish to compute (must be local)
80147c6ae99SBarry Smith .    vu - input vector
80247c6ae99SBarry Smith .    vfu - output value
80347c6ae99SBarry Smith -    w - any user data
80447c6ae99SBarry Smith 
80547c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
80647c6ae99SBarry Smith 
80747c6ae99SBarry Smith     Level: advanced
80847c6ae99SBarry Smith 
809aa219208SBarry Smith .seealso: DMDAComputeJacobian1WithAdic()
81047c6ae99SBarry Smith 
81147c6ae99SBarry Smith @*/
8127087cfbeSBarry Smith PetscErrorCode  DMDAFormFunctioni1(DM da,PetscInt i,Vec vu,PetscScalar *vfu,void *w)
81347c6ae99SBarry Smith {
81447c6ae99SBarry Smith   PetscErrorCode ierr;
81547c6ae99SBarry Smith   void           *u;
816aa219208SBarry Smith   DMDALocalInfo  info;
81747c6ae99SBarry Smith   MatStencil     stencil;
81847c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
81947c6ae99SBarry Smith 
82047c6ae99SBarry Smith   PetscFunctionBegin;
82147c6ae99SBarry Smith 
822aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
823aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vu,&u);CHKERRQ(ierr);
82447c6ae99SBarry Smith 
82547c6ae99SBarry Smith   /* figure out stencil value from i */
82647c6ae99SBarry Smith   stencil.c = i % info.dof;
82747c6ae99SBarry Smith   stencil.i = (i % (info.xm*info.dof))/info.dof;
82847c6ae99SBarry Smith   stencil.j = (i % (info.xm*info.ym*info.dof))/(info.xm*info.dof);
82947c6ae99SBarry Smith   stencil.k = i/(info.xm*info.ym*info.dof);
83047c6ae99SBarry Smith 
83147c6ae99SBarry Smith   ierr = (*dd->lfi)(&info,&stencil,u,vfu,w);CHKERRQ(ierr);
83247c6ae99SBarry Smith 
833aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vu,&u);CHKERRQ(ierr);
83447c6ae99SBarry Smith   PetscFunctionReturn(0);
83547c6ae99SBarry Smith }
83647c6ae99SBarry Smith 
83747c6ae99SBarry Smith #undef __FUNCT__
838aa219208SBarry Smith #define __FUNCT__ "DMDAFormFunctionib1"
83947c6ae99SBarry Smith /*@
840aa219208SBarry Smith     DMDAFormFunctionib1 - Evaluates a user provided point-block function
84147c6ae99SBarry Smith 
84247c6ae99SBarry Smith    Input Parameters:
8439a42bb27SBarry Smith +    da - the DM that defines the grid
84447c6ae99SBarry Smith .    i - the component of the function we wish to compute (must be local)
84547c6ae99SBarry Smith .    vu - input vector
84647c6ae99SBarry Smith .    vfu - output value
84747c6ae99SBarry Smith -    w - any user data
84847c6ae99SBarry Smith 
84947c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
85047c6ae99SBarry Smith 
85147c6ae99SBarry Smith     Level: advanced
85247c6ae99SBarry Smith 
853aa219208SBarry Smith .seealso: DMDAComputeJacobian1WithAdic()
85447c6ae99SBarry Smith 
85547c6ae99SBarry Smith @*/
8567087cfbeSBarry Smith PetscErrorCode  DMDAFormFunctionib1(DM da,PetscInt i,Vec vu,PetscScalar *vfu,void *w)
85747c6ae99SBarry Smith {
85847c6ae99SBarry Smith   PetscErrorCode ierr;
85947c6ae99SBarry Smith   void           *u;
860aa219208SBarry Smith   DMDALocalInfo  info;
86147c6ae99SBarry Smith   MatStencil     stencil;
86247c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
86347c6ae99SBarry Smith 
86447c6ae99SBarry Smith   PetscFunctionBegin;
865aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
866aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vu,&u);CHKERRQ(ierr);
86747c6ae99SBarry Smith 
86847c6ae99SBarry Smith   /* figure out stencil value from i */
86947c6ae99SBarry Smith   stencil.c = i % info.dof;
87047c6ae99SBarry Smith   if (stencil.c) SETERRQ(((PetscObject)da)->comm,PETSC_ERR_ARG_WRONG,"Point-block functions can only be called for the entire block");
87147c6ae99SBarry Smith   stencil.i = (i % (info.xm*info.dof))/info.dof;
87247c6ae99SBarry Smith   stencil.j = (i % (info.xm*info.ym*info.dof))/(info.xm*info.dof);
87347c6ae99SBarry Smith   stencil.k = i/(info.xm*info.ym*info.dof);
87447c6ae99SBarry Smith 
87547c6ae99SBarry Smith   ierr = (*dd->lfib)(&info,&stencil,u,vfu,w);CHKERRQ(ierr);
87647c6ae99SBarry Smith 
877aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vu,&u);CHKERRQ(ierr);
87847c6ae99SBarry Smith   PetscFunctionReturn(0);
87947c6ae99SBarry Smith }
88047c6ae99SBarry Smith 
88147c6ae99SBarry Smith #if defined(new)
88247c6ae99SBarry Smith #undef __FUNCT__
883aa219208SBarry Smith #define __FUNCT__ "DMDAGetDiagonal_MFFD"
88447c6ae99SBarry Smith /*
885aa219208SBarry Smith   DMDAGetDiagonal_MFFD - Gets the diagonal for a matrix free matrix where local
886aa219208SBarry Smith     function lives on a DMDA
88747c6ae99SBarry Smith 
88847c6ae99SBarry Smith         y ~= (F(u + ha) - F(u))/h,
88947c6ae99SBarry Smith   where F = nonlinear function, as set by SNESSetFunction()
89047c6ae99SBarry Smith         u = current iterate
89147c6ae99SBarry Smith         h = difference interval
89247c6ae99SBarry Smith */
893aa219208SBarry Smith PetscErrorCode DMDAGetDiagonal_MFFD(DM da,Vec U,Vec a)
89447c6ae99SBarry Smith {
89547c6ae99SBarry Smith   PetscScalar    h,*aa,*ww,v;
89647c6ae99SBarry Smith   PetscReal      epsilon = PETSC_SQRT_MACHINE_EPSILON,umin = 100.0*PETSC_SQRT_MACHINE_EPSILON;
89747c6ae99SBarry Smith   PetscErrorCode ierr;
89847c6ae99SBarry Smith   PetscInt       gI,nI;
89947c6ae99SBarry Smith   MatStencil     stencil;
900aa219208SBarry Smith   DMDALocalInfo  info;
90147c6ae99SBarry Smith 
90247c6ae99SBarry Smith   PetscFunctionBegin;
90347c6ae99SBarry Smith   ierr = (*ctx->func)(0,U,a,ctx->funcctx);CHKERRQ(ierr);
90447c6ae99SBarry Smith   ierr = (*ctx->funcisetbase)(U,ctx->funcctx);CHKERRQ(ierr);
90547c6ae99SBarry Smith 
90647c6ae99SBarry Smith   ierr = VecGetArray(U,&ww);CHKERRQ(ierr);
90747c6ae99SBarry Smith   ierr = VecGetArray(a,&aa);CHKERRQ(ierr);
90847c6ae99SBarry Smith 
90947c6ae99SBarry Smith   nI = 0;
91047c6ae99SBarry Smith     h  = ww[gI];
91147c6ae99SBarry Smith     if (h == 0.0) h = 1.0;
91247c6ae99SBarry Smith #if !defined(PETSC_USE_COMPLEX)
91347c6ae99SBarry Smith     if (h < umin && h >= 0.0)      h = umin;
91447c6ae99SBarry Smith     else if (h < 0.0 && h > -umin) h = -umin;
91547c6ae99SBarry Smith #else
91647c6ae99SBarry Smith     if (PetscAbsScalar(h) < umin && PetscRealPart(h) >= 0.0)     h = umin;
91747c6ae99SBarry Smith     else if (PetscRealPart(h) < 0.0 && PetscAbsScalar(h) < umin) h = -umin;
91847c6ae99SBarry Smith #endif
91947c6ae99SBarry Smith     h     *= epsilon;
92047c6ae99SBarry Smith 
92147c6ae99SBarry Smith     ww[gI] += h;
92247c6ae99SBarry Smith     ierr          = (*ctx->funci)(i,w,&v,ctx->funcctx);CHKERRQ(ierr);
92347c6ae99SBarry Smith     aa[nI]  = (v - aa[nI])/h;
92447c6ae99SBarry Smith     ww[gI] -= h;
92547c6ae99SBarry Smith     nI++;
92647c6ae99SBarry Smith   }
92747c6ae99SBarry Smith   ierr = VecRestoreArray(U,&ww);CHKERRQ(ierr);
92847c6ae99SBarry Smith   ierr = VecRestoreArray(a,&aa);CHKERRQ(ierr);
92947c6ae99SBarry Smith   PetscFunctionReturn(0);
93047c6ae99SBarry Smith }
93147c6ae99SBarry Smith #endif
93247c6ae99SBarry Smith 
93347c6ae99SBarry Smith #if defined(PETSC_HAVE_ADIC)
93447c6ae99SBarry Smith EXTERN_C_BEGIN
935c6db04a5SJed Brown #include <adic/ad_utils.h>
93647c6ae99SBarry Smith EXTERN_C_END
93747c6ae99SBarry Smith 
93847c6ae99SBarry Smith #undef __FUNCT__
939aa219208SBarry Smith #define __FUNCT__ "DMDAComputeJacobian1WithAdic"
94047c6ae99SBarry Smith /*@C
941aa219208SBarry Smith     DMDAComputeJacobian1WithAdic - Evaluates a adiC provided Jacobian function on each processor that
942aa219208SBarry Smith         share a DMDA
94347c6ae99SBarry Smith 
94447c6ae99SBarry Smith    Input Parameters:
9459a42bb27SBarry Smith +    da - the DM that defines the grid
94647c6ae99SBarry Smith .    vu - input vector (ghosted)
94747c6ae99SBarry Smith .    J - output matrix
94847c6ae99SBarry Smith -    w - any user data
94947c6ae99SBarry Smith 
95047c6ae99SBarry Smith    Level: advanced
95147c6ae99SBarry Smith 
95247c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
95347c6ae99SBarry Smith 
954aa219208SBarry Smith .seealso: DMDAFormFunction1()
95547c6ae99SBarry Smith 
95647c6ae99SBarry Smith @*/
9577087cfbeSBarry Smith PetscErrorCode  DMDAComputeJacobian1WithAdic(DM da,Vec vu,Mat J,void *w)
95847c6ae99SBarry Smith {
95947c6ae99SBarry Smith   PetscErrorCode ierr;
96047c6ae99SBarry Smith   PetscInt       gtdof,tdof;
96147c6ae99SBarry Smith   PetscScalar    *ustart;
962aa219208SBarry Smith   DMDALocalInfo  info;
96347c6ae99SBarry Smith   void           *ad_u,*ad_f,*ad_ustart,*ad_fstart;
96447c6ae99SBarry Smith   ISColoring     iscoloring;
96547c6ae99SBarry Smith 
96647c6ae99SBarry Smith   PetscFunctionBegin;
967aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
96847c6ae99SBarry Smith 
96947c6ae99SBarry Smith   PetscADResetIndep();
97047c6ae99SBarry Smith 
97147c6ae99SBarry Smith   /* get space for derivative objects.  */
972aa219208SBarry Smith   ierr = DMDAGetAdicArray(da,PETSC_TRUE,&ad_u,&ad_ustart,&gtdof);CHKERRQ(ierr);
973aa219208SBarry Smith   ierr = DMDAGetAdicArray(da,PETSC_FALSE,&ad_f,&ad_fstart,&tdof);CHKERRQ(ierr);
97447c6ae99SBarry Smith   ierr = VecGetArray(vu,&ustart);CHKERRQ(ierr);
97594013140SBarry Smith   ierr = DMGetColoring(da,IS_COLORING_GHOSTED,MATAIJ,&iscoloring);CHKERRQ(ierr);
97647c6ae99SBarry Smith 
97747c6ae99SBarry Smith   PetscADSetValueAndColor(ad_ustart,gtdof,iscoloring->colors,ustart);
97847c6ae99SBarry Smith 
97947c6ae99SBarry Smith   ierr = VecRestoreArray(vu,&ustart);CHKERRQ(ierr);
980fcfd50ebSBarry Smith   ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
98147c6ae99SBarry Smith   ierr = PetscADIncrementTotalGradSize(iscoloring->n);CHKERRQ(ierr);
98247c6ae99SBarry Smith   PetscADSetIndepDone();
98347c6ae99SBarry Smith 
984aa219208SBarry Smith   ierr = PetscLogEventBegin(DMDA_LocalADFunction,0,0,0,0);CHKERRQ(ierr);
98547c6ae99SBarry Smith   ierr = (*dd->adic_lf)(&info,ad_u,ad_f,w);CHKERRQ(ierr);
986aa219208SBarry Smith   ierr = PetscLogEventEnd(DMDA_LocalADFunction,0,0,0,0);CHKERRQ(ierr);
98747c6ae99SBarry Smith 
98847c6ae99SBarry Smith   /* stick the values into the matrix */
98947c6ae99SBarry Smith   ierr = MatSetValuesAdic(J,(PetscScalar**)ad_fstart);CHKERRQ(ierr);
99047c6ae99SBarry Smith 
99147c6ae99SBarry Smith   /* return space for derivative objects.  */
992aa219208SBarry Smith   ierr = DMDARestoreAdicArray(da,PETSC_TRUE,&ad_u,&ad_ustart,&gtdof);CHKERRQ(ierr);
993aa219208SBarry Smith   ierr = DMDARestoreAdicArray(da,PETSC_FALSE,&ad_f,&ad_fstart,&tdof);CHKERRQ(ierr);
99447c6ae99SBarry Smith   PetscFunctionReturn(0);
99547c6ae99SBarry Smith }
99647c6ae99SBarry Smith 
99747c6ae99SBarry Smith #undef __FUNCT__
998aa219208SBarry Smith #define __FUNCT__ "DMDAMultiplyByJacobian1WithAdic"
99947c6ae99SBarry Smith /*@C
1000aa219208SBarry Smith     DMDAMultiplyByJacobian1WithAdic - Applies an ADIC-provided Jacobian function to a vector on
1001aa219208SBarry Smith     each processor that shares a DMDA.
100247c6ae99SBarry Smith 
100347c6ae99SBarry Smith     Input Parameters:
10049a42bb27SBarry Smith +   da - the DM that defines the grid
100547c6ae99SBarry Smith .   vu - Jacobian is computed at this point (ghosted)
100647c6ae99SBarry Smith .   v - product is done on this vector (ghosted)
100747c6ae99SBarry Smith .   fu - output vector = J(vu)*v (not ghosted)
100847c6ae99SBarry Smith -   w - any user data
100947c6ae99SBarry Smith 
101047c6ae99SBarry Smith     Notes:
101147c6ae99SBarry Smith     This routine does NOT do ghost updates on vu upon entry.
101247c6ae99SBarry Smith 
101347c6ae99SBarry Smith    Level: advanced
101447c6ae99SBarry Smith 
1015aa219208SBarry Smith .seealso: DMDAFormFunction1()
101647c6ae99SBarry Smith 
101747c6ae99SBarry Smith @*/
10187087cfbeSBarry Smith PetscErrorCode  DMDAMultiplyByJacobian1WithAdic(DM da,Vec vu,Vec v,Vec f,void *w)
101947c6ae99SBarry Smith {
102047c6ae99SBarry Smith   PetscErrorCode ierr;
102147c6ae99SBarry Smith   PetscInt       i,gtdof,tdof;
102247c6ae99SBarry Smith   PetscScalar    *avu,*av,*af,*ad_vustart,*ad_fstart;
1023aa219208SBarry Smith   DMDALocalInfo  info;
102447c6ae99SBarry Smith   void           *ad_vu,*ad_f;
102547c6ae99SBarry Smith 
102647c6ae99SBarry Smith   PetscFunctionBegin;
1027aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
102847c6ae99SBarry Smith 
102947c6ae99SBarry Smith   /* get space for derivative objects.  */
1030aa219208SBarry Smith   ierr = DMDAGetAdicMFArray(da,PETSC_TRUE,&ad_vu,&ad_vustart,&gtdof);CHKERRQ(ierr);
1031aa219208SBarry Smith   ierr = DMDAGetAdicMFArray(da,PETSC_FALSE,&ad_f,&ad_fstart,&tdof);CHKERRQ(ierr);
103247c6ae99SBarry Smith 
103347c6ae99SBarry Smith   /* copy input vector into derivative object */
103447c6ae99SBarry Smith   ierr = VecGetArray(vu,&avu);CHKERRQ(ierr);
103547c6ae99SBarry Smith   ierr = VecGetArray(v,&av);CHKERRQ(ierr);
103647c6ae99SBarry Smith   for (i=0; i<gtdof; i++) {
103747c6ae99SBarry Smith     ad_vustart[2*i]   = avu[i];
103847c6ae99SBarry Smith     ad_vustart[2*i+1] = av[i];
103947c6ae99SBarry Smith   }
104047c6ae99SBarry Smith   ierr = VecRestoreArray(vu,&avu);CHKERRQ(ierr);
104147c6ae99SBarry Smith   ierr = VecRestoreArray(v,&av);CHKERRQ(ierr);
104247c6ae99SBarry Smith 
104347c6ae99SBarry Smith   PetscADResetIndep();
104447c6ae99SBarry Smith   ierr = PetscADIncrementTotalGradSize(1);CHKERRQ(ierr);
104547c6ae99SBarry Smith   PetscADSetIndepDone();
104647c6ae99SBarry Smith 
104747c6ae99SBarry Smith   ierr = (*dd->adicmf_lf)(&info,ad_vu,ad_f,w);CHKERRQ(ierr);
104847c6ae99SBarry Smith 
104947c6ae99SBarry Smith   /* stick the values into the vector */
105047c6ae99SBarry Smith   ierr = VecGetArray(f,&af);CHKERRQ(ierr);
105147c6ae99SBarry Smith   for (i=0; i<tdof; i++) {
105247c6ae99SBarry Smith     af[i] = ad_fstart[2*i+1];
105347c6ae99SBarry Smith   }
105447c6ae99SBarry Smith   ierr = VecRestoreArray(f,&af);CHKERRQ(ierr);
105547c6ae99SBarry Smith 
105647c6ae99SBarry Smith   /* return space for derivative objects.  */
1057aa219208SBarry Smith   ierr = DMDARestoreAdicMFArray(da,PETSC_TRUE,&ad_vu,&ad_vustart,&gtdof);CHKERRQ(ierr);
1058aa219208SBarry Smith   ierr = DMDARestoreAdicMFArray(da,PETSC_FALSE,&ad_f,&ad_fstart,&tdof);CHKERRQ(ierr);
105947c6ae99SBarry Smith   PetscFunctionReturn(0);
106047c6ae99SBarry Smith }
106147c6ae99SBarry Smith #endif
106247c6ae99SBarry Smith 
106347c6ae99SBarry Smith #undef __FUNCT__
1064aa219208SBarry Smith #define __FUNCT__ "DMDAComputeJacobian1"
106547c6ae99SBarry Smith /*@
1066aa219208SBarry Smith     DMDAComputeJacobian1 - Evaluates a local Jacobian function on each processor that
1067aa219208SBarry Smith         share a DMDA
106847c6ae99SBarry Smith 
106947c6ae99SBarry Smith    Input Parameters:
10709a42bb27SBarry Smith +    da - the DM that defines the grid
107147c6ae99SBarry Smith .    vu - input vector (ghosted)
107247c6ae99SBarry Smith .    J - output matrix
107347c6ae99SBarry Smith -    w - any user data
107447c6ae99SBarry Smith 
107547c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
107647c6ae99SBarry Smith 
107747c6ae99SBarry Smith     Level: advanced
107847c6ae99SBarry Smith 
1079aa219208SBarry Smith .seealso: DMDAFormFunction1()
108047c6ae99SBarry Smith 
108147c6ae99SBarry Smith @*/
10827087cfbeSBarry Smith PetscErrorCode  DMDAComputeJacobian1(DM da,Vec vu,Mat J,void *w)
108347c6ae99SBarry Smith {
108447c6ae99SBarry Smith   PetscErrorCode ierr;
108547c6ae99SBarry Smith   void           *u;
1086aa219208SBarry Smith   DMDALocalInfo  info;
108747c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
108847c6ae99SBarry Smith 
108947c6ae99SBarry Smith   PetscFunctionBegin;
1090aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
1091aa219208SBarry Smith   ierr = DMDAVecGetArray(da,vu,&u);CHKERRQ(ierr);
109247c6ae99SBarry Smith   ierr = (*dd->lj)(&info,u,J,w);CHKERRQ(ierr);
1093aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,vu,&u);CHKERRQ(ierr);
109447c6ae99SBarry Smith   PetscFunctionReturn(0);
109547c6ae99SBarry Smith }
109647c6ae99SBarry Smith 
109747c6ae99SBarry Smith 
109847c6ae99SBarry Smith #undef __FUNCT__
1099aa219208SBarry Smith #define __FUNCT__ "DMDAComputeJacobian1WithAdifor"
110047c6ae99SBarry Smith /*
1101aa219208SBarry Smith     DMDAComputeJacobian1WithAdifor - Evaluates a ADIFOR provided Jacobian local function on each processor that
1102aa219208SBarry Smith         share a DMDA
110347c6ae99SBarry Smith 
110447c6ae99SBarry Smith    Input Parameters:
11059a42bb27SBarry Smith +    da - the DM that defines the grid
110647c6ae99SBarry Smith .    vu - input vector (ghosted)
110747c6ae99SBarry Smith .    J - output matrix
110847c6ae99SBarry Smith -    w - any user data
110947c6ae99SBarry Smith 
111047c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu upon entry
111147c6ae99SBarry Smith 
1112aa219208SBarry Smith .seealso: DMDAFormFunction1()
111347c6ae99SBarry Smith 
111447c6ae99SBarry Smith */
11157087cfbeSBarry Smith PetscErrorCode  DMDAComputeJacobian1WithAdifor(DM da,Vec vu,Mat J,void *w)
111647c6ae99SBarry Smith {
111747c6ae99SBarry Smith   PetscErrorCode  ierr;
111847c6ae99SBarry Smith   PetscInt        i,Nc,N;
111947c6ae99SBarry Smith   ISColoringValue *color;
1120aa219208SBarry Smith   DMDALocalInfo   info;
112147c6ae99SBarry Smith   PetscScalar     *u,*g_u,*g_f,*f = 0,*p_u;
112247c6ae99SBarry Smith   ISColoring      iscoloring;
112347c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
1124aa219208SBarry Smith   void            (*lf)(PetscInt*,DMDALocalInfo*,PetscScalar*,PetscScalar*,PetscInt*,PetscScalar*,PetscScalar*,PetscInt*,void*,PetscErrorCode*) =
1125aa219208SBarry Smith                   (void (*)(PetscInt*,DMDALocalInfo*,PetscScalar*,PetscScalar*,PetscInt*,PetscScalar*,PetscScalar*,PetscInt*,void*,PetscErrorCode*))*dd->adifor_lf;
112647c6ae99SBarry Smith 
112747c6ae99SBarry Smith   PetscFunctionBegin;
112894013140SBarry Smith   ierr = DMGetColoring(da,IS_COLORING_GHOSTED,MATAIJ,&iscoloring);CHKERRQ(ierr);
112947c6ae99SBarry Smith   Nc   = iscoloring->n;
1130aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
113147c6ae99SBarry Smith   N    = info.gxm*info.gym*info.gzm*info.dof;
113247c6ae99SBarry Smith 
113347c6ae99SBarry Smith   /* get space for derivative objects.  */
113447c6ae99SBarry Smith   ierr  = PetscMalloc(Nc*info.gxm*info.gym*info.gzm*info.dof*sizeof(PetscScalar),&g_u);CHKERRQ(ierr);
113547c6ae99SBarry Smith   ierr  = PetscMemzero(g_u,Nc*info.gxm*info.gym*info.gzm*info.dof*sizeof(PetscScalar));CHKERRQ(ierr);
113647c6ae99SBarry Smith   p_u   = g_u;
113747c6ae99SBarry Smith   color = iscoloring->colors;
113847c6ae99SBarry Smith   for (i=0; i<N; i++) {
113947c6ae99SBarry Smith     p_u[*color++] = 1.0;
114047c6ae99SBarry Smith     p_u          += Nc;
114147c6ae99SBarry Smith   }
1142fcfd50ebSBarry Smith   ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
114347c6ae99SBarry Smith   ierr = PetscMalloc2(Nc*info.xm*info.ym*info.zm*info.dof,PetscScalar,&g_f,info.xm*info.ym*info.zm*info.dof,PetscScalar,&f);CHKERRQ(ierr);
114447c6ae99SBarry Smith 
114547c6ae99SBarry Smith   /* Seed the input array g_u with coloring information */
114647c6ae99SBarry Smith 
114747c6ae99SBarry Smith   ierr = VecGetArray(vu,&u);CHKERRQ(ierr);
114847c6ae99SBarry Smith   (lf)(&Nc,&info,u,g_u,&Nc,f,g_f,&Nc,w,&ierr);CHKERRQ(ierr);
114947c6ae99SBarry Smith   ierr = VecRestoreArray(vu,&u);CHKERRQ(ierr);
115047c6ae99SBarry Smith 
115147c6ae99SBarry Smith   /* stick the values into the matrix */
115247c6ae99SBarry Smith   /* PetscScalarView(Nc*info.xm*info.ym,g_f,0); */
115347c6ae99SBarry Smith   ierr = MatSetValuesAdifor(J,Nc,g_f);CHKERRQ(ierr);
115447c6ae99SBarry Smith 
115547c6ae99SBarry Smith   /* return space for derivative objects.  */
115647c6ae99SBarry Smith   ierr = PetscFree(g_u);CHKERRQ(ierr);
115747c6ae99SBarry Smith   ierr = PetscFree2(g_f,f);CHKERRQ(ierr);
115847c6ae99SBarry Smith   PetscFunctionReturn(0);
115947c6ae99SBarry Smith }
116047c6ae99SBarry Smith 
116147c6ae99SBarry Smith #undef __FUNCT__
1162aa219208SBarry Smith #define __FUNCT__ "DMDAFormJacobianLocal"
116347c6ae99SBarry Smith /*@C
1164aa219208SBarry Smith    DMDAFormjacobianLocal - This is a universal Jacobian evaluation routine for
11659a42bb27SBarry Smith    a local DM function.
116647c6ae99SBarry Smith 
1167aa219208SBarry Smith    Collective on DMDA
116847c6ae99SBarry Smith 
116947c6ae99SBarry Smith    Input Parameters:
11709a42bb27SBarry Smith +  da - the DM context
117147c6ae99SBarry Smith .  func - The local function
117247c6ae99SBarry Smith .  X - input vector
117347c6ae99SBarry Smith .  J - Jacobian matrix
117447c6ae99SBarry Smith -  ctx - A user context
117547c6ae99SBarry Smith 
117647c6ae99SBarry Smith    Level: intermediate
117747c6ae99SBarry Smith 
1178aa219208SBarry Smith .seealso: DMDASetLocalFunction(), DMDASetLocalJacobian(), DMDASetLocalAdicFunction(), DMDASetLocalAdicMFFunction(),
117947c6ae99SBarry Smith           SNESSetFunction(), SNESSetJacobian()
118047c6ae99SBarry Smith 
118147c6ae99SBarry Smith @*/
11827087cfbeSBarry Smith PetscErrorCode  DMDAFormJacobianLocal(DM da, DMDALocalFunction1 func, Vec X, Mat J, void *ctx)
118347c6ae99SBarry Smith {
118447c6ae99SBarry Smith   Vec            localX;
1185aa219208SBarry Smith   DMDALocalInfo  info;
118647c6ae99SBarry Smith   void           *u;
118747c6ae99SBarry Smith   PetscErrorCode ierr;
118847c6ae99SBarry Smith 
118947c6ae99SBarry Smith   PetscFunctionBegin;
11909a42bb27SBarry Smith   ierr = DMGetLocalVector(da,&localX);CHKERRQ(ierr);
119147c6ae99SBarry Smith   /*
119247c6ae99SBarry Smith      Scatter ghost points to local vector, using the 2-step process
11939a42bb27SBarry Smith         DMGlobalToLocalBegin(), DMGlobalToLocalEnd().
119447c6ae99SBarry Smith   */
11959a42bb27SBarry Smith   ierr = DMGlobalToLocalBegin(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
11969a42bb27SBarry Smith   ierr = DMGlobalToLocalEnd(da,X,INSERT_VALUES,localX);CHKERRQ(ierr);
1197aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
1198aa219208SBarry Smith   ierr = DMDAVecGetArray(da,localX,&u);CHKERRQ(ierr);
119939d508bbSBarry Smith   ierr = (*func)(&info,u,J,ctx);CHKERRQ(ierr);
1200aa219208SBarry Smith   ierr = DMDAVecRestoreArray(da,localX,&u);CHKERRQ(ierr);
12019a42bb27SBarry Smith   ierr = DMRestoreLocalVector(da,&localX);CHKERRQ(ierr);
120247c6ae99SBarry Smith   PetscFunctionReturn(0);
120347c6ae99SBarry Smith }
120447c6ae99SBarry Smith 
120547c6ae99SBarry Smith #undef __FUNCT__
1206aa219208SBarry Smith #define __FUNCT__ "DMDAMultiplyByJacobian1WithAD"
120747c6ae99SBarry Smith /*@C
1208aa219208SBarry Smith     DMDAMultiplyByJacobian1WithAD - Applies a Jacobian function supplied by ADIFOR or ADIC
1209aa219208SBarry Smith     to a vector on each processor that shares a DMDA.
121047c6ae99SBarry Smith 
121147c6ae99SBarry Smith    Input Parameters:
12129a42bb27SBarry Smith +    da - the DM that defines the grid
121347c6ae99SBarry Smith .    vu - Jacobian is computed at this point (ghosted)
121447c6ae99SBarry Smith .    v - product is done on this vector (ghosted)
121547c6ae99SBarry Smith .    fu - output vector = J(vu)*v (not ghosted)
121647c6ae99SBarry Smith -    w - any user data
121747c6ae99SBarry Smith 
121847c6ae99SBarry Smith     Notes:
121947c6ae99SBarry Smith     This routine does NOT do ghost updates on vu and v upon entry.
122047c6ae99SBarry Smith 
1221aa219208SBarry Smith     Automatically calls DMDAMultiplyByJacobian1WithAdifor() or DMDAMultiplyByJacobian1WithAdic()
1222aa219208SBarry Smith     depending on whether DMDASetLocalAdicMFFunction() or DMDASetLocalAdiforMFFunction() was called.
122347c6ae99SBarry Smith 
122447c6ae99SBarry Smith    Level: advanced
122547c6ae99SBarry Smith 
1226aa219208SBarry Smith .seealso: DMDAFormFunction1(), DMDAMultiplyByJacobian1WithAdifor(), DMDAMultiplyByJacobian1WithAdic()
122747c6ae99SBarry Smith 
122847c6ae99SBarry Smith @*/
12297087cfbeSBarry Smith PetscErrorCode  DMDAMultiplyByJacobian1WithAD(DM da,Vec u,Vec v,Vec f,void *w)
123047c6ae99SBarry Smith {
123147c6ae99SBarry Smith   PetscErrorCode ierr;
123247c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
123347c6ae99SBarry Smith 
123447c6ae99SBarry Smith   PetscFunctionBegin;
123547c6ae99SBarry Smith   if (dd->adicmf_lf) {
123647c6ae99SBarry Smith #if defined(PETSC_HAVE_ADIC)
1237aa219208SBarry Smith     ierr = DMDAMultiplyByJacobian1WithAdic(da,u,v,f,w);CHKERRQ(ierr);
123847c6ae99SBarry Smith #else
123947c6ae99SBarry Smith     SETERRQ(((PetscObject)da)->comm,PETSC_ERR_SUP_SYS,"Requires ADIC to be installed and cannot use complex numbers");
124047c6ae99SBarry Smith #endif
124147c6ae99SBarry Smith   } else if (dd->adiformf_lf) {
1242aa219208SBarry Smith     ierr = DMDAMultiplyByJacobian1WithAdifor(da,u,v,f,w);CHKERRQ(ierr);
124347c6ae99SBarry Smith   } else {
1244aa219208SBarry Smith     SETERRQ(((PetscObject)da)->comm,PETSC_ERR_ORDER,"Must call DMDASetLocalAdiforMFFunction() or DMDASetLocalAdicMFFunction() before using");
124547c6ae99SBarry Smith   }
124647c6ae99SBarry Smith   PetscFunctionReturn(0);
124747c6ae99SBarry Smith }
124847c6ae99SBarry Smith 
124947c6ae99SBarry Smith 
125047c6ae99SBarry Smith #undef __FUNCT__
1251aa219208SBarry Smith #define __FUNCT__ "DMDAMultiplyByJacobian1WithAdifor"
125247c6ae99SBarry Smith /*@C
1253aa219208SBarry Smith     DMDAMultiplyByJacobian1WithAdifor - Applies a ADIFOR provided Jacobian function on each processor that
12549a42bb27SBarry Smith         share a DM to a vector
125547c6ae99SBarry Smith 
125647c6ae99SBarry Smith    Input Parameters:
12579a42bb27SBarry Smith +    da - the DM that defines the grid
125847c6ae99SBarry Smith .    vu - Jacobian is computed at this point (ghosted)
125947c6ae99SBarry Smith .    v - product is done on this vector (ghosted)
126047c6ae99SBarry Smith .    fu - output vector = J(vu)*v (not ghosted)
126147c6ae99SBarry Smith -    w - any user data
126247c6ae99SBarry Smith 
126347c6ae99SBarry Smith     Notes: Does NOT do ghost updates on vu and v upon entry
126447c6ae99SBarry Smith 
126547c6ae99SBarry Smith    Level: advanced
126647c6ae99SBarry Smith 
1267aa219208SBarry Smith .seealso: DMDAFormFunction1()
126847c6ae99SBarry Smith 
126947c6ae99SBarry Smith @*/
12707087cfbeSBarry Smith PetscErrorCode  DMDAMultiplyByJacobian1WithAdifor(DM da,Vec u,Vec v,Vec f,void *w)
127147c6ae99SBarry Smith {
127247c6ae99SBarry Smith   PetscErrorCode ierr;
127347c6ae99SBarry Smith   PetscScalar    *au,*av,*af,*awork;
127447c6ae99SBarry Smith   Vec            work;
1275aa219208SBarry Smith   DMDALocalInfo  info;
127647c6ae99SBarry Smith   DM_DA          *dd = (DM_DA*)da->data;
1277aa219208SBarry Smith   void           (*lf)(DMDALocalInfo*,PetscScalar*,PetscScalar*,PetscScalar*,PetscScalar*,void*,PetscErrorCode*) =
1278aa219208SBarry Smith                  (void (*)(DMDALocalInfo*,PetscScalar*,PetscScalar*,PetscScalar*,PetscScalar*,void*,PetscErrorCode*))*dd->adiformf_lf;
127947c6ae99SBarry Smith 
128047c6ae99SBarry Smith   PetscFunctionBegin;
1281aa219208SBarry Smith   ierr = DMDAGetLocalInfo(da,&info);CHKERRQ(ierr);
128247c6ae99SBarry Smith 
12839a42bb27SBarry Smith   ierr = DMGetGlobalVector(da,&work);CHKERRQ(ierr);
128447c6ae99SBarry Smith   ierr = VecGetArray(u,&au);CHKERRQ(ierr);
128547c6ae99SBarry Smith   ierr = VecGetArray(v,&av);CHKERRQ(ierr);
128647c6ae99SBarry Smith   ierr = VecGetArray(f,&af);CHKERRQ(ierr);
128747c6ae99SBarry Smith   ierr = VecGetArray(work,&awork);CHKERRQ(ierr);
128847c6ae99SBarry Smith   (lf)(&info,au,av,awork,af,w,&ierr);CHKERRQ(ierr);
128947c6ae99SBarry Smith   ierr = VecRestoreArray(u,&au);CHKERRQ(ierr);
129047c6ae99SBarry Smith   ierr = VecRestoreArray(v,&av);CHKERRQ(ierr);
129147c6ae99SBarry Smith   ierr = VecRestoreArray(f,&af);CHKERRQ(ierr);
129247c6ae99SBarry Smith   ierr = VecRestoreArray(work,&awork);CHKERRQ(ierr);
12939a42bb27SBarry Smith   ierr = DMRestoreGlobalVector(da,&work);CHKERRQ(ierr);
129447c6ae99SBarry Smith 
129547c6ae99SBarry Smith   PetscFunctionReturn(0);
129647c6ae99SBarry Smith }
129747c6ae99SBarry Smith 
129847c6ae99SBarry Smith #undef __FUNCT__
12999a42bb27SBarry Smith #define __FUNCT__ "DMSetUp_DA_2D"
13007087cfbeSBarry Smith PetscErrorCode  DMSetUp_DA_2D(DM da)
130147c6ae99SBarry Smith {
130247c6ae99SBarry Smith   DM_DA                  *dd = (DM_DA*)da->data;
130347c6ae99SBarry Smith   const PetscInt         M            = dd->M;
130447c6ae99SBarry Smith   const PetscInt         N            = dd->N;
130547c6ae99SBarry Smith   PetscInt               m            = dd->m;
130647c6ae99SBarry Smith   PetscInt               n            = dd->n;
130747c6ae99SBarry Smith   const PetscInt         dof          = dd->w;
130847c6ae99SBarry Smith   const PetscInt         s            = dd->s;
13091321219cSEthan Coon   const DMDABoundaryType bx         = dd->bx;
13101321219cSEthan Coon   const DMDABoundaryType by         = dd->by;
1311aa219208SBarry Smith   const DMDAStencilType  stencil_type = dd->stencil_type;
131247c6ae99SBarry Smith   PetscInt               *lx           = dd->lx;
131347c6ae99SBarry Smith   PetscInt               *ly           = dd->ly;
131447c6ae99SBarry Smith   MPI_Comm               comm;
131547c6ae99SBarry Smith   PetscMPIInt            rank,size;
1316ce00eea3SSatish Balay   PetscInt               xs,xe,ys,ye,x,y,Xs,Xe,Ys,Ye,start,end,IXs,IXe,IYs,IYe;
1317ce00eea3SSatish Balay   PetscInt               up,down,left,right,i,n0,n1,n2,n3,n5,n6,n7,n8,*idx,nn,*idx_cpy;
1318ce00eea3SSatish Balay   const PetscInt         *idx_full;
1319db87c5ecSEthan Coon   PetscInt               xbase,*bases,*ldims,j,x_t,y_t,s_t,base,count;
132047c6ae99SBarry Smith   PetscInt               s_x,s_y; /* s proportionalized to w */
132147c6ae99SBarry Smith   PetscInt               sn0 = 0,sn2 = 0,sn6 = 0,sn8 = 0;
132247c6ae99SBarry Smith   Vec                    local,global;
132347c6ae99SBarry Smith   VecScatter             ltog,gtol;
1324ce00eea3SSatish Balay   IS                     to,from,ltogis;
132547c6ae99SBarry Smith   PetscErrorCode         ierr;
132647c6ae99SBarry Smith 
132747c6ae99SBarry Smith   PetscFunctionBegin;
1328*3855c12bSBarry Smith   if (dof < 1) SETERRQ1(((PetscObject)da)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Must have 1 or more degrees of freedom per node: %D",dof);
1329*3855c12bSBarry Smith   if (s < 0) SETERRQ1(((PetscObject)da)->comm,PETSC_ERR_ARG_OUTOFRANGE,"Stencil width cannot be negative: %D",s);
133047c6ae99SBarry Smith   ierr = PetscObjectGetComm((PetscObject)da,&comm);CHKERRQ(ierr);
1331*3855c12bSBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
1332*3855c12bSBarry Smith   if (((Petsc64bitInt) M)*((Petsc64bitInt) N)*((Petsc64bitInt) dof) > (Petsc64bitInt) PETSC_MPI_INT_MAX) SETERRQ3(comm,PETSC_ERR_INT_OVERFLOW,"Mesh of %D by %D by %D (dof) is too large for 32 bit indices",M,N,dof);
1333*3855c12bSBarry Smith #endif
133447c6ae99SBarry Smith 
133547c6ae99SBarry Smith   if (dof < 1) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Must have 1 or more degrees of freedom per node: %D",dof);
133647c6ae99SBarry Smith   if (s < 0) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Stencil width cannot be negative: %D",s);
133747c6ae99SBarry Smith 
133847c6ae99SBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
133947c6ae99SBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
134047c6ae99SBarry Smith 
134147c6ae99SBarry Smith   dd->dim         = 2;
134247c6ae99SBarry Smith   ierr = PetscMalloc(dof*sizeof(char*),&dd->fieldname);CHKERRQ(ierr);
134347c6ae99SBarry Smith   ierr = PetscMemzero(dd->fieldname,dof*sizeof(char*));CHKERRQ(ierr);
134447c6ae99SBarry Smith 
134547c6ae99SBarry Smith   if (m != PETSC_DECIDE) {
134647c6ae99SBarry Smith     if (m < 1) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Non-positive number of processors in X direction: %D",m);
134747c6ae99SBarry Smith     else if (m > size) SETERRQ2(comm,PETSC_ERR_ARG_OUTOFRANGE,"Too many processors in X direction: %D %d",m,size);
134847c6ae99SBarry Smith   }
134947c6ae99SBarry Smith   if (n != PETSC_DECIDE) {
135047c6ae99SBarry Smith     if (n < 1) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Non-positive number of processors in Y direction: %D",n);
135147c6ae99SBarry Smith     else if (n > size) SETERRQ2(comm,PETSC_ERR_ARG_OUTOFRANGE,"Too many processors in Y direction: %D %d",n,size);
135247c6ae99SBarry Smith   }
135347c6ae99SBarry Smith 
135447c6ae99SBarry Smith   if (m == PETSC_DECIDE || n == PETSC_DECIDE) {
135547c6ae99SBarry Smith     if (n != PETSC_DECIDE) {
135647c6ae99SBarry Smith       m = size/n;
135747c6ae99SBarry Smith     } else if (m != PETSC_DECIDE) {
135847c6ae99SBarry Smith       n = size/m;
135947c6ae99SBarry Smith     } else {
136047c6ae99SBarry Smith       /* try for squarish distribution */
136147c6ae99SBarry Smith       m = (PetscInt)(0.5 + sqrt(((double)M)*((double)size)/((double)N)));
136247c6ae99SBarry Smith       if (!m) m = 1;
136347c6ae99SBarry Smith       while (m > 0) {
136447c6ae99SBarry Smith 	n = size/m;
136547c6ae99SBarry Smith 	if (m*n == size) break;
136647c6ae99SBarry Smith 	m--;
136747c6ae99SBarry Smith       }
136847c6ae99SBarry Smith       if (M > N && m < n) {PetscInt _m = m; m = n; n = _m;}
136947c6ae99SBarry Smith     }
137047c6ae99SBarry Smith     if (m*n != size) SETERRQ(comm,PETSC_ERR_PLIB,"Unable to create partition, check the size of the communicator and input m and n ");
137147c6ae99SBarry Smith   } else if (m*n != size) SETERRQ(comm,PETSC_ERR_ARG_OUTOFRANGE,"Given Bad partition");
137247c6ae99SBarry Smith 
137347c6ae99SBarry Smith   if (M < m) SETERRQ2(comm,PETSC_ERR_ARG_OUTOFRANGE,"Partition in x direction is too fine! %D %D",M,m);
137447c6ae99SBarry Smith   if (N < n) SETERRQ2(comm,PETSC_ERR_ARG_OUTOFRANGE,"Partition in y direction is too fine! %D %D",N,n);
137547c6ae99SBarry Smith 
137647c6ae99SBarry Smith   /*
137747c6ae99SBarry Smith      Determine locally owned region
137847c6ae99SBarry Smith      xs is the first local node number, x is the number of local nodes
137947c6ae99SBarry Smith   */
138047c6ae99SBarry Smith   if (!lx) {
138147c6ae99SBarry Smith     ierr = PetscMalloc(m*sizeof(PetscInt), &dd->lx);CHKERRQ(ierr);
138247c6ae99SBarry Smith     lx = dd->lx;
138347c6ae99SBarry Smith     for (i=0; i<m; i++) {
138447c6ae99SBarry Smith       lx[i] = M/m + ((M % m) > i);
138547c6ae99SBarry Smith     }
138647c6ae99SBarry Smith   }
138747c6ae99SBarry Smith   x  = lx[rank % m];
138847c6ae99SBarry Smith   xs = 0;
138947c6ae99SBarry Smith   for (i=0; i<(rank % m); i++) {
139047c6ae99SBarry Smith     xs += lx[i];
139147c6ae99SBarry Smith   }
139247c6ae99SBarry Smith #if defined(PETSC_USE_DEBUG)
139347c6ae99SBarry Smith   left = xs;
139447c6ae99SBarry Smith   for (i=(rank % m); i<m; i++) {
139547c6ae99SBarry Smith     left += lx[i];
139647c6ae99SBarry Smith   }
139747c6ae99SBarry Smith   if (left != M) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Sum of lx across processors not equal to M: %D %D",left,M);
139847c6ae99SBarry Smith #endif
139947c6ae99SBarry Smith 
140047c6ae99SBarry Smith   /*
140147c6ae99SBarry Smith      Determine locally owned region
140247c6ae99SBarry Smith      ys is the first local node number, y is the number of local nodes
140347c6ae99SBarry Smith   */
140447c6ae99SBarry Smith   if (!ly) {
140547c6ae99SBarry Smith     ierr = PetscMalloc(n*sizeof(PetscInt), &dd->ly);CHKERRQ(ierr);
140647c6ae99SBarry Smith     ly = dd->ly;
140747c6ae99SBarry Smith     for (i=0; i<n; i++) {
140847c6ae99SBarry Smith       ly[i] = N/n + ((N % n) > i);
140947c6ae99SBarry Smith     }
141047c6ae99SBarry Smith   }
141147c6ae99SBarry Smith   y  = ly[rank/m];
141247c6ae99SBarry Smith   ys = 0;
141347c6ae99SBarry Smith   for (i=0; i<(rank/m); i++) {
141447c6ae99SBarry Smith     ys += ly[i];
141547c6ae99SBarry Smith   }
141647c6ae99SBarry Smith #if defined(PETSC_USE_DEBUG)
141747c6ae99SBarry Smith   left = ys;
141847c6ae99SBarry Smith   for (i=(rank/m); i<n; i++) {
141947c6ae99SBarry Smith     left += ly[i];
142047c6ae99SBarry Smith   }
142147c6ae99SBarry Smith   if (left != N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Sum of ly across processors not equal to N: %D %D",left,N);
142247c6ae99SBarry Smith #endif
142347c6ae99SBarry Smith 
1424bcea557cSEthan Coon   /*
1425bcea557cSEthan Coon    check if the scatter requires more than one process neighbor or wraps around
1426bcea557cSEthan Coon    the domain more than once
1427bcea557cSEthan Coon   */
1428bcea557cSEthan Coon   if ((x < s) && ((m > 1) || (bx == DMDA_BOUNDARY_PERIODIC))) {
1429bcea557cSEthan Coon     SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Local x-width of domain x %D is smaller than stencil width s %D",x,s);
1430bcea557cSEthan Coon   }
1431bcea557cSEthan Coon   if ((y < s) && ((n > 1) || (by == DMDA_BOUNDARY_PERIODIC))) {
1432bcea557cSEthan Coon     SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Local y-width of domain y %D is smaller than stencil width s %D",y,s);
1433bcea557cSEthan Coon   }
143447c6ae99SBarry Smith   xe = xs + x;
143547c6ae99SBarry Smith   ye = ys + y;
143647c6ae99SBarry Smith 
1437ce00eea3SSatish Balay   /* determine ghost region (Xs) and region scattered into (IXs)  */
143847c6ae99SBarry Smith   /* Assume No Periodicity */
1439ce00eea3SSatish Balay   if (xs-s > 0) { Xs = xs - s; IXs = xs - s; } else { Xs = 0; IXs = 0; }
1440ce00eea3SSatish Balay   if (xe+s <= M) { Xe = xe + s; IXe = xe + s; } else { Xe = M; IXe = M; }
1441ce00eea3SSatish Balay   if (ys-s > 0) { Ys = ys - s; IYs = ys - s; } else { Ys = 0; IYs = 0; }
1442ce00eea3SSatish Balay   if (ye+s <= N) { Ye = ye + s; IYe = ye + s; } else { Ye = N; IYe = N; }
144347c6ae99SBarry Smith 
1444ce00eea3SSatish Balay   /* fix for periodicity/ghosted */
14451321219cSEthan Coon   if (bx) { Xs = xs - s; Xe = xe + s; }
14461321219cSEthan Coon   if (bx == DMDA_BOUNDARY_PERIODIC) { IXs = xs - s; IXe = xe + s; }
14471321219cSEthan Coon   if (by) { Ys = ys - s; Ye = ye + s; }
14481321219cSEthan Coon   if (by == DMDA_BOUNDARY_PERIODIC) { IYs = ys - s; IYe = ye + s; }
144947c6ae99SBarry Smith 
145047c6ae99SBarry Smith   /* Resize all X parameters to reflect w */
1451ce00eea3SSatish Balay   s_x = s;
145247c6ae99SBarry Smith   s_y = s;
145347c6ae99SBarry Smith 
145447c6ae99SBarry Smith   /* determine starting point of each processor */
145547c6ae99SBarry Smith   nn    = x*y;
145647c6ae99SBarry Smith   ierr  = PetscMalloc2(size+1,PetscInt,&bases,size,PetscInt,&ldims);CHKERRQ(ierr);
145747c6ae99SBarry Smith   ierr  = MPI_Allgather(&nn,1,MPIU_INT,ldims,1,MPIU_INT,comm);CHKERRQ(ierr);
145847c6ae99SBarry Smith   bases[0] = 0;
145947c6ae99SBarry Smith   for (i=1; i<=size; i++) {
146047c6ae99SBarry Smith     bases[i] = ldims[i-1];
146147c6ae99SBarry Smith   }
146247c6ae99SBarry Smith   for (i=1; i<=size; i++) {
146347c6ae99SBarry Smith     bases[i] += bases[i-1];
146447c6ae99SBarry Smith   }
1465ce00eea3SSatish Balay   base = bases[rank]*dof;
146647c6ae99SBarry Smith 
146747c6ae99SBarry Smith   /* allocate the base parallel and sequential vectors */
1468ce00eea3SSatish Balay   dd->Nlocal = x*y*dof;
146947c6ae99SBarry Smith   ierr = VecCreateMPIWithArray(comm,dd->Nlocal,PETSC_DECIDE,0,&global);CHKERRQ(ierr);
147047c6ae99SBarry Smith   ierr = VecSetBlockSize(global,dof);CHKERRQ(ierr);
1471ce00eea3SSatish Balay   dd->nlocal = (Xe-Xs)*(Ye-Ys)*dof;
147247c6ae99SBarry Smith   ierr = VecCreateSeqWithArray(PETSC_COMM_SELF,dd->nlocal,0,&local);CHKERRQ(ierr);
147347c6ae99SBarry Smith   ierr = VecSetBlockSize(local,dof);CHKERRQ(ierr);
147447c6ae99SBarry Smith 
147547c6ae99SBarry Smith   /* generate appropriate vector scatters */
147647c6ae99SBarry Smith   /* local to global inserts non-ghost point region into global */
147747c6ae99SBarry Smith   ierr = VecGetOwnershipRange(global,&start,&end);CHKERRQ(ierr);
1478ce00eea3SSatish Balay   ierr = ISCreateStride(comm,x*y*dof,start,1,&to);CHKERRQ(ierr);
147947c6ae99SBarry Smith 
1480db87c5ecSEthan Coon   count = x*y;
1481ce00eea3SSatish Balay   ierr = PetscMalloc(x*y*sizeof(PetscInt),&idx);CHKERRQ(ierr);
1482ce00eea3SSatish Balay   left = xs - Xs; right = left + x;
1483ce00eea3SSatish Balay   down = ys - Ys; up = down + y;
148447c6ae99SBarry Smith   count = 0;
148547c6ae99SBarry Smith   for (i=down; i<up; i++) {
1486ce00eea3SSatish Balay     for (j=left; j<right; j++) {
1487ce00eea3SSatish Balay       idx[count++] = i*(Xe-Xs) + j;
148847c6ae99SBarry Smith     }
148947c6ae99SBarry Smith   }
149047c6ae99SBarry Smith 
1491ce00eea3SSatish Balay   ierr = ISCreateBlock(comm,dof,count,idx,PETSC_OWN_POINTER,&from);CHKERRQ(ierr);
149247c6ae99SBarry Smith   ierr = VecScatterCreate(local,from,global,to,&ltog);CHKERRQ(ierr);
149347c6ae99SBarry Smith   ierr = PetscLogObjectParent(dd,ltog);CHKERRQ(ierr);
1494fcfd50ebSBarry Smith   ierr = ISDestroy(&from);CHKERRQ(ierr);
1495fcfd50ebSBarry Smith   ierr = ISDestroy(&to);CHKERRQ(ierr);
149647c6ae99SBarry Smith 
1497ce00eea3SSatish Balay   /* global to local must include ghost points within the domain,
1498ce00eea3SSatish Balay      but not ghost points outside the domain that aren't periodic */
1499aa219208SBarry Smith   if (stencil_type == DMDA_STENCIL_BOX) {
1500db87c5ecSEthan Coon     count = (IXe-IXs)*(IYe-IYs);
1501db87c5ecSEthan Coon     ierr  = PetscMalloc(count*sizeof(PetscInt),&idx);CHKERRQ(ierr);
1502ce00eea3SSatish Balay 
1503ce00eea3SSatish Balay     left = IXs - Xs; right = left + (IXe-IXs);
1504ce00eea3SSatish Balay     down = IYs - Ys; up = down + (IYe-IYs);
1505ce00eea3SSatish Balay     count = 0;
1506ce00eea3SSatish Balay     for (i=down; i<up; i++) {
1507ce00eea3SSatish Balay       for (j=left; j<right; j++) {
1508ce00eea3SSatish Balay         idx[count++] = j + i*(Xe-Xs);
1509ce00eea3SSatish Balay       }
1510ce00eea3SSatish Balay     }
1511ce00eea3SSatish Balay     ierr = ISCreateBlock(comm,dof,count,idx,PETSC_OWN_POINTER,&to);CHKERRQ(ierr);
1512ce00eea3SSatish Balay 
151347c6ae99SBarry Smith   } else {
151447c6ae99SBarry Smith     /* must drop into cross shape region */
151547c6ae99SBarry Smith     /*       ---------|
151647c6ae99SBarry Smith             |  top    |
1517ce00eea3SSatish Balay          |---         ---| up
151847c6ae99SBarry Smith          |   middle      |
151947c6ae99SBarry Smith          |               |
1520ce00eea3SSatish Balay          ----         ---- down
152147c6ae99SBarry Smith             | bottom  |
152247c6ae99SBarry Smith             -----------
152347c6ae99SBarry Smith          Xs xs        xe Xe */
1524db87c5ecSEthan Coon     count = (ys-IYs)*x + y*(IXe-IXs) + (IYe-ye)*x;
1525db87c5ecSEthan Coon     ierr  = PetscMalloc(count*sizeof(PetscInt),&idx);CHKERRQ(ierr);
1526ce00eea3SSatish Balay 
1527ce00eea3SSatish Balay     left = xs - Xs; right = left + x;
1528ce00eea3SSatish Balay     down = ys - Ys; up = down + y;
152947c6ae99SBarry Smith     count = 0;
1530ce00eea3SSatish Balay     /* bottom */
1531ce00eea3SSatish Balay     for (i=(IYs-Ys); i<down; i++) {
1532ce00eea3SSatish Balay       for (j=left; j<right; j++) {
1533ce00eea3SSatish Balay         idx[count++] = j + i*(Xe-Xs);
153447c6ae99SBarry Smith       }
153547c6ae99SBarry Smith     }
153647c6ae99SBarry Smith     /* middle */
153747c6ae99SBarry Smith     for (i=down; i<up; i++) {
1538ce00eea3SSatish Balay       for (j=(IXs-Xs); j<(IXe-Xs); j++) {
1539ce00eea3SSatish Balay         idx[count++] = j + i*(Xe-Xs);
154047c6ae99SBarry Smith       }
154147c6ae99SBarry Smith     }
154247c6ae99SBarry Smith     /* top */
1543ce00eea3SSatish Balay     for (i=up; i<up+IYe-ye; i++) {
1544ce00eea3SSatish Balay       for (j=left; j<right; j++) {
1545ce00eea3SSatish Balay         idx[count++] = j + i*(Xe-Xs);
154647c6ae99SBarry Smith       }
154747c6ae99SBarry Smith     }
154847c6ae99SBarry Smith     ierr = ISCreateBlock(comm,dof,count,idx,PETSC_OWN_POINTER,&to);CHKERRQ(ierr);
154947c6ae99SBarry Smith   }
155047c6ae99SBarry Smith 
155147c6ae99SBarry Smith 
155247c6ae99SBarry Smith   /* determine who lies on each side of us stored in    n6 n7 n8
155347c6ae99SBarry Smith                                                         n3    n5
155447c6ae99SBarry Smith                                                         n0 n1 n2
155547c6ae99SBarry Smith   */
155647c6ae99SBarry Smith 
155747c6ae99SBarry Smith   /* Assume the Non-Periodic Case */
155847c6ae99SBarry Smith   n1 = rank - m;
155947c6ae99SBarry Smith   if (rank % m) {
156047c6ae99SBarry Smith     n0 = n1 - 1;
156147c6ae99SBarry Smith   } else {
156247c6ae99SBarry Smith     n0 = -1;
156347c6ae99SBarry Smith   }
156447c6ae99SBarry Smith   if ((rank+1) % m) {
156547c6ae99SBarry Smith     n2 = n1 + 1;
156647c6ae99SBarry Smith     n5 = rank + 1;
156747c6ae99SBarry Smith     n8 = rank + m + 1; if (n8 >= m*n) n8 = -1;
156847c6ae99SBarry Smith   } else {
156947c6ae99SBarry Smith     n2 = -1; n5 = -1; n8 = -1;
157047c6ae99SBarry Smith   }
157147c6ae99SBarry Smith   if (rank % m) {
157247c6ae99SBarry Smith     n3 = rank - 1;
157347c6ae99SBarry Smith     n6 = n3 + m; if (n6 >= m*n) n6 = -1;
157447c6ae99SBarry Smith   } else {
157547c6ae99SBarry Smith     n3 = -1; n6 = -1;
157647c6ae99SBarry Smith   }
157747c6ae99SBarry Smith   n7 = rank + m; if (n7 >= m*n) n7 = -1;
157847c6ae99SBarry Smith 
15791321219cSEthan Coon   if (bx == DMDA_BOUNDARY_PERIODIC && by == DMDA_BOUNDARY_PERIODIC) {
158047c6ae99SBarry Smith   /* Modify for Periodic Cases */
158147c6ae99SBarry Smith     /* Handle all four corners */
158247c6ae99SBarry Smith     if ((n6 < 0) && (n7 < 0) && (n3 < 0)) n6 = m-1;
158347c6ae99SBarry Smith     if ((n8 < 0) && (n7 < 0) && (n5 < 0)) n8 = 0;
158447c6ae99SBarry Smith     if ((n2 < 0) && (n5 < 0) && (n1 < 0)) n2 = size-m;
158547c6ae99SBarry Smith     if ((n0 < 0) && (n3 < 0) && (n1 < 0)) n0 = size-1;
158647c6ae99SBarry Smith 
158747c6ae99SBarry Smith     /* Handle Top and Bottom Sides */
158847c6ae99SBarry Smith     if (n1 < 0) n1 = rank + m * (n-1);
158947c6ae99SBarry Smith     if (n7 < 0) n7 = rank - m * (n-1);
159047c6ae99SBarry Smith     if ((n3 >= 0) && (n0 < 0)) n0 = size - m + rank - 1;
159147c6ae99SBarry Smith     if ((n3 >= 0) && (n6 < 0)) n6 = (rank%m)-1;
159247c6ae99SBarry Smith     if ((n5 >= 0) && (n2 < 0)) n2 = size - m + rank + 1;
159347c6ae99SBarry Smith     if ((n5 >= 0) && (n8 < 0)) n8 = (rank%m)+1;
159447c6ae99SBarry Smith 
159547c6ae99SBarry Smith     /* Handle Left and Right Sides */
159647c6ae99SBarry Smith     if (n3 < 0) n3 = rank + (m-1);
159747c6ae99SBarry Smith     if (n5 < 0) n5 = rank - (m-1);
159847c6ae99SBarry Smith     if ((n1 >= 0) && (n0 < 0)) n0 = rank-1;
159947c6ae99SBarry Smith     if ((n1 >= 0) && (n2 < 0)) n2 = rank-2*m+1;
160047c6ae99SBarry Smith     if ((n7 >= 0) && (n6 < 0)) n6 = rank+2*m-1;
160147c6ae99SBarry Smith     if ((n7 >= 0) && (n8 < 0)) n8 = rank+1;
16021321219cSEthan Coon   } else if (by == DMDA_BOUNDARY_PERIODIC) {  /* Handle Top and Bottom Sides */
1603ce00eea3SSatish Balay     if (n1 < 0) n1 = rank + m * (n-1);
1604ce00eea3SSatish Balay     if (n7 < 0) n7 = rank - m * (n-1);
1605ce00eea3SSatish Balay     if ((n3 >= 0) && (n0 < 0)) n0 = size - m + rank - 1;
1606ce00eea3SSatish Balay     if ((n3 >= 0) && (n6 < 0)) n6 = (rank%m)-1;
1607ce00eea3SSatish Balay     if ((n5 >= 0) && (n2 < 0)) n2 = size - m + rank + 1;
1608ce00eea3SSatish Balay     if ((n5 >= 0) && (n8 < 0)) n8 = (rank%m)+1;
16091321219cSEthan Coon   } else if (bx == DMDA_BOUNDARY_PERIODIC) { /* Handle Left and Right Sides */
1610ce00eea3SSatish Balay     if (n3 < 0) n3 = rank + (m-1);
1611ce00eea3SSatish Balay     if (n5 < 0) n5 = rank - (m-1);
1612ce00eea3SSatish Balay     if ((n1 >= 0) && (n0 < 0)) n0 = rank-1;
1613ce00eea3SSatish Balay     if ((n1 >= 0) && (n2 < 0)) n2 = rank-2*m+1;
1614ce00eea3SSatish Balay     if ((n7 >= 0) && (n6 < 0)) n6 = rank+2*m-1;
1615ce00eea3SSatish Balay     if ((n7 >= 0) && (n8 < 0)) n8 = rank+1;
161647c6ae99SBarry Smith   }
1617ce00eea3SSatish Balay 
161847c6ae99SBarry Smith   ierr = PetscMalloc(9*sizeof(PetscInt),&dd->neighbors);CHKERRQ(ierr);
161947c6ae99SBarry Smith   dd->neighbors[0] = n0;
162047c6ae99SBarry Smith   dd->neighbors[1] = n1;
162147c6ae99SBarry Smith   dd->neighbors[2] = n2;
162247c6ae99SBarry Smith   dd->neighbors[3] = n3;
162347c6ae99SBarry Smith   dd->neighbors[4] = rank;
162447c6ae99SBarry Smith   dd->neighbors[5] = n5;
162547c6ae99SBarry Smith   dd->neighbors[6] = n6;
162647c6ae99SBarry Smith   dd->neighbors[7] = n7;
162747c6ae99SBarry Smith   dd->neighbors[8] = n8;
162847c6ae99SBarry Smith 
1629aa219208SBarry Smith   if (stencil_type == DMDA_STENCIL_STAR) {
163047c6ae99SBarry Smith     /* save corner processor numbers */
163147c6ae99SBarry Smith     sn0 = n0; sn2 = n2; sn6 = n6; sn8 = n8;
163247c6ae99SBarry Smith     n0 = n2 = n6 = n8 = -1;
163347c6ae99SBarry Smith   }
163447c6ae99SBarry Smith 
1635ce00eea3SSatish Balay   ierr = PetscMalloc((Xe-Xs)*(Ye-Ys)*sizeof(PetscInt),&idx);CHKERRQ(ierr);
1636ce00eea3SSatish Balay   ierr = PetscLogObjectMemory(da,(Xe-Xs)*(Ye-Ys)*sizeof(PetscInt));CHKERRQ(ierr);
163747c6ae99SBarry Smith 
1638ce00eea3SSatish Balay   nn = 0;
163947c6ae99SBarry Smith   xbase = bases[rank];
164047c6ae99SBarry Smith   for (i=1; i<=s_y; i++) {
164147c6ae99SBarry Smith     if (n0 >= 0) { /* left below */
1642ce00eea3SSatish Balay       x_t = lx[n0 % m];
164347c6ae99SBarry Smith       y_t = ly[(n0/m)];
164447c6ae99SBarry Smith       s_t = bases[n0] + x_t*y_t - (s_y-i)*x_t - s_x;
164547c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
164647c6ae99SBarry Smith     }
164747c6ae99SBarry Smith     if (n1 >= 0) { /* directly below */
164847c6ae99SBarry Smith       x_t = x;
164947c6ae99SBarry Smith       y_t = ly[(n1/m)];
165047c6ae99SBarry Smith       s_t = bases[n1] + x_t*y_t - (s_y+1-i)*x_t;
165147c6ae99SBarry Smith       for (j=0; j<x_t; j++) { idx[nn++] = s_t++;}
165247c6ae99SBarry Smith     }
165347c6ae99SBarry Smith     if (n2 >= 0) { /* right below */
1654ce00eea3SSatish Balay       x_t = lx[n2 % m];
165547c6ae99SBarry Smith       y_t = ly[(n2/m)];
165647c6ae99SBarry Smith       s_t = bases[n2] + x_t*y_t - (s_y+1-i)*x_t;
165747c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
165847c6ae99SBarry Smith     }
165947c6ae99SBarry Smith   }
166047c6ae99SBarry Smith 
166147c6ae99SBarry Smith   for (i=0; i<y; i++) {
166247c6ae99SBarry Smith     if (n3 >= 0) { /* directly left */
1663ce00eea3SSatish Balay       x_t = lx[n3 % m];
166447c6ae99SBarry Smith       /* y_t = y; */
166547c6ae99SBarry Smith       s_t = bases[n3] + (i+1)*x_t - s_x;
166647c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
166747c6ae99SBarry Smith     }
166847c6ae99SBarry Smith 
166947c6ae99SBarry Smith     for (j=0; j<x; j++) { idx[nn++] = xbase++; } /* interior */
167047c6ae99SBarry Smith 
167147c6ae99SBarry Smith     if (n5 >= 0) { /* directly right */
1672ce00eea3SSatish Balay       x_t = lx[n5 % m];
167347c6ae99SBarry Smith       /* y_t = y; */
167447c6ae99SBarry Smith       s_t = bases[n5] + (i)*x_t;
167547c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
167647c6ae99SBarry Smith     }
167747c6ae99SBarry Smith   }
167847c6ae99SBarry Smith 
167947c6ae99SBarry Smith   for (i=1; i<=s_y; i++) {
168047c6ae99SBarry Smith     if (n6 >= 0) { /* left above */
1681ce00eea3SSatish Balay       x_t = lx[n6 % m];
168247c6ae99SBarry Smith       /* y_t = ly[(n6/m)]; */
168347c6ae99SBarry Smith       s_t = bases[n6] + (i)*x_t - s_x;
168447c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
168547c6ae99SBarry Smith     }
168647c6ae99SBarry Smith     if (n7 >= 0) { /* directly above */
168747c6ae99SBarry Smith       x_t = x;
168847c6ae99SBarry Smith       /* y_t = ly[(n7/m)]; */
168947c6ae99SBarry Smith       s_t = bases[n7] + (i-1)*x_t;
169047c6ae99SBarry Smith       for (j=0; j<x_t; j++) { idx[nn++] = s_t++;}
169147c6ae99SBarry Smith     }
169247c6ae99SBarry Smith     if (n8 >= 0) { /* right above */
1693ce00eea3SSatish Balay       x_t = lx[n8 % m];
169447c6ae99SBarry Smith       /* y_t = ly[(n8/m)]; */
169547c6ae99SBarry Smith       s_t = bases[n8] + (i-1)*x_t;
169647c6ae99SBarry Smith       for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
169747c6ae99SBarry Smith     }
169847c6ae99SBarry Smith   }
169947c6ae99SBarry Smith 
1700ce00eea3SSatish Balay   ierr = ISCreateBlock(comm,dof,nn,idx,PETSC_COPY_VALUES,&from);CHKERRQ(ierr);
170147c6ae99SBarry Smith   ierr = VecScatterCreate(global,from,local,to,&gtol);CHKERRQ(ierr);
170247c6ae99SBarry Smith   ierr = PetscLogObjectParent(da,gtol);CHKERRQ(ierr);
1703fcfd50ebSBarry Smith   ierr = ISDestroy(&to);CHKERRQ(ierr);
1704fcfd50ebSBarry Smith   ierr = ISDestroy(&from);CHKERRQ(ierr);
170547c6ae99SBarry Smith 
1706aa219208SBarry Smith   if (stencil_type == DMDA_STENCIL_STAR) {
1707ce00eea3SSatish Balay     n0 = sn0; n2 = sn2; n6 = sn6; n8 = sn8;
1708ce00eea3SSatish Balay   }
1709ce00eea3SSatish Balay 
1710ce00eea3SSatish Balay   if ((stencil_type == DMDA_STENCIL_STAR) ||
17111321219cSEthan Coon       (bx && bx != DMDA_BOUNDARY_PERIODIC) ||
17121321219cSEthan Coon       (by && by != DMDA_BOUNDARY_PERIODIC)) {
171347c6ae99SBarry Smith     /*
171447c6ae99SBarry Smith         Recompute the local to global mappings, this time keeping the
1715ce00eea3SSatish Balay       information about the cross corner processor numbers and any ghosted
1716ce00eea3SSatish Balay       but not periodic indices.
171747c6ae99SBarry Smith     */
171847c6ae99SBarry Smith     nn = 0;
171947c6ae99SBarry Smith     xbase = bases[rank];
172047c6ae99SBarry Smith     for (i=1; i<=s_y; i++) {
172147c6ae99SBarry Smith       if (n0 >= 0) { /* left below */
1722ce00eea3SSatish Balay         x_t = lx[n0 % m];
172347c6ae99SBarry Smith         y_t = ly[(n0/m)];
172447c6ae99SBarry Smith         s_t = bases[n0] + x_t*y_t - (s_y-i)*x_t - s_x;
172547c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1726ce00eea3SSatish Balay       } else if (xs-Xs > 0 && ys-Ys > 0) {
1727ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
172847c6ae99SBarry Smith       }
172947c6ae99SBarry Smith       if (n1 >= 0) { /* directly below */
173047c6ae99SBarry Smith         x_t = x;
173147c6ae99SBarry Smith         y_t = ly[(n1/m)];
173247c6ae99SBarry Smith         s_t = bases[n1] + x_t*y_t - (s_y+1-i)*x_t;
173347c6ae99SBarry Smith         for (j=0; j<x_t; j++) { idx[nn++] = s_t++;}
1734ce00eea3SSatish Balay       } else if (ys-Ys > 0) {
1735ce00eea3SSatish Balay         for (j=0; j<x; j++) { idx[nn++] = -1;}
173647c6ae99SBarry Smith       }
173747c6ae99SBarry Smith       if (n2 >= 0) { /* right below */
1738ce00eea3SSatish Balay         x_t = lx[n2 % m];
173947c6ae99SBarry Smith         y_t = ly[(n2/m)];
174047c6ae99SBarry Smith         s_t = bases[n2] + x_t*y_t - (s_y+1-i)*x_t;
174147c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1742ce00eea3SSatish Balay       } else if (Xe-xe> 0 && ys-Ys > 0) {
1743ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
174447c6ae99SBarry Smith       }
174547c6ae99SBarry Smith     }
174647c6ae99SBarry Smith 
174747c6ae99SBarry Smith     for (i=0; i<y; i++) {
174847c6ae99SBarry Smith       if (n3 >= 0) { /* directly left */
1749ce00eea3SSatish Balay         x_t = lx[n3 % m];
175047c6ae99SBarry Smith         /* y_t = y; */
175147c6ae99SBarry Smith         s_t = bases[n3] + (i+1)*x_t - s_x;
175247c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1753ce00eea3SSatish Balay       } else if (xs-Xs > 0) {
1754ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
175547c6ae99SBarry Smith       }
175647c6ae99SBarry Smith 
175747c6ae99SBarry Smith       for (j=0; j<x; j++) { idx[nn++] = xbase++; } /* interior */
175847c6ae99SBarry Smith 
175947c6ae99SBarry Smith       if (n5 >= 0) { /* directly right */
1760ce00eea3SSatish Balay         x_t = lx[n5 % m];
176147c6ae99SBarry Smith         /* y_t = y; */
176247c6ae99SBarry Smith         s_t = bases[n5] + (i)*x_t;
176347c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1764ce00eea3SSatish Balay       } else if (Xe-xe > 0) {
1765ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
176647c6ae99SBarry Smith       }
176747c6ae99SBarry Smith     }
176847c6ae99SBarry Smith 
176947c6ae99SBarry Smith     for (i=1; i<=s_y; i++) {
177047c6ae99SBarry Smith       if (n6 >= 0) { /* left above */
1771ce00eea3SSatish Balay         x_t = lx[n6 % m];
177247c6ae99SBarry Smith         /* y_t = ly[(n6/m)]; */
177347c6ae99SBarry Smith         s_t = bases[n6] + (i)*x_t - s_x;
177447c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1775ce00eea3SSatish Balay       } else if (xs-Xs > 0 && Ye-ye > 0) {
1776ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
177747c6ae99SBarry Smith       }
177847c6ae99SBarry Smith       if (n7 >= 0) { /* directly above */
177947c6ae99SBarry Smith         x_t = x;
178047c6ae99SBarry Smith         /* y_t = ly[(n7/m)]; */
178147c6ae99SBarry Smith         s_t = bases[n7] + (i-1)*x_t;
178247c6ae99SBarry Smith         for (j=0; j<x_t; j++) { idx[nn++] = s_t++;}
1783ce00eea3SSatish Balay       } else if (Ye-ye > 0) {
1784ce00eea3SSatish Balay         for (j=0; j<x; j++) { idx[nn++] = -1;}
178547c6ae99SBarry Smith       }
178647c6ae99SBarry Smith       if (n8 >= 0) { /* right above */
1787ce00eea3SSatish Balay         x_t = lx[n8 % m];
178847c6ae99SBarry Smith         /* y_t = ly[(n8/m)]; */
178947c6ae99SBarry Smith         s_t = bases[n8] + (i-1)*x_t;
179047c6ae99SBarry Smith         for (j=0; j<s_x; j++) { idx[nn++] = s_t++;}
1791ce00eea3SSatish Balay       } else if (Xe-xe > 0 && Ye-ye > 0) {
1792ce00eea3SSatish Balay         for (j=0; j<s_x; j++) { idx[nn++] = -1;}
179347c6ae99SBarry Smith       }
179447c6ae99SBarry Smith     }
179547c6ae99SBarry Smith   }
1796ce00eea3SSatish Balay   /*
1797ce00eea3SSatish Balay      Set the local to global ordering in the global vector, this allows use
1798ce00eea3SSatish Balay      of VecSetValuesLocal().
1799ce00eea3SSatish Balay   */
1800ce00eea3SSatish Balay   ierr = ISCreateBlock(comm,dof,nn,idx,PETSC_OWN_POINTER,&ltogis);CHKERRQ(ierr);
1801ce00eea3SSatish Balay   ierr = PetscMalloc(nn*dof*sizeof(PetscInt),&idx_cpy);CHKERRQ(ierr);
1802db87c5ecSEthan Coon   ierr = PetscLogObjectMemory(da,nn*dof*sizeof(PetscInt));CHKERRQ(ierr);
1803ce00eea3SSatish Balay   ierr = ISGetIndices(ltogis, &idx_full);
1804ce00eea3SSatish Balay   ierr = PetscMemcpy(idx_cpy,idx_full,nn*dof*sizeof(PetscInt));CHKERRQ(ierr);
1805ce00eea3SSatish Balay   ierr = ISRestoreIndices(ltogis, &idx_full);
1806ce00eea3SSatish Balay   ierr = ISLocalToGlobalMappingCreateIS(ltogis,&da->ltogmap);CHKERRQ(ierr);
1807ce00eea3SSatish Balay   ierr = PetscLogObjectParent(da,da->ltogmap);CHKERRQ(ierr);
1808fcfd50ebSBarry Smith   ierr = ISDestroy(&ltogis);CHKERRQ(ierr);
1809ce00eea3SSatish Balay   ierr = ISLocalToGlobalMappingBlock(da->ltogmap,dd->w,&da->ltogmapb);CHKERRQ(ierr);
1810ce00eea3SSatish Balay   ierr = PetscLogObjectParent(da,da->ltogmap);CHKERRQ(ierr);
181147c6ae99SBarry Smith 
1812ce00eea3SSatish Balay   ierr = PetscFree2(bases,ldims);CHKERRQ(ierr);
181347c6ae99SBarry Smith   dd->m  = m;  dd->n  = n;
1814ce00eea3SSatish Balay   /* note petsc expects xs/xe/Xs/Xe to be multiplied by #dofs in many places */
1815ce00eea3SSatish Balay   dd->xs = xs*dof; dd->xe = xe*dof; dd->ys = ys; dd->ye = ye; dd->zs = 0; dd->ze = 1;
1816ce00eea3SSatish Balay   dd->Xs = Xs*dof; dd->Xe = Xe*dof; dd->Ys = Ys; dd->Ye = Ye; dd->Zs = 0; dd->Ze = 1;
181747c6ae99SBarry Smith 
1818fcfd50ebSBarry Smith   ierr = VecDestroy(&local);CHKERRQ(ierr);
1819fcfd50ebSBarry Smith   ierr = VecDestroy(&global);CHKERRQ(ierr);
182047c6ae99SBarry Smith 
182147c6ae99SBarry Smith   dd->gtol      = gtol;
182247c6ae99SBarry Smith   dd->ltog      = ltog;
1823ce00eea3SSatish Balay   dd->idx       = idx_cpy;
1824ce00eea3SSatish Balay   dd->Nl        = nn*dof;
182547c6ae99SBarry Smith   dd->base      = base;
18269a42bb27SBarry Smith   da->ops->view = DMView_DA_2d;
182747c6ae99SBarry Smith   dd->ltol = PETSC_NULL;
182847c6ae99SBarry Smith   dd->ao   = PETSC_NULL;
182947c6ae99SBarry Smith 
183047c6ae99SBarry Smith   PetscFunctionReturn(0);
183147c6ae99SBarry Smith }
183247c6ae99SBarry Smith 
183347c6ae99SBarry Smith #undef __FUNCT__
1834aa219208SBarry Smith #define __FUNCT__ "DMDACreate2d"
183547c6ae99SBarry Smith /*@C
1836aa219208SBarry Smith    DMDACreate2d -  Creates an object that will manage the communication of  two-dimensional
183747c6ae99SBarry Smith    regular array data that is distributed across some processors.
183847c6ae99SBarry Smith 
183947c6ae99SBarry Smith    Collective on MPI_Comm
184047c6ae99SBarry Smith 
184147c6ae99SBarry Smith    Input Parameters:
184247c6ae99SBarry Smith +  comm - MPI communicator
18431321219cSEthan Coon .  bx,by - type of ghost nodes the array have.
18441321219cSEthan Coon          Use one of DMDA_BOUNDARY_NONE, DMDA_BOUNDARY_GHOSTED, DMDA_BOUNDARY_PERIODIC.
1845aa219208SBarry Smith .  stencil_type - stencil type.  Use either DMDA_STENCIL_BOX or DMDA_STENCIL_STAR.
184647c6ae99SBarry Smith .  M,N - global dimension in each direction of the array (use -M and or -N to indicate that it may be set to a different value
184747c6ae99SBarry Smith             from the command line with -da_grid_x <M> -da_grid_y <N>)
184847c6ae99SBarry Smith .  m,n - corresponding number of processors in each dimension
184947c6ae99SBarry Smith          (or PETSC_DECIDE to have calculated)
185047c6ae99SBarry Smith .  dof - number of degrees of freedom per node
185147c6ae99SBarry Smith .  s - stencil width
185247c6ae99SBarry Smith -  lx, ly - arrays containing the number of nodes in each cell along
185347c6ae99SBarry Smith            the x and y coordinates, or PETSC_NULL. If non-null, these
185447c6ae99SBarry Smith            must be of length as m and n, and the corresponding
185547c6ae99SBarry Smith            m and n cannot be PETSC_DECIDE. The sum of the lx[] entries
185647c6ae99SBarry Smith            must be M, and the sum of the ly[] entries must be N.
185747c6ae99SBarry Smith 
185847c6ae99SBarry Smith    Output Parameter:
185947c6ae99SBarry Smith .  da - the resulting distributed array object
186047c6ae99SBarry Smith 
186147c6ae99SBarry Smith    Options Database Key:
1862aa219208SBarry Smith +  -da_view - Calls DMView() at the conclusion of DMDACreate2d()
186347c6ae99SBarry Smith .  -da_grid_x <nx> - number of grid points in x direction, if M < 0
186447c6ae99SBarry Smith .  -da_grid_y <ny> - number of grid points in y direction, if N < 0
186547c6ae99SBarry Smith .  -da_processors_x <nx> - number of processors in x direction
186647c6ae99SBarry Smith .  -da_processors_y <ny> - number of processors in y direction
1867e0f5d30fSBarry Smith .  -da_refine_x <rx> - refinement ratio in x direction
1868e0f5d30fSBarry Smith .  -da_refine_y <ry> - refinement ratio in y direction
1869e0f5d30fSBarry Smith -  -da_refine <n> - refine the DMDA n times before creating, if M or N < 0
1870e0f5d30fSBarry Smith 
187147c6ae99SBarry Smith 
187247c6ae99SBarry Smith    Level: beginner
187347c6ae99SBarry Smith 
187447c6ae99SBarry Smith    Notes:
1875aa219208SBarry Smith    The stencil type DMDA_STENCIL_STAR with width 1 corresponds to the
1876aa219208SBarry Smith    standard 5-pt stencil, while DMDA_STENCIL_BOX with width 1 denotes
187747c6ae99SBarry Smith    the standard 9-pt stencil.
187847c6ae99SBarry Smith 
1879aa219208SBarry Smith    The array data itself is NOT stored in the DMDA, it is stored in Vec objects;
1880564755cdSBarry Smith    The appropriate vector objects can be obtained with calls to DMCreateGlobalVector()
1881564755cdSBarry Smith    and DMCreateLocalVector() and calls to VecDuplicate() if more are needed.
188247c6ae99SBarry Smith 
188347c6ae99SBarry Smith .keywords: distributed array, create, two-dimensional
188447c6ae99SBarry Smith 
1885aa219208SBarry Smith .seealso: DMDestroy(), DMView(), DMDACreate1d(), DMDACreate3d(), DMGlobalToLocalBegin(), DMDAGetRefinementFactor(),
1886aa219208SBarry Smith           DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMDALocalToLocalBegin(), DMDALocalToLocalEnd(), DMDASetRefinementFactor(),
1887d461ba97SBarry Smith           DMDAGetInfo(), DMCreateGlobalVector(), DMCreateLocalVector(), DMDACreateNaturalVector(), DMLoad(), DMDAGetOwnershipRanges()
188847c6ae99SBarry Smith 
188947c6ae99SBarry Smith @*/
1890fe16a2e9SBarry Smith 
18911321219cSEthan Coon PetscErrorCode  DMDACreate2d(MPI_Comm comm,DMDABoundaryType bx,DMDABoundaryType by,DMDAStencilType stencil_type,
18929a42bb27SBarry Smith                           PetscInt M,PetscInt N,PetscInt m,PetscInt n,PetscInt dof,PetscInt s,const PetscInt lx[],const PetscInt ly[],DM *da)
189347c6ae99SBarry Smith {
189447c6ae99SBarry Smith   PetscErrorCode ierr;
189547c6ae99SBarry Smith 
189647c6ae99SBarry Smith   PetscFunctionBegin;
1897aa219208SBarry Smith   ierr = DMDACreate(comm, da);CHKERRQ(ierr);
1898aa219208SBarry Smith   ierr = DMDASetDim(*da, 2);CHKERRQ(ierr);
1899aa219208SBarry Smith   ierr = DMDASetSizes(*da, M, N, 1);CHKERRQ(ierr);
1900aa219208SBarry Smith   ierr = DMDASetNumProcs(*da, m, n, PETSC_DECIDE);CHKERRQ(ierr);
1901755f258dSLisandro Dalcin   ierr = DMDASetBoundaryType(*da, bx, by, DMDA_BOUNDARY_NONE);CHKERRQ(ierr);
1902aa219208SBarry Smith   ierr = DMDASetDof(*da, dof);CHKERRQ(ierr);
1903aa219208SBarry Smith   ierr = DMDASetStencilType(*da, stencil_type);CHKERRQ(ierr);
1904aa219208SBarry Smith   ierr = DMDASetStencilWidth(*da, s);CHKERRQ(ierr);
1905aa219208SBarry Smith   ierr = DMDASetOwnershipRanges(*da, lx, ly, PETSC_NULL);CHKERRQ(ierr);
190647c6ae99SBarry Smith   /* This violates the behavior for other classes, but right now users expect negative dimensions to be handled this way */
19079a42bb27SBarry Smith   ierr = DMSetFromOptions(*da);CHKERRQ(ierr);
19089a42bb27SBarry Smith   ierr = DMSetUp(*da);CHKERRQ(ierr);
19097242296bSJed Brown   ierr = DMView_DA_Private(*da);CHKERRQ(ierr);
191047c6ae99SBarry Smith   PetscFunctionReturn(0);
191147c6ae99SBarry Smith }
1912