Actual source code: sundials.c

  1: /*
  2:     Provides a PETSc interface to version 2.5 of SUNDIALS/CVODE solver (a very old version)
  3:     The interface to PVODE (old version of CVODE) was originally contributed
  4:     by Liyang Xu. It has been redone by Hong Zhang and Dinesh Kaushik.

  6:     Reference: sundials-2.4.0/examples/cvode/parallel/cvDiurnal_kry_p.c
  7: */
  8: #include <../src/ts/impls/implicit/sundials/sundials.h>

 10: /*
 11:       TSPrecond_Sundials - function that we provide to SUNDIALS to
 12:                         evaluate the preconditioner.
 13: */
 14: static PetscErrorCode TSPrecond_Sundials_Petsc(realtype tn, N_Vector y, N_Vector fy, booleantype jok, booleantype *jcurPtr, realtype _gamma, void *P_data, N_Vector vtemp1, N_Vector vtemp2, N_Vector vtemp3)
 15: {
 16:   TS           ts    = (TS)P_data;
 17:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
 18:   PC           pc;
 19:   Mat          J, P;
 20:   Vec          yy = cvode->w1, yydot = cvode->ydot;
 21:   PetscReal    gm = (PetscReal)_gamma;
 22:   PetscScalar *y_data;

 24:   PetscFunctionBegin;
 25:   PetscCall(TSGetIJacobian(ts, &J, &P, NULL, NULL));
 26:   y_data = (PetscScalar *)N_VGetArrayPointer(y);
 27:   PetscCall(VecPlaceArray(yy, y_data));
 28:   PetscCall(VecZeroEntries(yydot)); /* The Jacobian is independent of Ydot for ODE which is all that CVode works for */
 29:   /* compute the shifted Jacobian   (1/gm)*I + Jrest */
 30:   PetscCall(TSComputeIJacobian(ts, ts->ptime, yy, yydot, 1 / gm, J, P, PETSC_FALSE));
 31:   PetscCall(VecResetArray(yy));
 32:   PetscCall(MatScale(P, gm)); /* turn into I-gm*Jrest, J is not used by SUNDIALS  */
 33:   *jcurPtr = TRUE;
 34:   PetscCall(TSSundialsGetPC(ts, &pc));
 35:   PetscCall(PCSetOperators(pc, J, P));
 36:   PetscFunctionReturn(PETSC_SUCCESS);
 37: }

 39: /* Sundial expects an int (*)(args...) but PetscErrorCode is an enum. Instead of switching out
 40:    all the PetscCalls in TSPrecond_Sundials_Petsc we just wrap it */
 41: static int TSPrecond_Sundials_Private(realtype tn, N_Vector y, N_Vector fy, booleantype jok, booleantype *jcurPtr, realtype _gamma, void *P_data, N_Vector vtemp1, N_Vector vtemp2, N_Vector vtemp3)
 42: {
 43:   return (int)TSPrecond_Sundials_Petsc(tn, y, fy, jok, jcurPtr, _gamma, P_data, vtemp1, vtemp2, vtemp3);
 44: }

 46: /*
 47:      TSPSolve_Sundials -  routine that we provide to SUNDIALS that applies the preconditioner.
 48: */
 49: static PetscErrorCode TSPSolve_Sundials_Petsc(realtype tn, N_Vector y, N_Vector fy, N_Vector r, N_Vector z, realtype _gamma, realtype delta, int lr, void *P_data, N_Vector vtemp)
 50: {
 51:   TS           ts    = (TS)P_data;
 52:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
 53:   PC           pc;
 54:   Vec          rr = cvode->w1, zz = cvode->w2;
 55:   PetscScalar *r_data, *z_data;

 57:   PetscFunctionBegin;
 58:   /* Make the PETSc work vectors rr and zz point to the arrays in the SUNDIALS vectors r and z respectively*/
 59:   r_data = (PetscScalar *)N_VGetArrayPointer(r);
 60:   z_data = (PetscScalar *)N_VGetArrayPointer(z);
 61:   PetscCall(VecPlaceArray(rr, r_data));
 62:   PetscCall(VecPlaceArray(zz, z_data));

 64:   /* Solve the Px=r and put the result in zz */
 65:   PetscCall(TSSundialsGetPC(ts, &pc));
 66:   PetscCall(PCApply(pc, rr, zz));
 67:   PetscCall(VecResetArray(rr));
 68:   PetscCall(VecResetArray(zz));
 69:   PetscFunctionReturn(PETSC_SUCCESS);
 70: }

 72: /* See TSPrecond_Sundials_Private() */
 73: static int TSPSolve_Sundials_Private(realtype tn, N_Vector y, N_Vector fy, N_Vector r, N_Vector z, realtype _gamma, realtype delta, int lr, void *P_data, N_Vector vtemp)
 74: {
 75:   return (int)TSPSolve_Sundials_Petsc(tn, y, fy, r, z, _gamma, delta, lr, P_data, vtemp);
 76: }

 78: /*
 79:         TSFunction_Sundials - routine that we provide to SUNDIALS that applies the right-hand side.
 80: */
 81: static int TSFunction_Sundials(realtype t, N_Vector y, N_Vector ydot, void *ctx)
 82: {
 83:   TS             ts = (TS)ctx;
 84:   DM             dm;
 85:   DMTS           tsdm;
 86:   TSIFunctionFn *ifunction;
 87:   MPI_Comm       comm;
 88:   TS_Sundials   *cvode = (TS_Sundials *)ts->data;
 89:   Vec            yy = cvode->w1, yyd = cvode->w2, yydot = cvode->ydot;
 90:   PetscScalar   *y_data, *ydot_data;

 92:   PetscFunctionBegin;
 93:   PetscCall(PetscObjectGetComm((PetscObject)ts, &comm));
 94:   /* Make the PETSc work vectors yy and yyd point to the arrays in the SUNDIALS vectors y and ydot respectively*/
 95:   y_data    = (PetscScalar *)N_VGetArrayPointer(y);
 96:   ydot_data = (PetscScalar *)N_VGetArrayPointer(ydot);
 97:   PetscCallAbort(comm, VecPlaceArray(yy, y_data));
 98:   PetscCallAbort(comm, VecPlaceArray(yyd, ydot_data));

100:   /* Now compute the right-hand side function, via IFunction unless only the more efficient RHSFunction is set */
101:   PetscCall(TSGetDM(ts, &dm));
102:   PetscCall(DMGetDMTS(dm, &tsdm));
103:   PetscCall(DMTSGetIFunction(dm, &ifunction, NULL));
104:   if (!ifunction) {
105:     PetscCall(TSComputeRHSFunction(ts, t, yy, yyd));
106:   } else { /* If rhsfunction is also set, this computes both parts and shifts them to the right */
107:     PetscCall(VecZeroEntries(yydot));
108:     PetscCallAbort(comm, TSComputeIFunction(ts, t, yy, yydot, yyd, PETSC_FALSE));
109:     PetscCall(VecScale(yyd, -1.));
110:   }
111:   PetscCallAbort(comm, VecResetArray(yy));
112:   PetscCallAbort(comm, VecResetArray(yyd));
113:   PetscFunctionReturn(PETSC_SUCCESS);
114: }

