xref: /petsc/src/ts/impls/implicit/sundials/sundials.c (revision f7d195e4ad6e26c05f14257c8116f4b5b3c9cdd8)
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 */
14bbd56ea5SKarl Rupp PetscErrorCode TSPrecond_Sundials(realtype tn,N_Vector y,N_Vector fy,booleantype jok,booleantype *jcurPtr,
15bbd56ea5SKarl Rupp                                   realtype _gamma,void *P_data,N_Vector vtemp1,N_Vector vtemp2,N_Vector vtemp3)
167cb94ee6SHong Zhang {
177cb94ee6SHong Zhang   TS             ts     = (TS) P_data;
187cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
19dcbc6d53SSean Farley   PC             pc;
200679a0aeSJed Brown   Mat            J,P;
210679a0aeSJed Brown   Vec            yy  = cvode->w1,yydot = cvode->ydot;
220679a0aeSJed Brown   PetscReal      gm  = (PetscReal)_gamma;
237cb94ee6SHong Zhang   PetscScalar    *y_data;
247cb94ee6SHong Zhang 
257cb94ee6SHong Zhang   PetscFunctionBegin;
269566063dSJacob Faibussowitsch   PetscCall(TSGetIJacobian(ts,&J,&P,NULL,NULL));
277cb94ee6SHong Zhang   y_data = (PetscScalar*) N_VGetArrayPointer(y);
289566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(yy,y_data));
299566063dSJacob Faibussowitsch   PetscCall(VecZeroEntries(yydot)); /* The Jacobian is independent of Ydot for ODE which is all that CVode works for */
300679a0aeSJed Brown   /* compute the shifted Jacobian   (1/gm)*I + Jrest */
319566063dSJacob Faibussowitsch   PetscCall(TSComputeIJacobian(ts,ts->ptime,yy,yydot,1/gm,J,P,PETSC_FALSE));
329566063dSJacob Faibussowitsch   PetscCall(VecResetArray(yy));
339566063dSJacob Faibussowitsch   PetscCall(MatScale(P,gm)); /* turn into I-gm*Jrest, J is not used by Sundials  */
347cb94ee6SHong Zhang   *jcurPtr = TRUE;
359566063dSJacob Faibussowitsch   PetscCall(TSSundialsGetPC(ts,&pc));
369566063dSJacob Faibussowitsch   PetscCall(PCSetOperators(pc,J,P));
377cb94ee6SHong Zhang   PetscFunctionReturn(0);
387cb94ee6SHong Zhang }
397cb94ee6SHong Zhang 
407cb94ee6SHong Zhang /*
417cb94ee6SHong Zhang      TSPSolve_Sundials -  routine that we provide to Sundials that applies the preconditioner.
427cb94ee6SHong Zhang */
434ac7836bSHong Zhang PetscErrorCode TSPSolve_Sundials(realtype tn,N_Vector y,N_Vector fy,N_Vector r,N_Vector z,
444ac7836bSHong Zhang                                  realtype _gamma,realtype delta,int lr,void *P_data,N_Vector vtemp)
457cb94ee6SHong Zhang {
467cb94ee6SHong Zhang   TS             ts     = (TS) P_data;
477cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
48dcbc6d53SSean Farley   PC             pc;
497cb94ee6SHong Zhang   Vec            rr = cvode->w1,zz = cvode->w2;
507cb94ee6SHong Zhang   PetscScalar    *r_data,*z_data;
517cb94ee6SHong Zhang 
527cb94ee6SHong Zhang   PetscFunctionBegin;
537cb94ee6SHong Zhang   /* Make the PETSc work vectors rr and zz point to the arrays in the SUNDIALS vectors r and z respectively*/
547cb94ee6SHong Zhang   r_data = (PetscScalar*) N_VGetArrayPointer(r);
557cb94ee6SHong Zhang   z_data = (PetscScalar*) N_VGetArrayPointer(z);
569566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(rr,r_data));
579566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(zz,z_data));
584ac7836bSHong Zhang 
597cb94ee6SHong Zhang   /* Solve the Px=r and put the result in zz */
609566063dSJacob Faibussowitsch   PetscCall(TSSundialsGetPC(ts,&pc));
619566063dSJacob Faibussowitsch   PetscCall(PCApply(pc,rr,zz));
629566063dSJacob Faibussowitsch   PetscCall(VecResetArray(rr));
639566063dSJacob Faibussowitsch   PetscCall(VecResetArray(zz));
647cb94ee6SHong Zhang   PetscFunctionReturn(0);
657cb94ee6SHong Zhang }
667cb94ee6SHong Zhang 
677cb94ee6SHong Zhang /*
687cb94ee6SHong Zhang         TSFunction_Sundials - routine that we provide to Sundials that applies the right hand side.
697cb94ee6SHong Zhang */
704ac7836bSHong Zhang int TSFunction_Sundials(realtype t,N_Vector y,N_Vector ydot,void *ctx)
717cb94ee6SHong Zhang {
727cb94ee6SHong Zhang   TS             ts = (TS) ctx;
735fcef5e4SJed Brown   DM             dm;
74942e3340SBarry Smith   DMTS           tsdm;
755fcef5e4SJed Brown   TSIFunction    ifunction;
76ce94432eSBarry Smith   MPI_Comm       comm;
777cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
780679a0aeSJed Brown   Vec            yy     = cvode->w1,yyd = cvode->w2,yydot = cvode->ydot;
797cb94ee6SHong Zhang   PetscScalar    *y_data,*ydot_data;
807cb94ee6SHong Zhang 
817cb94ee6SHong Zhang   PetscFunctionBegin;
829566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)ts,&comm));
835ff03cf7SDinesh Kaushik   /* Make the PETSc work vectors yy and yyd point to the arrays in the SUNDIALS vectors y and ydot respectively*/
847cb94ee6SHong Zhang   y_data    = (PetscScalar*) N_VGetArrayPointer(y);
857cb94ee6SHong Zhang   ydot_data = (PetscScalar*) N_VGetArrayPointer(ydot);
869566063dSJacob Faibussowitsch   PetscCallAbort(comm,VecPlaceArray(yy,y_data));
879566063dSJacob Faibussowitsch   PetscCallAbort(comm,VecPlaceArray(yyd,ydot_data));
884ac7836bSHong Zhang 
895fcef5e4SJed Brown   /* Now compute the right hand side function, via IFunction unless only the more efficient RHSFunction is set */
909566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts,&dm));
919566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(dm,&tsdm));
929566063dSJacob Faibussowitsch   PetscCall(DMTSGetIFunction(dm,&ifunction,NULL));
935fcef5e4SJed Brown   if (!ifunction) {
949566063dSJacob Faibussowitsch     PetscCall(TSComputeRHSFunction(ts,t,yy,yyd));
95bc0cc02bSJed Brown   } else {                      /* If rhsfunction is also set, this computes both parts and shifts them to the right */
969566063dSJacob Faibussowitsch     PetscCall(VecZeroEntries(yydot));
979566063dSJacob Faibussowitsch     PetscCallAbort(comm,TSComputeIFunction(ts,t,yy,yydot,yyd,PETSC_FALSE));
989566063dSJacob Faibussowitsch     PetscCall(VecScale(yyd,-1.));
99bc0cc02bSJed Brown   }
1009566063dSJacob Faibussowitsch   PetscCallAbort(comm,VecResetArray(yy));
1019566063dSJacob Faibussowitsch   PetscCallAbort(comm,VecResetArray(yyd));
1024ac7836bSHong Zhang   PetscFunctionReturn(0);
1037cb94ee6SHong Zhang }
1047cb94ee6SHong Zhang 
1057cb94ee6SHong Zhang /*
106b4eba00bSSean Farley        TSStep_Sundials - Calls Sundials to integrate the ODE.
1077cb94ee6SHong Zhang */
108b4eba00bSSean Farley PetscErrorCode TSStep_Sundials(TS ts)
1097cb94ee6SHong Zhang {
1107cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
111b4eba00bSSean Farley   PetscInt       flag;
112be5899b3SLisandro Dalcin   long int       nits,lits,nsteps;
1137cb94ee6SHong Zhang   realtype       t,tout;
1147cb94ee6SHong Zhang   PetscScalar    *y_data;
1157cb94ee6SHong Zhang   void           *mem;
1167cb94ee6SHong Zhang 
1177cb94ee6SHong Zhang   PetscFunctionBegin;
11816016685SHong Zhang   mem  = cvode->mem;
1197cb94ee6SHong Zhang   tout = ts->max_time;
1209566063dSJacob Faibussowitsch   PetscCall(VecGetArray(ts->vec_sol,&y_data));
1217cb94ee6SHong Zhang   N_VSetArrayPointer((realtype*)y_data,cvode->y);
1229566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(ts->vec_sol,NULL));
123186e87acSLisandro Dalcin 
1249687d888SLisandro Dalcin   /* We would like to TSPreStage() and TSPostStage()
1259687d888SLisandro Dalcin    * before each stage solve but CVode does not appear to support this. */
126be5899b3SLisandro Dalcin   if (cvode->monitorstep)
127be5899b3SLisandro Dalcin     flag = CVode(mem,tout,cvode->y,&t,CV_ONE_STEP);
128be5899b3SLisandro Dalcin   else
129be5899b3SLisandro Dalcin     flag = CVode(mem,tout,cvode->y,&t,CV_NORMAL);
1309f94935aSHong Zhang 
1319f94935aSHong Zhang   if (flag) { /* display error message */
1329f94935aSHong Zhang     switch (flag) {
1339f94935aSHong Zhang       case CV_ILL_INPUT:
1349f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ILL_INPUT");
1359f94935aSHong Zhang         break;
1369f94935aSHong Zhang       case CV_TOO_CLOSE:
1379f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_CLOSE");
1389f94935aSHong Zhang         break;
1393c7fefeeSJed Brown       case CV_TOO_MUCH_WORK: {
1409f94935aSHong Zhang         PetscReal tcur;
1419566063dSJacob Faibussowitsch         PetscCall(CVodeGetNumSteps(mem,&nsteps));
1429566063dSJacob Faibussowitsch         PetscCall(CVodeGetCurrentTime(mem,&tcur));
14363a3b9bcSJacob Faibussowitsch         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_WORK. At t=%g, nsteps %ld exceeds maxstep %" PetscInt_FMT ". Increase '-ts_max_steps <>' or modify TSSetMaxSteps()",(double)tcur,nsteps,ts->max_steps);
1443c7fefeeSJed Brown       } break;
1459f94935aSHong Zhang       case CV_TOO_MUCH_ACC:
1469f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_ACC");
1479f94935aSHong Zhang         break;
1489f94935aSHong Zhang       case CV_ERR_FAILURE:
1499f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ERR_FAILURE");
1509f94935aSHong Zhang         break;
1519f94935aSHong Zhang       case CV_CONV_FAILURE:
1529f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_CONV_FAILURE");
1539f94935aSHong Zhang         break;
1549f94935aSHong Zhang       case CV_LINIT_FAIL:
1559f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LINIT_FAIL");
1569f94935aSHong Zhang         break;
1579f94935aSHong Zhang       case CV_LSETUP_FAIL:
1589f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSETUP_FAIL");
1599f94935aSHong Zhang         break;
1609f94935aSHong Zhang       case CV_LSOLVE_FAIL:
1619f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSOLVE_FAIL");
1629f94935aSHong Zhang         break;
1639f94935aSHong Zhang       case CV_RHSFUNC_FAIL:
1649f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RHSFUNC_FAIL");
1659f94935aSHong Zhang         break;
1669f94935aSHong Zhang       case CV_FIRST_RHSFUNC_ERR:
1679f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_FIRST_RHSFUNC_ERR");
1689f94935aSHong Zhang         break;
1699f94935aSHong Zhang       case CV_REPTD_RHSFUNC_ERR:
1709f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_REPTD_RHSFUNC_ERR");
1719f94935aSHong Zhang         break;
1729f94935aSHong Zhang       case CV_UNREC_RHSFUNC_ERR:
1739f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_UNREC_RHSFUNC_ERR");
1749f94935aSHong Zhang         break;
1759f94935aSHong Zhang       case CV_RTFUNC_FAIL:
1769f94935aSHong Zhang         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RTFUNC_FAIL");
1779f94935aSHong Zhang         break;
1789f94935aSHong Zhang       default:
17998921bdaSJacob Faibussowitsch         SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, flag %d",flag);
1809f94935aSHong Zhang     }
1819f94935aSHong Zhang   }
1829f94935aSHong Zhang 
183be5899b3SLisandro Dalcin   /* log inner nonlinear and linear iterations */
1849566063dSJacob Faibussowitsch   PetscCall(CVodeGetNumNonlinSolvIters(mem,&nits));
1859566063dSJacob Faibussowitsch   PetscCall(CVSpilsGetNumLinIters(mem,&lits));
186be5899b3SLisandro Dalcin   ts->snes_its += nits; ts->ksp_its = lits;
187be5899b3SLisandro Dalcin 
1887cb94ee6SHong Zhang   /* copy the solution from cvode->y to cvode->update and sol */
1899566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(cvode->w1,y_data));
1909566063dSJacob Faibussowitsch   PetscCall(VecCopy(cvode->w1,cvode->update));
1919566063dSJacob Faibussowitsch   PetscCall(VecResetArray(cvode->w1));
1929566063dSJacob Faibussowitsch   PetscCall(VecCopy(cvode->update,ts->vec_sol));
193186e87acSLisandro Dalcin 
194186e87acSLisandro Dalcin   ts->time_step = t - ts->ptime;
195186e87acSLisandro Dalcin   ts->ptime = t;
196186e87acSLisandro Dalcin 
1979566063dSJacob Faibussowitsch   PetscCall(CVodeGetNumSteps(mem,&nsteps));
1982808aa04SLisandro Dalcin   if (!cvode->monitorstep) ts->steps += nsteps - 1; /* TSStep() increments the step counter by one */
199b4eba00bSSean Farley   PetscFunctionReturn(0);
200b4eba00bSSean Farley }
201b4eba00bSSean Farley 
202b4eba00bSSean Farley static PetscErrorCode TSInterpolate_Sundials(TS ts,PetscReal t,Vec X)
203b4eba00bSSean Farley {
204b4eba00bSSean Farley   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
205b4eba00bSSean Farley   N_Vector       y;
206b4eba00bSSean Farley   PetscScalar    *x_data;
207b4eba00bSSean Farley   PetscInt       glosize,locsize;
208b4eba00bSSean Farley 
209b4eba00bSSean Farley   PetscFunctionBegin;
210b4eba00bSSean Farley   /* get the vector size */
2119566063dSJacob Faibussowitsch   PetscCall(VecGetSize(X,&glosize));
2129566063dSJacob Faibussowitsch   PetscCall(VecGetLocalSize(X,&locsize));
2139566063dSJacob Faibussowitsch   PetscCall(VecGetArray(X,&x_data));
214b4eba00bSSean Farley 
2154d78c9e0SClaas Abert   /* Initialize N_Vec y with x_data */
216918687b8SPatrick Sanan   if (cvode->use_dense) {
217918687b8SPatrick Sanan     PetscMPIInt size;
218918687b8SPatrick Sanan 
2199566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
2203c633725SBarry Smith     PetscCheck(size == 1,PETSC_COMM_WORLD,PETSC_ERR_WRONG_MPI_SIZE,"TSSUNDIALS only supports a dense solve in the serial case");
221918687b8SPatrick Sanan     y = N_VMake_Serial(locsize,(realtype*)x_data);
222918687b8SPatrick Sanan   } else {
2234d78c9e0SClaas Abert     y = N_VMake_Parallel(cvode->comm_sundials,locsize,glosize,(realtype*)x_data);
224918687b8SPatrick Sanan   }
225918687b8SPatrick Sanan 
2263c633725SBarry Smith   PetscCheck(y,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Interpolated y is not allocated");
227b4eba00bSSean Farley 
2289566063dSJacob Faibussowitsch   PetscCall(CVodeGetDky(cvode->mem,t,0,y));
2299566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(X,&x_data));
2307cb94ee6SHong Zhang   PetscFunctionReturn(0);
2317cb94ee6SHong Zhang }
2327cb94ee6SHong Zhang 
233277b19d0SLisandro Dalcin PetscErrorCode TSReset_Sundials(TS ts)
234277b19d0SLisandro Dalcin {
235277b19d0SLisandro Dalcin   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
236277b19d0SLisandro Dalcin 
237277b19d0SLisandro Dalcin   PetscFunctionBegin;
2389566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&cvode->update));
2399566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&cvode->ydot));
2409566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&cvode->w1));
2419566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&cvode->w2));
242bbd56ea5SKarl Rupp   if (cvode->mem) CVodeFree(&cvode->mem);
243277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
244277b19d0SLisandro Dalcin }
245277b19d0SLisandro Dalcin 
2467cb94ee6SHong Zhang PetscErrorCode TSDestroy_Sundials(TS ts)
2477cb94ee6SHong Zhang {
2487cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
2497cb94ee6SHong Zhang 
2507cb94ee6SHong Zhang   PetscFunctionBegin;
2519566063dSJacob Faibussowitsch   PetscCall(TSReset_Sundials(ts));
2529566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_free(&(cvode->comm_sundials)));
2539566063dSJacob Faibussowitsch   PetscCall(PetscFree(ts->data));
2549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetType_C",NULL));
2559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxl_C",NULL));
2569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetLinearTolerance_C",NULL));
2579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetGramSchmidtType_C",NULL));
2589566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetTolerance_C",NULL));
2599566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMinTimeStep_C",NULL));
2609566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxTimeStep_C",NULL));
2619566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetPC_C",NULL));
2629566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetIterations_C",NULL));
2639566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsMonitorInternalSteps_C",NULL));
2642e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetUseDense_C",NULL));
2657cb94ee6SHong Zhang   PetscFunctionReturn(0);
2667cb94ee6SHong Zhang }
2677cb94ee6SHong Zhang 
268214bc6a2SJed Brown PetscErrorCode TSSetUp_Sundials(TS ts)
2697cb94ee6SHong Zhang {
2707cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
27116016685SHong Zhang   PetscInt       glosize,locsize,i,flag;
2727cb94ee6SHong Zhang   PetscScalar    *y_data,*parray;
27316016685SHong Zhang   void           *mem;
274dcbc6d53SSean Farley   PC             pc;
27519fd82e9SBarry Smith   PCType         pctype;
276ace3abfcSBarry Smith   PetscBool      pcnone;
2777cb94ee6SHong Zhang 
2787cb94ee6SHong Zhang   PetscFunctionBegin;
27908401ef6SPierre Jolivet   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP,PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for exact final time option 'MATCHSTEP' when using Sundials");
280236c45dcSShri Abhyankar 
2817cb94ee6SHong Zhang   /* get the vector size */
2829566063dSJacob Faibussowitsch   PetscCall(VecGetSize(ts->vec_sol,&glosize));
2839566063dSJacob Faibussowitsch   PetscCall(VecGetLocalSize(ts->vec_sol,&locsize));
2847cb94ee6SHong Zhang 
2857cb94ee6SHong Zhang   /* allocate the memory for N_Vec y */
286918687b8SPatrick Sanan   if (cvode->use_dense) {
287918687b8SPatrick Sanan     PetscMPIInt size;
288918687b8SPatrick Sanan 
2899566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
2903c633725SBarry Smith     PetscCheck(size == 1,PETSC_COMM_WORLD,PETSC_ERR_WRONG_MPI_SIZE,"TSSUNDIALS only supports a dense solve in the serial case");
291918687b8SPatrick Sanan     cvode->y = N_VNew_Serial(locsize);
292918687b8SPatrick Sanan   } else {
293a07356b8SSatish Balay     cvode->y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize);
294918687b8SPatrick Sanan   }
2953c633725SBarry Smith   PetscCheck(cvode->y,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"cvode->y is not allocated");
2967cb94ee6SHong Zhang 
29728adb3f7SHong Zhang   /* initialize N_Vec y: copy ts->vec_sol to cvode->y */
2989566063dSJacob Faibussowitsch   PetscCall(VecGetArray(ts->vec_sol,&parray));
2997cb94ee6SHong Zhang   y_data = (PetscScalar*) N_VGetArrayPointer(cvode->y);
3007cb94ee6SHong Zhang   for (i = 0; i < locsize; i++) y_data[i] = parray[i];
3019566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(ts->vec_sol,NULL));
30242528757SHong Zhang 
3039566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(ts->vec_sol,&cvode->update));
3049566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(ts->vec_sol,&cvode->ydot));
3059566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->update));
3069566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->ydot));
3077cb94ee6SHong Zhang 
3087cb94ee6SHong Zhang   /*
3097cb94ee6SHong Zhang     Create work vectors for the TSPSolve_Sundials() routine. Note these are
3107cb94ee6SHong Zhang     allocated with zero space arrays because the actual array space is provided
3117cb94ee6SHong Zhang     by Sundials and set using VecPlaceArray().
3127cb94ee6SHong Zhang   */
3139566063dSJacob Faibussowitsch   PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts),1,locsize,PETSC_DECIDE,NULL,&cvode->w1));
3149566063dSJacob Faibussowitsch   PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts),1,locsize,PETSC_DECIDE,NULL,&cvode->w2));
3159566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->w1));
3169566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)ts,(PetscObject)cvode->w2));
31716016685SHong Zhang 
31816016685SHong Zhang   /* Call CVodeCreate to create the solver memory and the use of a Newton iteration */
31916016685SHong Zhang   mem = CVodeCreate(cvode->cvode_type, CV_NEWTON);
3203c633725SBarry Smith   PetscCheck(mem,PETSC_COMM_SELF,PETSC_ERR_MEM,"CVodeCreate() fails");
32116016685SHong Zhang   cvode->mem = mem;
32216016685SHong Zhang 
32316016685SHong Zhang   /* Set the pointer to user-defined data */
32416016685SHong Zhang   flag = CVodeSetUserData(mem, ts);
32528b400f6SJacob Faibussowitsch   PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetUserData() fails");
32616016685SHong Zhang 
327fc6b9e64SJed Brown   /* Sundials may choose to use a smaller initial step, but will never use a larger step. */
328cdbf8f93SLisandro Dalcin   flag = CVodeSetInitStep(mem,(realtype)ts->time_step);
32928b400f6SJacob Faibussowitsch   PetscCheck(!flag,PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetInitStep() failed");
330f1cd61daSJed Brown   if (cvode->mindt > 0) {
331f1cd61daSJed Brown     flag = CVodeSetMinStep(mem,(realtype)cvode->mindt);
3329f94935aSHong Zhang     if (flag) {
33308401ef6SPierre Jolivet       PetscCheck(flag != CV_MEM_NULL,PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed, cvode_mem pointer is NULL");
334*f7d195e4SLawrence Mitchell       PetscCheck(flag != CV_ILL_INPUT,PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed, hmin is nonpositive or it exceeds the maximum allowable step size");
335*f7d195e4SLawrence Mitchell       SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMinStep() failed");
3369f94935aSHong Zhang     }
337f1cd61daSJed Brown   }
338f1cd61daSJed Brown   if (cvode->maxdt > 0) {
339f1cd61daSJed Brown     flag = CVodeSetMaxStep(mem,(realtype)cvode->maxdt);
34028b400f6SJacob Faibussowitsch     PetscCheck(!flag,PetscObjectComm((PetscObject)ts),PETSC_ERR_LIB,"CVodeSetMaxStep() failed");
341f1cd61daSJed Brown   }
342f1cd61daSJed Brown 
34316016685SHong Zhang   /* Call CVodeInit to initialize the integrator memory and specify the
344a5b23f4aSJose E. Roman    * user's right hand side function in u'=f(t,u), the initial time T0, and
34516016685SHong Zhang    * the initial dependent variable vector cvode->y */
34616016685SHong Zhang   flag = CVodeInit(mem,TSFunction_Sundials,ts->ptime,cvode->y);
34728b400f6SJacob Faibussowitsch   PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeInit() fails, flag %d",flag);
34816016685SHong Zhang 
3499f94935aSHong Zhang   /* specifies scalar relative and absolute tolerances */
35016016685SHong Zhang   flag = CVodeSStolerances(mem,cvode->reltol,cvode->abstol);
35128b400f6SJacob Faibussowitsch   PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSStolerances() fails, flag %d",flag);
35216016685SHong Zhang 
353c4e80e11SFlorian   /* Specify max order of BDF / ADAMS method */
354c4e80e11SFlorian   if (cvode->maxord != PETSC_DEFAULT) {
355c4e80e11SFlorian     flag = CVodeSetMaxOrd(mem,cvode->maxord);
35628b400f6SJacob Faibussowitsch     PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetMaxOrd() fails, flag %d",flag);
357c4e80e11SFlorian   }
358c4e80e11SFlorian 
3599f94935aSHong Zhang   /* Specify max num of steps to be taken by cvode in its attempt to reach the next output time */
3609f94935aSHong Zhang   flag = CVodeSetMaxNumSteps(mem,ts->max_steps);
36128b400f6SJacob Faibussowitsch   PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetMaxNumSteps() fails, flag %d",flag);
36216016685SHong Zhang 
363918687b8SPatrick Sanan   if (cvode->use_dense) {
364918687b8SPatrick Sanan     /* call CVDense to use a dense linear solver. */
365918687b8SPatrick Sanan     PetscMPIInt size;
366918687b8SPatrick Sanan 
3679566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
3683c633725SBarry Smith     PetscCheck(size == 1,PETSC_COMM_WORLD,PETSC_ERR_WRONG_MPI_SIZE,"TSSUNDIALS only supports a dense solve in the serial case");
369918687b8SPatrick Sanan     flag = CVDense(mem,locsize);
37028b400f6SJacob Faibussowitsch     PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVDense() fails, flag %d",flag);
371918687b8SPatrick Sanan   } else {
37216016685SHong Zhang     /* call CVSpgmr to use GMRES as the linear solver.        */
37316016685SHong Zhang     /* setup the ode integrator with the given preconditioner */
3749566063dSJacob Faibussowitsch     PetscCall(TSSundialsGetPC(ts,&pc));
3759566063dSJacob Faibussowitsch     PetscCall(PCGetType(pc,&pctype));
3769566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)pc,PCNONE,&pcnone));
37716016685SHong Zhang     if (pcnone) {
37816016685SHong Zhang       flag = CVSpgmr(mem,PREC_NONE,0);
37928b400f6SJacob Faibussowitsch       PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
38016016685SHong Zhang     } else {
381f61b2b6aSHong Zhang       flag = CVSpgmr(mem,PREC_LEFT,cvode->maxl);
38228b400f6SJacob Faibussowitsch       PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag);
38316016685SHong Zhang 
38416016685SHong Zhang       /* Set preconditioner and solve routines Precond and PSolve,
38516016685SHong Zhang          and the pointer to the user-defined block data */
38616016685SHong Zhang       flag = CVSpilsSetPreconditioner(mem,TSPrecond_Sundials,TSPSolve_Sundials);
38728b400f6SJacob Faibussowitsch       PetscCheck(!flag,PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpilsSetPreconditioner() fails, flag %d", flag);
38816016685SHong Zhang     }
389918687b8SPatrick Sanan   }
3907cb94ee6SHong Zhang   PetscFunctionReturn(0);
3917cb94ee6SHong Zhang }
3927cb94ee6SHong Zhang 
3936fadb2cdSHong Zhang /* type of CVODE linear multistep method */
394c793f718SLisandro Dalcin const char *const TSSundialsLmmTypes[] = {"","ADAMS","BDF","TSSundialsLmmType","SUNDIALS_",NULL};
3956fadb2cdSHong Zhang /* type of G-S orthogonalization used by CVODE linear solver */
396c793f718SLisandro Dalcin const char *const TSSundialsGramSchmidtTypes[] = {"","MODIFIED","CLASSICAL","TSSundialsGramSchmidtType","SUNDIALS_",NULL};
397a04cf4d8SBarry Smith 
3984416b707SBarry Smith PetscErrorCode TSSetFromOptions_Sundials(PetscOptionItems *PetscOptionsObject,TS ts)
3997cb94ee6SHong Zhang {
4007cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
4017cb94ee6SHong Zhang   int            indx;
402ace3abfcSBarry Smith   PetscBool      flag;
4037bda3a07SJed Brown   PC             pc;
4047cb94ee6SHong Zhang 
4057cb94ee6SHong Zhang   PetscFunctionBegin;
406d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject,"SUNDIALS ODE solver options");
4079566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEList("-ts_sundials_type","Scheme","TSSundialsSetType",TSSundialsLmmTypes,3,TSSundialsLmmTypes[cvode->cvode_type],&indx,&flag));
4081baa6e33SBarry Smith   if (flag) PetscCall(TSSundialsSetType(ts,(TSSundialsLmmType)indx));
4099566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEList("-ts_sundials_gramschmidt_type","Type of orthogonalization","TSSundialsSetGramSchmidtType",TSSundialsGramSchmidtTypes,3,TSSundialsGramSchmidtTypes[cvode->gtype],&indx,&flag));
4101baa6e33SBarry Smith   if (flag) PetscCall(TSSundialsSetGramSchmidtType(ts,(TSSundialsGramSchmidtType)indx));
4119566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_sundials_atol","Absolute tolerance for convergence","TSSundialsSetTolerance",cvode->abstol,&cvode->abstol,NULL));
4129566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_sundials_rtol","Relative tolerance for convergence","TSSundialsSetTolerance",cvode->reltol,&cvode->reltol,NULL));
4139566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_sundials_mindt","Minimum step size","TSSundialsSetMinTimeStep",cvode->mindt,&cvode->mindt,NULL));
4149566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_sundials_maxdt","Maximum step size","TSSundialsSetMaxTimeStep",cvode->maxdt,&cvode->maxdt,NULL));
4159566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_sundials_linear_tolerance","Convergence tolerance for linear solve","TSSundialsSetLinearTolerance",cvode->linear_tol,&cvode->linear_tol,NULL));
4169566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_sundials_maxord","Max Order for BDF/Adams method","TSSundialsSetMaxOrd",cvode->maxord,&cvode->maxord,NULL));
4179566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_sundials_maxl","Max dimension of the Krylov subspace","TSSundialsSetMaxl",cvode->maxl,&cvode->maxl,NULL));
4189566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_sundials_monitor_steps","Monitor SUNDIALS internal steps","TSSundialsMonitorInternalSteps",cvode->monitorstep,&cvode->monitorstep,NULL));
4199566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_sundials_use_dense","Use dense internal solver in SUNDIALS (serial only)","TSSundialsSetUseDense",cvode->use_dense,&cvode->use_dense,NULL));
420d0609cedSBarry Smith   PetscOptionsHeadEnd();
4219566063dSJacob Faibussowitsch   PetscCall(TSSundialsGetPC(ts,&pc));
4229566063dSJacob Faibussowitsch   PetscCall(PCSetFromOptions(pc));
4237cb94ee6SHong Zhang   PetscFunctionReturn(0);
4247cb94ee6SHong Zhang }
4257cb94ee6SHong Zhang 
4267cb94ee6SHong Zhang PetscErrorCode TSView_Sundials(TS ts,PetscViewer viewer)
4277cb94ee6SHong Zhang {
4287cb94ee6SHong Zhang   TS_Sundials    *cvode = (TS_Sundials*)ts->data;
4297cb94ee6SHong Zhang   char           *type;
4307cb94ee6SHong Zhang   char           atype[] = "Adams";
4317cb94ee6SHong Zhang   char           btype[] = "BDF: backward differentiation formula";
432ace3abfcSBarry Smith   PetscBool      iascii,isstring;
4332c823083SHong Zhang   long int       nsteps,its,nfevals,nlinsetups,nfails,itmp;
4342c823083SHong Zhang   PetscInt       qlast,qcur;
4355d47aee6SHong Zhang   PetscReal      hinused,hlast,hcur,tcur,tolsfac;
43642528757SHong Zhang   PC             pc;
4377cb94ee6SHong Zhang 
4387cb94ee6SHong Zhang   PetscFunctionBegin;
439bbd56ea5SKarl Rupp   if (cvode->cvode_type == SUNDIALS_ADAMS) type = atype;
440bbd56ea5SKarl Rupp   else                                     type = btype;
4417cb94ee6SHong Zhang 
4429566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii));
4439566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring));
4447cb94ee6SHong Zhang   if (iascii) {
4459566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials integrator does not use SNES!\n"));
4469566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials integrator type %s\n",type));
44763a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials maxord %" PetscInt_FMT "\n",cvode->maxord));
4489566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials abs tol %g rel tol %g\n",(double)cvode->abstol,(double)cvode->reltol));
449918687b8SPatrick Sanan     if (cvode->use_dense) {
4509566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials integrator using a dense linear solve\n"));
451918687b8SPatrick Sanan     } else {
4529566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials linear solver tolerance factor %g\n",(double)cvode->linear_tol));
45363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials max dimension of Krylov subspace %" PetscInt_FMT "\n",cvode->maxl));
4547cb94ee6SHong Zhang       if (cvode->gtype == SUNDIALS_MODIFIED_GS) {
4559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials using modified Gram-Schmidt for orthogonalization in GMRES\n"));
4567cb94ee6SHong Zhang       } else {
4579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials using unmodified (classical) Gram-Schmidt for orthogonalization in GMRES\n"));
4587cb94ee6SHong Zhang       }
459918687b8SPatrick Sanan     }
4609566063dSJacob Faibussowitsch     if (cvode->mindt > 0) PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials minimum time step %g\n",(double)cvode->mindt));
4619566063dSJacob Faibussowitsch     if (cvode->maxdt > 0) PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials maximum time step %g\n",(double)cvode->maxdt));
4622c823083SHong Zhang 
4635d47aee6SHong Zhang     /* Outputs from CVODE, CVSPILS */
4649566063dSJacob Faibussowitsch     PetscCall(CVodeGetTolScaleFactor(cvode->mem,&tolsfac));
4659566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials suggested factor for tolerance scaling %g\n",tolsfac));
4669566063dSJacob Faibussowitsch     PetscCall(CVodeGetIntegratorStats(cvode->mem,&nsteps,&nfevals,&nlinsetups,&nfails,&qlast,&qcur,&hinused,&hlast,&hcur,&tcur));
46763a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials cumulative number of internal steps %ld\n",nsteps));
46863a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to rhs function %ld\n",nfevals));
46963a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to linear solver setup function %ld\n",nlinsetups));
47063a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of error test failures %ld\n",nfails));
4712c823083SHong Zhang 
4729566063dSJacob Faibussowitsch     PetscCall(CVodeGetNonlinSolvStats(cvode->mem,&its,&nfails));
47363a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear solver iterations %ld\n",its));
47463a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear convergence failure %ld\n",nfails));
475918687b8SPatrick Sanan     if (!cvode->use_dense) {
4769566063dSJacob Faibussowitsch       PetscCall(CVSpilsGetNumLinIters(cvode->mem, &its)); /* its = no. of calls to TSPrecond_Sundials() */
47763a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of linear iterations %ld\n",its));
4789566063dSJacob Faibussowitsch       PetscCall(CVSpilsGetNumConvFails(cvode->mem,&itmp));
47963a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of linear convergence failures %ld\n",itmp));
48042528757SHong Zhang 
4819566063dSJacob Faibussowitsch       PetscCall(TSSundialsGetPC(ts,&pc));
4829566063dSJacob Faibussowitsch       PetscCall(PCView(pc,viewer));
4839566063dSJacob Faibussowitsch       PetscCall(CVSpilsGetNumPrecEvals(cvode->mem,&itmp));
48463a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner evaluations %ld\n",itmp));
4859566063dSJacob Faibussowitsch       PetscCall(CVSpilsGetNumPrecSolves(cvode->mem,&itmp));
48663a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner solves %ld\n",itmp));
487918687b8SPatrick Sanan     }
4889566063dSJacob Faibussowitsch     PetscCall(CVSpilsGetNumJtimesEvals(cvode->mem,&itmp));
48963a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of Jacobian-vector product evaluations %ld\n",itmp));
4909566063dSJacob Faibussowitsch     PetscCall(CVSpilsGetNumRhsEvals(cvode->mem,&itmp));
49163a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer,"Sundials no. of rhs calls for finite diff. Jacobian-vector evals %ld\n",itmp));
4927cb94ee6SHong Zhang   } else if (isstring) {
4939566063dSJacob Faibussowitsch     PetscCall(PetscViewerStringSPrintf(viewer,"Sundials type %s",type));
4947cb94ee6SHong Zhang   }
4957cb94ee6SHong Zhang   PetscFunctionReturn(0);
4967cb94ee6SHong Zhang }
4977cb94ee6SHong Zhang 
4987cb94ee6SHong Zhang /* --------------------------------------------------------------------------*/
4997087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType_Sundials(TS ts,TSSundialsLmmType type)
5007cb94ee6SHong Zhang {
5017cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5027cb94ee6SHong Zhang 
5037cb94ee6SHong Zhang   PetscFunctionBegin;
5047cb94ee6SHong Zhang   cvode->cvode_type = type;
5057cb94ee6SHong Zhang   PetscFunctionReturn(0);
5067cb94ee6SHong Zhang }
5077cb94ee6SHong Zhang 
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 
517590ae059SPatrick Sanan PetscErrorCode  TSSundialsSetLinearTolerance_Sundials(TS ts,PetscReal tol)
5187cb94ee6SHong Zhang {
5197cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5207cb94ee6SHong Zhang 
5217cb94ee6SHong Zhang   PetscFunctionBegin;
5227cb94ee6SHong Zhang   cvode->linear_tol = tol;
5237cb94ee6SHong Zhang   PetscFunctionReturn(0);
5247cb94ee6SHong Zhang }
5257cb94ee6SHong Zhang 
5267087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType_Sundials(TS ts,TSSundialsGramSchmidtType type)
5277cb94ee6SHong Zhang {
5287cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5297cb94ee6SHong Zhang 
5307cb94ee6SHong Zhang   PetscFunctionBegin;
5317cb94ee6SHong Zhang   cvode->gtype = type;
5327cb94ee6SHong Zhang   PetscFunctionReturn(0);
5337cb94ee6SHong Zhang }
5347cb94ee6SHong Zhang 
535590ae059SPatrick Sanan PetscErrorCode  TSSundialsSetTolerance_Sundials(TS ts,PetscReal aabs,PetscReal rel)
5367cb94ee6SHong Zhang {
5377cb94ee6SHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5387cb94ee6SHong Zhang 
5397cb94ee6SHong Zhang   PetscFunctionBegin;
5407cb94ee6SHong Zhang   if (aabs != PETSC_DECIDE) cvode->abstol = aabs;
5417cb94ee6SHong Zhang   if (rel != PETSC_DECIDE)  cvode->reltol = rel;
5427cb94ee6SHong Zhang   PetscFunctionReturn(0);
5437cb94ee6SHong Zhang }
5447cb94ee6SHong Zhang 
5457087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep_Sundials(TS ts,PetscReal mindt)
546f1cd61daSJed Brown {
547f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
548f1cd61daSJed Brown 
549f1cd61daSJed Brown   PetscFunctionBegin;
550f1cd61daSJed Brown   cvode->mindt = mindt;
551f1cd61daSJed Brown   PetscFunctionReturn(0);
552f1cd61daSJed Brown }
553f1cd61daSJed Brown 
5547087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep_Sundials(TS ts,PetscReal maxdt)
555f1cd61daSJed Brown {
556f1cd61daSJed Brown   TS_Sundials *cvode = (TS_Sundials*)ts->data;
557f1cd61daSJed Brown 
558f1cd61daSJed Brown   PetscFunctionBegin;
559f1cd61daSJed Brown   cvode->maxdt = maxdt;
560f1cd61daSJed Brown   PetscFunctionReturn(0);
561f1cd61daSJed Brown }
562918687b8SPatrick Sanan 
563918687b8SPatrick Sanan PetscErrorCode  TSSundialsSetUseDense_Sundials(TS ts,PetscBool use_dense)
564918687b8SPatrick Sanan {
565918687b8SPatrick Sanan   TS_Sundials *cvode = (TS_Sundials*)ts->data;
566918687b8SPatrick Sanan 
567918687b8SPatrick Sanan   PetscFunctionBegin;
568918687b8SPatrick Sanan   cvode->use_dense = use_dense;
569918687b8SPatrick Sanan   PetscFunctionReturn(0);
570918687b8SPatrick Sanan }
571918687b8SPatrick Sanan 
5727087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC_Sundials(TS ts,PC *pc)
5737cb94ee6SHong Zhang {
574dcbc6d53SSean Farley   SNES           snes;
575dcbc6d53SSean Farley   KSP            ksp;
5767cb94ee6SHong Zhang 
5777cb94ee6SHong Zhang   PetscFunctionBegin;
5789566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts,&snes));
5799566063dSJacob Faibussowitsch   PetscCall(SNESGetKSP(snes,&ksp));
5809566063dSJacob Faibussowitsch   PetscCall(KSPGetPC(ksp,pc));
5817cb94ee6SHong Zhang   PetscFunctionReturn(0);
5827cb94ee6SHong Zhang }
5837cb94ee6SHong Zhang 
5847087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations_Sundials(TS ts,int *nonlin,int *lin)
5857cb94ee6SHong Zhang {
5867cb94ee6SHong Zhang   PetscFunctionBegin;
5875ef26d82SJed Brown   if (nonlin) *nonlin = ts->snes_its;
5885ef26d82SJed Brown   if (lin)    *lin    = ts->ksp_its;
5897cb94ee6SHong Zhang   PetscFunctionReturn(0);
5907cb94ee6SHong Zhang }
5917cb94ee6SHong Zhang 
5927087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps_Sundials(TS ts,PetscBool s)
5932bfc04deSHong Zhang {
5942bfc04deSHong Zhang   TS_Sundials *cvode = (TS_Sundials*)ts->data;
5952bfc04deSHong Zhang 
5962bfc04deSHong Zhang   PetscFunctionBegin;
5972bfc04deSHong Zhang   cvode->monitorstep = s;
5982bfc04deSHong Zhang   PetscFunctionReturn(0);
5992bfc04deSHong Zhang }
6007cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
6017cb94ee6SHong Zhang 
6027cb94ee6SHong Zhang /*@C
6037cb94ee6SHong Zhang    TSSundialsGetIterations - Gets the number of nonlinear and linear iterations used so far by Sundials.
6047cb94ee6SHong Zhang 
6057cb94ee6SHong Zhang    Not Collective
6067cb94ee6SHong Zhang 
60797bb3fdcSJose E. Roman    Input Parameter:
6087cb94ee6SHong Zhang .    ts     - the time-step context
6097cb94ee6SHong Zhang 
6107cb94ee6SHong Zhang    Output Parameters:
6117cb94ee6SHong Zhang +   nonlin - number of nonlinear iterations
6127cb94ee6SHong Zhang -   lin    - number of linear iterations
6137cb94ee6SHong Zhang 
6147cb94ee6SHong Zhang    Level: advanced
6157cb94ee6SHong Zhang 
6167cb94ee6SHong Zhang    Notes:
6177cb94ee6SHong Zhang     These return the number since the creation of the TS object
6187cb94ee6SHong Zhang 
619db781477SPatrick Sanan .seealso: `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
620db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
621db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
622db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsGetPC()`, `TSSetExactFinalTime()`
6237cb94ee6SHong Zhang 
6247cb94ee6SHong Zhang @*/
6257087cfbeSBarry Smith PetscErrorCode  TSSundialsGetIterations(TS ts,int *nonlin,int *lin)
6267cb94ee6SHong Zhang {
6277cb94ee6SHong Zhang   PetscFunctionBegin;
628cac4c232SBarry Smith   PetscUseMethod(ts,"TSSundialsGetIterations_C",(TS,int*,int*),(ts,nonlin,lin));
6297cb94ee6SHong Zhang   PetscFunctionReturn(0);
6307cb94ee6SHong Zhang }
6317cb94ee6SHong Zhang 
6327cb94ee6SHong Zhang /*@
6337cb94ee6SHong Zhang    TSSundialsSetType - Sets the method that Sundials will use for integration.
6347cb94ee6SHong Zhang 
6353f9fe445SBarry Smith    Logically Collective on TS
6367cb94ee6SHong Zhang 
6378f7d6fe5SPatrick Sanan    Input Parameters:
6387cb94ee6SHong Zhang +    ts     - the time-step context
6397cb94ee6SHong Zhang -    type   - one of  SUNDIALS_ADAMS or SUNDIALS_BDF
6407cb94ee6SHong Zhang 
6417cb94ee6SHong Zhang    Level: intermediate
6427cb94ee6SHong Zhang 
643db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetMaxl()`,
644db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
645db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
646db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
647db781477SPatrick Sanan           `TSSetExactFinalTime()`
6487cb94ee6SHong Zhang @*/
6497087cfbeSBarry Smith PetscErrorCode  TSSundialsSetType(TS ts,TSSundialsLmmType type)
6507cb94ee6SHong Zhang {
6517cb94ee6SHong Zhang   PetscFunctionBegin;
652cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetType_C",(TS,TSSundialsLmmType),(ts,type));
6537cb94ee6SHong Zhang   PetscFunctionReturn(0);
6547cb94ee6SHong Zhang }
6557cb94ee6SHong Zhang 
6567cb94ee6SHong Zhang /*@
657c4e80e11SFlorian    TSSundialsSetMaxord - Sets the maximum order for BDF/Adams method used by SUNDIALS.
658c4e80e11SFlorian 
659c4e80e11SFlorian    Logically Collective on TS
660c4e80e11SFlorian 
6618f7d6fe5SPatrick Sanan    Input Parameters:
662c4e80e11SFlorian +    ts      - the time-step context
663c4e80e11SFlorian -    maxord  - maximum order of BDF / Adams method
664c4e80e11SFlorian 
665c4e80e11SFlorian    Level: advanced
666c4e80e11SFlorian 
667db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`,
668db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
669db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
670db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
671db781477SPatrick Sanan           `TSSetExactFinalTime()`
672c4e80e11SFlorian 
673c4e80e11SFlorian @*/
674c4e80e11SFlorian PetscErrorCode  TSSundialsSetMaxord(TS ts,PetscInt maxord)
675c4e80e11SFlorian {
676c4e80e11SFlorian   PetscFunctionBegin;
677c4e80e11SFlorian   PetscValidLogicalCollectiveInt(ts,maxord,2);
678cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetMaxOrd_C",(TS,PetscInt),(ts,maxord));
679c4e80e11SFlorian   PetscFunctionReturn(0);
680c4e80e11SFlorian }
681c4e80e11SFlorian 
682c4e80e11SFlorian /*@
683f61b2b6aSHong Zhang    TSSundialsSetMaxl - Sets the dimension of the Krylov space used by
6847cb94ee6SHong Zhang        GMRES in the linear solver in SUNDIALS. SUNDIALS DOES NOT use restarted GMRES so
685f61b2b6aSHong Zhang        this is the maximum number of GMRES steps that will be used.
6867cb94ee6SHong Zhang 
6873f9fe445SBarry Smith    Logically Collective on TS
6887cb94ee6SHong Zhang 
6898f7d6fe5SPatrick Sanan    Input Parameters:
6907cb94ee6SHong Zhang +    ts      - the time-step context
691f61b2b6aSHong Zhang -    maxl - number of direction vectors (the dimension of Krylov subspace).
6927cb94ee6SHong Zhang 
6937cb94ee6SHong Zhang    Level: advanced
6947cb94ee6SHong Zhang 
695db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`,
696db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
697db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
698db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
699db781477SPatrick Sanan           `TSSetExactFinalTime()`
7007cb94ee6SHong Zhang 
7017cb94ee6SHong Zhang @*/
702f61b2b6aSHong Zhang PetscErrorCode  TSSundialsSetMaxl(TS ts,PetscInt maxl)
7037cb94ee6SHong Zhang {
7047cb94ee6SHong Zhang   PetscFunctionBegin;
705f61b2b6aSHong Zhang   PetscValidLogicalCollectiveInt(ts,maxl,2);
706cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetMaxl_C",(TS,PetscInt),(ts,maxl));
7077cb94ee6SHong Zhang   PetscFunctionReturn(0);
7087cb94ee6SHong Zhang }
7097cb94ee6SHong Zhang 
7107cb94ee6SHong Zhang /*@
7117cb94ee6SHong Zhang    TSSundialsSetLinearTolerance - Sets the tolerance used to solve the linear
7127cb94ee6SHong Zhang        system by SUNDIALS.
7137cb94ee6SHong Zhang 
7143f9fe445SBarry Smith    Logically Collective on TS
7157cb94ee6SHong Zhang 
7168f7d6fe5SPatrick Sanan    Input Parameters:
7177cb94ee6SHong Zhang +    ts     - the time-step context
7187cb94ee6SHong Zhang -    tol    - the factor by which the tolerance on the nonlinear solver is
7197cb94ee6SHong Zhang              multiplied to get the tolerance on the linear solver, .05 by default.
7207cb94ee6SHong Zhang 
7217cb94ee6SHong Zhang    Level: advanced
7227cb94ee6SHong Zhang 
723db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
724db781477SPatrick Sanan           `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
725db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
726db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
727db781477SPatrick Sanan           `TSSetExactFinalTime()`
7287cb94ee6SHong Zhang 
7297cb94ee6SHong Zhang @*/
730590ae059SPatrick Sanan PetscErrorCode  TSSundialsSetLinearTolerance(TS ts,PetscReal tol)
7317cb94ee6SHong Zhang {
7327cb94ee6SHong Zhang   PetscFunctionBegin;
733c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,tol,2);
734cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetLinearTolerance_C",(TS,PetscReal),(ts,tol));
7357cb94ee6SHong Zhang   PetscFunctionReturn(0);
7367cb94ee6SHong Zhang }
7377cb94ee6SHong Zhang 
7387cb94ee6SHong Zhang /*@
7397cb94ee6SHong Zhang    TSSundialsSetGramSchmidtType - Sets type of orthogonalization used
7407cb94ee6SHong Zhang         in GMRES method by SUNDIALS linear solver.
7417cb94ee6SHong Zhang 
7423f9fe445SBarry Smith    Logically Collective on TS
7437cb94ee6SHong Zhang 
7448f7d6fe5SPatrick Sanan    Input Parameters:
7457cb94ee6SHong Zhang +    ts  - the time-step context
7467cb94ee6SHong Zhang -    type - either SUNDIALS_MODIFIED_GS or SUNDIALS_CLASSICAL_GS
7477cb94ee6SHong Zhang 
7487cb94ee6SHong Zhang    Level: advanced
7497cb94ee6SHong Zhang 
750db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
751db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`,
752db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
753db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
754db781477SPatrick Sanan           `TSSetExactFinalTime()`
7557cb94ee6SHong Zhang 
7567cb94ee6SHong Zhang @*/
7577087cfbeSBarry Smith PetscErrorCode  TSSundialsSetGramSchmidtType(TS ts,TSSundialsGramSchmidtType type)
7587cb94ee6SHong Zhang {
7597cb94ee6SHong Zhang   PetscFunctionBegin;
760cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetGramSchmidtType_C",(TS,TSSundialsGramSchmidtType),(ts,type));
7617cb94ee6SHong Zhang   PetscFunctionReturn(0);
7627cb94ee6SHong Zhang }
7637cb94ee6SHong Zhang 
7647cb94ee6SHong Zhang /*@
7657cb94ee6SHong Zhang    TSSundialsSetTolerance - Sets the absolute and relative tolerance used by
7667cb94ee6SHong Zhang                          Sundials for error control.
7677cb94ee6SHong Zhang 
7683f9fe445SBarry Smith    Logically Collective on TS
7697cb94ee6SHong Zhang 
7708f7d6fe5SPatrick Sanan    Input Parameters:
7717cb94ee6SHong Zhang +    ts  - the time-step context
7727cb94ee6SHong Zhang .    aabs - the absolute tolerance
7737cb94ee6SHong Zhang -    rel - the relative tolerance
7747cb94ee6SHong Zhang 
7757cb94ee6SHong Zhang      See the Cvode/Sundials users manual for exact details on these parameters. Essentially
7767cb94ee6SHong Zhang     these regulate the size of the error for a SINGLE timestep.
7777cb94ee6SHong Zhang 
7787cb94ee6SHong Zhang    Level: intermediate
7797cb94ee6SHong Zhang 
780db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetGMRESMaxl()`,
781db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`,
782db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
783db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`,
784db781477SPatrick Sanan           `TSSetExactFinalTime()`
7857cb94ee6SHong Zhang 
7867cb94ee6SHong Zhang @*/
787590ae059SPatrick Sanan PetscErrorCode  TSSundialsSetTolerance(TS ts,PetscReal aabs,PetscReal rel)
7887cb94ee6SHong Zhang {
7897cb94ee6SHong Zhang   PetscFunctionBegin;
790cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetTolerance_C",(TS,PetscReal,PetscReal),(ts,aabs,rel));
7917cb94ee6SHong Zhang   PetscFunctionReturn(0);
7927cb94ee6SHong Zhang }
7937cb94ee6SHong Zhang 
7947cb94ee6SHong Zhang /*@
7957cb94ee6SHong Zhang    TSSundialsGetPC - Extract the PC context from a time-step context for Sundials.
7967cb94ee6SHong Zhang 
7977cb94ee6SHong Zhang    Input Parameter:
7987cb94ee6SHong Zhang .    ts - the time-step context
7997cb94ee6SHong Zhang 
8007cb94ee6SHong Zhang    Output Parameter:
8017cb94ee6SHong Zhang .    pc - the preconditioner context
8027cb94ee6SHong Zhang 
8037cb94ee6SHong Zhang    Level: advanced
8047cb94ee6SHong Zhang 
805db781477SPatrick Sanan .seealso: `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
806db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
807db781477SPatrick Sanan           `TSSundialsGetIterations()`, `TSSundialsSetType()`,
808db781477SPatrick Sanan           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`
8097cb94ee6SHong Zhang @*/
8107087cfbeSBarry Smith PetscErrorCode  TSSundialsGetPC(TS ts,PC *pc)
8117cb94ee6SHong Zhang {
8127cb94ee6SHong Zhang   PetscFunctionBegin;
813cac4c232SBarry Smith   PetscUseMethod(ts,"TSSundialsGetPC_C",(TS,PC*),(ts,pc));
8147cb94ee6SHong Zhang   PetscFunctionReturn(0);
8157cb94ee6SHong Zhang }
8167cb94ee6SHong Zhang 
817f1cd61daSJed Brown /*@
818f1cd61daSJed Brown    TSSundialsSetMinTimeStep - Smallest time step to be chosen by the adaptive controller.
819f1cd61daSJed Brown 
820d8d19677SJose E. Roman    Input Parameters:
821f1cd61daSJed Brown +   ts - the time-step context
822f1cd61daSJed Brown -   mindt - lowest time step if positive, negative to deactivate
823f1cd61daSJed Brown 
824fc6b9e64SJed Brown    Note:
825fc6b9e64SJed Brown    Sundials will error if it is not possible to keep the estimated truncation error below
826fc6b9e64SJed Brown    the tolerance set with TSSundialsSetTolerance() without going below this step size.
827fc6b9e64SJed Brown 
828f1cd61daSJed Brown    Level: beginner
829f1cd61daSJed Brown 
830db781477SPatrick Sanan .seealso: `TSSundialsSetType()`, `TSSundialsSetTolerance()`,
831f1cd61daSJed Brown @*/
8327087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMinTimeStep(TS ts,PetscReal mindt)
833f1cd61daSJed Brown {
834f1cd61daSJed Brown   PetscFunctionBegin;
835cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetMinTimeStep_C",(TS,PetscReal),(ts,mindt));
836f1cd61daSJed Brown   PetscFunctionReturn(0);
837f1cd61daSJed Brown }
838f1cd61daSJed Brown 
839f1cd61daSJed Brown /*@
840f1cd61daSJed Brown    TSSundialsSetMaxTimeStep - Largest time step to be chosen by the adaptive controller.
841f1cd61daSJed Brown 
842d8d19677SJose E. Roman    Input Parameters:
843f1cd61daSJed Brown +   ts - the time-step context
844f1cd61daSJed Brown -   maxdt - lowest time step if positive, negative to deactivate
845f1cd61daSJed Brown 
846f1cd61daSJed Brown    Level: beginner
847f1cd61daSJed Brown 
848db781477SPatrick Sanan .seealso: `TSSundialsSetType()`, `TSSundialsSetTolerance()`,
849f1cd61daSJed Brown @*/
8507087cfbeSBarry Smith PetscErrorCode  TSSundialsSetMaxTimeStep(TS ts,PetscReal maxdt)
851f1cd61daSJed Brown {
852f1cd61daSJed Brown   PetscFunctionBegin;
853cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetMaxTimeStep_C",(TS,PetscReal),(ts,maxdt));
854f1cd61daSJed Brown   PetscFunctionReturn(0);
855f1cd61daSJed Brown }
856f1cd61daSJed Brown 
8572bfc04deSHong Zhang /*@
8582bfc04deSHong Zhang    TSSundialsMonitorInternalSteps - Monitor Sundials internal steps (Defaults to false).
8592bfc04deSHong Zhang 
860d8d19677SJose E. Roman    Input Parameters:
8612bfc04deSHong Zhang +   ts - the time-step context
8622bfc04deSHong Zhang -   ft - PETSC_TRUE if monitor, else PETSC_FALSE
8632bfc04deSHong Zhang 
8642bfc04deSHong Zhang    Level: beginner
8652bfc04deSHong Zhang 
866f61b2b6aSHong Zhang .seealso:TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetMaxl(),
8672bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(),
868f61b2b6aSHong Zhang           TSSundialsGetIterations(), TSSundialsSetType(),
8692bfc04deSHong Zhang           TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC()
8702bfc04deSHong Zhang @*/
8717087cfbeSBarry Smith PetscErrorCode  TSSundialsMonitorInternalSteps(TS ts,PetscBool ft)
8722bfc04deSHong Zhang {
8732bfc04deSHong Zhang   PetscFunctionBegin;
874cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsMonitorInternalSteps_C",(TS,PetscBool),(ts,ft));
8752bfc04deSHong Zhang   PetscFunctionReturn(0);
8762bfc04deSHong Zhang }
877918687b8SPatrick Sanan 
878918687b8SPatrick Sanan /*@
879918687b8SPatrick Sanan    TSSundialsSetUseDense - Set a flag to use a dense linear solver in SUNDIALS (serial only)
880918687b8SPatrick Sanan 
881918687b8SPatrick Sanan    Logically Collective
882918687b8SPatrick Sanan 
883918687b8SPatrick Sanan    Input Parameters:
884918687b8SPatrick Sanan +    ts         - the time-step context
885918687b8SPatrick Sanan -    use_dense  - PETSC_TRUE to use the dense solver
886918687b8SPatrick Sanan 
887918687b8SPatrick Sanan    Level: advanced
888918687b8SPatrick Sanan 
889db781477SPatrick Sanan .seealso: `TSSUNDIALS`
890918687b8SPatrick Sanan 
891918687b8SPatrick Sanan @*/
892918687b8SPatrick Sanan PetscErrorCode  TSSundialsSetUseDense(TS ts,PetscBool use_dense)
893918687b8SPatrick Sanan {
894918687b8SPatrick Sanan   PetscFunctionBegin;
895918687b8SPatrick Sanan   PetscValidLogicalCollectiveInt(ts,use_dense,2);
896cac4c232SBarry Smith   PetscTryMethod(ts,"TSSundialsSetUseDense_C",(TS,PetscBool),(ts,use_dense));
897918687b8SPatrick Sanan   PetscFunctionReturn(0);
898918687b8SPatrick Sanan }
899918687b8SPatrick Sanan 
9007cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/
9017cb94ee6SHong Zhang /*MC
90296f5712cSJed Brown       TSSUNDIALS - ODE solver using the LLNL CVODE/SUNDIALS package (now called SUNDIALS)
9037cb94ee6SHong Zhang 
9047cb94ee6SHong Zhang    Options Database:
905897c9f78SHong Zhang +    -ts_sundials_type <bdf,adams> -
9067cb94ee6SHong Zhang .    -ts_sundials_gramschmidt_type <modified, classical> - type of orthogonalization inside GMRES
9077cb94ee6SHong Zhang .    -ts_sundials_atol <tol> - Absolute tolerance for convergence
9087cb94ee6SHong Zhang .    -ts_sundials_rtol <tol> - Relative tolerance for convergence
909897c9f78SHong Zhang .    -ts_sundials_linear_tolerance <tol> -
910f61b2b6aSHong Zhang .    -ts_sundials_maxl <maxl> - Max dimension of the Krylov subspace
911918687b8SPatrick Sanan .    -ts_sundials_monitor_steps - Monitor SUNDIALS internal steps
912918687b8SPatrick Sanan -    -ts_sundials_use_dense - Use a dense linear solver within CVODE (serial only)
91316016685SHong Zhang 
91495452b02SPatrick Sanan     Notes:
91595452b02SPatrick Sanan     This uses its own nonlinear solver and Krylov method so PETSc SNES and KSP options do not apply,
916897c9f78SHong Zhang            only PETSc PC options.
9177cb94ee6SHong Zhang 
9187cb94ee6SHong Zhang     Level: beginner
9197cb94ee6SHong Zhang 
920db781477SPatrick Sanan .seealso: `TSCreate()`, `TS`, `TSSetType()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`, `TSSundialsSetLinearTolerance()`,
921db781477SPatrick Sanan           `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`, `TSSundialsGetIterations()`, `TSSetExactFinalTime()`
9227cb94ee6SHong Zhang 
9237cb94ee6SHong Zhang M*/
9248cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_Sundials(TS ts)
9257cb94ee6SHong Zhang {
9267cb94ee6SHong Zhang   TS_Sundials    *cvode;
92742528757SHong Zhang   PC             pc;
9287cb94ee6SHong Zhang 
9297cb94ee6SHong Zhang   PetscFunctionBegin;
930277b19d0SLisandro Dalcin   ts->ops->reset          = TSReset_Sundials;
93128adb3f7SHong Zhang   ts->ops->destroy        = TSDestroy_Sundials;
93228adb3f7SHong Zhang   ts->ops->view           = TSView_Sundials;
933214bc6a2SJed Brown   ts->ops->setup          = TSSetUp_Sundials;
934b4eba00bSSean Farley   ts->ops->step           = TSStep_Sundials;
935b4eba00bSSean Farley   ts->ops->interpolate    = TSInterpolate_Sundials;
936214bc6a2SJed Brown   ts->ops->setfromoptions = TSSetFromOptions_Sundials;
9372ffb9264SLisandro Dalcin   ts->default_adapt_type  = TSADAPTNONE;
9387cb94ee6SHong Zhang 
9399566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(ts,&cvode));
940bbd56ea5SKarl Rupp 
941efd4aadfSBarry Smith   ts->usessnes = PETSC_TRUE;
942efd4aadfSBarry Smith 
9437cb94ee6SHong Zhang   ts->data           = (void*)cvode;
9446fadb2cdSHong Zhang   cvode->cvode_type  = SUNDIALS_BDF;
9456fadb2cdSHong Zhang   cvode->gtype       = SUNDIALS_CLASSICAL_GS;
946f61b2b6aSHong Zhang   cvode->maxl        = 5;
947c4e80e11SFlorian   cvode->maxord      = PETSC_DEFAULT;
9487cb94ee6SHong Zhang   cvode->linear_tol  = .05;
949b4eba00bSSean Farley   cvode->monitorstep = PETSC_TRUE;
950918687b8SPatrick Sanan   cvode->use_dense   = PETSC_FALSE;
9517cb94ee6SHong Zhang 
9529566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_dup(PetscObjectComm((PetscObject)ts),&(cvode->comm_sundials)));
953f1cd61daSJed Brown 
954f1cd61daSJed Brown   cvode->mindt = -1.;
955f1cd61daSJed Brown   cvode->maxdt = -1.;
956f1cd61daSJed Brown 
9577cb94ee6SHong Zhang   /* set tolerance for Sundials */
9587cb94ee6SHong Zhang   cvode->reltol = 1e-6;
9592c823083SHong Zhang   cvode->abstol = 1e-6;
9607cb94ee6SHong Zhang 
96142528757SHong Zhang   /* set PCNONE as default pctype */
9629566063dSJacob Faibussowitsch   PetscCall(TSSundialsGetPC_Sundials(ts,&pc));
9639566063dSJacob Faibussowitsch   PetscCall(PCSetType(pc,PCNONE));
96442528757SHong Zhang 
9659566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetType_C",TSSundialsSetType_Sundials));
9669566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxl_C",TSSundialsSetMaxl_Sundials));
9679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetLinearTolerance_C",TSSundialsSetLinearTolerance_Sundials));
9689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetGramSchmidtType_C",TSSundialsSetGramSchmidtType_Sundials));
9699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetTolerance_C",TSSundialsSetTolerance_Sundials));
9709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMinTimeStep_C",TSSundialsSetMinTimeStep_Sundials));
9719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetMaxTimeStep_C",TSSundialsSetMaxTimeStep_Sundials));
9729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetPC_C",TSSundialsGetPC_Sundials));
9739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsGetIterations_C",TSSundialsGetIterations_Sundials));
9749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsMonitorInternalSteps_C",TSSundialsMonitorInternalSteps_Sundials));
9759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)ts,"TSSundialsSetUseDense_C",TSSundialsSetUseDense_Sundials));
9767cb94ee6SHong Zhang   PetscFunctionReturn(0);
9777cb94ee6SHong Zhang }
978