xref: /petsc/src/ts/impls/arkimex/arkimex.c (revision feed9e9da6c2d07546ffbbe4cafa0424dc138dae)
18a381b04SJed Brown /*
28a381b04SJed Brown   Code for timestepping with additive Runge-Kutta IMEX method
38a381b04SJed Brown 
48a381b04SJed Brown   Notes:
58a381b04SJed Brown   The general system is written as
68a381b04SJed Brown 
7f9c1d6abSBarry Smith   F(t,U,Udot) = G(t,U)
88a381b04SJed Brown 
98a381b04SJed Brown   where F represents the stiff part of the physics and G represents the non-stiff part.
108a381b04SJed Brown 
118a381b04SJed Brown */
12af0996ceSBarry Smith #include <petsc/private/tsimpl.h>                /*I   "petscts.h"   I*/
131e25c274SJed Brown #include <petscdm.h>
148a381b04SJed Brown 
1519fd82e9SBarry Smith static TSARKIMEXType  TSARKIMEXDefault = TSARKIMEX3;
168a381b04SJed Brown static PetscBool      TSARKIMEXRegisterAllCalled;
178a381b04SJed Brown static PetscBool      TSARKIMEXPackageInitialized;
18e817cc15SEmil Constantinescu static PetscInt       explicit_stage_time_id;
1956dcabbaSDebojyoti Ghosh static PetscErrorCode TSExtrapolate_ARKIMEX(TS,PetscReal,Vec);
208a381b04SJed Brown 
218a381b04SJed Brown typedef struct _ARKTableau *ARKTableau;
228a381b04SJed Brown struct _ARKTableau {
238a381b04SJed Brown   char      *name;
244f385281SJed Brown   PetscInt  order;                /* Classical approximation order of the method */
254f385281SJed Brown   PetscInt  s;                    /* Number of stages */
26e817cc15SEmil Constantinescu   PetscBool stiffly_accurate;     /* The implicit part is stiffly accurate*/
27e817cc15SEmil Constantinescu   PetscBool FSAL_implicit;        /* The implicit part is FSAL*/
28e817cc15SEmil Constantinescu   PetscBool explicit_first_stage; /* The implicit part has an explicit first stage*/
294f385281SJed Brown   PetscInt  pinterp;              /* Interpolation order */
304f385281SJed Brown   PetscReal *At,*bt,*ct;          /* Stiff tableau */
318a381b04SJed Brown   PetscReal *A,*b,*c;             /* Non-stiff tableau */
32108c343cSJed Brown   PetscReal *bembedt,*bembed;     /* Embedded formula of order one less (order-1) */
33cd652676SJed Brown   PetscReal *binterpt,*binterp;   /* Dense output formula */
34108c343cSJed Brown   PetscReal ccfl;                 /* Placeholder for CFL coefficient relative to forward Euler */
358a381b04SJed Brown };
368a381b04SJed Brown typedef struct _ARKTableauLink *ARKTableauLink;
378a381b04SJed Brown struct _ARKTableauLink {
388a381b04SJed Brown   struct _ARKTableau tab;
398a381b04SJed Brown   ARKTableauLink     next;
408a381b04SJed Brown };
418a381b04SJed Brown static ARKTableauLink ARKTableauList;
428a381b04SJed Brown 
438a381b04SJed Brown typedef struct {
448a381b04SJed Brown   ARKTableau   tableau;
458a381b04SJed Brown   Vec          *Y;               /* States computed during the step */
468a381b04SJed Brown   Vec          *YdotI;           /* Time derivatives for the stiff part */
478a381b04SJed Brown   Vec          *YdotRHS;         /* Function evaluations for the non-stiff part */
489eef816dSJed Brown   PetscBool    prev_step_valid;  /* Stored previous step (Y_prev, YdotI_prev, YdotRHS_prev) is valid */
4956dcabbaSDebojyoti Ghosh   Vec          *Y_prev;          /* States computed during the previous time step */
5056dcabbaSDebojyoti Ghosh   Vec          *YdotI_prev;      /* Time derivatives for the stiff part for the previous time step*/
5156dcabbaSDebojyoti Ghosh   Vec          *YdotRHS_prev;    /* Function evaluations for the non-stiff part for the previous time step*/
52e817cc15SEmil Constantinescu   Vec          Ydot0;            /* Holds the slope from the previous step in FSAL case */
538a381b04SJed Brown   Vec          Ydot;             /* Work vector holding Ydot during residual evaluation */
548a381b04SJed Brown   Vec          Work;             /* Generic work vector */
558a381b04SJed Brown   Vec          Z;                /* Ydot = shift(Y-Z) */
568a381b04SJed Brown   PetscScalar  *work;            /* Scalar work */
57b296d7d5SJed Brown   PetscReal    scoeff;           /* shift = scoeff/dt */
588a381b04SJed Brown   PetscReal    stage_time;
594cc180ffSJed Brown   PetscBool    imex;
6056dcabbaSDebojyoti Ghosh   PetscBool    init_guess_extrp; /* Extrapolate initial guess from previous time-step stage values */
61108c343cSJed Brown   TSStepStatus status;
628a381b04SJed Brown } TS_ARKIMEX;
631f80e275SEmil Constantinescu /*MC
641f80e275SEmil Constantinescu      TSARKIMEXARS122 - Second order ARK IMEX scheme.
658a381b04SJed Brown 
661f80e275SEmil Constantinescu      This method has one explicit stage and one implicit stage.
671f80e275SEmil Constantinescu 
681f80e275SEmil Constantinescu      References:
6996a0c994SBarry Smith .   1. -  U. Ascher, S. Ruuth, R. J. Spiteri, Implicit explicit Runge Kutta methods for time dependent Partial Differential Equations. Appl. Numer. Math. 25, (1997).
701f80e275SEmil Constantinescu 
711f80e275SEmil Constantinescu      Level: advanced
721f80e275SEmil Constantinescu 
731f80e275SEmil Constantinescu .seealso: TSARKIMEX
741f80e275SEmil Constantinescu M*/
751f80e275SEmil Constantinescu /*MC
761f80e275SEmil Constantinescu      TSARKIMEXA2 - Second order ARK IMEX scheme with A-stable implicit part.
771f80e275SEmil Constantinescu 
781f80e275SEmil Constantinescu      This method has an explicit stage and one implicit stage, and has an A-stable implicit scheme. This method was provided by Emil Constantinescu.
791f80e275SEmil Constantinescu 
801f80e275SEmil Constantinescu      Level: advanced
811f80e275SEmil Constantinescu 
821f80e275SEmil Constantinescu .seealso: TSARKIMEX
831f80e275SEmil Constantinescu M*/
841f80e275SEmil Constantinescu /*MC
851f80e275SEmil Constantinescu      TSARKIMEXL2 - Second order ARK IMEX scheme with L-stable implicit part.
861f80e275SEmil Constantinescu 
871f80e275SEmil Constantinescu      This method has two implicit stages, and L-stable implicit scheme.
881f80e275SEmil Constantinescu 
891f80e275SEmil Constantinescu     References:
9096a0c994SBarry Smith .   1. -  L. Pareschi, G. Russo, Implicit Explicit Runge Kutta schemes and applications to hyperbolic systems with relaxations. Journal of Scientific Computing Volume: 25, Issue: 1, October, 2005.
911f80e275SEmil Constantinescu 
921f80e275SEmil Constantinescu      Level: advanced
931f80e275SEmil Constantinescu 
941f80e275SEmil Constantinescu .seealso: TSARKIMEX
951f80e275SEmil Constantinescu M*/
961f80e275SEmil Constantinescu /*MC
97e817cc15SEmil Constantinescu      TSARKIMEX1BEE - First order Backward Euler represented as an ARK IMEX scheme with extrapolation as error estimator. This is a 3-stage method.
98e817cc15SEmil Constantinescu 
99e817cc15SEmil Constantinescu      This method is aimed at starting the integration of implicit DAEs when explicit first-stage ARK methods are used.
100e817cc15SEmil Constantinescu 
101e817cc15SEmil Constantinescu      Level: advanced
102e817cc15SEmil Constantinescu 
103e817cc15SEmil Constantinescu .seealso: TSARKIMEX
104e817cc15SEmil Constantinescu M*/
105e817cc15SEmil Constantinescu /*MC
1061f80e275SEmil Constantinescu      TSARKIMEX2C - Second order ARK IMEX scheme with L-stable implicit part.
1071f80e275SEmil Constantinescu 
1081f80e275SEmil Constantinescu      This method has one explicit stage and two implicit stages. The implicit part is the same as in TSARKIMEX2D and TSARKIMEX2E, but the explicit part has a larger stability region on the negative real axis. This method was provided by Emil Constantinescu.
1091f80e275SEmil Constantinescu 
1101f80e275SEmil Constantinescu      Level: advanced
1111f80e275SEmil Constantinescu 
1121f80e275SEmil Constantinescu .seealso: TSARKIMEX
1131f80e275SEmil Constantinescu M*/
11464f491ddSJed Brown /*MC
11564f491ddSJed Brown      TSARKIMEX2D - Second order ARK IMEX scheme with L-stable implicit part.
11664f491ddSJed Brown 
117617a39beSEmil Constantinescu      This method has one explicit stage and two implicit stages. The stability function is independent of the explicit part in the infinity limit of the implict component. This method was provided by Emil Constantinescu.
11864f491ddSJed Brown 
119b330ce4dSSatish Balay      Level: advanced
120b330ce4dSSatish Balay 
12164f491ddSJed Brown .seealso: TSARKIMEX
12264f491ddSJed Brown M*/
12364f491ddSJed Brown /*MC
12464f491ddSJed Brown      TSARKIMEX2E - Second order ARK IMEX scheme with L-stable implicit part.
12564f491ddSJed Brown 
12664f491ddSJed Brown      This method has one explicit stage and two implicit stages. It is is an optimal method developed by Emil Constantinescu.
12764f491ddSJed Brown 
128b330ce4dSSatish Balay      Level: advanced
129b330ce4dSSatish Balay 
13064f491ddSJed Brown .seealso: TSARKIMEX
13164f491ddSJed Brown M*/
13264f491ddSJed Brown /*MC
1336cf0794eSJed Brown      TSARKIMEXPRSSP2 - Second order SSP ARK IMEX scheme.
1346cf0794eSJed Brown 
1356cf0794eSJed Brown      This method has three implicit stages.
1366cf0794eSJed Brown 
1376cf0794eSJed Brown      References:
13896a0c994SBarry Smith .   1. -  L. Pareschi, G. Russo, Implicit Explicit Runge Kutta schemes and applications to hyperbolic systems with relaxations. Journal of Scientific Computing Volume: 25, Issue: 1, October, 2005.
1396cf0794eSJed Brown 
1406cf0794eSJed Brown      This method is referred to as SSP2-(3,3,2) in http://arxiv.org/abs/1110.4375
1416cf0794eSJed Brown 
1426cf0794eSJed Brown      Level: advanced
1436cf0794eSJed Brown 
1446cf0794eSJed Brown .seealso: TSARKIMEX
1456cf0794eSJed Brown M*/
1466cf0794eSJed Brown /*MC
14764f491ddSJed Brown      TSARKIMEX3 - Third order ARK IMEX scheme with L-stable implicit part.
14864f491ddSJed Brown 
14964f491ddSJed Brown      This method has one explicit stage and three implicit stages.
15064f491ddSJed Brown 
15164f491ddSJed Brown      References:
15296a0c994SBarry Smith .   1. -  Kennedy and Carpenter 2003.
15364f491ddSJed Brown 
154b330ce4dSSatish Balay      Level: advanced
155b330ce4dSSatish Balay 
15664f491ddSJed Brown .seealso: TSARKIMEX
15764f491ddSJed Brown M*/
15864f491ddSJed Brown /*MC
1596cf0794eSJed Brown      TSARKIMEXARS443 - Third order ARK IMEX scheme.
1606cf0794eSJed Brown 
1616cf0794eSJed Brown      This method has one explicit stage and four implicit stages.
1626cf0794eSJed Brown 
1636cf0794eSJed Brown      References:
16496a0c994SBarry Smith +   1. -  U. Ascher, S. Ruuth, R. J. Spiteri, Implicit explicit Runge Kutta methods for time dependent Partial Differential Equations. Appl. Numer. Math. 25, (1997).
16596a0c994SBarry Smith -   2. -  This method is referred to as ARS(4,4,3) in http://arxiv.org/abs/1110.4375
1666cf0794eSJed Brown 
1676cf0794eSJed Brown      Level: advanced
1686cf0794eSJed Brown 
1696cf0794eSJed Brown .seealso: TSARKIMEX
1706cf0794eSJed Brown M*/
1716cf0794eSJed Brown /*MC
1726cf0794eSJed Brown      TSARKIMEXBPR3 - Third order ARK IMEX scheme.
1736cf0794eSJed Brown 
1746cf0794eSJed Brown      This method has one explicit stage and four implicit stages.
1756cf0794eSJed Brown 
1766cf0794eSJed Brown      References:
17796a0c994SBarry Smith  .    This method is referred to as ARK3 in http://arxiv.org/abs/1110.4375
1786cf0794eSJed Brown 
1796cf0794eSJed Brown      Level: advanced
1806cf0794eSJed Brown 
1816cf0794eSJed Brown .seealso: TSARKIMEX
1826cf0794eSJed Brown M*/
1836cf0794eSJed Brown /*MC
18464f491ddSJed Brown      TSARKIMEX4 - Fourth order ARK IMEX scheme with L-stable implicit part.
18564f491ddSJed Brown 
18664f491ddSJed Brown      This method has one explicit stage and four implicit stages.
18764f491ddSJed Brown 
18864f491ddSJed Brown      References:
18996a0c994SBarry Smith .     Kennedy and Carpenter 2003.
19064f491ddSJed Brown 
191b330ce4dSSatish Balay      Level: advanced
192b330ce4dSSatish Balay 
19364f491ddSJed Brown .seealso: TSARKIMEX
19464f491ddSJed Brown M*/
19564f491ddSJed Brown /*MC
19664f491ddSJed Brown      TSARKIMEX5 - Fifth order ARK IMEX scheme with L-stable implicit part.
19764f491ddSJed Brown 
19864f491ddSJed Brown      This method has one explicit stage and five implicit stages.
19964f491ddSJed Brown 
20064f491ddSJed Brown      References:
20196a0c994SBarry Smith .     Kennedy and Carpenter 2003.
20264f491ddSJed Brown 
203b330ce4dSSatish Balay      Level: advanced
204b330ce4dSSatish Balay 
20564f491ddSJed Brown .seealso: TSARKIMEX
20664f491ddSJed Brown M*/
20764f491ddSJed Brown 
2088a381b04SJed Brown #undef __FUNCT__
2098a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegisterAll"
2108a381b04SJed Brown /*@C
2118a381b04SJed Brown   TSARKIMEXRegisterAll - Registers all of the additive Runge-Kutta implicit-explicit methods in TSARKIMEX
2128a381b04SJed Brown 
213fca742c7SJed Brown   Not Collective, but should be called by all processes which will need the schemes to be registered
2148a381b04SJed Brown 
2158a381b04SJed Brown   Level: advanced
2168a381b04SJed Brown 
2178a381b04SJed Brown .keywords: TS, TSARKIMEX, register, all
2188a381b04SJed Brown 
2198a381b04SJed Brown .seealso:  TSARKIMEXRegisterDestroy()
2208a381b04SJed Brown @*/
2218a381b04SJed Brown PetscErrorCode TSARKIMEXRegisterAll(void)
2228a381b04SJed Brown {
2238a381b04SJed Brown   PetscErrorCode ierr;
2248a381b04SJed Brown 
2258a381b04SJed Brown   PetscFunctionBegin;
2268a381b04SJed Brown   if (TSARKIMEXRegisterAllCalled) PetscFunctionReturn(0);
2278a381b04SJed Brown   TSARKIMEXRegisterAllCalled = PETSC_TRUE;
228e817cc15SEmil Constantinescu 
229e817cc15SEmil Constantinescu   {
230e817cc15SEmil Constantinescu     const PetscReal
231e817cc15SEmil Constantinescu       A[3][3] = {{0.0,0.0,0.0},
232e817cc15SEmil Constantinescu                  {0.0,0.0,0.0},
233748ad121SEmil Constantinescu                  {0.0,0.5,0.0}},
234e817cc15SEmil Constantinescu       At[3][3] = {{1.0,0.0,0.0},
235e817cc15SEmil Constantinescu                   {0.0,0.5,0.0},
236e817cc15SEmil Constantinescu                   {0.0,0.5,0.5}},
237e817cc15SEmil Constantinescu       b[3]       = {0.0,0.5,0.5},
238e817cc15SEmil Constantinescu       bembedt[3] = {1.0,0.0,0.0};
2390298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX1BEE,2,3,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
240e817cc15SEmil Constantinescu   }
2418a381b04SJed Brown   {
2428a381b04SJed Brown     const PetscReal
2431f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2441f80e275SEmil Constantinescu                  {0.5,0.0}},
2451f80e275SEmil Constantinescu       At[2][2] = {{0.0,0.0},
2461f80e275SEmil Constantinescu                   {0.0,0.5}},
2471f80e275SEmil Constantinescu       b[2]       = {0.0,1.0},
2481f80e275SEmil Constantinescu       bembedt[2] = {0.5,0.5};
2491f80e275SEmil Constantinescu     /* binterpt[2][2] = {{1.0,-1.0},{0.0,1.0}};  second order dense output has poor stability properties and hence it is not currently in use*/
2500298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXARS122,2,2,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
2511f80e275SEmil Constantinescu   }
2521f80e275SEmil Constantinescu   {
2531f80e275SEmil Constantinescu     const PetscReal
2541f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2551f80e275SEmil Constantinescu                  {1.0,0.0}},
2561f80e275SEmil Constantinescu       At[2][2] = {{0.0,0.0},
2571f80e275SEmil Constantinescu                   {0.5,0.5}},
2581f80e275SEmil Constantinescu       b[2]       = {0.5,0.5},
2591f80e275SEmil Constantinescu       bembedt[2] = {0.0,1.0};
2601f80e275SEmil Constantinescu     /* binterpt[2][2] = {{1.0,-0.5},{0.0,0.5}}  second order dense output has poor stability properties and hence it is not currently in use*/
2610298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXA2,2,2,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
2621f80e275SEmil Constantinescu   }
2631f80e275SEmil Constantinescu   {
264da80777bSKarl Rupp     /* const PetscReal us2 = 1.0-1.0/PetscSqrtReal((PetscReal)2.0);    Direct evaluation: 0.2928932188134524755992. Used below to ensure all values are available at compile time   */
2651f80e275SEmil Constantinescu     const PetscReal
2661f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2671f80e275SEmil Constantinescu                  {1.0,0.0}},
268da80777bSKarl Rupp       At[2][2] = {{0.2928932188134524755992,0.0},
269da80777bSKarl Rupp                   {1.0-2.0*0.2928932188134524755992,0.2928932188134524755992}},
2701f80e275SEmil Constantinescu       b[2]       = {0.5,0.5},
2711f80e275SEmil Constantinescu       bembedt[2] = {0.0,1.0},
272da80777bSKarl Rupp       binterpt[2][2] = {{  (0.2928932188134524755992-1.0)/(2.0*0.2928932188134524755992-1.0),-1/(2.0*(1.0-2.0*0.2928932188134524755992))},
273da80777bSKarl Rupp                         {1-(0.2928932188134524755992-1.0)/(2.0*0.2928932188134524755992-1.0),-1/(2.0*(1.0-2.0*0.2928932188134524755992))}},
2741f80e275SEmil Constantinescu       binterp[2][2] = {{1.0,-0.5},{0.0,0.5}};
2750298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXL2,2,2,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,2,binterpt[0],binterp[0]);CHKERRQ(ierr);
2761f80e275SEmil Constantinescu   }
2771f80e275SEmil Constantinescu   {
278da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
279da80777bSKarl Rupp     const PetscReal
2808a381b04SJed Brown       A[3][3] = {{0,0,0},
281da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
282617a39beSEmil Constantinescu                  {0.5,0.5,0}},
283da80777bSKarl Rupp       At[3][3] = {{0,0,0},
284da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
285da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
286da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
287da80777bSKarl Rupp       binterpt[3][2] = {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
288da80777bSKarl Rupp                         {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
289da80777bSKarl Rupp                         {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
2900298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2C,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
2911f80e275SEmil Constantinescu   }
2921f80e275SEmil Constantinescu   {
293da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
294da80777bSKarl Rupp     const PetscReal
2951f80e275SEmil Constantinescu       A[3][3] = {{0,0,0},
296da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
2978a381b04SJed Brown                  {0.75,0.25,0}},
298da80777bSKarl Rupp       At[3][3] = {{0,0,0},
299da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
300da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
301da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
302da80777bSKarl Rupp       binterpt[3][2] =  {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
303da80777bSKarl Rupp                          {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
304da80777bSKarl Rupp                          {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
3050298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2D,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
3068a381b04SJed Brown   }
30706db7b1cSJed Brown   {                             /* Optimal for linear implicit part */
308da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
309da80777bSKarl Rupp     const PetscReal
310da80777bSKarl Rupp       A[3][3] = {{0,0,0},
311da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
312da80777bSKarl Rupp                  {(3-2*1.414213562373095048802)/6,(3+2*1.414213562373095048802)/6,0}},
313da80777bSKarl Rupp       At[3][3] = {{0,0,0},
314da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
315da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
316da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
317da80777bSKarl Rupp       binterpt[3][2] =  {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
318da80777bSKarl Rupp                          {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
319da80777bSKarl Rupp                          {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
3200298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2E,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
321a3a57f36SJed Brown   }
3226cf0794eSJed Brown   {                             /* Optimal for linear implicit part */
3236cf0794eSJed Brown     const PetscReal
3246cf0794eSJed Brown       A[3][3] = {{0,0,0},
3256cf0794eSJed Brown                  {0.5,0,0},
3266cf0794eSJed Brown                  {0.5,0.5,0}},
3276cf0794eSJed Brown       At[3][3] = {{0.25,0,0},
3286cf0794eSJed Brown                   {0,0.25,0},
3296cf0794eSJed Brown                   {1./3,1./3,1./3}};
3300298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXPRSSP2,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,NULL,NULL,0,NULL,NULL);CHKERRQ(ierr);
3316cf0794eSJed Brown   }
332a3a57f36SJed Brown   {
333a3a57f36SJed Brown     const PetscReal
334a3a57f36SJed Brown       A[4][4] = {{0,0,0,0},
3354040e9f2SJed Brown                  {1767732205903./2027836641118.,0,0,0},
3364040e9f2SJed Brown                  {5535828885825./10492691773637.,788022342437./10882634858940.,0,0},
3374040e9f2SJed Brown                  {6485989280629./16251701735622.,-4246266847089./9704473918619.,10755448449292./10357097424841.,0}},
338a3a57f36SJed Brown       At[4][4] = {{0,0,0,0},
3394040e9f2SJed Brown                   {1767732205903./4055673282236.,1767732205903./4055673282236.,0,0},
3404040e9f2SJed Brown                   {2746238789719./10658868560708.,-640167445237./6845629431997.,1767732205903./4055673282236.,0},
3414040e9f2SJed Brown                   {1471266399579./7840856788654.,-4482444167858./7529755066697.,11266239266428./11593286722821.,1767732205903./4055673282236.}},
342cc46b9d1SJed Brown       bembedt[4]     = {2756255671327./12835298489170.,-10771552573575./22201958757719.,9247589265047./10645013368117.,2193209047091./5459859503100.},
3434040e9f2SJed Brown       binterpt[4][2] = {{4655552711362./22874653954995., -215264564351./13552729205753.},
3444040e9f2SJed Brown                         {-18682724506714./9892148508045.,17870216137069./13817060693119.},
3454040e9f2SJed Brown                         {34259539580243./13192909600954.,-28141676662227./17317692491321.},
3464040e9f2SJed Brown                         {584795268549./6622622206610.,   2508943948391./7218656332882.}};
3470298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX3,3,4,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
348a3a57f36SJed Brown   }
349a3a57f36SJed Brown   {
350a3a57f36SJed Brown     const PetscReal
351e74514c0SSatish Balay       A[5][5] = {{0,0,0,0,0},
3526cf0794eSJed Brown                  {1./2,0,0,0,0},
3536cf0794eSJed Brown                  {11./18,1./18,0,0,0},
3546cf0794eSJed Brown                  {5./6,-5./6,.5,0,0},
3556cf0794eSJed Brown                  {1./4,7./4,3./4,-7./4,0}},
3566cf0794eSJed Brown       At[5][5] = {{0,0,0,0,0},
3576cf0794eSJed Brown                   {0,1./2,0,0,0},
3586cf0794eSJed Brown                   {0,1./6,1./2,0,0},
3596cf0794eSJed Brown                   {0,-1./2,1./2,1./2,0},
360108c343cSJed Brown                   {0,3./2,-3./2,1./2,1./2}},
3610298fd71SBarry Smith     *bembedt = NULL;
3620298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXARS443,3,5,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,0,NULL,NULL);CHKERRQ(ierr);
3636cf0794eSJed Brown   }
3646cf0794eSJed Brown   {
3656cf0794eSJed Brown     const PetscReal
366e74514c0SSatish Balay       A[5][5] = {{0,0,0,0,0},
3676cf0794eSJed Brown                  {1,0,0,0,0},
3686cf0794eSJed Brown                  {4./9,2./9,0,0,0},
3696cf0794eSJed Brown                  {1./4,0,3./4,0,0},
3706cf0794eSJed Brown                  {1./4,0,3./5,0,0}},
371e74514c0SSatish Balay       At[5][5] = {{0,0,0,0,0},
3726cf0794eSJed Brown                   {.5,.5,0,0,0},
3736cf0794eSJed Brown                   {5./18,-1./9,.5,0,0},
3746cf0794eSJed Brown                   {.5,0,0,.5,0},
375108c343cSJed Brown                   {.25,0,.75,-.5,.5}},
3760298fd71SBarry Smith     *bembedt = NULL;
3770298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXBPR3,3,5,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,0,NULL,NULL);CHKERRQ(ierr);
3786cf0794eSJed Brown   }
3796cf0794eSJed Brown   {
3806cf0794eSJed Brown     const PetscReal
381a3a57f36SJed Brown       A[6][6] = {{0,0,0,0,0,0},
382a3a57f36SJed Brown                  {1./2,0,0,0,0,0},
3834040e9f2SJed Brown                  {13861./62500.,6889./62500.,0,0,0,0},
3844040e9f2SJed Brown                  {-116923316275./2393684061468.,-2731218467317./15368042101831.,9408046702089./11113171139209.,0,0,0},
3854040e9f2SJed Brown                  {-451086348788./2902428689909.,-2682348792572./7519795681897.,12662868775082./11960479115383.,3355817975965./11060851509271.,0,0},
3864040e9f2SJed Brown                  {647845179188./3216320057751.,73281519250./8382639484533.,552539513391./3454668386233.,3354512671639./8306763924573.,4040./17871.,0}},
387a3a57f36SJed Brown       At[6][6] = {{0,0,0,0,0,0},
388a3a57f36SJed Brown                   {1./4,1./4,0,0,0,0},
3894040e9f2SJed Brown                   {8611./62500.,-1743./31250.,1./4,0,0,0},
3904040e9f2SJed Brown                   {5012029./34652500.,-654441./2922500.,174375./388108.,1./4,0,0},
3914040e9f2SJed Brown                   {15267082809./155376265600.,-71443401./120774400.,730878875./902184768.,2285395./8070912.,1./4,0},
3924040e9f2SJed Brown                   {82889./524892.,0,15625./83664.,69875./102672.,-2260./8211,1./4}},
393cc46b9d1SJed Brown       bembedt[6]     = {4586570599./29645900160.,0,178811875./945068544.,814220225./1159782912.,-3700637./11593932.,61727./225920.},
3944040e9f2SJed Brown       binterpt[6][3] = {{6943876665148./7220017795957.,-54480133./30881146.,6818779379841./7100303317025.},
395cd652676SJed Brown                         {0,0,0},
3964040e9f2SJed Brown                         {7640104374378./9702883013639.,-11436875./14766696.,2173542590792./12501825683035.},
3974040e9f2SJed Brown                         {-20649996744609./7521556579894.,174696575./18121608.,-31592104683404./5083833661969.},
3984040e9f2SJed Brown                         {8854892464581./2390941311638.,-12120380./966161.,61146701046299./7138195549469.},
3994040e9f2SJed Brown                         {-11397109935349./6675773540249.,3843./706.,-17219254887155./4939391667607.}};
4000298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX4,4,6,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,3,binterpt[0],NULL);CHKERRQ(ierr);
401a3a57f36SJed Brown   }
402a3a57f36SJed Brown   {
403a3a57f36SJed Brown     const PetscReal
404a3a57f36SJed Brown       A[8][8] = {{0,0,0,0,0,0,0,0},
405a3a57f36SJed Brown                  {41./100,0,0,0,0,0,0,0},
4064040e9f2SJed Brown                  {367902744464./2072280473677.,677623207551./8224143866563.,0,0,0,0,0,0},
4074040e9f2SJed Brown                  {1268023523408./10340822734521.,0,1029933939417./13636558850479.,0,0,0,0,0},
4084040e9f2SJed Brown                  {14463281900351./6315353703477.,0,66114435211212./5879490589093.,-54053170152839./4284798021562.,0,0,0,0},
4094040e9f2SJed Brown                  {14090043504691./34967701212078.,0,15191511035443./11219624916014.,-18461159152457./12425892160975.,-281667163811./9011619295870.,0,0,0},
4104040e9f2SJed Brown                  {19230459214898./13134317526959.,0,21275331358303./2942455364971.,-38145345988419./4862620318723.,-1./8,-1./8,0,0},
4114040e9f2SJed Brown                  {-19977161125411./11928030595625.,0,-40795976796054./6384907823539.,177454434618887./12078138498510.,782672205425./8267701900261.,-69563011059811./9646580694205.,7356628210526./4942186776405.,0}},
412a3a57f36SJed Brown       At[8][8] = {{0,0,0,0,0,0,0,0},
4134040e9f2SJed Brown                   {41./200.,41./200.,0,0,0,0,0,0},
4144040e9f2SJed Brown                   {41./400.,-567603406766./11931857230679.,41./200.,0,0,0,0,0},
4154040e9f2SJed Brown                   {683785636431./9252920307686.,0,-110385047103./1367015193373.,41./200.,0,0,0,0},
4164040e9f2SJed Brown                   {3016520224154./10081342136671.,0,30586259806659./12414158314087.,-22760509404356./11113319521817.,41./200.,0,0,0},
4174040e9f2SJed Brown                   {218866479029./1489978393911.,0,638256894668./5436446318841.,-1179710474555./5321154724896.,-60928119172./8023461067671.,41./200.,0,0},
4184040e9f2SJed Brown                   {1020004230633./5715676835656.,0,25762820946817./25263940353407.,-2161375909145./9755907335909.,-211217309593./5846859502534.,-4269925059573./7827059040749.,41./200,0},
4194040e9f2SJed Brown                   {-872700587467./9133579230613.,0,0,22348218063261./9555858737531.,-1143369518992./8141816002931.,-39379526789629./19018526304540.,32727382324388./42900044865799.,41./200.}},
420cc46b9d1SJed Brown       bembedt[8]     = {-975461918565./9796059967033.,0,0,78070527104295./32432590147079.,-548382580838./3424219808633.,-33438840321285./15594753105479.,3629800801594./4656183773603.,4035322873751./18575991585200.},
4214040e9f2SJed Brown       binterpt[8][3] = {{-17674230611817./10670229744614.,  43486358583215./12773830924787., -9257016797708./5021505065439.},
422cd652676SJed Brown                         {0,  0, 0                            },
423cd652676SJed Brown                         {0,  0, 0                            },
4244040e9f2SJed Brown                         {65168852399939./7868540260826.,  -91478233927265./11067650958493., 26096422576131./11239449250142.},
4254040e9f2SJed Brown                         {15494834004392./5936557850923.,  -79368583304911./10890268929626., 92396832856987./20362823103730.},
4264040e9f2SJed Brown                         {-99329723586156./26959484932159.,  -12239297817655./9152339842473., 30029262896817./10175596800299.},
4274040e9f2SJed Brown                         {-19024464361622./5461577185407.,  115839755401235./10719374521269., -26136350496073./3983972220547.},
4284040e9f2SJed Brown                         {-6511271360970./6095937251113.,  5843115559534./2180450260947., -5289405421727./3760307252460. }};
4290298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX5,5,8,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,3,binterpt[0],NULL);CHKERRQ(ierr);
430a3a57f36SJed Brown   }
4318a381b04SJed Brown   PetscFunctionReturn(0);
4328a381b04SJed Brown }
4338a381b04SJed Brown 
4348a381b04SJed Brown #undef __FUNCT__
4358a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegisterDestroy"
4368a381b04SJed Brown /*@C
4378a381b04SJed Brown    TSARKIMEXRegisterDestroy - Frees the list of schemes that were registered by TSARKIMEXRegister().
4388a381b04SJed Brown 
4398a381b04SJed Brown    Not Collective
4408a381b04SJed Brown 
4418a381b04SJed Brown    Level: advanced
4428a381b04SJed Brown 
4438a381b04SJed Brown .keywords: TSARKIMEX, register, destroy
444607a6623SBarry Smith .seealso: TSARKIMEXRegister(), TSARKIMEXRegisterAll()
4458a381b04SJed Brown @*/
4468a381b04SJed Brown PetscErrorCode TSARKIMEXRegisterDestroy(void)
4478a381b04SJed Brown {
4488a381b04SJed Brown   PetscErrorCode ierr;
4498a381b04SJed Brown   ARKTableauLink link;
4508a381b04SJed Brown 
4518a381b04SJed Brown   PetscFunctionBegin;
4528a381b04SJed Brown   while ((link = ARKTableauList)) {
4538a381b04SJed Brown     ARKTableau t = &link->tab;
4548a381b04SJed Brown     ARKTableauList = link->next;
4558a381b04SJed Brown     ierr = PetscFree6(t->At,t->bt,t->ct,t->A,t->b,t->c);CHKERRQ(ierr);
456108c343cSJed Brown     ierr = PetscFree2(t->bembedt,t->bembed);CHKERRQ(ierr);
457cd652676SJed Brown     ierr = PetscFree2(t->binterpt,t->binterp);CHKERRQ(ierr);
4588a381b04SJed Brown     ierr = PetscFree(t->name);CHKERRQ(ierr);
4598a381b04SJed Brown     ierr = PetscFree(link);CHKERRQ(ierr);
4608a381b04SJed Brown   }
4618a381b04SJed Brown   TSARKIMEXRegisterAllCalled = PETSC_FALSE;
4628a381b04SJed Brown   PetscFunctionReturn(0);
4638a381b04SJed Brown }
4648a381b04SJed Brown 
4658a381b04SJed Brown #undef __FUNCT__
4668a381b04SJed Brown #define __FUNCT__ "TSARKIMEXInitializePackage"
4678a381b04SJed Brown /*@C
4688a381b04SJed Brown   TSARKIMEXInitializePackage - This function initializes everything in the TSARKIMEX package. It is called
4698a381b04SJed Brown   from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to TSCreate_ARKIMEX()
4708a381b04SJed Brown   when using static libraries.
4718a381b04SJed Brown 
4728a381b04SJed Brown   Level: developer
4738a381b04SJed Brown 
4748a381b04SJed Brown .keywords: TS, TSARKIMEX, initialize, package
4758a381b04SJed Brown .seealso: PetscInitialize()
4768a381b04SJed Brown @*/
477607a6623SBarry Smith PetscErrorCode TSARKIMEXInitializePackage(void)
4788a381b04SJed Brown {
4798a381b04SJed Brown   PetscErrorCode ierr;
4808a381b04SJed Brown 
4818a381b04SJed Brown   PetscFunctionBegin;
4828a381b04SJed Brown   if (TSARKIMEXPackageInitialized) PetscFunctionReturn(0);
4838a381b04SJed Brown   TSARKIMEXPackageInitialized = PETSC_TRUE;
4848a381b04SJed Brown   ierr = TSARKIMEXRegisterAll();CHKERRQ(ierr);
485e817cc15SEmil Constantinescu   ierr = PetscObjectComposedDataRegister(&explicit_stage_time_id);CHKERRQ(ierr);
4868a381b04SJed Brown   ierr = PetscRegisterFinalize(TSARKIMEXFinalizePackage);CHKERRQ(ierr);
4878a381b04SJed Brown   PetscFunctionReturn(0);
4888a381b04SJed Brown }
4898a381b04SJed Brown 
4908a381b04SJed Brown #undef __FUNCT__
4918a381b04SJed Brown #define __FUNCT__ "TSARKIMEXFinalizePackage"
4928a381b04SJed Brown /*@C
4938a381b04SJed Brown   TSARKIMEXFinalizePackage - This function destroys everything in the TSARKIMEX package. It is
4948a381b04SJed Brown   called from PetscFinalize().
4958a381b04SJed Brown 
4968a381b04SJed Brown   Level: developer
4978a381b04SJed Brown 
4988a381b04SJed Brown .keywords: Petsc, destroy, package
4998a381b04SJed Brown .seealso: PetscFinalize()
5008a381b04SJed Brown @*/
5018a381b04SJed Brown PetscErrorCode TSARKIMEXFinalizePackage(void)
5028a381b04SJed Brown {
5038a381b04SJed Brown   PetscErrorCode ierr;
5048a381b04SJed Brown 
5058a381b04SJed Brown   PetscFunctionBegin;
5068a381b04SJed Brown   TSARKIMEXPackageInitialized = PETSC_FALSE;
5078a381b04SJed Brown   ierr = TSARKIMEXRegisterDestroy();CHKERRQ(ierr);
5088a381b04SJed Brown   PetscFunctionReturn(0);
5098a381b04SJed Brown }
5108a381b04SJed Brown 
5118a381b04SJed Brown #undef __FUNCT__
5128a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegister"
513cd652676SJed Brown /*@C
514cd652676SJed Brown    TSARKIMEXRegister - register an ARK IMEX scheme by providing the entries in the Butcher tableau and optionally embedded approximations and interpolation
515cd652676SJed Brown 
516cd652676SJed Brown    Not Collective, but the same schemes should be registered on all processes on which they will be used
517cd652676SJed Brown 
518cd652676SJed Brown    Input Parameters:
519cd652676SJed Brown +  name - identifier for method
520cd652676SJed Brown .  order - approximation order of method
521cd652676SJed Brown .  s - number of stages, this is the dimension of the matrices below
522cd652676SJed Brown .  At - Butcher table of stage coefficients for stiff part (dimension s*s, row-major)
5230298fd71SBarry Smith .  bt - Butcher table for completing the stiff part of the step (dimension s; NULL to use the last row of At)
5240298fd71SBarry Smith .  ct - Abscissa of each stiff stage (dimension s, NULL to use row sums of At)
525cd652676SJed Brown .  A - Non-stiff stage coefficients (dimension s*s, row-major)
5260298fd71SBarry Smith .  b - Non-stiff step completion table (dimension s; NULL to use last row of At)
5270298fd71SBarry Smith .  c - Non-stiff abscissa (dimension s; NULL to use row sums of A)
5280298fd71SBarry Smith .  bembedt - Stiff part of completion table for embedded method (dimension s; NULL if not available)
5290298fd71SBarry Smith .  bembed - Non-stiff part of completion table for embedded method (dimension s; NULL to use bembedt if provided)
530cd652676SJed Brown .  pinterp - Order of the interpolation scheme, equal to the number of columns of binterpt and binterp
531cd652676SJed Brown .  binterpt - Coefficients of the interpolation formula for the stiff part (dimension s*pinterp)
5320298fd71SBarry Smith -  binterp - Coefficients of the interpolation formula for the non-stiff part (dimension s*pinterp; NULL to reuse binterpt)
533cd652676SJed Brown 
534cd652676SJed Brown    Notes:
535cd652676SJed Brown    Several ARK IMEX methods are provided, this function is only needed to create new methods.
536cd652676SJed Brown 
537cd652676SJed Brown    Level: advanced
538cd652676SJed Brown 
539cd652676SJed Brown .keywords: TS, register
540cd652676SJed Brown 
541cd652676SJed Brown .seealso: TSARKIMEX
542cd652676SJed Brown @*/
54319fd82e9SBarry Smith PetscErrorCode TSARKIMEXRegister(TSARKIMEXType name,PetscInt order,PetscInt s,
5448a381b04SJed Brown                                  const PetscReal At[],const PetscReal bt[],const PetscReal ct[],
545cd652676SJed Brown                                  const PetscReal A[],const PetscReal b[],const PetscReal c[],
546108c343cSJed Brown                                  const PetscReal bembedt[],const PetscReal bembed[],
547cd652676SJed Brown                                  PetscInt pinterp,const PetscReal binterpt[],const PetscReal binterp[])
5488a381b04SJed Brown {
5498a381b04SJed Brown   PetscErrorCode ierr;
5508a381b04SJed Brown   ARKTableauLink link;
5518a381b04SJed Brown   ARKTableau     t;
5528a381b04SJed Brown   PetscInt       i,j;
5538a381b04SJed Brown 
5548a381b04SJed Brown   PetscFunctionBegin;
5551795a4d1SJed Brown   ierr     = PetscCalloc1(1,&link);CHKERRQ(ierr);
5568a381b04SJed Brown   t        = &link->tab;
5578a381b04SJed Brown   ierr     = PetscStrallocpy(name,&t->name);CHKERRQ(ierr);
5588a381b04SJed Brown   t->order = order;
5598a381b04SJed Brown   t->s     = s;
560dcca6d9dSJed Brown   ierr     = PetscMalloc6(s*s,&t->At,s,&t->bt,s,&t->ct,s*s,&t->A,s,&t->b,s,&t->c);CHKERRQ(ierr);
5618a381b04SJed Brown   ierr     = PetscMemcpy(t->At,At,s*s*sizeof(At[0]));CHKERRQ(ierr);
5628a381b04SJed Brown   ierr     = PetscMemcpy(t->A,A,s*s*sizeof(A[0]));CHKERRQ(ierr);
5638a381b04SJed Brown   if (bt) { ierr = PetscMemcpy(t->bt,bt,s*sizeof(bt[0]));CHKERRQ(ierr); }
5648a381b04SJed Brown   else for (i=0; i<s; i++) t->bt[i] = At[(s-1)*s+i];
5658a381b04SJed Brown   if (b)  { ierr = PetscMemcpy(t->b,b,s*sizeof(b[0]));CHKERRQ(ierr); }
5665dceddf7SDebojyoti Ghosh   else for (i=0; i<s; i++) t->b[i] = t->bt[i];
5678a381b04SJed Brown   if (ct) { ierr = PetscMemcpy(t->ct,ct,s*sizeof(ct[0]));CHKERRQ(ierr); }
5688a381b04SJed Brown   else for (i=0; i<s; i++) for (j=0,t->ct[i]=0; j<s; j++) t->ct[i] += At[i*s+j];
5698a381b04SJed Brown   if (c)  { ierr = PetscMemcpy(t->c,c,s*sizeof(c[0]));CHKERRQ(ierr); }
5708a381b04SJed Brown   else for (i=0; i<s; i++) for (j=0,t->c[i]=0; j<s; j++) t->c[i] += A[i*s+j];
571e817cc15SEmil Constantinescu   t->stiffly_accurate = PETSC_TRUE;
572e817cc15SEmil Constantinescu   for (i=0; i<s; i++) if (t->At[(s-1)*s+i] != t->bt[i]) t->stiffly_accurate = PETSC_FALSE;
573e817cc15SEmil Constantinescu   t->explicit_first_stage = PETSC_TRUE;
574e817cc15SEmil Constantinescu   for (i=0; i<s; i++) if (t->At[i] != 0.0) t->explicit_first_stage = PETSC_FALSE;
575e817cc15SEmil Constantinescu   /*def of FSAL can be made more precise*/
5764e9d4bf5SJed Brown   t->FSAL_implicit = (PetscBool)(t->explicit_first_stage && t->stiffly_accurate);
577108c343cSJed Brown   if (bembedt) {
578dcca6d9dSJed Brown     ierr = PetscMalloc2(s,&t->bembedt,s,&t->bembed);CHKERRQ(ierr);
579108c343cSJed Brown     ierr = PetscMemcpy(t->bembedt,bembedt,s*sizeof(bembedt[0]));CHKERRQ(ierr);
580108c343cSJed Brown     ierr = PetscMemcpy(t->bembed,bembed ? bembed : bembedt,s*sizeof(bembed[0]));CHKERRQ(ierr);
581108c343cSJed Brown   }
582108c343cSJed Brown 
5834f385281SJed Brown   t->pinterp     = pinterp;
584dcca6d9dSJed Brown   ierr           = PetscMalloc2(s*pinterp,&t->binterpt,s*pinterp,&t->binterp);CHKERRQ(ierr);
585cd652676SJed Brown   ierr           = PetscMemcpy(t->binterpt,binterpt,s*pinterp*sizeof(binterpt[0]));CHKERRQ(ierr);
586cd652676SJed Brown   ierr           = PetscMemcpy(t->binterp,binterp ? binterp : binterpt,s*pinterp*sizeof(binterpt[0]));CHKERRQ(ierr);
5878a381b04SJed Brown   link->next     = ARKTableauList;
5888a381b04SJed Brown   ARKTableauList = link;
5898a381b04SJed Brown   PetscFunctionReturn(0);
5908a381b04SJed Brown }
5918a381b04SJed Brown 
5928a381b04SJed Brown #undef __FUNCT__
593108c343cSJed Brown #define __FUNCT__ "TSEvaluateStep_ARKIMEX"
594108c343cSJed Brown /*
595108c343cSJed Brown  The step completion formula is
596108c343cSJed Brown 
597108c343cSJed Brown  x1 = x0 - h bt^T YdotI + h b^T YdotRHS
598108c343cSJed Brown 
599108c343cSJed Brown  This function can be called before or after ts->vec_sol has been updated.
600108c343cSJed Brown  Suppose we have a completion formula (bt,b) and an embedded formula (bet,be) of different order.
601108c343cSJed Brown  We can write
602108c343cSJed Brown 
603108c343cSJed Brown  x1e = x0 - h bet^T YdotI + h be^T YdotRHS
604108c343cSJed Brown      = x1 + h bt^T YdotI - h b^T YdotRHS - h bet^T YdotI + h be^T YdotRHS
605108c343cSJed Brown      = x1 - h (bet - bt)^T YdotI + h (be - b)^T YdotRHS
606108c343cSJed Brown 
607108c343cSJed Brown  so we can evaluate the method with different order even after the step has been optimistically completed.
608108c343cSJed Brown */
609108c343cSJed Brown static PetscErrorCode TSEvaluateStep_ARKIMEX(TS ts,PetscInt order,Vec X,PetscBool *done)
610108c343cSJed Brown {
611108c343cSJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
612108c343cSJed Brown   ARKTableau     tab  = ark->tableau;
613108c343cSJed Brown   PetscScalar    *w   = ark->work;
614108c343cSJed Brown   PetscReal      h;
615108c343cSJed Brown   PetscInt       s = tab->s,j;
616108c343cSJed Brown   PetscErrorCode ierr;
617108c343cSJed Brown 
618108c343cSJed Brown   PetscFunctionBegin;
619108c343cSJed Brown   switch (ark->status) {
620108c343cSJed Brown   case TS_STEP_INCOMPLETE:
621108c343cSJed Brown   case TS_STEP_PENDING:
622108c343cSJed Brown     h = ts->time_step; break;
623108c343cSJed Brown   case TS_STEP_COMPLETE:
624108c343cSJed Brown     h = ts->time_step_prev; break;
625ce94432eSBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Invalid TSStepStatus");
626108c343cSJed Brown   }
627108c343cSJed Brown   if (order == tab->order) {
628e817cc15SEmil Constantinescu     if (ark->status == TS_STEP_INCOMPLETE) {
629740132f1SEmil Constantinescu       if (!ark->imex && tab->stiffly_accurate) { /* Only the stiffly accurate implicit formula is used */
630e817cc15SEmil Constantinescu         ierr = VecCopy(ark->Y[s-1],X);CHKERRQ(ierr);
631e817cc15SEmil Constantinescu       } else { /* Use the standard completion formula (bt,b) */
632108c343cSJed Brown         ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
633e817cc15SEmil Constantinescu         for (j=0; j<s; j++) w[j] = h*tab->bt[j];
634108c343cSJed Brown         ierr = VecMAXPY(X,s,w,ark->YdotI);CHKERRQ(ierr);
635e817cc15SEmil Constantinescu         if (ark->imex) { /* Method is IMEX, complete the explicit formula */
636108c343cSJed Brown           for (j=0; j<s; j++) w[j] = h*tab->b[j];
637108c343cSJed Brown           ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
638e817cc15SEmil Constantinescu         }
639e817cc15SEmil Constantinescu       }
640108c343cSJed Brown     } else {ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);}
641108c343cSJed Brown     if (done) *done = PETSC_TRUE;
642108c343cSJed Brown     PetscFunctionReturn(0);
643108c343cSJed Brown   } else if (order == tab->order-1) {
644108c343cSJed Brown     if (!tab->bembedt) goto unavailable;
645108c343cSJed Brown     if (ark->status == TS_STEP_INCOMPLETE) { /* Complete with the embedded method (bet,be) */
646108c343cSJed Brown       ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
647e817cc15SEmil Constantinescu       for (j=0; j<s; j++) w[j] = h*tab->bembedt[j];
648108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotI);CHKERRQ(ierr);
649108c343cSJed Brown       for (j=0; j<s; j++) w[j] = h*tab->bembed[j];
650108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
651108c343cSJed Brown     } else {                    /* Rollback and re-complete using (bet-be,be-b) */
652108c343cSJed Brown       ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
653e817cc15SEmil Constantinescu       for (j=0; j<s; j++) w[j] = h*(tab->bembedt[j] - tab->bt[j]);
654108c343cSJed Brown       ierr = VecMAXPY(X,tab->s,w,ark->YdotI);CHKERRQ(ierr);
655108c343cSJed Brown       for (j=0; j<s; j++) w[j] = h*(tab->bembed[j] - tab->b[j]);
656108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
657108c343cSJed Brown     }
658108c343cSJed Brown     if (done) *done = PETSC_TRUE;
659108c343cSJed Brown     PetscFunctionReturn(0);
660108c343cSJed Brown   }
661108c343cSJed Brown unavailable:
662108c343cSJed Brown   if (done) *done = PETSC_FALSE;
663a7fac7c2SEmil Constantinescu   else SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"ARKIMEX '%s' of order %D cannot evaluate step at order %D. Consider using -ts_adapt_type none or a different method that has an embedded estimate.",tab->name,tab->order,order);
664108c343cSJed Brown   PetscFunctionReturn(0);
665108c343cSJed Brown }
666108c343cSJed Brown 
667108c343cSJed Brown #undef __FUNCT__
66824655328SShri #define __FUNCT__ "TSRollBack_ARKIMEX"
66924655328SShri static PetscErrorCode TSRollBack_ARKIMEX(TS ts)
67024655328SShri {
67124655328SShri   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
67224655328SShri   ARKTableau      tab  = ark->tableau;
67324655328SShri   const PetscInt  s    = tab->s;
67424655328SShri   const PetscReal *bt = tab->bt,*b = tab->b;
67524655328SShri   PetscScalar     *w   = ark->work;
67624655328SShri   Vec             *YdotI = ark->YdotI,*YdotRHS = ark->YdotRHS;
67724655328SShri   PetscInt        j;
67824655328SShri   PetscReal       h=ts->time_step;
67924655328SShri   PetscErrorCode  ierr;
68024655328SShri 
68124655328SShri   PetscFunctionBegin;
68224655328SShri   for (j=0; j<s; j++) w[j] = -h*bt[j];
68324655328SShri   ierr = VecMAXPY(ts->vec_sol,s,w,YdotI);CHKERRQ(ierr);
68424655328SShri   for (j=0; j<s; j++) w[j] = -h*b[j];
68524655328SShri   ierr = VecMAXPY(ts->vec_sol,s,w,YdotRHS);CHKERRQ(ierr);
68624655328SShri   ark->status   = TS_STEP_INCOMPLETE;
68724655328SShri   PetscFunctionReturn(0);
68824655328SShri }
68924655328SShri 
69024655328SShri #undef __FUNCT__
6918a381b04SJed Brown #define __FUNCT__ "TSStep_ARKIMEX"
6928a381b04SJed Brown static PetscErrorCode TSStep_ARKIMEX(TS ts)
6938a381b04SJed Brown {
6948a381b04SJed Brown   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
6958a381b04SJed Brown   ARKTableau      tab  = ark->tableau;
6968a381b04SJed Brown   const PetscInt  s    = tab->s;
69724655328SShri   const PetscReal *At  = tab->At,*A = tab->A,*ct = tab->ct,*c = tab->c;
698406d0ec2SJed Brown   PetscScalar     *w   = ark->work;
6991297b224SEmil Constantinescu   Vec             *Y   = ark->Y,*YdotI = ark->YdotI,*YdotRHS = ark->YdotRHS,Ydot = ark->Ydot,Ydot0 = ark->Ydot0,Z = ark->Z;
70056dcabbaSDebojyoti Ghosh   PetscBool       init_guess_extrp = ark->init_guess_extrp;
701108c343cSJed Brown   TSAdapt         adapt;
7028a381b04SJed Brown   SNES            snes;
703108c343cSJed Brown   PetscInt        i,j,its,lits,reject,next_scheme;
704108c343cSJed Brown   PetscReal       t;
70524655328SShri   PetscReal       next_time_step;
706108c343cSJed Brown   PetscBool       accept;
7078a381b04SJed Brown   PetscErrorCode  ierr;
708f85781f1SEmil Constantinescu   SNESConvergedReason snes_reason;
7098a381b04SJed Brown 
7108a381b04SJed Brown   PetscFunctionBegin;
7110e27d5d5SShri   if (ts->equation_type >= TS_EQ_IMPLICIT && tab->explicit_first_stage && (!ts->event || (ts->event && ts->event->status != TSEVENT_PROCESSING))) {
712e817cc15SEmil Constantinescu     PetscReal valid_time;
713e817cc15SEmil Constantinescu     PetscBool isvalid;
71460427346SBarry Smith     ierr = PetscObjectComposedDataGetReal((PetscObject)ts->vec_sol,explicit_stage_time_id,valid_time,isvalid);CHKERRQ(ierr);
715e817cc15SEmil Constantinescu     if (!isvalid || valid_time != ts->ptime) {
716e817cc15SEmil Constantinescu       TS        ts_start;
717baa10174SEmil Constantinescu       SNES      snes_dup=NULL;
71819436ca2SJed Brown 
719baa10174SEmil Constantinescu       ierr = TSClone(ts,&ts_start);CHKERRQ(ierr);
720bbd56ea5SKarl Rupp 
721e817cc15SEmil Constantinescu       ierr = TSSetSolution(ts_start,ts->vec_sol);CHKERRQ(ierr);
722e817cc15SEmil Constantinescu       ierr = TSSetTime(ts_start,ts->ptime);CHKERRQ(ierr);
723eb082435SEmil Constantinescu       ierr = TSSetDuration(ts_start,1,ts->ptime+ts->time_step);CHKERRQ(ierr);
724*feed9e9dSBarry Smith       ierr = TSSetExactFinalTime(ts_start,TS_EXACTFINALTIME_STEPOVER);CHKERRQ(ierr);
725740132f1SEmil Constantinescu       ierr = TSSetTimeStep(ts_start,ts->time_step);CHKERRQ(ierr);
726e817cc15SEmil Constantinescu       ierr = TSSetType(ts_start,TSARKIMEX);CHKERRQ(ierr);
727740132f1SEmil Constantinescu       ierr = TSARKIMEXSetFullyImplicit(ts_start,PETSC_TRUE);CHKERRQ(ierr);
728e817cc15SEmil Constantinescu       ierr = TSARKIMEXSetType(ts_start,TSARKIMEX1BEE);CHKERRQ(ierr);
72934561852SEmil Constantinescu 
730e817cc15SEmil Constantinescu       ierr = TSSolve(ts_start,ts->vec_sol);CHKERRQ(ierr);
731e817cc15SEmil Constantinescu       ierr = TSGetTime(ts_start,&ts->ptime);CHKERRQ(ierr);
732bbd56ea5SKarl Rupp 
733740132f1SEmil Constantinescu       ts->time_step = ts_start->time_step;
734740132f1SEmil Constantinescu       ts->steps++;
735e817cc15SEmil Constantinescu       ierr = VecCopy(((TS_ARKIMEX*)ts_start->data)->Ydot0,Ydot0);CHKERRQ(ierr);
73634561852SEmil Constantinescu 
737d15a3a53SEmil Constantinescu       /* Set the correct TS in SNES */
738d15a3a53SEmil Constantinescu       /* We'll try to bypass this by changing the method on the fly */
739e5168f73SEmil Constantinescu       ierr = TSGetSNES(ts,&snes_dup);CHKERRQ(ierr);
740e5168f73SEmil Constantinescu       ierr = TSSetSNES(ts,snes_dup);CHKERRQ(ierr);
741d15a3a53SEmil Constantinescu 
742166a6834SEmil Constantinescu       ierr = TSDestroy(&ts_start);CHKERRQ(ierr);
743e817cc15SEmil Constantinescu     }
744e817cc15SEmil Constantinescu   }
745e817cc15SEmil Constantinescu 
7468a381b04SJed Brown   ierr           = TSGetSNES(ts,&snes);CHKERRQ(ierr);
7478a381b04SJed Brown   t              = ts->ptime;
74824655328SShri   next_time_step = ts->time_step;
749108c343cSJed Brown   accept         = PETSC_TRUE;
750108c343cSJed Brown   ark->status    = TS_STEP_INCOMPLETE;
7518a381b04SJed Brown 
752e817cc15SEmil Constantinescu 
75397335746SJed Brown   for (reject=0; reject<ts->max_reject && !ts->reason; reject++,ts->reject++) {
754108c343cSJed Brown     PetscReal h = ts->time_step;
755b8123daeSJed Brown     ierr = TSPreStep(ts);CHKERRQ(ierr);
7568a381b04SJed Brown     for (i=0; i<s; i++) {
7579be3e283SDebojyoti Ghosh       ark->stage_time = t + h*ct[i];
7588a381b04SJed Brown       if (At[i*s+i] == 0) {           /* This stage is explicit */
7596c4ed002SBarry Smith         if(i!=0 && ts->equation_type>=TS_EQ_IMPLICIT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Explicit stages other than the first one are not supported for implicit problems");
7608a381b04SJed Brown         ierr = VecCopy(ts->vec_sol,Y[i]);CHKERRQ(ierr);
761e817cc15SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*At[i*s+j];
7628a381b04SJed Brown         ierr = VecMAXPY(Y[i],i,w,YdotI);CHKERRQ(ierr);
7638a381b04SJed Brown         for (j=0; j<i; j++) w[j] = h*A[i*s+j];
7648a381b04SJed Brown         ierr = VecMAXPY(Y[i],i,w,YdotRHS);CHKERRQ(ierr);
7658a381b04SJed Brown       } else {
766b296d7d5SJed Brown         ark->scoeff     = 1./At[i*s+i];
767b8123daeSJed Brown         ierr            = TSPreStage(ts,ark->stage_time);CHKERRQ(ierr);
768f16577ceSEmil Constantinescu 
7698a381b04SJed Brown         /* Ydot = shift*(Y-Z) */
7708a381b04SJed Brown         ierr = VecCopy(ts->vec_sol,Z);CHKERRQ(ierr);
771e817cc15SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*At[i*s+j];
7724f385281SJed Brown         ierr = VecMAXPY(Z,i,w,YdotI);CHKERRQ(ierr);
773c58d1302SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*A[i*s+j];
774c58d1302SEmil Constantinescu         ierr = VecMAXPY(Z,i,w,YdotRHS);CHKERRQ(ierr);
775f16577ceSEmil Constantinescu 
7769eef816dSJed Brown         if (init_guess_extrp && ark->prev_step_valid) {
77756dcabbaSDebojyoti Ghosh           /* Initial guess extrapolated from previous time step stage values */
77856dcabbaSDebojyoti Ghosh           ierr        = TSExtrapolate_ARKIMEX(ts,c[i],Y[i]);CHKERRQ(ierr);
77956dcabbaSDebojyoti Ghosh         } else {
7808a381b04SJed Brown           /* Initial guess taken from last stage */
7818a381b04SJed Brown           ierr        = VecCopy(i>0 ? Y[i-1] : ts->vec_sol,Y[i]);CHKERRQ(ierr);
78256dcabbaSDebojyoti Ghosh         }
783baa10174SEmil Constantinescu         ierr          = SNESSolve(snes,NULL,Y[i]);CHKERRQ(ierr);
7848a381b04SJed Brown         ierr          = SNESGetIterationNumber(snes,&its);CHKERRQ(ierr);
7858a381b04SJed Brown         ierr          = SNESGetLinearSolveIterations(snes,&lits);CHKERRQ(ierr);
7865ef26d82SJed Brown         ts->snes_its += its; ts->ksp_its += lits;
787552698daSJed Brown         ierr          = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
788b295832fSPierre Barbier de Reuille         ierr          = TSAdaptCheckStage(adapt,ts,ark->stage_time,Y[i],&accept);CHKERRQ(ierr);
7891be93e3eSJed Brown         if (!accept) {
7901be93e3eSJed Brown           /* We are likely rejecting the step because of solver or function domain problems so we should not attempt to
7911be93e3eSJed Brown            * use extrapolation to initialize the solves on the next attempt. */
7921be93e3eSJed Brown           ark->prev_step_valid = PETSC_FALSE;
7931be93e3eSJed Brown           goto reject_step;
7941be93e3eSJed Brown         }
7958a381b04SJed Brown       }
7969be3e283SDebojyoti Ghosh       ierr = TSPostStage(ts,ark->stage_time,i,Y); CHKERRQ(ierr);
797e817cc15SEmil Constantinescu       if (ts->equation_type>=TS_EQ_IMPLICIT) {
798e817cc15SEmil Constantinescu         if (i==0 && tab->explicit_first_stage) {
7996c4ed002SBarry Smith           if(!tab->stiffly_accurate ) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSARKIMEX %s is not stiffly accurate and therefore explicit-first stage methods cannot be used if the equation is implicit because the slope cannot be evaluated",ark->tableau->name);
800df5e1e3dSEmil Constantinescu           ierr = VecCopy(Ydot0,YdotI[0]);CHKERRQ(ierr);                                      /* YdotI = YdotI(tn-1) */
801e817cc15SEmil Constantinescu         } else {
802df5e1e3dSEmil Constantinescu           ierr = VecAXPBYPCZ(YdotI[i],-ark->scoeff/h,ark->scoeff/h,0,Z,Y[i]);CHKERRQ(ierr);  /* YdotI = shift*(X-Z) */
803e817cc15SEmil Constantinescu         }
804e817cc15SEmil Constantinescu       } else {
8055eca1a21SEmil Constantinescu         if (i==0 && tab->explicit_first_stage) {
8068a381b04SJed Brown           ierr = VecZeroEntries(Ydot);CHKERRQ(ierr);
807df5e1e3dSEmil Constantinescu           ierr = TSComputeIFunction(ts,t+h*ct[i],Y[i],Ydot,YdotI[i],ark->imex);CHKERRQ(ierr);/* YdotI = -G(t,Y,0)   */
808e817cc15SEmil Constantinescu           ierr = VecScale(YdotI[i], -1.0);CHKERRQ(ierr);
8095eca1a21SEmil Constantinescu         } else {
810df5e1e3dSEmil Constantinescu           ierr = VecAXPBYPCZ(YdotI[i],-ark->scoeff/h,ark->scoeff/h,0,Z,Y[i]);CHKERRQ(ierr);  /* YdotI = shift*(X-Z) */
8115eca1a21SEmil Constantinescu         }
8124cc180ffSJed Brown         if (ark->imex) {
8138a381b04SJed Brown           ierr = TSComputeRHSFunction(ts,t+h*c[i],Y[i],YdotRHS[i]);CHKERRQ(ierr);
8144cc180ffSJed Brown         } else {
8154cc180ffSJed Brown           ierr = VecZeroEntries(YdotRHS[i]);CHKERRQ(ierr);
8164cc180ffSJed Brown         }
8178a381b04SJed Brown       }
818e817cc15SEmil Constantinescu     }
8190298fd71SBarry Smith     ierr = TSEvaluateStep(ts,tab->order,ts->vec_sol,NULL);CHKERRQ(ierr);
820108c343cSJed Brown     ark->status = TS_STEP_PENDING;
8218a381b04SJed Brown 
822108c343cSJed Brown     /* Register only the current method as a candidate because we're not supporting multiple candidates yet. */
823552698daSJed Brown     ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
824108c343cSJed Brown     ierr = TSAdaptCandidatesClear(adapt);CHKERRQ(ierr);
825108c343cSJed Brown     ierr = TSAdaptCandidateAdd(adapt,tab->name,tab->order,1,tab->ccfl,1.*tab->s,PETSC_TRUE);CHKERRQ(ierr);
826108c343cSJed Brown     ierr = TSAdaptChoose(adapt,ts,ts->time_step,&next_scheme,&next_time_step,&accept);CHKERRQ(ierr);
827108c343cSJed Brown     if (accept) {
828108c343cSJed Brown       /* ignore next_scheme for now */
8298a381b04SJed Brown       ts->ptime    += ts->time_step;
830cdbf8f93SLisandro Dalcin       ts->time_step = next_time_step;
8318a381b04SJed Brown       ts->steps++;
832e817cc15SEmil Constantinescu       if (ts->equation_type>=TS_EQ_IMPLICIT) { /* save the initial slope for the next step*/
833e817cc15SEmil Constantinescu         ierr = VecCopy(YdotI[s-1],Ydot0);CHKERRQ(ierr);
834e817cc15SEmil Constantinescu       }
835108c343cSJed Brown       ark->status = TS_STEP_COMPLETE;
836e817cc15SEmil Constantinescu       if (tab->explicit_first_stage) {
837e817cc15SEmil Constantinescu         ierr = PetscObjectComposedDataSetReal((PetscObject)ts->vec_sol,explicit_stage_time_id,ts->ptime);CHKERRQ(ierr);
838e817cc15SEmil Constantinescu       }
83964b5d2f7SDebojyoti Ghosh       /* Save the Y, YdotI, YdotRHS for extrapolation initial guess */
84064b5d2f7SDebojyoti Ghosh       if (ark->init_guess_extrp) {
84164b5d2f7SDebojyoti Ghosh         for (i = 0; i<s; i++) {
84264b5d2f7SDebojyoti Ghosh           ierr = VecCopy(Y[i],ark->Y_prev[i]);CHKERRQ(ierr);
84364b5d2f7SDebojyoti Ghosh           ierr = VecCopy(YdotRHS[i],ark->YdotRHS_prev[i]);CHKERRQ(ierr);
84464b5d2f7SDebojyoti Ghosh           ierr = VecCopy(YdotI[i],ark->YdotI_prev[i]);CHKERRQ(ierr);
84564b5d2f7SDebojyoti Ghosh         }
8469eef816dSJed Brown         ark->prev_step_valid = PETSC_TRUE;
84764b5d2f7SDebojyoti Ghosh       }
848108c343cSJed Brown       break;
849108c343cSJed Brown     } else {                    /* Roll back the current step */
85024655328SShri       ts->ptime += next_time_step; /* This will be undone in rollback */
851108c343cSJed Brown       ark->status = TS_STEP_INCOMPLETE;
85224655328SShri       ierr = TSRollBack(ts);CHKERRQ(ierr);
853108c343cSJed Brown     }
854476b6736SJed Brown reject_step: continue;
855108c343cSJed Brown   }
856f85781f1SEmil Constantinescu   if (ark->status != TS_STEP_COMPLETE && !ts->reason){
857f85781f1SEmil Constantinescu     ierr=SNESGetConvergedReason(snes,&snes_reason);CHKERRQ(ierr);
858f85781f1SEmil Constantinescu     if(snes_reason<0) ts->reason = TS_DIVERGED_NONLINEAR_SOLVE;
859f85781f1SEmil Constantinescu     else ts->reason = TS_DIVERGED_STEP_REJECTED;
860f85781f1SEmil Constantinescu   }
8618a381b04SJed Brown   PetscFunctionReturn(0);
8628a381b04SJed Brown }
8638a381b04SJed Brown 
864cd652676SJed Brown #undef __FUNCT__
865cd652676SJed Brown #define __FUNCT__ "TSInterpolate_ARKIMEX"
866cd652676SJed Brown static PetscErrorCode TSInterpolate_ARKIMEX(TS ts,PetscReal itime,Vec X)
867cd652676SJed Brown {
868cd652676SJed Brown   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
8694f385281SJed Brown   PetscInt        s    = ark->tableau->s,pinterp = ark->tableau->pinterp,i,j;
870108c343cSJed Brown   PetscReal       h;
871108c343cSJed Brown   PetscReal       tt,t;
872cd652676SJed Brown   PetscScalar     *bt,*b;
873cd652676SJed Brown   const PetscReal *Bt = ark->tableau->binterpt,*B = ark->tableau->binterp;
874cd652676SJed Brown   PetscErrorCode  ierr;
875cd652676SJed Brown 
876cd652676SJed Brown   PetscFunctionBegin;
877ce94432eSBarry Smith   if (!Bt || !B) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSARKIMEX %s does not have an interpolation formula",ark->tableau->name);
878108c343cSJed Brown   switch (ark->status) {
879108c343cSJed Brown   case TS_STEP_INCOMPLETE:
880108c343cSJed Brown   case TS_STEP_PENDING:
881108c343cSJed Brown     h = ts->time_step;
882108c343cSJed Brown     t = (itime - ts->ptime)/h;
883108c343cSJed Brown     break;
884108c343cSJed Brown   case TS_STEP_COMPLETE:
885108c343cSJed Brown     h = ts->time_step_prev;
886108c343cSJed Brown     t = (itime - ts->ptime)/h + 1; /* In the interval [0,1] */
887108c343cSJed Brown     break;
888ce94432eSBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Invalid TSStepStatus");
889108c343cSJed Brown   }
890dcca6d9dSJed Brown   ierr = PetscMalloc2(s,&bt,s,&b);CHKERRQ(ierr);
891cd652676SJed Brown   for (i=0; i<s; i++) bt[i] = b[i] = 0;
8924f385281SJed Brown   for (j=0,tt=t; j<pinterp; j++,tt*=t) {
893cd652676SJed Brown     for (i=0; i<s; i++) {
894c1758d98SDebojyoti Ghosh       bt[i] += h * Bt[i*pinterp+j] * tt;
895108c343cSJed Brown       b[i]  += h * B[i*pinterp+j] * tt;
896cd652676SJed Brown     }
897cd652676SJed Brown   }
898cd652676SJed Brown   ierr = VecCopy(ark->Y[0],X);CHKERRQ(ierr);
899cd652676SJed Brown   ierr = VecMAXPY(X,s,bt,ark->YdotI);CHKERRQ(ierr);
900cd652676SJed Brown   ierr = VecMAXPY(X,s,b,ark->YdotRHS);CHKERRQ(ierr);
901cd652676SJed Brown   ierr = PetscFree2(bt,b);CHKERRQ(ierr);
902cd652676SJed Brown   PetscFunctionReturn(0);
903cd652676SJed Brown }
904cd652676SJed Brown 
90556dcabbaSDebojyoti Ghosh #undef __FUNCT__
90656dcabbaSDebojyoti Ghosh #define __FUNCT__ "TSExtrapolate_ARKIMEX"
90756dcabbaSDebojyoti Ghosh static PetscErrorCode TSExtrapolate_ARKIMEX(TS ts,PetscReal c,Vec X)
90856dcabbaSDebojyoti Ghosh {
90956dcabbaSDebojyoti Ghosh   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
91056dcabbaSDebojyoti Ghosh   PetscInt        s    = ark->tableau->s,pinterp = ark->tableau->pinterp,i,j;
91156dcabbaSDebojyoti Ghosh   PetscReal       h;
91256dcabbaSDebojyoti Ghosh   PetscReal       tt,t;
91356dcabbaSDebojyoti Ghosh   PetscScalar     *bt,*b;
91456dcabbaSDebojyoti Ghosh   const PetscReal *Bt = ark->tableau->binterpt,*B = ark->tableau->binterp;
91556dcabbaSDebojyoti Ghosh   PetscErrorCode  ierr;
91656dcabbaSDebojyoti Ghosh 
91756dcabbaSDebojyoti Ghosh   PetscFunctionBegin;
91856dcabbaSDebojyoti Ghosh   if (!Bt || !B) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSARKIMEX %s does not have an interpolation formula",ark->tableau->name);
91956dcabbaSDebojyoti Ghosh   t = 1.0 + (ts->time_step/ts->time_step_prev)*c;
92081d12688SDebojyoti Ghosh   h = ts->time_step;
921dcca6d9dSJed Brown   ierr = PetscMalloc2(s,&bt,s,&b);CHKERRQ(ierr);
92256dcabbaSDebojyoti Ghosh   for (i=0; i<s; i++) bt[i] = b[i] = 0;
92356dcabbaSDebojyoti Ghosh   for (j=0,tt=t; j<pinterp; j++,tt*=t) {
92456dcabbaSDebojyoti Ghosh     for (i=0; i<s; i++) {
92581d12688SDebojyoti Ghosh       bt[i] += h * Bt[i*pinterp+j] * tt;
92656dcabbaSDebojyoti Ghosh       b[i]  += h * B[i*pinterp+j] * tt;
92756dcabbaSDebojyoti Ghosh     }
92856dcabbaSDebojyoti Ghosh   }
9299eef816dSJed Brown   if (!ark->prev_step_valid) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Stages from previous step have not been stored");
93056dcabbaSDebojyoti Ghosh   ierr = VecCopy(ark->Y_prev[0],X);CHKERRQ(ierr);
93156dcabbaSDebojyoti Ghosh   ierr = VecMAXPY(X,s,bt,ark->YdotI_prev);CHKERRQ(ierr);
93256dcabbaSDebojyoti Ghosh   ierr = VecMAXPY(X,s,b,ark->YdotRHS_prev);CHKERRQ(ierr);
93356dcabbaSDebojyoti Ghosh   ierr = PetscFree2(bt,b);CHKERRQ(ierr);
93456dcabbaSDebojyoti Ghosh   PetscFunctionReturn(0);
93556dcabbaSDebojyoti Ghosh }
93656dcabbaSDebojyoti Ghosh 
9378a381b04SJed Brown /*------------------------------------------------------------*/
9388a381b04SJed Brown #undef __FUNCT__
9398a381b04SJed Brown #define __FUNCT__ "TSReset_ARKIMEX"
9408a381b04SJed Brown static PetscErrorCode TSReset_ARKIMEX(TS ts)
9418a381b04SJed Brown {
9428a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
9438a381b04SJed Brown   PetscInt       s;
9448a381b04SJed Brown   PetscErrorCode ierr;
9458a381b04SJed Brown 
9468a381b04SJed Brown   PetscFunctionBegin;
9478a381b04SJed Brown   if (!ark->tableau) PetscFunctionReturn(0);
9488a381b04SJed Brown   s    = ark->tableau->s;
9498a381b04SJed Brown   ierr = VecDestroyVecs(s,&ark->Y);CHKERRQ(ierr);
9508a381b04SJed Brown   ierr = VecDestroyVecs(s,&ark->YdotI);CHKERRQ(ierr);
9518a381b04SJed Brown   ierr = VecDestroyVecs(s,&ark->YdotRHS);CHKERRQ(ierr);
9520bf495dbSBarry Smith   if (ark->init_guess_extrp) {
95356dcabbaSDebojyoti Ghosh     ierr = VecDestroyVecs(s,&ark->Y_prev);CHKERRQ(ierr);
95456dcabbaSDebojyoti Ghosh     ierr = VecDestroyVecs(s,&ark->YdotI_prev);CHKERRQ(ierr);
95556dcabbaSDebojyoti Ghosh     ierr = VecDestroyVecs(s,&ark->YdotRHS_prev);CHKERRQ(ierr);
95656dcabbaSDebojyoti Ghosh   }
9578a381b04SJed Brown   ierr = VecDestroy(&ark->Ydot);CHKERRQ(ierr);
9588a381b04SJed Brown   ierr = VecDestroy(&ark->Work);CHKERRQ(ierr);
959e817cc15SEmil Constantinescu   ierr = VecDestroy(&ark->Ydot0);CHKERRQ(ierr);
9608a381b04SJed Brown   ierr = VecDestroy(&ark->Z);CHKERRQ(ierr);
9618a381b04SJed Brown   ierr = PetscFree(ark->work);CHKERRQ(ierr);
9628a381b04SJed Brown   PetscFunctionReturn(0);
9638a381b04SJed Brown }
9648a381b04SJed Brown 
9658a381b04SJed Brown #undef __FUNCT__
9668a381b04SJed Brown #define __FUNCT__ "TSDestroy_ARKIMEX"
9678a381b04SJed Brown static PetscErrorCode TSDestroy_ARKIMEX(TS ts)
9688a381b04SJed Brown {
9698a381b04SJed Brown   PetscErrorCode ierr;
9708a381b04SJed Brown 
9718a381b04SJed Brown   PetscFunctionBegin;
9728a381b04SJed Brown   ierr = TSReset_ARKIMEX(ts);CHKERRQ(ierr);
9738a381b04SJed Brown   ierr = PetscFree(ts->data);CHKERRQ(ierr);
974bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXGetType_C",NULL);CHKERRQ(ierr);
975bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetType_C",NULL);CHKERRQ(ierr);
976bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetFullyImplicit_C",NULL);CHKERRQ(ierr);
9778a381b04SJed Brown   PetscFunctionReturn(0);
9788a381b04SJed Brown }
9798a381b04SJed Brown 
980d5e6173cSPeter Brune 
981d5e6173cSPeter Brune #undef __FUNCT__
982d5e6173cSPeter Brune #define __FUNCT__ "TSARKIMEXGetVecs"
983d5e6173cSPeter Brune static PetscErrorCode TSARKIMEXGetVecs(TS ts,DM dm,Vec *Z,Vec *Ydot)
984d5e6173cSPeter Brune {
985d5e6173cSPeter Brune   TS_ARKIMEX     *ax = (TS_ARKIMEX*)ts->data;
986d5e6173cSPeter Brune   PetscErrorCode ierr;
987d5e6173cSPeter Brune 
988d5e6173cSPeter Brune   PetscFunctionBegin;
989d5e6173cSPeter Brune   if (Z) {
990d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
991d5e6173cSPeter Brune       ierr = DMGetNamedGlobalVector(dm,"TSARKIMEX_Z",Z);CHKERRQ(ierr);
992d5e6173cSPeter Brune     } else *Z = ax->Z;
993d5e6173cSPeter Brune   }
994d5e6173cSPeter Brune   if (Ydot) {
995d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
996d5e6173cSPeter Brune       ierr = DMGetNamedGlobalVector(dm,"TSARKIMEX_Ydot",Ydot);CHKERRQ(ierr);
997d5e6173cSPeter Brune     } else *Ydot = ax->Ydot;
998d5e6173cSPeter Brune   }
999d5e6173cSPeter Brune   PetscFunctionReturn(0);
1000d5e6173cSPeter Brune }
1001d5e6173cSPeter Brune 
1002d5e6173cSPeter Brune 
1003d5e6173cSPeter Brune #undef __FUNCT__
1004d5e6173cSPeter Brune #define __FUNCT__ "TSARKIMEXRestoreVecs"
1005d5e6173cSPeter Brune static PetscErrorCode TSARKIMEXRestoreVecs(TS ts,DM dm,Vec *Z,Vec *Ydot)
1006d5e6173cSPeter Brune {
1007d5e6173cSPeter Brune   PetscErrorCode ierr;
1008d5e6173cSPeter Brune 
1009d5e6173cSPeter Brune   PetscFunctionBegin;
1010d5e6173cSPeter Brune   if (Z) {
1011d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1012d5e6173cSPeter Brune       ierr = DMRestoreNamedGlobalVector(dm,"TSARKIMEX_Z",Z);CHKERRQ(ierr);
1013d5e6173cSPeter Brune     }
1014d5e6173cSPeter Brune   }
1015d5e6173cSPeter Brune   if (Ydot) {
1016d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1017d5e6173cSPeter Brune       ierr = DMRestoreNamedGlobalVector(dm,"TSARKIMEX_Ydot",Ydot);CHKERRQ(ierr);
1018d5e6173cSPeter Brune     }
1019d5e6173cSPeter Brune   }
1020d5e6173cSPeter Brune   PetscFunctionReturn(0);
1021d5e6173cSPeter Brune }
1022d5e6173cSPeter Brune 
10238a381b04SJed Brown /*
10248a381b04SJed Brown   This defines the nonlinear equation that is to be solved with SNES
10258a381b04SJed Brown   G(U) = F[t0+Theta*dt, U, (U-U0)*shift] = 0
10268a381b04SJed Brown */
10278a381b04SJed Brown #undef __FUNCT__
10288a381b04SJed Brown #define __FUNCT__ "SNESTSFormFunction_ARKIMEX"
10298a381b04SJed Brown static PetscErrorCode SNESTSFormFunction_ARKIMEX(SNES snes,Vec X,Vec F,TS ts)
10308a381b04SJed Brown {
10318a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
1032d5e6173cSPeter Brune   DM             dm,dmsave;
1033d5e6173cSPeter Brune   Vec            Z,Ydot;
1034b296d7d5SJed Brown   PetscReal      shift = ark->scoeff / ts->time_step;
10358a381b04SJed Brown   PetscErrorCode ierr;
10368a381b04SJed Brown 
10378a381b04SJed Brown   PetscFunctionBegin;
1038d5e6173cSPeter Brune   ierr   = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1039d5e6173cSPeter Brune   ierr   = TSARKIMEXGetVecs(ts,dm,&Z,&Ydot);CHKERRQ(ierr);
1040b296d7d5SJed Brown   ierr   = VecAXPBYPCZ(Ydot,-shift,shift,0,Z,X);CHKERRQ(ierr); /* Ydot = shift*(X-Z) */
1041d5e6173cSPeter Brune   dmsave = ts->dm;
1042d5e6173cSPeter Brune   ts->dm = dm;
1043740132f1SEmil Constantinescu 
1044d5e6173cSPeter Brune   ierr = TSComputeIFunction(ts,ark->stage_time,X,Ydot,F,ark->imex);CHKERRQ(ierr);
1045e817cc15SEmil Constantinescu 
1046d5e6173cSPeter Brune   ts->dm = dmsave;
1047d5e6173cSPeter Brune   ierr   = TSARKIMEXRestoreVecs(ts,dm,&Z,&Ydot);CHKERRQ(ierr);
10488a381b04SJed Brown   PetscFunctionReturn(0);
10498a381b04SJed Brown }
10508a381b04SJed Brown 
10518a381b04SJed Brown #undef __FUNCT__
10528a381b04SJed Brown #define __FUNCT__ "SNESTSFormJacobian_ARKIMEX"
1053d1e9a80fSBarry Smith static PetscErrorCode SNESTSFormJacobian_ARKIMEX(SNES snes,Vec X,Mat A,Mat B,TS ts)
10548a381b04SJed Brown {
10558a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
1056d5e6173cSPeter Brune   DM             dm,dmsave;
1057d5e6173cSPeter Brune   Vec            Ydot;
1058b296d7d5SJed Brown   PetscReal      shift = ark->scoeff / ts->time_step;
10598a381b04SJed Brown   PetscErrorCode ierr;
10608a381b04SJed Brown 
10618a381b04SJed Brown   PetscFunctionBegin;
1062d5e6173cSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
10630298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,dm,NULL,&Ydot);CHKERRQ(ierr);
10648a381b04SJed Brown   /* ark->Ydot has already been computed in SNESTSFormFunction_ARKIMEX (SNES guarantees this) */
1065d5e6173cSPeter Brune   dmsave = ts->dm;
1066d5e6173cSPeter Brune   ts->dm = dm;
1067740132f1SEmil Constantinescu 
1068d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,ark->stage_time,X,Ydot,shift,A,B,ark->imex);CHKERRQ(ierr);
1069740132f1SEmil Constantinescu 
1070d5e6173cSPeter Brune   ts->dm = dmsave;
10710298fd71SBarry Smith   ierr   = TSARKIMEXRestoreVecs(ts,dm,NULL,&Ydot);CHKERRQ(ierr);
1072d5e6173cSPeter Brune   PetscFunctionReturn(0);
1073d5e6173cSPeter Brune }
1074d5e6173cSPeter Brune 
1075d5e6173cSPeter Brune #undef __FUNCT__
1076d5e6173cSPeter Brune #define __FUNCT__ "DMCoarsenHook_TSARKIMEX"
1077d5e6173cSPeter Brune static PetscErrorCode DMCoarsenHook_TSARKIMEX(DM fine,DM coarse,void *ctx)
1078d5e6173cSPeter Brune {
1079d5e6173cSPeter Brune   PetscFunctionBegin;
1080d5e6173cSPeter Brune   PetscFunctionReturn(0);
1081d5e6173cSPeter Brune }
1082d5e6173cSPeter Brune 
1083d5e6173cSPeter Brune #undef __FUNCT__
1084d5e6173cSPeter Brune #define __FUNCT__ "DMRestrictHook_TSARKIMEX"
1085d5e6173cSPeter Brune static PetscErrorCode DMRestrictHook_TSARKIMEX(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse,void *ctx)
1086d5e6173cSPeter Brune {
1087d5e6173cSPeter Brune   TS             ts = (TS)ctx;
1088d5e6173cSPeter Brune   PetscErrorCode ierr;
1089d5e6173cSPeter Brune   Vec            Z,Z_c;
1090d5e6173cSPeter Brune 
1091d5e6173cSPeter Brune   PetscFunctionBegin;
10920298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,fine,&Z,NULL);CHKERRQ(ierr);
10930298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,coarse,&Z_c,NULL);CHKERRQ(ierr);
1094d5e6173cSPeter Brune   ierr = MatRestrict(restrct,Z,Z_c);CHKERRQ(ierr);
1095d5e6173cSPeter Brune   ierr = VecPointwiseMult(Z_c,rscale,Z_c);CHKERRQ(ierr);
10960298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,fine,&Z,NULL);CHKERRQ(ierr);
10970298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,coarse,&Z_c,NULL);CHKERRQ(ierr);
10988a381b04SJed Brown   PetscFunctionReturn(0);
10998a381b04SJed Brown }
11008a381b04SJed Brown 
1101cdb298fcSPeter Brune 
1102cdb298fcSPeter Brune #undef __FUNCT__
1103cdb298fcSPeter Brune #define __FUNCT__ "DMSubDomainHook_TSARKIMEX"
1104cdb298fcSPeter Brune static PetscErrorCode DMSubDomainHook_TSARKIMEX(DM dm,DM subdm,void *ctx)
1105cdb298fcSPeter Brune {
1106cdb298fcSPeter Brune   PetscFunctionBegin;
1107cdb298fcSPeter Brune   PetscFunctionReturn(0);
1108cdb298fcSPeter Brune }
1109cdb298fcSPeter Brune 
1110cdb298fcSPeter Brune #undef __FUNCT__
1111cdb298fcSPeter Brune #define __FUNCT__ "DMSubDomainRestrictHook_TSARKIMEX"
1112cdb298fcSPeter Brune static PetscErrorCode DMSubDomainRestrictHook_TSARKIMEX(DM dm,VecScatter gscat,VecScatter lscat,DM subdm,void *ctx)
1113cdb298fcSPeter Brune {
1114cdb298fcSPeter Brune   TS             ts = (TS)ctx;
1115cdb298fcSPeter Brune   PetscErrorCode ierr;
1116cdb298fcSPeter Brune   Vec            Z,Z_c;
1117cdb298fcSPeter Brune 
1118cdb298fcSPeter Brune   PetscFunctionBegin;
11190298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,dm,&Z,NULL);CHKERRQ(ierr);
11200298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,subdm,&Z_c,NULL);CHKERRQ(ierr);
1121cdb298fcSPeter Brune 
1122cdb298fcSPeter Brune   ierr = VecScatterBegin(gscat,Z,Z_c,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1123cdb298fcSPeter Brune   ierr = VecScatterEnd(gscat,Z,Z_c,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1124cdb298fcSPeter Brune 
11250298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,dm,&Z,NULL);CHKERRQ(ierr);
11260298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,subdm,&Z_c,NULL);CHKERRQ(ierr);
1127cdb298fcSPeter Brune   PetscFunctionReturn(0);
1128cdb298fcSPeter Brune }
1129cdb298fcSPeter Brune 
11308a381b04SJed Brown #undef __FUNCT__
11318a381b04SJed Brown #define __FUNCT__ "TSSetUp_ARKIMEX"
11328a381b04SJed Brown static PetscErrorCode TSSetUp_ARKIMEX(TS ts)
11338a381b04SJed Brown {
11348a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
1135f2c2a1b9SBarry Smith   ARKTableau     tab;
1136f2c2a1b9SBarry Smith   PetscInt       s;
11378a381b04SJed Brown   PetscErrorCode ierr;
1138d5e6173cSPeter Brune   DM             dm;
1139f9c1d6abSBarry Smith 
11408a381b04SJed Brown   PetscFunctionBegin;
11418a381b04SJed Brown   if (!ark->tableau) {
1142e24355feSJed Brown     ierr = TSARKIMEXSetType(ts,TSARKIMEXDefault);CHKERRQ(ierr);
11438a381b04SJed Brown   }
1144f2c2a1b9SBarry Smith   tab  = ark->tableau;
1145f2c2a1b9SBarry Smith   s    = tab->s;
11468a381b04SJed Brown   ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->Y);CHKERRQ(ierr);
11478a381b04SJed Brown   ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->YdotI);CHKERRQ(ierr);
11488a381b04SJed Brown   ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->YdotRHS);CHKERRQ(ierr);
114956dcabbaSDebojyoti Ghosh   if (ark->init_guess_extrp) {
115056dcabbaSDebojyoti Ghosh     ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->Y_prev);CHKERRQ(ierr);
115156dcabbaSDebojyoti Ghosh     ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->YdotI_prev);CHKERRQ(ierr);
115256dcabbaSDebojyoti Ghosh     ierr = VecDuplicateVecs(ts->vec_sol,s,&ark->YdotRHS_prev);CHKERRQ(ierr);
115356dcabbaSDebojyoti Ghosh   }
11548a381b04SJed Brown   ierr = VecDuplicate(ts->vec_sol,&ark->Ydot);CHKERRQ(ierr);
11558a381b04SJed Brown   ierr = VecDuplicate(ts->vec_sol,&ark->Work);CHKERRQ(ierr);
1156e817cc15SEmil Constantinescu   ierr = VecDuplicate(ts->vec_sol,&ark->Ydot0);CHKERRQ(ierr);
11578a381b04SJed Brown   ierr = VecDuplicate(ts->vec_sol,&ark->Z);CHKERRQ(ierr);
1158785e854fSJed Brown   ierr = PetscMalloc1(s,&ark->work);CHKERRQ(ierr);
1159d5e6173cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1160d5e6173cSPeter Brune   if (dm) {
1161d5e6173cSPeter Brune     ierr = DMCoarsenHookAdd(dm,DMCoarsenHook_TSARKIMEX,DMRestrictHook_TSARKIMEX,ts);CHKERRQ(ierr);
1162cdb298fcSPeter Brune     ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_TSARKIMEX,DMSubDomainRestrictHook_TSARKIMEX,ts);CHKERRQ(ierr);
1163d5e6173cSPeter Brune   }
11648a381b04SJed Brown   PetscFunctionReturn(0);
11658a381b04SJed Brown }
11668a381b04SJed Brown /*------------------------------------------------------------*/
11678a381b04SJed Brown 
11688a381b04SJed Brown #undef __FUNCT__
11698a381b04SJed Brown #define __FUNCT__ "TSSetFromOptions_ARKIMEX"
11704416b707SBarry Smith static PetscErrorCode TSSetFromOptions_ARKIMEX(PetscOptionItems *PetscOptionsObject,TS ts)
11718a381b04SJed Brown {
11724cc180ffSJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
11738a381b04SJed Brown   PetscErrorCode ierr;
11748a381b04SJed Brown   char           arktype[256];
11758a381b04SJed Brown 
11768a381b04SJed Brown   PetscFunctionBegin;
1177e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"ARKIMEX ODE solver options");CHKERRQ(ierr);
11788a381b04SJed Brown   {
11798a381b04SJed Brown     ARKTableauLink link;
11808a381b04SJed Brown     PetscInt       count,choice;
11818a381b04SJed Brown     PetscBool      flg;
11828a381b04SJed Brown     const char     **namelist;
11838caf3d72SBarry Smith     ierr = PetscStrncpy(arktype,TSARKIMEXDefault,sizeof(arktype));CHKERRQ(ierr);
11848a381b04SJed Brown     for (link=ARKTableauList,count=0; link; link=link->next,count++) ;
1185785e854fSJed Brown     ierr = PetscMalloc1(count,&namelist);CHKERRQ(ierr);
11868a381b04SJed Brown     for (link=ARKTableauList,count=0; link; link=link->next,count++) namelist[count] = link->tab.name;
11878a381b04SJed Brown       ierr      = PetscOptionsEList("-ts_arkimex_type","Family of ARK IMEX method","TSARKIMEXSetType",(const char*const*)namelist,count,arktype,&choice,&flg);CHKERRQ(ierr);
11888a381b04SJed Brown       ierr      = TSARKIMEXSetType(ts,flg ? namelist[choice] : arktype);CHKERRQ(ierr);
11898a381b04SJed Brown     ierr      = PetscFree(namelist);CHKERRQ(ierr);
11904cc180ffSJed Brown     flg       = (PetscBool) !ark->imex;
11910298fd71SBarry Smith     ierr      = PetscOptionsBool("-ts_arkimex_fully_implicit","Solve the problem fully implicitly","TSARKIMEXSetFullyImplicit",flg,&flg,NULL);CHKERRQ(ierr);
11924cc180ffSJed Brown     ark->imex = (PetscBool) !flg;
119356dcabbaSDebojyoti Ghosh     ark->init_guess_extrp = PETSC_FALSE;
119456dcabbaSDebojyoti Ghosh     ierr      = PetscOptionsBool("-ts_arkimex_initial_guess_extrapolate","Extrapolate the initial guess for the stage solution from stage values of the previous time step","",ark->init_guess_extrp,&ark->init_guess_extrp,NULL);CHKERRQ(ierr);
11958a381b04SJed Brown   }
11968a381b04SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
11978a381b04SJed Brown   PetscFunctionReturn(0);
11988a381b04SJed Brown }
11998a381b04SJed Brown 
12008a381b04SJed Brown #undef __FUNCT__
12018a381b04SJed Brown #define __FUNCT__ "PetscFormatRealArray"
12028a381b04SJed Brown static PetscErrorCode PetscFormatRealArray(char buf[],size_t len,const char *fmt,PetscInt n,const PetscReal x[])
12038a381b04SJed Brown {
1204257d2499SJed Brown   PetscErrorCode ierr;
1205f1d86077SJed Brown   PetscInt       i;
1206f1d86077SJed Brown   size_t         left,count;
12078a381b04SJed Brown   char           *p;
12088a381b04SJed Brown 
12098a381b04SJed Brown   PetscFunctionBegin;
1210f1d86077SJed Brown   for (i=0,p=buf,left=len; i<n; i++) {
1211f1d86077SJed Brown     ierr = PetscSNPrintfCount(p,left,fmt,&count,x[i]);CHKERRQ(ierr);
12128a381b04SJed Brown     if (count >= left) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Insufficient space in buffer");
12138a381b04SJed Brown     left -= count;
12148a381b04SJed Brown     p    += count;
12158a381b04SJed Brown     *p++  = ' ';
12168a381b04SJed Brown   }
12178a381b04SJed Brown   p[i ? 0 : -1] = 0;
12188a381b04SJed Brown   PetscFunctionReturn(0);
12198a381b04SJed Brown }
12208a381b04SJed Brown 
12218a381b04SJed Brown #undef __FUNCT__
12228a381b04SJed Brown #define __FUNCT__ "TSView_ARKIMEX"
12238a381b04SJed Brown static PetscErrorCode TSView_ARKIMEX(TS ts,PetscViewer viewer)
12248a381b04SJed Brown {
12258a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
12268a381b04SJed Brown   ARKTableau     tab  = ark->tableau;
12278a381b04SJed Brown   PetscBool      iascii;
12288a381b04SJed Brown   PetscErrorCode ierr;
1229559eea31SJed Brown   TSAdapt        adapt;
12308a381b04SJed Brown 
12318a381b04SJed Brown   PetscFunctionBegin;
1232251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
12338a381b04SJed Brown   if (iascii) {
123419fd82e9SBarry Smith     TSARKIMEXType arktype;
12358a381b04SJed Brown     char          buf[512];
12368a381b04SJed Brown     ierr = TSARKIMEXGetType(ts,&arktype);CHKERRQ(ierr);
12378a381b04SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  ARK IMEX %s\n",arktype);CHKERRQ(ierr);
12388caf3d72SBarry Smith     ierr = PetscFormatRealArray(buf,sizeof(buf),"% 8.6f",tab->s,tab->ct);CHKERRQ(ierr);
123931f6fcc0SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  Stiff abscissa       ct = %s\n",buf);CHKERRQ(ierr);
12408caf3d72SBarry Smith     ierr = PetscFormatRealArray(buf,sizeof(buf),"% 8.6f",tab->s,tab->c);CHKERRQ(ierr);
1241e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"Stiffly accurate: %s\n",tab->stiffly_accurate ? "yes" : "no");CHKERRQ(ierr);
1242e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"Explicit first stage: %s\n",tab->explicit_first_stage ? "yes" : "no");CHKERRQ(ierr);
1243e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"FSAL property: %s\n",tab->FSAL_implicit ? "yes" : "no");CHKERRQ(ierr);
124431f6fcc0SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  Nonstiff abscissa     c = %s\n",buf);CHKERRQ(ierr);
12458a381b04SJed Brown   }
1246552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
1247559eea31SJed Brown   ierr = TSAdaptView(adapt,viewer);CHKERRQ(ierr);
1248d52bd9f3SBarry Smith   ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
12498a381b04SJed Brown   PetscFunctionReturn(0);
12508a381b04SJed Brown }
12518a381b04SJed Brown 
12528a381b04SJed Brown #undef __FUNCT__
1253f2c2a1b9SBarry Smith #define __FUNCT__ "TSLoad_ARKIMEX"
1254f2c2a1b9SBarry Smith static PetscErrorCode TSLoad_ARKIMEX(TS ts,PetscViewer viewer)
1255f2c2a1b9SBarry Smith {
1256f2c2a1b9SBarry Smith   PetscErrorCode ierr;
1257f2c2a1b9SBarry Smith   SNES           snes;
1258ad6bc421SBarry Smith   TSAdapt        tsadapt;
1259f2c2a1b9SBarry Smith 
1260f2c2a1b9SBarry Smith   PetscFunctionBegin;
1261552698daSJed Brown   ierr = TSGetAdapt(ts,&tsadapt);CHKERRQ(ierr);
1262ad6bc421SBarry Smith   ierr = TSAdaptLoad(tsadapt,viewer);CHKERRQ(ierr);
1263f2c2a1b9SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1264f2c2a1b9SBarry Smith   ierr = SNESLoad(snes,viewer);CHKERRQ(ierr);
1265ad6bc421SBarry Smith   /* function and Jacobian context for SNES when used with TS is always ts object */
12660298fd71SBarry Smith   ierr = SNESSetFunction(snes,NULL,NULL,ts);CHKERRQ(ierr);
12670298fd71SBarry Smith   ierr = SNESSetJacobian(snes,NULL,NULL,NULL,ts);CHKERRQ(ierr);
1268f2c2a1b9SBarry Smith   PetscFunctionReturn(0);
1269f2c2a1b9SBarry Smith }
1270f2c2a1b9SBarry Smith 
1271f2c2a1b9SBarry Smith #undef __FUNCT__
12728a381b04SJed Brown #define __FUNCT__ "TSARKIMEXSetType"
12738a381b04SJed Brown /*@C
12748a381b04SJed Brown   TSARKIMEXSetType - Set the type of ARK IMEX scheme
12758a381b04SJed Brown 
12768a381b04SJed Brown   Logically collective
12778a381b04SJed Brown 
12788a381b04SJed Brown   Input Parameter:
12798a381b04SJed Brown +  ts - timestepping context
12808a381b04SJed Brown -  arktype - type of ARK-IMEX scheme
12818a381b04SJed Brown 
12828a381b04SJed Brown   Level: intermediate
12838a381b04SJed Brown 
1284020d8f30SJed Brown .seealso: TSARKIMEXGetType(), TSARKIMEX, TSARKIMEX2D, TSARKIMEX2E, TSARKIMEXPRSSP2, TSARKIMEX3, TSARKIMEXBPR3, TSARKIMEXARS443, TSARKIMEX4, TSARKIMEX5
12858a381b04SJed Brown @*/
128619fd82e9SBarry Smith PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType arktype)
12878a381b04SJed Brown {
12888a381b04SJed Brown   PetscErrorCode ierr;
12898a381b04SJed Brown 
12908a381b04SJed Brown   PetscFunctionBegin;
12918a381b04SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
129219fd82e9SBarry Smith   ierr = PetscTryMethod(ts,"TSARKIMEXSetType_C",(TS,TSARKIMEXType),(ts,arktype));CHKERRQ(ierr);
12938a381b04SJed Brown   PetscFunctionReturn(0);
12948a381b04SJed Brown }
12958a381b04SJed Brown 
12968a381b04SJed Brown #undef __FUNCT__
12978a381b04SJed Brown #define __FUNCT__ "TSARKIMEXGetType"
12988a381b04SJed Brown /*@C
12998a381b04SJed Brown   TSARKIMEXGetType - Get the type of ARK IMEX scheme
13008a381b04SJed Brown 
13018a381b04SJed Brown   Logically collective
13028a381b04SJed Brown 
13038a381b04SJed Brown   Input Parameter:
13048a381b04SJed Brown .  ts - timestepping context
13058a381b04SJed Brown 
13068a381b04SJed Brown   Output Parameter:
13078a381b04SJed Brown .  arktype - type of ARK-IMEX scheme
13088a381b04SJed Brown 
13098a381b04SJed Brown   Level: intermediate
13108a381b04SJed Brown 
13118a381b04SJed Brown .seealso: TSARKIMEXGetType()
13128a381b04SJed Brown @*/
131319fd82e9SBarry Smith PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType *arktype)
13148a381b04SJed Brown {
13158a381b04SJed Brown   PetscErrorCode ierr;
13168a381b04SJed Brown 
13178a381b04SJed Brown   PetscFunctionBegin;
13188a381b04SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
131919fd82e9SBarry Smith   ierr = PetscUseMethod(ts,"TSARKIMEXGetType_C",(TS,TSARKIMEXType*),(ts,arktype));CHKERRQ(ierr);
13208a381b04SJed Brown   PetscFunctionReturn(0);
13218a381b04SJed Brown }
13228a381b04SJed Brown 
13234cc180ffSJed Brown #undef __FUNCT__
13244cc180ffSJed Brown #define __FUNCT__ "TSARKIMEXSetFullyImplicit"
132516353aafSBarry Smith /*@
13264cc180ffSJed Brown   TSARKIMEXSetFullyImplicit - Solve both parts of the equation implicitly
13274cc180ffSJed Brown 
13284cc180ffSJed Brown   Logically collective
13294cc180ffSJed Brown 
13304cc180ffSJed Brown   Input Parameter:
13314cc180ffSJed Brown +  ts - timestepping context
13324cc180ffSJed Brown -  flg - PETSC_TRUE for fully implicit
13334cc180ffSJed Brown 
13344cc180ffSJed Brown   Level: intermediate
13354cc180ffSJed Brown 
13364cc180ffSJed Brown .seealso: TSARKIMEXGetType()
13374cc180ffSJed Brown @*/
13384cc180ffSJed Brown PetscErrorCode TSARKIMEXSetFullyImplicit(TS ts,PetscBool flg)
13394cc180ffSJed Brown {
13404cc180ffSJed Brown   PetscErrorCode ierr;
13414cc180ffSJed Brown 
13424cc180ffSJed Brown   PetscFunctionBegin;
13434cc180ffSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13444cc180ffSJed Brown   ierr = PetscTryMethod(ts,"TSARKIMEXSetFullyImplicit_C",(TS,PetscBool),(ts,flg));CHKERRQ(ierr);
13454cc180ffSJed Brown   PetscFunctionReturn(0);
13464cc180ffSJed Brown }
13474cc180ffSJed Brown 
13488a381b04SJed Brown #undef __FUNCT__
13498a381b04SJed Brown #define __FUNCT__ "TSARKIMEXGetType_ARKIMEX"
135019fd82e9SBarry Smith PetscErrorCode  TSARKIMEXGetType_ARKIMEX(TS ts,TSARKIMEXType *arktype)
13518a381b04SJed Brown {
13528a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
13538a381b04SJed Brown   PetscErrorCode ierr;
13548a381b04SJed Brown 
13558a381b04SJed Brown   PetscFunctionBegin;
1356f2c2a1b9SBarry Smith   if (!ark->tableau) {
1357f2c2a1b9SBarry Smith     ierr = TSARKIMEXSetType(ts,TSARKIMEXDefault);CHKERRQ(ierr);
1358f2c2a1b9SBarry Smith   }
13598a381b04SJed Brown   *arktype = ark->tableau->name;
13608a381b04SJed Brown   PetscFunctionReturn(0);
13618a381b04SJed Brown }
13628a381b04SJed Brown #undef __FUNCT__
13638a381b04SJed Brown #define __FUNCT__ "TSARKIMEXSetType_ARKIMEX"
136419fd82e9SBarry Smith PetscErrorCode  TSARKIMEXSetType_ARKIMEX(TS ts,TSARKIMEXType arktype)
13658a381b04SJed Brown {
13668a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
13678a381b04SJed Brown   PetscErrorCode ierr;
13688a381b04SJed Brown   PetscBool      match;
13698a381b04SJed Brown   ARKTableauLink link;
13708a381b04SJed Brown 
13718a381b04SJed Brown   PetscFunctionBegin;
13728a381b04SJed Brown   if (ark->tableau) {
13738a381b04SJed Brown     ierr = PetscStrcmp(ark->tableau->name,arktype,&match);CHKERRQ(ierr);
13748a381b04SJed Brown     if (match) PetscFunctionReturn(0);
13758a381b04SJed Brown   }
13768a381b04SJed Brown   for (link = ARKTableauList; link; link=link->next) {
13778a381b04SJed Brown     ierr = PetscStrcmp(link->tab.name,arktype,&match);CHKERRQ(ierr);
13788a381b04SJed Brown     if (match) {
13798a381b04SJed Brown       ierr = TSReset_ARKIMEX(ts);CHKERRQ(ierr);
13808a381b04SJed Brown       ark->tableau = &link->tab;
13818a381b04SJed Brown       PetscFunctionReturn(0);
13828a381b04SJed Brown     }
13838a381b04SJed Brown   }
1384ce94432eSBarry Smith   SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_UNKNOWN_TYPE,"Could not find '%s'",arktype);
13858a381b04SJed Brown   PetscFunctionReturn(0);
13868a381b04SJed Brown }
13874cc180ffSJed Brown #undef __FUNCT__
13884cc180ffSJed Brown #define __FUNCT__ "TSARKIMEXSetFullyImplicit_ARKIMEX"
13894cc180ffSJed Brown PetscErrorCode  TSARKIMEXSetFullyImplicit_ARKIMEX(TS ts,PetscBool flg)
13904cc180ffSJed Brown {
13914cc180ffSJed Brown   TS_ARKIMEX *ark = (TS_ARKIMEX*)ts->data;
13924cc180ffSJed Brown 
13934cc180ffSJed Brown   PetscFunctionBegin;
13944cc180ffSJed Brown   ark->imex = (PetscBool)!flg;
13954cc180ffSJed Brown   PetscFunctionReturn(0);
13964cc180ffSJed Brown }
13978a381b04SJed Brown 
13988a381b04SJed Brown /* ------------------------------------------------------------ */
13998a381b04SJed Brown /*MC
1400a4386c9eSJed Brown       TSARKIMEX - ODE and DAE solver using Additive Runge-Kutta IMEX schemes
14018a381b04SJed Brown 
1402fca742c7SJed Brown   These methods are intended for problems with well-separated time scales, especially when a slow scale is strongly
1403fca742c7SJed Brown   nonlinear such that it is expensive to solve with a fully implicit method. The user should provide the stiff part
1404fca742c7SJed Brown   of the equation using TSSetIFunction() and the non-stiff part with TSSetRHSFunction().
1405fca742c7SJed Brown 
1406fca742c7SJed Brown   Notes:
1407a4386c9eSJed Brown   The default is TSARKIMEX3, it can be changed with TSARKIMEXSetType() or -ts_arkimex_type
1408c8058688SBarry Smith 
14095eca1a21SEmil Constantinescu   If the equation is implicit or a DAE, then TSSetEquationType() needs to be set accordingly. Refer to the manual for further information.
14105eca1a21SEmil Constantinescu 
1411a4386c9eSJed Brown   Methods with an explicit stage can only be used with ODE in which the stiff part G(t,X,Xdot) has the form Xdot + Ghat(t,X).
1412fca742c7SJed Brown 
1413d0685a90SJed Brown   Consider trying TSROSW if the stiff part is linear or weakly nonlinear.
1414d0685a90SJed Brown 
14158a381b04SJed Brown   Level: beginner
14168a381b04SJed Brown 
1417d0685a90SJed Brown .seealso:  TSCreate(), TS, TSSetType(), TSARKIMEXSetType(), TSARKIMEXGetType(), TSARKIMEXSetFullyImplicit(), TSARKIMEX1BEE,
1418d0685a90SJed Brown            TSARKIMEX2C, TSARKIMEX2D, TSARKIMEX2E, TSARKIMEX3, TSARKIMEXL2, TSARKIMEXA2, TSARKIMEXARS122,
1419d0685a90SJed Brown            TSARKIMEX4, TSARKIMEX5, TSARKIMEXPRSSP2, TSARKIMEXARS443, TSARKIMEXBPR3, TSARKIMEXType, TSARKIMEXRegister()
14208a381b04SJed Brown 
14218a381b04SJed Brown M*/
14228a381b04SJed Brown #undef __FUNCT__
14238a381b04SJed Brown #define __FUNCT__ "TSCreate_ARKIMEX"
14248cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_ARKIMEX(TS ts)
14258a381b04SJed Brown {
14268a381b04SJed Brown   TS_ARKIMEX     *th;
14278a381b04SJed Brown   PetscErrorCode ierr;
14288a381b04SJed Brown 
14298a381b04SJed Brown   PetscFunctionBegin;
1430607a6623SBarry Smith   ierr = TSARKIMEXInitializePackage();CHKERRQ(ierr);
14318a381b04SJed Brown 
14328a381b04SJed Brown   ts->ops->reset          = TSReset_ARKIMEX;
14338a381b04SJed Brown   ts->ops->destroy        = TSDestroy_ARKIMEX;
14348a381b04SJed Brown   ts->ops->view           = TSView_ARKIMEX;
1435f2c2a1b9SBarry Smith   ts->ops->load           = TSLoad_ARKIMEX;
14368a381b04SJed Brown   ts->ops->setup          = TSSetUp_ARKIMEX;
14378a381b04SJed Brown   ts->ops->step           = TSStep_ARKIMEX;
1438cd652676SJed Brown   ts->ops->interpolate    = TSInterpolate_ARKIMEX;
1439108c343cSJed Brown   ts->ops->evaluatestep   = TSEvaluateStep_ARKIMEX;
144024655328SShri   ts->ops->rollback       = TSRollBack_ARKIMEX;
14418a381b04SJed Brown   ts->ops->setfromoptions = TSSetFromOptions_ARKIMEX;
14428a381b04SJed Brown   ts->ops->snesfunction   = SNESTSFormFunction_ARKIMEX;
14438a381b04SJed Brown   ts->ops->snesjacobian   = SNESTSFormJacobian_ARKIMEX;
14448a381b04SJed Brown 
1445b00a9115SJed Brown   ierr = PetscNewLog(ts,&th);CHKERRQ(ierr);
14468a381b04SJed Brown   ts->data = (void*)th;
14474cc180ffSJed Brown   th->imex = PETSC_TRUE;
14488a381b04SJed Brown 
1449bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXGetType_C",TSARKIMEXGetType_ARKIMEX);CHKERRQ(ierr);
1450bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetType_C",TSARKIMEXSetType_ARKIMEX);CHKERRQ(ierr);
1451bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetFullyImplicit_C",TSARKIMEXSetFullyImplicit_ARKIMEX);CHKERRQ(ierr);
14528a381b04SJed Brown   PetscFunctionReturn(0);
14538a381b04SJed Brown }
1454