116: /*
117:        TSStep_Sundials - Calls SUNDIALS to integrate the ODE.
118: */
119: static PetscErrorCode TSStep_Sundials(TS ts)
120: {
121:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
122:   PetscInt     flag;
123:   long int     nits, lits, nsteps;
124:   realtype     t, tout;
125:   PetscScalar *y_data;
126:   void        *mem;

128:   PetscFunctionBegin;
129:   mem  = cvode->mem;
130:   tout = ts->max_time;
131:   PetscCall(VecGetArray(ts->vec_sol, &y_data));
132:   N_VSetArrayPointer((realtype *)y_data, cvode->y);
133:   PetscCall(VecRestoreArray(ts->vec_sol, NULL));

135:   /* We would like to TSPreStage() and TSPostStage()
136:    * before each stage solve but CVode does not appear to support this. */
137:   if (cvode->monitorstep) flag = CVode(mem, tout, cvode->y, &t, CV_ONE_STEP);
138:   else flag = CVode(mem, tout, cvode->y, &t, CV_NORMAL);

140:   if (flag) { /* display error message */
141:     switch (flag) {
142:     case CV_ILL_INPUT:
143:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_ILL_INPUT");
144:       break;
145:     case CV_TOO_CLOSE:
146:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_TOO_CLOSE");
147:       break;
148:     case CV_TOO_MUCH_WORK: {
149:       PetscReal tcur;
150:       PetscCallExternal(CVodeGetNumSteps, mem, &nsteps);
151:       PetscCallExternal(CVodeGetCurrentTime, mem, &tcur);
152:       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);
153:     } break;
154:     case CV_TOO_MUCH_ACC:
155:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_TOO_MUCH_ACC");
156:       break;
157:     case CV_ERR_FAILURE:
158:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_ERR_FAILURE");
159:       break;
160:     case CV_CONV_FAILURE:
161:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_CONV_FAILURE");
162:       break;
163:     case CV_LINIT_FAIL:
164:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_LINIT_FAIL");
165:       break;
166:     case CV_LSETUP_FAIL:
167:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_LSETUP_FAIL");
168:       break;
169:     case CV_LSOLVE_FAIL:
170:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_LSOLVE_FAIL");
171:       break;
172:     case CV_RHSFUNC_FAIL:
173:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_RHSFUNC_FAIL");
174:       break;
175:     case CV_FIRST_RHSFUNC_ERR:
176:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_FIRST_RHSFUNC_ERR");
177:       break;
178:     case CV_REPTD_RHSFUNC_ERR:
179:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_REPTD_RHSFUNC_ERR");
180:       break;
181:     case CV_UNREC_RHSFUNC_ERR:
182:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_UNREC_RHSFUNC_ERR");
183:       break;
184:     case CV_RTFUNC_FAIL:
185:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, CV_RTFUNC_FAIL");
186:       break;
187:     default:
188:       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "CVode() fails, flag %d", flag);
189:     }
190:   }

192:   /* log inner nonlinear and linear iterations */
193:   PetscCallExternal(CVodeGetNumNonlinSolvIters, mem, &nits);
194:   PetscCallExternal(CVSpilsGetNumLinIters, mem, &lits);
195:   ts->snes_its += nits;
196:   ts->ksp_its = lits;

198:   /* copy the solution from cvode->y to cvode->update and sol */
199:   PetscCall(VecPlaceArray(cvode->w1, y_data));
200:   PetscCall(VecCopy(cvode->w1, cvode->update));
201:   PetscCall(VecResetArray(cvode->w1));
202:   PetscCall(VecCopy(cvode->update, ts->vec_sol));

204:   ts->time_step = t - ts->ptime;
205:   ts->ptime     = t;

207:   PetscCallExternal(CVodeGetNumSteps, mem, &nsteps);
208:   if (!cvode->monitorstep) ts->steps += nsteps - 1; /* TSStep() increments the step counter by one */
209:   PetscFunctionReturn(PETSC_SUCCESS);
210: }

