xref: /petsc/src/ts/impls/arkimex/arkimex.c (revision be5899b337ba0cfa5eb720cdae190eefe60949dd)
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 */
4856dcabbaSDebojyoti Ghosh   Vec          *Y_prev;          /* States computed during the previous time step */
4956dcabbaSDebojyoti Ghosh   Vec          *YdotI_prev;      /* Time derivatives for the stiff part for the previous time step*/
5056dcabbaSDebojyoti Ghosh   Vec          *YdotRHS_prev;    /* Function evaluations for the non-stiff part for the previous time step*/
51e817cc15SEmil Constantinescu   Vec          Ydot0;            /* Holds the slope from the previous step in FSAL case */
528a381b04SJed Brown   Vec          Ydot;             /* Work vector holding Ydot during residual evaluation */
538a381b04SJed Brown   Vec          Z;                /* Ydot = shift(Y-Z) */
548a381b04SJed Brown   PetscScalar  *work;            /* Scalar work */
55b296d7d5SJed Brown   PetscReal    scoeff;           /* shift = scoeff/dt */
568a381b04SJed Brown   PetscReal    stage_time;
574cc180ffSJed Brown   PetscBool    imex;
5896400bd6SLisandro Dalcin   PetscBool    extrapolate;      /* Extrapolate initial guess from previous time-step stage values */
59108c343cSJed Brown   TSStepStatus status;
608a381b04SJed Brown } TS_ARKIMEX;
611f80e275SEmil Constantinescu /*MC
621f80e275SEmil Constantinescu      TSARKIMEXARS122 - Second order ARK IMEX scheme.
638a381b04SJed Brown 
641f80e275SEmil Constantinescu      This method has one explicit stage and one implicit stage.
651f80e275SEmil Constantinescu 
661f80e275SEmil Constantinescu      References:
6796a0c994SBarry 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).
681f80e275SEmil Constantinescu 
691f80e275SEmil Constantinescu      Level: advanced
701f80e275SEmil Constantinescu 
711f80e275SEmil Constantinescu .seealso: TSARKIMEX
721f80e275SEmil Constantinescu M*/
731f80e275SEmil Constantinescu /*MC
741f80e275SEmil Constantinescu      TSARKIMEXA2 - Second order ARK IMEX scheme with A-stable implicit part.
751f80e275SEmil Constantinescu 
761f80e275SEmil 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.
771f80e275SEmil Constantinescu 
781f80e275SEmil Constantinescu      Level: advanced
791f80e275SEmil Constantinescu 
801f80e275SEmil Constantinescu .seealso: TSARKIMEX
811f80e275SEmil Constantinescu M*/
821f80e275SEmil Constantinescu /*MC
831f80e275SEmil Constantinescu      TSARKIMEXL2 - Second order ARK IMEX scheme with L-stable implicit part.
841f80e275SEmil Constantinescu 
851f80e275SEmil Constantinescu      This method has two implicit stages, and L-stable implicit scheme.
861f80e275SEmil Constantinescu 
871f80e275SEmil Constantinescu     References:
8896a0c994SBarry 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.
891f80e275SEmil Constantinescu 
901f80e275SEmil Constantinescu      Level: advanced
911f80e275SEmil Constantinescu 
921f80e275SEmil Constantinescu .seealso: TSARKIMEX
931f80e275SEmil Constantinescu M*/
941f80e275SEmil Constantinescu /*MC
95e817cc15SEmil Constantinescu      TSARKIMEX1BEE - First order Backward Euler represented as an ARK IMEX scheme with extrapolation as error estimator. This is a 3-stage method.
96e817cc15SEmil Constantinescu 
97e817cc15SEmil Constantinescu      This method is aimed at starting the integration of implicit DAEs when explicit first-stage ARK methods are used.
98e817cc15SEmil Constantinescu 
99e817cc15SEmil Constantinescu      Level: advanced
100e817cc15SEmil Constantinescu 
101e817cc15SEmil Constantinescu .seealso: TSARKIMEX
102e817cc15SEmil Constantinescu M*/
103e817cc15SEmil Constantinescu /*MC
1041f80e275SEmil Constantinescu      TSARKIMEX2C - Second order ARK IMEX scheme with L-stable implicit part.
1051f80e275SEmil Constantinescu 
1061f80e275SEmil 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.
1071f80e275SEmil Constantinescu 
1081f80e275SEmil Constantinescu      Level: advanced
1091f80e275SEmil Constantinescu 
1101f80e275SEmil Constantinescu .seealso: TSARKIMEX
1111f80e275SEmil Constantinescu M*/
11264f491ddSJed Brown /*MC
11364f491ddSJed Brown      TSARKIMEX2D - Second order ARK IMEX scheme with L-stable implicit part.
11464f491ddSJed Brown 
115617a39beSEmil 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.
11664f491ddSJed Brown 
117b330ce4dSSatish Balay      Level: advanced
118b330ce4dSSatish Balay 
11964f491ddSJed Brown .seealso: TSARKIMEX
12064f491ddSJed Brown M*/
12164f491ddSJed Brown /*MC
12264f491ddSJed Brown      TSARKIMEX2E - Second order ARK IMEX scheme with L-stable implicit part.
12364f491ddSJed Brown 
12464f491ddSJed Brown      This method has one explicit stage and two implicit stages. It is is an optimal method developed by Emil Constantinescu.
12564f491ddSJed Brown 
126b330ce4dSSatish Balay      Level: advanced
127b330ce4dSSatish Balay 
12864f491ddSJed Brown .seealso: TSARKIMEX
12964f491ddSJed Brown M*/
13064f491ddSJed Brown /*MC
1316cf0794eSJed Brown      TSARKIMEXPRSSP2 - Second order SSP ARK IMEX scheme.
1326cf0794eSJed Brown 
1336cf0794eSJed Brown      This method has three implicit stages.
1346cf0794eSJed Brown 
1356cf0794eSJed Brown      References:
13696a0c994SBarry 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.
1376cf0794eSJed Brown 
1386cf0794eSJed Brown      This method is referred to as SSP2-(3,3,2) in http://arxiv.org/abs/1110.4375
1396cf0794eSJed Brown 
1406cf0794eSJed Brown      Level: advanced
1416cf0794eSJed Brown 
1426cf0794eSJed Brown .seealso: TSARKIMEX
1436cf0794eSJed Brown M*/
1446cf0794eSJed Brown /*MC
14564f491ddSJed Brown      TSARKIMEX3 - Third order ARK IMEX scheme with L-stable implicit part.
14664f491ddSJed Brown 
14764f491ddSJed Brown      This method has one explicit stage and three implicit stages.
14864f491ddSJed Brown 
14964f491ddSJed Brown      References:
15096a0c994SBarry Smith .   1. -  Kennedy and Carpenter 2003.
15164f491ddSJed Brown 
152b330ce4dSSatish Balay      Level: advanced
153b330ce4dSSatish Balay 
15464f491ddSJed Brown .seealso: TSARKIMEX
15564f491ddSJed Brown M*/
15664f491ddSJed Brown /*MC
1576cf0794eSJed Brown      TSARKIMEXARS443 - Third order ARK IMEX scheme.
1586cf0794eSJed Brown 
1596cf0794eSJed Brown      This method has one explicit stage and four implicit stages.
1606cf0794eSJed Brown 
1616cf0794eSJed Brown      References:
16296a0c994SBarry 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).
16396a0c994SBarry Smith -   2. -  This method is referred to as ARS(4,4,3) in http://arxiv.org/abs/1110.4375
1646cf0794eSJed Brown 
1656cf0794eSJed Brown      Level: advanced
1666cf0794eSJed Brown 
1676cf0794eSJed Brown .seealso: TSARKIMEX
1686cf0794eSJed Brown M*/
1696cf0794eSJed Brown /*MC
1706cf0794eSJed Brown      TSARKIMEXBPR3 - Third order ARK IMEX scheme.
1716cf0794eSJed Brown 
1726cf0794eSJed Brown      This method has one explicit stage and four implicit stages.
1736cf0794eSJed Brown 
1746cf0794eSJed Brown      References:
17596a0c994SBarry Smith  .    This method is referred to as ARK3 in http://arxiv.org/abs/1110.4375
1766cf0794eSJed Brown 
1776cf0794eSJed Brown      Level: advanced
1786cf0794eSJed Brown 
1796cf0794eSJed Brown .seealso: TSARKIMEX
1806cf0794eSJed Brown M*/
1816cf0794eSJed Brown /*MC
18264f491ddSJed Brown      TSARKIMEX4 - Fourth order ARK IMEX scheme with L-stable implicit part.
18364f491ddSJed Brown 
18464f491ddSJed Brown      This method has one explicit stage and four implicit stages.
18564f491ddSJed Brown 
18664f491ddSJed Brown      References:
18796a0c994SBarry Smith .     Kennedy and Carpenter 2003.
18864f491ddSJed Brown 
189b330ce4dSSatish Balay      Level: advanced
190b330ce4dSSatish Balay 
19164f491ddSJed Brown .seealso: TSARKIMEX
19264f491ddSJed Brown M*/
19364f491ddSJed Brown /*MC
19464f491ddSJed Brown      TSARKIMEX5 - Fifth order ARK IMEX scheme with L-stable implicit part.
19564f491ddSJed Brown 
19664f491ddSJed Brown      This method has one explicit stage and five implicit stages.
19764f491ddSJed Brown 
19864f491ddSJed Brown      References:
19996a0c994SBarry Smith .     Kennedy and Carpenter 2003.
20064f491ddSJed Brown 
201b330ce4dSSatish Balay      Level: advanced
202b330ce4dSSatish Balay 
20364f491ddSJed Brown .seealso: TSARKIMEX
20464f491ddSJed Brown M*/
20564f491ddSJed Brown 
2068a381b04SJed Brown #undef __FUNCT__
2078a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegisterAll"
2088a381b04SJed Brown /*@C
2098a381b04SJed Brown   TSARKIMEXRegisterAll - Registers all of the additive Runge-Kutta implicit-explicit methods in TSARKIMEX
2108a381b04SJed Brown 
211fca742c7SJed Brown   Not Collective, but should be called by all processes which will need the schemes to be registered
2128a381b04SJed Brown 
2138a381b04SJed Brown   Level: advanced
2148a381b04SJed Brown 
2158a381b04SJed Brown .keywords: TS, TSARKIMEX, register, all
2168a381b04SJed Brown 
2178a381b04SJed Brown .seealso:  TSARKIMEXRegisterDestroy()
2188a381b04SJed Brown @*/
2198a381b04SJed Brown PetscErrorCode TSARKIMEXRegisterAll(void)
2208a381b04SJed Brown {
2218a381b04SJed Brown   PetscErrorCode ierr;
2228a381b04SJed Brown 
2238a381b04SJed Brown   PetscFunctionBegin;
2248a381b04SJed Brown   if (TSARKIMEXRegisterAllCalled) PetscFunctionReturn(0);
2258a381b04SJed Brown   TSARKIMEXRegisterAllCalled = PETSC_TRUE;
226e817cc15SEmil Constantinescu 
227e817cc15SEmil Constantinescu   {
228e817cc15SEmil Constantinescu     const PetscReal
229e817cc15SEmil Constantinescu       A[3][3] = {{0.0,0.0,0.0},
230e817cc15SEmil Constantinescu                  {0.0,0.0,0.0},
231748ad121SEmil Constantinescu                  {0.0,0.5,0.0}},
232e817cc15SEmil Constantinescu       At[3][3] = {{1.0,0.0,0.0},
233e817cc15SEmil Constantinescu                   {0.0,0.5,0.0},
234e817cc15SEmil Constantinescu                   {0.0,0.5,0.5}},
235e817cc15SEmil Constantinescu       b[3]       = {0.0,0.5,0.5},
236e817cc15SEmil Constantinescu       bembedt[3] = {1.0,0.0,0.0};
2370298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX1BEE,2,3,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
238e817cc15SEmil Constantinescu   }
2398a381b04SJed Brown   {
2408a381b04SJed Brown     const PetscReal
2411f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2421f80e275SEmil Constantinescu                  {0.5,0.0}},
2431f80e275SEmil Constantinescu       At[2][2] = {{0.0,0.0},
2441f80e275SEmil Constantinescu                   {0.0,0.5}},
2451f80e275SEmil Constantinescu       b[2]       = {0.0,1.0},
2461f80e275SEmil Constantinescu       bembedt[2] = {0.5,0.5};
2471f80e275SEmil 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*/
2480298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXARS122,2,2,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
2491f80e275SEmil Constantinescu   }
2501f80e275SEmil Constantinescu   {
2511f80e275SEmil Constantinescu     const PetscReal
2521f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2531f80e275SEmil Constantinescu                  {1.0,0.0}},
2541f80e275SEmil Constantinescu       At[2][2] = {{0.0,0.0},
2551f80e275SEmil Constantinescu                   {0.5,0.5}},
2561f80e275SEmil Constantinescu       b[2]       = {0.5,0.5},
2571f80e275SEmil Constantinescu       bembedt[2] = {0.0,1.0};
2581f80e275SEmil 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*/
2590298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXA2,2,2,&At[0][0],b,NULL,&A[0][0],b,NULL,bembedt,bembedt,1,b,NULL);CHKERRQ(ierr);
2601f80e275SEmil Constantinescu   }
2611f80e275SEmil Constantinescu   {
262da80777bSKarl 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   */
2631f80e275SEmil Constantinescu     const PetscReal
2641f80e275SEmil Constantinescu       A[2][2] = {{0.0,0.0},
2651f80e275SEmil Constantinescu                  {1.0,0.0}},
266da80777bSKarl Rupp       At[2][2] = {{0.2928932188134524755992,0.0},
267da80777bSKarl Rupp                   {1.0-2.0*0.2928932188134524755992,0.2928932188134524755992}},
2681f80e275SEmil Constantinescu       b[2]       = {0.5,0.5},
2691f80e275SEmil Constantinescu       bembedt[2] = {0.0,1.0},
270da80777bSKarl Rupp       binterpt[2][2] = {{  (0.2928932188134524755992-1.0)/(2.0*0.2928932188134524755992-1.0),-1/(2.0*(1.0-2.0*0.2928932188134524755992))},
271da80777bSKarl Rupp                         {1-(0.2928932188134524755992-1.0)/(2.0*0.2928932188134524755992-1.0),-1/(2.0*(1.0-2.0*0.2928932188134524755992))}},
2721f80e275SEmil Constantinescu       binterp[2][2] = {{1.0,-0.5},{0.0,0.5}};
2730298fd71SBarry 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);
2741f80e275SEmil Constantinescu   }
2751f80e275SEmil Constantinescu   {
276da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
277da80777bSKarl Rupp     const PetscReal
2788a381b04SJed Brown       A[3][3] = {{0,0,0},
279da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
280617a39beSEmil Constantinescu                  {0.5,0.5,0}},
281da80777bSKarl Rupp       At[3][3] = {{0,0,0},
282da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
283da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
284da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
285da80777bSKarl Rupp       binterpt[3][2] = {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
286da80777bSKarl Rupp                         {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
287da80777bSKarl Rupp                         {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
2880298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2C,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
2891f80e275SEmil Constantinescu   }
2901f80e275SEmil Constantinescu   {
291da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
292da80777bSKarl Rupp     const PetscReal
2931f80e275SEmil Constantinescu       A[3][3] = {{0,0,0},
294da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
2958a381b04SJed Brown                  {0.75,0.25,0}},
296da80777bSKarl Rupp       At[3][3] = {{0,0,0},
297da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
298da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
299da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
300da80777bSKarl Rupp       binterpt[3][2] =  {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
301da80777bSKarl Rupp                          {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
302da80777bSKarl Rupp                          {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
3030298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2D,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
3048a381b04SJed Brown   }
30506db7b1cSJed Brown   {                             /* Optimal for linear implicit part */
306da80777bSKarl Rupp     /* const PetscReal s2 = PetscSqrtReal((PetscReal)2.0),  Direct evaluation: 1.414213562373095048802. Used below to ensure all values are available at compile time   */
307da80777bSKarl Rupp     const PetscReal
308da80777bSKarl Rupp       A[3][3] = {{0,0,0},
309da80777bSKarl Rupp                  {2-1.414213562373095048802,0,0},
310da80777bSKarl Rupp                  {(3-2*1.414213562373095048802)/6,(3+2*1.414213562373095048802)/6,0}},
311da80777bSKarl Rupp       At[3][3] = {{0,0,0},
312da80777bSKarl Rupp                   {1-1/1.414213562373095048802,1-1/1.414213562373095048802,0},
313da80777bSKarl Rupp                   {1/(2*1.414213562373095048802),1/(2*1.414213562373095048802),1-1/1.414213562373095048802}},
314da80777bSKarl Rupp       bembedt[3] = {(4.-1.414213562373095048802)/8.,(4.-1.414213562373095048802)/8.,1/(2.*1.414213562373095048802)},
315da80777bSKarl Rupp       binterpt[3][2] =  {{1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
316da80777bSKarl Rupp                          {1.0/1.414213562373095048802,-1.0/(2.0*1.414213562373095048802)},
317da80777bSKarl Rupp                          {1.0-1.414213562373095048802,1.0/1.414213562373095048802}};
3180298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX2E,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
319a3a57f36SJed Brown   }
3206cf0794eSJed Brown   {                             /* Optimal for linear implicit part */
3216cf0794eSJed Brown     const PetscReal
3226cf0794eSJed Brown       A[3][3] = {{0,0,0},
3236cf0794eSJed Brown                  {0.5,0,0},
3246cf0794eSJed Brown                  {0.5,0.5,0}},
3256cf0794eSJed Brown       At[3][3] = {{0.25,0,0},
3266cf0794eSJed Brown                   {0,0.25,0},
3276cf0794eSJed Brown                   {1./3,1./3,1./3}};
3280298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXPRSSP2,2,3,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,NULL,NULL,0,NULL,NULL);CHKERRQ(ierr);
3296cf0794eSJed Brown   }
330a3a57f36SJed Brown   {
331a3a57f36SJed Brown     const PetscReal
332a3a57f36SJed Brown       A[4][4] = {{0,0,0,0},
3334040e9f2SJed Brown                  {1767732205903./2027836641118.,0,0,0},
3344040e9f2SJed Brown                  {5535828885825./10492691773637.,788022342437./10882634858940.,0,0},
3354040e9f2SJed Brown                  {6485989280629./16251701735622.,-4246266847089./9704473918619.,10755448449292./10357097424841.,0}},
336a3a57f36SJed Brown       At[4][4] = {{0,0,0,0},
3374040e9f2SJed Brown                   {1767732205903./4055673282236.,1767732205903./4055673282236.,0,0},
3384040e9f2SJed Brown                   {2746238789719./10658868560708.,-640167445237./6845629431997.,1767732205903./4055673282236.,0},
3394040e9f2SJed Brown                   {1471266399579./7840856788654.,-4482444167858./7529755066697.,11266239266428./11593286722821.,1767732205903./4055673282236.}},
340cc46b9d1SJed Brown       bembedt[4]     = {2756255671327./12835298489170.,-10771552573575./22201958757719.,9247589265047./10645013368117.,2193209047091./5459859503100.},
3414040e9f2SJed Brown       binterpt[4][2] = {{4655552711362./22874653954995., -215264564351./13552729205753.},
3424040e9f2SJed Brown                         {-18682724506714./9892148508045.,17870216137069./13817060693119.},
3434040e9f2SJed Brown                         {34259539580243./13192909600954.,-28141676662227./17317692491321.},
3444040e9f2SJed Brown                         {584795268549./6622622206610.,   2508943948391./7218656332882.}};
3450298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX3,3,4,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,2,binterpt[0],NULL);CHKERRQ(ierr);
346a3a57f36SJed Brown   }
347a3a57f36SJed Brown   {
348a3a57f36SJed Brown     const PetscReal
349e74514c0SSatish Balay       A[5][5] = {{0,0,0,0,0},
3506cf0794eSJed Brown                  {1./2,0,0,0,0},
3516cf0794eSJed Brown                  {11./18,1./18,0,0,0},
3526cf0794eSJed Brown                  {5./6,-5./6,.5,0,0},
3536cf0794eSJed Brown                  {1./4,7./4,3./4,-7./4,0}},
3546cf0794eSJed Brown       At[5][5] = {{0,0,0,0,0},
3556cf0794eSJed Brown                   {0,1./2,0,0,0},
3566cf0794eSJed Brown                   {0,1./6,1./2,0,0},
3576cf0794eSJed Brown                   {0,-1./2,1./2,1./2,0},
358108c343cSJed Brown                   {0,3./2,-3./2,1./2,1./2}},
3590298fd71SBarry Smith     *bembedt = NULL;
3600298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXARS443,3,5,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,0,NULL,NULL);CHKERRQ(ierr);
3616cf0794eSJed Brown   }
3626cf0794eSJed Brown   {
3636cf0794eSJed Brown     const PetscReal
364e74514c0SSatish Balay       A[5][5] = {{0,0,0,0,0},
3656cf0794eSJed Brown                  {1,0,0,0,0},
3666cf0794eSJed Brown                  {4./9,2./9,0,0,0},
3676cf0794eSJed Brown                  {1./4,0,3./4,0,0},
3686cf0794eSJed Brown                  {1./4,0,3./5,0,0}},
369e74514c0SSatish Balay       At[5][5] = {{0,0,0,0,0},
3706cf0794eSJed Brown                   {.5,.5,0,0,0},
3716cf0794eSJed Brown                   {5./18,-1./9,.5,0,0},
3726cf0794eSJed Brown                   {.5,0,0,.5,0},
373108c343cSJed Brown                   {.25,0,.75,-.5,.5}},
3740298fd71SBarry Smith     *bembedt = NULL;
3750298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEXBPR3,3,5,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,0,NULL,NULL);CHKERRQ(ierr);
3766cf0794eSJed Brown   }
3776cf0794eSJed Brown   {
3786cf0794eSJed Brown     const PetscReal
379a3a57f36SJed Brown       A[6][6] = {{0,0,0,0,0,0},
380a3a57f36SJed Brown                  {1./2,0,0,0,0,0},
3814040e9f2SJed Brown                  {13861./62500.,6889./62500.,0,0,0,0},
3824040e9f2SJed Brown                  {-116923316275./2393684061468.,-2731218467317./15368042101831.,9408046702089./11113171139209.,0,0,0},
3834040e9f2SJed Brown                  {-451086348788./2902428689909.,-2682348792572./7519795681897.,12662868775082./11960479115383.,3355817975965./11060851509271.,0,0},
3844040e9f2SJed Brown                  {647845179188./3216320057751.,73281519250./8382639484533.,552539513391./3454668386233.,3354512671639./8306763924573.,4040./17871.,0}},
385a3a57f36SJed Brown       At[6][6] = {{0,0,0,0,0,0},
386a3a57f36SJed Brown                   {1./4,1./4,0,0,0,0},
3874040e9f2SJed Brown                   {8611./62500.,-1743./31250.,1./4,0,0,0},
3884040e9f2SJed Brown                   {5012029./34652500.,-654441./2922500.,174375./388108.,1./4,0,0},
3894040e9f2SJed Brown                   {15267082809./155376265600.,-71443401./120774400.,730878875./902184768.,2285395./8070912.,1./4,0},
3904040e9f2SJed Brown                   {82889./524892.,0,15625./83664.,69875./102672.,-2260./8211,1./4}},
391cc46b9d1SJed Brown       bembedt[6]     = {4586570599./29645900160.,0,178811875./945068544.,814220225./1159782912.,-3700637./11593932.,61727./225920.},
3924040e9f2SJed Brown       binterpt[6][3] = {{6943876665148./7220017795957.,-54480133./30881146.,6818779379841./7100303317025.},
393cd652676SJed Brown                         {0,0,0},
3944040e9f2SJed Brown                         {7640104374378./9702883013639.,-11436875./14766696.,2173542590792./12501825683035.},
3954040e9f2SJed Brown                         {-20649996744609./7521556579894.,174696575./18121608.,-31592104683404./5083833661969.},
3964040e9f2SJed Brown                         {8854892464581./2390941311638.,-12120380./966161.,61146701046299./7138195549469.},
3974040e9f2SJed Brown                         {-11397109935349./6675773540249.,3843./706.,-17219254887155./4939391667607.}};
3980298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX4,4,6,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,3,binterpt[0],NULL);CHKERRQ(ierr);
399a3a57f36SJed Brown   }
400a3a57f36SJed Brown   {
401a3a57f36SJed Brown     const PetscReal
402a3a57f36SJed Brown       A[8][8] = {{0,0,0,0,0,0,0,0},
403a3a57f36SJed Brown                  {41./100,0,0,0,0,0,0,0},
4044040e9f2SJed Brown                  {367902744464./2072280473677.,677623207551./8224143866563.,0,0,0,0,0,0},
4054040e9f2SJed Brown                  {1268023523408./10340822734521.,0,1029933939417./13636558850479.,0,0,0,0,0},
4064040e9f2SJed Brown                  {14463281900351./6315353703477.,0,66114435211212./5879490589093.,-54053170152839./4284798021562.,0,0,0,0},
4074040e9f2SJed Brown                  {14090043504691./34967701212078.,0,15191511035443./11219624916014.,-18461159152457./12425892160975.,-281667163811./9011619295870.,0,0,0},
4084040e9f2SJed Brown                  {19230459214898./13134317526959.,0,21275331358303./2942455364971.,-38145345988419./4862620318723.,-1./8,-1./8,0,0},
4094040e9f2SJed Brown                  {-19977161125411./11928030595625.,0,-40795976796054./6384907823539.,177454434618887./12078138498510.,782672205425./8267701900261.,-69563011059811./9646580694205.,7356628210526./4942186776405.,0}},
410a3a57f36SJed Brown       At[8][8] = {{0,0,0,0,0,0,0,0},
4114040e9f2SJed Brown                   {41./200.,41./200.,0,0,0,0,0,0},
4124040e9f2SJed Brown                   {41./400.,-567603406766./11931857230679.,41./200.,0,0,0,0,0},
4134040e9f2SJed Brown                   {683785636431./9252920307686.,0,-110385047103./1367015193373.,41./200.,0,0,0,0},
4144040e9f2SJed Brown                   {3016520224154./10081342136671.,0,30586259806659./12414158314087.,-22760509404356./11113319521817.,41./200.,0,0,0},
4154040e9f2SJed Brown                   {218866479029./1489978393911.,0,638256894668./5436446318841.,-1179710474555./5321154724896.,-60928119172./8023461067671.,41./200.,0,0},
4164040e9f2SJed Brown                   {1020004230633./5715676835656.,0,25762820946817./25263940353407.,-2161375909145./9755907335909.,-211217309593./5846859502534.,-4269925059573./7827059040749.,41./200,0},
4174040e9f2SJed Brown                   {-872700587467./9133579230613.,0,0,22348218063261./9555858737531.,-1143369518992./8141816002931.,-39379526789629./19018526304540.,32727382324388./42900044865799.,41./200.}},
418cc46b9d1SJed Brown       bembedt[8]     = {-975461918565./9796059967033.,0,0,78070527104295./32432590147079.,-548382580838./3424219808633.,-33438840321285./15594753105479.,3629800801594./4656183773603.,4035322873751./18575991585200.},
4194040e9f2SJed Brown       binterpt[8][3] = {{-17674230611817./10670229744614.,  43486358583215./12773830924787., -9257016797708./5021505065439.},
420cd652676SJed Brown                         {0,  0, 0                            },
421cd652676SJed Brown                         {0,  0, 0                            },
4224040e9f2SJed Brown                         {65168852399939./7868540260826.,  -91478233927265./11067650958493., 26096422576131./11239449250142.},
4234040e9f2SJed Brown                         {15494834004392./5936557850923.,  -79368583304911./10890268929626., 92396832856987./20362823103730.},
4244040e9f2SJed Brown                         {-99329723586156./26959484932159.,  -12239297817655./9152339842473., 30029262896817./10175596800299.},
4254040e9f2SJed Brown                         {-19024464361622./5461577185407.,  115839755401235./10719374521269., -26136350496073./3983972220547.},
4264040e9f2SJed Brown                         {-6511271360970./6095937251113.,  5843115559534./2180450260947., -5289405421727./3760307252460. }};
4270298fd71SBarry Smith     ierr = TSARKIMEXRegister(TSARKIMEX5,5,8,&At[0][0],NULL,NULL,&A[0][0],NULL,NULL,bembedt,bembedt,3,binterpt[0],NULL);CHKERRQ(ierr);
428a3a57f36SJed Brown   }
4298a381b04SJed Brown   PetscFunctionReturn(0);
4308a381b04SJed Brown }
4318a381b04SJed Brown 
4328a381b04SJed Brown #undef __FUNCT__
4338a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegisterDestroy"
4348a381b04SJed Brown /*@C
4358a381b04SJed Brown    TSARKIMEXRegisterDestroy - Frees the list of schemes that were registered by TSARKIMEXRegister().
4368a381b04SJed Brown 
4378a381b04SJed Brown    Not Collective
4388a381b04SJed Brown 
4398a381b04SJed Brown    Level: advanced
4408a381b04SJed Brown 
4418a381b04SJed Brown .keywords: TSARKIMEX, register, destroy
442607a6623SBarry Smith .seealso: TSARKIMEXRegister(), TSARKIMEXRegisterAll()
4438a381b04SJed Brown @*/
4448a381b04SJed Brown PetscErrorCode TSARKIMEXRegisterDestroy(void)
4458a381b04SJed Brown {
4468a381b04SJed Brown   PetscErrorCode ierr;
4478a381b04SJed Brown   ARKTableauLink link;
4488a381b04SJed Brown 
4498a381b04SJed Brown   PetscFunctionBegin;
4508a381b04SJed Brown   while ((link = ARKTableauList)) {
4518a381b04SJed Brown     ARKTableau t = &link->tab;
4528a381b04SJed Brown     ARKTableauList = link->next;
4538a381b04SJed Brown     ierr = PetscFree6(t->At,t->bt,t->ct,t->A,t->b,t->c);CHKERRQ(ierr);
454108c343cSJed Brown     ierr = PetscFree2(t->bembedt,t->bembed);CHKERRQ(ierr);
455cd652676SJed Brown     ierr = PetscFree2(t->binterpt,t->binterp);CHKERRQ(ierr);
4568a381b04SJed Brown     ierr = PetscFree(t->name);CHKERRQ(ierr);
4578a381b04SJed Brown     ierr = PetscFree(link);CHKERRQ(ierr);
4588a381b04SJed Brown   }
4598a381b04SJed Brown   TSARKIMEXRegisterAllCalled = PETSC_FALSE;
4608a381b04SJed Brown   PetscFunctionReturn(0);
4618a381b04SJed Brown }
4628a381b04SJed Brown 
4638a381b04SJed Brown #undef __FUNCT__
4648a381b04SJed Brown #define __FUNCT__ "TSARKIMEXInitializePackage"
4658a381b04SJed Brown /*@C
4668a381b04SJed Brown   TSARKIMEXInitializePackage - This function initializes everything in the TSARKIMEX package. It is called
4678a381b04SJed Brown   from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to TSCreate_ARKIMEX()
4688a381b04SJed Brown   when using static libraries.
4698a381b04SJed Brown 
4708a381b04SJed Brown   Level: developer
4718a381b04SJed Brown 
4728a381b04SJed Brown .keywords: TS, TSARKIMEX, initialize, package
4738a381b04SJed Brown .seealso: PetscInitialize()
4748a381b04SJed Brown @*/
475607a6623SBarry Smith PetscErrorCode TSARKIMEXInitializePackage(void)
4768a381b04SJed Brown {
4778a381b04SJed Brown   PetscErrorCode ierr;
4788a381b04SJed Brown 
4798a381b04SJed Brown   PetscFunctionBegin;
4808a381b04SJed Brown   if (TSARKIMEXPackageInitialized) PetscFunctionReturn(0);
4818a381b04SJed Brown   TSARKIMEXPackageInitialized = PETSC_TRUE;
4828a381b04SJed Brown   ierr = TSARKIMEXRegisterAll();CHKERRQ(ierr);
483e817cc15SEmil Constantinescu   ierr = PetscObjectComposedDataRegister(&explicit_stage_time_id);CHKERRQ(ierr);
4848a381b04SJed Brown   ierr = PetscRegisterFinalize(TSARKIMEXFinalizePackage);CHKERRQ(ierr);
4858a381b04SJed Brown   PetscFunctionReturn(0);
4868a381b04SJed Brown }
4878a381b04SJed Brown 
4888a381b04SJed Brown #undef __FUNCT__
4898a381b04SJed Brown #define __FUNCT__ "TSARKIMEXFinalizePackage"
4908a381b04SJed Brown /*@C
4918a381b04SJed Brown   TSARKIMEXFinalizePackage - This function destroys everything in the TSARKIMEX package. It is
4928a381b04SJed Brown   called from PetscFinalize().
4938a381b04SJed Brown 
4948a381b04SJed Brown   Level: developer
4958a381b04SJed Brown 
4968a381b04SJed Brown .keywords: Petsc, destroy, package
4978a381b04SJed Brown .seealso: PetscFinalize()
4988a381b04SJed Brown @*/
4998a381b04SJed Brown PetscErrorCode TSARKIMEXFinalizePackage(void)
5008a381b04SJed Brown {
5018a381b04SJed Brown   PetscErrorCode ierr;
5028a381b04SJed Brown 
5038a381b04SJed Brown   PetscFunctionBegin;
5048a381b04SJed Brown   TSARKIMEXPackageInitialized = PETSC_FALSE;
5058a381b04SJed Brown   ierr = TSARKIMEXRegisterDestroy();CHKERRQ(ierr);
5068a381b04SJed Brown   PetscFunctionReturn(0);
5078a381b04SJed Brown }
5088a381b04SJed Brown 
5098a381b04SJed Brown #undef __FUNCT__
5108a381b04SJed Brown #define __FUNCT__ "TSARKIMEXRegister"
511cd652676SJed Brown /*@C
512cd652676SJed Brown    TSARKIMEXRegister - register an ARK IMEX scheme by providing the entries in the Butcher tableau and optionally embedded approximations and interpolation
513cd652676SJed Brown 
514cd652676SJed Brown    Not Collective, but the same schemes should be registered on all processes on which they will be used
515cd652676SJed Brown 
516cd652676SJed Brown    Input Parameters:
517cd652676SJed Brown +  name - identifier for method
518cd652676SJed Brown .  order - approximation order of method
519cd652676SJed Brown .  s - number of stages, this is the dimension of the matrices below
520cd652676SJed Brown .  At - Butcher table of stage coefficients for stiff part (dimension s*s, row-major)
5210298fd71SBarry Smith .  bt - Butcher table for completing the stiff part of the step (dimension s; NULL to use the last row of At)
5220298fd71SBarry Smith .  ct - Abscissa of each stiff stage (dimension s, NULL to use row sums of At)
523cd652676SJed Brown .  A - Non-stiff stage coefficients (dimension s*s, row-major)
5240298fd71SBarry Smith .  b - Non-stiff step completion table (dimension s; NULL to use last row of At)
5250298fd71SBarry Smith .  c - Non-stiff abscissa (dimension s; NULL to use row sums of A)
5260298fd71SBarry Smith .  bembedt - Stiff part of completion table for embedded method (dimension s; NULL if not available)
5270298fd71SBarry Smith .  bembed - Non-stiff part of completion table for embedded method (dimension s; NULL to use bembedt if provided)
528cd652676SJed Brown .  pinterp - Order of the interpolation scheme, equal to the number of columns of binterpt and binterp
529cd652676SJed Brown .  binterpt - Coefficients of the interpolation formula for the stiff part (dimension s*pinterp)
5300298fd71SBarry Smith -  binterp - Coefficients of the interpolation formula for the non-stiff part (dimension s*pinterp; NULL to reuse binterpt)
531cd652676SJed Brown 
532cd652676SJed Brown    Notes:
533cd652676SJed Brown    Several ARK IMEX methods are provided, this function is only needed to create new methods.
534cd652676SJed Brown 
535cd652676SJed Brown    Level: advanced
536cd652676SJed Brown 
537cd652676SJed Brown .keywords: TS, register
538cd652676SJed Brown 
539cd652676SJed Brown .seealso: TSARKIMEX
540cd652676SJed Brown @*/
54119fd82e9SBarry Smith PetscErrorCode TSARKIMEXRegister(TSARKIMEXType name,PetscInt order,PetscInt s,
5428a381b04SJed Brown                                  const PetscReal At[],const PetscReal bt[],const PetscReal ct[],
543cd652676SJed Brown                                  const PetscReal A[],const PetscReal b[],const PetscReal c[],
544108c343cSJed Brown                                  const PetscReal bembedt[],const PetscReal bembed[],
545cd652676SJed Brown                                  PetscInt pinterp,const PetscReal binterpt[],const PetscReal binterp[])
5468a381b04SJed Brown {
5478a381b04SJed Brown   PetscErrorCode ierr;
5488a381b04SJed Brown   ARKTableauLink link;
5498a381b04SJed Brown   ARKTableau     t;
5508a381b04SJed Brown   PetscInt       i,j;
5518a381b04SJed Brown 
5528a381b04SJed Brown   PetscFunctionBegin;
5531795a4d1SJed Brown   ierr     = PetscCalloc1(1,&link);CHKERRQ(ierr);
5548a381b04SJed Brown   t        = &link->tab;
5558a381b04SJed Brown   ierr     = PetscStrallocpy(name,&t->name);CHKERRQ(ierr);
5568a381b04SJed Brown   t->order = order;
5578a381b04SJed Brown   t->s     = s;
558dcca6d9dSJed 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);
5598a381b04SJed Brown   ierr     = PetscMemcpy(t->At,At,s*s*sizeof(At[0]));CHKERRQ(ierr);
5608a381b04SJed Brown   ierr     = PetscMemcpy(t->A,A,s*s*sizeof(A[0]));CHKERRQ(ierr);
5618a381b04SJed Brown   if (bt) { ierr = PetscMemcpy(t->bt,bt,s*sizeof(bt[0]));CHKERRQ(ierr); }
5628a381b04SJed Brown   else for (i=0; i<s; i++) t->bt[i] = At[(s-1)*s+i];
5638a381b04SJed Brown   if (b)  { ierr = PetscMemcpy(t->b,b,s*sizeof(b[0]));CHKERRQ(ierr); }
5645dceddf7SDebojyoti Ghosh   else for (i=0; i<s; i++) t->b[i] = t->bt[i];
5658a381b04SJed Brown   if (ct) { ierr = PetscMemcpy(t->ct,ct,s*sizeof(ct[0]));CHKERRQ(ierr); }
5668a381b04SJed 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];
5678a381b04SJed Brown   if (c)  { ierr = PetscMemcpy(t->c,c,s*sizeof(c[0]));CHKERRQ(ierr); }
5688a381b04SJed 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];
569e817cc15SEmil Constantinescu   t->stiffly_accurate = PETSC_TRUE;
570e817cc15SEmil Constantinescu   for (i=0; i<s; i++) if (t->At[(s-1)*s+i] != t->bt[i]) t->stiffly_accurate = PETSC_FALSE;
571e817cc15SEmil Constantinescu   t->explicit_first_stage = PETSC_TRUE;
572e817cc15SEmil Constantinescu   for (i=0; i<s; i++) if (t->At[i] != 0.0) t->explicit_first_stage = PETSC_FALSE;
573e817cc15SEmil Constantinescu   /*def of FSAL can be made more precise*/
5744e9d4bf5SJed Brown   t->FSAL_implicit = (PetscBool)(t->explicit_first_stage && t->stiffly_accurate);
575108c343cSJed Brown   if (bembedt) {
576dcca6d9dSJed Brown     ierr = PetscMalloc2(s,&t->bembedt,s,&t->bembed);CHKERRQ(ierr);
577108c343cSJed Brown     ierr = PetscMemcpy(t->bembedt,bembedt,s*sizeof(bembedt[0]));CHKERRQ(ierr);
578108c343cSJed Brown     ierr = PetscMemcpy(t->bembed,bembed ? bembed : bembedt,s*sizeof(bembed[0]));CHKERRQ(ierr);
579108c343cSJed Brown   }
580108c343cSJed Brown 
5814f385281SJed Brown   t->pinterp     = pinterp;
582dcca6d9dSJed Brown   ierr           = PetscMalloc2(s*pinterp,&t->binterpt,s*pinterp,&t->binterp);CHKERRQ(ierr);
583cd652676SJed Brown   ierr           = PetscMemcpy(t->binterpt,binterpt,s*pinterp*sizeof(binterpt[0]));CHKERRQ(ierr);
584cd652676SJed Brown   ierr           = PetscMemcpy(t->binterp,binterp ? binterp : binterpt,s*pinterp*sizeof(binterpt[0]));CHKERRQ(ierr);
5858a381b04SJed Brown   link->next     = ARKTableauList;
5868a381b04SJed Brown   ARKTableauList = link;
5878a381b04SJed Brown   PetscFunctionReturn(0);
5888a381b04SJed Brown }
5898a381b04SJed Brown 
5908a381b04SJed Brown #undef __FUNCT__
591108c343cSJed Brown #define __FUNCT__ "TSEvaluateStep_ARKIMEX"
592108c343cSJed Brown /*
593108c343cSJed Brown  The step completion formula is
594108c343cSJed Brown 
595108c343cSJed Brown  x1 = x0 - h bt^T YdotI + h b^T YdotRHS
596108c343cSJed Brown 
597108c343cSJed Brown  This function can be called before or after ts->vec_sol has been updated.
598108c343cSJed Brown  Suppose we have a completion formula (bt,b) and an embedded formula (bet,be) of different order.
599108c343cSJed Brown  We can write
600108c343cSJed Brown 
601108c343cSJed Brown  x1e = x0 - h bet^T YdotI + h be^T YdotRHS
602108c343cSJed Brown      = x1 + h bt^T YdotI - h b^T YdotRHS - h bet^T YdotI + h be^T YdotRHS
603108c343cSJed Brown      = x1 - h (bet - bt)^T YdotI + h (be - b)^T YdotRHS
604108c343cSJed Brown 
605108c343cSJed Brown  so we can evaluate the method with different order even after the step has been optimistically completed.
606108c343cSJed Brown */
607108c343cSJed Brown static PetscErrorCode TSEvaluateStep_ARKIMEX(TS ts,PetscInt order,Vec X,PetscBool *done)
608108c343cSJed Brown {
609108c343cSJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
610108c343cSJed Brown   ARKTableau     tab  = ark->tableau;
611108c343cSJed Brown   PetscScalar    *w   = ark->work;
612108c343cSJed Brown   PetscReal      h;
613108c343cSJed Brown   PetscInt       s = tab->s,j;
614108c343cSJed Brown   PetscErrorCode ierr;
615108c343cSJed Brown 
616108c343cSJed Brown   PetscFunctionBegin;
617108c343cSJed Brown   switch (ark->status) {
618108c343cSJed Brown   case TS_STEP_INCOMPLETE:
619108c343cSJed Brown   case TS_STEP_PENDING:
620108c343cSJed Brown     h = ts->time_step; break;
621108c343cSJed Brown   case TS_STEP_COMPLETE:
622*be5899b3SLisandro Dalcin     h = ts->ptime - ts->ptime_prev; break;
623ce94432eSBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Invalid TSStepStatus");
624108c343cSJed Brown   }
625108c343cSJed Brown   if (order == tab->order) {
626e817cc15SEmil Constantinescu     if (ark->status == TS_STEP_INCOMPLETE) {
627740132f1SEmil Constantinescu       if (!ark->imex && tab->stiffly_accurate) { /* Only the stiffly accurate implicit formula is used */
628e817cc15SEmil Constantinescu         ierr = VecCopy(ark->Y[s-1],X);CHKERRQ(ierr);
629e817cc15SEmil Constantinescu       } else { /* Use the standard completion formula (bt,b) */
630108c343cSJed Brown         ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
631e817cc15SEmil Constantinescu         for (j=0; j<s; j++) w[j] = h*tab->bt[j];
632108c343cSJed Brown         ierr = VecMAXPY(X,s,w,ark->YdotI);CHKERRQ(ierr);
633e817cc15SEmil Constantinescu         if (ark->imex) { /* Method is IMEX, complete the explicit formula */
634108c343cSJed Brown           for (j=0; j<s; j++) w[j] = h*tab->b[j];
635108c343cSJed Brown           ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
636e817cc15SEmil Constantinescu         }
637e817cc15SEmil Constantinescu       }
638108c343cSJed Brown     } else {ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);}
639108c343cSJed Brown     if (done) *done = PETSC_TRUE;
640108c343cSJed Brown     PetscFunctionReturn(0);
641108c343cSJed Brown   } else if (order == tab->order-1) {
642108c343cSJed Brown     if (!tab->bembedt) goto unavailable;
643108c343cSJed Brown     if (ark->status == TS_STEP_INCOMPLETE) { /* Complete with the embedded method (bet,be) */
644108c343cSJed Brown       ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
645e817cc15SEmil Constantinescu       for (j=0; j<s; j++) w[j] = h*tab->bembedt[j];
646108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotI);CHKERRQ(ierr);
647108c343cSJed Brown       for (j=0; j<s; j++) w[j] = h*tab->bembed[j];
648108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
649108c343cSJed Brown     } else { /* Rollback and re-complete using (bet-be,be-b) */
650108c343cSJed Brown       ierr = VecCopy(ts->vec_sol,X);CHKERRQ(ierr);
651e817cc15SEmil Constantinescu       for (j=0; j<s; j++) w[j] = h*(tab->bembedt[j] - tab->bt[j]);
652108c343cSJed Brown       ierr = VecMAXPY(X,tab->s,w,ark->YdotI);CHKERRQ(ierr);
653108c343cSJed Brown       for (j=0; j<s; j++) w[j] = h*(tab->bembed[j] - tab->b[j]);
654108c343cSJed Brown       ierr = VecMAXPY(X,s,w,ark->YdotRHS);CHKERRQ(ierr);
655108c343cSJed Brown     }
656108c343cSJed Brown     if (done) *done = PETSC_TRUE;
657108c343cSJed Brown     PetscFunctionReturn(0);
658108c343cSJed Brown   }
659108c343cSJed Brown unavailable:
660108c343cSJed Brown   if (done) *done = PETSC_FALSE;
661a7fac7c2SEmil 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);
662108c343cSJed Brown   PetscFunctionReturn(0);
663108c343cSJed Brown }
664108c343cSJed Brown 
665108c343cSJed Brown #undef __FUNCT__
66624655328SShri #define __FUNCT__ "TSRollBack_ARKIMEX"
66724655328SShri static PetscErrorCode TSRollBack_ARKIMEX(TS ts)
66824655328SShri {
66924655328SShri   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
67024655328SShri   ARKTableau      tab  = ark->tableau;
67124655328SShri   const PetscInt  s    = tab->s;
67224655328SShri   const PetscReal *bt  = tab->bt,*b = tab->b;
67324655328SShri   PetscScalar     *w   = ark->work;
67424655328SShri   Vec             *YdotI = ark->YdotI,*YdotRHS = ark->YdotRHS;
67524655328SShri   PetscInt        j;
676*be5899b3SLisandro Dalcin   PetscReal       h;
67724655328SShri   PetscErrorCode  ierr;
67824655328SShri 
67924655328SShri   PetscFunctionBegin;
680*be5899b3SLisandro Dalcin   switch (ark->status) {
681*be5899b3SLisandro Dalcin   case TS_STEP_INCOMPLETE:
682*be5899b3SLisandro Dalcin   case TS_STEP_PENDING:
683*be5899b3SLisandro Dalcin     h = ts->time_step; break;
684*be5899b3SLisandro Dalcin   case TS_STEP_COMPLETE:
685*be5899b3SLisandro Dalcin     h = ts->ptime - ts->ptime_prev; break;
686*be5899b3SLisandro Dalcin   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Invalid TSStepStatus");
687*be5899b3SLisandro Dalcin   }
68824655328SShri   for (j=0; j<s; j++) w[j] = -h*bt[j];
68924655328SShri   ierr = VecMAXPY(ts->vec_sol,s,w,YdotI);CHKERRQ(ierr);
69024655328SShri   for (j=0; j<s; j++) w[j] = -h*b[j];
69124655328SShri   ierr = VecMAXPY(ts->vec_sol,s,w,YdotRHS);CHKERRQ(ierr);
69224655328SShri   PetscFunctionReturn(0);
69324655328SShri }
69424655328SShri 
69596400bd6SLisandro Dalcin #define TSEvent_Status(ts) (ts->event ? ts->event->status : TSEVENT_NONE)
69696400bd6SLisandro Dalcin 
69724655328SShri #undef __FUNCT__
6988a381b04SJed Brown #define __FUNCT__ "TSStep_ARKIMEX"
6998a381b04SJed Brown static PetscErrorCode TSStep_ARKIMEX(TS ts)
7008a381b04SJed Brown {
7018a381b04SJed Brown   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
7028a381b04SJed Brown   ARKTableau      tab  = ark->tableau;
7038a381b04SJed Brown   const PetscInt  s    = tab->s;
70424655328SShri   const PetscReal *At  = tab->At,*A = tab->A,*ct = tab->ct,*c = tab->c;
705406d0ec2SJed Brown   PetscScalar     *w   = ark->work;
7061297b224SEmil Constantinescu   Vec             *Y   = ark->Y,*YdotI = ark->YdotI,*YdotRHS = ark->YdotRHS,Ydot = ark->Ydot,Ydot0 = ark->Ydot0,Z = ark->Z;
70796400bd6SLisandro Dalcin   PetscBool       extrapolate = ark->extrapolate;
708108c343cSJed Brown   TSAdapt         adapt;
7098a381b04SJed Brown   SNES            snes;
71096400bd6SLisandro Dalcin   PetscInt        i,j,its,lits,next_scheme;
711*be5899b3SLisandro Dalcin   PetscInt        rejections = 0;
71296400bd6SLisandro Dalcin   PetscBool       stageok,accept = PETSC_TRUE;
71396400bd6SLisandro Dalcin   PetscReal       next_time_step = ts->time_step;
7148a381b04SJed Brown   PetscErrorCode  ierr;
7158a381b04SJed Brown 
7168a381b04SJed Brown   PetscFunctionBegin;
71796400bd6SLisandro Dalcin   if (ark->extrapolate && !ark->Y_prev) {
71896400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->Y_prev);CHKERRQ(ierr);
71996400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotI_prev);CHKERRQ(ierr);
72096400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotRHS_prev);CHKERRQ(ierr);
72196400bd6SLisandro Dalcin   }
72296400bd6SLisandro Dalcin 
72396400bd6SLisandro Dalcin   if (!ts->steprollback) {
72496400bd6SLisandro Dalcin     if (ts->equation_type >= TS_EQ_IMPLICIT) { /* Save the initial slope for the next step*/
72596400bd6SLisandro Dalcin       ierr = VecCopy(YdotI[s-1],Ydot0);CHKERRQ(ierr);
72696400bd6SLisandro Dalcin     }
72796400bd6SLisandro Dalcin     if (ark->extrapolate && ts->steps > 0) { /* Save the Y, YdotI, YdotRHS for extrapolation initial guess */
72896400bd6SLisandro Dalcin       for (i = 0; i<s; i++) {
72996400bd6SLisandro Dalcin         ierr = VecCopy(Y[i],ark->Y_prev[i]);CHKERRQ(ierr);
73096400bd6SLisandro Dalcin         ierr = VecCopy(YdotRHS[i],ark->YdotRHS_prev[i]);CHKERRQ(ierr);
73196400bd6SLisandro Dalcin         ierr = VecCopy(YdotI[i],ark->YdotI_prev[i]);CHKERRQ(ierr);
73296400bd6SLisandro Dalcin       }
73396400bd6SLisandro Dalcin     }
73496400bd6SLisandro Dalcin   }
73596400bd6SLisandro Dalcin 
73696400bd6SLisandro Dalcin   if (!ts->steps || TSEvent_Status(ts) == TSEVENT_RESET_NEXTSTEP) extrapolate = PETSC_FALSE;
73796400bd6SLisandro Dalcin 
7380e27d5d5SShri   if (ts->equation_type >= TS_EQ_IMPLICIT && tab->explicit_first_stage && (!ts->event || (ts->event && ts->event->status != TSEVENT_PROCESSING))) {
73996400bd6SLisandro Dalcin     TS        ts_start;
740e817cc15SEmil Constantinescu     PetscReal valid_time;
741e817cc15SEmil Constantinescu     PetscBool isvalid;
74260427346SBarry Smith     ierr = PetscObjectComposedDataGetReal((PetscObject)ts->vec_sol,explicit_stage_time_id,valid_time,isvalid);CHKERRQ(ierr);
743e817cc15SEmil Constantinescu     if (!isvalid || valid_time != ts->ptime) {
744baa10174SEmil Constantinescu       ierr = TSClone(ts,&ts_start);CHKERRQ(ierr);
745bbd56ea5SKarl Rupp 
746e817cc15SEmil Constantinescu       ierr = TSSetSolution(ts_start,ts->vec_sol);CHKERRQ(ierr);
747e817cc15SEmil Constantinescu       ierr = TSSetTime(ts_start,ts->ptime);CHKERRQ(ierr);
748eb082435SEmil Constantinescu       ierr = TSSetDuration(ts_start,1,ts->ptime+ts->time_step);CHKERRQ(ierr);
749feed9e9dSBarry Smith       ierr = TSSetExactFinalTime(ts_start,TS_EXACTFINALTIME_STEPOVER);CHKERRQ(ierr);
750740132f1SEmil Constantinescu       ierr = TSSetTimeStep(ts_start,ts->time_step);CHKERRQ(ierr);
751e817cc15SEmil Constantinescu       ierr = TSSetType(ts_start,TSARKIMEX);CHKERRQ(ierr);
752740132f1SEmil Constantinescu       ierr = TSARKIMEXSetFullyImplicit(ts_start,PETSC_TRUE);CHKERRQ(ierr);
753e817cc15SEmil Constantinescu       ierr = TSARKIMEXSetType(ts_start,TSARKIMEX1BEE);CHKERRQ(ierr);
75434561852SEmil Constantinescu 
755e817cc15SEmil Constantinescu       ierr = TSSolve(ts_start,ts->vec_sol);CHKERRQ(ierr);
756e817cc15SEmil Constantinescu       ierr = TSGetTime(ts_start,&ts->ptime);CHKERRQ(ierr);
75796400bd6SLisandro Dalcin       ierr = TSGetTimeStep(ts_start,&ts->time_step);CHKERRQ(ierr);
758bbd56ea5SKarl Rupp 
759e817cc15SEmil Constantinescu       ierr = VecCopy(((TS_ARKIMEX*)ts_start->data)->Ydot0,Ydot0);CHKERRQ(ierr);
76096400bd6SLisandro Dalcin       ts->steps++;
761*be5899b3SLisandro Dalcin       ts->total_steps++;
76234561852SEmil Constantinescu 
763d15a3a53SEmil Constantinescu       /* Set the correct TS in SNES */
764d15a3a53SEmil Constantinescu       /* We'll try to bypass this by changing the method on the fly */
76596400bd6SLisandro Dalcin       {
76696400bd6SLisandro Dalcin         SNES snes;
76796400bd6SLisandro Dalcin         ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
76896400bd6SLisandro Dalcin         ierr = TSSetSNES(ts,snes);CHKERRQ(ierr);
76996400bd6SLisandro Dalcin       }
770166a6834SEmil Constantinescu       ierr = TSDestroy(&ts_start);CHKERRQ(ierr);
771e817cc15SEmil Constantinescu     }
772e817cc15SEmil Constantinescu   }
773e817cc15SEmil Constantinescu 
774108c343cSJed Brown   ark->status = TS_STEP_INCOMPLETE;
77596400bd6SLisandro Dalcin   while (!ts->reason && ark->status != TS_STEP_COMPLETE) {
77696400bd6SLisandro Dalcin     PetscReal t = ts->ptime;
777108c343cSJed Brown     PetscReal h = ts->time_step;
7788a381b04SJed Brown     for (i=0; i<s; i++) {
7799be3e283SDebojyoti Ghosh       ark->stage_time = t + h*ct[i];
78096400bd6SLisandro Dalcin       ierr = TSPreStage(ts,ark->stage_time);CHKERRQ(ierr);
7818a381b04SJed Brown       if (At[i*s+i] == 0) { /* This stage is explicit */
7826c4ed002SBarry 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");
7838a381b04SJed Brown         ierr = VecCopy(ts->vec_sol,Y[i]);CHKERRQ(ierr);
784e817cc15SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*At[i*s+j];
7858a381b04SJed Brown         ierr = VecMAXPY(Y[i],i,w,YdotI);CHKERRQ(ierr);
7868a381b04SJed Brown         for (j=0; j<i; j++) w[j] = h*A[i*s+j];
7878a381b04SJed Brown         ierr = VecMAXPY(Y[i],i,w,YdotRHS);CHKERRQ(ierr);
7888a381b04SJed Brown       } else {
789b296d7d5SJed Brown         ark->scoeff = 1./At[i*s+i];
7908a381b04SJed Brown         /* Ydot = shift*(Y-Z) */
7918a381b04SJed Brown         ierr = VecCopy(ts->vec_sol,Z);CHKERRQ(ierr);
792e817cc15SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*At[i*s+j];
7934f385281SJed Brown         ierr = VecMAXPY(Z,i,w,YdotI);CHKERRQ(ierr);
794c58d1302SEmil Constantinescu         for (j=0; j<i; j++) w[j] = h*A[i*s+j];
795c58d1302SEmil Constantinescu         ierr = VecMAXPY(Z,i,w,YdotRHS);CHKERRQ(ierr);
79696400bd6SLisandro Dalcin         if (extrapolate) {
79756dcabbaSDebojyoti Ghosh           /* Initial guess extrapolated from previous time step stage values */
79856dcabbaSDebojyoti Ghosh           ierr = TSExtrapolate_ARKIMEX(ts,c[i],Y[i]);CHKERRQ(ierr);
79956dcabbaSDebojyoti Ghosh         } else {
8008a381b04SJed Brown           /* Initial guess taken from last stage */
8018a381b04SJed Brown           ierr = VecCopy(i>0 ? Y[i-1] : ts->vec_sol,Y[i]);CHKERRQ(ierr);
80256dcabbaSDebojyoti Ghosh         }
80396400bd6SLisandro Dalcin         ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
804baa10174SEmil Constantinescu         ierr = SNESSolve(snes,NULL,Y[i]);CHKERRQ(ierr);
8058a381b04SJed Brown         ierr = SNESGetIterationNumber(snes,&its);CHKERRQ(ierr);
8068a381b04SJed Brown         ierr = SNESGetLinearSolveIterations(snes,&lits);CHKERRQ(ierr);
8075ef26d82SJed Brown         ts->snes_its += its; ts->ksp_its += lits;
808552698daSJed Brown         ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
80996400bd6SLisandro Dalcin         ierr = TSAdaptCheckStage(adapt,ts,ark->stage_time,Y[i],&stageok);CHKERRQ(ierr);
81096400bd6SLisandro Dalcin         if (!stageok) {
8111be93e3eSJed Brown           /* We are likely rejecting the step because of solver or function domain problems so we should not attempt to
8121be93e3eSJed Brown            * use extrapolation to initialize the solves on the next attempt. */
81396400bd6SLisandro Dalcin           extrapolate = PETSC_FALSE;
8141be93e3eSJed Brown           goto reject_step;
8151be93e3eSJed Brown         }
8168a381b04SJed Brown       }
817e817cc15SEmil Constantinescu       if (ts->equation_type >= TS_EQ_IMPLICIT) {
818e817cc15SEmil Constantinescu         if (i==0 && tab->explicit_first_stage) {
8196c4ed002SBarry 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);
820df5e1e3dSEmil Constantinescu           ierr = VecCopy(Ydot0,YdotI[0]);CHKERRQ(ierr);                                      /* YdotI = YdotI(tn-1) */
821e817cc15SEmil Constantinescu         } else {
822df5e1e3dSEmil Constantinescu           ierr = VecAXPBYPCZ(YdotI[i],-ark->scoeff/h,ark->scoeff/h,0,Z,Y[i]);CHKERRQ(ierr);  /* YdotI = shift*(X-Z) */
823e817cc15SEmil Constantinescu         }
824e817cc15SEmil Constantinescu       } else {
8255eca1a21SEmil Constantinescu         if (i==0 && tab->explicit_first_stage) {
8268a381b04SJed Brown           ierr = VecZeroEntries(Ydot);CHKERRQ(ierr);
827df5e1e3dSEmil Constantinescu           ierr = TSComputeIFunction(ts,t+h*ct[i],Y[i],Ydot,YdotI[i],ark->imex);CHKERRQ(ierr);/* YdotI = -G(t,Y,0)   */
828e817cc15SEmil Constantinescu           ierr = VecScale(YdotI[i],-1.0);CHKERRQ(ierr);
8295eca1a21SEmil Constantinescu         } else {
830df5e1e3dSEmil Constantinescu           ierr = VecAXPBYPCZ(YdotI[i],-ark->scoeff/h,ark->scoeff/h,0,Z,Y[i]);CHKERRQ(ierr);  /* YdotI = shift*(X-Z) */
8315eca1a21SEmil Constantinescu         }
8324cc180ffSJed Brown         if (ark->imex) {
8338a381b04SJed Brown           ierr = TSComputeRHSFunction(ts,t+h*c[i],Y[i],YdotRHS[i]);CHKERRQ(ierr);
8344cc180ffSJed Brown         } else {
8354cc180ffSJed Brown           ierr = VecZeroEntries(YdotRHS[i]);CHKERRQ(ierr);
8364cc180ffSJed Brown         }
8378a381b04SJed Brown       }
83896400bd6SLisandro Dalcin       ierr = TSPostStage(ts,ark->stage_time,i,Y); CHKERRQ(ierr);
839e817cc15SEmil Constantinescu     }
84096400bd6SLisandro Dalcin 
841*be5899b3SLisandro Dalcin     ark->status = TS_STEP_INCOMPLETE;
8420298fd71SBarry Smith     ierr = TSEvaluateStep(ts,tab->order,ts->vec_sol,NULL);CHKERRQ(ierr);
843108c343cSJed Brown     ark->status = TS_STEP_PENDING;
844108c343cSJed Brown     /* Register only the current method as a candidate because we're not supporting multiple candidates yet. */
845552698daSJed Brown     ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
846108c343cSJed Brown     ierr = TSAdaptCandidatesClear(adapt);CHKERRQ(ierr);
847108c343cSJed Brown     ierr = TSAdaptCandidateAdd(adapt,tab->name,tab->order,1,tab->ccfl,1.*tab->s,PETSC_TRUE);CHKERRQ(ierr);
848108c343cSJed Brown     ierr = TSAdaptChoose(adapt,ts,ts->time_step,&next_scheme,&next_time_step,&accept);CHKERRQ(ierr);
84996400bd6SLisandro Dalcin     ark->status = accept ? TS_STEP_COMPLETE : TS_STEP_INCOMPLETE;
85096400bd6SLisandro Dalcin     if (!accept) { /* Roll back the current step */
85196400bd6SLisandro Dalcin       ierr = TSRollBack_ARKIMEX(ts);CHKERRQ(ierr);
852*be5899b3SLisandro Dalcin       ts->time_step = next_time_step;
853*be5899b3SLisandro Dalcin       goto reject_step;
85496400bd6SLisandro Dalcin     }
85596400bd6SLisandro Dalcin 
85696400bd6SLisandro Dalcin     /* Ignore next_scheme for now */
8578a381b04SJed Brown     ts->ptime += ts->time_step;
858cdbf8f93SLisandro Dalcin     ts->time_step = next_time_step;
85996400bd6SLisandro Dalcin 
860e817cc15SEmil Constantinescu     if (tab->explicit_first_stage) {
861e817cc15SEmil Constantinescu       ierr = PetscObjectComposedDataSetReal((PetscObject)ts->vec_sol,explicit_stage_time_id,ts->ptime);CHKERRQ(ierr);
862e817cc15SEmil Constantinescu     }
863108c343cSJed Brown     break;
86496400bd6SLisandro Dalcin 
86596400bd6SLisandro Dalcin   reject_step:
86696400bd6SLisandro Dalcin     ts->reject++;
867*be5899b3SLisandro Dalcin     if (!ts->reason && ++rejections > ts->max_reject && ts->max_reject >= 0) {
86896400bd6SLisandro Dalcin       ts->reason = TS_DIVERGED_STEP_REJECTED;
869*be5899b3SLisandro Dalcin       ierr = PetscInfo2(ts,"Step=%D, step rejections %D greater than current TS allowed, stopping solve\n",ts->steps,rejections);CHKERRQ(ierr);
870108c343cSJed Brown     }
871f85781f1SEmil Constantinescu   }
8728a381b04SJed Brown   PetscFunctionReturn(0);
8738a381b04SJed Brown }
8748a381b04SJed Brown 
875cd652676SJed Brown #undef __FUNCT__
876cd652676SJed Brown #define __FUNCT__ "TSInterpolate_ARKIMEX"
877cd652676SJed Brown static PetscErrorCode TSInterpolate_ARKIMEX(TS ts,PetscReal itime,Vec X)
878cd652676SJed Brown {
879cd652676SJed Brown   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
8804f385281SJed Brown   PetscInt        s    = ark->tableau->s,pinterp = ark->tableau->pinterp,i,j;
881108c343cSJed Brown   PetscReal       h;
882108c343cSJed Brown   PetscReal       tt,t;
883cd652676SJed Brown   PetscScalar     *bt,*b;
884cd652676SJed Brown   const PetscReal *Bt = ark->tableau->binterpt,*B = ark->tableau->binterp;
885cd652676SJed Brown   PetscErrorCode  ierr;
886cd652676SJed Brown 
887cd652676SJed Brown   PetscFunctionBegin;
888ce94432eSBarry Smith   if (!Bt || !B) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSARKIMEX %s does not have an interpolation formula",ark->tableau->name);
889108c343cSJed Brown   switch (ark->status) {
890108c343cSJed Brown   case TS_STEP_INCOMPLETE:
891108c343cSJed Brown   case TS_STEP_PENDING:
892108c343cSJed Brown     h = ts->time_step;
893108c343cSJed Brown     t = (itime - ts->ptime)/h;
894108c343cSJed Brown     break;
895108c343cSJed Brown   case TS_STEP_COMPLETE:
896*be5899b3SLisandro Dalcin     h = ts->ptime - ts->ptime_prev;
897108c343cSJed Brown     t = (itime - ts->ptime)/h + 1; /* In the interval [0,1] */
898108c343cSJed Brown     break;
899ce94432eSBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_PLIB,"Invalid TSStepStatus");
900108c343cSJed Brown   }
901dcca6d9dSJed Brown   ierr = PetscMalloc2(s,&bt,s,&b);CHKERRQ(ierr);
902cd652676SJed Brown   for (i=0; i<s; i++) bt[i] = b[i] = 0;
9034f385281SJed Brown   for (j=0,tt=t; j<pinterp; j++,tt*=t) {
904cd652676SJed Brown     for (i=0; i<s; i++) {
905c1758d98SDebojyoti Ghosh       bt[i] += h * Bt[i*pinterp+j] * tt;
906108c343cSJed Brown       b[i]  += h * B[i*pinterp+j] * tt;
907cd652676SJed Brown     }
908cd652676SJed Brown   }
909cd652676SJed Brown   ierr = VecCopy(ark->Y[0],X);CHKERRQ(ierr);
910cd652676SJed Brown   ierr = VecMAXPY(X,s,bt,ark->YdotI);CHKERRQ(ierr);
911cd652676SJed Brown   ierr = VecMAXPY(X,s,b,ark->YdotRHS);CHKERRQ(ierr);
912cd652676SJed Brown   ierr = PetscFree2(bt,b);CHKERRQ(ierr);
913cd652676SJed Brown   PetscFunctionReturn(0);
914cd652676SJed Brown }
915cd652676SJed Brown 
91656dcabbaSDebojyoti Ghosh #undef __FUNCT__
91756dcabbaSDebojyoti Ghosh #define __FUNCT__ "TSExtrapolate_ARKIMEX"
91856dcabbaSDebojyoti Ghosh static PetscErrorCode TSExtrapolate_ARKIMEX(TS ts,PetscReal c,Vec X)
91956dcabbaSDebojyoti Ghosh {
92056dcabbaSDebojyoti Ghosh   TS_ARKIMEX      *ark = (TS_ARKIMEX*)ts->data;
92156dcabbaSDebojyoti Ghosh   PetscInt        s = ark->tableau->s,pinterp = ark->tableau->pinterp,i,j;
922*be5899b3SLisandro Dalcin   PetscReal       h,h_prev,t,tt;
92356dcabbaSDebojyoti Ghosh   PetscScalar     *bt,*b;
92456dcabbaSDebojyoti Ghosh   const PetscReal *Bt = ark->tableau->binterpt,*B = ark->tableau->binterp;
92556dcabbaSDebojyoti Ghosh   PetscErrorCode  ierr;
92656dcabbaSDebojyoti Ghosh 
92756dcabbaSDebojyoti Ghosh   PetscFunctionBegin;
92856dcabbaSDebojyoti Ghosh   if (!Bt || !B) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSARKIMEX %s does not have an interpolation formula",ark->tableau->name);
929*be5899b3SLisandro Dalcin   ierr = PetscCalloc2(s,&bt,s,&b);CHKERRQ(ierr);
93081d12688SDebojyoti Ghosh   h = ts->time_step;
931*be5899b3SLisandro Dalcin   h_prev = ts->ptime - ts->ptime_prev;
932*be5899b3SLisandro Dalcin   t = 1 + h/h_prev*c;
93356dcabbaSDebojyoti Ghosh   for (j=0,tt=t; j<pinterp; j++,tt*=t) {
93456dcabbaSDebojyoti Ghosh     for (i=0; i<s; i++) {
93581d12688SDebojyoti Ghosh       bt[i] += h * Bt[i*pinterp+j] * tt;
93656dcabbaSDebojyoti Ghosh       b[i]  += h * B[i*pinterp+j] * tt;
93756dcabbaSDebojyoti Ghosh     }
93856dcabbaSDebojyoti Ghosh   }
93996400bd6SLisandro Dalcin   if (!ark->Y_prev) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Stages from previous step have not been stored");
94056dcabbaSDebojyoti Ghosh   ierr = VecCopy(ark->Y_prev[0],X);CHKERRQ(ierr);
94156dcabbaSDebojyoti Ghosh   ierr = VecMAXPY(X,s,bt,ark->YdotI_prev);CHKERRQ(ierr);
94256dcabbaSDebojyoti Ghosh   ierr = VecMAXPY(X,s,b,ark->YdotRHS_prev);CHKERRQ(ierr);
94356dcabbaSDebojyoti Ghosh   ierr = PetscFree2(bt,b);CHKERRQ(ierr);
94456dcabbaSDebojyoti Ghosh   PetscFunctionReturn(0);
94556dcabbaSDebojyoti Ghosh }
94656dcabbaSDebojyoti Ghosh 
9478a381b04SJed Brown /*------------------------------------------------------------*/
94896400bd6SLisandro Dalcin 
94996400bd6SLisandro Dalcin #undef __FUNCT__
95096400bd6SLisandro Dalcin #define __FUNCT__ "TSARKIMEXTableauReset"
95196400bd6SLisandro Dalcin static PetscErrorCode TSARKIMEXTableauReset(TS ts)
95296400bd6SLisandro Dalcin {
95396400bd6SLisandro Dalcin   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
95496400bd6SLisandro Dalcin   ARKTableau     tab  = ark->tableau;
95596400bd6SLisandro Dalcin   PetscErrorCode ierr;
95696400bd6SLisandro Dalcin 
95796400bd6SLisandro Dalcin   PetscFunctionBegin;
95896400bd6SLisandro Dalcin   if (!tab) PetscFunctionReturn(0);
95996400bd6SLisandro Dalcin   ierr = PetscFree(ark->work);CHKERRQ(ierr);
96096400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->Y);CHKERRQ(ierr);
96196400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->YdotI);CHKERRQ(ierr);
96296400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->YdotRHS);CHKERRQ(ierr);
96396400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->Y_prev);CHKERRQ(ierr);
96496400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->YdotI_prev);CHKERRQ(ierr);
96596400bd6SLisandro Dalcin   ierr = VecDestroyVecs(tab->s,&ark->YdotRHS_prev);CHKERRQ(ierr);
96696400bd6SLisandro Dalcin   PetscFunctionReturn(0);
96796400bd6SLisandro Dalcin }
96896400bd6SLisandro Dalcin 
9698a381b04SJed Brown #undef __FUNCT__
9708a381b04SJed Brown #define __FUNCT__ "TSReset_ARKIMEX"
9718a381b04SJed Brown static PetscErrorCode TSReset_ARKIMEX(TS ts)
9728a381b04SJed Brown {
9738a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
9748a381b04SJed Brown   PetscErrorCode ierr;
9758a381b04SJed Brown 
9768a381b04SJed Brown   PetscFunctionBegin;
97796400bd6SLisandro Dalcin   ierr = TSARKIMEXTableauReset(ts);CHKERRQ(ierr);
9788a381b04SJed Brown   ierr = VecDestroy(&ark->Ydot);CHKERRQ(ierr);
979e817cc15SEmil Constantinescu   ierr = VecDestroy(&ark->Ydot0);CHKERRQ(ierr);
9808a381b04SJed Brown   ierr = VecDestroy(&ark->Z);CHKERRQ(ierr);
9818a381b04SJed Brown   PetscFunctionReturn(0);
9828a381b04SJed Brown }
9838a381b04SJed Brown 
9848a381b04SJed Brown #undef __FUNCT__
9858a381b04SJed Brown #define __FUNCT__ "TSDestroy_ARKIMEX"
9868a381b04SJed Brown static PetscErrorCode TSDestroy_ARKIMEX(TS ts)
9878a381b04SJed Brown {
9888a381b04SJed Brown   PetscErrorCode ierr;
9898a381b04SJed Brown 
9908a381b04SJed Brown   PetscFunctionBegin;
9918a381b04SJed Brown   ierr = TSReset_ARKIMEX(ts);CHKERRQ(ierr);
9928a381b04SJed Brown   ierr = PetscFree(ts->data);CHKERRQ(ierr);
993bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXGetType_C",NULL);CHKERRQ(ierr);
994bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetType_C",NULL);CHKERRQ(ierr);
995bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetFullyImplicit_C",NULL);CHKERRQ(ierr);
9968a381b04SJed Brown   PetscFunctionReturn(0);
9978a381b04SJed Brown }
9988a381b04SJed Brown 
999d5e6173cSPeter Brune 
1000d5e6173cSPeter Brune #undef __FUNCT__
1001d5e6173cSPeter Brune #define __FUNCT__ "TSARKIMEXGetVecs"
1002d5e6173cSPeter Brune static PetscErrorCode TSARKIMEXGetVecs(TS ts,DM dm,Vec *Z,Vec *Ydot)
1003d5e6173cSPeter Brune {
1004d5e6173cSPeter Brune   TS_ARKIMEX     *ax = (TS_ARKIMEX*)ts->data;
1005d5e6173cSPeter Brune   PetscErrorCode ierr;
1006d5e6173cSPeter Brune 
1007d5e6173cSPeter Brune   PetscFunctionBegin;
1008d5e6173cSPeter Brune   if (Z) {
1009d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1010d5e6173cSPeter Brune       ierr = DMGetNamedGlobalVector(dm,"TSARKIMEX_Z",Z);CHKERRQ(ierr);
1011d5e6173cSPeter Brune     } else *Z = ax->Z;
1012d5e6173cSPeter Brune   }
1013d5e6173cSPeter Brune   if (Ydot) {
1014d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1015d5e6173cSPeter Brune       ierr = DMGetNamedGlobalVector(dm,"TSARKIMEX_Ydot",Ydot);CHKERRQ(ierr);
1016d5e6173cSPeter Brune     } else *Ydot = ax->Ydot;
1017d5e6173cSPeter Brune   }
1018d5e6173cSPeter Brune   PetscFunctionReturn(0);
1019d5e6173cSPeter Brune }
1020d5e6173cSPeter Brune 
1021d5e6173cSPeter Brune 
1022d5e6173cSPeter Brune #undef __FUNCT__
1023d5e6173cSPeter Brune #define __FUNCT__ "TSARKIMEXRestoreVecs"
1024d5e6173cSPeter Brune static PetscErrorCode TSARKIMEXRestoreVecs(TS ts,DM dm,Vec *Z,Vec *Ydot)
1025d5e6173cSPeter Brune {
1026d5e6173cSPeter Brune   PetscErrorCode ierr;
1027d5e6173cSPeter Brune 
1028d5e6173cSPeter Brune   PetscFunctionBegin;
1029d5e6173cSPeter Brune   if (Z) {
1030d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1031d5e6173cSPeter Brune       ierr = DMRestoreNamedGlobalVector(dm,"TSARKIMEX_Z",Z);CHKERRQ(ierr);
1032d5e6173cSPeter Brune     }
1033d5e6173cSPeter Brune   }
1034d5e6173cSPeter Brune   if (Ydot) {
1035d5e6173cSPeter Brune     if (dm && dm != ts->dm) {
1036d5e6173cSPeter Brune       ierr = DMRestoreNamedGlobalVector(dm,"TSARKIMEX_Ydot",Ydot);CHKERRQ(ierr);
1037d5e6173cSPeter Brune     }
1038d5e6173cSPeter Brune   }
1039d5e6173cSPeter Brune   PetscFunctionReturn(0);
1040d5e6173cSPeter Brune }
1041d5e6173cSPeter Brune 
10428a381b04SJed Brown /*
10438a381b04SJed Brown   This defines the nonlinear equation that is to be solved with SNES
10448a381b04SJed Brown   G(U) = F[t0+Theta*dt, U, (U-U0)*shift] = 0
10458a381b04SJed Brown */
10468a381b04SJed Brown #undef __FUNCT__
10478a381b04SJed Brown #define __FUNCT__ "SNESTSFormFunction_ARKIMEX"
10488a381b04SJed Brown static PetscErrorCode SNESTSFormFunction_ARKIMEX(SNES snes,Vec X,Vec F,TS ts)
10498a381b04SJed Brown {
10508a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
1051d5e6173cSPeter Brune   DM             dm,dmsave;
1052d5e6173cSPeter Brune   Vec            Z,Ydot;
1053b296d7d5SJed Brown   PetscReal      shift = ark->scoeff / ts->time_step;
10548a381b04SJed Brown   PetscErrorCode ierr;
10558a381b04SJed Brown 
10568a381b04SJed Brown   PetscFunctionBegin;
1057d5e6173cSPeter Brune   ierr   = SNESGetDM(snes,&dm);CHKERRQ(ierr);
1058d5e6173cSPeter Brune   ierr   = TSARKIMEXGetVecs(ts,dm,&Z,&Ydot);CHKERRQ(ierr);
1059b296d7d5SJed Brown   ierr   = VecAXPBYPCZ(Ydot,-shift,shift,0,Z,X);CHKERRQ(ierr); /* Ydot = shift*(X-Z) */
1060d5e6173cSPeter Brune   dmsave = ts->dm;
1061d5e6173cSPeter Brune   ts->dm = dm;
1062740132f1SEmil Constantinescu 
1063d5e6173cSPeter Brune   ierr = TSComputeIFunction(ts,ark->stage_time,X,Ydot,F,ark->imex);CHKERRQ(ierr);
1064e817cc15SEmil Constantinescu 
1065d5e6173cSPeter Brune   ts->dm = dmsave;
1066d5e6173cSPeter Brune   ierr   = TSARKIMEXRestoreVecs(ts,dm,&Z,&Ydot);CHKERRQ(ierr);
10678a381b04SJed Brown   PetscFunctionReturn(0);
10688a381b04SJed Brown }
10698a381b04SJed Brown 
10708a381b04SJed Brown #undef __FUNCT__
10718a381b04SJed Brown #define __FUNCT__ "SNESTSFormJacobian_ARKIMEX"
1072d1e9a80fSBarry Smith static PetscErrorCode SNESTSFormJacobian_ARKIMEX(SNES snes,Vec X,Mat A,Mat B,TS ts)
10738a381b04SJed Brown {
10748a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
1075d5e6173cSPeter Brune   DM             dm,dmsave;
1076d5e6173cSPeter Brune   Vec            Ydot;
1077b296d7d5SJed Brown   PetscReal      shift = ark->scoeff / ts->time_step;
10788a381b04SJed Brown   PetscErrorCode ierr;
10798a381b04SJed Brown 
10808a381b04SJed Brown   PetscFunctionBegin;
1081d5e6173cSPeter Brune   ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr);
10820298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,dm,NULL,&Ydot);CHKERRQ(ierr);
10838a381b04SJed Brown   /* ark->Ydot has already been computed in SNESTSFormFunction_ARKIMEX (SNES guarantees this) */
1084d5e6173cSPeter Brune   dmsave = ts->dm;
1085d5e6173cSPeter Brune   ts->dm = dm;
1086740132f1SEmil Constantinescu 
1087d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,ark->stage_time,X,Ydot,shift,A,B,ark->imex);CHKERRQ(ierr);
1088740132f1SEmil Constantinescu 
1089d5e6173cSPeter Brune   ts->dm = dmsave;
10900298fd71SBarry Smith   ierr   = TSARKIMEXRestoreVecs(ts,dm,NULL,&Ydot);CHKERRQ(ierr);
1091d5e6173cSPeter Brune   PetscFunctionReturn(0);
1092d5e6173cSPeter Brune }
1093d5e6173cSPeter Brune 
1094d5e6173cSPeter Brune #undef __FUNCT__
1095d5e6173cSPeter Brune #define __FUNCT__ "DMCoarsenHook_TSARKIMEX"
1096d5e6173cSPeter Brune static PetscErrorCode DMCoarsenHook_TSARKIMEX(DM fine,DM coarse,void *ctx)
1097d5e6173cSPeter Brune {
1098d5e6173cSPeter Brune   PetscFunctionBegin;
1099d5e6173cSPeter Brune   PetscFunctionReturn(0);
1100d5e6173cSPeter Brune }
1101d5e6173cSPeter Brune 
1102d5e6173cSPeter Brune #undef __FUNCT__
1103d5e6173cSPeter Brune #define __FUNCT__ "DMRestrictHook_TSARKIMEX"
1104d5e6173cSPeter Brune static PetscErrorCode DMRestrictHook_TSARKIMEX(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse,void *ctx)
1105d5e6173cSPeter Brune {
1106d5e6173cSPeter Brune   TS             ts = (TS)ctx;
1107d5e6173cSPeter Brune   PetscErrorCode ierr;
1108d5e6173cSPeter Brune   Vec            Z,Z_c;
1109d5e6173cSPeter Brune 
1110d5e6173cSPeter Brune   PetscFunctionBegin;
11110298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,fine,&Z,NULL);CHKERRQ(ierr);
11120298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,coarse,&Z_c,NULL);CHKERRQ(ierr);
1113d5e6173cSPeter Brune   ierr = MatRestrict(restrct,Z,Z_c);CHKERRQ(ierr);
1114d5e6173cSPeter Brune   ierr = VecPointwiseMult(Z_c,rscale,Z_c);CHKERRQ(ierr);
11150298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,fine,&Z,NULL);CHKERRQ(ierr);
11160298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,coarse,&Z_c,NULL);CHKERRQ(ierr);
11178a381b04SJed Brown   PetscFunctionReturn(0);
11188a381b04SJed Brown }
11198a381b04SJed Brown 
1120cdb298fcSPeter Brune 
1121cdb298fcSPeter Brune #undef __FUNCT__
1122cdb298fcSPeter Brune #define __FUNCT__ "DMSubDomainHook_TSARKIMEX"
1123cdb298fcSPeter Brune static PetscErrorCode DMSubDomainHook_TSARKIMEX(DM dm,DM subdm,void *ctx)
1124cdb298fcSPeter Brune {
1125cdb298fcSPeter Brune   PetscFunctionBegin;
1126cdb298fcSPeter Brune   PetscFunctionReturn(0);
1127cdb298fcSPeter Brune }
1128cdb298fcSPeter Brune 
1129cdb298fcSPeter Brune #undef __FUNCT__
1130cdb298fcSPeter Brune #define __FUNCT__ "DMSubDomainRestrictHook_TSARKIMEX"
1131cdb298fcSPeter Brune static PetscErrorCode DMSubDomainRestrictHook_TSARKIMEX(DM dm,VecScatter gscat,VecScatter lscat,DM subdm,void *ctx)
1132cdb298fcSPeter Brune {
1133cdb298fcSPeter Brune   TS             ts = (TS)ctx;
1134cdb298fcSPeter Brune   PetscErrorCode ierr;
1135cdb298fcSPeter Brune   Vec            Z,Z_c;
1136cdb298fcSPeter Brune 
1137cdb298fcSPeter Brune   PetscFunctionBegin;
11380298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,dm,&Z,NULL);CHKERRQ(ierr);
11390298fd71SBarry Smith   ierr = TSARKIMEXGetVecs(ts,subdm,&Z_c,NULL);CHKERRQ(ierr);
1140cdb298fcSPeter Brune 
1141cdb298fcSPeter Brune   ierr = VecScatterBegin(gscat,Z,Z_c,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1142cdb298fcSPeter Brune   ierr = VecScatterEnd(gscat,Z,Z_c,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1143cdb298fcSPeter Brune 
11440298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,dm,&Z,NULL);CHKERRQ(ierr);
11450298fd71SBarry Smith   ierr = TSARKIMEXRestoreVecs(ts,subdm,&Z_c,NULL);CHKERRQ(ierr);
1146cdb298fcSPeter Brune   PetscFunctionReturn(0);
1147cdb298fcSPeter Brune }
1148cdb298fcSPeter Brune 
11498a381b04SJed Brown #undef __FUNCT__
115096400bd6SLisandro Dalcin #define __FUNCT__ "TSARKIMEXTableauSetUp"
115196400bd6SLisandro Dalcin static PetscErrorCode TSARKIMEXTableauSetUp(TS ts)
115296400bd6SLisandro Dalcin {
115396400bd6SLisandro Dalcin   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
115496400bd6SLisandro Dalcin   ARKTableau     tab  = ark->tableau;
115596400bd6SLisandro Dalcin   PetscErrorCode ierr;
115696400bd6SLisandro Dalcin 
115796400bd6SLisandro Dalcin   PetscFunctionBegin;
115896400bd6SLisandro Dalcin   ierr = PetscMalloc1(tab->s,&ark->work);CHKERRQ(ierr);
115996400bd6SLisandro Dalcin   ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->Y);CHKERRQ(ierr);
116096400bd6SLisandro Dalcin   ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotI);CHKERRQ(ierr);
116196400bd6SLisandro Dalcin   ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotRHS);CHKERRQ(ierr);
116296400bd6SLisandro Dalcin   if (ark->extrapolate) {
116396400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->Y_prev);CHKERRQ(ierr);
116496400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotI_prev);CHKERRQ(ierr);
116596400bd6SLisandro Dalcin     ierr = VecDuplicateVecs(ts->vec_sol,tab->s,&ark->YdotRHS_prev);CHKERRQ(ierr);
116696400bd6SLisandro Dalcin   }
116796400bd6SLisandro Dalcin   PetscFunctionReturn(0);
116896400bd6SLisandro Dalcin }
116996400bd6SLisandro Dalcin 
117096400bd6SLisandro Dalcin #undef __FUNCT__
11718a381b04SJed Brown #define __FUNCT__ "TSSetUp_ARKIMEX"
11728a381b04SJed Brown static PetscErrorCode TSSetUp_ARKIMEX(TS ts)
11738a381b04SJed Brown {
11748a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
11758a381b04SJed Brown   PetscErrorCode ierr;
1176d5e6173cSPeter Brune   DM             dm;
117796400bd6SLisandro Dalcin   SNES           snes;
1178f9c1d6abSBarry Smith 
11798a381b04SJed Brown   PetscFunctionBegin;
118096400bd6SLisandro Dalcin   ierr = TSARKIMEXTableauSetUp(ts);CHKERRQ(ierr);
11818a381b04SJed Brown   ierr = VecDuplicate(ts->vec_sol,&ark->Ydot);CHKERRQ(ierr);
1182e817cc15SEmil Constantinescu   ierr = VecDuplicate(ts->vec_sol,&ark->Ydot0);CHKERRQ(ierr);
11838a381b04SJed Brown   ierr = VecDuplicate(ts->vec_sol,&ark->Z);CHKERRQ(ierr);
1184d5e6173cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1185d5e6173cSPeter Brune   if (dm) {
1186d5e6173cSPeter Brune     ierr = DMCoarsenHookAdd(dm,DMCoarsenHook_TSARKIMEX,DMRestrictHook_TSARKIMEX,ts);CHKERRQ(ierr);
1187cdb298fcSPeter Brune     ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_TSARKIMEX,DMSubDomainRestrictHook_TSARKIMEX,ts);CHKERRQ(ierr);
1188d5e6173cSPeter Brune   }
118996400bd6SLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11908a381b04SJed Brown   PetscFunctionReturn(0);
11918a381b04SJed Brown }
11928a381b04SJed Brown /*------------------------------------------------------------*/
11938a381b04SJed Brown 
11948a381b04SJed Brown #undef __FUNCT__
11958a381b04SJed Brown #define __FUNCT__ "TSSetFromOptions_ARKIMEX"
11964416b707SBarry Smith static PetscErrorCode TSSetFromOptions_ARKIMEX(PetscOptionItems *PetscOptionsObject,TS ts)
11978a381b04SJed Brown {
11984cc180ffSJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
11998a381b04SJed Brown   PetscErrorCode ierr;
12008a381b04SJed Brown 
12018a381b04SJed Brown   PetscFunctionBegin;
1202e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"ARKIMEX ODE solver options");CHKERRQ(ierr);
12038a381b04SJed Brown   {
12048a381b04SJed Brown     ARKTableauLink link;
12058a381b04SJed Brown     PetscInt       count,choice;
12068a381b04SJed Brown     PetscBool      flg;
12078a381b04SJed Brown     const char     **namelist;
12088a381b04SJed Brown     for (link=ARKTableauList,count=0; link; link=link->next,count++) ;
1209785e854fSJed Brown     ierr = PetscMalloc1(count,&namelist);CHKERRQ(ierr);
12108a381b04SJed Brown     for (link=ARKTableauList,count=0; link; link=link->next,count++) namelist[count] = link->tab.name;
121196400bd6SLisandro Dalcin     ierr = PetscOptionsEList("-ts_arkimex_type","Family of ARK IMEX method","TSARKIMEXSetType",(const char*const*)namelist,count,ark->tableau->name,&choice,&flg);CHKERRQ(ierr);
121296400bd6SLisandro Dalcin     if (flg) {ierr = TSARKIMEXSetType(ts,namelist[choice]);CHKERRQ(ierr);}
12138a381b04SJed Brown     ierr = PetscFree(namelist);CHKERRQ(ierr);
121496400bd6SLisandro Dalcin 
12154cc180ffSJed Brown     flg  = (PetscBool) !ark->imex;
12160298fd71SBarry Smith     ierr = PetscOptionsBool("-ts_arkimex_fully_implicit","Solve the problem fully implicitly","TSARKIMEXSetFullyImplicit",flg,&flg,NULL);CHKERRQ(ierr);
12174cc180ffSJed Brown     ark->imex = (PetscBool) !flg;
121896400bd6SLisandro Dalcin     ierr = PetscOptionsBool("-ts_arkimex_extrapolate","Extrapolate the initial guess for the stage solution from stage values of the previous time step","",ark->extrapolate,&ark->extrapolate,NULL);CHKERRQ(ierr);
12198a381b04SJed Brown   }
12208a381b04SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
12218a381b04SJed Brown   PetscFunctionReturn(0);
12228a381b04SJed Brown }
12238a381b04SJed Brown 
12248a381b04SJed Brown #undef __FUNCT__
12258a381b04SJed Brown #define __FUNCT__ "PetscFormatRealArray"
12268a381b04SJed Brown static PetscErrorCode PetscFormatRealArray(char buf[],size_t len,const char *fmt,PetscInt n,const PetscReal x[])
12278a381b04SJed Brown {
1228257d2499SJed Brown   PetscErrorCode ierr;
1229f1d86077SJed Brown   PetscInt       i;
1230f1d86077SJed Brown   size_t         left,count;
12318a381b04SJed Brown   char           *p;
12328a381b04SJed Brown 
12338a381b04SJed Brown   PetscFunctionBegin;
1234f1d86077SJed Brown   for (i=0,p=buf,left=len; i<n; i++) {
1235f1d86077SJed Brown     ierr = PetscSNPrintfCount(p,left,fmt,&count,x[i]);CHKERRQ(ierr);
12368a381b04SJed Brown     if (count >= left) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Insufficient space in buffer");
12378a381b04SJed Brown     left -= count;
12388a381b04SJed Brown     p    += count;
12398a381b04SJed Brown     *p++  = ' ';
12408a381b04SJed Brown   }
12418a381b04SJed Brown   p[i ? 0 : -1] = 0;
12428a381b04SJed Brown   PetscFunctionReturn(0);
12438a381b04SJed Brown }
12448a381b04SJed Brown 
12458a381b04SJed Brown #undef __FUNCT__
12468a381b04SJed Brown #define __FUNCT__ "TSView_ARKIMEX"
12478a381b04SJed Brown static PetscErrorCode TSView_ARKIMEX(TS ts,PetscViewer viewer)
12488a381b04SJed Brown {
12498a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
12508a381b04SJed Brown   PetscBool      iascii;
12518a381b04SJed Brown   PetscErrorCode ierr;
12528a381b04SJed Brown 
12538a381b04SJed Brown   PetscFunctionBegin;
1254251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
12558a381b04SJed Brown   if (iascii) {
12569c334d8fSLisandro Dalcin     ARKTableau    tab = ark->tableau;
125719fd82e9SBarry Smith     TSARKIMEXType arktype;
12588a381b04SJed Brown     char          buf[512];
12598a381b04SJed Brown     ierr = TSARKIMEXGetType(ts,&arktype);CHKERRQ(ierr);
12608a381b04SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  ARK IMEX %s\n",arktype);CHKERRQ(ierr);
12618caf3d72SBarry Smith     ierr = PetscFormatRealArray(buf,sizeof(buf),"% 8.6f",tab->s,tab->ct);CHKERRQ(ierr);
126231f6fcc0SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  Stiff abscissa       ct = %s\n",buf);CHKERRQ(ierr);
12638caf3d72SBarry Smith     ierr = PetscFormatRealArray(buf,sizeof(buf),"% 8.6f",tab->s,tab->c);CHKERRQ(ierr);
1264e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"Stiffly accurate: %s\n",tab->stiffly_accurate ? "yes" : "no");CHKERRQ(ierr);
1265e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"Explicit first stage: %s\n",tab->explicit_first_stage ? "yes" : "no");CHKERRQ(ierr);
1266e817cc15SEmil Constantinescu     ierr = PetscViewerASCIIPrintf(viewer,"FSAL property: %s\n",tab->FSAL_implicit ? "yes" : "no");CHKERRQ(ierr);
126731f6fcc0SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  Nonstiff abscissa     c = %s\n",buf);CHKERRQ(ierr);
12688a381b04SJed Brown   }
1269*be5899b3SLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
127096400bd6SLisandro Dalcin   if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
12718a381b04SJed Brown   PetscFunctionReturn(0);
12728a381b04SJed Brown }
12738a381b04SJed Brown 
12748a381b04SJed Brown #undef __FUNCT__
1275f2c2a1b9SBarry Smith #define __FUNCT__ "TSLoad_ARKIMEX"
1276f2c2a1b9SBarry Smith static PetscErrorCode TSLoad_ARKIMEX(TS ts,PetscViewer viewer)
1277f2c2a1b9SBarry Smith {
1278f2c2a1b9SBarry Smith   PetscErrorCode ierr;
1279f2c2a1b9SBarry Smith   SNES           snes;
12809c334d8fSLisandro Dalcin   TSAdapt        adapt;
1281f2c2a1b9SBarry Smith 
1282f2c2a1b9SBarry Smith   PetscFunctionBegin;
12839c334d8fSLisandro Dalcin   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
12849c334d8fSLisandro Dalcin   ierr = TSAdaptLoad(adapt,viewer);CHKERRQ(ierr);
1285f2c2a1b9SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1286f2c2a1b9SBarry Smith   ierr = SNESLoad(snes,viewer);CHKERRQ(ierr);
1287ad6bc421SBarry Smith   /* function and Jacobian context for SNES when used with TS is always ts object */
12880298fd71SBarry Smith   ierr = SNESSetFunction(snes,NULL,NULL,ts);CHKERRQ(ierr);
12890298fd71SBarry Smith   ierr = SNESSetJacobian(snes,NULL,NULL,NULL,ts);CHKERRQ(ierr);
1290f2c2a1b9SBarry Smith   PetscFunctionReturn(0);
1291f2c2a1b9SBarry Smith }
1292f2c2a1b9SBarry Smith 
1293f2c2a1b9SBarry Smith #undef __FUNCT__
12948a381b04SJed Brown #define __FUNCT__ "TSARKIMEXSetType"
12958a381b04SJed Brown /*@C
12968a381b04SJed Brown   TSARKIMEXSetType - Set the type of ARK IMEX scheme
12978a381b04SJed Brown 
12988a381b04SJed Brown   Logically collective
12998a381b04SJed Brown 
13008a381b04SJed Brown   Input Parameter:
13018a381b04SJed Brown +  ts - timestepping context
13028a381b04SJed Brown -  arktype - type of ARK-IMEX scheme
13038a381b04SJed Brown 
13048a381b04SJed Brown   Level: intermediate
13058a381b04SJed Brown 
1306020d8f30SJed Brown .seealso: TSARKIMEXGetType(), TSARKIMEX, TSARKIMEX2D, TSARKIMEX2E, TSARKIMEXPRSSP2, TSARKIMEX3, TSARKIMEXBPR3, TSARKIMEXARS443, TSARKIMEX4, TSARKIMEX5
13078a381b04SJed Brown @*/
130819fd82e9SBarry Smith PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType arktype)
13098a381b04SJed Brown {
13108a381b04SJed Brown   PetscErrorCode ierr;
13118a381b04SJed Brown 
13128a381b04SJed Brown   PetscFunctionBegin;
13138a381b04SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
131419fd82e9SBarry Smith   ierr = PetscTryMethod(ts,"TSARKIMEXSetType_C",(TS,TSARKIMEXType),(ts,arktype));CHKERRQ(ierr);
13158a381b04SJed Brown   PetscFunctionReturn(0);
13168a381b04SJed Brown }
13178a381b04SJed Brown 
13188a381b04SJed Brown #undef __FUNCT__
13198a381b04SJed Brown #define __FUNCT__ "TSARKIMEXGetType"
13208a381b04SJed Brown /*@C
13218a381b04SJed Brown   TSARKIMEXGetType - Get the type of ARK IMEX scheme
13228a381b04SJed Brown 
13238a381b04SJed Brown   Logically collective
13248a381b04SJed Brown 
13258a381b04SJed Brown   Input Parameter:
13268a381b04SJed Brown .  ts - timestepping context
13278a381b04SJed Brown 
13288a381b04SJed Brown   Output Parameter:
13298a381b04SJed Brown .  arktype - type of ARK-IMEX scheme
13308a381b04SJed Brown 
13318a381b04SJed Brown   Level: intermediate
13328a381b04SJed Brown 
13338a381b04SJed Brown .seealso: TSARKIMEXGetType()
13348a381b04SJed Brown @*/
133519fd82e9SBarry Smith PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType *arktype)
13368a381b04SJed Brown {
13378a381b04SJed Brown   PetscErrorCode ierr;
13388a381b04SJed Brown 
13398a381b04SJed Brown   PetscFunctionBegin;
13408a381b04SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
134119fd82e9SBarry Smith   ierr = PetscUseMethod(ts,"TSARKIMEXGetType_C",(TS,TSARKIMEXType*),(ts,arktype));CHKERRQ(ierr);
13428a381b04SJed Brown   PetscFunctionReturn(0);
13438a381b04SJed Brown }
13448a381b04SJed Brown 
13454cc180ffSJed Brown #undef __FUNCT__
13464cc180ffSJed Brown #define __FUNCT__ "TSARKIMEXSetFullyImplicit"
134716353aafSBarry Smith /*@
13484cc180ffSJed Brown   TSARKIMEXSetFullyImplicit - Solve both parts of the equation implicitly
13494cc180ffSJed Brown 
13504cc180ffSJed Brown   Logically collective
13514cc180ffSJed Brown 
13524cc180ffSJed Brown   Input Parameter:
13534cc180ffSJed Brown +  ts - timestepping context
13544cc180ffSJed Brown -  flg - PETSC_TRUE for fully implicit
13554cc180ffSJed Brown 
13564cc180ffSJed Brown   Level: intermediate
13574cc180ffSJed Brown 
13584cc180ffSJed Brown .seealso: TSARKIMEXGetType()
13594cc180ffSJed Brown @*/
13604cc180ffSJed Brown PetscErrorCode TSARKIMEXSetFullyImplicit(TS ts,PetscBool flg)
13614cc180ffSJed Brown {
13624cc180ffSJed Brown   PetscErrorCode ierr;
13634cc180ffSJed Brown 
13644cc180ffSJed Brown   PetscFunctionBegin;
13654cc180ffSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13664cc180ffSJed Brown   ierr = PetscTryMethod(ts,"TSARKIMEXSetFullyImplicit_C",(TS,PetscBool),(ts,flg));CHKERRQ(ierr);
13674cc180ffSJed Brown   PetscFunctionReturn(0);
13684cc180ffSJed Brown }
13694cc180ffSJed Brown 
13708a381b04SJed Brown #undef __FUNCT__
13718a381b04SJed Brown #define __FUNCT__ "TSARKIMEXGetType_ARKIMEX"
1372e0877f53SBarry Smith static PetscErrorCode  TSARKIMEXGetType_ARKIMEX(TS ts,TSARKIMEXType *arktype)
13738a381b04SJed Brown {
13748a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
13758a381b04SJed Brown 
13768a381b04SJed Brown   PetscFunctionBegin;
13778a381b04SJed Brown   *arktype = ark->tableau->name;
13788a381b04SJed Brown   PetscFunctionReturn(0);
13798a381b04SJed Brown }
13808a381b04SJed Brown #undef __FUNCT__
13818a381b04SJed Brown #define __FUNCT__ "TSARKIMEXSetType_ARKIMEX"
1382e0877f53SBarry Smith static PetscErrorCode  TSARKIMEXSetType_ARKIMEX(TS ts,TSARKIMEXType arktype)
13838a381b04SJed Brown {
13848a381b04SJed Brown   TS_ARKIMEX     *ark = (TS_ARKIMEX*)ts->data;
13858a381b04SJed Brown   PetscErrorCode ierr;
13868a381b04SJed Brown   PetscBool      match;
13878a381b04SJed Brown   ARKTableauLink link;
13888a381b04SJed Brown 
13898a381b04SJed Brown   PetscFunctionBegin;
13908a381b04SJed Brown   if (ark->tableau) {
13918a381b04SJed Brown     ierr = PetscStrcmp(ark->tableau->name,arktype,&match);CHKERRQ(ierr);
13928a381b04SJed Brown     if (match) PetscFunctionReturn(0);
13938a381b04SJed Brown   }
13948a381b04SJed Brown   for (link = ARKTableauList; link; link=link->next) {
13958a381b04SJed Brown     ierr = PetscStrcmp(link->tab.name,arktype,&match);CHKERRQ(ierr);
13968a381b04SJed Brown     if (match) {
139796400bd6SLisandro Dalcin       if (ts->setupcalled) {ierr = TSARKIMEXTableauReset(ts);CHKERRQ(ierr);}
13988a381b04SJed Brown       ark->tableau = &link->tab;
139996400bd6SLisandro Dalcin       if (ts->setupcalled) {ierr = TSARKIMEXTableauSetUp(ts);CHKERRQ(ierr);}
14008a381b04SJed Brown       PetscFunctionReturn(0);
14018a381b04SJed Brown     }
14028a381b04SJed Brown   }
1403ce94432eSBarry Smith   SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_UNKNOWN_TYPE,"Could not find '%s'",arktype);
14048a381b04SJed Brown   PetscFunctionReturn(0);
14058a381b04SJed Brown }
1406e0877f53SBarry Smith 
14074cc180ffSJed Brown #undef __FUNCT__
14084cc180ffSJed Brown #define __FUNCT__ "TSARKIMEXSetFullyImplicit_ARKIMEX"
1409e0877f53SBarry Smith static PetscErrorCode  TSARKIMEXSetFullyImplicit_ARKIMEX(TS ts,PetscBool flg)
14104cc180ffSJed Brown {
14114cc180ffSJed Brown   TS_ARKIMEX *ark = (TS_ARKIMEX*)ts->data;
14124cc180ffSJed Brown 
14134cc180ffSJed Brown   PetscFunctionBegin;
14144cc180ffSJed Brown   ark->imex = (PetscBool)!flg;
14154cc180ffSJed Brown   PetscFunctionReturn(0);
14164cc180ffSJed Brown }
14178a381b04SJed Brown 
14188a381b04SJed Brown /* ------------------------------------------------------------ */
14198a381b04SJed Brown /*MC
1420a4386c9eSJed Brown       TSARKIMEX - ODE and DAE solver using Additive Runge-Kutta IMEX schemes
14218a381b04SJed Brown 
1422fca742c7SJed Brown   These methods are intended for problems with well-separated time scales, especially when a slow scale is strongly
1423fca742c7SJed Brown   nonlinear such that it is expensive to solve with a fully implicit method. The user should provide the stiff part
1424fca742c7SJed Brown   of the equation using TSSetIFunction() and the non-stiff part with TSSetRHSFunction().
1425fca742c7SJed Brown 
1426fca742c7SJed Brown   Notes:
1427a4386c9eSJed Brown   The default is TSARKIMEX3, it can be changed with TSARKIMEXSetType() or -ts_arkimex_type
1428c8058688SBarry Smith 
14295eca1a21SEmil Constantinescu   If the equation is implicit or a DAE, then TSSetEquationType() needs to be set accordingly. Refer to the manual for further information.
14305eca1a21SEmil Constantinescu 
1431a4386c9eSJed 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).
1432fca742c7SJed Brown 
1433d0685a90SJed Brown   Consider trying TSROSW if the stiff part is linear or weakly nonlinear.
1434d0685a90SJed Brown 
14358a381b04SJed Brown   Level: beginner
14368a381b04SJed Brown 
1437d0685a90SJed Brown .seealso:  TSCreate(), TS, TSSetType(), TSARKIMEXSetType(), TSARKIMEXGetType(), TSARKIMEXSetFullyImplicit(), TSARKIMEX1BEE,
1438d0685a90SJed Brown            TSARKIMEX2C, TSARKIMEX2D, TSARKIMEX2E, TSARKIMEX3, TSARKIMEXL2, TSARKIMEXA2, TSARKIMEXARS122,
1439d0685a90SJed Brown            TSARKIMEX4, TSARKIMEX5, TSARKIMEXPRSSP2, TSARKIMEXARS443, TSARKIMEXBPR3, TSARKIMEXType, TSARKIMEXRegister()
14408a381b04SJed Brown 
14418a381b04SJed Brown M*/
14428a381b04SJed Brown #undef __FUNCT__
14438a381b04SJed Brown #define __FUNCT__ "TSCreate_ARKIMEX"
14448cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_ARKIMEX(TS ts)
14458a381b04SJed Brown {
14468a381b04SJed Brown   TS_ARKIMEX     *th;
14478a381b04SJed Brown   PetscErrorCode ierr;
14488a381b04SJed Brown 
14498a381b04SJed Brown   PetscFunctionBegin;
1450607a6623SBarry Smith   ierr = TSARKIMEXInitializePackage();CHKERRQ(ierr);
14518a381b04SJed Brown 
14528a381b04SJed Brown   ts->ops->reset          = TSReset_ARKIMEX;
14538a381b04SJed Brown   ts->ops->destroy        = TSDestroy_ARKIMEX;
14548a381b04SJed Brown   ts->ops->view           = TSView_ARKIMEX;
1455f2c2a1b9SBarry Smith   ts->ops->load           = TSLoad_ARKIMEX;
14568a381b04SJed Brown   ts->ops->setup          = TSSetUp_ARKIMEX;
14578a381b04SJed Brown   ts->ops->step           = TSStep_ARKIMEX;
1458cd652676SJed Brown   ts->ops->interpolate    = TSInterpolate_ARKIMEX;
1459108c343cSJed Brown   ts->ops->evaluatestep   = TSEvaluateStep_ARKIMEX;
146024655328SShri   ts->ops->rollback       = TSRollBack_ARKIMEX;
14618a381b04SJed Brown   ts->ops->setfromoptions = TSSetFromOptions_ARKIMEX;
14628a381b04SJed Brown   ts->ops->snesfunction   = SNESTSFormFunction_ARKIMEX;
14638a381b04SJed Brown   ts->ops->snesjacobian   = SNESTSFormJacobian_ARKIMEX;
14648a381b04SJed Brown 
1465b00a9115SJed Brown   ierr = PetscNewLog(ts,&th);CHKERRQ(ierr);
14668a381b04SJed Brown   ts->data = (void*)th;
14674cc180ffSJed Brown   th->imex = PETSC_TRUE;
14688a381b04SJed Brown 
1469bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXGetType_C",TSARKIMEXGetType_ARKIMEX);CHKERRQ(ierr);
1470bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetType_C",TSARKIMEXSetType_ARKIMEX);CHKERRQ(ierr);
1471bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)ts,"TSARKIMEXSetFullyImplicit_C",TSARKIMEXSetFullyImplicit_ARKIMEX);CHKERRQ(ierr);
147296400bd6SLisandro Dalcin 
147396400bd6SLisandro Dalcin   ierr = TSARKIMEXSetType(ts,TSARKIMEXDefault);CHKERRQ(ierr);
14748a381b04SJed Brown   PetscFunctionReturn(0);
14758a381b04SJed Brown }
1476