xref: /petsc/src/ts/impls/implicit/sundials/sundials.c (revision f61b2b6a5fd3b7f08a8cc191828a1c51f84d7ab7)
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 */
856a740aaSHong Zhang #include "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"
167cb94ee6SHong Zhang PetscErrorCode TSPrecond_Sundials(realtype tn,N_Vector y,N_Vector fy,
177cb94ee6SHong Zhang                     booleantype jok,booleantype *jcurPtr,
187cb94ee6SHong Zhang                     realtype _gamma,void *P_data,
197cb94ee6SHong Zhang                     N_Vector vtemp1,N_Vector vtemp2,N_Vector vtemp3)
207cb94ee6SHong Zhang {
217cb94ee6SHong Zhang   TS             ts = (TS) P_data;
227cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
23dcbc6d53SSean Farley   PC             pc;
247cb94ee6SHong Zhang   PetscErrorCode ierr;
250679a0aeSJed Brown   Mat            J,P;
260679a0aeSJed Brown   Vec            yy = cvode->w1,yydot = cvode->ydot;
270679a0aeSJed Brown   PetscReal      gm = (PetscReal)_gamma;
287cb94ee6SHong Zhang   MatStructure   str = DIFFERENT_NONZERO_PATTERN;
297cb94ee6SHong Zhang   PetscScalar    *y_data;
307cb94ee6SHong Zhang 
317cb94ee6SHong Zhang   PetscFunctionBegin;
320679a0aeSJed Brown   ierr = TSGetIJacobian(ts,&J,&P,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
337cb94ee6SHong Zhang   y_data = (PetscScalar *) N_VGetArrayPointer(y);
347cb94ee6SHong Zhang   ierr = VecPlaceArray(yy,y_data); CHKERRQ(ierr);
350679a0aeSJed Brown   ierr = VecZeroEntries(yydot);CHKERRQ(ierr); /* The Jacobian is independent of Ydot for ODE which is all that CVode works for */
360679a0aeSJed Brown   /* compute the shifted Jacobian   (1/gm)*I + Jrest */
370679a0aeSJed Brown   ierr = TSComputeIJacobian(ts,ts->ptime,yy,yydot,1/gm,&J,&P,&str,PETSC_FALSE);CHKERRQ(ierr);
387cb94ee6SHong Zhang   ierr = VecResetArray(yy); CHKERRQ(ierr);
390679a0aeSJed Brown   ierr = MatScale(P,gm);CHKERRQ(ierr);  /* turn into I-gm*Jrest, J is not used by Sundials  */
407cb94ee6SHong Zhang   *jcurPtr = TRUE;
41dcbc6d53SSean Farley   ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr);
420679a0aeSJed Brown   ierr = PCSetOperators(pc,J,P,str);CHKERRQ(ierr);
437cb94ee6SHong Zhang   PetscFunctionReturn(0);
447cb94ee6SHong Zhang }
457cb94ee6SHong Zhang 
467cb94ee6SHong Zhang /*
477cb94ee6SHong Zhang      TSPSolve_Sundials -  routine that we provide to Sundials that applies the preconditioner.
487cb94ee6SHong Zhang */
497cb94ee6SHong Zhang #undef __FUNCT__
507cb94ee6SHong Zhang #define __FUNCT__ "TSPSolve_Sundials"
514ac7836bSHong Zhang PetscErrorCode TSPSolve_Sundials(realtype tn,N_Vector y,N_Vector fy,N_Vector r,N_Vector z,
524ac7836bSHong Zhang                                  realtype _gamma,realtype delta,int lr,void *P_data,N_Vector vtemp)
537cb94ee6SHong Zhang {
547cb94ee6SHong Zhang   TS              ts = (TS) P_data;
557cb94ee6SHong Zhang   TS_Sundials     *cvode = (TS_Sundials*)ts->data;
56dcbc6d53SSean Farley   PC              pc;
577cb94ee6SHong Zhang   Vec             rr = cvode->w1,zz = cvode->w2;
587cb94ee6SHong Zhang   PetscErrorCode  ierr;
597cb94ee6SHong Zhang   PetscScalar     *r_data,*z_data;
607cb94ee6SHong Zhang 
617cb94ee6SHong Zhang   PetscFunctionBegin;
627cb94ee6SHong Zhang   /* Make the PETSc work vectors rr and zz point to the arrays in the SUNDIALS vectors r and z respectively*/
637cb94ee6SHong Zhang   r_data  = (PetscScalar *) N_VGetArrayPointer(r);
647cb94ee6SHong Zhang   z_data  = (PetscScalar *) N_VGetArrayPointer(z);
657cb94ee6SHong Zhang   ierr = VecPlaceArray(rr,r_data); CHKERRQ(ierr);
667cb94ee6SHong Zhang   ierr = VecPlaceArray(zz,z_data); CHKERRQ(ierr);
674ac7836bSHong Zhang 
687cb94ee6SHong Zhang   /* Solve the Px=r and put the result in zz */
69dcbc6d53SSean Farley   ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr);
707cb94ee6SHong Zhang   ierr = PCApply(pc,rr,zz); CHKERRQ(ierr);
717cb94ee6SHong Zhang   ierr = VecResetArray(rr); CHKERRQ(ierr);
727cb94ee6SHong Zhang   ierr = VecResetArray(zz); CHKERRQ(ierr);
737cb94ee6SHong Zhang   PetscFunctionReturn(0);
747cb94ee6SHong Zhang }
757cb94ee6SHong Zhang 
767cb94ee6SHong Zhang /*
777cb94ee6SHong Zhang         TSFunction_Sundials - routine that we provide to Sundials that applies the right hand side.
787cb94ee6SHong Zhang */
797cb94ee6SHong Zhang #undef __FUNCT__
807cb94ee6SHong Zhang #define __FUNCT__ "TSFunction_Sundials"
814ac7836bSHong Zhang int TSFunction_Sundials(realtype t,N_Vector y,N_Vector ydot,void *ctx)
827cb94ee6SHong Zhang {
837cb94ee6SHong Zhang   TS              ts = (TS) ctx;
847adad957SLisandro Dalcin   MPI_Comm        comm = ((PetscObject)ts)->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;
915ff03cf7SDinesh Kaushik   /* Make the PETSc work vectors yy and yyd point to the arrays in the SUNDIALS vectors y and ydot respectively*/
927cb94ee6SHong Zhang   y_data     = (PetscScalar *) N_VGetArrayPointer(y);
937cb94ee6SHong Zhang   ydot_data  = (PetscScalar *) N_VGetArrayPointer(ydot);
944ac7836bSHong Zhang   ierr = VecPlaceArray(yy,y_data);CHKERRABORT(comm,ierr);
954ac7836bSHong Zhang   ierr = VecPlaceArray(yyd,ydot_data); CHKERRABORT(comm,ierr);
960679a0aeSJed Brown   ierr = VecZeroEntries(yydot);CHKERRQ(ierr);
974ac7836bSHong Zhang 
987cb94ee6SHong Zhang   /* now compute the right hand side function */
990679a0aeSJed Brown   ierr = TSComputeIFunction(ts,t,yy,yydot,yyd,PETSC_FALSE); CHKERRABORT(comm,ierr);
1000679a0aeSJed Brown   ierr = VecScale(yyd,-1.);CHKERRQ(ierr);
1017cb94ee6SHong Zhang   ierr = VecResetArray(yy); CHKERRABORT(comm,ierr);
1027cb94ee6SHong Zhang   ierr = VecResetArray(yyd); CHKERRABORT(comm,ierr);
1034ac7836bSHong Zhang   PetscFunctionReturn(0);
1047cb94ee6SHong Zhang }
1057cb94ee6SHong Zhang 
1067cb94ee6SHong Zhang /*
107b4eba00bSSean Farley        TSStep_Sundials - Calls Sundials to integrate the ODE.
1087cb94ee6SHong Zhang */
1097cb94ee6SHong Zhang #undef __FUNCT__
110b4eba00bSSean Farley #define __FUNCT__ "TSStep_Sundials"
111b4eba00bSSean Farley PetscErrorCode TSStep_Sundials(TS ts)
1127cb94ee6SHong Zhang {
1137cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
1147cb94ee6SHong Zhang   Vec            sol = ts->vec_sol;
1157cb94ee6SHong Zhang   PetscErrorCode ierr;
116b4eba00bSSean Farley   PetscInt       flag;
1179f94935aSHong Zhang   long int       its,nsteps;
1187cb94ee6SHong Zhang   realtype       t,tout;
1197cb94ee6SHong Zhang   PetscScalar    *y_data;
1207cb94ee6SHong Zhang   void           *mem;
121abe29043SSean Farley   SNES           snes;
122abe29043SSean Farley   Vec            res; /* This, together with snes, will check if the SNES vec_func has been set */
1237cb94ee6SHong Zhang 
1247cb94ee6SHong Zhang   PetscFunctionBegin;
12516016685SHong Zhang   mem  = cvode->mem;
1267cb94ee6SHong Zhang   tout = ts->max_time;
1277cb94ee6SHong Zhang   ierr = VecGetArray(ts->vec_sol,&y_data);CHKERRQ(ierr);
1287cb94ee6SHong Zhang   N_VSetArrayPointer((realtype *)y_data,cvode->y);
1297cb94ee6SHong Zhang   ierr = VecRestoreArray(ts->vec_sol,PETSC_NULL);CHKERRQ(ierr);
130186e87acSLisandro Dalcin 
131b4eba00bSSean Farley   /* Should think about moving this outside the loop */
132abe29043SSean Farley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
133abe29043SSean Farley   ierr = SNESGetFunction(snes, &res, PETSC_NULL, PETSC_NULL);CHKERRQ(ierr);
134abe29043SSean Farley   if (!res) {
135abe29043SSean Farley     ierr = TSSetIFunction(ts, sol, PETSC_NULL, PETSC_NULL);CHKERRQ(ierr);
136abe29043SSean Farley   }
137abe29043SSean Farley 
1383f2090d5SJed Brown   ierr = TSPreStep(ts);CHKERRQ(ierr);
139186e87acSLisandro Dalcin 
1402bfc04deSHong Zhang   if (cvode->monitorstep) {
14128adb3f7SHong Zhang     flag = CVode(mem,tout,cvode->y,&t,CV_ONE_STEP);
1422bfc04deSHong Zhang   } else {
1432bfc04deSHong Zhang     flag = CVode(mem,tout,cvode->y,&t,CV_NORMAL);
1442bfc04deSHong Zhang   }
1459f94935aSHong Zhang 
1469f94935aSHong Zhang   if (flag){ /* display error message */
1479f94935aSHong Zhang     switch (flag){
1489f94935aSHong Zhang       case CV_ILL_INPUT:
1499f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ILL_INPUT");
1509f94935aSHong Zhang         break;
1519f94935aSHong Zhang       case CV_TOO_CLOSE:
1529f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_CLOSE");
1539f94935aSHong Zhang         break;
1543c7fefeeSJed Brown       case CV_TOO_MUCH_WORK: {
1559f94935aSHong Zhang         PetscReal      tcur;
1569f94935aSHong Zhang         ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr);
1579f94935aSHong Zhang         ierr = CVodeGetCurrentTime(mem,&tcur);CHKERRQ(ierr);
1589f94935aSHong Zhang         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()",tcur,nsteps,ts->max_steps);
1593c7fefeeSJed Brown       } break;
1609f94935aSHong Zhang       case CV_TOO_MUCH_ACC:
1619f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_ACC");
1629f94935aSHong Zhang         break;
1639f94935aSHong Zhang       case CV_ERR_FAILURE:
1649f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ERR_FAILURE");
1659f94935aSHong Zhang         break;
1669f94935aSHong Zhang       case CV_CONV_FAILURE:
1679f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_CONV_FAILURE");
1689f94935aSHong Zhang         break;
1699f94935aSHong Zhang       case CV_LINIT_FAIL:
1709f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LINIT_FAIL");
1719f94935aSHong Zhang         break;
1729f94935aSHong Zhang       case CV_LSETUP_FAIL:
1739f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSETUP_FAIL");
1749f94935aSHong Zhang         break;
1759f94935aSHong Zhang       case CV_LSOLVE_FAIL:
1769f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSOLVE_FAIL");
1779f94935aSHong Zhang         break;
1789f94935aSHong Zhang       case CV_RHSFUNC_FAIL:
1799f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RHSFUNC_FAIL");
1809f94935aSHong Zhang         break;
1819f94935aSHong Zhang       case CV_FIRST_RHSFUNC_ERR:
1829f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_FIRST_RHSFUNC_ERR");
1839f94935aSHong Zhang         break;
1849f94935aSHong Zhang       case CV_REPTD_RHSFUNC_ERR:
1859f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_REPTD_RHSFUNC_ERR");
1869f94935aSHong Zhang         break;
1879f94935aSHong Zhang       case CV_UNREC_RHSFUNC_ERR:
1889f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_UNREC_RHSFUNC_ERR");
1899f94935aSHong Zhang         break;
1909f94935aSHong Zhang       case CV_RTFUNC_FAIL:
1919f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RTFUNC_FAIL");
1929f94935aSHong Zhang         break;
1939f94935aSHong Zhang       default:
1949f94935aSHong Zhang         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, flag %d",flag);
1959f94935aSHong Zhang     }
1969f94935aSHong Zhang   }
1979f94935aSHong Zhang 
1987cb94ee6SHong Zhang   /* copy the solution from cvode->y to cvode->update and sol */
1997cb94ee6SHong Zhang   ierr = VecPlaceArray(cvode->w1,y_data); CHKERRQ(ierr);
2007cb94ee6SHong Zhang   ierr = VecCopy(cvode->w1,cvode->update);CHKERRQ(ierr);
2017cb94ee6SHong Zhang   ierr = VecResetArray(cvode->w1); CHKERRQ(ierr);
2027cb94ee6SHong Zhang   ierr = VecCopy(cvode->update,sol);CHKERRQ(ierr);
2037cb94ee6SHong Zhang   ierr = CVodeGetNumNonlinSolvIters(mem,&its);CHKERRQ(ierr);
2044ac7836bSHong Zhang   ierr = CVSpilsGetNumLinIters(mem, &its);
205186e87acSLisandro Dalcin   ts->nonlinear_its = its; ts->linear_its = its;
206186e87acSLisandro Dalcin 
207186e87acSLisandro Dalcin   ts->time_step = t - ts->ptime;
208186e87acSLisandro Dalcin   ts->ptime     = t;
2097cb94ee6SHong Zhang   ts->steps++;
210186e87acSLisandro Dalcin 
2119f94935aSHong Zhang   ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr);
212b4eba00bSSean Farley   if (!cvode->monitorstep) ts->steps = nsteps;
213b4eba00bSSean Farley   PetscFunctionReturn(0);
214b4eba00bSSean Farley }
215b4eba00bSSean Farley 
216b4eba00bSSean Farley #undef __FUNCT__
217b4eba00bSSean Farley #define __FUNCT__ "TSInterpolate_Sundials"
218b4eba00bSSean Farley static PetscErrorCode TSInterpolate_Sundials(TS ts,PetscReal t,Vec X)
219b4eba00bSSean Farley {
220b4eba00bSSean Farley   TS_Sundials     *cvode = (TS_Sundials*)ts->data;
221b4eba00bSSean Farley   N_Vector        y;
222b4eba00bSSean Farley   PetscErrorCode  ierr;
223b4eba00bSSean Farley   PetscScalar     *x_data;
224b4eba00bSSean Farley   PetscInt        glosize,locsize;
225b4eba00bSSean Farley 
226b4eba00bSSean Farley   PetscFunctionBegin;
227b4eba00bSSean Farley 
228b4eba00bSSean Farley   /* get the vector size */
229b4eba00bSSean Farley   ierr = VecGetSize(X,&glosize);CHKERRQ(ierr);
230b4eba00bSSean Farley   ierr = VecGetLocalSize(X,&locsize);CHKERRQ(ierr);
231b4eba00bSSean Farley 
232b4eba00bSSean Farley   /* allocate the memory for N_Vec y */
233b4eba00bSSean Farley   y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize);
234b4eba00bSSean Farley   if (!y) SETERRQ(PETSC_COMM_SELF,1,"Interpolated y is not allocated");
235b4eba00bSSean Farley 
236b4eba00bSSean Farley   ierr = VecGetArray(X,&x_data);CHKERRQ(ierr);
237b4eba00bSSean Farley   N_VSetArrayPointer((realtype *)x_data,y);
238b4eba00bSSean Farley   ierr = CVodeGetDky(cvode->mem,t,0,y);CHKERRQ(ierr);
239b4eba00bSSean Farley   ierr = VecRestoreArray(X,&x_data);CHKERRQ(ierr);
240b4eba00bSSean Farley 
2417cb94ee6SHong Zhang   PetscFunctionReturn(0);
2427cb94ee6SHong Zhang }
2437cb94ee6SHong Zhang 
2447cb94ee6SHong Zhang #undef __FUNCT__
245277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset_Sundials"
246277b19d0SLisandro Dalcin PetscErrorCode TSReset_Sundials(TS ts)
247277b19d0SLisandro Dalcin {
248277b19d0SLisandro Dalcin   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
249277b19d0SLisandro Dalcin   PetscErrorCode ierr;
250277b19d0SLisandro Dalcin 
251277b19d0SLisandro Dalcin   PetscFunctionBegin;
2525c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->update);CHKERRQ(ierr);
2530679a0aeSJed Brown   ierr = VecDestroy(&cvode->ydot);CHKERRQ(ierr);
2545c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->w1);CHKERRQ(ierr);
2555c6b4a3dSJed Brown   ierr = VecDestroy(&cvode->w2);CHKERRQ(ierr);
256277b19d0SLisandro Dalcin   if (cvode->mem)    {CVodeFree(&cvode->mem);}
257277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
258277b19d0SLisandro Dalcin }
259277b19d0SLisandro Dalcin 
260277b19d0SLisandro Dalcin #undef __FUNCT__
2617cb94ee6SHong Zhang #define __FUNCT__ "TSDestroy_Sundials"
2627cb94ee6SHong Zhang PetscErrorCode TSDestroy_Sundials(TS ts)
2637cb94ee6SHong Zhang {
2647cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
2657cb94ee6SHong Zhang   PetscErrorCode ierr;
2667cb94ee6SHong Zhang 
2677cb94ee6SHong Zhang   PetscFunctionBegin;
268277b19d0SLisandro Dalcin   ierr = TSReset_Sundials(ts);CHKERRQ(ierr);
269a07356b8SSatish Balay   ierr = MPI_Comm_free(&(cvode->comm_sundials));CHKERRQ(ierr);
270277b19d0SLisandro Dalcin   ierr = PetscFree(ts->data);CHKERRQ(ierr);
271335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetType_C","",PETSC_NULL);CHKERRQ(ierr);
272*f61b2b6aSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxl_C","",PETSC_NULL);CHKERRQ(ierr);
273335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetLinearTolerance_C","",PETSC_NULL);CHKERRQ(ierr);
274335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGramSchmidtType_C","",PETSC_NULL);CHKERRQ(ierr);
275335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetTolerance_C","",PETSC_NULL);CHKERRQ(ierr);
276335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMinTimeStep_C","",PETSC_NULL);CHKERRQ(ierr);
277335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxTimeStep_C","",PETSC_NULL);CHKERRQ(ierr);
278335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetPC_C","",PETSC_NULL);CHKERRQ(ierr);
279335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetIterations_C","",PETSC_NULL);CHKERRQ(ierr);
280335f802eSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsMonitorInternalSteps_C","",PETSC_NULL);CHKERRQ(ierr);
2817cb94ee6SHong Zhang   PetscFunctionReturn(0);
2827cb94ee6SHong Zhang }
2837cb94ee6SHong Zhang 
2847cb94ee6SHong Zhang #undef __FUNCT__
285214bc6a2SJed Brown #define __FUNCT__ "TSSetUp_Sundials"
286214bc6a2SJed Brown PetscErrorCode TSSetUp_Sundials(TS ts)
2877cb94ee6SHong Zhang {
2887cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
2897cb94ee6SHong Zhang   PetscErrorCode ierr;
29016016685SHong Zhang   PetscInt       glosize,locsize,i,flag;
2917cb94ee6SHong Zhang   PetscScalar    *y_data,*parray;
29216016685SHong Zhang   void           *mem;
293dcbc6d53SSean Farley   PC             pc;
29416016685SHong Zhang   const PCType   pctype;
295ace3abfcSBarry Smith   PetscBool      pcnone;
2967cb94ee6SHong Zhang 
2977cb94ee6SHong Zhang   PetscFunctionBegin;
2987cb94ee6SHong Zhang   /* get the vector size */
2997cb94ee6SHong Zhang   ierr = VecGetSize(ts->vec_sol,&glosize);CHKERRQ(ierr);
3007cb94ee6SHong Zhang   ierr = VecGetLocalSize(ts->vec_sol,&locsize);CHKERRQ(ierr);
3017cb94ee6SHong Zhang 
3027cb94ee6SHong Zhang   /* allocate the memory for N_Vec y */
303a07356b8SSatish Balay   cvode->y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize);
304e32f2f54SBarry Smith   if (!cvode->y) SETERRQ(PETSC_COMM_SELF,1,"cvode->y is not allocated");
3057cb94ee6SHong Zhang 
30628adb3f7SHong Zhang   /* initialize N_Vec y: copy ts->vec_sol to cvode->y */
3077cb94ee6SHong Zhang   ierr = VecGetArray(ts->vec_sol,&parray);CHKERRQ(ierr);
3087cb94ee6SHong Zhang   y_data = (PetscScalar *) N_VGetArrayPointer(cvode->y);
3097cb94ee6SHong Zhang   for (i = 0; i < locsize; i++) y_data[i] = parray[i];
3107cb94ee6SHong Zhang   ierr = VecRestoreArray(ts->vec_sol,PETSC_NULL);CHKERRQ(ierr);
31142528757SHong Zhang 
3127cb94ee6SHong Zhang   ierr = VecDuplicate(ts->vec_sol,&cvode->update);CHKERRQ(ierr);
3130679a0aeSJed Brown   ierr = VecDuplicate(ts->vec_sol,&cvode->ydot);CHKERRQ(ierr);
3147cb94ee6SHong Zhang   ierr = PetscLogObjectParent(ts,cvode->update);CHKERRQ(ierr);
3150679a0aeSJed Brown   ierr = PetscLogObjectParent(ts,cvode->ydot);CHKERRQ(ierr);
3167cb94ee6SHong Zhang 
3177cb94ee6SHong Zhang   /*
3187cb94ee6SHong Zhang     Create work vectors for the TSPSolve_Sundials() routine. Note these are
3197cb94ee6SHong Zhang     allocated with zero space arrays because the actual array space is provided
3207cb94ee6SHong Zhang     by Sundials and set using VecPlaceArray().
3217cb94ee6SHong Zhang   */
3227adad957SLisandro Dalcin   ierr = VecCreateMPIWithArray(((PetscObject)ts)->comm,locsize,PETSC_DECIDE,0,&cvode->w1);CHKERRQ(ierr);
3237adad957SLisandro Dalcin   ierr = VecCreateMPIWithArray(((PetscObject)ts)->comm,locsize,PETSC_DECIDE,0,&cvode->w2);CHKERRQ(ierr);
3247cb94ee6SHong Zhang   ierr = PetscLogObjectParent(ts,cvode->w1);CHKERRQ(ierr);
3257cb94ee6SHong Zhang   ierr = PetscLogObjectParent(ts,cvode->w2);CHKERRQ(ierr);
32616016685SHong Zhang 
32716016685SHong Zhang   /* Call CVodeCreate to create the solver memory and the use of a Newton iteration */
32816016685SHong Zhang   mem = CVodeCreate(cvode->cvode_type, CV_NEWTON);
329e32f2f54SBarry Smith   if (!mem) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"CVodeCreate() fails");
33016016685SHong Zhang   cvode->mem = mem;
33116016685SHong Zhang 
33216016685SHong Zhang   /* Set the pointer to user-defined data */
33316016685SHong Zhang   flag = CVodeSetUserData(mem, ts);
334e32f2f54SBarry Smith   if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetUserData() fails");
33516016685SHong Zhang 
336fc6b9e64SJed Brown   /* Sundials may choose to use a smaller initial step, but will never use a larger step. */
337fc6b9e64SJed Brown   flag = CVodeSetInitStep(mem,(realtype)ts->initial_time_step);
338fc6b9e64SJed Brown   if (flag) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetInitStep() failed");
339f1cd61daSJed Brown   if (cvode->mindt > 0) {
340f1cd61daSJed Brown     flag = CVodeSetMinStep(mem,(realtype)cvode->mindt);
3419f94935aSHong Zhang     if (flag){
3429f94935aSHong Zhang       if (flag == CV_MEM_NULL){
3439f94935aSHong Zhang         SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed, cvode_mem pointer is NULL");
3449f94935aSHong Zhang       } else if (flag == CV_ILL_INPUT){
3459f94935aSHong Zhang         SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed, hmin is nonpositive or it exceeds the maximum allowable step size");
3469f94935aSHong Zhang       } else {
3479f94935aSHong Zhang         SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed");
3489f94935aSHong Zhang       }
3499f94935aSHong Zhang     }
350f1cd61daSJed Brown   }
351f1cd61daSJed Brown   if (cvode->maxdt > 0) {
352f1cd61daSJed Brown     flag = CVodeSetMaxStep(mem,(realtype)cvode->maxdt);
353f1cd61daSJed Brown     if (flag) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMaxStep() failed");
354f1cd61daSJed Brown   }
355f1cd61daSJed Brown 
35616016685SHong Zhang   /* Call CVodeInit to initialize the integrator memory and specify the
35716016685SHong Zhang    * user's right hand side function in u'=f(t,u), the inital time T0, and
35816016685SHong Zhang    * the initial dependent variable vector cvode->y */
35916016685SHong Zhang   flag = CVodeInit(mem,TSFunction_Sundials,ts->ptime,cvode->y);
36016016685SHong Zhang   if (flag){
361e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeInit() fails, flag %d",flag);
36216016685SHong Zhang   }
36316016685SHong Zhang 
3649f94935aSHong Zhang   /* specifies scalar relative and absolute tolerances */
36516016685SHong Zhang   flag = CVodeSStolerances(mem,cvode->reltol,cvode->abstol);
36616016685SHong Zhang   if (flag){
367e32f2f54SBarry Smith     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSStolerances() fails, flag %d",flag);
36816016685SHong Zhang   }
36916016685SHong Zhang 
3709f94935aSHong Zhang   /* Specify max num of steps to be taken by cvode in its attempt to reach the next output time */
3719f94935aSHong Zhang   flag = CVodeSetMaxNumSteps(mem,ts->max_steps);
37216016685SHong Zhang 
37316016685SHong Zhang   /* call CVSpgmr to use GMRES as the linear solver.        */
37416016685SHong Zhang   /* setup the ode integrator with the given preconditioner */
375dcbc6d53SSean Farley   ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr);
376dcbc6d53SSean Farley   ierr = PCGetType(pc,&pctype);CHKERRQ(ierr);
377dcbc6d53SSean Farley   ierr = PetscTypeCompare((PetscObject)pc,PCNONE,&pcnone);CHKERRQ(ierr);
37816016685SHong Zhang   if (pcnone){
37916016685SHong Zhang     flag  = CVSpgmr(mem,PREC_NONE,0);
380e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
38116016685SHong Zhang   } else {
382*f61b2b6aSHong Zhang     flag  = CVSpgmr(mem,PREC_LEFT,cvode->maxl);
383e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
38416016685SHong Zhang 
38516016685SHong Zhang     /* Set preconditioner and solve routines Precond and PSolve,
38616016685SHong Zhang      and the pointer to the user-defined block data */
38716016685SHong Zhang     flag = CVSpilsSetPreconditioner(mem,TSPrecond_Sundials,TSPSolve_Sundials);
388e32f2f54SBarry Smith     if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpilsSetPreconditioner() fails, flag %d", flag);
38916016685SHong Zhang   }
39016016685SHong Zhang 
39116016685SHong Zhang   flag = CVSpilsSetGSType(mem, MODIFIED_GS);
392e32f2f54SBarry Smith   if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmrSetGSType() fails, flag %d",flag);
3937cb94ee6SHong Zhang   PetscFunctionReturn(0);
3947cb94ee6SHong Zhang }
3957cb94ee6SHong Zhang 
3966fadb2cdSHong Zhang /* type of CVODE linear multistep method */
397dfcd32c8SHong Zhang const char *TSSundialsLmmTypes[] = {"","adams","bdf","TSSundialsLmmType","SUNDIALS_",0};
3986fadb2cdSHong Zhang /* type of G-S orthogonalization used by CVODE linear solver */
399dfcd32c8SHong Zhang const char *TSSundialsGramSchmidtTypes[] = {"","modified","classical","TSSundialsGramSchmidtType","SUNDIALS_",0};
400a04cf4d8SBarry Smith 
4017cb94ee6SHong Zhang #undef __FUNCT__
402214bc6a2SJed Brown #define __FUNCT__ "TSSetFromOptions_Sundials"
403214bc6a2SJed Brown PetscErrorCode TSSetFromOptions_Sundials(TS ts)
4047cb94ee6SHong Zhang {
4057cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
4067cb94ee6SHong Zhang   PetscErrorCode ierr;
4077cb94ee6SHong Zhang   int            indx;
408ace3abfcSBarry Smith   PetscBool      flag;
4097cb94ee6SHong Zhang 
4107cb94ee6SHong Zhang   PetscFunctionBegin;
4117cb94ee6SHong Zhang   ierr = PetscOptionsHead("SUNDIALS ODE solver options");CHKERRQ(ierr);
4126fadb2cdSHong Zhang     ierr = PetscOptionsEList("-ts_sundials_type","Scheme","TSSundialsSetType",TSSundialsLmmTypes,3,TSSundialsLmmTypes[cvode->cvode_type],&indx,&flag);CHKERRQ(ierr);
4137cb94ee6SHong Zhang     if (flag) {
4146fadb2cdSHong Zhang       ierr = TSSundialsSetType(ts,(TSSundialsLmmType)indx);CHKERRQ(ierr);
4157cb94ee6SHong Zhang     }
4166fadb2cdSHong Zhang     ierr = PetscOptionsEList("-ts_sundials_gramschmidt_type","Type of orthogonalization","TSSundialsSetGramSchmidtType",TSSundialsGramSchmidtTypes,3,TSSundialsGramSchmidtTypes[cvode->gtype],&indx,&flag);CHKERRQ(ierr);
4177cb94ee6SHong Zhang     if (flag) {
4187cb94ee6SHong Zhang       ierr = TSSundialsSetGramSchmidtType(ts,(TSSundialsGramSchmidtType)indx);CHKERRQ(ierr);
4197cb94ee6SHong Zhang     }
4207cb94ee6SHong Zhang     ierr = PetscOptionsReal("-ts_sundials_atol","Absolute tolerance for convergence","TSSundialsSetTolerance",cvode->abstol,&cvode->abstol,PETSC_NULL);CHKERRQ(ierr);
4217cb94ee6SHong Zhang     ierr = PetscOptionsReal("-ts_sundials_rtol","Relative tolerance for convergence","TSSundialsSetTolerance",cvode->reltol,&cvode->reltol,PETSC_NULL);CHKERRQ(ierr);
422f1cd61daSJed Brown     ierr = PetscOptionsReal("-ts_sundials_mindt","Minimum step size","TSSundialsSetMinTimeStep",cvode->mindt,&cvode->mindt,PETSC_NULL);CHKERRQ(ierr);
423f1cd61daSJed Brown     ierr = PetscOptionsReal("-ts_sundials_maxdt","Maximum step size","TSSundialsSetMaxTimeStep",cvode->maxdt,&cvode->maxdt,PETSC_NULL);CHKERRQ(ierr);
4247cb94ee6SHong Zhang     ierr = PetscOptionsReal("-ts_sundials_linear_tolerance","Convergence tolerance for linear solve","TSSundialsSetLinearTolerance",cvode->linear_tol,&cvode->linear_tol,&flag);CHKERRQ(ierr);
425*f61b2b6aSHong Zhang     ierr = PetscOptionsInt("-ts_sundials_maxl","Max dimension of the Krylov subspace","TSSundialsSetMaxl",cvode->maxl,&cvode->maxl,&flag);CHKERRQ(ierr);
426acfcf0e5SJed Brown     ierr = PetscOptionsBool("-ts_sundials_monitor_steps","Monitor SUNDIALS internel steps","TSSundialsMonitorInternalSteps",cvode->monitorstep,&cvode->monitorstep,PETSC_NULL);CHKERRQ(ierr);
4277cb94ee6SHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
4287cb94ee6SHong Zhang   PetscFunctionReturn(0);
4297cb94ee6SHong Zhang }
4307cb94ee6SHong Zhang 
4317cb94ee6SHong Zhang #undef __FUNCT__
4327cb94ee6SHong Zhang #define __FUNCT__ "TSView_Sundials"
4337cb94ee6SHong Zhang PetscErrorCode TSView_Sundials(TS ts,PetscViewer viewer)
4347cb94ee6SHong Zhang {
4357cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
4367cb94ee6SHong Zhang   PetscErrorCode ierr;
4377cb94ee6SHong Zhang   char           *type;
4387cb94ee6SHong Zhang   char           atype[] = "Adams";
4397cb94ee6SHong Zhang   char           btype[] = "BDF: backward differentiation formula";
440ace3abfcSBarry Smith   PetscBool      iascii,isstring;
4412c823083SHong Zhang   long int       nsteps,its,nfevals,nlinsetups,nfails,itmp;
4422c823083SHong Zhang   PetscInt       qlast,qcur;
4435d47aee6SHong Zhang   PetscReal      hinused,hlast,hcur,tcur,tolsfac;
44442528757SHong Zhang   PC             pc;
4457cb94ee6SHong Zhang 
4467cb94ee6SHong Zhang   PetscFunctionBegin;
4477cb94ee6SHong Zhang   if (cvode->cvode_type == SUNDIALS_ADAMS) {type = atype;}
4487cb94ee6SHong Zhang   else                                     {type = btype;}
4497cb94ee6SHong Zhang 
4502692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
4512692d6eeSBarry Smith   ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
4527cb94ee6SHong Zhang   if (iascii) {
4537cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater does not use SNES!\n");CHKERRQ(ierr);
4547cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater type %s\n",type);CHKERRQ(ierr);
4557cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials abs tol %g rel tol %g\n",cvode->abstol,cvode->reltol);CHKERRQ(ierr);
4567cb94ee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials linear solver tolerance factor %g\n",cvode->linear_tol);CHKERRQ(ierr);
457*f61b2b6aSHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials max dimension of Krylov subspace %D\n",cvode->maxl);CHKERRQ(ierr);
4587cb94ee6SHong Zhang     if (cvode->gtype == SUNDIALS_MODIFIED_GS) {
4597cb94ee6SHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"Sundials using modified Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr);
4607cb94ee6SHong Zhang     } else {
4617cb94ee6SHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"Sundials using unmodified (classical) Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr);
4627cb94ee6SHong Zhang     }
463f1cd61daSJed Brown     if (cvode->mindt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials minimum time step %g\n",cvode->mindt);CHKERRQ(ierr);}
464f1cd61daSJed Brown     if (cvode->maxdt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials maximum time step %g\n",cvode->maxdt);CHKERRQ(ierr);}
4652c823083SHong Zhang 
4665d47aee6SHong Zhang     /* Outputs from CVODE, CVSPILS */
4675d47aee6SHong Zhang     ierr = CVodeGetTolScaleFactor(cvode->mem,&tolsfac);CHKERRQ(ierr);
4685d47aee6SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials suggested factor for tolerance scaling %g\n",tolsfac);CHKERRQ(ierr);
4692c823083SHong Zhang     ierr = CVodeGetIntegratorStats(cvode->mem,&nsteps,&nfevals,
4702c823083SHong Zhang                                    &nlinsetups,&nfails,&qlast,&qcur,
4712c823083SHong Zhang                                    &hinused,&hlast,&hcur,&tcur);CHKERRQ(ierr);
4722c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials cumulative number of internal steps %D\n",nsteps);CHKERRQ(ierr);
4732c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to rhs function %D\n",nfevals);CHKERRQ(ierr);
4742c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to linear solver setup function %D\n",nlinsetups);CHKERRQ(ierr);
4752c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of error test failures %D\n",nfails);CHKERRQ(ierr);
4762c823083SHong Zhang 
4772c823083SHong Zhang     ierr = CVodeGetNonlinSolvStats(cvode->mem,&its,&nfails);CHKERRQ(ierr);
4782c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear solver iterations %D\n",its);CHKERRQ(ierr);
4792c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear convergence failure %D\n",nfails);CHKERRQ(ierr);
4802c823083SHong Zhang 
4812c823083SHong Zhang     ierr = CVSpilsGetNumLinIters(cvode->mem, &its);CHKERRQ(ierr); /* its = no. of calls to TSPrecond_Sundials() */
4822c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear iterations %D\n",its);CHKERRQ(ierr);
4832c823083SHong Zhang     ierr = CVSpilsGetNumConvFails(cvode->mem,&itmp);CHKERRQ(ierr);
4842c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear convergence failures %D\n",itmp);CHKERRQ(ierr);
48542528757SHong Zhang 
48642528757SHong Zhang     ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr);
48742528757SHong Zhang     ierr = PCView(pc,viewer);CHKERRQ(ierr);
4882c823083SHong Zhang     ierr = CVSpilsGetNumPrecEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4892c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner evaluations %D\n",itmp);CHKERRQ(ierr);
4902c823083SHong Zhang     ierr = CVSpilsGetNumPrecSolves(cvode->mem,&itmp);CHKERRQ(ierr);
4912c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner solves %D\n",itmp);CHKERRQ(ierr);
49242528757SHong Zhang 
4932c823083SHong Zhang     ierr = CVSpilsGetNumJtimesEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4942c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of Jacobian-vector product evaluations %D\n",itmp);CHKERRQ(ierr);
4952c823083SHong Zhang     ierr = CVSpilsGetNumRhsEvals(cvode->mem,&itmp);CHKERRQ(ierr);
4962c823083SHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of rhs calls for finite diff. Jacobian-vector evals %D\n",itmp);CHKERRQ(ierr);
4977cb94ee6SHong Zhang   } else if (isstring) {
4987cb94ee6SHong Zhang     ierr = PetscViewerStringSPrintf(viewer,"Sundials type %s",type);CHKERRQ(ierr);
4997cb94ee6SHong Zhang   }
5007cb94ee6SHong Zhang   PetscFunctionReturn(0);
5017cb94ee6SHong Zhang }
5027cb94ee6SHong Zhang 
5037cb94ee6SHong Zhang 
5047cb94ee6SHong Zhang /* --------------------------------------------------------------------------*/
5057cb94ee6SHong Zhang EXTERN_C_BEGIN
5067cb94ee6SHong Zhang #undef __FUNCT__
5077cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType_Sundials"
5087087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType_Sundials(TS ts,TSSundialsLmmType type)
5097cb94ee6SHong Zhang {
5107cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5117cb94ee6SHong Zhang 
5127cb94ee6SHong Zhang   PetscFunctionBegin;
5137cb94ee6SHong Zhang   cvode->cvode_type = type;
5147cb94ee6SHong Zhang   PetscFunctionReturn(0);
5157cb94ee6SHong Zhang }
5167cb94ee6SHong Zhang EXTERN_C_END
5177cb94ee6SHong Zhang 
5187cb94ee6SHong Zhang EXTERN_C_BEGIN
5197cb94ee6SHong Zhang #undef __FUNCT__
520*f61b2b6aSHong Zhang #define __FUNCT__ "TSSundialsSetMaxl_Sundials"
521*f61b2b6aSHong Zhang PetscErrorCode  TSSundialsSetMaxl_Sundials(TS ts,PetscInt maxl)
5227cb94ee6SHong Zhang {
5237cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5247cb94ee6SHong Zhang 
5257cb94ee6SHong Zhang   PetscFunctionBegin;
526*f61b2b6aSHong Zhang   cvode->maxl = maxl;
5277cb94ee6SHong Zhang   PetscFunctionReturn(0);
5287cb94ee6SHong Zhang }
5297cb94ee6SHong Zhang EXTERN_C_END
5307cb94ee6SHong Zhang 
5317cb94ee6SHong Zhang EXTERN_C_BEGIN
5327cb94ee6SHong Zhang #undef __FUNCT__
5337cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance_Sundials"
5347087cfbeSBarry Smith PetscErrorCode  TSSundialsSetLinearTolerance_Sundials(TS ts,double tol)
5357cb94ee6SHong Zhang {
5367cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5377cb94ee6SHong Zhang 
5387cb94ee6SHong Zhang   PetscFunctionBegin;
5397cb94ee6SHong Zhang   cvode->linear_tol = tol;
5407cb94ee6SHong Zhang   PetscFunctionReturn(0);
5417cb94ee6SHong Zhang }
5427cb94ee6SHong Zhang EXTERN_C_END
5437cb94ee6SHong Zhang 
5447cb94ee6SHong Zhang EXTERN_C_BEGIN
5457cb94ee6SHong Zhang #undef __FUNCT__
5467cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType_Sundials"
5477087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType_Sundials(TS ts,TSSundialsGramSchmidtType type)
5487cb94ee6SHong Zhang {
5497cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5507cb94ee6SHong Zhang 
5517cb94ee6SHong Zhang   PetscFunctionBegin;
5527cb94ee6SHong Zhang   cvode->gtype = type;
5537cb94ee6SHong Zhang   PetscFunctionReturn(0);
5547cb94ee6SHong Zhang }
5557cb94ee6SHong Zhang EXTERN_C_END
5567cb94ee6SHong Zhang 
5577cb94ee6SHong Zhang EXTERN_C_BEGIN
5587cb94ee6SHong Zhang #undef __FUNCT__
5597cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance_Sundials"
5607087cfbeSBarry Smith PetscErrorCode  TSSundialsSetTolerance_Sundials(TS ts,double aabs,double rel)
5617cb94ee6SHong Zhang {
5627cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5637cb94ee6SHong Zhang 
5647cb94ee6SHong Zhang   PetscFunctionBegin;
5657cb94ee6SHong Zhang   if (aabs != PETSC_DECIDE) cvode->abstol = aabs;
5667cb94ee6SHong Zhang   if (rel != PETSC_DECIDE)  cvode->reltol = rel;
5677cb94ee6SHong Zhang   PetscFunctionReturn(0);
5687cb94ee6SHong Zhang }
5697cb94ee6SHong Zhang EXTERN_C_END
5707cb94ee6SHong Zhang 
5717cb94ee6SHong Zhang EXTERN_C_BEGIN
5727cb94ee6SHong Zhang #undef __FUNCT__
573f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep_Sundials"
5747087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep_Sundials(TS ts,PetscReal mindt)
575f1cd61daSJed Brown {
576f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
577f1cd61daSJed Brown 
578f1cd61daSJed Brown   PetscFunctionBegin;
579f1cd61daSJed Brown   cvode->mindt = mindt;
580f1cd61daSJed Brown   PetscFunctionReturn(0);
581f1cd61daSJed Brown }
582f1cd61daSJed Brown EXTERN_C_END
583f1cd61daSJed Brown 
584f1cd61daSJed Brown EXTERN_C_BEGIN
585f1cd61daSJed Brown #undef __FUNCT__
586f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep_Sundials"
5877087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep_Sundials(TS ts,PetscReal maxdt)
588f1cd61daSJed Brown {
589f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
590f1cd61daSJed Brown 
591f1cd61daSJed Brown   PetscFunctionBegin;
592f1cd61daSJed Brown   cvode->maxdt = maxdt;
593f1cd61daSJed Brown   PetscFunctionReturn(0);
594f1cd61daSJed Brown }
595f1cd61daSJed Brown EXTERN_C_END
596f1cd61daSJed Brown 
597f1cd61daSJed Brown EXTERN_C_BEGIN
598f1cd61daSJed Brown #undef __FUNCT__
5997cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC_Sundials"
6007087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC_Sundials(TS ts,PC *pc)
6017cb94ee6SHong Zhang {
602dcbc6d53SSean Farley   SNES            snes;
603dcbc6d53SSean Farley   KSP             ksp;
604dcbc6d53SSean Farley   PetscErrorCode  ierr;
6057cb94ee6SHong Zhang 
6067cb94ee6SHong Zhang   PetscFunctionBegin;
607dcbc6d53SSean Farley   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
608dcbc6d53SSean Farley   ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr);
609dcbc6d53SSean Farley   ierr = KSPGetPC(ksp,pc); CHKERRQ(ierr);
6107cb94ee6SHong Zhang   PetscFunctionReturn(0);
6117cb94ee6SHong Zhang }
6127cb94ee6SHong Zhang EXTERN_C_END
6137cb94ee6SHong Zhang 
6147cb94ee6SHong Zhang EXTERN_C_BEGIN
6157cb94ee6SHong Zhang #undef __FUNCT__
6167cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations_Sundials"
6177087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations_Sundials(TS ts,int *nonlin,int *lin)
6187cb94ee6SHong Zhang {
6197cb94ee6SHong Zhang   PetscFunctionBegin;
6202c823083SHong Zhang   if (nonlin) *nonlin = ts->nonlinear_its;
6212c823083SHong Zhang   if (lin)    *lin    = ts->linear_its;
6227cb94ee6SHong Zhang   PetscFunctionReturn(0);
6237cb94ee6SHong Zhang }
6247cb94ee6SHong Zhang EXTERN_C_END
6257cb94ee6SHong Zhang 
6267cb94ee6SHong Zhang EXTERN_C_BEGIN
6277cb94ee6SHong Zhang #undef __FUNCT__
6282bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps_Sundials"
6297087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps_Sundials(TS ts,PetscBool  s)
6302bfc04deSHong Zhang {
6312bfc04deSHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
6322bfc04deSHong Zhang 
6332bfc04deSHong Zhang   PetscFunctionBegin;
6342bfc04deSHong Zhang   cvode->monitorstep = s;
6352bfc04deSHong Zhang   PetscFunctionReturn(0);
6362bfc04deSHong Zhang }
6372bfc04deSHong Zhang EXTERN_C_END
6387cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
6397cb94ee6SHong Zhang 
6407cb94ee6SHong Zhang #undef __FUNCT__
6417cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations"
6427cb94ee6SHong Zhang /*@C
6437cb94ee6SHong Zhang    TSSundialsGetIterations - Gets the number of nonlinear and linear iterations used so far by Sundials.
6447cb94ee6SHong Zhang 
6457cb94ee6SHong Zhang    Not Collective
6467cb94ee6SHong Zhang 
6477cb94ee6SHong Zhang    Input parameters:
6487cb94ee6SHong Zhang .    ts     - the time-step context
6497cb94ee6SHong Zhang 
6507cb94ee6SHong Zhang    Output Parameters:
6517cb94ee6SHong Zhang +   nonlin - number of nonlinear iterations
6527cb94ee6SHong Zhang -   lin    - number of linear iterations
6537cb94ee6SHong Zhang 
6547cb94ee6SHong Zhang    Level: advanced
6557cb94ee6SHong Zhang 
6567cb94ee6SHong Zhang    Notes:
6577cb94ee6SHong Zhang     These return the number since the creation of the TS object
6587cb94ee6SHong Zhang 
6597cb94ee6SHong Zhang .keywords: non-linear iterations, linear iterations
6607cb94ee6SHong Zhang 
661*f61b2b6aSHong Zhang .seealso: TSSundialsSetType(), TSSundialsSetMaxl(),
6627cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
663*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
664a43b19c4SJed Brown           TSSundialsSetLinearTolerance(), TSSundialsGetPC(), TSSetExactFinalTime()
6657cb94ee6SHong Zhang 
6667cb94ee6SHong Zhang @*/
6677087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations(TS ts,int *nonlin,int *lin)
6687cb94ee6SHong Zhang {
6694ac538c5SBarry Smith   PetscErrorCode ierr;
6707cb94ee6SHong Zhang 
6717cb94ee6SHong Zhang   PetscFunctionBegin;
6724ac538c5SBarry Smith   ierr = PetscUseMethod(ts,"TSSundialsGetIterations_C",(TS,int*,int*),(ts,nonlin,lin));CHKERRQ(ierr);
6737cb94ee6SHong Zhang   PetscFunctionReturn(0);
6747cb94ee6SHong Zhang }
6757cb94ee6SHong Zhang 
6767cb94ee6SHong Zhang #undef __FUNCT__
6777cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType"
6787cb94ee6SHong Zhang /*@
6797cb94ee6SHong Zhang    TSSundialsSetType - Sets the method that Sundials will use for integration.
6807cb94ee6SHong Zhang 
6813f9fe445SBarry Smith    Logically Collective on TS
6827cb94ee6SHong Zhang 
6837cb94ee6SHong Zhang    Input parameters:
6847cb94ee6SHong Zhang +    ts     - the time-step context
6857cb94ee6SHong Zhang -    type   - one of  SUNDIALS_ADAMS or SUNDIALS_BDF
6867cb94ee6SHong Zhang 
6877cb94ee6SHong Zhang    Level: intermediate
6887cb94ee6SHong Zhang 
6897cb94ee6SHong Zhang .keywords: Adams, backward differentiation formula
6907cb94ee6SHong Zhang 
691*f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(),  TSSundialsSetMaxl(),
6927cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
693*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
6947cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
695a43b19c4SJed Brown           TSSetExactFinalTime()
6967cb94ee6SHong Zhang @*/
6977087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType(TS ts,TSSundialsLmmType type)
6987cb94ee6SHong Zhang {
6994ac538c5SBarry Smith   PetscErrorCode ierr;
7007cb94ee6SHong Zhang 
7017cb94ee6SHong Zhang   PetscFunctionBegin;
7024ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetType_C",(TS,TSSundialsLmmType),(ts,type));CHKERRQ(ierr);
7037cb94ee6SHong Zhang   PetscFunctionReturn(0);
7047cb94ee6SHong Zhang }
7057cb94ee6SHong Zhang 
7067cb94ee6SHong Zhang #undef __FUNCT__
707*f61b2b6aSHong Zhang #define __FUNCT__ "TSSundialsSetMaxl"
7087cb94ee6SHong Zhang /*@
709*f61b2b6aSHong Zhang    TSSundialsSetMaxl - Sets the dimension of the Krylov space used by
7107cb94ee6SHong Zhang        GMRES in the linear solver in SUNDIALS. SUNDIALS DOES NOT use restarted GMRES so
711*f61b2b6aSHong Zhang        this is the maximum number of GMRES steps that will be used.
7127cb94ee6SHong Zhang 
7133f9fe445SBarry Smith    Logically Collective on TS
7147cb94ee6SHong Zhang 
7157cb94ee6SHong Zhang    Input parameters:
7167cb94ee6SHong Zhang +    ts      - the time-step context
717*f61b2b6aSHong Zhang -    maxl - number of direction vectors (the dimension of Krylov subspace).
7187cb94ee6SHong Zhang 
7197cb94ee6SHong Zhang    Level: advanced
7207cb94ee6SHong Zhang 
721*f61b2b6aSHong Zhang .keywords: GMRES
7227cb94ee6SHong Zhang 
7237cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(),
7247cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
725*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7267cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
727a43b19c4SJed Brown           TSSetExactFinalTime()
7287cb94ee6SHong Zhang 
7297cb94ee6SHong Zhang @*/
730*f61b2b6aSHong Zhang PetscErrorCode  TSSundialsSetMaxl(TS ts,PetscInt maxl)
7317cb94ee6SHong Zhang {
7324ac538c5SBarry Smith   PetscErrorCode ierr;
7337cb94ee6SHong Zhang 
7347cb94ee6SHong Zhang   PetscFunctionBegin;
735*f61b2b6aSHong Zhang   PetscValidLogicalCollectiveInt(ts,maxl,2);
736*f61b2b6aSHong Zhang   ierr = PetscTryMethod(ts,"TSSundialsSetMaxl_C",(TS,PetscInt),(ts,maxl));CHKERRQ(ierr);
7377cb94ee6SHong Zhang   PetscFunctionReturn(0);
7387cb94ee6SHong Zhang }
7397cb94ee6SHong Zhang 
7407cb94ee6SHong Zhang #undef __FUNCT__
7417cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance"
7427cb94ee6SHong Zhang /*@
7437cb94ee6SHong Zhang    TSSundialsSetLinearTolerance - Sets the tolerance used to solve the linear
7447cb94ee6SHong Zhang        system by SUNDIALS.
7457cb94ee6SHong Zhang 
7463f9fe445SBarry Smith    Logically Collective on TS
7477cb94ee6SHong Zhang 
7487cb94ee6SHong Zhang    Input parameters:
7497cb94ee6SHong Zhang +    ts     - the time-step context
7507cb94ee6SHong Zhang -    tol    - the factor by which the tolerance on the nonlinear solver is
7517cb94ee6SHong Zhang              multiplied to get the tolerance on the linear solver, .05 by default.
7527cb94ee6SHong Zhang 
7537cb94ee6SHong Zhang    Level: advanced
7547cb94ee6SHong Zhang 
7557cb94ee6SHong Zhang .keywords: GMRES, linear convergence tolerance, SUNDIALS
7567cb94ee6SHong Zhang 
757*f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
7587cb94ee6SHong Zhang           TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
759*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7607cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
761a43b19c4SJed Brown           TSSetExactFinalTime()
7627cb94ee6SHong Zhang 
7637cb94ee6SHong Zhang @*/
7647087cfbeSBarry Smith PetscErrorCode  TSSundialsSetLinearTolerance(TS ts,double tol)
7657cb94ee6SHong Zhang {
7664ac538c5SBarry Smith   PetscErrorCode ierr;
7677cb94ee6SHong Zhang 
7687cb94ee6SHong Zhang   PetscFunctionBegin;
769c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,tol,2);
7704ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetLinearTolerance_C",(TS,double),(ts,tol));CHKERRQ(ierr);
7717cb94ee6SHong Zhang   PetscFunctionReturn(0);
7727cb94ee6SHong Zhang }
7737cb94ee6SHong Zhang 
7747cb94ee6SHong Zhang #undef __FUNCT__
7757cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType"
7767cb94ee6SHong Zhang /*@
7777cb94ee6SHong Zhang    TSSundialsSetGramSchmidtType - Sets type of orthogonalization used
7787cb94ee6SHong Zhang         in GMRES method by SUNDIALS linear solver.
7797cb94ee6SHong Zhang 
7803f9fe445SBarry Smith    Logically Collective on TS
7817cb94ee6SHong Zhang 
7827cb94ee6SHong Zhang    Input parameters:
7837cb94ee6SHong Zhang +    ts  - the time-step context
7847cb94ee6SHong Zhang -    type - either SUNDIALS_MODIFIED_GS or SUNDIALS_CLASSICAL_GS
7857cb94ee6SHong Zhang 
7867cb94ee6SHong Zhang    Level: advanced
7877cb94ee6SHong Zhang 
7887cb94ee6SHong Zhang .keywords: Sundials, orthogonalization
7897cb94ee6SHong Zhang 
790*f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
7917cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(),  TSSundialsSetTolerance(),
792*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
7937cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
794a43b19c4SJed Brown           TSSetExactFinalTime()
7957cb94ee6SHong Zhang 
7967cb94ee6SHong Zhang @*/
7977087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType(TS ts,TSSundialsGramSchmidtType type)
7987cb94ee6SHong Zhang {
7994ac538c5SBarry Smith   PetscErrorCode ierr;
8007cb94ee6SHong Zhang 
8017cb94ee6SHong Zhang   PetscFunctionBegin;
8024ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetGramSchmidtType_C",(TS,TSSundialsGramSchmidtType),(ts,type));CHKERRQ(ierr);
8037cb94ee6SHong Zhang   PetscFunctionReturn(0);
8047cb94ee6SHong Zhang }
8057cb94ee6SHong Zhang 
8067cb94ee6SHong Zhang #undef __FUNCT__
8077cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance"
8087cb94ee6SHong Zhang /*@
8097cb94ee6SHong Zhang    TSSundialsSetTolerance - Sets the absolute and relative tolerance used by
8107cb94ee6SHong Zhang                          Sundials for error control.
8117cb94ee6SHong Zhang 
8123f9fe445SBarry Smith    Logically Collective on TS
8137cb94ee6SHong Zhang 
8147cb94ee6SHong Zhang    Input parameters:
8157cb94ee6SHong Zhang +    ts  - the time-step context
8167cb94ee6SHong Zhang .    aabs - the absolute tolerance
8177cb94ee6SHong Zhang -    rel - the relative tolerance
8187cb94ee6SHong Zhang 
8197cb94ee6SHong Zhang      See the Cvode/Sundials users manual for exact details on these parameters. Essentially
8207cb94ee6SHong Zhang     these regulate the size of the error for a SINGLE timestep.
8217cb94ee6SHong Zhang 
8227cb94ee6SHong Zhang    Level: intermediate
8237cb94ee6SHong Zhang 
8247cb94ee6SHong Zhang .keywords: Sundials, tolerance
8257cb94ee6SHong Zhang 
826*f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESMaxl(),
8277cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(),
828*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
8297cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(),
830a43b19c4SJed Brown           TSSetExactFinalTime()
8317cb94ee6SHong Zhang 
8327cb94ee6SHong Zhang @*/
8337087cfbeSBarry Smith PetscErrorCode  TSSundialsSetTolerance(TS ts,double aabs,double rel)
8347cb94ee6SHong Zhang {
8354ac538c5SBarry Smith   PetscErrorCode ierr;
8367cb94ee6SHong Zhang 
8377cb94ee6SHong Zhang   PetscFunctionBegin;
8384ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetTolerance_C",(TS,double,double),(ts,aabs,rel));CHKERRQ(ierr);
8397cb94ee6SHong Zhang   PetscFunctionReturn(0);
8407cb94ee6SHong Zhang }
8417cb94ee6SHong Zhang 
8427cb94ee6SHong Zhang #undef __FUNCT__
8437cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC"
8447cb94ee6SHong Zhang /*@
8457cb94ee6SHong Zhang    TSSundialsGetPC - Extract the PC context from a time-step context for Sundials.
8467cb94ee6SHong Zhang 
8477cb94ee6SHong Zhang    Input Parameter:
8487cb94ee6SHong Zhang .    ts - the time-step context
8497cb94ee6SHong Zhang 
8507cb94ee6SHong Zhang    Output Parameter:
8517cb94ee6SHong Zhang .    pc - the preconditioner context
8527cb94ee6SHong Zhang 
8537cb94ee6SHong Zhang    Level: advanced
8547cb94ee6SHong Zhang 
855*f61b2b6aSHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
8567cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
857*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
8587cb94ee6SHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance()
8597cb94ee6SHong Zhang @*/
8607087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC(TS ts,PC *pc)
8617cb94ee6SHong Zhang {
8624ac538c5SBarry Smith   PetscErrorCode ierr;
8637cb94ee6SHong Zhang 
8647cb94ee6SHong Zhang   PetscFunctionBegin;
8654ac538c5SBarry Smith   ierr = PetscUseMethod(ts,"TSSundialsGetPC_C",(TS,PC *),(ts,pc));CHKERRQ(ierr);
8667cb94ee6SHong Zhang   PetscFunctionReturn(0);
8677cb94ee6SHong Zhang }
8687cb94ee6SHong Zhang 
8697cb94ee6SHong Zhang #undef __FUNCT__
870f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep"
871f1cd61daSJed Brown /*@
872f1cd61daSJed Brown    TSSundialsSetMinTimeStep - Smallest time step to be chosen by the adaptive controller.
873f1cd61daSJed Brown 
874f1cd61daSJed Brown    Input Parameter:
875f1cd61daSJed Brown +   ts - the time-step context
876f1cd61daSJed Brown -   mindt - lowest time step if positive, negative to deactivate
877f1cd61daSJed Brown 
878fc6b9e64SJed Brown    Note:
879fc6b9e64SJed Brown    Sundials will error if it is not possible to keep the estimated truncation error below
880fc6b9e64SJed Brown    the tolerance set with TSSundialsSetTolerance() without going below this step size.
881fc6b9e64SJed Brown 
882f1cd61daSJed Brown    Level: beginner
883f1cd61daSJed Brown 
884f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(),
885f1cd61daSJed Brown @*/
8867087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep(TS ts,PetscReal mindt)
887f1cd61daSJed Brown {
8884ac538c5SBarry Smith   PetscErrorCode ierr;
889f1cd61daSJed Brown 
890f1cd61daSJed Brown   PetscFunctionBegin;
8914ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetMinTimeStep_C",(TS,PetscReal),(ts,mindt));CHKERRQ(ierr);
892f1cd61daSJed Brown   PetscFunctionReturn(0);
893f1cd61daSJed Brown }
894f1cd61daSJed Brown 
895f1cd61daSJed Brown #undef __FUNCT__
896f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep"
897f1cd61daSJed Brown /*@
898f1cd61daSJed Brown    TSSundialsSetMaxTimeStep - Largest time step to be chosen by the adaptive controller.
899f1cd61daSJed Brown 
900f1cd61daSJed Brown    Input Parameter:
901f1cd61daSJed Brown +   ts - the time-step context
902f1cd61daSJed Brown -   maxdt - lowest time step if positive, negative to deactivate
903f1cd61daSJed Brown 
904f1cd61daSJed Brown    Level: beginner
905f1cd61daSJed Brown 
906f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(),
907f1cd61daSJed Brown @*/
9087087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep(TS ts,PetscReal maxdt)
909f1cd61daSJed Brown {
9104ac538c5SBarry Smith   PetscErrorCode ierr;
911f1cd61daSJed Brown 
912f1cd61daSJed Brown   PetscFunctionBegin;
9134ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsSetMaxTimeStep_C",(TS,PetscReal),(ts,maxdt));CHKERRQ(ierr);
914f1cd61daSJed Brown   PetscFunctionReturn(0);
915f1cd61daSJed Brown }
916f1cd61daSJed Brown 
917f1cd61daSJed Brown #undef __FUNCT__
9182bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps"
9192bfc04deSHong Zhang /*@
9202bfc04deSHong Zhang    TSSundialsMonitorInternalSteps - Monitor Sundials internal steps (Defaults to false).
9212bfc04deSHong Zhang 
9222bfc04deSHong Zhang    Input Parameter:
9232bfc04deSHong Zhang +   ts - the time-step context
9242bfc04deSHong Zhang -   ft - PETSC_TRUE if monitor, else PETSC_FALSE
9252bfc04deSHong Zhang 
9262bfc04deSHong Zhang    Level: beginner
9272bfc04deSHong Zhang 
928*f61b2b6aSHong Zhang .seealso:TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
9292bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
930*f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
9312bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC()
9322bfc04deSHong Zhang @*/
9337087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps(TS ts,PetscBool  ft)
9342bfc04deSHong Zhang {
9354ac538c5SBarry Smith   PetscErrorCode ierr;
9362bfc04deSHong Zhang 
9372bfc04deSHong Zhang   PetscFunctionBegin;
9384ac538c5SBarry Smith   ierr = PetscTryMethod(ts,"TSSundialsMonitorInternalSteps_C",(TS,PetscBool),(ts,ft));CHKERRQ(ierr);
9392bfc04deSHong Zhang   PetscFunctionReturn(0);
9402bfc04deSHong Zhang }
9417cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
9427cb94ee6SHong Zhang /*MC
94396f5712cSJed Brown       TSSUNDIALS - ODE solver using the LLNL CVODE/SUNDIALS package (now called SUNDIALS)
9447cb94ee6SHong Zhang 
9457cb94ee6SHong Zhang    Options Database:
9467cb94ee6SHong Zhang +    -ts_sundials_type <bdf,adams>
9477cb94ee6SHong Zhang .    -ts_sundials_gramschmidt_type <modified, classical> - type of orthogonalization inside GMRES
9487cb94ee6SHong Zhang .    -ts_sundials_atol <tol> - Absolute tolerance for convergence
9497cb94ee6SHong Zhang .    -ts_sundials_rtol <tol> - Relative tolerance for convergence
9507cb94ee6SHong Zhang .    -ts_sundials_linear_tolerance <tol>
951*f61b2b6aSHong Zhang .    -ts_sundials_maxl <maxl> - Max dimension of the Krylov subspace
95216016685SHong Zhang -    -ts_sundials_monitor_steps - Monitor SUNDIALS internel steps
95316016685SHong Zhang 
9547cb94ee6SHong Zhang 
9557cb94ee6SHong Zhang     Notes: This uses its own nonlinear solver and Krylov method so PETSc SNES and KSP options do not apply
9567cb94ee6SHong Zhang            only PETSc PC options
9577cb94ee6SHong Zhang 
9587cb94ee6SHong Zhang     Level: beginner
9597cb94ee6SHong Zhang 
960*f61b2b6aSHong Zhang .seealso:  TSCreate(), TS, TSSetType(), TSSundialsSetType(), TSSundialsSetMaxl(), TSSundialsSetLinearTolerance(),
961a43b19c4SJed Brown            TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), TSSundialsGetPC(), TSSundialsGetIterations(), TSSetExactFinalTime()
9627cb94ee6SHong Zhang 
9637cb94ee6SHong Zhang M*/
9647cb94ee6SHong Zhang EXTERN_C_BEGIN
9657cb94ee6SHong Zhang #undef __FUNCT__
9667cb94ee6SHong Zhang #define __FUNCT__ "TSCreate_Sundials"
9677087cfbeSBarry Smith PetscErrorCode  TSCreate_Sundials(TS ts)
9687cb94ee6SHong Zhang {
9697cb94ee6SHong Zhang   TS_Sundials    *cvode;
9707cb94ee6SHong Zhang   PetscErrorCode ierr;
97142528757SHong Zhang   PC             pc;
9727cb94ee6SHong Zhang 
9737cb94ee6SHong Zhang   PetscFunctionBegin;
974277b19d0SLisandro Dalcin   ts->ops->reset          = TSReset_Sundials;
97528adb3f7SHong Zhang   ts->ops->destroy        = TSDestroy_Sundials;
97628adb3f7SHong Zhang   ts->ops->view           = TSView_Sundials;
977214bc6a2SJed Brown   ts->ops->setup          = TSSetUp_Sundials;
978b4eba00bSSean Farley   ts->ops->step           = TSStep_Sundials;
979b4eba00bSSean Farley   ts->ops->interpolate    = TSInterpolate_Sundials;
980214bc6a2SJed Brown   ts->ops->setfromoptions = TSSetFromOptions_Sundials;
9817cb94ee6SHong Zhang 
98238f2d2fdSLisandro Dalcin   ierr = PetscNewLog(ts,TS_Sundials,&cvode);CHKERRQ(ierr);
9837cb94ee6SHong Zhang   ts->data                = (void*)cvode;
9846fadb2cdSHong Zhang   cvode->cvode_type       = SUNDIALS_BDF;
9856fadb2cdSHong Zhang   cvode->gtype            = SUNDIALS_CLASSICAL_GS;
986*f61b2b6aSHong Zhang   cvode->maxl             = 5;
9877cb94ee6SHong Zhang   cvode->linear_tol       = .05;
9887cb94ee6SHong Zhang 
989b4eba00bSSean Farley   cvode->monitorstep      = PETSC_TRUE;
9907cb94ee6SHong Zhang 
991a07356b8SSatish Balay   ierr = MPI_Comm_dup(((PetscObject)ts)->comm,&(cvode->comm_sundials));CHKERRQ(ierr);
992f1cd61daSJed Brown 
993f1cd61daSJed Brown   cvode->mindt = -1.;
994f1cd61daSJed Brown   cvode->maxdt = -1.;
995f1cd61daSJed Brown 
9967cb94ee6SHong Zhang   /* set tolerance for Sundials */
9977cb94ee6SHong Zhang   cvode->reltol = 1e-6;
9982c823083SHong Zhang   cvode->abstol = 1e-6;
9997cb94ee6SHong Zhang 
100042528757SHong Zhang   /* set PCNONE as default pctype */
100142528757SHong Zhang   ierr = TSSundialsGetPC_Sundials(ts,&pc);CHKERRQ(ierr);
100242528757SHong Zhang   ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr);
100342528757SHong Zhang 
1004b4eba00bSSean Farley   if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_FALSE;
1005a43b19c4SJed Brown 
10067cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetType_C","TSSundialsSetType_Sundials",
10077cb94ee6SHong Zhang                     TSSundialsSetType_Sundials);CHKERRQ(ierr);
1008*f61b2b6aSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxl_C",
1009*f61b2b6aSHong Zhang                     "TSSundialsSetMaxl_Sundials",
1010*f61b2b6aSHong Zhang                     TSSundialsSetMaxl_Sundials);CHKERRQ(ierr);
10117cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetLinearTolerance_C",
10127cb94ee6SHong Zhang                     "TSSundialsSetLinearTolerance_Sundials",
10137cb94ee6SHong Zhang                      TSSundialsSetLinearTolerance_Sundials);CHKERRQ(ierr);
10147cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGramSchmidtType_C",
10157cb94ee6SHong Zhang                     "TSSundialsSetGramSchmidtType_Sundials",
10167cb94ee6SHong Zhang                      TSSundialsSetGramSchmidtType_Sundials);CHKERRQ(ierr);
10177cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetTolerance_C",
10187cb94ee6SHong Zhang                     "TSSundialsSetTolerance_Sundials",
10197cb94ee6SHong Zhang                      TSSundialsSetTolerance_Sundials);CHKERRQ(ierr);
1020f1cd61daSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMinTimeStep_C",
1021f1cd61daSJed Brown                     "TSSundialsSetMinTimeStep_Sundials",
1022f1cd61daSJed Brown                      TSSundialsSetMinTimeStep_Sundials);CHKERRQ(ierr);
1023f1cd61daSJed Brown   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxTimeStep_C",
1024f1cd61daSJed Brown                     "TSSundialsSetMaxTimeStep_Sundials",
1025f1cd61daSJed Brown                      TSSundialsSetMaxTimeStep_Sundials);CHKERRQ(ierr);
10267cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetPC_C",
10277cb94ee6SHong Zhang                     "TSSundialsGetPC_Sundials",
10287cb94ee6SHong Zhang                      TSSundialsGetPC_Sundials);CHKERRQ(ierr);
10297cb94ee6SHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetIterations_C",
10307cb94ee6SHong Zhang                     "TSSundialsGetIterations_Sundials",
10317cb94ee6SHong Zhang                      TSSundialsGetIterations_Sundials);CHKERRQ(ierr);
10322bfc04deSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsMonitorInternalSteps_C",
10332bfc04deSHong Zhang                     "TSSundialsMonitorInternalSteps_Sundials",
10342bfc04deSHong Zhang                      TSSundialsMonitorInternalSteps_Sundials);CHKERRQ(ierr);
10352bfc04deSHong Zhang 
10367cb94ee6SHong Zhang   PetscFunctionReturn(0);
10377cb94ee6SHong Zhang }
10387cb94ee6SHong Zhang EXTERN_C_END
1039