212: static PetscErrorCode TSInterpolate_Sundials(TS ts, PetscReal t, Vec X)
213: {
214:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
215:   N_Vector     y;
216:   PetscScalar *x_data;
217:   PetscInt     glosize, locsize;

219:   PetscFunctionBegin;
220:   /* get the vector size */
221:   PetscCall(VecGetSize(X, &glosize));
222:   PetscCall(VecGetLocalSize(X, &locsize));
223:   PetscCall(VecGetArray(X, &x_data));

225:   /* Initialize N_Vec y with x_data */
226:   if (cvode->use_dense) {
227:     PetscMPIInt size;

229:     PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD, &size));
230:     PetscCheck(size == 1, PETSC_COMM_WORLD, PETSC_ERR_WRONG_MPI_SIZE, "TSSUNDIALS only supports a dense solve in the serial case");
231:     y = N_VMake_Serial(locsize, (realtype *)x_data);
232:   } else {
233:     y = N_VMake_Parallel(cvode->comm_sundials, locsize, glosize, (realtype *)x_data);
234:   }

236:   PetscCheck(y, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Interpolated y is not allocated");

238:   PetscCallExternal(CVodeGetDky, cvode->mem, t, 0, y);
239:   PetscCall(VecRestoreArray(X, &x_data));
240:   PetscFunctionReturn(PETSC_SUCCESS);
241: }

243: static PetscErrorCode TSReset_Sundials(TS ts)
244: {
245:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

247:   PetscFunctionBegin;
248:   PetscCall(VecDestroy(&cvode->update));
249:   PetscCall(VecDestroy(&cvode->ydot));
250:   PetscCall(VecDestroy(&cvode->w1));
251:   PetscCall(VecDestroy(&cvode->w2));
252:   if (cvode->mem) CVodeFree(&cvode->mem);
253:   PetscFunctionReturn(PETSC_SUCCESS);
254: }

256: static PetscErrorCode TSDestroy_Sundials(TS ts)
257: {
258:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

260:   PetscFunctionBegin;
261:   PetscCall(TSReset_Sundials(ts));
262:   PetscCallMPI(MPI_Comm_free(&cvode->comm_sundials));
263:   PetscCall(PetscFree(ts->data));
264:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetType_C", NULL));
265:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMaxl_C", NULL));
266:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetLinearTolerance_C", NULL));
267:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetGramSchmidtType_C", NULL));
268:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetTolerance_C", NULL));
269:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMinTimeStep_C", NULL));
270:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMaxTimeStep_C", NULL));
271:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsGetPC_C", NULL));
272:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsGetIterations_C", NULL));
273:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsMonitorInternalSteps_C", NULL));
274:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetUseDense_C", NULL));
275:   PetscFunctionReturn(PETSC_SUCCESS);
276: }

278: static PetscErrorCode TSSetUp_Sundials(TS ts)
279: {
280:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
281:   PetscInt     glosize, locsize, i;
282:   PetscScalar *y_data, *parray;
283:   PC           pc;
284:   PCType       pctype;
285:   PetscBool    pcnone;

287:   PetscFunctionBegin;
288:   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");

290:   /* get the vector size */
291:   PetscCall(VecGetSize(ts->vec_sol, &glosize));
292:   PetscCall(VecGetLocalSize(ts->vec_sol, &locsize));

294:   /* allocate the memory for N_Vec y */
295:   if (cvode->use_dense) {
296:     PetscMPIInt size;

298:     PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD, &size));
299:     PetscCheck(size == 1, PETSC_COMM_WORLD, PETSC_ERR_WRONG_MPI_SIZE, "TSSUNDIALS only supports a dense solve in the serial case");
300:     cvode->y = N_VNew_Serial(locsize);
301:   } else {
302:     cvode->y = N_VNew_Parallel(cvode->comm_sundials, locsize, glosize);
303:   }
304:   PetscCheck(cvode->y, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "cvode->y is not allocated");

306:   /* initialize N_Vec y: copy ts->vec_sol to cvode->y */
307:   PetscCall(VecGetArray(ts->vec_sol, &parray));
308:   y_data = (PetscScalar *)N_VGetArrayPointer(cvode->y);
309:   for (i = 0; i < locsize; i++) y_data[i] = parray[i];
310:   PetscCall(VecRestoreArray(ts->vec_sol, NULL));

312:   PetscCall(VecDuplicate(ts->vec_sol, &cvode->update));
313:   PetscCall(VecDuplicate(ts->vec_sol, &cvode->ydot));

315:   /*
316:     Create work vectors for the TSPSolve_Sundials() routine. Note these are
317:     allocated with zero space arrays because the actual array space is provided
318:     by SUNDIALS and set using VecPlaceArray().
319:   */
320:   PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts), 1, locsize, PETSC_DECIDE, NULL, &cvode->w1));
321:   PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ts), 1, locsize, PETSC_DECIDE, NULL, &cvode->w2));

323:   /* Call CVodeCreate to create the solver memory and the use of a Newton iteration */
324:   cvode->mem = CVodeCreate(cvode->cvode_type, CV_NEWTON);
325:   PetscCheck(cvode->mem, PETSC_COMM_SELF, PETSC_ERR_MEM, "CVodeCreate() fails");

327:   /* Set the pointer to user-defined data */
328:   PetscCallExternal(CVodeSetUserData, cvode->mem, ts);

330:   /* SUNDIALS may choose to use a smaller initial step, but will never use a larger step. */
331:   PetscCallExternal(CVodeSetInitStep, cvode->mem, (realtype)ts->time_step);
332:   if (cvode->mindt > 0) {
333:     int flag = CVodeSetMinStep(cvode->mem, (realtype)cvode->mindt);
334:     if (flag) {
335:       PetscCheck(flag != CV_MEM_NULL, PetscObjectComm((PetscObject)ts), PETSC_ERR_LIB, "CVodeSetMinStep() failed, cvode_mem pointer is NULL");
336:       PetscCheck(flag != CV_ILL_INPUT, PetscObjectComm((PetscObject)ts), PETSC_ERR_LIB, "CVodeSetMinStep() failed, hmin is nonpositive or it exceeds the maximum allowable step size");
337:       SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_LIB, "CVodeSetMinStep() failed");
338:     }
339:   }
340:   if (cvode->maxdt > 0) PetscCallExternal(CVodeSetMaxStep, cvode->mem, (realtype)cvode->maxdt);

