xref: /petsc/src/ts/impls/implicit/sundials/sundials.c (revision 09e82e2bd3302f8435a763d6c4e719fade28b049)
17cb94ee6SHong Zhang /*
2db268bfaSHong Zhang     Provides a PETSc interface to SUNDIALS/CVODE solver.
37cb94ee6SHong Zhang     The interface to PVODE (old version of CVODE) was originally contributed
47cb94ee6SHong Zhang     by Liyang Xu. It has been redone by Hong Zhang and Dinesh Kaushik.
528adb3f7SHong Zhang 
628adb3f7SHong Zhang     Reference: sundials-2.4.0/examples/cvode/parallel/cvDiurnal_kry_p.c
77cb94ee6SHong Zhang */
81c7d2463SJed Brown #include <../src/ts/impls/implicit/sundials/sundials.h>  /*I "petscts.h" I*/
97cb94ee6SHong Zhang 
107cb94ee6SHong Zhang /*
117cb94ee6SHong Zhang       TSPrecond_Sundials - function that we provide to SUNDIALS to
127cb94ee6SHong Zhang                         evaluate the preconditioner.
137cb94ee6SHong Zhang */
147cb94ee6SHong Zhang #undef __FUNCT__
157cb94ee6SHong Zhang #define __FUNCT__ "TSPrecond_Sundials"
16bbd56ea5SKarl Rupp PetscErrorCode TSPrecond_Sundials(realtype tn,N_Vector y,N_Vector fy,booleantype jok,booleantype *jcurPtr,
17bbd56ea5SKarl Rupp                                   realtype _gamma,void *P_data,N_Vector vtemp1,N_Vector vtemp2,N_Vector vtemp3)
187cb94ee6SHong Zhang {
197cb94ee6SHong Zhang   TS             ts     = (TS) P_data;
207cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
21dcbc6d53SSean Farley   PC             pc;
227cb94ee6SHong Zhang   PetscErrorCode ierr;
230679a0aeSJed Brown   Mat            J,P;
240679a0aeSJed Brown   Vec            yy  = cvode->w1,yydot = cvode->ydot;
250679a0aeSJed Brown   PetscReal      gm  = (PetscReal)_gamma;
267cb94ee6SHong Zhang   PetscScalar    *y_data;
277cb94ee6SHong Zhang 
287cb94ee6SHong Zhang   PetscFunctionBegin;
290298fd71SBarry Smith   ierr   = TSGetIJacobian(ts,&J,&P,NULL,NULL);CHKERRQ(ierr);
307cb94ee6SHong Zhang   y_data = (PetscScalar*) N_VGetArrayPointer(y);
317cb94ee6SHong Zhang   ierr   = VecPlaceArray(yy,y_data);CHKERRQ(ierr);
320679a0aeSJed Brown   ierr   = VecZeroEntries(yydot);CHKERRQ(ierr); /* The Jacobian is independent of Ydot for ODE which is all that CVode works for */
330679a0aeSJed Brown   /* compute the shifted Jacobian   (1/gm)*I + Jrest */
34*09e82e2bSBarry Smith   ierr     = TSComputeIJacobian(ts,ts->ptime,yy,yydot,1/gm,J,P,PETSC_FALSE);CHKERRQ(ierr);
357cb94ee6SHong Zhang   ierr     = VecResetArray(yy);CHKERRQ(ierr);
360679a0aeSJed Brown   ierr     = MatScale(P,gm);CHKERRQ(ierr); /* turn into I-gm*Jrest, J is not used by Sundials  */
377cb94ee6SHong Zhang   *jcurPtr = TRUE;
38dcbc6d53SSean Farley   ierr     = TSSundialsGetPC(ts,&pc);CHKERRQ(ierr);
39*09e82e2bSBarry Smith   ierr     = PCSetOperators(pc,J,P);CHKERRQ(ierr);
407cb94ee6SHong Zhang   PetscFunctionReturn(0);
417cb94ee6SHong Zhang }
427cb94ee6SHong Zhang 
437cb94ee6SHong Zhang /*
447cb94ee6SHong Zhang      TSPSolve_Sundials -  routine that we provide to Sundials that applies the preconditioner.
457cb94ee6SHong Zhang */
467cb94ee6SHong Zhang #undef __FUNCT__
477cb94ee6SHong Zhang #define __FUNCT__ "TSPSolve_Sundials"
484ac7836bSHong Zhang PetscErrorCode TSPSolve_Sundials(realtype tn,N_Vector y,N_Vector fy,N_Vector r,N_Vector z,
494ac7836bSHong Zhang                                  realtype _gamma,realtype delta,int lr,void *P_data,N_Vector vtemp)
507cb94ee6SHong Zhang {
517cb94ee6SHong Zhang   TS             ts     = (TS) P_data;
527cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
53dcbc6d53SSean Farley   PC             pc;
547cb94ee6SHong Zhang   Vec            rr = cvode->w1,zz = cvode->w2;
557cb94ee6SHong Zhang   PetscErrorCode ierr;
567cb94ee6SHong Zhang   PetscScalar    *r_data,*z_data;
577cb94ee6SHong Zhang 
587cb94ee6SHong Zhang   PetscFunctionBegin;
597cb94ee6SHong Zhang   /* Make the PETSc work vectors rr and zz point to the arrays in the SUNDIALS vectors r and z respectively*/
607cb94ee6SHong Zhang   r_data = (PetscScalar*) N_VGetArrayPointer(r);
617cb94ee6SHong Zhang   z_data = (PetscScalar*) N_VGetArrayPointer(z);
627cb94ee6SHong Zhang   ierr   = VecPlaceArray(rr,r_data);CHKERRQ(ierr);
637cb94ee6SHong Zhang   ierr   = VecPlaceArray(zz,z_data);CHKERRQ(ierr);
644ac7836bSHong Zhang 
657cb94ee6SHong Zhang   /* Solve the Px=r and put the result in zz */
66dcbc6d53SSean Farley   ierr = TSSundialsGetPC(ts,&pc);CHKERRQ(ierr);
677cb94ee6SHong Zhang   ierr = PCApply(pc,rr,zz);CHKERRQ(ierr);
687cb94ee6SHong Zhang   ierr = VecResetArray(rr);CHKERRQ(ierr);
697cb94ee6SHong Zhang   ierr = VecResetArray(zz);CHKERRQ(ierr);
707cb94ee6SHong Zhang   PetscFunctionReturn(0);
717cb94ee6SHong Zhang }
727cb94ee6SHong Zhang 
737cb94ee6SHong Zhang /*
747cb94ee6SHong Zhang         TSFunction_Sundials - routine that we provide to Sundials that applies the right hand side.
757cb94ee6SHong Zhang */
767cb94ee6SHong Zhang #undef __FUNCT__
777cb94ee6SHong Zhang #define __FUNCT__ "TSFunction_Sundials"
784ac7836bSHong Zhang int TSFunction_Sundials(realtype t,N_Vector y,N_Vector ydot,void *ctx)
797cb94ee6SHong Zhang {
807cb94ee6SHong Zhang   TS             ts = (TS) ctx;
815fcef5e4SJed Brown   DM             dm;
82942e3340SBarry Smith   DMTS           tsdm;
835fcef5e4SJed Brown   TSIFunction    ifunction;
84ce94432eSBarry Smith   MPI_Comm       comm;
857cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
860679a0aeSJed Brown   Vec            yy     = cvode->w1,yyd = cvode->w2,yydot = cvode->ydot;
877cb94ee6SHong Zhang   PetscScalar    *y_data,*ydot_data;
887cb94ee6SHong Zhang   PetscErrorCode ierr;
897cb94ee6SHong Zhang 
907cb94ee6SHong Zhang   PetscFunctionBegin;
91ce94432eSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
925ff03cf7SDinesh Kaushik   /* Make the PETSc work vectors yy and yyd point to the arrays in the SUNDIALS vectors y and ydot respectively*/
937cb94ee6SHong Zhang   y_data    = (PetscScalar*) N_VGetArrayPointer(y);
947cb94ee6SHong Zhang   ydot_data = (PetscScalar*) N_VGetArrayPointer(ydot);
954ac7836bSHong Zhang   ierr      = VecPlaceArray(yy,y_data);CHKERRABORT(comm,ierr);
964ac7836bSHong Zhang   ierr      = VecPlaceArray(yyd,ydot_data);CHKERRABORT(comm,ierr);
974ac7836bSHong Zhang 
985fcef5e4SJed Brown   /* Now compute the right hand side function, via IFunction unless only the more efficient RHSFunction is set */
995fcef5e4SJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
1010298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
1025fcef5e4SJed Brown   if (!ifunction) {
103bc0cc02bSJed Brown     ierr = TSComputeRHSFunction(ts,t,yy,yyd);CHKERRQ(ierr);
104bc0cc02bSJed Brown   } else {                      /* If rhsfunction is also set, this computes both parts and shifts them to the right */
105bc0cc02bSJed Brown     ierr = VecZeroEntries(yydot);CHKERRQ(ierr);
1060679a0aeSJed Brown     ierr = TSComputeIFunction(ts,t,yy,yydot,yyd,PETSC_FALSE);CHKERRABORT(comm,ierr);
1070679a0aeSJed Brown     ierr = VecScale(yyd,-1.);CHKERRQ(ierr);
108bc0cc02bSJed Brown   }
1097cb94ee6SHong Zhang   ierr = VecResetArray(yy);CHKERRABORT(comm,ierr);
1107cb94ee6SHong Zhang   ierr = VecResetArray(yyd);CHKERRABORT(comm,ierr);
1114ac7836bSHong Zhang   PetscFunctionReturn(0);
1127cb94ee6SHong Zhang }
1137cb94ee6SHong Zhang 
1147cb94ee6SHong Zhang /*
115b4eba00bSSean Farley        TSStep_Sundials - Calls Sundials to integrate the ODE.
1167cb94ee6SHong Zhang */
1177cb94ee6SHong Zhang #undef __FUNCT__
118b4eba00bSSean Farley #define __FUNCT__ "TSStep_Sundials"
119b4eba00bSSean Farley PetscErrorCode TSStep_Sundials(TS ts)
1207cb94ee6SHong Zhang {
1217cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
1227cb94ee6SHong Zhang   PetscErrorCode ierr;
123b4eba00bSSean Farley   PetscInt       flag;
1249f94935aSHong Zhang   long int       its,nsteps;
1257cb94ee6SHong Zhang   realtype       t,tout;
1267cb94ee6SHong Zhang   PetscScalar    *y_data;
1277cb94ee6SHong Zhang   void           *mem;
1287cb94ee6SHong Zhang 
1297cb94ee6SHong Zhang   PetscFunctionBegin;
13016016685SHong Zhang   mem  = cvode->mem;
1317cb94ee6SHong Zhang   tout = ts->max_time;
1327cb94ee6SHong Zhang   ierr = VecGetArray(ts->vec_sol,&y_data);CHKERRQ(ierr);
1337cb94ee6SHong Zhang   N_VSetArrayPointer((realtype*)y_data,cvode->y);
1340298fd71SBarry Smith   ierr = VecRestoreArray(ts->vec_sol,NULL);CHKERRQ(ierr);
135186e87acSLisandro Dalcin 
1363f2090d5SJed Brown   ierr = TSPreStep(ts);CHKERRQ(ierr);
137186e87acSLisandro Dalcin 
1389be3e283SDebojyoti Ghosh   /* We would like to call TSPreStep() when starting each step (including rejections), TSPreStage(),
1399be3e283SDebojyoti Ghosh    * and TSPostStage() before each stage solve, but CVode does not appear to support this. */
140bbd56ea5SKarl Rupp   if (cvode->monitorstep) flag = CVode(mem,tout,cvode->y,&t,CV_ONE_STEP);
141bbd56ea5SKarl Rupp   else flag = CVode(mem,tout,cvode->y,&t,CV_NORMAL);
1429f94935aSHong Zhang 
1439f94935aSHong Zhang   if (flag) { /* display error message */
1449f94935aSHong Zhang     switch (flag) {
1459f94935aSHong Zhang       case CV_ILL_INPUT:
1469f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ILL_INPUT");
1479f94935aSHong Zhang         break;
1489f94935aSHong Zhang       case CV_TOO_CLOSE:
1499f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_CLOSE");
1509f94935aSHong Zhang         break;
1513c7fefeeSJed Brown       case CV_TOO_MUCH_WORK: {
1529f94935aSHong Zhang         PetscReal      tcur;
1539f94935aSHong Zhang         ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr);
1549f94935aSHong Zhang         ierr = CVodeGetCurrentTime(mem,&tcur);CHKERRQ(ierr);
1557c8652ddSBarry Smith         SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_WORK. At t=%g, nsteps %D exceeds mxstep %D. Increase '-ts_max_steps <>' or modify TSSetDuration()",(double)tcur,nsteps,ts->max_steps);
1563c7fefeeSJed Brown       } break;
1579f94935aSHong Zhang       case CV_TOO_MUCH_ACC:
1589f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_ACC");
1599f94935aSHong Zhang         break;
1609f94935aSHong Zhang       case CV_ERR_FAILURE:
1619f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ERR_FAILURE");
1629f94935aSHong Zhang         break;
1639f94935aSHong Zhang       case CV_CONV_FAILURE:
1649f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_CONV_FAILURE");
1659f94935aSHong Zhang         break;
1669f94935aSHong Zhang       case CV_LINIT_FAIL:
1679f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LINIT_FAIL");
1689f94935aSHong Zhang         break;
1699f94935aSHong Zhang       case CV_LSETUP_FAIL:
1709f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSETUP_FAIL");
1719f94935aSHong Zhang         break;
1729f94935aSHong Zhang       case CV_LSOLVE_FAIL:
1739f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSOLVE_FAIL");
1749f94935aSHong Zhang         break;
1759f94935aSHong Zhang       case CV_RHSFUNC_FAIL:
1769f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RHSFUNC_FAIL");
1779f94935aSHong Zhang         break;
1789f94935aSHong Zhang       case CV_FIRST_RHSFUNC_ERR:
1799f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_FIRST_RHSFUNC_ERR");
1809f94935aSHong Zhang         break;
1819f94935aSHong Zhang       case CV_REPTD_RHSFUNC_ERR:
1829f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_REPTD_RHSFUNC_ERR");
1839f94935aSHong Zhang         break;
1849f94935aSHong Zhang       case CV_UNREC_RHSFUNC_ERR:
1859f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_UNREC_RHSFUNC_ERR");
1869f94935aSHong Zhang         break;
1879f94935aSHong Zhang       case CV_RTFUNC_FAIL:
1889f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RTFUNC_FAIL");
1899f94935aSHong Zhang         break;
1909f94935aSHong Zhang       default:
1919f94935aSHong Zhang         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, flag %d",flag);
1929f94935aSHong Zhang     }
1939f94935aSHong Zhang   }
1949f94935aSHong Zhang 
1957cb94ee6SHong Zhang   /* copy the solution from cvode->y to cvode->update and sol */
1967cb94ee6SHong Zhang   ierr = VecPlaceArray(cvode->w1,y_data);CHKERRQ(ierr);
1977cb94ee6SHong Zhang   ierr = VecCopy(cvode->w1,cvode->update);CHKERRQ(ierr);
1987cb94ee6SHong Zhang   ierr = VecResetArray(cvode->w1);CHKERRQ(ierr);
199bc0cc02bSJed Brown   ierr = VecCopy(cvode->update,ts->vec_sol);CHKERRQ(ierr);
2007cb94ee6SHong Zhang   ierr = CVodeGetNumNonlinSolvIters(mem,&its);CHKERRQ(ierr);
2014ac7836bSHong Zhang   ierr = CVSpilsGetNumLinIters(mem, &its);
2025ef26d82SJed Brown   ts->snes_its = its; ts->ksp_its = its;
203186e87acSLisandro Dalcin 
204186e87acSLisandro Dalcin   ts->time_step = t - ts->ptime;
205186e87acSLisandro Dalcin   ts->ptime     = t;
2067cb94ee6SHong Zhang   ts->steps++;
207186e87acSLisandro Dalcin 
2089f94935aSHong Zhang   ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr);
209b4eba00bSSean Farley   if (!cvode->monitorstep) ts->steps = nsteps;
210b4eba00bSSean Farley   PetscFunctionReturn(0);
211b4eba00bSSean Farley }
212b4eba00bSSean Farley 
213b4eba00bSSean Farley #undef __FUNCT__
214b4eba00bSSean Farley #define __FUNCT__ "TSInterpolate_Sundials"
215b4eba00bSSean Farley static PetscErrorCode TSInterpolate_Sundials(TS ts,PetscReal t,Vec X)
216b4eba00bSSean Farley {
217b4eba00bSSean Farley   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
218b4eba00bSSean Farley   N_Vector       y;
219b4eba00bSSean Farley   PetscErrorCode ierr;
220b4eba00bSSean Farley   PetscScalar    *x_data;
221b4eba00bSSean Farley   PetscInt       glosize,locsize;
222b4eba00bSSean Farley 
223b4eba00bSSean Farley   PetscFunctionBegin;
224b4eba00bSSean Farley   /* get the vector size */
225b4eba00bSSean Farley   ierr = VecGetSize(X,&glosize);CHKERRQ(ierr);
226b4eba00bSSean Farley   ierr = VecGetLocalSize(X,&locsize);CHKERRQ(ierr);
227b4eba00bSSean Farley 
228b4eba00bSSean Farley   /* allocate the memory for N_Vec y */
229b4eba00bSSean Farley   y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize);
230b4eba00bSSean Farley   if (!y) SETERRQ(PETSC_COMM_SELF,1,"Interpolated y is not allocated");
231b4eba00bSSean Farley 
232b4eba00bSSean Farley   ierr = VecGetArray(X,&x_data);CHKERRQ(ierr);
233b4eba00bSSean Farley   N_VSetArrayPointer((realtype*)x_data,y);
234b4eba00bSSean Farley   ierr = CVodeGetDky(cvode->mem,t,0,y);CHKERRQ(ierr);
235b4eba00bSSean Farley   ierr = VecRestoreArray(X,&x_data);CHKERRQ(ierr);
2367cb94ee6SHong Zhang   PetscFunctionReturn(0);
2377cb94ee6SHong Zhang }
2387cb94ee6SHong Zhang 
2397cb94ee6SHong Zhang #undef __FUNCT__
240277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset_Sundials"
241277b19d0SLisandro Dalcin PetscErrorCode TSReset_Sundials(TS ts)
242277b19d0SLisandro Dalcin {
243277b19d0SLisandro Dalcin   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
244277b19d0SLisandro Dalcin   PetscErrorCode ierr;
245277b19d0SLisandro Dalcin 
246277b19d0SLisandro Dalcin   PetscFunctionBegin;
2475c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->update);CHKERRQ(ierr);
2480679a0aeSJed Brown   ierr = VecDestroy(&cvode->ydot);CHKERRQ(ierr);
2495c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->w1);CHKERRQ(ierr);
2505c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->w2);CHKERRQ(ierr);
251bbd56ea5SKarl Rupp   if (cvode->mem) CVodeFree(&cvode->mem);
252277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
253277b19d0SLisandro Dalcin }
254277b19d0SLisandro Dalcin 
255277b19d0SLisandro Dalcin #undef __FUNCT__
2567cb94ee6SHong Zhang #define __FUNCT__ "TSDestroy_Sundials"
2577cb94ee6SHong Zhang PetscErrorCode TSDestroy_Sundials(TS ts)
2587cb94ee6SHong Zhang {
2597cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
2607cb94ee6SHong Zhang   PetscErrorCode ierr;
2617cb94ee6SHong Zhang 
2627cb94ee6SHong Zhang   PetscFunctionBegin;
263277b19d0SLisandro Dalcin   ierr = TSReset_Sundials(ts);CHKERRQ(ierr);
264a07356b8SSatish Balay   ierr = MPI_Comm_free(&(cvode->comm_sundials));CHKERRQ(ierr);
265277b19d0SLisandro Dalcin   ierr = PetscFree(ts->data);CHKERRQ(ierr);
266bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetType_C",NULL);CHKERRQ(ierr);
267bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxl_C",NULL);CHKERRQ(ierr);
268bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetLinearTolerance_C",NULL);CHKERRQ(ierr);
269bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetGramSchmidtType_C",NULL);CHKERRQ(ierr);
270bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetTolerance_C",NULL);CHKERRQ(ierr);
271bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMinTimeStep_C",NULL);CHKERRQ(ierr);
272bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxTimeStep_C",NULL);CHKERRQ(ierr);
273bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetPC_C",NULL);CHKERRQ(ierr);
274bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetIterations_C",NULL);CHKERRQ(ierr);
275bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsMonitorInternalSteps_C",NULL);CHKERRQ(ierr);
2767cb94ee6SHong Zhang   PetscFunctionReturn(0);
2777cb94ee6SHong Zhang }
2787cb94ee6SHong Zhang 
2797cb94ee6SHong Zhang #undef __FUNCT__
280214bc6a2SJed Brown #define __FUNCT__ "TSSetUp_Sundials"
281214bc6a2SJed Brown PetscErrorCode TSSetUp_Sundials(TS ts)
2827cb94ee6SHong Zhang {
2837cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
2847cb94ee6SHong Zhang   PetscErrorCode ierr;
28516016685SHong Zhang   PetscInt       glosize,locsize,i,flag;
2867cb94ee6SHong Zhang   PetscScalar    *y_data,*parray;
28716016685SHong Zhang   void           *mem;
288dcbc6d53SSean Farley   PC             pc;
28919fd82e9SBarry Smith   PCType         pctype;
290ace3abfcSBarry Smith   PetscBool      pcnone;
2917cb94ee6SHong Zhang 
2927cb94ee6SHong Zhang   PetscFunctionBegin;
2937cb94ee6SHong Zhang   /* get the vector size */
2947cb94ee6SHong Zhang   ierr = VecGetSize(ts->vec_sol,&glosize);CHKERRQ(ierr);
2957cb94ee6SHong Zhang   ierr = VecGetLocalSize(ts->vec_sol,&locsize);CHKERRQ(ierr);
2967cb94ee6SHong Zhang 
2977cb94ee6SHong Zhang   /* allocate the memory for N_Vec y */
298a07356b8SSatish Balay   cvode->y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize);
299e32f2f54SBarry Smith   if (!cvode->y) SETERRQ(PETSC_COMM_SELF,1,"cvode->y is not allocated");
3007cb94ee6SHong Zhang 
30128adb3f7SHong Zhang   /* initialize N_Vec y: copy ts->vec_sol to cvode->y */
3027cb94ee6SHong Zhang   ierr   = VecGetArray(ts->vec_sol,&parray);CHKERRQ(ierr);
3037cb94ee6SHong Zhang   y_data = (PetscScalar*) N_VGetArrayPointer(cvode->y);
3047cb94ee6SHong Zhang   for (i = 0; i < locsize; i++) y_data[i] = parray[i];
3050298fd71SBarry Smith   ierr = VecRestoreArray(ts->vec_sol,NULL);CHKERRQ(ierr);
30642528757SHong Zhang 
3077cb94ee6SHong Zhang   ierr = VecDuplicate(ts->vec_sol,&cvode->update);CHKERRQ(ierr);
3080679a0aeSJed Brown   ierr = VecDuplicate(ts->vec_sol,&cvode->ydot);CHKERRQ(ierr);
3093bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->update);CHKERRQ(ierr);
3103bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->ydot);CHKERRQ(ierr);
3117cb94ee6SHong Zhang 
3127cb94ee6SHong Zhang   /*
3137cb94ee6SHong Zhang     Create work vectors for the TSPSolve_Sundials() routine. Note these are
3147cb94ee6SHong Zhang     allocated with zero space arrays because the actual array space is provided
3157cb94ee6SHong Zhang     by Sundials and set using VecPlaceArray().
3167cb94ee6SHong Zhang   */
317ce94432eSBarry Smith   ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts),1,locsize,PETSC_DECIDE,0,&cvode->w1);CHKERRQ(ierr);
318ce94432eSBarry Smith   ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts),1,locsize,PETSC_DECIDE,0,&cvode->w2);CHKERRQ(ierr);
3193bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->w1);CHKERRQ(ierr);
3203bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->w2);CHKERRQ(ierr);
32116016685SHong Zhang 
32216016685SHong Zhang   /* Call CVodeCreate to create the solver memory and the use of a Newton iteration */
32316016685SHong Zhang   mem = CVodeCreate(cvode->cvode_type, CV_NEWTON);
324e32f2f54SBarry Smith   if (!mem) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"CVodeCreate() fails");
32516016685SHong Zhang   cvode->mem = mem;
32616016685SHong Zhang 
32716016685SHong Zhang   /* Set the pointer to user-defined data */
32816016685SHong Zhang   flag = CVodeSetUserData(mem, ts);
329e32f2f54SBarry Smith   if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetUserData() fails");
33016016685SHong Zhang 
331fc6b9e64SJed Brown   /* Sundials may choose to use a smaller initial step, but will never use a larger step. */
332cdbf8f93SLisandro Dalcin   flag = CVodeSetInitStep(mem,(realtype)ts->time_step);
333ce94432eSBarry Smith   if (flag) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetInitStep() failed");
334f1cd61daSJed Brown   if (cvode->mindt > 0) {
335f1cd61daSJed Brown     flag = CVodeSetMinStep(mem,(realtype)cvode->mindt);
3369f94935aSHong Zhang     if (flag) {
337ce94432eSBarry Smith       if (flag == CV_MEM_NULL) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed, cvode_mem pointer is NULL");
338ce94432eSBarry Smith       else if (flag == CV_ILL_INPUT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed, hmin is nonpositive or it exceeds the maximum allowable step size");
339ce94432eSBarry Smith       else SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed");
3409f94935aSHong Zhang     }
341f1cd61daSJed Brown   }
342f1cd61daSJed Brown   if (cvode->maxdt > 0) {
343f1cd61daSJed Brown     flag = CVodeSetMaxStep(mem,(realtype)cvode->maxdt);
344ce94432eSBarry Smith     if (flag) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMaxStep() failed");
345f1cd61daSJed Brown   }
346f1cd61daSJed Brown 
34716016685SHong Zhang   /* Call CVodeInit to initialize the integrator memory and specify the
34816016685SHong Zhang    * user's right hand side function in u'=f(t,u), the inital time T0, and
34916016685SHong Zhang    * the initial dependent variable vector cvode->y */
35016016685SHong Zhang   flag = CVodeInit(mem,TSFunction_Sundials,ts->ptime,cvode->y);
351bbd56ea5SKarl Rupp   if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeInit() fails, flag %d",flag);
35216016685SHong Zhang 
3539f94935aSHong Zhang   /* specifies scalar relative and absolute tolerances */
35416016685SHong Zhang   flag = CVodeSStolerances(mem,cvode->reltol,cvode->abstol);
355bbd56ea5SKarl Rupp   if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSStolerances() fails, flag %d",flag);
35616016685SHong Zhang 
3579f94935aSHong Zhang   /* Specify max num of steps to be taken by cvode in its attempt to reach the next output time */
3589f94935aSHong Zhang   flag = CVodeSetMaxNumSteps(mem,ts->max_steps);
35916016685SHong Zhang 
36016016685SHong Zhang   /* call CVSpgmr to use GMRES as the linear solver.        */
36116016685SHong Zhang   /* setup the ode integrator with the given preconditioner */
362dcbc6d53SSean Farley   ierr = TSSundialsGetPC(ts,&pc);CHKERRQ(ierr);
363dcbc6d53SSean Farley   ierr = PCGetType(pc,&pctype);CHKERRQ(ierr);
364251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCNONE,&pcnone);CHKERRQ(ierr);
36516016685SHong Zhang   if (pcnone) {
36616016685SHong Zhang     flag = CVSpgmr(mem,PREC_NONE,0);
367e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
36816016685SHong Zhang   } else {
369f61b2b6aSHong Zhang     flag = CVSpgmr(mem,PREC_LEFT,cvode->maxl);
370e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
37116016685SHong Zhang 
37216016685SHong Zhang     /* Set preconditioner and solve routines Precond and PSolve,
37316016685SHong Zhang      and the pointer to the user-defined block data */
37416016685SHong Zhang     flag = CVSpilsSetPreconditioner(mem,TSPrecond_Sundials,TSPSolve_Sundials);
375e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpilsSetPreconditioner() fails, flag %d", flag);
37616016685SHong Zhang   }
37716016685SHong Zhang 
37816016685SHong Zhang   flag = CVSpilsSetGSType(mem, MODIFIED_GS);
379e32f2f54SBarry Smith   if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmrSetGSType() fails, flag %d",flag);
3807cb94ee6SHong Zhang   PetscFunctionReturn(0);
3817cb94ee6SHong Zhang }
3827cb94ee6SHong Zhang 
3836fadb2cdSHong Zhang /* type of CVODE linear multistep method */
3846a6fc655SJed Brown const char *const TSSundialsLmmTypes[] = {"","ADAMS","BDF","TSSundialsLmmType","SUNDIALS_",0};
3856fadb2cdSHong Zhang /* type of G-S orthogonalization used by CVODE linear solver */
3866a6fc655SJed Brown const char *const TSSundialsGramSchmidtTypes[] = {"","MODIFIED","CLASSICAL","TSSundialsGramSchmidtType","SUNDIALS_",0};
387a04cf4d8SBarry Smith 
3887cb94ee6SHong Zhang #undef __FUNCT__
389214bc6a2SJed Brown #define __FUNCT__ "TSSetFromOptions_Sundials"
390214bc6a2SJed Brown PetscErrorCode TSSetFromOptions_Sundials(TS ts)
3917cb94ee6SHong Zhang {
3927cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
3937cb94ee6SHong Zhang   PetscErrorCode ierr;
3947cb94ee6SHong Zhang   int            indx;
395ace3abfcSBarry Smith   PetscBool      flag;
3967bda3a07SJed Brown   PC             pc;
3977cb94ee6SHong Zhang 
3987cb94ee6SHong Zhang   PetscFunctionBegin;
3997cb94ee6SHong Zhang   ierr = PetscOptionsHead("SUNDIALS ODE solver options");CHKERRQ(ierr);
4006fadb2cdSHong Zhang   ierr = PetscOptionsEList("-ts_sundials_type","Scheme","TSSundialsSetType",TSSundialsLmmTypes,3,TSSundialsLmmTypes[cvode->cvode_type],&indx,&flag);CHKERRQ(ierr);
4017cb94ee6SHong Zhang   if (flag) {
4026fadb2cdSHong Zhang     ierr = TSSundialsSetType(ts,(TSSundialsLmmType)indx);CHKERRQ(ierr);
4037cb94ee6SHong Zhang   }
4046fadb2cdSHong Zhang   ierr = PetscOptionsEList("-ts_sundials_gramschmidt_type","Type of orthogonalization","TSSundialsSetGramSchmidtType",TSSundialsGramSchmidtTypes,3,TSSundialsGramSchmidtTypes[cvode->gtype],&indx,&flag);CHKERRQ(ierr);
4057cb94ee6SHong Zhang   if (flag) {
4067cb94ee6SHong Zhang     ierr = TSSundialsSetGramSchmidtType(ts,(TSSundialsGramSchmidtType)indx);CHKERRQ(ierr);
4077cb94ee6SHong Zhang   }
4080298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_sundials_atol","Absolute tolerance for convergence","TSSundialsSetTolerance",cvode->abstol,&cvode->abstol,NULL);CHKERRQ(ierr);
4090298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_sundials_rtol","Relative tolerance for convergence","TSSundialsSetTolerance",cvode->reltol,&cvode->reltol,NULL);CHKERRQ(ierr);
4100298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_sundials_mindt","Minimum step size","TSSundialsSetMinTimeStep",cvode->mindt,&cvode->mindt,NULL);CHKERRQ(ierr);
4110298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_sundials_maxdt","Maximum step size","TSSundialsSetMaxTimeStep",cvode->maxdt,&cvode->maxdt,NULL);CHKERRQ(ierr);
4127cb94ee6SHong Zhang   ierr = PetscOptionsReal("-ts_sundials_linear_tolerance","Convergence tolerance for linear solve","TSSundialsSetLinearTolerance",cvode->linear_tol,&cvode->linear_tol,&flag);CHKERRQ(ierr);
413f61b2b6aSHong Zhang   ierr = PetscOptionsInt("-ts_sundials_maxl","Max dimension of the Krylov subspace","TSSundialsSetMaxl",cvode->maxl,&cvode->maxl,&flag);CHKERRQ(ierr);
4140298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_sundials_monitor_steps","Monitor SUNDIALS internel steps","TSSundialsMonitorInternalSteps",cvode->monitorstep,&cvode->monitorstep,NULL);CHKERRQ(ierr);
4157cb94ee6SHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
4167bda3a07SJed Brown   ierr = TSSundialsGetPC(ts,&pc);CHKERRQ(ierr);
4177bda3a07SJed Brown   ierr = PCSetFromOptions(pc);CHKERRQ(ierr);
4187cb94ee6SHong Zhang   PetscFunctionReturn(0);
4197cb94ee6SHong Zhang }
4207cb94ee6SHong Zhang 
4217cb94ee6SHong Zhang #undef __FUNCT__
4227cb94ee6SHong Zhang #define __FUNCT__ "TSView_Sundials"
4237cb94ee6SHong Zhang PetscErrorCode TSView_Sundials(TS ts,PetscViewer viewer)
4247cb94ee6SHong Zhang {
4257cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
4267cb94ee6SHong Zhang   PetscErrorCode ierr;
4277cb94ee6SHong Zhang   char           *type;
4287cb94ee6SHong Zhang   char           atype[] = "Adams";
4297cb94ee6SHong Zhang   char           btype[] = "BDF: backward differentiation formula";
430ace3abfcSBarry Smith   PetscBool      iascii,isstring;
4312c823083SHong Zhang   long int       nsteps,its,nfevals,nlinsetups,nfails,itmp;
4322c823083SHong Zhang   PetscInt       qlast,qcur;
4335d47aee6SHong Zhang   PetscReal      hinused,hlast,hcur,tcur,tolsfac;
43442528757SHong Zhang   PC             pc;
4357cb94ee6SHong Zhang 
4367cb94ee6SHong Zhang   PetscFunctionBegin;
437bbd56ea5SKarl Rupp   if (cvode->cvode_type == SUNDIALS_ADAMS) type = atype;
438bbd56ea5SKarl Rupp   else                                     type = btype;
4397cb94ee6SHong Zhang 
440251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
441251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
4427cb94ee6SHong Zhang   if (iascii) {
4437cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater does not use SNES!\n");CHKERRQ(ierr);
4447cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater type %s\n",type);CHKERRQ(ierr);
4457cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials abs tol %g rel tol %g\n",cvode->abstol,cvode->reltol);CHKERRQ(ierr);
4467cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials linear solver tolerance factor %g\n",cvode->linear_tol);CHKERRQ(ierr);
447f61b2b6aSHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials max dimension of Krylov subspace %D\n",cvode->maxl);CHKERRQ(ierr);
4487cb94ee6SHong Zhang     if (cvode->gtype == SUNDIALS_MODIFIED_GS) {
4497cb94ee6SHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"Sundials using modified Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr);
4507cb94ee6SHong Zhang     } else {
4517cb94ee6SHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"Sundials using unmodified (classical) Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr);
4527cb94ee6SHong Zhang     }
453f1cd61daSJed Brown     if (cvode->mindt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials minimum time step %g\n",cvode->mindt);CHKERRQ(ierr);}
454f1cd61daSJed Brown     if (cvode->maxdt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials maximum time step %g\n",cvode->maxdt);CHKERRQ(ierr);}
4552c823083SHong Zhang 
4565d47aee6SHong Zhang     /* Outputs from CVODE, CVSPILS */
4575d47aee6SHong Zhang     ierr = CVodeGetTolScaleFactor(cvode->mem,&tolsfac);CHKERRQ(ierr);
4585d47aee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials suggested factor for tolerance scaling %g\n",tolsfac);CHKERRQ(ierr);
4592c823083SHong Zhang     ierr = CVodeGetIntegratorStats(cvode->mem,&nsteps,&nfevals,
4602c823083SHong Zhang                                    &nlinsetups,&nfails,&qlast,&qcur,
4612c823083SHong Zhang                                    &hinused,&hlast,&hcur,&tcur);CHKERRQ(ierr);
4622c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials cumulative number of internal steps %D\n",nsteps);CHKERRQ(ierr);
4632c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to rhs function %D\n",nfevals);CHKERRQ(ierr);
4642c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to linear solver setup function %D\n",nlinsetups);CHKERRQ(ierr);
4652c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of error test failures %D\n",nfails);CHKERRQ(ierr);
4662c823083SHong Zhang 
4672c823083SHong Zhang     ierr = CVodeGetNonlinSolvStats(cvode->mem,&its,&nfails);CHKERRQ(ierr);
4682c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear solver iterations %D\n",its);CHKERRQ(ierr);
4692c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear convergence failure %D\n",nfails);CHKERRQ(ierr);
4702c823083SHong Zhang 
4712c823083SHong Zhang     ierr = CVSpilsGetNumLinIters(cvode->mem, &its);CHKERRQ(ierr); /* its = no. of calls to TSPrecond_Sundials() */
4722c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear iterations %D\n",its);CHKERRQ(ierr);
4732c823083SHong Zhang     ierr = CVSpilsGetNumConvFails(cvode->mem,&itmp);CHKERRQ(ierr);
4742c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear convergence failures %D\n",itmp);CHKERRQ(ierr);
47542528757SHong Zhang 
47642528757SHong Zhang     ierr = TSSundialsGetPC(ts,&pc);CHKERRQ(ierr);
47742528757SHong Zhang     ierr = PCView(pc,viewer);CHKERRQ(ierr);
4782c823083SHong Zhang     ierr = CVSpilsGetNumPrecEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4792c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner evaluations %D\n",itmp);CHKERRQ(ierr);
4802c823083SHong Zhang     ierr = CVSpilsGetNumPrecSolves(cvode->mem,&itmp);CHKERRQ(ierr);
4812c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner solves %D\n",itmp);CHKERRQ(ierr);
48242528757SHong Zhang 
4832c823083SHong Zhang     ierr = CVSpilsGetNumJtimesEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4842c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of Jacobian-vector product evaluations %D\n",itmp);CHKERRQ(ierr);
4852c823083SHong Zhang     ierr = CVSpilsGetNumRhsEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4862c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of rhs calls for finite diff. Jacobian-vector evals %D\n",itmp);CHKERRQ(ierr);
4877cb94ee6SHong Zhang   } else if (isstring) {
4887cb94ee6SHong Zhang     ierr = PetscViewerStringSPrintf(viewer,"Sundials type %s",type);CHKERRQ(ierr);
4897cb94ee6SHong Zhang   }
4907cb94ee6SHong Zhang   PetscFunctionReturn(0);
4917cb94ee6SHong Zhang }
4927cb94ee6SHong Zhang 
4937cb94ee6SHong Zhang 
4947cb94ee6SHong Zhang /* --------------------------------------------------------------------------*/
4957cb94ee6SHong Zhang #undef __FUNCT__
4967cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType_Sundials"
4977087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType_Sundials(TS ts,TSSundialsLmmType type)
4987cb94ee6SHong Zhang {
4997cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5007cb94ee6SHong Zhang 
5017cb94ee6SHong Zhang   PetscFunctionBegin;
5027cb94ee6SHong Zhang   cvode->cvode_type = type;
5037cb94ee6SHong Zhang   PetscFunctionReturn(0);
5047cb94ee6SHong Zhang }
5057cb94ee6SHong Zhang 
5067cb94ee6SHong Zhang #undef __FUNCT__
507f61b2b6aSHong Zhang #define __FUNCT__ "TSSundialsSetMaxl_Sundials"
508f61b2b6aSHong Zhang PetscErrorCode  TSSundialsSetMaxl_Sundials(TS ts,PetscInt maxl)
5097cb94ee6SHong Zhang {
5107cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5117cb94ee6SHong Zhang 
5127cb94ee6SHong Zhang   PetscFunctionBegin;
513f61b2b6aSHong Zhang   cvode->maxl = maxl;
5147cb94ee6SHong Zhang   PetscFunctionReturn(0);
5157cb94ee6SHong Zhang }
5167cb94ee6SHong Zhang 
5177cb94ee6SHong Zhang #undef __FUNCT__
5187cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance_Sundials"
5197087cfbeSBarry Smith PetscErrorCode  TSSundialsSetLinearTolerance_Sundials(TS ts,double tol)
5207cb94ee6SHong Zhang {
5217cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5227cb94ee6SHong Zhang 
5237cb94ee6SHong Zhang   PetscFunctionBegin;
5247cb94ee6SHong Zhang   cvode->linear_tol = tol;
5257cb94ee6SHong Zhang   PetscFunctionReturn(0);
5267cb94ee6SHong Zhang }
5277cb94ee6SHong Zhang 
5287cb94ee6SHong Zhang #undef __FUNCT__
5297cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType_Sundials"
5307087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType_Sundials(TS ts,TSSundialsGramSchmidtType type)
5317cb94ee6SHong Zhang {
5327cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5337cb94ee6SHong Zhang 
5347cb94ee6SHong Zhang   PetscFunctionBegin;
5357cb94ee6SHong Zhang   cvode->gtype = type;
5367cb94ee6SHong Zhang   PetscFunctionReturn(0);
5377cb94ee6SHong Zhang }
5387cb94ee6SHong Zhang 
5397cb94ee6SHong Zhang #undef __FUNCT__
5407cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance_Sundials"
5417087cfbeSBarry Smith PetscErrorCode  TSSundialsSetTolerance_Sundials(TS ts,double aabs,double rel)
5427cb94ee6SHong Zhang {
5437cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5447cb94ee6SHong Zhang 
5457cb94ee6SHong Zhang   PetscFunctionBegin;
5467cb94ee6SHong Zhang   if (aabs != PETSC_DECIDE) cvode->abstol = aabs;
5477cb94ee6SHong Zhang   if (rel != PETSC_DECIDE)  cvode->reltol = rel;
5487cb94ee6SHong Zhang   PetscFunctionReturn(0);
5497cb94ee6SHong Zhang }
5507cb94ee6SHong Zhang 
5517cb94ee6SHong Zhang #undef __FUNCT__
552f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep_Sundials"
5537087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep_Sundials(TS ts,PetscReal mindt)
554f1cd61daSJed Brown {
555f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
556f1cd61daSJed Brown 
557f1cd61daSJed Brown   PetscFunctionBegin;
558f1cd61daSJed Brown   cvode->mindt = mindt;
559f1cd61daSJed Brown   PetscFunctionReturn(0);
560f1cd61daSJed Brown }
561f1cd61daSJed Brown 
562f1cd61daSJed Brown #undef __FUNCT__
563f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep_Sundials"
5647087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep_Sundials(TS ts,PetscReal maxdt)
565f1cd61daSJed Brown {
566f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
567f1cd61daSJed Brown 
568f1cd61daSJed Brown   PetscFunctionBegin;
569f1cd61daSJed Brown   cvode->maxdt = maxdt;
570f1cd61daSJed Brown   PetscFunctionReturn(0);
571f1cd61daSJed Brown }
572f1cd61daSJed Brown #undef __FUNCT__
5737cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC_Sundials"
5747087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC_Sundials(TS ts,PC *pc)
5757cb94ee6SHong Zhang {
576dcbc6d53SSean Farley   SNES           snes;
577dcbc6d53SSean Farley   KSP            ksp;
578dcbc6d53SSean Farley   PetscErrorCode ierr;
5797cb94ee6SHong Zhang 
5807cb94ee6SHong Zhang   PetscFunctionBegin;
581dcbc6d53SSean Farley   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
582dcbc6d53SSean Farley   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
583dcbc6d53SSean Farley   ierr = KSPGetPC(ksp,pc);CHKERRQ(ierr);
5847cb94ee6SHong Zhang   PetscFunctionReturn(0);
5857cb94ee6SHong Zhang }
5867cb94ee6SHong Zhang 
5877cb94ee6SHong Zhang #undef __FUNCT__
5887cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations_Sundials"
5897087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations_Sundials(TS ts,int *nonlin,int *lin)
5907cb94ee6SHong Zhang {
5917cb94ee6SHong Zhang   PetscFunctionBegin;
5925ef26d82SJed Brown   if (nonlin) *nonlin = ts->snes_its;
5935ef26d82SJed Brown   if (lin)    *lin    = ts->ksp_its;
5947cb94ee6SHong Zhang   PetscFunctionReturn(0);
5957cb94ee6SHong Zhang }
5967cb94ee6SHong Zhang 
5977cb94ee6SHong Zhang #undef __FUNCT__
5982bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps_Sundials"
5997087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps_Sundials(TS ts,PetscBool s)
6002bfc04deSHong Zhang {
6012bfc04deSHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
6022bfc04deSHong Zhang 
6032bfc04deSHong Zhang   PetscFunctionBegin;
6042bfc04deSHong Zhang   cvode->monitorstep = s;
6052bfc04deSHong Zhang   PetscFunctionReturn(0);
6062bfc04deSHong Zhang }
6077cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
6087cb94ee6SHong Zhang 
6097cb94ee6SHong Zhang #undef __FUNCT__
6107cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations"
6117cb94ee6SHong Zhang /*@C
6127cb94ee6SHong Zhang    TSSundialsGetIterations - Gets the number of nonlinear and linear iterations used so far by Sundials.
6137cb94ee6SHong Zhang 
6147cb94ee6SHong Zhang    Not Collective
6157cb94ee6SHong Zhang 
6167cb94ee6SHong Zhang    Input parameters:
6177cb94ee6SHong Zhang .    ts     - the time-step context
6187cb94ee6SHong Zhang 
6197cb94ee6SHong Zhang    Output Parameters:
6207cb94ee6SHong Zhang +   nonlin - number of nonlinear iterations
6217cb94ee6SHong Zhang -   lin    - number of linear iterations
6227cb94ee6SHong Zhang 
6237cb94ee6SHong Zhang    Level: advanced
6247cb94ee6SHong Zhang 
6257cb94ee6SHong Zhang    Notes:
6267cb94ee6SHong Zhang     These return the number since the creation of the TS object
6277cb94ee6SHong Zhang 
6287cb94ee6SHong Zhang .keywords: non-linear iterations, linear iterations
6297cb94ee6SHong Zhang 
630f61b2b6aSHong Zhang .seealso: TSSundialsSetType(), TSSundialsSetMaxl(),
6317cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
632f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
633a43b19c4SJed Brown           TSSundialsSetLinearTolerance(), TSSundialsGetPC(), TSSetExactFinalTime()
6347cb94ee6SHong Zhang 
6357cb94ee6SHong Zhang @*/
6367087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations(TS ts,int *nonlin,int *lin)
6377cb94ee6SHong Zhang {
6384ac538c5SBarry Smith   PetscErrorCode ierr;
6397cb94ee6SHong Zhang 
6407cb94ee6SHong Zhang   PetscFunctionBegin;
6414ac538c5SBarry Smith   ierr = PetscUseMethod(ts,"TSSundialsGetIterations_C",(TS,int*,int*),(ts,nonlin,lin));CHKERRQ(ierr);
6427cb94ee6SHong Zhang   PetscFunctionReturn(0);
6437cb94ee6SHong Zhang }
6447cb94ee6SHong Zhang 
6457cb94ee6SHong Zhang #undef __FUNCT__
6467cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType"
6477cb94ee6SHong Zhang /*@
6487cb94ee6SHong Zhang    TSSundialsSetType - Sets the method that Sundials will use for integration.
6497cb94ee6SHong Zhang 
6503f9fe445SBarry Smith    Logically Collective on TS
6517cb94ee6SHong Zhang 
6527cb94ee6SHong Zhang    Input parameters:
6537cb94ee6SHong Zhang +    ts     - the time-step context
6547cb94ee6SHong Zhang -    type   - one of  SUNDIALS_ADAMS or SUNDIALS_BDF
6557cb94ee6SHong Zhang 
6567cb94ee6SHong Zhang    Level: intermediate
6577cb94ee6SHong Zhang 
6587cb94ee6SHong Zhang .keywords: Adams, backward differentiation formula
6597cb94ee6SHong Zhang 
660f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(),  TSSundialsSetMaxl(),
6617cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
662f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
6637cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
664a43b19c4SJed Brown           TSSetExactFinalTime()
6657cb94ee6SHong Zhang @*/
6667087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType(TS ts,TSSundialsLmmType type)
6677cb94ee6SHong Zhang {
6684ac538c5SBarry Smith   PetscErrorCode ierr;
6697cb94ee6SHong Zhang 
6707cb94ee6SHong Zhang   PetscFunctionBegin;
6714ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetType_C",(TS,TSSundialsLmmType),(ts,type));CHKERRQ(ierr);
6727cb94ee6SHong Zhang   PetscFunctionReturn(0);
6737cb94ee6SHong Zhang }
6747cb94ee6SHong Zhang 
6757cb94ee6SHong Zhang #undef __FUNCT__
676f61b2b6aSHong Zhang #define __FUNCT__ "TSSundialsSetMaxl"
6777cb94ee6SHong Zhang /*@
678f61b2b6aSHong Zhang    TSSundialsSetMaxl - Sets the dimension of the Krylov space used by
6797cb94ee6SHong Zhang        GMRES in the linear solver in SUNDIALS. SUNDIALS DOES NOT use restarted GMRES so
680f61b2b6aSHong Zhang        this is the maximum number of GMRES steps that will be used.
6817cb94ee6SHong Zhang 
6823f9fe445SBarry Smith    Logically Collective on TS
6837cb94ee6SHong Zhang 
6847cb94ee6SHong Zhang    Input parameters:
6857cb94ee6SHong Zhang +    ts      - the time-step context
686f61b2b6aSHong Zhang -    maxl - number of direction vectors (the dimension of Krylov subspace).
6877cb94ee6SHong Zhang 
6887cb94ee6SHong Zhang    Level: advanced
6897cb94ee6SHong Zhang 
690f61b2b6aSHong Zhang .keywords: GMRES
6917cb94ee6SHong Zhang 
6927cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(),
6937cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
694f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
6957cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
696a43b19c4SJed Brown           TSSetExactFinalTime()
6977cb94ee6SHong Zhang 
6987cb94ee6SHong Zhang @*/
699f61b2b6aSHong Zhang PetscErrorCode  TSSundialsSetMaxl(TS ts,PetscInt maxl)
7007cb94ee6SHong Zhang {
7014ac538c5SBarry Smith   PetscErrorCode ierr;
7027cb94ee6SHong Zhang 
7037cb94ee6SHong Zhang   PetscFunctionBegin;
704f61b2b6aSHong Zhang   PetscValidLogicalCollectiveInt(ts,maxl,2);
705f61b2b6aSHong Zhang   ierr = PetscTryMethod(ts,"TSSundialsSetMaxl_C",(TS,PetscInt),(ts,maxl));CHKERRQ(ierr);
7067cb94ee6SHong Zhang   PetscFunctionReturn(0);
7077cb94ee6SHong Zhang }
7087cb94ee6SHong Zhang 
7097cb94ee6SHong Zhang #undef __FUNCT__
7107cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance"
7117cb94ee6SHong Zhang /*@
7127cb94ee6SHong Zhang    TSSundialsSetLinearTolerance - Sets the tolerance used to solve the linear
7137cb94ee6SHong Zhang        system by SUNDIALS.
7147cb94ee6SHong Zhang 
7153f9fe445SBarry Smith    Logically Collective on TS
7167cb94ee6SHong Zhang 
7177cb94ee6SHong Zhang    Input parameters:
7187cb94ee6SHong Zhang +    ts     - the time-step context
7197cb94ee6SHong Zhang -    tol    - the factor by which the tolerance on the nonlinear solver is
7207cb94ee6SHong Zhang              multiplied to get the tolerance on the linear solver, .05 by default.
7217cb94ee6SHong Zhang 
7227cb94ee6SHong Zhang    Level: advanced
7237cb94ee6SHong Zhang 
7247cb94ee6SHong Zhang .keywords: GMRES, linear convergence tolerance, SUNDIALS
7257cb94ee6SHong Zhang 
726f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
7277cb94ee6SHong Zhang           TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
728f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7297cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
730a43b19c4SJed Brown           TSSetExactFinalTime()
7317cb94ee6SHong Zhang 
7327cb94ee6SHong Zhang @*/
7337087cfbeSBarry Smith PetscErrorCode  TSSundialsSetLinearTolerance(TS ts,double tol)
7347cb94ee6SHong Zhang {
7354ac538c5SBarry Smith   PetscErrorCode ierr;
7367cb94ee6SHong Zhang 
7377cb94ee6SHong Zhang   PetscFunctionBegin;
738c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,tol,2);
7394ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetLinearTolerance_C",(TS,double),(ts,tol));CHKERRQ(ierr);
7407cb94ee6SHong Zhang   PetscFunctionReturn(0);
7417cb94ee6SHong Zhang }
7427cb94ee6SHong Zhang 
7437cb94ee6SHong Zhang #undef __FUNCT__
7447cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType"
7457cb94ee6SHong Zhang /*@
7467cb94ee6SHong Zhang    TSSundialsSetGramSchmidtType - Sets type of orthogonalization used
7477cb94ee6SHong Zhang         in GMRES method by SUNDIALS linear solver.
7487cb94ee6SHong Zhang 
7493f9fe445SBarry Smith    Logically Collective on TS
7507cb94ee6SHong Zhang 
7517cb94ee6SHong Zhang    Input parameters:
7527cb94ee6SHong Zhang +    ts  - the time-step context
7537cb94ee6SHong Zhang -    type - either SUNDIALS_MODIFIED_GS or SUNDIALS_CLASSICAL_GS
7547cb94ee6SHong Zhang 
7557cb94ee6SHong Zhang    Level: advanced
7567cb94ee6SHong Zhang 
7577cb94ee6SHong Zhang .keywords: Sundials, orthogonalization
7587cb94ee6SHong Zhang 
759f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
7607cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(),  TSSundialsSetTolerance(),
761f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7627cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
763a43b19c4SJed Brown           TSSetExactFinalTime()
7647cb94ee6SHong Zhang 
7657cb94ee6SHong Zhang @*/
7667087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType(TS ts,TSSundialsGramSchmidtType type)
7677cb94ee6SHong Zhang {
7684ac538c5SBarry Smith   PetscErrorCode ierr;
7697cb94ee6SHong Zhang 
7707cb94ee6SHong Zhang   PetscFunctionBegin;
7714ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetGramSchmidtType_C",(TS,TSSundialsGramSchmidtType),(ts,type));CHKERRQ(ierr);
7727cb94ee6SHong Zhang   PetscFunctionReturn(0);
7737cb94ee6SHong Zhang }
7747cb94ee6SHong Zhang 
7757cb94ee6SHong Zhang #undef __FUNCT__
7767cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance"
7777cb94ee6SHong Zhang /*@
7787cb94ee6SHong Zhang    TSSundialsSetTolerance - Sets the absolute and relative tolerance used by
7797cb94ee6SHong Zhang                          Sundials for error control.
7807cb94ee6SHong Zhang 
7813f9fe445SBarry Smith    Logically Collective on TS
7827cb94ee6SHong Zhang 
7837cb94ee6SHong Zhang    Input parameters:
7847cb94ee6SHong Zhang +    ts  - the time-step context
7857cb94ee6SHong Zhang .    aabs - the absolute tolerance
7867cb94ee6SHong Zhang -    rel - the relative tolerance
7877cb94ee6SHong Zhang 
7887cb94ee6SHong Zhang      See the Cvode/Sundials users manual for exact details on these parameters. Essentially
7897cb94ee6SHong Zhang     these regulate the size of the error for a SINGLE timestep.
7907cb94ee6SHong Zhang 
7917cb94ee6SHong Zhang    Level: intermediate
7927cb94ee6SHong Zhang 
7937cb94ee6SHong Zhang .keywords: Sundials, tolerance
7947cb94ee6SHong Zhang 
795f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESMaxl(),
7967cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(),
797f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7987cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
799a43b19c4SJed Brown           TSSetExactFinalTime()
8007cb94ee6SHong Zhang 
8017cb94ee6SHong Zhang @*/
8027087cfbeSBarry Smith PetscErrorCode  TSSundialsSetTolerance(TS ts,double aabs,double rel)
8037cb94ee6SHong Zhang {
8044ac538c5SBarry Smith   PetscErrorCode ierr;
8057cb94ee6SHong Zhang 
8067cb94ee6SHong Zhang   PetscFunctionBegin;
8074ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetTolerance_C",(TS,double,double),(ts,aabs,rel));CHKERRQ(ierr);
8087cb94ee6SHong Zhang   PetscFunctionReturn(0);
8097cb94ee6SHong Zhang }
8107cb94ee6SHong Zhang 
8117cb94ee6SHong Zhang #undef __FUNCT__
8127cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC"
8137cb94ee6SHong Zhang /*@
8147cb94ee6SHong Zhang    TSSundialsGetPC - Extract the PC context from a time-step context for Sundials.
8157cb94ee6SHong Zhang 
8167cb94ee6SHong Zhang    Input Parameter:
8177cb94ee6SHong Zhang .    ts - the time-step context
8187cb94ee6SHong Zhang 
8197cb94ee6SHong Zhang    Output Parameter:
8207cb94ee6SHong Zhang .    pc - the preconditioner context
8217cb94ee6SHong Zhang 
8227cb94ee6SHong Zhang    Level: advanced
8237cb94ee6SHong Zhang 
824f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
8257cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
826f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
8277cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance()
8287cb94ee6SHong Zhang @*/
8297087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC(TS ts,PC *pc)
8307cb94ee6SHong Zhang {
8314ac538c5SBarry Smith   PetscErrorCode ierr;
8327cb94ee6SHong Zhang 
8337cb94ee6SHong Zhang   PetscFunctionBegin;
8344ac538c5SBarry Smith   ierr = PetscUseMethod(ts,"TSSundialsGetPC_C",(TS,PC*),(ts,pc));CHKERRQ(ierr);
8357cb94ee6SHong Zhang   PetscFunctionReturn(0);
8367cb94ee6SHong Zhang }
8377cb94ee6SHong Zhang 
8387cb94ee6SHong Zhang #undef __FUNCT__
839f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep"
840f1cd61daSJed Brown /*@
841f1cd61daSJed Brown    TSSundialsSetMinTimeStep - Smallest time step to be chosen by the adaptive controller.
842f1cd61daSJed Brown 
843f1cd61daSJed Brown    Input Parameter:
844f1cd61daSJed Brown +   ts - the time-step context
845f1cd61daSJed Brown -   mindt - lowest time step if positive, negative to deactivate
846f1cd61daSJed Brown 
847fc6b9e64SJed Brown    Note:
848fc6b9e64SJed Brown    Sundials will error if it is not possible to keep the estimated truncation error below
849fc6b9e64SJed Brown    the tolerance set with TSSundialsSetTolerance() without going below this step size.
850fc6b9e64SJed Brown 
851f1cd61daSJed Brown    Level: beginner
852f1cd61daSJed Brown 
853f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(),
854f1cd61daSJed Brown @*/
8557087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep(TS ts,PetscReal mindt)
856f1cd61daSJed Brown {
8574ac538c5SBarry Smith   PetscErrorCode ierr;
858f1cd61daSJed Brown 
859f1cd61daSJed Brown   PetscFunctionBegin;
8604ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetMinTimeStep_C",(TS,PetscReal),(ts,mindt));CHKERRQ(ierr);
861f1cd61daSJed Brown   PetscFunctionReturn(0);
862f1cd61daSJed Brown }
863f1cd61daSJed Brown 
864f1cd61daSJed Brown #undef __FUNCT__
865f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep"
866f1cd61daSJed Brown /*@
867f1cd61daSJed Brown    TSSundialsSetMaxTimeStep - Largest time step to be chosen by the adaptive controller.
868f1cd61daSJed Brown 
869f1cd61daSJed Brown    Input Parameter:
870f1cd61daSJed Brown +   ts - the time-step context
871f1cd61daSJed Brown -   maxdt - lowest time step if positive, negative to deactivate
872f1cd61daSJed Brown 
873f1cd61daSJed Brown    Level: beginner
874f1cd61daSJed Brown 
875f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(),
876f1cd61daSJed Brown @*/
8777087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep(TS ts,PetscReal maxdt)
878f1cd61daSJed Brown {
8794ac538c5SBarry Smith   PetscErrorCode ierr;
880f1cd61daSJed Brown 
881f1cd61daSJed Brown   PetscFunctionBegin;
8824ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetMaxTimeStep_C",(TS,PetscReal),(ts,maxdt));CHKERRQ(ierr);
883f1cd61daSJed Brown   PetscFunctionReturn(0);
884f1cd61daSJed Brown }
885f1cd61daSJed Brown 
886f1cd61daSJed Brown #undef __FUNCT__
8872bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps"
8882bfc04deSHong Zhang /*@
8892bfc04deSHong Zhang    TSSundialsMonitorInternalSteps - Monitor Sundials internal steps (Defaults to false).
8902bfc04deSHong Zhang 
8912bfc04deSHong Zhang    Input Parameter:
8922bfc04deSHong Zhang +   ts - the time-step context
8932bfc04deSHong Zhang -   ft - PETSC_TRUE if monitor, else PETSC_FALSE
8942bfc04deSHong Zhang 
8952bfc04deSHong Zhang    Level: beginner
8962bfc04deSHong Zhang 
897f61b2b6aSHong Zhang .seealso:TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
8982bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
899f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
9002bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC()
9012bfc04deSHong Zhang @*/
9027087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps(TS ts,PetscBool ft)
9032bfc04deSHong Zhang {
9044ac538c5SBarry Smith   PetscErrorCode ierr;
9052bfc04deSHong Zhang 
9062bfc04deSHong Zhang   PetscFunctionBegin;
9074ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsMonitorInternalSteps_C",(TS,PetscBool),(ts,ft));CHKERRQ(ierr);
9082bfc04deSHong Zhang   PetscFunctionReturn(0);
9092bfc04deSHong Zhang }
9107cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
9117cb94ee6SHong Zhang /*MC
91296f5712cSJed Brown       TSSUNDIALS - ODE solver using the LLNL CVODE/SUNDIALS package (now called SUNDIALS)
9137cb94ee6SHong Zhang 
9147cb94ee6SHong Zhang    Options Database:
9157cb94ee6SHong Zhang +    -ts_sundials_type <bdf,adams>
9167cb94ee6SHong Zhang .    -ts_sundials_gramschmidt_type <modified, classical> - type of orthogonalization inside GMRES
9177cb94ee6SHong Zhang .    -ts_sundials_atol <tol> - Absolute tolerance for convergence
9187cb94ee6SHong Zhang .    -ts_sundials_rtol <tol> - Relative tolerance for convergence
9197cb94ee6SHong Zhang .    -ts_sundials_linear_tolerance <tol>
920f61b2b6aSHong Zhang .    -ts_sundials_maxl <maxl> - Max dimension of the Krylov subspace
92116016685SHong Zhang -    -ts_sundials_monitor_steps - Monitor SUNDIALS internel steps
92216016685SHong Zhang 
9237cb94ee6SHong Zhang 
9247cb94ee6SHong Zhang     Notes: This uses its own nonlinear solver and Krylov method so PETSc SNES and KSP options do not apply
9257cb94ee6SHong Zhang            only PETSc PC options
9267cb94ee6SHong Zhang 
9277cb94ee6SHong Zhang     Level: beginner
9287cb94ee6SHong Zhang 
929f61b2b6aSHong Zhang .seealso:  TSCreate(), TS, TSSetType(), TSSundialsSetType(), TSSundialsSetMaxl(), TSSundialsSetLinearTolerance(),
930a43b19c4SJed Brown            TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), TSSundialsGetPC(), TSSundialsGetIterations(), TSSetExactFinalTime()
9317cb94ee6SHong Zhang 
9327cb94ee6SHong Zhang M*/
9337cb94ee6SHong Zhang #undef __FUNCT__
9347cb94ee6SHong Zhang #define __FUNCT__ "TSCreate_Sundials"
9358cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_Sundials(TS ts)
9367cb94ee6SHong Zhang {
9377cb94ee6SHong Zhang   TS_Sundials    *cvode;
9387cb94ee6SHong Zhang   PetscErrorCode ierr;
93942528757SHong Zhang   PC             pc;
9407cb94ee6SHong Zhang 
9417cb94ee6SHong Zhang   PetscFunctionBegin;
942277b19d0SLisandro Dalcin   ts->ops->reset          = TSReset_Sundials;
94328adb3f7SHong Zhang   ts->ops->destroy        = TSDestroy_Sundials;
94428adb3f7SHong Zhang   ts->ops->view           = TSView_Sundials;
945214bc6a2SJed Brown   ts->ops->setup          = TSSetUp_Sundials;
946b4eba00bSSean Farley   ts->ops->step           = TSStep_Sundials;
947b4eba00bSSean Farley   ts->ops->interpolate    = TSInterpolate_Sundials;
948214bc6a2SJed Brown   ts->ops->setfromoptions = TSSetFromOptions_Sundials;
9497cb94ee6SHong Zhang 
950b00a9115SJed Brown   ierr = PetscNewLog(ts,&cvode);CHKERRQ(ierr);
951bbd56ea5SKarl Rupp 
9527cb94ee6SHong Zhang   ts->data           = (void*)cvode;
9536fadb2cdSHong Zhang   cvode->cvode_type  = SUNDIALS_BDF;
9546fadb2cdSHong Zhang   cvode->gtype       = SUNDIALS_CLASSICAL_GS;
955f61b2b6aSHong Zhang   cvode->maxl        = 5;
9567cb94ee6SHong Zhang   cvode->linear_tol  = .05;
957b4eba00bSSean Farley   cvode->monitorstep = PETSC_TRUE;
9587cb94ee6SHong Zhang 
959ce94432eSBarry Smith   ierr = MPI_Comm_dup(PetscObjectComm((PetscObject)ts),&(cvode->comm_sundials));CHKERRQ(ierr);
960f1cd61daSJed Brown 
961f1cd61daSJed Brown   cvode->mindt = -1.;
962f1cd61daSJed Brown   cvode->maxdt = -1.;
963f1cd61daSJed Brown 
9647cb94ee6SHong Zhang   /* set tolerance for Sundials */
9657cb94ee6SHong Zhang   cvode->reltol = 1e-6;
9662c823083SHong Zhang   cvode->abstol = 1e-6;
9677cb94ee6SHong Zhang 
96842528757SHong Zhang   /* set PCNONE as default pctype */
96942528757SHong Zhang   ierr = TSSundialsGetPC_Sundials(ts,&pc);CHKERRQ(ierr);
97042528757SHong Zhang   ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
97142528757SHong Zhang 
97249354f04SShri Abhyankar   if (ts->exact_final_time != TS_EXACTFINALTIME_STEPOVER) ts->exact_final_time = TS_EXACTFINALTIME_STEPOVER;
973a43b19c4SJed Brown 
974bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetType_C",TSSundialsSetType_Sundials);CHKERRQ(ierr);
975bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxl_C",TSSundialsSetMaxl_Sundials);CHKERRQ(ierr);
976bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetLinearTolerance_C",TSSundialsSetLinearTolerance_Sundials);CHKERRQ(ierr);
977bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetGramSchmidtType_C",TSSundialsSetGramSchmidtType_Sundials);CHKERRQ(ierr);
978bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetTolerance_C",TSSundialsSetTolerance_Sundials);CHKERRQ(ierr);
979bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMinTimeStep_C",TSSundialsSetMinTimeStep_Sundials);CHKERRQ(ierr);
980bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxTimeStep_C",TSSundialsSetMaxTimeStep_Sundials);CHKERRQ(ierr);
981bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetPC_C",TSSundialsGetPC_Sundials);CHKERRQ(ierr);
982bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetIterations_C",TSSundialsGetIterations_Sundials);CHKERRQ(ierr);
983bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSSundialsMonitorInternalSteps_C",TSSundialsMonitorInternalSteps_Sundials);CHKERRQ(ierr);
9847cb94ee6SHong Zhang   PetscFunctionReturn(0);
9857cb94ee6SHong Zhang }
986