xref: /petsc/src/ts/utils/dmdats.c (revision 98921bda46e76d7aaed9e0138c5ff9d0ce93f355)
124989b8cSPeter Brune #include <petscdmda.h>          /*I "petscdmda.h" I*/
2af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
3af0996ceSBarry Smith #include <petsc/private/tsimpl.h>   /*I "petscts.h" I*/
451b4a12fSMatthew G. Knepley #include <petscdraw.h>
524989b8cSPeter Brune 
624989b8cSPeter Brune /* This structure holds the user-provided DMDA callbacks */
724989b8cSPeter Brune typedef struct {
824989b8cSPeter Brune   PetscErrorCode (*ifunctionlocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
924989b8cSPeter Brune   PetscErrorCode (*rhsfunctionlocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
10d1e9a80fSBarry Smith   PetscErrorCode (*ijacobianlocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
11d1e9a80fSBarry Smith   PetscErrorCode (*rhsjacobianlocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
1224989b8cSPeter Brune   void       *ifunctionlocalctx;
1324989b8cSPeter Brune   void       *ijacobianlocalctx;
1424989b8cSPeter Brune   void       *rhsfunctionlocalctx;
1524989b8cSPeter Brune   void       *rhsjacobianlocalctx;
1624989b8cSPeter Brune   InsertMode ifunctionlocalimode;
1724989b8cSPeter Brune   InsertMode rhsfunctionlocalimode;
18942e3340SBarry Smith } DMTS_DA;
1924989b8cSPeter Brune 
20942e3340SBarry Smith static PetscErrorCode DMTSDestroy_DMDA(DMTS sdm)
2124989b8cSPeter Brune {
2224989b8cSPeter Brune   PetscErrorCode ierr;
2324989b8cSPeter Brune 
2424989b8cSPeter Brune   PetscFunctionBegin;
2524989b8cSPeter Brune   ierr = PetscFree(sdm->data);CHKERRQ(ierr);
2624989b8cSPeter Brune   PetscFunctionReturn(0);
2724989b8cSPeter Brune }
2824989b8cSPeter Brune 
29d74926cbSBarry Smith static PetscErrorCode DMTSDuplicate_DMDA(DMTS oldsdm,DMTS sdm)
300313d0e0SJed Brown {
310313d0e0SJed Brown   PetscErrorCode ierr;
320313d0e0SJed Brown 
330313d0e0SJed Brown   PetscFunctionBegin;
34b00a9115SJed Brown   ierr = PetscNewLog(sdm,(DMTS_DA**)&sdm->data);CHKERRQ(ierr);
35942e3340SBarry Smith   if (oldsdm->data) {ierr = PetscMemcpy(sdm->data,oldsdm->data,sizeof(DMTS_DA));CHKERRQ(ierr);}
360313d0e0SJed Brown   PetscFunctionReturn(0);
370313d0e0SJed Brown }
380313d0e0SJed Brown 
39942e3340SBarry Smith static PetscErrorCode DMDATSGetContext(DM dm,DMTS sdm,DMTS_DA **dmdats)
4024989b8cSPeter Brune {
4124989b8cSPeter Brune   PetscErrorCode ierr;
4224989b8cSPeter Brune 
4324989b8cSPeter Brune   PetscFunctionBegin;
440298fd71SBarry Smith   *dmdats = NULL;
4524989b8cSPeter Brune   if (!sdm->data) {
46b00a9115SJed Brown     ierr = PetscNewLog(dm,(DMTS_DA**)&sdm->data);CHKERRQ(ierr);
47d74926cbSBarry Smith     sdm->ops->destroy   = DMTSDestroy_DMDA;
48d74926cbSBarry Smith     sdm->ops->duplicate = DMTSDuplicate_DMDA;
4924989b8cSPeter Brune   }
50942e3340SBarry Smith   *dmdats = (DMTS_DA*)sdm->data;
5124989b8cSPeter Brune   PetscFunctionReturn(0);
5224989b8cSPeter Brune }
5324989b8cSPeter Brune 
5424989b8cSPeter Brune static PetscErrorCode TSComputeIFunction_DMDA(TS ts,PetscReal ptime,Vec X,Vec Xdot,Vec F,void *ctx)
5524989b8cSPeter Brune {
5624989b8cSPeter Brune   PetscErrorCode ierr;
5724989b8cSPeter Brune   DM             dm;
58942e3340SBarry Smith   DMTS_DA        *dmdats = (DMTS_DA*)ctx;
5924989b8cSPeter Brune   DMDALocalInfo  info;
60d2fc88d6Ssepideh   Vec            Xloc,Xdotloc;
6124989b8cSPeter Brune   void           *x,*f,*xdot;
6224989b8cSPeter Brune 
6324989b8cSPeter Brune   PetscFunctionBegin;
6424989b8cSPeter Brune   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
65064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
66064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(F,VEC_CLASSID,5);
67ce94432eSBarry Smith   if (!dmdats->ifunctionlocal) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Corrupt context");
6824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
69d2fc88d6Ssepideh   ierr = DMGetLocalVector(dm,&Xdotloc);CHKERRQ(ierr);
70d2fc88d6Ssepideh   ierr = DMGlobalToLocalBegin(dm,Xdot,INSERT_VALUES,Xdotloc);CHKERRQ(ierr);
71d2fc88d6Ssepideh   ierr = DMGlobalToLocalEnd(dm,Xdot,INSERT_VALUES,Xdotloc);CHKERRQ(ierr);
7224989b8cSPeter Brune   ierr = DMGetLocalVector(dm,&Xloc);CHKERRQ(ierr);
7324989b8cSPeter Brune   ierr = DMGlobalToLocalBegin(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
7424989b8cSPeter Brune   ierr = DMGlobalToLocalEnd(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
7524989b8cSPeter Brune   ierr = DMDAGetLocalInfo(dm,&info);CHKERRQ(ierr);
7624989b8cSPeter Brune   ierr = DMDAVecGetArray(dm,Xloc,&x);CHKERRQ(ierr);
77d2fc88d6Ssepideh   ierr = DMDAVecGetArray(dm,Xdotloc,&xdot);CHKERRQ(ierr);
7824989b8cSPeter Brune   switch (dmdats->ifunctionlocalimode) {
7924989b8cSPeter Brune   case INSERT_VALUES: {
8024989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,F,&f);CHKERRQ(ierr);
8124989b8cSPeter Brune     CHKMEMQ;
8224989b8cSPeter Brune     ierr = (*dmdats->ifunctionlocal)(&info,ptime,x,xdot,f,dmdats->ifunctionlocalctx);CHKERRQ(ierr);
8324989b8cSPeter Brune     CHKMEMQ;
8424989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,F,&f);CHKERRQ(ierr);
8524989b8cSPeter Brune   } break;
8624989b8cSPeter Brune   case ADD_VALUES: {
8724989b8cSPeter Brune     Vec Floc;
8824989b8cSPeter Brune     ierr = DMGetLocalVector(dm,&Floc);CHKERRQ(ierr);
8924989b8cSPeter Brune     ierr = VecZeroEntries(Floc);CHKERRQ(ierr);
9024989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,Floc,&f);CHKERRQ(ierr);
9124989b8cSPeter Brune     CHKMEMQ;
9224989b8cSPeter Brune     ierr = (*dmdats->ifunctionlocal)(&info,ptime,x,xdot,f,dmdats->ifunctionlocalctx);CHKERRQ(ierr);
9324989b8cSPeter Brune     CHKMEMQ;
9424989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,Floc,&f);CHKERRQ(ierr);
9524989b8cSPeter Brune     ierr = VecZeroEntries(F);CHKERRQ(ierr);
9624989b8cSPeter Brune     ierr = DMLocalToGlobalBegin(dm,Floc,ADD_VALUES,F);CHKERRQ(ierr);
9724989b8cSPeter Brune     ierr = DMLocalToGlobalEnd(dm,Floc,ADD_VALUES,F);CHKERRQ(ierr);
9824989b8cSPeter Brune     ierr = DMRestoreLocalVector(dm,&Floc);CHKERRQ(ierr);
9924989b8cSPeter Brune   } break;
100*98921bdaSJacob Faibussowitsch   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_INCOMP,"Cannot use imode=%d",(int)dmdats->ifunctionlocalimode);
10124989b8cSPeter Brune   }
10224989b8cSPeter Brune   ierr = DMDAVecRestoreArray(dm,Xloc,&x);CHKERRQ(ierr);
10324989b8cSPeter Brune   ierr = DMRestoreLocalVector(dm,&Xloc);CHKERRQ(ierr);
104d2fc88d6Ssepideh   ierr = DMDAVecRestoreArray(dm,Xdotloc,&xdot);CHKERRQ(ierr);
105d2fc88d6Ssepideh   ierr = DMRestoreLocalVector(dm,&Xdotloc);CHKERRQ(ierr);
10624989b8cSPeter Brune   PetscFunctionReturn(0);
10724989b8cSPeter Brune }
10824989b8cSPeter Brune 
109d1e9a80fSBarry Smith static PetscErrorCode TSComputeIJacobian_DMDA(TS ts,PetscReal ptime,Vec X,Vec Xdot,PetscReal shift,Mat A,Mat B,void *ctx)
11024989b8cSPeter Brune {
11124989b8cSPeter Brune   PetscErrorCode ierr;
11224989b8cSPeter Brune   DM             dm;
113942e3340SBarry Smith   DMTS_DA        *dmdats = (DMTS_DA*)ctx;
11424989b8cSPeter Brune   DMDALocalInfo  info;
11524989b8cSPeter Brune   Vec            Xloc;
11624989b8cSPeter Brune   void           *x,*xdot;
11724989b8cSPeter Brune 
11824989b8cSPeter Brune   PetscFunctionBegin;
119ce94432eSBarry Smith   if (!dmdats->ifunctionlocal) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Corrupt context");
12024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
12124989b8cSPeter Brune 
12224989b8cSPeter Brune   if (dmdats->ijacobianlocal) {
12324989b8cSPeter Brune     ierr = DMGetLocalVector(dm,&Xloc);CHKERRQ(ierr);
12424989b8cSPeter Brune     ierr = DMGlobalToLocalBegin(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
12524989b8cSPeter Brune     ierr = DMGlobalToLocalEnd(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
12624989b8cSPeter Brune     ierr = DMDAGetLocalInfo(dm,&info);CHKERRQ(ierr);
12724989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,Xloc,&x);CHKERRQ(ierr);
12824989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,Xdot,&xdot);CHKERRQ(ierr);
12924989b8cSPeter Brune     CHKMEMQ;
130d1e9a80fSBarry Smith     ierr = (*dmdats->ijacobianlocal)(&info,ptime,x,xdot,shift,A,B,dmdats->ijacobianlocalctx);CHKERRQ(ierr);
13124989b8cSPeter Brune     CHKMEMQ;
13224989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,Xloc,&x);CHKERRQ(ierr);
13324989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,Xdot,&xdot);CHKERRQ(ierr);
13424989b8cSPeter Brune     ierr = DMRestoreLocalVector(dm,&Xloc);CHKERRQ(ierr);
135ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"TSComputeIJacobian_DMDA() called without calling DMDATSSetIJacobian()");
13624989b8cSPeter Brune   /* This will be redundant if the user called both, but it's too common to forget. */
13794ab13aaSBarry Smith   if (A != B) {
13894ab13aaSBarry Smith     ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
13994ab13aaSBarry Smith     ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
14024989b8cSPeter Brune   }
14124989b8cSPeter Brune   PetscFunctionReturn(0);
14224989b8cSPeter Brune }
14324989b8cSPeter Brune 
14424989b8cSPeter Brune static PetscErrorCode TSComputeRHSFunction_DMDA(TS ts,PetscReal ptime,Vec X,Vec F,void *ctx)
14524989b8cSPeter Brune {
14624989b8cSPeter Brune   PetscErrorCode ierr;
14724989b8cSPeter Brune   DM             dm;
148942e3340SBarry Smith   DMTS_DA        *dmdats = (DMTS_DA*)ctx;
14924989b8cSPeter Brune   DMDALocalInfo  info;
15024989b8cSPeter Brune   Vec            Xloc;
15124989b8cSPeter Brune   void           *x,*f;
15224989b8cSPeter Brune 
15324989b8cSPeter Brune   PetscFunctionBegin;
15424989b8cSPeter Brune   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
155064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
156064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(F,VEC_CLASSID,4);
157ce94432eSBarry Smith   if (!dmdats->rhsfunctionlocal) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Corrupt context");
15824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
15924989b8cSPeter Brune   ierr = DMGetLocalVector(dm,&Xloc);CHKERRQ(ierr);
16024989b8cSPeter Brune   ierr = DMGlobalToLocalBegin(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
16124989b8cSPeter Brune   ierr = DMGlobalToLocalEnd(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
16224989b8cSPeter Brune   ierr = DMDAGetLocalInfo(dm,&info);CHKERRQ(ierr);
16324989b8cSPeter Brune   ierr = DMDAVecGetArray(dm,Xloc,&x);CHKERRQ(ierr);
16424989b8cSPeter Brune   switch (dmdats->rhsfunctionlocalimode) {
16524989b8cSPeter Brune   case INSERT_VALUES: {
16624989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,F,&f);CHKERRQ(ierr);
16724989b8cSPeter Brune     CHKMEMQ;
16824989b8cSPeter Brune     ierr = (*dmdats->rhsfunctionlocal)(&info,ptime,x,f,dmdats->rhsfunctionlocalctx);CHKERRQ(ierr);
16924989b8cSPeter Brune     CHKMEMQ;
17024989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,F,&f);CHKERRQ(ierr);
17124989b8cSPeter Brune   } break;
17224989b8cSPeter Brune   case ADD_VALUES: {
17324989b8cSPeter Brune     Vec Floc;
17424989b8cSPeter Brune     ierr = DMGetLocalVector(dm,&Floc);CHKERRQ(ierr);
17524989b8cSPeter Brune     ierr = VecZeroEntries(Floc);CHKERRQ(ierr);
17624989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,Floc,&f);CHKERRQ(ierr);
17724989b8cSPeter Brune     CHKMEMQ;
17824989b8cSPeter Brune     ierr = (*dmdats->rhsfunctionlocal)(&info,ptime,x,f,dmdats->rhsfunctionlocalctx);CHKERRQ(ierr);
17924989b8cSPeter Brune     CHKMEMQ;
18024989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,Floc,&f);CHKERRQ(ierr);
18124989b8cSPeter Brune     ierr = VecZeroEntries(F);CHKERRQ(ierr);
18224989b8cSPeter Brune     ierr = DMLocalToGlobalBegin(dm,Floc,ADD_VALUES,F);CHKERRQ(ierr);
18324989b8cSPeter Brune     ierr = DMLocalToGlobalEnd(dm,Floc,ADD_VALUES,F);CHKERRQ(ierr);
18424989b8cSPeter Brune     ierr = DMRestoreLocalVector(dm,&Floc);CHKERRQ(ierr);
18524989b8cSPeter Brune   } break;
186*98921bdaSJacob Faibussowitsch   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_INCOMP,"Cannot use imode=%d",(int)dmdats->rhsfunctionlocalimode);
18724989b8cSPeter Brune   }
18824989b8cSPeter Brune   ierr = DMDAVecRestoreArray(dm,Xloc,&x);CHKERRQ(ierr);
18924989b8cSPeter Brune   ierr = DMRestoreLocalVector(dm,&Xloc);CHKERRQ(ierr);
19024989b8cSPeter Brune   PetscFunctionReturn(0);
19124989b8cSPeter Brune }
19224989b8cSPeter Brune 
193d1e9a80fSBarry Smith static PetscErrorCode TSComputeRHSJacobian_DMDA(TS ts,PetscReal ptime,Vec X,Mat A,Mat B,void *ctx)
19424989b8cSPeter Brune {
19524989b8cSPeter Brune   PetscErrorCode ierr;
19624989b8cSPeter Brune   DM             dm;
197942e3340SBarry Smith   DMTS_DA        *dmdats = (DMTS_DA*)ctx;
19824989b8cSPeter Brune   DMDALocalInfo  info;
19924989b8cSPeter Brune   Vec            Xloc;
20024989b8cSPeter Brune   void           *x;
20124989b8cSPeter Brune 
20224989b8cSPeter Brune   PetscFunctionBegin;
203ce94432eSBarry Smith   if (!dmdats->rhsfunctionlocal) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Corrupt context");
20424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
20524989b8cSPeter Brune 
20624989b8cSPeter Brune   if (dmdats->rhsjacobianlocal) {
20724989b8cSPeter Brune     ierr = DMGetLocalVector(dm,&Xloc);CHKERRQ(ierr);
20824989b8cSPeter Brune     ierr = DMGlobalToLocalBegin(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
20924989b8cSPeter Brune     ierr = DMGlobalToLocalEnd(dm,X,INSERT_VALUES,Xloc);CHKERRQ(ierr);
21024989b8cSPeter Brune     ierr = DMDAGetLocalInfo(dm,&info);CHKERRQ(ierr);
21124989b8cSPeter Brune     ierr = DMDAVecGetArray(dm,Xloc,&x);CHKERRQ(ierr);
21224989b8cSPeter Brune     CHKMEMQ;
213d1e9a80fSBarry Smith     ierr = (*dmdats->rhsjacobianlocal)(&info,ptime,x,A,B,dmdats->rhsjacobianlocalctx);CHKERRQ(ierr);
21424989b8cSPeter Brune     CHKMEMQ;
21524989b8cSPeter Brune     ierr = DMDAVecRestoreArray(dm,Xloc,&x);CHKERRQ(ierr);
21624989b8cSPeter Brune     ierr = DMRestoreLocalVector(dm,&Xloc);CHKERRQ(ierr);
217ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"TSComputeRHSJacobian_DMDA() called without calling DMDATSSetRHSJacobian()");
21824989b8cSPeter Brune   /* This will be redundant if the user called both, but it's too common to forget. */
21994ab13aaSBarry Smith   if (A != B) {
22094ab13aaSBarry Smith     ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
22194ab13aaSBarry Smith     ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
22224989b8cSPeter Brune   }
22324989b8cSPeter Brune   PetscFunctionReturn(0);
22424989b8cSPeter Brune }
22524989b8cSPeter Brune 
22624989b8cSPeter Brune /*@C
22724989b8cSPeter Brune    DMDATSSetRHSFunctionLocal - set a local residual evaluation function
22824989b8cSPeter Brune 
22924989b8cSPeter Brune    Logically Collective
23024989b8cSPeter Brune 
2314165533cSJose E. Roman    Input Parameters:
23224989b8cSPeter Brune +  dm - DM to associate callback with
233b398ffe5SPeter Brune .  imode - insert mode for the residual
23424989b8cSPeter Brune .  func - local residual evaluation
23524989b8cSPeter Brune -  ctx - optional context for local residual evaluation
23624989b8cSPeter Brune 
23724989b8cSPeter Brune    Calling sequence for func:
238b398ffe5SPeter Brune 
239b398ffe5SPeter Brune $ func(DMDALocalInfo info,PetscReal t,void *x,void *f,void *ctx)
240b398ffe5SPeter Brune 
24124989b8cSPeter Brune +  info - DMDALocalInfo defining the subdomain to evaluate the residual on
242b398ffe5SPeter Brune .  t - time at which to evaluate residual
243b398ffe5SPeter Brune .  x - array of local state information
244b398ffe5SPeter Brune .  f - output array of local residual information
245b398ffe5SPeter Brune -  ctx - optional user context
24624989b8cSPeter Brune 
24724989b8cSPeter Brune    Level: beginner
24824989b8cSPeter Brune 
2498e625dcfSPeter Brune .seealso: DMTSSetRHSFunction(), DMDATSSetRHSJacobianLocal(), DMDASNESSetFunctionLocal()
25024989b8cSPeter Brune @*/
2516c6b9e74SPeter Brune PetscErrorCode DMDATSSetRHSFunctionLocal(DM dm,InsertMode imode,DMDATSRHSFunctionLocal func,void *ctx)
25224989b8cSPeter Brune {
25324989b8cSPeter Brune   PetscErrorCode ierr;
254942e3340SBarry Smith   DMTS           sdm;
255942e3340SBarry Smith   DMTS_DA        *dmdats;
25624989b8cSPeter Brune 
25724989b8cSPeter Brune   PetscFunctionBegin;
25824989b8cSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
259942e3340SBarry Smith   ierr = DMGetDMTSWrite(dm,&sdm);CHKERRQ(ierr);
26024989b8cSPeter Brune   ierr = DMDATSGetContext(dm,sdm,&dmdats);CHKERRQ(ierr);
26124989b8cSPeter Brune   dmdats->rhsfunctionlocalimode = imode;
26224989b8cSPeter Brune   dmdats->rhsfunctionlocal      = func;
26324989b8cSPeter Brune   dmdats->rhsfunctionlocalctx   = ctx;
26424989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,TSComputeRHSFunction_DMDA,dmdats);CHKERRQ(ierr);
26524989b8cSPeter Brune   PetscFunctionReturn(0);
26624989b8cSPeter Brune }
26724989b8cSPeter Brune 
26824989b8cSPeter Brune /*@C
26924989b8cSPeter Brune    DMDATSSetRHSJacobianLocal - set a local residual evaluation function
27024989b8cSPeter Brune 
27124989b8cSPeter Brune    Logically Collective
27224989b8cSPeter Brune 
2734165533cSJose E. Roman    Input Parameters:
27424989b8cSPeter Brune +  dm    - DM to associate callback with
275b398ffe5SPeter Brune .  func  - local RHS Jacobian evaluation routine
276b398ffe5SPeter Brune -  ctx   - optional context for local jacobian evaluation
27724989b8cSPeter Brune 
27824989b8cSPeter Brune    Calling sequence for func:
279b398ffe5SPeter Brune 
2807f6be190SBarry Smith $ func(DMDALocalInfo* info,PetscReal t,void* x,Mat J,Mat B,void *ctx);
281b398ffe5SPeter Brune 
28224989b8cSPeter Brune +  info - DMDALocalInfo defining the subdomain to evaluate the residual on
283b398ffe5SPeter Brune .  t    - time at which to evaluate residual
284b398ffe5SPeter Brune .  x    - array of local state information
285b398ffe5SPeter Brune .  J    - Jacobian matrix
286b398ffe5SPeter Brune .  B    - preconditioner matrix; often same as J
28724989b8cSPeter Brune -  ctx  - optional context passed above
28824989b8cSPeter Brune 
28924989b8cSPeter Brune    Level: beginner
29024989b8cSPeter Brune 
2918e625dcfSPeter Brune .seealso: DMTSSetRHSJacobian(), DMDATSSetRHSFunctionLocal(), DMDASNESSetJacobianLocal()
29224989b8cSPeter Brune @*/
2936c6b9e74SPeter Brune PetscErrorCode DMDATSSetRHSJacobianLocal(DM dm,DMDATSRHSJacobianLocal func,void *ctx)
29424989b8cSPeter Brune {
29524989b8cSPeter Brune   PetscErrorCode ierr;
296942e3340SBarry Smith   DMTS           sdm;
297942e3340SBarry Smith   DMTS_DA        *dmdats;
29824989b8cSPeter Brune 
29924989b8cSPeter Brune   PetscFunctionBegin;
30024989b8cSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
301942e3340SBarry Smith   ierr = DMGetDMTSWrite(dm,&sdm);CHKERRQ(ierr);
30224989b8cSPeter Brune   ierr = DMDATSGetContext(dm,sdm,&dmdats);CHKERRQ(ierr);
30324989b8cSPeter Brune   dmdats->rhsjacobianlocal    = func;
30424989b8cSPeter Brune   dmdats->rhsjacobianlocalctx = ctx;
30524989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,TSComputeRHSJacobian_DMDA,dmdats);CHKERRQ(ierr);
30624989b8cSPeter Brune   PetscFunctionReturn(0);
30724989b8cSPeter Brune }
30824989b8cSPeter Brune 
30924989b8cSPeter Brune /*@C
31024989b8cSPeter Brune    DMDATSSetIFunctionLocal - set a local residual evaluation function
31124989b8cSPeter Brune 
31224989b8cSPeter Brune    Logically Collective
31324989b8cSPeter Brune 
3144165533cSJose E. Roman    Input Parameters:
31524989b8cSPeter Brune +  dm   - DM to associate callback with
31624989b8cSPeter Brune .  func - local residual evaluation
31724989b8cSPeter Brune -  ctx  - optional context for local residual evaluation
31824989b8cSPeter Brune 
31924989b8cSPeter Brune    Calling sequence for func:
32024989b8cSPeter Brune +  info - DMDALocalInfo defining the subdomain to evaluate the residual on
321b398ffe5SPeter Brune .  t    - time at which to evaluate residual
322b398ffe5SPeter Brune .  x    - array of local state information
323b398ffe5SPeter Brune .  xdot - array of local time derivative information
324b398ffe5SPeter Brune .  f    - output array of local function evaluation information
32524989b8cSPeter Brune -  ctx - optional context passed above
32624989b8cSPeter Brune 
32724989b8cSPeter Brune    Level: beginner
32824989b8cSPeter Brune 
3298e625dcfSPeter Brune .seealso: DMTSSetIFunction(), DMDATSSetIJacobianLocal(), DMDASNESSetFunctionLocal()
33024989b8cSPeter Brune @*/
3316c6b9e74SPeter Brune PetscErrorCode DMDATSSetIFunctionLocal(DM dm,InsertMode imode,DMDATSIFunctionLocal func,void *ctx)
33224989b8cSPeter Brune {
33324989b8cSPeter Brune   PetscErrorCode ierr;
334942e3340SBarry Smith   DMTS           sdm;
335942e3340SBarry Smith   DMTS_DA        *dmdats;
33624989b8cSPeter Brune 
33724989b8cSPeter Brune   PetscFunctionBegin;
33824989b8cSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
339942e3340SBarry Smith   ierr = DMGetDMTSWrite(dm,&sdm);CHKERRQ(ierr);
34024989b8cSPeter Brune   ierr = DMDATSGetContext(dm,sdm,&dmdats);CHKERRQ(ierr);
34124989b8cSPeter Brune   dmdats->ifunctionlocalimode = imode;
34224989b8cSPeter Brune   dmdats->ifunctionlocal      = func;
34324989b8cSPeter Brune   dmdats->ifunctionlocalctx   = ctx;
34424989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,TSComputeIFunction_DMDA,dmdats);CHKERRQ(ierr);
34524989b8cSPeter Brune   PetscFunctionReturn(0);
34624989b8cSPeter Brune }
34724989b8cSPeter Brune 
34824989b8cSPeter Brune /*@C
34924989b8cSPeter Brune    DMDATSSetIJacobianLocal - set a local residual evaluation function
35024989b8cSPeter Brune 
35124989b8cSPeter Brune    Logically Collective
35224989b8cSPeter Brune 
3534165533cSJose E. Roman    Input Parameters:
35424989b8cSPeter Brune +  dm   - DM to associate callback with
35524989b8cSPeter Brune .  func - local residual evaluation
35624989b8cSPeter Brune -  ctx   - optional context for local residual evaluation
35724989b8cSPeter Brune 
35824989b8cSPeter Brune    Calling sequence for func:
359b398ffe5SPeter Brune 
360dab4423fSBarry Smith $ func(DMDALocalInfo* info,PetscReal t,void* x,void *xdot,PetscScalar shift,Mat J,Mat B,void *ctx);
361b398ffe5SPeter Brune 
36224989b8cSPeter Brune +  info - DMDALocalInfo defining the subdomain to evaluate the residual on
363b398ffe5SPeter Brune .  t    - time at which to evaluate the jacobian
364b398ffe5SPeter Brune .  x    - array of local state information
365b398ffe5SPeter Brune .  xdot - time derivative at this state
366dab4423fSBarry Smith .  shift - see TSSetIJacobian() for the meaning of this parameter
367b398ffe5SPeter Brune .  J    - Jacobian matrix
368b398ffe5SPeter Brune .  B    - preconditioner matrix; often same as J
36924989b8cSPeter Brune -  ctx  - optional context passed above
37024989b8cSPeter Brune 
37124989b8cSPeter Brune    Level: beginner
37224989b8cSPeter Brune 
3738e625dcfSPeter Brune .seealso: DMTSSetJacobian(), DMDATSSetIFunctionLocal(), DMDASNESSetJacobianLocal()
37424989b8cSPeter Brune @*/
3756c6b9e74SPeter Brune PetscErrorCode DMDATSSetIJacobianLocal(DM dm,DMDATSIJacobianLocal func,void *ctx)
37624989b8cSPeter Brune {
37724989b8cSPeter Brune   PetscErrorCode ierr;
378942e3340SBarry Smith   DMTS           sdm;
379942e3340SBarry Smith   DMTS_DA        *dmdats;
38024989b8cSPeter Brune 
38124989b8cSPeter Brune   PetscFunctionBegin;
38224989b8cSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
383942e3340SBarry Smith   ierr = DMGetDMTSWrite(dm,&sdm);CHKERRQ(ierr);
38424989b8cSPeter Brune   ierr = DMDATSGetContext(dm,sdm,&dmdats);CHKERRQ(ierr);
38524989b8cSPeter Brune   dmdats->ijacobianlocal    = func;
38624989b8cSPeter Brune   dmdats->ijacobianlocalctx = ctx;
38724989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,TSComputeIJacobian_DMDA,dmdats);CHKERRQ(ierr);
38824989b8cSPeter Brune   PetscFunctionReturn(0);
38924989b8cSPeter Brune }
390d1212d36SBarry Smith 
391d1212d36SBarry Smith PetscErrorCode TSMonitorDMDARayDestroy(void **mctx)
392d1212d36SBarry Smith {
393d1212d36SBarry Smith   TSMonitorDMDARayCtx *rayctx = (TSMonitorDMDARayCtx *) *mctx;
394d1212d36SBarry Smith   PetscErrorCode       ierr;
395d1212d36SBarry Smith 
396d1212d36SBarry Smith   PetscFunctionBegin;
39751b4a12fSMatthew G. Knepley   if (rayctx->lgctx) {ierr = TSMonitorLGCtxDestroy(&rayctx->lgctx);CHKERRQ(ierr);}
398d1212d36SBarry Smith   ierr = VecDestroy(&rayctx->ray);CHKERRQ(ierr);
399d1212d36SBarry Smith   ierr = VecScatterDestroy(&rayctx->scatter);CHKERRQ(ierr);
400d1212d36SBarry Smith   ierr = PetscViewerDestroy(&rayctx->viewer);CHKERRQ(ierr);
401d1212d36SBarry Smith   ierr = PetscFree(rayctx);CHKERRQ(ierr);
402d1212d36SBarry Smith   PetscFunctionReturn(0);
403d1212d36SBarry Smith }
404d1212d36SBarry Smith 
405d1212d36SBarry Smith PetscErrorCode TSMonitorDMDARay(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
406d1212d36SBarry Smith {
407d1212d36SBarry Smith   TSMonitorDMDARayCtx *rayctx = (TSMonitorDMDARayCtx*)mctx;
408d1212d36SBarry Smith   Vec                 solution;
409d1212d36SBarry Smith   PetscErrorCode      ierr;
410d1212d36SBarry Smith 
411d1212d36SBarry Smith   PetscFunctionBegin;
412d1212d36SBarry Smith   ierr = TSGetSolution(ts,&solution);CHKERRQ(ierr);
413d1212d36SBarry Smith   ierr = VecScatterBegin(rayctx->scatter,solution,rayctx->ray,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
414d1212d36SBarry Smith   ierr = VecScatterEnd(rayctx->scatter,solution,rayctx->ray,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
415d1212d36SBarry Smith   if (rayctx->viewer) {
416d1212d36SBarry Smith     ierr = VecView(rayctx->ray,rayctx->viewer);CHKERRQ(ierr);
417d1212d36SBarry Smith   }
418d1212d36SBarry Smith   PetscFunctionReturn(0);
419d1212d36SBarry Smith }
42051b4a12fSMatthew G. Knepley 
42151b4a12fSMatthew G. Knepley PetscErrorCode  TSMonitorLGDMDARay(TS ts, PetscInt step, PetscReal ptime, Vec u, void *ctx)
42251b4a12fSMatthew G. Knepley {
42351b4a12fSMatthew G. Knepley   TSMonitorDMDARayCtx *rayctx = (TSMonitorDMDARayCtx *) ctx;
42451b4a12fSMatthew G. Knepley   TSMonitorLGCtx       lgctx  = (TSMonitorLGCtx) rayctx->lgctx;
42551b4a12fSMatthew G. Knepley   Vec                  v      = rayctx->ray;
42651b4a12fSMatthew G. Knepley   const PetscScalar   *a;
42751b4a12fSMatthew G. Knepley   PetscInt             dim;
42851b4a12fSMatthew G. Knepley   PetscErrorCode       ierr;
42951b4a12fSMatthew G. Knepley 
43051b4a12fSMatthew G. Knepley   PetscFunctionBegin;
43151b4a12fSMatthew G. Knepley   ierr = VecScatterBegin(rayctx->scatter, u, v, INSERT_VALUES, SCATTER_FORWARD);CHKERRQ(ierr);
43251b4a12fSMatthew G. Knepley   ierr = VecScatterEnd(rayctx->scatter, u, v, INSERT_VALUES, SCATTER_FORWARD);CHKERRQ(ierr);
43351b4a12fSMatthew G. Knepley   if (!step) {
43451b4a12fSMatthew G. Knepley     PetscDrawAxis axis;
43551b4a12fSMatthew G. Knepley 
43651b4a12fSMatthew G. Knepley     ierr = PetscDrawLGGetAxis(lgctx->lg, &axis);CHKERRQ(ierr);
43751b4a12fSMatthew G. Knepley     ierr = PetscDrawAxisSetLabels(axis, "Solution Ray as function of time", "Time", "Solution");CHKERRQ(ierr);
43851b4a12fSMatthew G. Knepley     ierr = VecGetLocalSize(rayctx->ray, &dim);CHKERRQ(ierr);
43951b4a12fSMatthew G. Knepley     ierr = PetscDrawLGSetDimension(lgctx->lg, dim);CHKERRQ(ierr);
44051b4a12fSMatthew G. Knepley     ierr = PetscDrawLGReset(lgctx->lg);CHKERRQ(ierr);
44151b4a12fSMatthew G. Knepley   }
44251b4a12fSMatthew G. Knepley   ierr = VecGetArrayRead(v, &a);CHKERRQ(ierr);
44351b4a12fSMatthew G. Knepley #if defined(PETSC_USE_COMPLEX)
44451b4a12fSMatthew G. Knepley   {
44551b4a12fSMatthew G. Knepley     PetscReal *areal;
44651b4a12fSMatthew G. Knepley     PetscInt   i,n;
44751b4a12fSMatthew G. Knepley     ierr = VecGetLocalSize(v, &n);CHKERRQ(ierr);
448785e854fSJed Brown     ierr = PetscMalloc1(n, &areal);CHKERRQ(ierr);
44951b4a12fSMatthew G. Knepley     for (i = 0; i < n; ++i) areal[i] = PetscRealPart(a[i]);
45051b4a12fSMatthew G. Knepley     ierr = PetscDrawLGAddCommonPoint(lgctx->lg, ptime, areal);CHKERRQ(ierr);
45151b4a12fSMatthew G. Knepley     ierr = PetscFree(areal);CHKERRQ(ierr);
45251b4a12fSMatthew G. Knepley   }
45351b4a12fSMatthew G. Knepley #else
45451b4a12fSMatthew G. Knepley   ierr = PetscDrawLGAddCommonPoint(lgctx->lg, ptime, a);CHKERRQ(ierr);
45551b4a12fSMatthew G. Knepley #endif
45651b4a12fSMatthew G. Knepley   ierr = VecRestoreArrayRead(v, &a);CHKERRQ(ierr);
45751b4a12fSMatthew G. Knepley   if (((lgctx->howoften > 0) && (!(step % lgctx->howoften))) || ((lgctx->howoften == -1) && ts->reason)) {
45851b4a12fSMatthew G. Knepley     ierr = PetscDrawLGDraw(lgctx->lg);CHKERRQ(ierr);
4596934998bSLisandro Dalcin     ierr = PetscDrawLGSave(lgctx->lg);CHKERRQ(ierr);
46051b4a12fSMatthew G. Knepley   }
46151b4a12fSMatthew G. Knepley   PetscFunctionReturn(0);
46251b4a12fSMatthew G. Knepley }
463