342:   /* Call CVodeInit to initialize the integrator memory and specify the
343:    * user's right-hand side function in u'=f(t,u), the initial time T0, and
344:    * the initial dependent variable vector cvode->y */
345:   PetscCallExternal(CVodeInit, cvode->mem, TSFunction_Sundials, ts->ptime, cvode->y);

347:   /* specifies scalar relative and absolute tolerances */
348:   PetscCallExternal(CVodeSStolerances, cvode->mem, cvode->reltol, cvode->abstol);

350:   /* Specify max order of BDF / ADAMS method */
351:   if (cvode->maxord != PETSC_DEFAULT) PetscCallExternal(CVodeSetMaxOrd, cvode->mem, cvode->maxord);

353:   /* Specify max num of steps to be taken by cvode in its attempt to reach the next output time */
354:   PetscCallExternal(CVodeSetMaxNumSteps, cvode->mem, ts->max_steps);

356:   if (cvode->use_dense) {
357:     PetscCallExternal(CVDense, cvode->mem, locsize);
358:   } else {
359:     /* call CVSpgmr to use GMRES as the linear solver.        */
360:     /* setup the ode integrator with the given preconditioner */
361:     PetscCall(TSSundialsGetPC(ts, &pc));
362:     PetscCall(PCGetType(pc, &pctype));
363:     PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCNONE, &pcnone));
364:     if (pcnone) {
365:       PetscCallExternal(CVSpgmr, cvode->mem, PREC_NONE, 0);
366:     } else {
367:       PetscCallExternal(CVSpgmr, cvode->mem, PREC_LEFT, cvode->maxl);

369:       /* Set preconditioner and solve routines Precond and PSolve,
370:          and the pointer to the user-defined block data */
371:       PetscCallExternal(CVSpilsSetPreconditioner, cvode->mem, TSPrecond_Sundials_Private, TSPSolve_Sundials_Private);
372:     }
373:   }
374:   PetscFunctionReturn(PETSC_SUCCESS);
375: }

377: /* type of CVODE linear multistep method */
378: const char *const TSSundialsLmmTypes[] = {"", "ADAMS", "BDF", "TSSundialsLmmType", "SUNDIALS_", NULL};
379: /* type of G-S orthogonalization used by CVODE linear solver */
380: const char *const TSSundialsGramSchmidtTypes[] = {"", "MODIFIED", "CLASSICAL", "TSSundialsGramSchmidtType", "SUNDIALS_", NULL};

382: static PetscErrorCode TSSetFromOptions_Sundials(TS ts, PetscOptionItems *PetscOptionsObject)
383: {
384:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
385:   int          indx;
386:   PetscBool    flag;
387:   PC           pc;

389:   PetscFunctionBegin;
390:   PetscOptionsHeadBegin(PetscOptionsObject, "SUNDIALS ODE solver options");
391:   PetscCall(PetscOptionsEList("-ts_sundials_type", "Scheme", "TSSundialsSetType", TSSundialsLmmTypes, 3, TSSundialsLmmTypes[cvode->cvode_type], &indx, &flag));
392:   if (flag) PetscCall(TSSundialsSetType(ts, (TSSundialsLmmType)indx));
393:   PetscCall(PetscOptionsEList("-ts_sundials_gramschmidt_type", "Type of orthogonalization", "TSSundialsSetGramSchmidtType", TSSundialsGramSchmidtTypes, 3, TSSundialsGramSchmidtTypes[cvode->gtype], &indx, &flag));
394:   if (flag) PetscCall(TSSundialsSetGramSchmidtType(ts, (TSSundialsGramSchmidtType)indx));
395:   PetscCall(PetscOptionsReal("-ts_sundials_atol", "Absolute tolerance for convergence", "TSSundialsSetTolerance", cvode->abstol, &cvode->abstol, NULL));
396:   PetscCall(PetscOptionsReal("-ts_sundials_rtol", "Relative tolerance for convergence", "TSSundialsSetTolerance", cvode->reltol, &cvode->reltol, NULL));
397:   PetscCall(PetscOptionsReal("-ts_sundials_mindt", "Minimum step size", "TSSundialsSetMinTimeStep", cvode->mindt, &cvode->mindt, NULL));
398:   PetscCall(PetscOptionsReal("-ts_sundials_maxdt", "Maximum step size", "TSSundialsSetMaxTimeStep", cvode->maxdt, &cvode->maxdt, NULL));
399:   PetscCall(PetscOptionsReal("-ts_sundials_linear_tolerance", "Convergence tolerance for linear solve", "TSSundialsSetLinearTolerance", cvode->linear_tol, &cvode->linear_tol, NULL));
400:   PetscCall(PetscOptionsInt("-ts_sundials_maxord", "Max Order for BDF/Adams method", "TSSundialsSetMaxOrd", cvode->maxord, &cvode->maxord, NULL));
401:   PetscCall(PetscOptionsInt("-ts_sundials_maxl", "Max dimension of the Krylov subspace", "TSSundialsSetMaxl", cvode->maxl, &cvode->maxl, NULL));
402:   PetscCall(PetscOptionsBool("-ts_sundials_monitor_steps", "Monitor SUNDIALS internal steps", "TSSundialsMonitorInternalSteps", cvode->monitorstep, &cvode->monitorstep, NULL));
403:   PetscCall(PetscOptionsBool("-ts_sundials_use_dense", "Use dense internal solver in SUNDIALS (serial only)", "TSSundialsSetUseDense", cvode->use_dense, &cvode->use_dense, NULL));
404:   PetscOptionsHeadEnd();
405:   PetscCall(TSSundialsGetPC(ts, &pc));
406:   PetscCall(PCSetFromOptions(pc));
407:   PetscFunctionReturn(PETSC_SUCCESS);
408: }

