17cb94ee6SHong Zhang /* 2db268bfaSHong Zhang Provides a PETSc interface to SUNDIALS/CVODE solver. 37cb94ee6SHong Zhang The interface to PVODE (old version of CVODE) was originally contributed 47cb94ee6SHong Zhang by Liyang Xu. It has been redone by Hong Zhang and Dinesh Kaushik. 528adb3f7SHong Zhang 628adb3f7SHong Zhang Reference: sundials-2.4.0/examples/cvode/parallel/cvDiurnal_kry_p.c 77cb94ee6SHong Zhang */ 856a740aaSHong Zhang #include "sundials.h" /*I "petscts.h" I*/ 97cb94ee6SHong Zhang 107cb94ee6SHong Zhang /* 117cb94ee6SHong Zhang TSPrecond_Sundials - function that we provide to SUNDIALS to 127cb94ee6SHong Zhang evaluate the preconditioner. 137cb94ee6SHong Zhang */ 147cb94ee6SHong Zhang #undef __FUNCT__ 157cb94ee6SHong Zhang #define __FUNCT__ "TSPrecond_Sundials" 167cb94ee6SHong Zhang PetscErrorCode TSPrecond_Sundials(realtype tn,N_Vector y,N_Vector fy, 177cb94ee6SHong Zhang booleantype jok,booleantype *jcurPtr, 187cb94ee6SHong Zhang realtype _gamma,void *P_data, 197cb94ee6SHong Zhang N_Vector vtemp1,N_Vector vtemp2,N_Vector vtemp3) 207cb94ee6SHong Zhang { 217cb94ee6SHong Zhang TS ts = (TS) P_data; 227cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 23dcbc6d53SSean Farley PC pc; 247cb94ee6SHong Zhang PetscErrorCode ierr; 250679a0aeSJed Brown Mat J,P; 260679a0aeSJed Brown Vec yy = cvode->w1,yydot = cvode->ydot; 270679a0aeSJed Brown PetscReal gm = (PetscReal)_gamma; 287cb94ee6SHong Zhang MatStructure str = DIFFERENT_NONZERO_PATTERN; 297cb94ee6SHong Zhang PetscScalar *y_data; 307cb94ee6SHong Zhang 317cb94ee6SHong Zhang PetscFunctionBegin; 320679a0aeSJed Brown ierr = TSGetIJacobian(ts,&J,&P,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr); 337cb94ee6SHong Zhang y_data = (PetscScalar *) N_VGetArrayPointer(y); 347cb94ee6SHong Zhang ierr = VecPlaceArray(yy,y_data); CHKERRQ(ierr); 350679a0aeSJed Brown ierr = VecZeroEntries(yydot);CHKERRQ(ierr); /* The Jacobian is independent of Ydot for ODE which is all that CVode works for */ 360679a0aeSJed Brown /* compute the shifted Jacobian (1/gm)*I + Jrest */ 370679a0aeSJed Brown ierr = TSComputeIJacobian(ts,ts->ptime,yy,yydot,1/gm,&J,&P,&str,PETSC_FALSE);CHKERRQ(ierr); 387cb94ee6SHong Zhang ierr = VecResetArray(yy); CHKERRQ(ierr); 390679a0aeSJed Brown ierr = MatScale(P,gm);CHKERRQ(ierr); /* turn into I-gm*Jrest, J is not used by Sundials */ 407cb94ee6SHong Zhang *jcurPtr = TRUE; 41dcbc6d53SSean Farley ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr); 420679a0aeSJed Brown ierr = PCSetOperators(pc,J,P,str);CHKERRQ(ierr); 437cb94ee6SHong Zhang PetscFunctionReturn(0); 447cb94ee6SHong Zhang } 457cb94ee6SHong Zhang 467cb94ee6SHong Zhang /* 477cb94ee6SHong Zhang TSPSolve_Sundials - routine that we provide to Sundials that applies the preconditioner. 487cb94ee6SHong Zhang */ 497cb94ee6SHong Zhang #undef __FUNCT__ 507cb94ee6SHong Zhang #define __FUNCT__ "TSPSolve_Sundials" 514ac7836bSHong Zhang PetscErrorCode TSPSolve_Sundials(realtype tn,N_Vector y,N_Vector fy,N_Vector r,N_Vector z, 524ac7836bSHong Zhang realtype _gamma,realtype delta,int lr,void *P_data,N_Vector vtemp) 537cb94ee6SHong Zhang { 547cb94ee6SHong Zhang TS ts = (TS) P_data; 557cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 56dcbc6d53SSean Farley PC pc; 577cb94ee6SHong Zhang Vec rr = cvode->w1,zz = cvode->w2; 587cb94ee6SHong Zhang PetscErrorCode ierr; 597cb94ee6SHong Zhang PetscScalar *r_data,*z_data; 607cb94ee6SHong Zhang 617cb94ee6SHong Zhang PetscFunctionBegin; 627cb94ee6SHong Zhang /* Make the PETSc work vectors rr and zz point to the arrays in the SUNDIALS vectors r and z respectively*/ 637cb94ee6SHong Zhang r_data = (PetscScalar *) N_VGetArrayPointer(r); 647cb94ee6SHong Zhang z_data = (PetscScalar *) N_VGetArrayPointer(z); 657cb94ee6SHong Zhang ierr = VecPlaceArray(rr,r_data); CHKERRQ(ierr); 667cb94ee6SHong Zhang ierr = VecPlaceArray(zz,z_data); CHKERRQ(ierr); 674ac7836bSHong Zhang 687cb94ee6SHong Zhang /* Solve the Px=r and put the result in zz */ 69dcbc6d53SSean Farley ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr); 707cb94ee6SHong Zhang ierr = PCApply(pc,rr,zz); CHKERRQ(ierr); 717cb94ee6SHong Zhang ierr = VecResetArray(rr); CHKERRQ(ierr); 727cb94ee6SHong Zhang ierr = VecResetArray(zz); CHKERRQ(ierr); 737cb94ee6SHong Zhang PetscFunctionReturn(0); 747cb94ee6SHong Zhang } 757cb94ee6SHong Zhang 767cb94ee6SHong Zhang /* 777cb94ee6SHong Zhang TSFunction_Sundials - routine that we provide to Sundials that applies the right hand side. 787cb94ee6SHong Zhang */ 797cb94ee6SHong Zhang #undef __FUNCT__ 807cb94ee6SHong Zhang #define __FUNCT__ "TSFunction_Sundials" 814ac7836bSHong Zhang int TSFunction_Sundials(realtype t,N_Vector y,N_Vector ydot,void *ctx) 827cb94ee6SHong Zhang { 837cb94ee6SHong Zhang TS ts = (TS) ctx; 847adad957SLisandro Dalcin MPI_Comm comm = ((PetscObject)ts)->comm; 857cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 860679a0aeSJed Brown Vec yy = cvode->w1,yyd = cvode->w2,yydot = cvode->ydot; 877cb94ee6SHong Zhang PetscScalar *y_data,*ydot_data; 887cb94ee6SHong Zhang PetscErrorCode ierr; 897cb94ee6SHong Zhang 907cb94ee6SHong Zhang PetscFunctionBegin; 915ff03cf7SDinesh Kaushik /* Make the PETSc work vectors yy and yyd point to the arrays in the SUNDIALS vectors y and ydot respectively*/ 927cb94ee6SHong Zhang y_data = (PetscScalar *) N_VGetArrayPointer(y); 937cb94ee6SHong Zhang ydot_data = (PetscScalar *) N_VGetArrayPointer(ydot); 944ac7836bSHong Zhang ierr = VecPlaceArray(yy,y_data);CHKERRABORT(comm,ierr); 954ac7836bSHong Zhang ierr = VecPlaceArray(yyd,ydot_data); CHKERRABORT(comm,ierr); 960679a0aeSJed Brown ierr = VecZeroEntries(yydot);CHKERRQ(ierr); 974ac7836bSHong Zhang 987cb94ee6SHong Zhang /* now compute the right hand side function */ 990679a0aeSJed Brown ierr = TSComputeIFunction(ts,t,yy,yydot,yyd,PETSC_FALSE); CHKERRABORT(comm,ierr); 1000679a0aeSJed Brown ierr = VecScale(yyd,-1.);CHKERRQ(ierr); 1017cb94ee6SHong Zhang ierr = VecResetArray(yy); CHKERRABORT(comm,ierr); 1027cb94ee6SHong Zhang ierr = VecResetArray(yyd); CHKERRABORT(comm,ierr); 1034ac7836bSHong Zhang PetscFunctionReturn(0); 1047cb94ee6SHong Zhang } 1057cb94ee6SHong Zhang 1067cb94ee6SHong Zhang /* 107117ce3f2SJed Brown TSSolve_Sundials - Calls Sundials to integrate the ODE. 1087cb94ee6SHong Zhang */ 1097cb94ee6SHong Zhang #undef __FUNCT__ 110117ce3f2SJed Brown #define __FUNCT__ "TSSolve_Sundials" 111117ce3f2SJed Brown PetscErrorCode TSSolve_Sundials(TS ts) 1127cb94ee6SHong Zhang { 1137cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 1147cb94ee6SHong Zhang Vec sol = ts->vec_sol; 1157cb94ee6SHong Zhang PetscErrorCode ierr; 116186e87acSLisandro Dalcin PetscInt i,flag; 1179f94935aSHong Zhang long int its,nsteps; 1187cb94ee6SHong Zhang realtype t,tout; 1197cb94ee6SHong Zhang PetscScalar *y_data; 1207cb94ee6SHong Zhang void *mem; 121*abe29043SSean Farley SNES snes; 122*abe29043SSean Farley Vec res; /* This, together with snes, will check if the SNES vec_func has been set */ 1237cb94ee6SHong Zhang 1247cb94ee6SHong Zhang PetscFunctionBegin; 12516016685SHong Zhang mem = cvode->mem; 1267cb94ee6SHong Zhang tout = ts->max_time; 1277cb94ee6SHong Zhang ierr = VecGetArray(ts->vec_sol,&y_data);CHKERRQ(ierr); 1287cb94ee6SHong Zhang N_VSetArrayPointer((realtype *)y_data,cvode->y); 1297cb94ee6SHong Zhang ierr = VecRestoreArray(ts->vec_sol,PETSC_NULL);CHKERRQ(ierr); 130186e87acSLisandro Dalcin 131*abe29043SSean Farley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 132*abe29043SSean Farley ierr = SNESGetFunction(snes, &res, PETSC_NULL, PETSC_NULL);CHKERRQ(ierr); 133*abe29043SSean Farley if (!res) { 134*abe29043SSean Farley ierr = TSSetIFunction(ts, sol, PETSC_NULL, PETSC_NULL);CHKERRQ(ierr); 135*abe29043SSean Farley } 136*abe29043SSean Farley 137186e87acSLisandro Dalcin for (i = 0; i < ts->max_steps; i++) { 1387cb94ee6SHong Zhang if (ts->ptime >= ts->max_time) break; 1393f2090d5SJed Brown ierr = TSPreStep(ts);CHKERRQ(ierr); 140186e87acSLisandro Dalcin 1412bfc04deSHong Zhang if (cvode->monitorstep) { 14228adb3f7SHong Zhang flag = CVode(mem,tout,cvode->y,&t,CV_ONE_STEP); 1432bfc04deSHong Zhang } else { 1442bfc04deSHong Zhang flag = CVode(mem,tout,cvode->y,&t,CV_NORMAL); 1452bfc04deSHong Zhang } 1469f94935aSHong Zhang 1479f94935aSHong Zhang if (flag){ /* display error message */ 1489f94935aSHong Zhang switch (flag){ 1499f94935aSHong Zhang case CV_ILL_INPUT: 1509f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ILL_INPUT"); 1519f94935aSHong Zhang break; 1529f94935aSHong Zhang case CV_TOO_CLOSE: 1539f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_CLOSE"); 1549f94935aSHong Zhang break; 1553c7fefeeSJed Brown case CV_TOO_MUCH_WORK: { 1569f94935aSHong Zhang PetscReal tcur; 1579f94935aSHong Zhang ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr); 1589f94935aSHong Zhang ierr = CVodeGetCurrentTime(mem,&tcur);CHKERRQ(ierr); 1599f94935aSHong Zhang SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_WORK. At t=%G, nsteps %D exceeds mxstep %D. Increase '-ts_max_steps <>' or modify TSSetDuration()",tcur,nsteps,ts->max_steps); 1603c7fefeeSJed Brown } break; 1619f94935aSHong Zhang case CV_TOO_MUCH_ACC: 1629f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_TOO_MUCH_ACC"); 1639f94935aSHong Zhang break; 1649f94935aSHong Zhang case CV_ERR_FAILURE: 1659f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_ERR_FAILURE"); 1669f94935aSHong Zhang break; 1679f94935aSHong Zhang case CV_CONV_FAILURE: 1689f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_CONV_FAILURE"); 1699f94935aSHong Zhang break; 1709f94935aSHong Zhang case CV_LINIT_FAIL: 1719f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LINIT_FAIL"); 1729f94935aSHong Zhang break; 1739f94935aSHong Zhang case CV_LSETUP_FAIL: 1749f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSETUP_FAIL"); 1759f94935aSHong Zhang break; 1769f94935aSHong Zhang case CV_LSOLVE_FAIL: 1779f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_LSOLVE_FAIL"); 1789f94935aSHong Zhang break; 1799f94935aSHong Zhang case CV_RHSFUNC_FAIL: 1809f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RHSFUNC_FAIL"); 1819f94935aSHong Zhang break; 1829f94935aSHong Zhang case CV_FIRST_RHSFUNC_ERR: 1839f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_FIRST_RHSFUNC_ERR"); 1849f94935aSHong Zhang break; 1859f94935aSHong Zhang case CV_REPTD_RHSFUNC_ERR: 1869f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_REPTD_RHSFUNC_ERR"); 1879f94935aSHong Zhang break; 1889f94935aSHong Zhang case CV_UNREC_RHSFUNC_ERR: 1899f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_UNREC_RHSFUNC_ERR"); 1909f94935aSHong Zhang break; 1919f94935aSHong Zhang case CV_RTFUNC_FAIL: 1929f94935aSHong Zhang SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, CV_RTFUNC_FAIL"); 1939f94935aSHong Zhang break; 1949f94935aSHong Zhang default: 1959f94935aSHong Zhang SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVode() fails, flag %d",flag); 1969f94935aSHong Zhang } 1979f94935aSHong Zhang } 1989f94935aSHong Zhang 1997cb94ee6SHong Zhang if (t > ts->max_time && cvode->exact_final_time) { 2007cb94ee6SHong Zhang /* interpolate to final requested time */ 2017cb94ee6SHong Zhang ierr = CVodeGetDky(mem,tout,0,cvode->y);CHKERRQ(ierr); 2027cb94ee6SHong Zhang t = tout; 2037cb94ee6SHong Zhang } 2047cb94ee6SHong Zhang 2057cb94ee6SHong Zhang /* copy the solution from cvode->y to cvode->update and sol */ 2067cb94ee6SHong Zhang ierr = VecPlaceArray(cvode->w1,y_data); CHKERRQ(ierr); 2077cb94ee6SHong Zhang ierr = VecCopy(cvode->w1,cvode->update);CHKERRQ(ierr); 2087cb94ee6SHong Zhang ierr = VecResetArray(cvode->w1); CHKERRQ(ierr); 2097cb94ee6SHong Zhang ierr = VecCopy(cvode->update,sol);CHKERRQ(ierr); 2107cb94ee6SHong Zhang ierr = CVodeGetNumNonlinSolvIters(mem,&its);CHKERRQ(ierr); 2114ac7836bSHong Zhang ierr = CVSpilsGetNumLinIters(mem, &its); 212186e87acSLisandro Dalcin ts->nonlinear_its = its; ts->linear_its = its; 213186e87acSLisandro Dalcin 214186e87acSLisandro Dalcin ts->time_step = t - ts->ptime; 215186e87acSLisandro Dalcin ts->ptime = t; 2167cb94ee6SHong Zhang ts->steps++; 217186e87acSLisandro Dalcin 2183f2090d5SJed Brown ierr = TSPostStep(ts);CHKERRQ(ierr); 2197cb94ee6SHong Zhang ierr = TSMonitor(ts,ts->steps,t,sol);CHKERRQ(ierr); 2207cb94ee6SHong Zhang } 2219f94935aSHong Zhang ierr = CVodeGetNumSteps(mem,&nsteps);CHKERRQ(ierr); 222c75d03b0SJed Brown ts->steps = nsteps; 2237cb94ee6SHong Zhang PetscFunctionReturn(0); 2247cb94ee6SHong Zhang } 2257cb94ee6SHong Zhang 2267cb94ee6SHong Zhang #undef __FUNCT__ 227277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset_Sundials" 228277b19d0SLisandro Dalcin PetscErrorCode TSReset_Sundials(TS ts) 229277b19d0SLisandro Dalcin { 230277b19d0SLisandro Dalcin TS_Sundials *cvode = (TS_Sundials*)ts->data; 231277b19d0SLisandro Dalcin PetscErrorCode ierr; 232277b19d0SLisandro Dalcin 233277b19d0SLisandro Dalcin PetscFunctionBegin; 2345c6b4a3dSJed Brown ierr = VecDestroy(&cvode->update);CHKERRQ(ierr); 2350679a0aeSJed Brown ierr = VecDestroy(&cvode->ydot);CHKERRQ(ierr); 2365c6b4a3dSJed Brown ierr = VecDestroy(&cvode->w1);CHKERRQ(ierr); 2375c6b4a3dSJed Brown ierr = VecDestroy(&cvode->w2);CHKERRQ(ierr); 238277b19d0SLisandro Dalcin if (cvode->mem) {CVodeFree(&cvode->mem);} 239277b19d0SLisandro Dalcin PetscFunctionReturn(0); 240277b19d0SLisandro Dalcin } 241277b19d0SLisandro Dalcin 242277b19d0SLisandro Dalcin #undef __FUNCT__ 2437cb94ee6SHong Zhang #define __FUNCT__ "TSDestroy_Sundials" 2447cb94ee6SHong Zhang PetscErrorCode TSDestroy_Sundials(TS ts) 2457cb94ee6SHong Zhang { 2467cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 2477cb94ee6SHong Zhang PetscErrorCode ierr; 2487cb94ee6SHong Zhang 2497cb94ee6SHong Zhang PetscFunctionBegin; 250277b19d0SLisandro Dalcin ierr = TSReset_Sundials(ts);CHKERRQ(ierr); 251a07356b8SSatish Balay ierr = MPI_Comm_free(&(cvode->comm_sundials));CHKERRQ(ierr); 252277b19d0SLisandro Dalcin ierr = PetscFree(ts->data);CHKERRQ(ierr); 253335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetType_C","",PETSC_NULL);CHKERRQ(ierr); 254335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGMRESRestart_C","",PETSC_NULL);CHKERRQ(ierr); 255335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetLinearTolerance_C","",PETSC_NULL);CHKERRQ(ierr); 256335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGramSchmidtType_C","",PETSC_NULL);CHKERRQ(ierr); 257335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetTolerance_C","",PETSC_NULL);CHKERRQ(ierr); 258335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMinTimeStep_C","",PETSC_NULL);CHKERRQ(ierr); 259335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxTimeStep_C","",PETSC_NULL);CHKERRQ(ierr); 260335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetPC_C","",PETSC_NULL);CHKERRQ(ierr); 261335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetIterations_C","",PETSC_NULL);CHKERRQ(ierr); 262335f802eSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsMonitorInternalSteps_C","",PETSC_NULL);CHKERRQ(ierr); 2637cb94ee6SHong Zhang PetscFunctionReturn(0); 2647cb94ee6SHong Zhang } 2657cb94ee6SHong Zhang 2667cb94ee6SHong Zhang #undef __FUNCT__ 267214bc6a2SJed Brown #define __FUNCT__ "TSSetUp_Sundials" 268214bc6a2SJed Brown PetscErrorCode TSSetUp_Sundials(TS ts) 2697cb94ee6SHong Zhang { 2707cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 2717cb94ee6SHong Zhang PetscErrorCode ierr; 27216016685SHong Zhang PetscInt glosize,locsize,i,flag; 2737cb94ee6SHong Zhang PetscScalar *y_data,*parray; 27416016685SHong Zhang void *mem; 275dcbc6d53SSean Farley PC pc; 27616016685SHong Zhang const PCType pctype; 277ace3abfcSBarry Smith PetscBool pcnone; 2787cb94ee6SHong Zhang 2797cb94ee6SHong Zhang PetscFunctionBegin; 2809f94935aSHong Zhang 2817cb94ee6SHong Zhang /* get the vector size */ 2827cb94ee6SHong Zhang ierr = VecGetSize(ts->vec_sol,&glosize);CHKERRQ(ierr); 2837cb94ee6SHong Zhang ierr = VecGetLocalSize(ts->vec_sol,&locsize);CHKERRQ(ierr); 2847cb94ee6SHong Zhang 2857cb94ee6SHong Zhang /* allocate the memory for N_Vec y */ 286a07356b8SSatish Balay cvode->y = N_VNew_Parallel(cvode->comm_sundials,locsize,glosize); 287e32f2f54SBarry Smith if (!cvode->y) SETERRQ(PETSC_COMM_SELF,1,"cvode->y is not allocated"); 2887cb94ee6SHong Zhang 28928adb3f7SHong Zhang /* initialize N_Vec y: copy ts->vec_sol to cvode->y */ 2907cb94ee6SHong Zhang ierr = VecGetArray(ts->vec_sol,&parray);CHKERRQ(ierr); 2917cb94ee6SHong Zhang y_data = (PetscScalar *) N_VGetArrayPointer(cvode->y); 2927cb94ee6SHong Zhang for (i = 0; i < locsize; i++) y_data[i] = parray[i]; 2937cb94ee6SHong Zhang ierr = VecRestoreArray(ts->vec_sol,PETSC_NULL);CHKERRQ(ierr); 29442528757SHong Zhang 2957cb94ee6SHong Zhang ierr = VecDuplicate(ts->vec_sol,&cvode->update);CHKERRQ(ierr); 2960679a0aeSJed Brown ierr = VecDuplicate(ts->vec_sol,&cvode->ydot);CHKERRQ(ierr); 2977cb94ee6SHong Zhang ierr = PetscLogObjectParent(ts,cvode->update);CHKERRQ(ierr); 2980679a0aeSJed Brown ierr = PetscLogObjectParent(ts,cvode->ydot);CHKERRQ(ierr); 2997cb94ee6SHong Zhang 3007cb94ee6SHong Zhang /* 3017cb94ee6SHong Zhang Create work vectors for the TSPSolve_Sundials() routine. Note these are 3027cb94ee6SHong Zhang allocated with zero space arrays because the actual array space is provided 3037cb94ee6SHong Zhang by Sundials and set using VecPlaceArray(). 3047cb94ee6SHong Zhang */ 3057adad957SLisandro Dalcin ierr = VecCreateMPIWithArray(((PetscObject)ts)->comm,locsize,PETSC_DECIDE,0,&cvode->w1);CHKERRQ(ierr); 3067adad957SLisandro Dalcin ierr = VecCreateMPIWithArray(((PetscObject)ts)->comm,locsize,PETSC_DECIDE,0,&cvode->w2);CHKERRQ(ierr); 3077cb94ee6SHong Zhang ierr = PetscLogObjectParent(ts,cvode->w1);CHKERRQ(ierr); 3087cb94ee6SHong Zhang ierr = PetscLogObjectParent(ts,cvode->w2);CHKERRQ(ierr); 30916016685SHong Zhang 31016016685SHong Zhang /* Call CVodeCreate to create the solver memory and the use of a Newton iteration */ 31116016685SHong Zhang mem = CVodeCreate(cvode->cvode_type, CV_NEWTON); 312e32f2f54SBarry Smith if (!mem) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"CVodeCreate() fails"); 31316016685SHong Zhang cvode->mem = mem; 31416016685SHong Zhang 31516016685SHong Zhang /* Set the pointer to user-defined data */ 31616016685SHong Zhang flag = CVodeSetUserData(mem, ts); 317e32f2f54SBarry Smith if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSetUserData() fails"); 31816016685SHong Zhang 319fc6b9e64SJed Brown /* Sundials may choose to use a smaller initial step, but will never use a larger step. */ 320fc6b9e64SJed Brown flag = CVodeSetInitStep(mem,(realtype)ts->initial_time_step); 321fc6b9e64SJed Brown if (flag) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetInitStep() failed"); 322f1cd61daSJed Brown if (cvode->mindt > 0) { 323f1cd61daSJed Brown flag = CVodeSetMinStep(mem,(realtype)cvode->mindt); 3249f94935aSHong Zhang if (flag){ 3259f94935aSHong Zhang if (flag == CV_MEM_NULL){ 3269f94935aSHong Zhang SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed, cvode_mem pointer is NULL"); 3279f94935aSHong Zhang } else if (flag == CV_ILL_INPUT){ 3289f94935aSHong Zhang SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed, hmin is nonpositive or it exceeds the maximum allowable step size"); 3299f94935aSHong Zhang } else { 3309f94935aSHong Zhang SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMinStep() failed"); 3319f94935aSHong Zhang } 3329f94935aSHong Zhang } 333f1cd61daSJed Brown } 334f1cd61daSJed Brown if (cvode->maxdt > 0) { 335f1cd61daSJed Brown flag = CVodeSetMaxStep(mem,(realtype)cvode->maxdt); 336f1cd61daSJed Brown if (flag) SETERRQ(((PetscObject)ts)->comm,PETSC_ERR_LIB,"CVodeSetMaxStep() failed"); 337f1cd61daSJed Brown } 338f1cd61daSJed Brown 33916016685SHong Zhang /* Call CVodeInit to initialize the integrator memory and specify the 34016016685SHong Zhang * user's right hand side function in u'=f(t,u), the inital time T0, and 34116016685SHong Zhang * the initial dependent variable vector cvode->y */ 34216016685SHong Zhang flag = CVodeInit(mem,TSFunction_Sundials,ts->ptime,cvode->y); 34316016685SHong Zhang if (flag){ 344e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeInit() fails, flag %d",flag); 34516016685SHong Zhang } 34616016685SHong Zhang 3479f94935aSHong Zhang /* specifies scalar relative and absolute tolerances */ 34816016685SHong Zhang flag = CVodeSStolerances(mem,cvode->reltol,cvode->abstol); 34916016685SHong Zhang if (flag){ 350e32f2f54SBarry Smith SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVodeSStolerances() fails, flag %d",flag); 35116016685SHong Zhang } 35216016685SHong Zhang 3539f94935aSHong Zhang /* Specify max num of steps to be taken by cvode in its attempt to reach the next output time */ 3549f94935aSHong Zhang flag = CVodeSetMaxNumSteps(mem,ts->max_steps); 35516016685SHong Zhang 35616016685SHong Zhang /* call CVSpgmr to use GMRES as the linear solver. */ 35716016685SHong Zhang /* setup the ode integrator with the given preconditioner */ 358dcbc6d53SSean Farley ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr); 359dcbc6d53SSean Farley ierr = PCGetType(pc,&pctype);CHKERRQ(ierr); 360dcbc6d53SSean Farley ierr = PetscTypeCompare((PetscObject)pc,PCNONE,&pcnone);CHKERRQ(ierr); 36116016685SHong Zhang if (pcnone){ 36216016685SHong Zhang flag = CVSpgmr(mem,PREC_NONE,0); 363e32f2f54SBarry Smith if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag); 36416016685SHong Zhang } else { 36516016685SHong Zhang flag = CVSpgmr(mem,PREC_LEFT,0); 366e32f2f54SBarry Smith if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmr() fails, flag %d",flag); 36716016685SHong Zhang 36816016685SHong Zhang /* Set preconditioner and solve routines Precond and PSolve, 36916016685SHong Zhang and the pointer to the user-defined block data */ 37016016685SHong Zhang flag = CVSpilsSetPreconditioner(mem,TSPrecond_Sundials,TSPSolve_Sundials); 371e32f2f54SBarry Smith if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpilsSetPreconditioner() fails, flag %d", flag); 37216016685SHong Zhang } 37316016685SHong Zhang 37416016685SHong Zhang flag = CVSpilsSetGSType(mem, MODIFIED_GS); 375e32f2f54SBarry Smith if (flag) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CVSpgmrSetGSType() fails, flag %d",flag); 3767cb94ee6SHong Zhang PetscFunctionReturn(0); 3777cb94ee6SHong Zhang } 3787cb94ee6SHong Zhang 3796fadb2cdSHong Zhang /* type of CVODE linear multistep method */ 380dfcd32c8SHong Zhang const char *TSSundialsLmmTypes[] = {"","adams","bdf","TSSundialsLmmType","SUNDIALS_",0}; 3816fadb2cdSHong Zhang /* type of G-S orthogonalization used by CVODE linear solver */ 382dfcd32c8SHong Zhang const char *TSSundialsGramSchmidtTypes[] = {"","modified","classical","TSSundialsGramSchmidtType","SUNDIALS_",0}; 383a04cf4d8SBarry Smith 3847cb94ee6SHong Zhang #undef __FUNCT__ 385214bc6a2SJed Brown #define __FUNCT__ "TSSetFromOptions_Sundials" 386214bc6a2SJed Brown PetscErrorCode TSSetFromOptions_Sundials(TS ts) 3877cb94ee6SHong Zhang { 3887cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 3897cb94ee6SHong Zhang PetscErrorCode ierr; 3907cb94ee6SHong Zhang int indx; 391ace3abfcSBarry Smith PetscBool flag; 3927cb94ee6SHong Zhang 3937cb94ee6SHong Zhang PetscFunctionBegin; 3947cb94ee6SHong Zhang ierr = PetscOptionsHead("SUNDIALS ODE solver options");CHKERRQ(ierr); 3956fadb2cdSHong Zhang ierr = PetscOptionsEList("-ts_sundials_type","Scheme","TSSundialsSetType",TSSundialsLmmTypes,3,TSSundialsLmmTypes[cvode->cvode_type],&indx,&flag);CHKERRQ(ierr); 3967cb94ee6SHong Zhang if (flag) { 3976fadb2cdSHong Zhang ierr = TSSundialsSetType(ts,(TSSundialsLmmType)indx);CHKERRQ(ierr); 3987cb94ee6SHong Zhang } 3996fadb2cdSHong Zhang ierr = PetscOptionsEList("-ts_sundials_gramschmidt_type","Type of orthogonalization","TSSundialsSetGramSchmidtType",TSSundialsGramSchmidtTypes,3,TSSundialsGramSchmidtTypes[cvode->gtype],&indx,&flag);CHKERRQ(ierr); 4007cb94ee6SHong Zhang if (flag) { 4017cb94ee6SHong Zhang ierr = TSSundialsSetGramSchmidtType(ts,(TSSundialsGramSchmidtType)indx);CHKERRQ(ierr); 4027cb94ee6SHong Zhang } 4037cb94ee6SHong Zhang ierr = PetscOptionsReal("-ts_sundials_atol","Absolute tolerance for convergence","TSSundialsSetTolerance",cvode->abstol,&cvode->abstol,PETSC_NULL);CHKERRQ(ierr); 4047cb94ee6SHong Zhang ierr = PetscOptionsReal("-ts_sundials_rtol","Relative tolerance for convergence","TSSundialsSetTolerance",cvode->reltol,&cvode->reltol,PETSC_NULL);CHKERRQ(ierr); 405f1cd61daSJed Brown ierr = PetscOptionsReal("-ts_sundials_mindt","Minimum step size","TSSundialsSetMinTimeStep",cvode->mindt,&cvode->mindt,PETSC_NULL);CHKERRQ(ierr); 406f1cd61daSJed Brown ierr = PetscOptionsReal("-ts_sundials_maxdt","Maximum step size","TSSundialsSetMaxTimeStep",cvode->maxdt,&cvode->maxdt,PETSC_NULL);CHKERRQ(ierr); 4077cb94ee6SHong Zhang ierr = PetscOptionsReal("-ts_sundials_linear_tolerance","Convergence tolerance for linear solve","TSSundialsSetLinearTolerance",cvode->linear_tol,&cvode->linear_tol,&flag);CHKERRQ(ierr); 4087cb94ee6SHong Zhang ierr = PetscOptionsInt("-ts_sundials_gmres_restart","Number of GMRES orthogonalization directions","TSSundialsSetGMRESRestart",cvode->restart,&cvode->restart,&flag);CHKERRQ(ierr); 409acfcf0e5SJed Brown ierr = PetscOptionsBool("-ts_sundials_monitor_steps","Monitor SUNDIALS internel steps","TSSundialsMonitorInternalSteps",cvode->monitorstep,&cvode->monitorstep,PETSC_NULL);CHKERRQ(ierr); 4107cb94ee6SHong Zhang ierr = PetscOptionsTail();CHKERRQ(ierr); 4117cb94ee6SHong Zhang PetscFunctionReturn(0); 4127cb94ee6SHong Zhang } 4137cb94ee6SHong Zhang 4147cb94ee6SHong Zhang #undef __FUNCT__ 4157cb94ee6SHong Zhang #define __FUNCT__ "TSView_Sundials" 4167cb94ee6SHong Zhang PetscErrorCode TSView_Sundials(TS ts,PetscViewer viewer) 4177cb94ee6SHong Zhang { 4187cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 4197cb94ee6SHong Zhang PetscErrorCode ierr; 4207cb94ee6SHong Zhang char *type; 4217cb94ee6SHong Zhang char atype[] = "Adams"; 4227cb94ee6SHong Zhang char btype[] = "BDF: backward differentiation formula"; 423ace3abfcSBarry Smith PetscBool iascii,isstring; 4242c823083SHong Zhang long int nsteps,its,nfevals,nlinsetups,nfails,itmp; 4252c823083SHong Zhang PetscInt qlast,qcur; 4265d47aee6SHong Zhang PetscReal hinused,hlast,hcur,tcur,tolsfac; 42742528757SHong Zhang PC pc; 4287cb94ee6SHong Zhang 4297cb94ee6SHong Zhang PetscFunctionBegin; 4307cb94ee6SHong Zhang if (cvode->cvode_type == SUNDIALS_ADAMS) {type = atype;} 4317cb94ee6SHong Zhang else {type = btype;} 4327cb94ee6SHong Zhang 4332692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 4342692d6eeSBarry Smith ierr = PetscTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 4357cb94ee6SHong Zhang if (iascii) { 4367cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater does not use SNES!\n");CHKERRQ(ierr); 4377cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials integrater type %s\n",type);CHKERRQ(ierr); 4387cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials abs tol %g rel tol %g\n",cvode->abstol,cvode->reltol);CHKERRQ(ierr); 4397cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials linear solver tolerance factor %g\n",cvode->linear_tol);CHKERRQ(ierr); 4407cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials GMRES max iterations (same as restart in SUNDIALS) %D\n",cvode->restart);CHKERRQ(ierr); 4417cb94ee6SHong Zhang if (cvode->gtype == SUNDIALS_MODIFIED_GS) { 4427cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials using modified Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr); 4437cb94ee6SHong Zhang } else { 4447cb94ee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials using unmodified (classical) Gram-Schmidt for orthogonalization in GMRES\n");CHKERRQ(ierr); 4457cb94ee6SHong Zhang } 446f1cd61daSJed Brown if (cvode->mindt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials minimum time step %g\n",cvode->mindt);CHKERRQ(ierr);} 447f1cd61daSJed Brown if (cvode->maxdt > 0) {ierr = PetscViewerASCIIPrintf(viewer,"Sundials maximum time step %g\n",cvode->maxdt);CHKERRQ(ierr);} 4482c823083SHong Zhang 4495d47aee6SHong Zhang /* Outputs from CVODE, CVSPILS */ 4505d47aee6SHong Zhang ierr = CVodeGetTolScaleFactor(cvode->mem,&tolsfac);CHKERRQ(ierr); 4515d47aee6SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials suggested factor for tolerance scaling %g\n",tolsfac);CHKERRQ(ierr); 4522c823083SHong Zhang ierr = CVodeGetIntegratorStats(cvode->mem,&nsteps,&nfevals, 4532c823083SHong Zhang &nlinsetups,&nfails,&qlast,&qcur, 4542c823083SHong Zhang &hinused,&hlast,&hcur,&tcur);CHKERRQ(ierr); 4552c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials cumulative number of internal steps %D\n",nsteps);CHKERRQ(ierr); 4562c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to rhs function %D\n",nfevals);CHKERRQ(ierr); 4572c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of calls to linear solver setup function %D\n",nlinsetups);CHKERRQ(ierr); 4582c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of error test failures %D\n",nfails);CHKERRQ(ierr); 4592c823083SHong Zhang 4602c823083SHong Zhang ierr = CVodeGetNonlinSolvStats(cvode->mem,&its,&nfails);CHKERRQ(ierr); 4612c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear solver iterations %D\n",its);CHKERRQ(ierr); 4622c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of nonlinear convergence failure %D\n",nfails);CHKERRQ(ierr); 4632c823083SHong Zhang 4642c823083SHong Zhang ierr = CVSpilsGetNumLinIters(cvode->mem, &its);CHKERRQ(ierr); /* its = no. of calls to TSPrecond_Sundials() */ 4652c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear iterations %D\n",its);CHKERRQ(ierr); 4662c823083SHong Zhang ierr = CVSpilsGetNumConvFails(cvode->mem,&itmp);CHKERRQ(ierr); 4672c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of linear convergence failures %D\n",itmp);CHKERRQ(ierr); 46842528757SHong Zhang 46942528757SHong Zhang ierr = TSSundialsGetPC(ts,&pc); CHKERRQ(ierr); 47042528757SHong Zhang ierr = PCView(pc,viewer);CHKERRQ(ierr); 4712c823083SHong Zhang ierr = CVSpilsGetNumPrecEvals(cvode->mem,&itmp);CHKERRQ(ierr); 4722c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner evaluations %D\n",itmp);CHKERRQ(ierr); 4732c823083SHong Zhang ierr = CVSpilsGetNumPrecSolves(cvode->mem,&itmp);CHKERRQ(ierr); 4742c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of preconditioner solves %D\n",itmp);CHKERRQ(ierr); 47542528757SHong Zhang 4762c823083SHong Zhang ierr = CVSpilsGetNumJtimesEvals(cvode->mem,&itmp);CHKERRQ(ierr); 4772c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of Jacobian-vector product evaluations %D\n",itmp);CHKERRQ(ierr); 4782c823083SHong Zhang ierr = CVSpilsGetNumRhsEvals(cvode->mem,&itmp);CHKERRQ(ierr); 4792c823083SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"Sundials no. of rhs calls for finite diff. Jacobian-vector evals %D\n",itmp);CHKERRQ(ierr); 4807cb94ee6SHong Zhang } else if (isstring) { 4817cb94ee6SHong Zhang ierr = PetscViewerStringSPrintf(viewer,"Sundials type %s",type);CHKERRQ(ierr); 4827cb94ee6SHong Zhang } 4837cb94ee6SHong Zhang PetscFunctionReturn(0); 4847cb94ee6SHong Zhang } 4857cb94ee6SHong Zhang 4867cb94ee6SHong Zhang 4877cb94ee6SHong Zhang /* --------------------------------------------------------------------------*/ 4887cb94ee6SHong Zhang EXTERN_C_BEGIN 4897cb94ee6SHong Zhang #undef __FUNCT__ 4907cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType_Sundials" 4917087cfbeSBarry Smith PetscErrorCode TSSundialsSetType_Sundials(TS ts,TSSundialsLmmType type) 4927cb94ee6SHong Zhang { 4937cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 4947cb94ee6SHong Zhang 4957cb94ee6SHong Zhang PetscFunctionBegin; 4967cb94ee6SHong Zhang cvode->cvode_type = type; 4977cb94ee6SHong Zhang PetscFunctionReturn(0); 4987cb94ee6SHong Zhang } 4997cb94ee6SHong Zhang EXTERN_C_END 5007cb94ee6SHong Zhang 5017cb94ee6SHong Zhang EXTERN_C_BEGIN 5027cb94ee6SHong Zhang #undef __FUNCT__ 5037cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGMRESRestart_Sundials" 5047087cfbeSBarry Smith PetscErrorCode TSSundialsSetGMRESRestart_Sundials(TS ts,int restart) 5057cb94ee6SHong Zhang { 5067cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 5077cb94ee6SHong Zhang 5087cb94ee6SHong Zhang PetscFunctionBegin; 5097cb94ee6SHong Zhang cvode->restart = restart; 5107cb94ee6SHong Zhang PetscFunctionReturn(0); 5117cb94ee6SHong Zhang } 5127cb94ee6SHong Zhang EXTERN_C_END 5137cb94ee6SHong Zhang 5147cb94ee6SHong Zhang EXTERN_C_BEGIN 5157cb94ee6SHong Zhang #undef __FUNCT__ 5167cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance_Sundials" 5177087cfbeSBarry Smith PetscErrorCode TSSundialsSetLinearTolerance_Sundials(TS ts,double 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 EXTERN_C_END 5267cb94ee6SHong Zhang 5277cb94ee6SHong Zhang EXTERN_C_BEGIN 5287cb94ee6SHong Zhang #undef __FUNCT__ 5297cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType_Sundials" 5307087cfbeSBarry Smith PetscErrorCode TSSundialsSetGramSchmidtType_Sundials(TS ts,TSSundialsGramSchmidtType type) 5317cb94ee6SHong Zhang { 5327cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 5337cb94ee6SHong Zhang 5347cb94ee6SHong Zhang PetscFunctionBegin; 5357cb94ee6SHong Zhang cvode->gtype = type; 5367cb94ee6SHong Zhang PetscFunctionReturn(0); 5377cb94ee6SHong Zhang } 5387cb94ee6SHong Zhang EXTERN_C_END 5397cb94ee6SHong Zhang 5407cb94ee6SHong Zhang EXTERN_C_BEGIN 5417cb94ee6SHong Zhang #undef __FUNCT__ 5427cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance_Sundials" 5437087cfbeSBarry Smith PetscErrorCode TSSundialsSetTolerance_Sundials(TS ts,double aabs,double rel) 5447cb94ee6SHong Zhang { 5457cb94ee6SHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 5467cb94ee6SHong Zhang 5477cb94ee6SHong Zhang PetscFunctionBegin; 5487cb94ee6SHong Zhang if (aabs != PETSC_DECIDE) cvode->abstol = aabs; 5497cb94ee6SHong Zhang if (rel != PETSC_DECIDE) cvode->reltol = rel; 5507cb94ee6SHong Zhang PetscFunctionReturn(0); 5517cb94ee6SHong Zhang } 5527cb94ee6SHong Zhang EXTERN_C_END 5537cb94ee6SHong Zhang 5547cb94ee6SHong Zhang EXTERN_C_BEGIN 5557cb94ee6SHong Zhang #undef __FUNCT__ 556f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep_Sundials" 5577087cfbeSBarry Smith PetscErrorCode TSSundialsSetMinTimeStep_Sundials(TS ts,PetscReal mindt) 558f1cd61daSJed Brown { 559f1cd61daSJed Brown TS_Sundials *cvode = (TS_Sundials*)ts->data; 560f1cd61daSJed Brown 561f1cd61daSJed Brown PetscFunctionBegin; 562f1cd61daSJed Brown cvode->mindt = mindt; 563f1cd61daSJed Brown PetscFunctionReturn(0); 564f1cd61daSJed Brown } 565f1cd61daSJed Brown EXTERN_C_END 566f1cd61daSJed Brown 567f1cd61daSJed Brown EXTERN_C_BEGIN 568f1cd61daSJed Brown #undef __FUNCT__ 569f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep_Sundials" 5707087cfbeSBarry Smith PetscErrorCode TSSundialsSetMaxTimeStep_Sundials(TS ts,PetscReal maxdt) 571f1cd61daSJed Brown { 572f1cd61daSJed Brown TS_Sundials *cvode = (TS_Sundials*)ts->data; 573f1cd61daSJed Brown 574f1cd61daSJed Brown PetscFunctionBegin; 575f1cd61daSJed Brown cvode->maxdt = maxdt; 576f1cd61daSJed Brown PetscFunctionReturn(0); 577f1cd61daSJed Brown } 578f1cd61daSJed Brown EXTERN_C_END 579f1cd61daSJed Brown 580f1cd61daSJed Brown EXTERN_C_BEGIN 581f1cd61daSJed Brown #undef __FUNCT__ 5827cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC_Sundials" 5837087cfbeSBarry Smith PetscErrorCode TSSundialsGetPC_Sundials(TS ts,PC *pc) 5847cb94ee6SHong Zhang { 585dcbc6d53SSean Farley SNES snes; 586dcbc6d53SSean Farley KSP ksp; 587dcbc6d53SSean Farley PetscErrorCode ierr; 5887cb94ee6SHong Zhang 5897cb94ee6SHong Zhang PetscFunctionBegin; 590dcbc6d53SSean Farley ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 591dcbc6d53SSean Farley ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 592dcbc6d53SSean Farley ierr = KSPGetPC(ksp,pc); CHKERRQ(ierr); 5937cb94ee6SHong Zhang PetscFunctionReturn(0); 5947cb94ee6SHong Zhang } 5957cb94ee6SHong Zhang EXTERN_C_END 5967cb94ee6SHong Zhang 5977cb94ee6SHong Zhang EXTERN_C_BEGIN 5987cb94ee6SHong Zhang #undef __FUNCT__ 5997cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations_Sundials" 6007087cfbeSBarry Smith PetscErrorCode TSSundialsGetIterations_Sundials(TS ts,int *nonlin,int *lin) 6017cb94ee6SHong Zhang { 6027cb94ee6SHong Zhang PetscFunctionBegin; 6032c823083SHong Zhang if (nonlin) *nonlin = ts->nonlinear_its; 6042c823083SHong Zhang if (lin) *lin = ts->linear_its; 6057cb94ee6SHong Zhang PetscFunctionReturn(0); 6067cb94ee6SHong Zhang } 6077cb94ee6SHong Zhang EXTERN_C_END 6087cb94ee6SHong Zhang 6097cb94ee6SHong Zhang EXTERN_C_BEGIN 6107cb94ee6SHong Zhang #undef __FUNCT__ 6112bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps_Sundials" 6127087cfbeSBarry Smith PetscErrorCode TSSundialsMonitorInternalSteps_Sundials(TS ts,PetscBool s) 6132bfc04deSHong Zhang { 6142bfc04deSHong Zhang TS_Sundials *cvode = (TS_Sundials*)ts->data; 6152bfc04deSHong Zhang 6162bfc04deSHong Zhang PetscFunctionBegin; 6172bfc04deSHong Zhang cvode->monitorstep = s; 6182bfc04deSHong Zhang PetscFunctionReturn(0); 6192bfc04deSHong Zhang } 6202bfc04deSHong Zhang EXTERN_C_END 6217cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/ 6227cb94ee6SHong Zhang 6237cb94ee6SHong Zhang #undef __FUNCT__ 6247cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetIterations" 6257cb94ee6SHong Zhang /*@C 6267cb94ee6SHong Zhang TSSundialsGetIterations - Gets the number of nonlinear and linear iterations used so far by Sundials. 6277cb94ee6SHong Zhang 6287cb94ee6SHong Zhang Not Collective 6297cb94ee6SHong Zhang 6307cb94ee6SHong Zhang Input parameters: 6317cb94ee6SHong Zhang . ts - the time-step context 6327cb94ee6SHong Zhang 6337cb94ee6SHong Zhang Output Parameters: 6347cb94ee6SHong Zhang + nonlin - number of nonlinear iterations 6357cb94ee6SHong Zhang - lin - number of linear iterations 6367cb94ee6SHong Zhang 6377cb94ee6SHong Zhang Level: advanced 6387cb94ee6SHong Zhang 6397cb94ee6SHong Zhang Notes: 6407cb94ee6SHong Zhang These return the number since the creation of the TS object 6417cb94ee6SHong Zhang 6427cb94ee6SHong Zhang .keywords: non-linear iterations, linear iterations 6437cb94ee6SHong Zhang 6447cb94ee6SHong Zhang .seealso: TSSundialsSetType(), TSSundialsSetGMRESRestart(), 6457cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 6467cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 647a43b19c4SJed Brown TSSundialsSetLinearTolerance(), TSSundialsGetPC(), TSSetExactFinalTime() 6487cb94ee6SHong Zhang 6497cb94ee6SHong Zhang @*/ 6507087cfbeSBarry Smith PetscErrorCode TSSundialsGetIterations(TS ts,int *nonlin,int *lin) 6517cb94ee6SHong Zhang { 6524ac538c5SBarry Smith PetscErrorCode ierr; 6537cb94ee6SHong Zhang 6547cb94ee6SHong Zhang PetscFunctionBegin; 6554ac538c5SBarry Smith ierr = PetscUseMethod(ts,"TSSundialsGetIterations_C",(TS,int*,int*),(ts,nonlin,lin));CHKERRQ(ierr); 6567cb94ee6SHong Zhang PetscFunctionReturn(0); 6577cb94ee6SHong Zhang } 6587cb94ee6SHong Zhang 6597cb94ee6SHong Zhang #undef __FUNCT__ 6607cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetType" 6617cb94ee6SHong Zhang /*@ 6627cb94ee6SHong Zhang TSSundialsSetType - Sets the method that Sundials will use for integration. 6637cb94ee6SHong Zhang 6643f9fe445SBarry Smith Logically Collective on TS 6657cb94ee6SHong Zhang 6667cb94ee6SHong Zhang Input parameters: 6677cb94ee6SHong Zhang + ts - the time-step context 6687cb94ee6SHong Zhang - type - one of SUNDIALS_ADAMS or SUNDIALS_BDF 6697cb94ee6SHong Zhang 6707cb94ee6SHong Zhang Level: intermediate 6717cb94ee6SHong Zhang 6727cb94ee6SHong Zhang .keywords: Adams, backward differentiation formula 6737cb94ee6SHong Zhang 6747cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetGMRESRestart(), 6757cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 6767cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 6777cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(), 678a43b19c4SJed Brown TSSetExactFinalTime() 6797cb94ee6SHong Zhang @*/ 6807087cfbeSBarry Smith PetscErrorCode TSSundialsSetType(TS ts,TSSundialsLmmType type) 6817cb94ee6SHong Zhang { 6824ac538c5SBarry Smith PetscErrorCode ierr; 6837cb94ee6SHong Zhang 6847cb94ee6SHong Zhang PetscFunctionBegin; 6854ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetType_C",(TS,TSSundialsLmmType),(ts,type));CHKERRQ(ierr); 6867cb94ee6SHong Zhang PetscFunctionReturn(0); 6877cb94ee6SHong Zhang } 6887cb94ee6SHong Zhang 6897cb94ee6SHong Zhang #undef __FUNCT__ 6907cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGMRESRestart" 6917cb94ee6SHong Zhang /*@ 6927cb94ee6SHong Zhang TSSundialsSetGMRESRestart - Sets the dimension of the Krylov space used by 6937cb94ee6SHong Zhang GMRES in the linear solver in SUNDIALS. SUNDIALS DOES NOT use restarted GMRES so 6947cb94ee6SHong Zhang this is ALSO the maximum number of GMRES steps that will be used. 6957cb94ee6SHong Zhang 6963f9fe445SBarry Smith Logically Collective on TS 6977cb94ee6SHong Zhang 6987cb94ee6SHong Zhang Input parameters: 6997cb94ee6SHong Zhang + ts - the time-step context 7007cb94ee6SHong Zhang - restart - number of direction vectors (the restart size). 7017cb94ee6SHong Zhang 7027cb94ee6SHong Zhang Level: advanced 7037cb94ee6SHong Zhang 7047cb94ee6SHong Zhang .keywords: GMRES, restart 7057cb94ee6SHong Zhang 7067cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), 7077cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 7087cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 7097cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(), 710a43b19c4SJed Brown TSSetExactFinalTime() 7117cb94ee6SHong Zhang 7127cb94ee6SHong Zhang @*/ 7137087cfbeSBarry Smith PetscErrorCode TSSundialsSetGMRESRestart(TS ts,int restart) 7147cb94ee6SHong Zhang { 7154ac538c5SBarry Smith PetscErrorCode ierr; 7167cb94ee6SHong Zhang 7177cb94ee6SHong Zhang PetscFunctionBegin; 718c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,restart,2); 7194ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetGMRESRestart_C",(TS,int),(ts,restart));CHKERRQ(ierr); 7207cb94ee6SHong Zhang PetscFunctionReturn(0); 7217cb94ee6SHong Zhang } 7227cb94ee6SHong Zhang 7237cb94ee6SHong Zhang #undef __FUNCT__ 7247cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetLinearTolerance" 7257cb94ee6SHong Zhang /*@ 7267cb94ee6SHong Zhang TSSundialsSetLinearTolerance - Sets the tolerance used to solve the linear 7277cb94ee6SHong Zhang system by SUNDIALS. 7287cb94ee6SHong Zhang 7293f9fe445SBarry Smith Logically Collective on TS 7307cb94ee6SHong Zhang 7317cb94ee6SHong Zhang Input parameters: 7327cb94ee6SHong Zhang + ts - the time-step context 7337cb94ee6SHong Zhang - tol - the factor by which the tolerance on the nonlinear solver is 7347cb94ee6SHong Zhang multiplied to get the tolerance on the linear solver, .05 by default. 7357cb94ee6SHong Zhang 7367cb94ee6SHong Zhang Level: advanced 7377cb94ee6SHong Zhang 7387cb94ee6SHong Zhang .keywords: GMRES, linear convergence tolerance, SUNDIALS 7397cb94ee6SHong Zhang 7407cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 7417cb94ee6SHong Zhang TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 7427cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 7437cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(), 744a43b19c4SJed Brown TSSetExactFinalTime() 7457cb94ee6SHong Zhang 7467cb94ee6SHong Zhang @*/ 7477087cfbeSBarry Smith PetscErrorCode TSSundialsSetLinearTolerance(TS ts,double tol) 7487cb94ee6SHong Zhang { 7494ac538c5SBarry Smith PetscErrorCode ierr; 7507cb94ee6SHong Zhang 7517cb94ee6SHong Zhang PetscFunctionBegin; 752c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,tol,2); 7534ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetLinearTolerance_C",(TS,double),(ts,tol));CHKERRQ(ierr); 7547cb94ee6SHong Zhang PetscFunctionReturn(0); 7557cb94ee6SHong Zhang } 7567cb94ee6SHong Zhang 7577cb94ee6SHong Zhang #undef __FUNCT__ 7587cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetGramSchmidtType" 7597cb94ee6SHong Zhang /*@ 7607cb94ee6SHong Zhang TSSundialsSetGramSchmidtType - Sets type of orthogonalization used 7617cb94ee6SHong Zhang in GMRES method by SUNDIALS linear solver. 7627cb94ee6SHong Zhang 7633f9fe445SBarry Smith Logically Collective on TS 7647cb94ee6SHong Zhang 7657cb94ee6SHong Zhang Input parameters: 7667cb94ee6SHong Zhang + ts - the time-step context 7677cb94ee6SHong Zhang - type - either SUNDIALS_MODIFIED_GS or SUNDIALS_CLASSICAL_GS 7687cb94ee6SHong Zhang 7697cb94ee6SHong Zhang Level: advanced 7707cb94ee6SHong Zhang 7717cb94ee6SHong Zhang .keywords: Sundials, orthogonalization 7727cb94ee6SHong Zhang 7737cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 7747cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), 7757cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 7767cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(), 777a43b19c4SJed Brown TSSetExactFinalTime() 7787cb94ee6SHong Zhang 7797cb94ee6SHong Zhang @*/ 7807087cfbeSBarry Smith PetscErrorCode TSSundialsSetGramSchmidtType(TS ts,TSSundialsGramSchmidtType type) 7817cb94ee6SHong Zhang { 7824ac538c5SBarry Smith PetscErrorCode ierr; 7837cb94ee6SHong Zhang 7847cb94ee6SHong Zhang PetscFunctionBegin; 7854ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetGramSchmidtType_C",(TS,TSSundialsGramSchmidtType),(ts,type));CHKERRQ(ierr); 7867cb94ee6SHong Zhang PetscFunctionReturn(0); 7877cb94ee6SHong Zhang } 7887cb94ee6SHong Zhang 7897cb94ee6SHong Zhang #undef __FUNCT__ 7907cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsSetTolerance" 7917cb94ee6SHong Zhang /*@ 7927cb94ee6SHong Zhang TSSundialsSetTolerance - Sets the absolute and relative tolerance used by 7937cb94ee6SHong Zhang Sundials for error control. 7947cb94ee6SHong Zhang 7953f9fe445SBarry Smith Logically Collective on TS 7967cb94ee6SHong Zhang 7977cb94ee6SHong Zhang Input parameters: 7987cb94ee6SHong Zhang + ts - the time-step context 7997cb94ee6SHong Zhang . aabs - the absolute tolerance 8007cb94ee6SHong Zhang - rel - the relative tolerance 8017cb94ee6SHong Zhang 8027cb94ee6SHong Zhang See the Cvode/Sundials users manual for exact details on these parameters. Essentially 8037cb94ee6SHong Zhang these regulate the size of the error for a SINGLE timestep. 8047cb94ee6SHong Zhang 8057cb94ee6SHong Zhang Level: intermediate 8067cb94ee6SHong Zhang 8077cb94ee6SHong Zhang .keywords: Sundials, tolerance 8087cb94ee6SHong Zhang 8097cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 8107cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), 8117cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 8127cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC(), 813a43b19c4SJed Brown TSSetExactFinalTime() 8147cb94ee6SHong Zhang 8157cb94ee6SHong Zhang @*/ 8167087cfbeSBarry Smith PetscErrorCode TSSundialsSetTolerance(TS ts,double aabs,double rel) 8177cb94ee6SHong Zhang { 8184ac538c5SBarry Smith PetscErrorCode ierr; 8197cb94ee6SHong Zhang 8207cb94ee6SHong Zhang PetscFunctionBegin; 8214ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetTolerance_C",(TS,double,double),(ts,aabs,rel));CHKERRQ(ierr); 8227cb94ee6SHong Zhang PetscFunctionReturn(0); 8237cb94ee6SHong Zhang } 8247cb94ee6SHong Zhang 8257cb94ee6SHong Zhang #undef __FUNCT__ 8267cb94ee6SHong Zhang #define __FUNCT__ "TSSundialsGetPC" 8277cb94ee6SHong Zhang /*@ 8287cb94ee6SHong Zhang TSSundialsGetPC - Extract the PC context from a time-step context for Sundials. 8297cb94ee6SHong Zhang 8307cb94ee6SHong Zhang Input Parameter: 8317cb94ee6SHong Zhang . ts - the time-step context 8327cb94ee6SHong Zhang 8337cb94ee6SHong Zhang Output Parameter: 8347cb94ee6SHong Zhang . pc - the preconditioner context 8357cb94ee6SHong Zhang 8367cb94ee6SHong Zhang Level: advanced 8377cb94ee6SHong Zhang 8387cb94ee6SHong Zhang .seealso: TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 8397cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 8407cb94ee6SHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 8417cb94ee6SHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance() 8427cb94ee6SHong Zhang @*/ 8437087cfbeSBarry Smith PetscErrorCode TSSundialsGetPC(TS ts,PC *pc) 8447cb94ee6SHong Zhang { 8454ac538c5SBarry Smith PetscErrorCode ierr; 8467cb94ee6SHong Zhang 8477cb94ee6SHong Zhang PetscFunctionBegin; 8484ac538c5SBarry Smith ierr = PetscUseMethod(ts,"TSSundialsGetPC_C",(TS,PC *),(ts,pc));CHKERRQ(ierr); 8497cb94ee6SHong Zhang PetscFunctionReturn(0); 8507cb94ee6SHong Zhang } 8517cb94ee6SHong Zhang 8527cb94ee6SHong Zhang #undef __FUNCT__ 853f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMinTimeStep" 854f1cd61daSJed Brown /*@ 855f1cd61daSJed Brown TSSundialsSetMinTimeStep - Smallest time step to be chosen by the adaptive controller. 856f1cd61daSJed Brown 857f1cd61daSJed Brown Input Parameter: 858f1cd61daSJed Brown + ts - the time-step context 859f1cd61daSJed Brown - mindt - lowest time step if positive, negative to deactivate 860f1cd61daSJed Brown 861fc6b9e64SJed Brown Note: 862fc6b9e64SJed Brown Sundials will error if it is not possible to keep the estimated truncation error below 863fc6b9e64SJed Brown the tolerance set with TSSundialsSetTolerance() without going below this step size. 864fc6b9e64SJed Brown 865f1cd61daSJed Brown Level: beginner 866f1cd61daSJed Brown 867f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(), 868f1cd61daSJed Brown @*/ 8697087cfbeSBarry Smith PetscErrorCode TSSundialsSetMinTimeStep(TS ts,PetscReal mindt) 870f1cd61daSJed Brown { 8714ac538c5SBarry Smith PetscErrorCode ierr; 872f1cd61daSJed Brown 873f1cd61daSJed Brown PetscFunctionBegin; 8744ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetMinTimeStep_C",(TS,PetscReal),(ts,mindt));CHKERRQ(ierr); 875f1cd61daSJed Brown PetscFunctionReturn(0); 876f1cd61daSJed Brown } 877f1cd61daSJed Brown 878f1cd61daSJed Brown #undef __FUNCT__ 879f1cd61daSJed Brown #define __FUNCT__ "TSSundialsSetMaxTimeStep" 880f1cd61daSJed Brown /*@ 881f1cd61daSJed Brown TSSundialsSetMaxTimeStep - Largest time step to be chosen by the adaptive controller. 882f1cd61daSJed Brown 883f1cd61daSJed Brown Input Parameter: 884f1cd61daSJed Brown + ts - the time-step context 885f1cd61daSJed Brown - maxdt - lowest time step if positive, negative to deactivate 886f1cd61daSJed Brown 887f1cd61daSJed Brown Level: beginner 888f1cd61daSJed Brown 889f1cd61daSJed Brown .seealso: TSSundialsSetType(), TSSundialsSetTolerance(), 890f1cd61daSJed Brown @*/ 8917087cfbeSBarry Smith PetscErrorCode TSSundialsSetMaxTimeStep(TS ts,PetscReal maxdt) 892f1cd61daSJed Brown { 8934ac538c5SBarry Smith PetscErrorCode ierr; 894f1cd61daSJed Brown 895f1cd61daSJed Brown PetscFunctionBegin; 8964ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsSetMaxTimeStep_C",(TS,PetscReal),(ts,maxdt));CHKERRQ(ierr); 897f1cd61daSJed Brown PetscFunctionReturn(0); 898f1cd61daSJed Brown } 899f1cd61daSJed Brown 900f1cd61daSJed Brown #undef __FUNCT__ 9012bfc04deSHong Zhang #define __FUNCT__ "TSSundialsMonitorInternalSteps" 9022bfc04deSHong Zhang /*@ 9032bfc04deSHong Zhang TSSundialsMonitorInternalSteps - Monitor Sundials internal steps (Defaults to false). 9042bfc04deSHong Zhang 9052bfc04deSHong Zhang Input Parameter: 9062bfc04deSHong Zhang + ts - the time-step context 9072bfc04deSHong Zhang - ft - PETSC_TRUE if monitor, else PETSC_FALSE 9082bfc04deSHong Zhang 9092bfc04deSHong Zhang Level: beginner 9102bfc04deSHong Zhang 9112bfc04deSHong Zhang .seealso:TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 9122bfc04deSHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), 9132bfc04deSHong Zhang TSSundialsGetIterations(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), 9142bfc04deSHong Zhang TSSundialsSetLinearTolerance(), TSSundialsSetTolerance(), TSSundialsGetPC() 9152bfc04deSHong Zhang @*/ 9167087cfbeSBarry Smith PetscErrorCode TSSundialsMonitorInternalSteps(TS ts,PetscBool ft) 9172bfc04deSHong Zhang { 9184ac538c5SBarry Smith PetscErrorCode ierr; 9192bfc04deSHong Zhang 9202bfc04deSHong Zhang PetscFunctionBegin; 9214ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSSundialsMonitorInternalSteps_C",(TS,PetscBool),(ts,ft));CHKERRQ(ierr); 9222bfc04deSHong Zhang PetscFunctionReturn(0); 9232bfc04deSHong Zhang } 9247cb94ee6SHong Zhang /* -------------------------------------------------------------------------------------------*/ 9257cb94ee6SHong Zhang /*MC 92696f5712cSJed Brown TSSUNDIALS - ODE solver using the LLNL CVODE/SUNDIALS package (now called SUNDIALS) 9277cb94ee6SHong Zhang 9287cb94ee6SHong Zhang Options Database: 9297cb94ee6SHong Zhang + -ts_sundials_type <bdf,adams> 9307cb94ee6SHong Zhang . -ts_sundials_gramschmidt_type <modified, classical> - type of orthogonalization inside GMRES 9317cb94ee6SHong Zhang . -ts_sundials_atol <tol> - Absolute tolerance for convergence 9327cb94ee6SHong Zhang . -ts_sundials_rtol <tol> - Relative tolerance for convergence 9337cb94ee6SHong Zhang . -ts_sundials_linear_tolerance <tol> 9347cb94ee6SHong Zhang . -ts_sundials_gmres_restart <restart> - Number of GMRES orthogonalization directions 93516016685SHong Zhang - -ts_sundials_monitor_steps - Monitor SUNDIALS internel steps 93616016685SHong Zhang 9377cb94ee6SHong Zhang 9387cb94ee6SHong Zhang Notes: This uses its own nonlinear solver and Krylov method so PETSc SNES and KSP options do not apply 9397cb94ee6SHong Zhang only PETSc PC options 9407cb94ee6SHong Zhang 9417cb94ee6SHong Zhang Level: beginner 9427cb94ee6SHong Zhang 9437cb94ee6SHong Zhang .seealso: TSCreate(), TS, TSSetType(), TSSundialsSetType(), TSSundialsSetGMRESRestart(), TSSundialsSetLinearTolerance(), 944a43b19c4SJed Brown TSSundialsSetGramSchmidtType(), TSSundialsSetTolerance(), TSSundialsGetPC(), TSSundialsGetIterations(), TSSetExactFinalTime() 9457cb94ee6SHong Zhang 9467cb94ee6SHong Zhang M*/ 9477cb94ee6SHong Zhang EXTERN_C_BEGIN 9487cb94ee6SHong Zhang #undef __FUNCT__ 9497cb94ee6SHong Zhang #define __FUNCT__ "TSCreate_Sundials" 9507087cfbeSBarry Smith PetscErrorCode TSCreate_Sundials(TS ts) 9517cb94ee6SHong Zhang { 9527cb94ee6SHong Zhang TS_Sundials *cvode; 9537cb94ee6SHong Zhang PetscErrorCode ierr; 95442528757SHong Zhang PC pc; 9557cb94ee6SHong Zhang 9567cb94ee6SHong Zhang PetscFunctionBegin; 957277b19d0SLisandro Dalcin ts->ops->reset = TSReset_Sundials; 95828adb3f7SHong Zhang ts->ops->destroy = TSDestroy_Sundials; 95928adb3f7SHong Zhang ts->ops->view = TSView_Sundials; 960214bc6a2SJed Brown ts->ops->setup = TSSetUp_Sundials; 961117ce3f2SJed Brown ts->ops->solve = TSSolve_Sundials; 962214bc6a2SJed Brown ts->ops->setfromoptions = TSSetFromOptions_Sundials; 9637cb94ee6SHong Zhang 96438f2d2fdSLisandro Dalcin ierr = PetscNewLog(ts,TS_Sundials,&cvode);CHKERRQ(ierr); 9657cb94ee6SHong Zhang ts->data = (void*)cvode; 9666fadb2cdSHong Zhang cvode->cvode_type = SUNDIALS_BDF; 9676fadb2cdSHong Zhang cvode->gtype = SUNDIALS_CLASSICAL_GS; 9687cb94ee6SHong Zhang cvode->restart = 5; 9697cb94ee6SHong Zhang cvode->linear_tol = .05; 9707cb94ee6SHong Zhang 9712bfc04deSHong Zhang cvode->monitorstep = PETSC_FALSE; 9727cb94ee6SHong Zhang 973a07356b8SSatish Balay ierr = MPI_Comm_dup(((PetscObject)ts)->comm,&(cvode->comm_sundials));CHKERRQ(ierr); 974f1cd61daSJed Brown 975f1cd61daSJed Brown cvode->mindt = -1.; 976f1cd61daSJed Brown cvode->maxdt = -1.; 977f1cd61daSJed Brown 9787cb94ee6SHong Zhang /* set tolerance for Sundials */ 9797cb94ee6SHong Zhang cvode->reltol = 1e-6; 9802c823083SHong Zhang cvode->abstol = 1e-6; 9817cb94ee6SHong Zhang 98242528757SHong Zhang /* set PCNONE as default pctype */ 98342528757SHong Zhang ierr = TSSundialsGetPC_Sundials(ts,&pc);CHKERRQ(ierr); 98442528757SHong Zhang ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr); 98542528757SHong Zhang 986a43b19c4SJed Brown if (ts->exact_final_time == PETSC_DECIDE) ts->exact_final_time = PETSC_TRUE; 987a43b19c4SJed Brown 9887cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetType_C","TSSundialsSetType_Sundials", 9897cb94ee6SHong Zhang TSSundialsSetType_Sundials);CHKERRQ(ierr); 9907cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGMRESRestart_C", 9917cb94ee6SHong Zhang "TSSundialsSetGMRESRestart_Sundials", 9927cb94ee6SHong Zhang TSSundialsSetGMRESRestart_Sundials);CHKERRQ(ierr); 9937cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetLinearTolerance_C", 9947cb94ee6SHong Zhang "TSSundialsSetLinearTolerance_Sundials", 9957cb94ee6SHong Zhang TSSundialsSetLinearTolerance_Sundials);CHKERRQ(ierr); 9967cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetGramSchmidtType_C", 9977cb94ee6SHong Zhang "TSSundialsSetGramSchmidtType_Sundials", 9987cb94ee6SHong Zhang TSSundialsSetGramSchmidtType_Sundials);CHKERRQ(ierr); 9997cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetTolerance_C", 10007cb94ee6SHong Zhang "TSSundialsSetTolerance_Sundials", 10017cb94ee6SHong Zhang TSSundialsSetTolerance_Sundials);CHKERRQ(ierr); 1002f1cd61daSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMinTimeStep_C", 1003f1cd61daSJed Brown "TSSundialsSetMinTimeStep_Sundials", 1004f1cd61daSJed Brown TSSundialsSetMinTimeStep_Sundials);CHKERRQ(ierr); 1005f1cd61daSJed Brown ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsSetMaxTimeStep_C", 1006f1cd61daSJed Brown "TSSundialsSetMaxTimeStep_Sundials", 1007f1cd61daSJed Brown TSSundialsSetMaxTimeStep_Sundials);CHKERRQ(ierr); 10087cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetPC_C", 10097cb94ee6SHong Zhang "TSSundialsGetPC_Sundials", 10107cb94ee6SHong Zhang TSSundialsGetPC_Sundials);CHKERRQ(ierr); 10117cb94ee6SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsGetIterations_C", 10127cb94ee6SHong Zhang "TSSundialsGetIterations_Sundials", 10137cb94ee6SHong Zhang TSSundialsGetIterations_Sundials);CHKERRQ(ierr); 10142bfc04deSHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)ts,"TSSundialsMonitorInternalSteps_C", 10152bfc04deSHong Zhang "TSSundialsMonitorInternalSteps_Sundials", 10162bfc04deSHong Zhang TSSundialsMonitorInternalSteps_Sundials);CHKERRQ(ierr); 10172bfc04deSHong Zhang 10187cb94ee6SHong Zhang PetscFunctionReturn(0); 10197cb94ee6SHong Zhang } 10207cb94ee6SHong Zhang EXTERN_C_END 1021