410: static PetscErrorCode TSView_Sundials(TS ts, PetscViewer viewer)
411: {
412:   TS_Sundials *cvode = (TS_Sundials *)ts->data;
413:   char        *type;
414:   char         atype[] = "Adams";
415:   char         btype[] = "BDF: backward differentiation formula";
416:   PetscBool    iascii, isstring;
417:   long int     nsteps, its, nfevals, nlinsetups, nfails, itmp;
418:   PetscInt     qlast, qcur;
419:   PetscReal    hinused, hlast, hcur, tcur, tolsfac;
420:   PC           pc;

422:   PetscFunctionBegin;
423:   if (cvode->cvode_type == SUNDIALS_ADAMS) type = atype;
424:   else type = btype;

426:   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
427:   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERSTRING, &isstring));
428:   if (iascii) {
429:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS integrator does not use SNES!\n"));
430:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS integrator type %s\n", type));
431:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS maxord %" PetscInt_FMT "\n", cvode->maxord));
432:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS abs tol %g rel tol %g\n", (double)cvode->abstol, (double)cvode->reltol));
433:     if (cvode->use_dense) {
434:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS integrator using a dense linear solve\n"));
435:     } else {
436:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS linear solver tolerance factor %g\n", (double)cvode->linear_tol));
437:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS max dimension of Krylov subspace %" PetscInt_FMT "\n", cvode->maxl));
438:       if (cvode->gtype == SUNDIALS_MODIFIED_GS) {
439:         PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS using modified Gram-Schmidt for orthogonalization in GMRES\n"));
440:       } else {
441:         PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS using unmodified (classical) Gram-Schmidt for orthogonalization in GMRES\n"));
442:       }
443:     }
444:     if (cvode->mindt > 0) PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS minimum time step %g\n", (double)cvode->mindt));
445:     if (cvode->maxdt > 0) PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS maximum time step %g\n", (double)cvode->maxdt));

447:     /* Outputs from CVODE, CVSPILS */
448:     PetscCallExternal(CVodeGetTolScaleFactor, cvode->mem, &tolsfac);
449:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS suggested factor for tolerance scaling %g\n", tolsfac));
450:     PetscCallExternal(CVodeGetIntegratorStats, cvode->mem, &nsteps, &nfevals, &nlinsetups, &nfails, &qlast, &qcur, &hinused, &hlast, &hcur, &tcur);
451:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS cumulative number of internal steps %ld\n", nsteps));
452:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of calls to rhs function %ld\n", nfevals));
453:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of calls to linear solver setup function %ld\n", nlinsetups));
454:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of error test failures %ld\n", nfails));

456:     PetscCallExternal(CVodeGetNonlinSolvStats, cvode->mem, &its, &nfails);
457:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of nonlinear solver iterations %ld\n", its));
458:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of nonlinear convergence failure %ld\n", nfails));
459:     if (!cvode->use_dense) {
460:       PetscCallExternal(CVSpilsGetNumLinIters, cvode->mem, &its); /* its = no. of calls to TSPrecond_Sundials() */
461:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of linear iterations %ld\n", its));
462:       PetscCallExternal(CVSpilsGetNumConvFails, cvode->mem, &itmp);
463:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of linear convergence failures %ld\n", itmp));

465:       PetscCall(TSSundialsGetPC(ts, &pc));
466:       PetscCall(PCView(pc, viewer));
467:       PetscCallExternal(CVSpilsGetNumPrecEvals, cvode->mem, &itmp);
468:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of preconditioner evaluations %ld\n", itmp));
469:       PetscCallExternal(CVSpilsGetNumPrecSolves, cvode->mem, &itmp);
470:       PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of preconditioner solves %ld\n", itmp));
471:     }
472:     PetscCallExternal(CVSpilsGetNumJtimesEvals, cvode->mem, &itmp);
473:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of Jacobian-vector product evaluations %ld\n", itmp));
474:     PetscCallExternal(CVSpilsGetNumRhsEvals, cvode->mem, &itmp);
475:     PetscCall(PetscViewerASCIIPrintf(viewer, "SUNDIALS no. of rhs calls for finite diff. Jacobian-vector evals %ld\n", itmp));
476:   } else if (isstring) {
477:     PetscCall(PetscViewerStringSPrintf(viewer, "SUNDIALS type %s", type));
478:   }
479:   PetscFunctionReturn(PETSC_SUCCESS);
480: }

482: static PetscErrorCode TSSundialsSetType_Sundials(TS ts, TSSundialsLmmType type)
483: {
484:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

486:   PetscFunctionBegin;
487:   cvode->cvode_type = type;
488:   PetscFunctionReturn(PETSC_SUCCESS);
489: }

491: static PetscErrorCode TSSundialsSetMaxl_Sundials(TS ts, PetscInt maxl)
492: {
493:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

495:   PetscFunctionBegin;
496:   cvode->maxl = maxl;
497:   PetscFunctionReturn(PETSC_SUCCESS);
498: }

500: static PetscErrorCode TSSundialsSetLinearTolerance_Sundials(TS ts, PetscReal tol)
501: {
502:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

504:   PetscFunctionBegin;
505:   cvode->linear_tol = tol;
506:   PetscFunctionReturn(PETSC_SUCCESS);
507: }

509: static PetscErrorCode TSSundialsSetGramSchmidtType_Sundials(TS ts, TSSundialsGramSchmidtType type)
510: {
511:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

513:   PetscFunctionBegin;
514:   cvode->gtype = type;
515:   PetscFunctionReturn(PETSC_SUCCESS);
516: }

518: static PetscErrorCode TSSundialsSetTolerance_Sundials(TS ts, PetscReal aabs, PetscReal rel)
519: {
520:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

522:   PetscFunctionBegin;
523:   if (aabs != PETSC_DECIDE) cvode->abstol = aabs;
524:   if (rel != PETSC_DECIDE) cvode->reltol = rel;
525:   PetscFunctionReturn(PETSC_SUCCESS);
526: }

528: static PetscErrorCode TSSundialsSetMinTimeStep_Sundials(TS ts, PetscReal mindt)
529: {
530:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

532:   PetscFunctionBegin;
533:   cvode->mindt = mindt;
534:   PetscFunctionReturn(PETSC_SUCCESS);
535: }

537: static PetscErrorCode TSSundialsSetMaxTimeStep_Sundials(TS ts, PetscReal maxdt)
538: {
539:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

541:   PetscFunctionBegin;
542:   cvode->maxdt = maxdt;
543:   PetscFunctionReturn(PETSC_SUCCESS);
544: }

546: static PetscErrorCode TSSundialsSetUseDense_Sundials(TS ts, PetscBool use_dense)
547: {
548:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

550:   PetscFunctionBegin;
551:   cvode->use_dense = use_dense;
552:   PetscFunctionReturn(PETSC_SUCCESS);
553: }

555: static PetscErrorCode TSSundialsGetPC_Sundials(TS ts, PC *pc)
556: {
557:   SNES snes;
558:   KSP  ksp;

560:   PetscFunctionBegin;
561:   PetscCall(TSGetSNES(ts, &snes));
562:   PetscCall(SNESGetKSP(snes, &ksp));
563:   PetscCall(KSPGetPC(ksp, pc));
564:   PetscFunctionReturn(PETSC_SUCCESS);
565: }

567: static PetscErrorCode TSSundialsGetIterations_Sundials(TS ts, int *nonlin, int *lin)
568: {
569:   PetscFunctionBegin;
570:   if (nonlin) *nonlin = ts->snes_its;
571:   if (lin) *lin = ts->ksp_its;
572:   PetscFunctionReturn(PETSC_SUCCESS);
573: }

575: static PetscErrorCode TSSundialsMonitorInternalSteps_Sundials(TS ts, PetscBool s)
576: {
577:   TS_Sundials *cvode = (TS_Sundials *)ts->data;

579:   PetscFunctionBegin;
580:   cvode->monitorstep = s;
581:   PetscFunctionReturn(PETSC_SUCCESS);
582: }

584: /*@
585:   TSSundialsGetIterations - Gets the number of nonlinear and linear iterations used so far by `TSSUNDIALS`.

587:   Not Collective

589:   Input Parameter:
590: . ts - the time-step context

592:   Output Parameters:
593: + nonlin - number of nonlinear iterations
594: - lin    - number of linear iterations

596:   Level: advanced

598:   Note:
599:   These return the number since the creation of the `TS` object

601: .seealso: [](ch_ts), `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
602:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
603:           `TSSundialsGetPC()`, `TSSetExactFinalTime()`
604: @*/
605: PetscErrorCode TSSundialsGetIterations(TS ts, int *nonlin, int *lin)
606: {
607:   PetscFunctionBegin;
608:   PetscUseMethod(ts, "TSSundialsGetIterations_C", (TS, int *, int *), (ts, nonlin, lin));
609:   PetscFunctionReturn(PETSC_SUCCESS);
610: }

612: /*@
613:   TSSundialsSetType - Sets the method that `TSSUNDIALS` will use for integration.

615:   Logically Collective

617:   Input Parameters:
618: + ts   - the time-step context
619: - type - one of  `SUNDIALS_ADAMS` or `SUNDIALS_BDF`

621:   Level: intermediate

623: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetMaxl()`,
624:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`,
625:           `TSSundialsSetTolerance()`, `TSSundialsGetPC()`, `TSSetExactFinalTime()`
626: @*/
627: PetscErrorCode TSSundialsSetType(TS ts, TSSundialsLmmType type)
628: {
629:   PetscFunctionBegin;
630:   PetscTryMethod(ts, "TSSundialsSetType_C", (TS, TSSundialsLmmType), (ts, type));
631:   PetscFunctionReturn(PETSC_SUCCESS);
632: }

634: /*@
635:   TSSundialsSetMaxord - Sets the maximum order for BDF/Adams method used by `TSSUNDIALS`.

637:   Logically Collective

639:   Input Parameters:
640: + ts     - the time-step context
641: - maxord - maximum order of BDF / Adams method

643:   Level: advanced

645: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`,
646:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`,
647:           `TSSundialsSetTolerance()`, `TSSundialsGetPC()`, `TSSetExactFinalTime()`
648: @*/
649: PetscErrorCode TSSundialsSetMaxord(TS ts, PetscInt maxord)
650: {
651:   PetscFunctionBegin;
653:   PetscTryMethod(ts, "TSSundialsSetMaxOrd_C", (TS, PetscInt), (ts, maxord));
654:   PetscFunctionReturn(PETSC_SUCCESS);
655: }

657: /*@
658:   TSSundialsSetMaxl - Sets the dimension of the Krylov space used by
659:   GMRES in the linear solver in `TSSUNDIALS`. `TSSUNDIALS` DOES NOT use restarted GMRES so
660:   this is the maximum number of GMRES steps that will be used.

662:   Logically Collective

664:   Input Parameters:
665: + ts   - the time-step context
666: - maxl - number of direction vectors (the dimension of Krylov subspace).

668:   Level: advanced

670: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`,
671:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
672:           `TSSundialsGetPC()`, `TSSetExactFinalTime()`
673: @*/
674: PetscErrorCode TSSundialsSetMaxl(TS ts, PetscInt maxl)
675: {
676:   PetscFunctionBegin;
678:   PetscTryMethod(ts, "TSSundialsSetMaxl_C", (TS, PetscInt), (ts, maxl));
679:   PetscFunctionReturn(PETSC_SUCCESS);
680: }

682: /*@
683:   TSSundialsSetLinearTolerance - Sets the tolerance used to solve the linear
684:   system by `TSSUNDIALS`.

686:   Logically Collective

688:   Input Parameters:
689: + ts  - the time-step context
690: - tol - the factor by which the tolerance on the nonlinear solver is
691:              multiplied to get the tolerance on the linear solver, .05 by default.

693:   Level: advanced

695: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
696:           `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
697:           `TSSundialsGetPC()`,
698:           `TSSetExactFinalTime()`
699: @*/
700: PetscErrorCode TSSundialsSetLinearTolerance(TS ts, PetscReal tol)
701: {
702:   PetscFunctionBegin;
704:   PetscTryMethod(ts, "TSSundialsSetLinearTolerance_C", (TS, PetscReal), (ts, tol));
705:   PetscFunctionReturn(PETSC_SUCCESS);
706: }

708: /*@
709:   TSSundialsSetGramSchmidtType - Sets type of orthogonalization used
710:   in GMRES method by `TSSUNDIALS` linear solver.

712:   Logically Collective

714:   Input Parameters:
715: + ts   - the time-step context
716: - type - either `SUNDIALS_MODIFIED_GS` or `SUNDIALS_CLASSICAL_GS`

718:   Level: advanced

720: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
721:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetTolerance()`,
722:           `TSSundialsGetPC()`,
723:           `TSSetExactFinalTime()`
724: @*/
725: PetscErrorCode TSSundialsSetGramSchmidtType(TS ts, TSSundialsGramSchmidtType type)
726: {
727:   PetscFunctionBegin;
728:   PetscTryMethod(ts, "TSSundialsSetGramSchmidtType_C", (TS, TSSundialsGramSchmidtType), (ts, type));
729:   PetscFunctionReturn(PETSC_SUCCESS);
730: }

732: /*@
733:   TSSundialsSetTolerance - Sets the absolute and relative tolerance used by
734:   `TSSUNDIALS` for error control.

736:   Logically Collective

738:   Input Parameters:
739: + ts   - the time-step context
740: . aabs - the absolute tolerance
741: - rel  - the relative tolerance

743:      See the CVODE/SUNDIALS users manual for exact details on these parameters. Essentially
744:     these regulate the size of the error for a SINGLE timestep.

746:   Level: intermediate

748: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetGMRESMaxl()`,
749:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`,
750:           `TSSundialsGetPC()`,
751:           `TSSetExactFinalTime()`
752: @*/
753: PetscErrorCode TSSundialsSetTolerance(TS ts, PetscReal aabs, PetscReal rel)
754: {
755:   PetscFunctionBegin;
756:   PetscTryMethod(ts, "TSSundialsSetTolerance_C", (TS, PetscReal, PetscReal), (ts, aabs, rel));
757:   PetscFunctionReturn(PETSC_SUCCESS);
758: }

760: /*@
761:   TSSundialsGetPC - Extract the PC context from a time-step context for `TSSUNDIALS`.

763:   Input Parameter:
764: . ts - the time-step context

766:   Output Parameter:
767: . pc - the preconditioner context

769:   Level: advanced

771: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
772:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`
773: @*/
774: PetscErrorCode TSSundialsGetPC(TS ts, PC *pc)
775: {
776:   PetscFunctionBegin;
777:   PetscUseMethod(ts, "TSSundialsGetPC_C", (TS, PC *), (ts, pc));
778:   PetscFunctionReturn(PETSC_SUCCESS);
779: }

781: /*@
782:   TSSundialsSetMinTimeStep - Smallest time step to be chosen by the adaptive controller.

784:   Input Parameters:
785: + ts    - the time-step context
786: - mindt - lowest time step if positive, negative to deactivate

788:   Note:
789:   `TSSUNDIALS` will error if it is not possible to keep the estimated truncation error below
790:   the tolerance set with `TSSundialsSetTolerance()` without going below this step size.

792:   Level: beginner

794: .seealso: [](ch_ts), `TSSundialsSetType()`, `TSSundialsSetTolerance()`,
795: @*/
796: PetscErrorCode TSSundialsSetMinTimeStep(TS ts, PetscReal mindt)
797: {
798:   PetscFunctionBegin;
799:   PetscTryMethod(ts, "TSSundialsSetMinTimeStep_C", (TS, PetscReal), (ts, mindt));
800:   PetscFunctionReturn(PETSC_SUCCESS);
801: }

803: /*@
804:   TSSundialsSetMaxTimeStep - Largest time step to be chosen by the adaptive controller.

806:   Input Parameters:
807: + ts    - the time-step context
808: - maxdt - lowest time step if positive, negative to deactivate

810:   Level: beginner

812: .seealso: [](ch_ts), `TSSundialsSetType()`, `TSSundialsSetTolerance()`,
813: @*/
814: PetscErrorCode TSSundialsSetMaxTimeStep(TS ts, PetscReal maxdt)
815: {
816:   PetscFunctionBegin;
817:   PetscTryMethod(ts, "TSSundialsSetMaxTimeStep_C", (TS, PetscReal), (ts, maxdt));
818:   PetscFunctionReturn(PETSC_SUCCESS);
819: }

821: /*@
822:   TSSundialsMonitorInternalSteps - Monitor `TSSUNDIALS` internal steps (Defaults to false).

824:   Input Parameters:
825: + ts - the time-step context
826: - ft - `PETSC_TRUE` if monitor, else `PETSC_FALSE`

828:   Level: beginner

830: .seealso: [](ch_ts), `TSSundialsGetIterations()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`,
831:           `TSSundialsSetLinearTolerance()`, `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`,
832:           `TSSundialsGetPC()`
833: @*/
834: PetscErrorCode TSSundialsMonitorInternalSteps(TS ts, PetscBool ft)
835: {
836:   PetscFunctionBegin;
837:   PetscTryMethod(ts, "TSSundialsMonitorInternalSteps_C", (TS, PetscBool), (ts, ft));
838:   PetscFunctionReturn(PETSC_SUCCESS);
839: }

841: /*@
842:   TSSundialsSetUseDense - Set a flag to use a dense linear solver in `TSSUNDIALS` (serial only)

844:   Logically Collective

846:   Input Parameters:
847: + ts        - the time-step context
848: - use_dense - `PETSC_TRUE` to use the dense solver

850:   Level: advanced

852: .seealso: [](ch_ts), `TSSUNDIALS`
853: @*/
854: PetscErrorCode TSSundialsSetUseDense(TS ts, PetscBool use_dense)
855: {
856:   PetscFunctionBegin;
858:   PetscTryMethod(ts, "TSSundialsSetUseDense_C", (TS, PetscBool), (ts, use_dense));
859:   PetscFunctionReturn(PETSC_SUCCESS);
860: }

862: /*MC
863:       TSSUNDIALS - ODE solver using a very old version of the LLNL CVODE/SUNDIALS package, version 2.5 (now called SUNDIALS). Requires ./configure --download-sundials

865:    Options Database Keys:
866: +    -ts_sundials_type <bdf,adams> -
867: .    -ts_sundials_gramschmidt_type <modified, classical> - type of orthogonalization inside GMRES
868: .    -ts_sundials_atol <tol> - Absolute tolerance for convergence
869: .    -ts_sundials_rtol <tol> - Relative tolerance for convergence
870: .    -ts_sundials_linear_tolerance <tol> -
871: .    -ts_sundials_maxl <maxl> - Max dimension of the Krylov subspace
872: .    -ts_sundials_monitor_steps - Monitor SUNDIALS internal steps
873: -    -ts_sundials_use_dense - Use a dense linear solver within CVODE (serial only)

875:     Level: beginner

877:     Note:
878:     This uses its own nonlinear solver and Krylov method so PETSc `SNES` and `KSP` options do not apply,
879:     only PETSc `PC` options.

881: .seealso: [](ch_ts), `TSCreate()`, `TS`, `TSSetType()`, `TSSundialsSetType()`, `TSSundialsSetMaxl()`, `TSSundialsSetLinearTolerance()`, `TSType`,
882:           `TSSundialsSetGramSchmidtType()`, `TSSundialsSetTolerance()`, `TSSundialsGetPC()`, `TSSundialsGetIterations()`, `TSSetExactFinalTime()`
883: M*/
884: PETSC_EXTERN PetscErrorCode TSCreate_Sundials(TS ts)
885: {
886:   TS_Sundials *cvode;
887:   PC           pc;

889:   PetscFunctionBegin;
890:   ts->ops->reset          = TSReset_Sundials;
891:   ts->ops->destroy        = TSDestroy_Sundials;
892:   ts->ops->view           = TSView_Sundials;
893:   ts->ops->setup          = TSSetUp_Sundials;
894:   ts->ops->step           = TSStep_Sundials;
895:   ts->ops->interpolate    = TSInterpolate_Sundials;
896:   ts->ops->setfromoptions = TSSetFromOptions_Sundials;
897:   ts->default_adapt_type  = TSADAPTNONE;

899:   PetscCall(PetscNew(&cvode));

901:   ts->usessnes = PETSC_TRUE;

903:   ts->data           = (void *)cvode;
904:   cvode->cvode_type  = SUNDIALS_BDF;
905:   cvode->gtype       = SUNDIALS_CLASSICAL_GS;
906:   cvode->maxl        = 5;
907:   cvode->maxord      = PETSC_DEFAULT;
908:   cvode->linear_tol  = .05;
909:   cvode->monitorstep = PETSC_TRUE;
910:   cvode->use_dense   = PETSC_FALSE;

912:   PetscCallMPI(MPI_Comm_dup(PetscObjectComm((PetscObject)ts), &cvode->comm_sundials));

914:   cvode->mindt = -1.;
915:   cvode->maxdt = -1.;

917:   /* set tolerance for SUNDIALS */
918:   cvode->reltol = 1e-6;
919:   cvode->abstol = 1e-6;

921:   /* set PCNONE as default pctype */
922:   PetscCall(TSSundialsGetPC_Sundials(ts, &pc));
923:   PetscCall(PCSetType(pc, PCNONE));

925:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetType_C", TSSundialsSetType_Sundials));
926:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMaxl_C", TSSundialsSetMaxl_Sundials));
927:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetLinearTolerance_C", TSSundialsSetLinearTolerance_Sundials));
928:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetGramSchmidtType_C", TSSundialsSetGramSchmidtType_Sundials));
929:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetTolerance_C", TSSundialsSetTolerance_Sundials));
930:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMinTimeStep_C", TSSundialsSetMinTimeStep_Sundials));
931:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetMaxTimeStep_C", TSSundialsSetMaxTimeStep_Sundials));
932:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsGetPC_C", TSSundialsGetPC_Sundials));
933:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsGetIterations_C", TSSundialsGetIterations_Sundials));
934:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsMonitorInternalSteps_C", TSSundialsMonitorInternalSteps_Sundials));
935:   PetscCall(PetscObjectComposeFunction((PetscObject)ts, "TSSundialsSetUseDense_C", TSSundialsSetUseDense_Sundials));
936:   PetscFunctionReturn(PETSC_SUCCESS);
937: }