1316643e7SJed Brown /* 2316643e7SJed Brown Code for timestepping with implicit Theta method 3316643e7SJed Brown */ 4af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 5a055c8caSBarry Smith #include <petscsnes.h> 61e25c274SJed Brown #include <petscdm.h> 73c54f92cSHong Zhang #include <petscmat.h> 8316643e7SJed Brown 9316643e7SJed Brown typedef struct { 10715f1b00SHong Zhang /* context for time stepping */ 111566a47fSLisandro Dalcin PetscReal stage_time; 121566a47fSLisandro Dalcin Vec X0,X,Xdot; /* Storage for stages and time derivative */ 131566a47fSLisandro Dalcin Vec affine; /* Affine vector needed for residual at beginning of step in endpoint formulation */ 141566a47fSLisandro Dalcin PetscReal Theta; 151a352fa8SHong Zhang PetscReal shift; /* Shift parameter for SNES Jacobian, used by forward, TLM and adjoint */ 161566a47fSLisandro Dalcin PetscInt order; 171566a47fSLisandro Dalcin PetscBool endpoint; 181566a47fSLisandro Dalcin PetscBool extrapolate; 19715f1b00SHong Zhang TSStepStatus status; 201a352fa8SHong Zhang Vec VecCostIntegral0; /* Backup for roll-backs due to events, used by cost integral */ 211a352fa8SHong Zhang PetscReal ptime0; /* Backup for ts->ptime, the start time of current time step, used by TLM and cost integral */ 221a352fa8SHong Zhang PetscReal time_step0; /* Backup for ts->timestep, the step size of current time step, used by TLM and cost integral*/ 231566a47fSLisandro Dalcin 24715f1b00SHong Zhang /* context for sensitivity analysis */ 25022c081aSHong Zhang PetscInt num_tlm; /* Total number of tangent linear equations */ 26b5e0532dSHong Zhang Vec *VecsDeltaLam; /* Increment of the adjoint sensitivity w.r.t IC at stage */ 27b5e0532dSHong Zhang Vec *VecsDeltaMu; /* Increment of the adjoint sensitivity w.r.t P at stage */ 2813b1b0ffSHong Zhang Vec *VecsSensiTemp; /* Vector to be multiplied with Jacobian transpose */ 2913b1b0ffSHong Zhang Mat MatDeltaFwdSensip; /* Increment of the forward sensitivity at stage */ 30b5b4017aSHong Zhang Vec VecDeltaFwdSensipCol; /* Working vector for holding one column of the sensitivity matrix */ 3113b1b0ffSHong Zhang Mat MatFwdSensip0; /* backup for roll-backs due to events */ 327207e0fdSHong Zhang Mat MatIntegralSensipTemp; /* Working vector for forward integral sensitivity */ 337207e0fdSHong Zhang Mat MatIntegralSensip0; /* backup for roll-backs due to events */ 34b5b4017aSHong Zhang Vec *VecsDeltaLam2; /* Increment of the 2nd-order adjoint sensitivity w.r.t IC at stage */ 35b5b4017aSHong Zhang Vec *VecsDeltaMu2; /* Increment of the 2nd-order adjoint sensitivity w.r.t P at stage */ 36b5b4017aSHong Zhang Vec *VecsSensi2Temp; /* Working vectors that holds the residual for the second-order adjoint */ 37b5b4017aSHong Zhang Vec *VecsAffine; /* Working vectors to store residuals */ 38715f1b00SHong Zhang /* context for error estimation */ 391566a47fSLisandro Dalcin Vec vec_sol_prev; 401566a47fSLisandro Dalcin Vec vec_lte_work; 41316643e7SJed Brown } TS_Theta; 42316643e7SJed Brown 437445fe48SJed Brown static PetscErrorCode TSThetaGetX0AndXdot(TS ts,DM dm,Vec *X0,Vec *Xdot) 447445fe48SJed Brown { 457445fe48SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 467445fe48SJed Brown PetscErrorCode ierr; 477445fe48SJed Brown 487445fe48SJed Brown PetscFunctionBegin; 497445fe48SJed Brown if (X0) { 507445fe48SJed Brown if (dm && dm != ts->dm) { 510d0b770aSPeter Brune ierr = DMGetNamedGlobalVector(dm,"TSTheta_X0",X0);CHKERRQ(ierr); 527445fe48SJed Brown } else *X0 = ts->vec_sol; 537445fe48SJed Brown } 547445fe48SJed Brown if (Xdot) { 557445fe48SJed Brown if (dm && dm != ts->dm) { 560d0b770aSPeter Brune ierr = DMGetNamedGlobalVector(dm,"TSTheta_Xdot",Xdot);CHKERRQ(ierr); 577445fe48SJed Brown } else *Xdot = th->Xdot; 587445fe48SJed Brown } 597445fe48SJed Brown PetscFunctionReturn(0); 607445fe48SJed Brown } 617445fe48SJed Brown 620d0b770aSPeter Brune static PetscErrorCode TSThetaRestoreX0AndXdot(TS ts,DM dm,Vec *X0,Vec *Xdot) 630d0b770aSPeter Brune { 640d0b770aSPeter Brune PetscErrorCode ierr; 650d0b770aSPeter Brune 660d0b770aSPeter Brune PetscFunctionBegin; 670d0b770aSPeter Brune if (X0) { 680d0b770aSPeter Brune if (dm && dm != ts->dm) { 690d0b770aSPeter Brune ierr = DMRestoreNamedGlobalVector(dm,"TSTheta_X0",X0);CHKERRQ(ierr); 700d0b770aSPeter Brune } 710d0b770aSPeter Brune } 720d0b770aSPeter Brune if (Xdot) { 730d0b770aSPeter Brune if (dm && dm != ts->dm) { 740d0b770aSPeter Brune ierr = DMRestoreNamedGlobalVector(dm,"TSTheta_Xdot",Xdot);CHKERRQ(ierr); 750d0b770aSPeter Brune } 760d0b770aSPeter Brune } 770d0b770aSPeter Brune PetscFunctionReturn(0); 780d0b770aSPeter Brune } 790d0b770aSPeter Brune 807445fe48SJed Brown static PetscErrorCode DMCoarsenHook_TSTheta(DM fine,DM coarse,void *ctx) 817445fe48SJed Brown { 827445fe48SJed Brown PetscFunctionBegin; 837445fe48SJed Brown PetscFunctionReturn(0); 847445fe48SJed Brown } 857445fe48SJed Brown 867445fe48SJed Brown static PetscErrorCode DMRestrictHook_TSTheta(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse,void *ctx) 877445fe48SJed Brown { 887445fe48SJed Brown TS ts = (TS)ctx; 897445fe48SJed Brown PetscErrorCode ierr; 907445fe48SJed Brown Vec X0,Xdot,X0_c,Xdot_c; 917445fe48SJed Brown 927445fe48SJed Brown PetscFunctionBegin; 937445fe48SJed Brown ierr = TSThetaGetX0AndXdot(ts,fine,&X0,&Xdot);CHKERRQ(ierr); 947445fe48SJed Brown ierr = TSThetaGetX0AndXdot(ts,coarse,&X0_c,&Xdot_c);CHKERRQ(ierr); 957445fe48SJed Brown ierr = MatRestrict(restrct,X0,X0_c);CHKERRQ(ierr); 967445fe48SJed Brown ierr = MatRestrict(restrct,Xdot,Xdot_c);CHKERRQ(ierr); 977445fe48SJed Brown ierr = VecPointwiseMult(X0_c,rscale,X0_c);CHKERRQ(ierr); 987445fe48SJed Brown ierr = VecPointwiseMult(Xdot_c,rscale,Xdot_c);CHKERRQ(ierr); 990d0b770aSPeter Brune ierr = TSThetaRestoreX0AndXdot(ts,fine,&X0,&Xdot);CHKERRQ(ierr); 1000d0b770aSPeter Brune ierr = TSThetaRestoreX0AndXdot(ts,coarse,&X0_c,&Xdot_c);CHKERRQ(ierr); 1017445fe48SJed Brown PetscFunctionReturn(0); 1027445fe48SJed Brown } 1037445fe48SJed Brown 104258e1594SPeter Brune static PetscErrorCode DMSubDomainHook_TSTheta(DM dm,DM subdm,void *ctx) 105258e1594SPeter Brune { 106258e1594SPeter Brune PetscFunctionBegin; 107258e1594SPeter Brune PetscFunctionReturn(0); 108258e1594SPeter Brune } 109258e1594SPeter Brune 110258e1594SPeter Brune static PetscErrorCode DMSubDomainRestrictHook_TSTheta(DM dm,VecScatter gscat,VecScatter lscat,DM subdm,void *ctx) 111258e1594SPeter Brune { 112258e1594SPeter Brune TS ts = (TS)ctx; 113258e1594SPeter Brune PetscErrorCode ierr; 114258e1594SPeter Brune Vec X0,Xdot,X0_sub,Xdot_sub; 115258e1594SPeter Brune 116258e1594SPeter Brune PetscFunctionBegin; 117258e1594SPeter Brune ierr = TSThetaGetX0AndXdot(ts,dm,&X0,&Xdot);CHKERRQ(ierr); 118258e1594SPeter Brune ierr = TSThetaGetX0AndXdot(ts,subdm,&X0_sub,&Xdot_sub);CHKERRQ(ierr); 119258e1594SPeter Brune 120258e1594SPeter Brune ierr = VecScatterBegin(gscat,X0,X0_sub,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 121258e1594SPeter Brune ierr = VecScatterEnd(gscat,X0,X0_sub,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 122258e1594SPeter Brune 123258e1594SPeter Brune ierr = VecScatterBegin(gscat,Xdot,Xdot_sub,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 124258e1594SPeter Brune ierr = VecScatterEnd(gscat,Xdot,Xdot_sub,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 125258e1594SPeter Brune 126258e1594SPeter Brune ierr = TSThetaRestoreX0AndXdot(ts,dm,&X0,&Xdot);CHKERRQ(ierr); 127258e1594SPeter Brune ierr = TSThetaRestoreX0AndXdot(ts,subdm,&X0_sub,&Xdot_sub);CHKERRQ(ierr); 128258e1594SPeter Brune PetscFunctionReturn(0); 129258e1594SPeter Brune } 130258e1594SPeter Brune 131022c081aSHong Zhang static PetscErrorCode TSThetaEvaluateCostIntegral(TS ts) 132022c081aSHong Zhang { 133022c081aSHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 134cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 135022c081aSHong Zhang PetscErrorCode ierr; 136022c081aSHong Zhang 137022c081aSHong Zhang PetscFunctionBegin; 138022c081aSHong Zhang if (th->endpoint) { 139022c081aSHong Zhang /* Evolve ts->vec_costintegral to compute integrals */ 140022c081aSHong Zhang if (th->Theta!=1.0) { 1411a352fa8SHong Zhang ierr = TSComputeRHSFunction(quadts,th->ptime0,th->X0,ts->vec_costintegrand);CHKERRQ(ierr); 1421a352fa8SHong Zhang ierr = VecAXPY(quadts->vec_sol,th->time_step0*(1.0-th->Theta),ts->vec_costintegrand);CHKERRQ(ierr); 143022c081aSHong Zhang } 144cd4cee2dSHong Zhang ierr = TSComputeRHSFunction(quadts,ts->ptime,ts->vec_sol,ts->vec_costintegrand);CHKERRQ(ierr); 1451a352fa8SHong Zhang ierr = VecAXPY(quadts->vec_sol,th->time_step0*th->Theta,ts->vec_costintegrand);CHKERRQ(ierr); 146022c081aSHong Zhang } else { 147cd4cee2dSHong Zhang ierr = TSComputeRHSFunction(quadts,th->stage_time,th->X,ts->vec_costintegrand);CHKERRQ(ierr); 1481a352fa8SHong Zhang ierr = VecAXPY(quadts->vec_sol,th->time_step0,ts->vec_costintegrand);CHKERRQ(ierr); 149022c081aSHong Zhang } 150022c081aSHong Zhang PetscFunctionReturn(0); 151022c081aSHong Zhang } 152022c081aSHong Zhang 153b1cb36f3SHong Zhang static PetscErrorCode TSForwardCostIntegral_Theta(TS ts) 154b1cb36f3SHong Zhang { 155b1cb36f3SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 156cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 157b1cb36f3SHong Zhang PetscErrorCode ierr; 158b1cb36f3SHong Zhang 159b1cb36f3SHong Zhang PetscFunctionBegin; 160b1cb36f3SHong Zhang /* backup cost integral */ 161cd4cee2dSHong Zhang ierr = VecCopy(quadts->vec_sol,th->VecCostIntegral0);CHKERRQ(ierr); 162022c081aSHong Zhang ierr = TSThetaEvaluateCostIntegral(ts);CHKERRQ(ierr); 163b1cb36f3SHong Zhang PetscFunctionReturn(0); 164b1cb36f3SHong Zhang } 165b1cb36f3SHong Zhang 166b1cb36f3SHong Zhang static PetscErrorCode TSAdjointCostIntegral_Theta(TS ts) 167b1cb36f3SHong Zhang { 1681a352fa8SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 169b1cb36f3SHong Zhang PetscErrorCode ierr; 170b1cb36f3SHong Zhang 171b1cb36f3SHong Zhang PetscFunctionBegin; 1721a352fa8SHong Zhang /* Like TSForwardCostIntegral(), the adjoint cost integral evaluation relies on ptime0 and time_step0. */ 1731a352fa8SHong Zhang th->ptime0 = ts->ptime + ts->time_step; 1741a352fa8SHong Zhang th->time_step0 = -ts->time_step; 175022c081aSHong Zhang ierr = TSThetaEvaluateCostIntegral(ts);CHKERRQ(ierr); 17624655328SShri PetscFunctionReturn(0); 17724655328SShri } 17824655328SShri 179470880abSPatrick Sanan static PetscErrorCode TSTheta_SNESSolve(TS ts,Vec b,Vec x) 1801566a47fSLisandro Dalcin { 1811566a47fSLisandro Dalcin PetscInt nits,lits; 1821566a47fSLisandro Dalcin PetscErrorCode ierr; 1831566a47fSLisandro Dalcin 1841566a47fSLisandro Dalcin PetscFunctionBegin; 1851566a47fSLisandro Dalcin ierr = SNESSolve(ts->snes,b,x);CHKERRQ(ierr); 1861566a47fSLisandro Dalcin ierr = SNESGetIterationNumber(ts->snes,&nits);CHKERRQ(ierr); 1871566a47fSLisandro Dalcin ierr = SNESGetLinearSolveIterations(ts->snes,&lits);CHKERRQ(ierr); 1881566a47fSLisandro Dalcin ts->snes_its += nits; ts->ksp_its += lits; 1891566a47fSLisandro Dalcin PetscFunctionReturn(0); 1901566a47fSLisandro Dalcin } 1911566a47fSLisandro Dalcin 192193ac0bcSJed Brown static PetscErrorCode TSStep_Theta(TS ts) 193316643e7SJed Brown { 194316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 1951566a47fSLisandro Dalcin PetscInt rejections = 0; 1964957b756SLisandro Dalcin PetscBool stageok,accept = PETSC_TRUE; 1971566a47fSLisandro Dalcin PetscReal next_time_step = ts->time_step; 198051f2191SLisandro Dalcin PetscErrorCode ierr; 199316643e7SJed Brown 200316643e7SJed Brown PetscFunctionBegin; 2011566a47fSLisandro Dalcin if (!ts->steprollback) { 2022ffb9264SLisandro Dalcin if (th->vec_sol_prev) { ierr = VecCopy(th->X0,th->vec_sol_prev);CHKERRQ(ierr); } 2033b1890cdSShri Abhyankar ierr = VecCopy(ts->vec_sol,th->X0);CHKERRQ(ierr); 2041566a47fSLisandro Dalcin } 2051566a47fSLisandro Dalcin 2061566a47fSLisandro Dalcin th->status = TS_STEP_INCOMPLETE; 20799260352SHong Zhang while (!ts->reason && th->status != TS_STEP_COMPLETE) { 2083e05ceb1SHong Zhang th->shift = 1/(th->Theta*ts->time_step); 2091566a47fSLisandro Dalcin th->stage_time = ts->ptime + (th->endpoint ? (PetscReal)1 : th->Theta)*ts->time_step; 210be5899b3SLisandro Dalcin ierr = VecCopy(th->X0,th->X);CHKERRQ(ierr); 211fecfb714SLisandro Dalcin if (th->extrapolate && !ts->steprestart) { 2123e05ceb1SHong Zhang ierr = VecAXPY(th->X,1/th->shift,th->Xdot);CHKERRQ(ierr); 213be5899b3SLisandro Dalcin } 214eb284becSJed Brown if (th->endpoint) { /* This formulation assumes linear time-independent mass matrix */ 215eb284becSJed Brown if (!th->affine) {ierr = VecDuplicate(ts->vec_sol,&th->affine);CHKERRQ(ierr);} 2161566a47fSLisandro Dalcin ierr = VecZeroEntries(th->Xdot);CHKERRQ(ierr); 2171566a47fSLisandro Dalcin ierr = TSComputeIFunction(ts,ts->ptime,th->X0,th->Xdot,th->affine,PETSC_FALSE);CHKERRQ(ierr); 2181566a47fSLisandro Dalcin ierr = VecScale(th->affine,(th->Theta-1)/th->Theta);CHKERRQ(ierr); 2191566a47fSLisandro Dalcin } else if (th->affine) { /* Just in case th->endpoint is changed between calls to TSStep_Theta() */ 2201566a47fSLisandro Dalcin ierr = VecZeroEntries(th->affine);CHKERRQ(ierr); 221eb284becSJed Brown } 222be5899b3SLisandro Dalcin ierr = TSPreStage(ts,th->stage_time);CHKERRQ(ierr); 223470880abSPatrick Sanan ierr = TSTheta_SNESSolve(ts,th->affine,th->X);CHKERRQ(ierr); 224be5899b3SLisandro Dalcin ierr = TSPostStage(ts,th->stage_time,0,&th->X);CHKERRQ(ierr); 2251566a47fSLisandro Dalcin ierr = TSAdaptCheckStage(ts->adapt,ts,th->stage_time,th->X,&stageok);CHKERRQ(ierr); 226fecfb714SLisandro Dalcin if (!stageok) goto reject_step; 227051f2191SLisandro Dalcin 228051f2191SLisandro Dalcin th->status = TS_STEP_PENDING; 2291566a47fSLisandro Dalcin if (th->endpoint) { 2301566a47fSLisandro Dalcin ierr = VecCopy(th->X,ts->vec_sol);CHKERRQ(ierr); 2311566a47fSLisandro Dalcin } else { 2323e05ceb1SHong Zhang ierr = VecAXPBYPCZ(th->Xdot,-th->shift,th->shift,0,th->X0,th->X);CHKERRQ(ierr); 2331566a47fSLisandro Dalcin ierr = VecAXPY(ts->vec_sol,ts->time_step,th->Xdot);CHKERRQ(ierr); 2341566a47fSLisandro Dalcin } 2351566a47fSLisandro Dalcin ierr = TSAdaptChoose(ts->adapt,ts,ts->time_step,NULL,&next_time_step,&accept);CHKERRQ(ierr); 2361566a47fSLisandro Dalcin th->status = accept ? TS_STEP_COMPLETE : TS_STEP_INCOMPLETE; 2371566a47fSLisandro Dalcin if (!accept) { 2381566a47fSLisandro Dalcin ierr = VecCopy(th->X0,ts->vec_sol);CHKERRQ(ierr); 239be5899b3SLisandro Dalcin ts->time_step = next_time_step; 240be5899b3SLisandro Dalcin goto reject_step; 241051f2191SLisandro Dalcin } 2423b1890cdSShri Abhyankar 243715f1b00SHong Zhang if (ts->forward_solve || ts->costintegralfwd) { /* Save the info for the later use in cost integral evaluation */ 2441a352fa8SHong Zhang th->ptime0 = ts->ptime; 2451a352fa8SHong Zhang th->time_step0 = ts->time_step; 24617145e75SHong Zhang } 2472b5a38e1SLisandro Dalcin ts->ptime += ts->time_step; 248cdbf8f93SLisandro Dalcin ts->time_step = next_time_step; 249051f2191SLisandro Dalcin break; 250051f2191SLisandro Dalcin 251051f2191SLisandro Dalcin reject_step: 252fecfb714SLisandro Dalcin ts->reject++; accept = PETSC_FALSE; 2531566a47fSLisandro Dalcin if (!ts->reason && ++rejections > ts->max_reject && ts->max_reject >= 0) { 254051f2191SLisandro Dalcin ts->reason = TS_DIVERGED_STEP_REJECTED; 2551566a47fSLisandro Dalcin ierr = PetscInfo2(ts,"Step=%D, step rejections %D greater than current TS allowed, stopping solve\n",ts->steps,rejections);CHKERRQ(ierr); 2563b1890cdSShri Abhyankar } 2573b1890cdSShri Abhyankar } 258316643e7SJed Brown PetscFunctionReturn(0); 259316643e7SJed Brown } 260316643e7SJed Brown 261c9681e5dSHong Zhang static PetscErrorCode TSAdjointStepBEuler_Private(TS ts) 262c9681e5dSHong Zhang { 263c9681e5dSHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 264cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 265c9681e5dSHong Zhang Vec *VecsDeltaLam = th->VecsDeltaLam,*VecsDeltaMu = th->VecsDeltaMu,*VecsSensiTemp = th->VecsSensiTemp; 266c9681e5dSHong Zhang Vec *VecsDeltaLam2 = th->VecsDeltaLam2,*VecsDeltaMu2 = th->VecsDeltaMu2,*VecsSensi2Temp = th->VecsSensi2Temp; 267c9681e5dSHong Zhang PetscInt nadj; 2687207e0fdSHong Zhang Mat J,Jpre,quadJ = NULL,quadJp = NULL; 269c9681e5dSHong Zhang KSP ksp; 270c9681e5dSHong Zhang PetscScalar *xarr; 271077c4feaSHong Zhang TSEquationType eqtype; 272077c4feaSHong Zhang PetscBool isexplicitode = PETSC_FALSE; 2731a352fa8SHong Zhang PetscReal adjoint_time_step; 274c9681e5dSHong Zhang PetscErrorCode ierr; 275c9681e5dSHong Zhang 276c9681e5dSHong Zhang PetscFunctionBegin; 277077c4feaSHong Zhang ierr = TSGetEquationType(ts,&eqtype);CHKERRQ(ierr); 278077c4feaSHong Zhang if (eqtype == TS_EQ_ODE_EXPLICIT) { 279077c4feaSHong Zhang isexplicitode = PETSC_TRUE; 280077c4feaSHong Zhang VecsDeltaLam = ts->vecs_sensi; 281077c4feaSHong Zhang VecsDeltaLam2 = ts->vecs_sensi2; 282077c4feaSHong Zhang } 283c9681e5dSHong Zhang th->status = TS_STEP_INCOMPLETE; 284c9681e5dSHong Zhang ierr = SNESGetKSP(ts->snes,&ksp);CHKERRQ(ierr); 285cd4cee2dSHong Zhang ierr = TSGetIJacobian(ts,&J,&Jpre,NULL,NULL);CHKERRQ(ierr); 2867207e0fdSHong Zhang if (quadts) { 287cd4cee2dSHong Zhang ierr = TSGetRHSJacobian(quadts,&quadJ,NULL,NULL,NULL);CHKERRQ(ierr); 288cd4cee2dSHong Zhang ierr = TSGetRHSJacobianP(quadts,&quadJp,NULL,NULL);CHKERRQ(ierr); 2897207e0fdSHong Zhang } 290c9681e5dSHong Zhang 2911a352fa8SHong Zhang th->stage_time = ts->ptime; 2921a352fa8SHong Zhang adjoint_time_step = -ts->time_step; /* always positive since time_step is negative */ 293c9681e5dSHong Zhang 29433f72c5dSHong Zhang /* Build RHS for first-order adjoint lambda_{n+1}/h + r_u^T(n+1) */ 2957207e0fdSHong Zhang if (quadts) { 296cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,th->X,quadJ,NULL);CHKERRQ(ierr); 2977207e0fdSHong Zhang } 298cd4cee2dSHong Zhang 299c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 300c9681e5dSHong Zhang ierr = VecCopy(ts->vecs_sensi[nadj],VecsSensiTemp[nadj]);CHKERRQ(ierr); 3011a352fa8SHong Zhang ierr = VecScale(VecsSensiTemp[nadj],1./adjoint_time_step);CHKERRQ(ierr); /* lambda_{n+1}/h */ 302cd4cee2dSHong Zhang if (quadJ) { 303cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJ,nadj,&xarr);CHKERRQ(ierr); 304cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdu_col,xarr);CHKERRQ(ierr); 305cd4cee2dSHong Zhang ierr = VecAXPY(VecsSensiTemp[nadj],1.,ts->vec_drdu_col);CHKERRQ(ierr); 306cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdu_col);CHKERRQ(ierr); 307cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJ,&xarr);CHKERRQ(ierr); 308c9681e5dSHong Zhang } 309c9681e5dSHong Zhang } 310c9681e5dSHong Zhang 311c9681e5dSHong Zhang /* Build LHS for first-order adjoint */ 312*c87ba875SIvan Yashchuk th->shift = 1./adjoint_time_step; 31304f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,th->X,J,Jpre);CHKERRQ(ierr); 31404f7482eSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 315c9681e5dSHong Zhang 316c9681e5dSHong Zhang /* Solve stage equation LHS*lambda_s = RHS for first-order adjoint */ 317c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 318c9681e5dSHong Zhang KSPConvergedReason kspreason; 319c9681e5dSHong Zhang ierr = KSPSolveTranspose(ksp,VecsSensiTemp[nadj],VecsDeltaLam[nadj]);CHKERRQ(ierr); 320c9681e5dSHong Zhang ierr = KSPGetConvergedReason(ksp,&kspreason);CHKERRQ(ierr); 321c9681e5dSHong Zhang if (kspreason < 0) { 322c9681e5dSHong Zhang ts->reason = TSADJOINT_DIVERGED_LINEAR_SOLVE; 32329b3c8a1SHong Zhang ierr = PetscInfo2(ts,"Step=%D, %Dth cost function, transposed linear solve fails, stopping 1st-order adjoint solve\n",ts->steps,nadj);CHKERRQ(ierr); 324c9681e5dSHong Zhang } 325c9681e5dSHong Zhang } 326c9681e5dSHong Zhang 327c9681e5dSHong Zhang if (ts->vecs_sensi2) { /* U_{n+1} */ 328c9681e5dSHong Zhang /* Get w1 at t_{n+1} from TLM matrix */ 329c9681e5dSHong Zhang ierr = MatDenseGetColumn(ts->mat_sensip,0,&xarr);CHKERRQ(ierr); 330c9681e5dSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 331c9681e5dSHong Zhang /* lambda_s^T F_UU w_1 */ 332b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionUU(ts,th->stage_time,th->X,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fuu);CHKERRQ(ierr); 333c9681e5dSHong Zhang /* lambda_s^T F_UP w_2 */ 334b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionUP(ts,th->stage_time,th->X,VecsDeltaLam,ts->vec_dir,ts->vecs_fup);CHKERRQ(ierr); 335c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { /* compute the residual */ 336c9681e5dSHong Zhang ierr = VecCopy(ts->vecs_sensi2[nadj],VecsSensi2Temp[nadj]);CHKERRQ(ierr); 3371a352fa8SHong Zhang ierr = VecScale(VecsSensi2Temp[nadj],1./adjoint_time_step);CHKERRQ(ierr); 33833f72c5dSHong Zhang ierr = VecAXPY(VecsSensi2Temp[nadj],-1.,ts->vecs_fuu[nadj]);CHKERRQ(ierr); 339c9681e5dSHong Zhang if (ts->vecs_fup) { 34033f72c5dSHong Zhang ierr = VecAXPY(VecsSensi2Temp[nadj],-1.,ts->vecs_fup[nadj]);CHKERRQ(ierr); 341c9681e5dSHong Zhang } 342c9681e5dSHong Zhang } 343c9681e5dSHong Zhang /* Solve stage equation LHS X = RHS for second-order adjoint */ 344c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 34505c9950eSHong Zhang KSPConvergedReason kspreason; 346c9681e5dSHong Zhang ierr = KSPSolveTranspose(ksp,VecsSensi2Temp[nadj],VecsDeltaLam2[nadj]);CHKERRQ(ierr); 34705c9950eSHong Zhang ierr = KSPGetConvergedReason(ksp,&kspreason);CHKERRQ(ierr); 34805c9950eSHong Zhang if (kspreason < 0) { 34905c9950eSHong Zhang ts->reason = TSADJOINT_DIVERGED_LINEAR_SOLVE; 35029b3c8a1SHong Zhang ierr = PetscInfo2(ts,"Step=%D, %Dth cost function, transposed linear solve fails, stopping 2nd-order adjoint solve\n",ts->steps,nadj);CHKERRQ(ierr); 35105c9950eSHong Zhang } 352c9681e5dSHong Zhang } 353c9681e5dSHong Zhang } 354c9681e5dSHong Zhang 355c9681e5dSHong Zhang /* Update sensitivities, and evaluate integrals if there is any */ 356077c4feaSHong Zhang if (!isexplicitode) { 3573e05ceb1SHong Zhang th->shift = 0.0; 35804f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,th->X,J,Jpre);CHKERRQ(ierr); 35904f7482eSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 360c9681e5dSHong Zhang ierr = MatScale(J,-1.);CHKERRQ(ierr); 361c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 36233f72c5dSHong Zhang /* Add f_U \lambda_s to the original RHS */ 363c9681e5dSHong Zhang ierr = MatMultTransposeAdd(J,VecsDeltaLam[nadj],VecsSensiTemp[nadj],VecsSensiTemp[nadj]);CHKERRQ(ierr); 3641a352fa8SHong Zhang ierr = VecScale(VecsSensiTemp[nadj],adjoint_time_step);CHKERRQ(ierr); 365c9681e5dSHong Zhang ierr = VecCopy(VecsSensiTemp[nadj],ts->vecs_sensi[nadj]);CHKERRQ(ierr); 366c9681e5dSHong Zhang if (ts->vecs_sensi2) { 367c9681e5dSHong Zhang ierr = MatMultTransposeAdd(J,VecsDeltaLam2[nadj],VecsSensi2Temp[nadj],VecsSensi2Temp[nadj]);CHKERRQ(ierr); 3681a352fa8SHong Zhang ierr = VecScale(VecsSensi2Temp[nadj],adjoint_time_step);CHKERRQ(ierr); 369c9681e5dSHong Zhang ierr = VecCopy(VecsSensi2Temp[nadj],ts->vecs_sensi2[nadj]);CHKERRQ(ierr); 370c9681e5dSHong Zhang } 371c9681e5dSHong Zhang } 372077c4feaSHong Zhang } 373c9681e5dSHong Zhang if (ts->vecs_sensip) { 3741a352fa8SHong Zhang ierr = TSComputeIJacobianP(ts,th->stage_time,th->X,th->Xdot,1./adjoint_time_step,ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); /* get -f_p */ 3757207e0fdSHong Zhang if (quadts) { 376cd4cee2dSHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->stage_time,th->X,quadJp);CHKERRQ(ierr); 3777207e0fdSHong Zhang } 378c9681e5dSHong Zhang if (ts->vecs_sensi2p) { 379c9681e5dSHong Zhang /* lambda_s^T F_PU w_1 */ 380b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionPU(ts,th->stage_time,th->X,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fpu);CHKERRQ(ierr); 38133f72c5dSHong Zhang /* lambda_s^T F_PP w_2 */ 382b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionPP(ts,th->stage_time,th->X,VecsDeltaLam,ts->vec_dir,ts->vecs_fpp);CHKERRQ(ierr); 383c9681e5dSHong Zhang } 384cd4cee2dSHong Zhang 385c9681e5dSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 386c9681e5dSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam[nadj],VecsDeltaMu[nadj]);CHKERRQ(ierr); 3871a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],-adjoint_time_step,VecsDeltaMu[nadj]);CHKERRQ(ierr); 388cd4cee2dSHong Zhang if (quadJp) { 389cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJp,nadj,&xarr);CHKERRQ(ierr); 390cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdp_col,xarr);CHKERRQ(ierr); 3911a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],adjoint_time_step,ts->vec_drdp_col);CHKERRQ(ierr); 392cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdp_col);CHKERRQ(ierr); 393cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJp,&xarr);CHKERRQ(ierr); 39433f72c5dSHong Zhang } 395c9681e5dSHong Zhang if (ts->vecs_sensi2p) { 396c9681e5dSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam2[nadj],VecsDeltaMu2[nadj]);CHKERRQ(ierr); 3971a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step,VecsDeltaMu2[nadj]);CHKERRQ(ierr); 398c9681e5dSHong Zhang if (ts->vecs_fpu) { 3991a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step,ts->vecs_fpu[nadj]);CHKERRQ(ierr); 400c9681e5dSHong Zhang } 401c9681e5dSHong Zhang if (ts->vecs_fpp) { 4021a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step,ts->vecs_fpp[nadj]);CHKERRQ(ierr); 403c9681e5dSHong Zhang } 404c9681e5dSHong Zhang } 405c9681e5dSHong Zhang } 406c9681e5dSHong Zhang } 407c9681e5dSHong Zhang 408c9681e5dSHong Zhang if (ts->vecs_sensi2) { 409c9681e5dSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 410c9681e5dSHong Zhang ierr = MatDenseRestoreColumn(ts->mat_sensip,&xarr);CHKERRQ(ierr); 411c9681e5dSHong Zhang } 412c9681e5dSHong Zhang th->status = TS_STEP_COMPLETE; 413c9681e5dSHong Zhang PetscFunctionReturn(0); 414c9681e5dSHong Zhang } 415c9681e5dSHong Zhang 41642f2b339SBarry Smith static PetscErrorCode TSAdjointStep_Theta(TS ts) 4172ca6e920SHong Zhang { 4182ca6e920SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 419cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 420b5e0532dSHong Zhang Vec *VecsDeltaLam = th->VecsDeltaLam,*VecsDeltaMu = th->VecsDeltaMu,*VecsSensiTemp = th->VecsSensiTemp; 421b5b4017aSHong Zhang Vec *VecsDeltaLam2 = th->VecsDeltaLam2,*VecsDeltaMu2 = th->VecsDeltaMu2,*VecsSensi2Temp = th->VecsSensi2Temp; 4222ca6e920SHong Zhang PetscInt nadj; 4237207e0fdSHong Zhang Mat J,Jpre,quadJ = NULL,quadJp = NULL; 4242ca6e920SHong Zhang KSP ksp; 425b5b4017aSHong Zhang PetscScalar *xarr; 4261a352fa8SHong Zhang PetscReal adjoint_time_step; 4271a352fa8SHong Zhang PetscReal adjoint_ptime; /* end time of the adjoint time step (ts->ptime is the start time, ususally ts->ptime is larger than adjoint_ptime) */ 428b5b4017aSHong Zhang PetscErrorCode ierr; 4292ca6e920SHong Zhang 4302ca6e920SHong Zhang PetscFunctionBegin; 431c9681e5dSHong Zhang if (th->Theta == 1.) { 432c9681e5dSHong Zhang ierr = TSAdjointStepBEuler_Private(ts);CHKERRQ(ierr); 433c9681e5dSHong Zhang PetscFunctionReturn(0); 434c9681e5dSHong Zhang } 4352ca6e920SHong Zhang th->status = TS_STEP_INCOMPLETE; 436302440fdSBarry Smith ierr = SNESGetKSP(ts->snes,&ksp);CHKERRQ(ierr); 437cd4cee2dSHong Zhang ierr = TSGetIJacobian(ts,&J,&Jpre,NULL,NULL);CHKERRQ(ierr); 4387207e0fdSHong Zhang if (quadts) { 439cd4cee2dSHong Zhang ierr = TSGetRHSJacobian(quadts,&quadJ,NULL,NULL,NULL);CHKERRQ(ierr); 440cd4cee2dSHong Zhang ierr = TSGetRHSJacobianP(quadts,&quadJp,NULL,NULL);CHKERRQ(ierr); 4417207e0fdSHong Zhang } 442b5e0532dSHong Zhang /* If endpoint=1, th->ptime and th->X0 will be used; if endpoint=0, th->stage_time and th->X will be used. */ 4431a352fa8SHong Zhang th->stage_time = th->endpoint ? ts->ptime : (ts->ptime+(1.-th->Theta)*ts->time_step); 4441a352fa8SHong Zhang adjoint_ptime = ts->ptime + ts->time_step; 4451a352fa8SHong Zhang adjoint_time_step = -ts->time_step; /* always positive since time_step is negative */ 4462ca6e920SHong Zhang 447b5b4017aSHong Zhang /* Build RHS for first-order adjoint */ 44833f72c5dSHong Zhang /* Cost function has an integral term */ 4497207e0fdSHong Zhang if (quadts) { 45005755b9cSHong Zhang if (th->endpoint) { 451cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,ts->vec_sol,quadJ,NULL);CHKERRQ(ierr); 45205755b9cSHong Zhang } else { 453cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,th->X,quadJ,NULL);CHKERRQ(ierr); 45405755b9cSHong Zhang } 4557207e0fdSHong Zhang } 45633f72c5dSHong Zhang 457abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 458b5e0532dSHong Zhang ierr = VecCopy(ts->vecs_sensi[nadj],VecsSensiTemp[nadj]);CHKERRQ(ierr); 4591a352fa8SHong Zhang ierr = VecScale(VecsSensiTemp[nadj],1./(th->Theta*adjoint_time_step));CHKERRQ(ierr); 460cd4cee2dSHong Zhang if (quadJ) { 461cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJ,nadj,&xarr);CHKERRQ(ierr); 462cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdu_col,xarr);CHKERRQ(ierr); 463cd4cee2dSHong Zhang ierr = VecAXPY(VecsSensiTemp[nadj],1.,ts->vec_drdu_col);CHKERRQ(ierr); 464cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdu_col);CHKERRQ(ierr); 465cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJ,&xarr);CHKERRQ(ierr); 46636eaed60SHong Zhang } 4672ca6e920SHong Zhang } 4683c54f92cSHong Zhang 469b5b4017aSHong Zhang /* Build LHS for first-order adjoint */ 4701a352fa8SHong Zhang th->shift = 1./(th->Theta*adjoint_time_step); 4713c54f92cSHong Zhang if (th->endpoint) { 47204f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,ts->vec_sol,J,Jpre);CHKERRQ(ierr); 4733c54f92cSHong Zhang } else { 47404f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,th->X,J,Jpre);CHKERRQ(ierr); 4753c54f92cSHong Zhang } 476cd4cee2dSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 4772ca6e920SHong Zhang 478b5b4017aSHong Zhang /* Solve stage equation LHS*lambda_s = RHS for first-order adjoint */ 479abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 4801d14d03bSHong Zhang KSPConvergedReason kspreason; 481b5e0532dSHong Zhang ierr = KSPSolveTranspose(ksp,VecsSensiTemp[nadj],VecsDeltaLam[nadj]);CHKERRQ(ierr); 4821d14d03bSHong Zhang ierr = KSPGetConvergedReason(ksp,&kspreason);CHKERRQ(ierr); 4831d14d03bSHong Zhang if (kspreason < 0) { 4841d14d03bSHong Zhang ts->reason = TSADJOINT_DIVERGED_LINEAR_SOLVE; 48529b3c8a1SHong Zhang ierr = PetscInfo2(ts,"Step=%D, %Dth cost function, transposed linear solve fails, stopping 1st-order adjoint solve\n",ts->steps,nadj);CHKERRQ(ierr); 4861d14d03bSHong Zhang } 4872ca6e920SHong Zhang } 4883c54f92cSHong Zhang 4891d14d03bSHong Zhang /* Second-order adjoint */ 490b5b4017aSHong Zhang if (ts->vecs_sensi2) { /* U_{n+1} */ 491b5b4017aSHong Zhang if (!th->endpoint) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Operation not implemented in TS_Theta"); 492b5b4017aSHong Zhang /* Get w1 at t_{n+1} from TLM matrix */ 493b5b4017aSHong Zhang ierr = MatDenseGetColumn(ts->mat_sensip,0,&xarr);CHKERRQ(ierr); 494b5b4017aSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 495b5b4017aSHong Zhang /* lambda_s^T F_UU w_1 */ 496b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionUU(ts,th->stage_time,ts->vec_sol,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fuu);CHKERRQ(ierr); 497b5b4017aSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 498b5b4017aSHong Zhang ierr = MatDenseRestoreColumn(ts->mat_sensip,&xarr);CHKERRQ(ierr); 499b5b4017aSHong Zhang /* lambda_s^T F_UP w_2 */ 500b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionUP(ts,th->stage_time,ts->vec_sol,VecsDeltaLam,ts->vec_dir,ts->vecs_fup);CHKERRQ(ierr); 501b5b4017aSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { /* compute the residual */ 502b5b4017aSHong Zhang ierr = VecCopy(ts->vecs_sensi2[nadj],VecsSensi2Temp[nadj]);CHKERRQ(ierr); 5033e05ceb1SHong Zhang ierr = VecScale(VecsSensi2Temp[nadj],th->shift);CHKERRQ(ierr); 50433f72c5dSHong Zhang ierr = VecAXPY(VecsSensi2Temp[nadj],-1.,ts->vecs_fuu[nadj]);CHKERRQ(ierr); 505b5b4017aSHong Zhang if (ts->vecs_fup) { 50633f72c5dSHong Zhang ierr = VecAXPY(VecsSensi2Temp[nadj],-1.,ts->vecs_fup[nadj]);CHKERRQ(ierr); 507b5b4017aSHong Zhang } 508b5b4017aSHong Zhang } 509b5b4017aSHong Zhang /* Solve stage equation LHS X = RHS for second-order adjoint */ 510b5b4017aSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 5111d14d03bSHong Zhang KSPConvergedReason kspreason; 5121d14d03bSHong Zhang ierr = KSPSolveTranspose(ksp,VecsSensi2Temp[nadj],VecsDeltaLam2[nadj]);CHKERRQ(ierr); 5131d14d03bSHong Zhang ierr = KSPGetConvergedReason(ksp,&kspreason);CHKERRQ(ierr); 5141d14d03bSHong Zhang if (kspreason < 0) { 5151d14d03bSHong Zhang ts->reason = TSADJOINT_DIVERGED_LINEAR_SOLVE; 51629b3c8a1SHong Zhang ierr = PetscInfo2(ts,"Step=%D, %Dth cost function, transposed linear solve fails, stopping 2nd-order adjoint solve\n",ts->steps,nadj);CHKERRQ(ierr); 5171d14d03bSHong Zhang } 518b5b4017aSHong Zhang } 519b5b4017aSHong Zhang } 520b5b4017aSHong Zhang 52136eaed60SHong Zhang /* Update sensitivities, and evaluate integrals if there is any */ 5221d14d03bSHong Zhang if(th->endpoint) { /* two-stage Theta methods with th->Theta!=1, th->Theta==1 leads to BEuler */ 5231a352fa8SHong Zhang th->shift = 1./((th->Theta-1.)*adjoint_time_step); 5241a352fa8SHong Zhang th->stage_time = adjoint_ptime; 52504f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,th->X0,J,Jpre);CHKERRQ(ierr); 52604f7482eSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 52733f72c5dSHong Zhang /* R_U at t_n */ 5287207e0fdSHong Zhang if (quadts) { 5291a352fa8SHong Zhang ierr = TSComputeRHSJacobian(quadts,adjoint_ptime,th->X0,quadJ,NULL);CHKERRQ(ierr); 5307207e0fdSHong Zhang } 531abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 532b5e0532dSHong Zhang ierr = MatMultTranspose(J,VecsDeltaLam[nadj],ts->vecs_sensi[nadj]);CHKERRQ(ierr); 533cd4cee2dSHong Zhang if (quadJ) { 534cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJ,nadj,&xarr);CHKERRQ(ierr); 535cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdu_col,xarr);CHKERRQ(ierr); 536cd4cee2dSHong Zhang ierr = VecAXPY(ts->vecs_sensi[nadj],-1.,ts->vec_drdu_col);CHKERRQ(ierr); 537cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdu_col);CHKERRQ(ierr); 538cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJ,&xarr);CHKERRQ(ierr); 539b5b4017aSHong Zhang } 5403e05ceb1SHong Zhang ierr = VecScale(ts->vecs_sensi[nadj],1./th->shift);CHKERRQ(ierr); 541b5b4017aSHong Zhang } 5421d14d03bSHong Zhang 5431d14d03bSHong Zhang /* Second-order adjoint */ 5441d14d03bSHong Zhang if (ts->vecs_sensi2) { /* U_n */ 545b5b4017aSHong Zhang /* Get w1 at t_n from TLM matrix */ 546b5b4017aSHong Zhang ierr = MatDenseGetColumn(th->MatFwdSensip0,0,&xarr);CHKERRQ(ierr); 547b5b4017aSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 548b5b4017aSHong Zhang /* lambda_s^T F_UU w_1 */ 5491a352fa8SHong Zhang ierr = TSComputeIHessianProductFunctionUU(ts,adjoint_ptime,th->X0,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fuu);CHKERRQ(ierr); 550b5b4017aSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 55133f72c5dSHong Zhang ierr = MatDenseRestoreColumn(th->MatFwdSensip0,&xarr);CHKERRQ(ierr); 552b5b4017aSHong Zhang /* lambda_s^T F_UU w_2 */ 5531a352fa8SHong Zhang ierr = TSComputeIHessianProductFunctionUP(ts,adjoint_ptime,th->X0,VecsDeltaLam,ts->vec_dir,ts->vecs_fup);CHKERRQ(ierr); 554b5b4017aSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 55533f72c5dSHong Zhang /* M^T Lambda_s + h(1-theta) F_U^T Lambda_s + h(1-theta) lambda_s^T F_UU w_1 + lambda_s^T F_UP w_2 */ 556b5b4017aSHong Zhang ierr = MatMultTranspose(J,VecsDeltaLam2[nadj],ts->vecs_sensi2[nadj]);CHKERRQ(ierr); 55733f72c5dSHong Zhang ierr = VecAXPY(ts->vecs_sensi2[nadj],1.,ts->vecs_fuu[nadj]);CHKERRQ(ierr); 558b5b4017aSHong Zhang if (ts->vecs_fup) { 55933f72c5dSHong Zhang ierr = VecAXPY(ts->vecs_sensi2[nadj],1.,ts->vecs_fup[nadj]);CHKERRQ(ierr); 560b5b4017aSHong Zhang } 5613e05ceb1SHong Zhang ierr = VecScale(ts->vecs_sensi2[nadj],1./th->shift);CHKERRQ(ierr); 562b5b4017aSHong Zhang } 563b5e0532dSHong Zhang } 5643fd52205SHong Zhang 565c586f2e8SHong Zhang th->stage_time = ts->ptime; /* recover the old value */ 566c586f2e8SHong Zhang 5673fd52205SHong Zhang if (ts->vecs_sensip) { /* sensitivities wrt parameters */ 568b5b4017aSHong Zhang /* U_{n+1} */ 5691a352fa8SHong Zhang ierr = TSComputeIJacobianP(ts,th->stage_time,ts->vec_sol,th->Xdot,-1./(th->Theta*adjoint_time_step),ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 5707207e0fdSHong Zhang if (quadts) { 571cd4cee2dSHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->stage_time,ts->vec_sol,quadJp);CHKERRQ(ierr); 5727207e0fdSHong Zhang } 573abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 574b5e0532dSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam[nadj],VecsDeltaMu[nadj]);CHKERRQ(ierr); 5751a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],-adjoint_time_step*th->Theta,VecsDeltaMu[nadj]);CHKERRQ(ierr); 5763fd52205SHong Zhang } 57733f72c5dSHong Zhang if (ts->vecs_sensi2p) { /* second-order */ 57833f72c5dSHong Zhang /* Get w1 at t_{n+1} from TLM matrix */ 57933f72c5dSHong Zhang ierr = MatDenseGetColumn(ts->mat_sensip,0,&xarr);CHKERRQ(ierr); 58033f72c5dSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 581b5b4017aSHong Zhang /* lambda_s^T F_PU w_1 */ 582b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionPU(ts,th->stage_time,ts->vec_sol,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fpu);CHKERRQ(ierr); 58333f72c5dSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 58433f72c5dSHong Zhang ierr = MatDenseRestoreColumn(ts->mat_sensip,&xarr);CHKERRQ(ierr); 58533f72c5dSHong Zhang 586b5b4017aSHong Zhang /* lambda_s^T F_PP w_2 */ 587b1e111ebSHong Zhang ierr = TSComputeIHessianProductFunctionPP(ts,th->stage_time,ts->vec_sol,VecsDeltaLam,ts->vec_dir,ts->vecs_fpp);CHKERRQ(ierr); 588b5b4017aSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 58933f72c5dSHong Zhang /* Mu2 <- Mu2 + h theta F_P^T Lambda_s + h theta (lambda_s^T F_UU w_1 + lambda_s^T F_UP w_2) */ 590b5b4017aSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam2[nadj],VecsDeltaMu2[nadj]);CHKERRQ(ierr); 5911a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*th->Theta,VecsDeltaMu2[nadj]);CHKERRQ(ierr); 592b5b4017aSHong Zhang if (ts->vecs_fpu) { 5931a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*th->Theta,ts->vecs_fpu[nadj]);CHKERRQ(ierr); 594b5b4017aSHong Zhang } 595b5b4017aSHong Zhang if (ts->vecs_fpp) { 5961a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*th->Theta,ts->vecs_fpp[nadj]);CHKERRQ(ierr); 597b5b4017aSHong Zhang } 598b5b4017aSHong Zhang } 599b5b4017aSHong Zhang } 600b5b4017aSHong Zhang 601b5b4017aSHong Zhang /* U_s */ 6021a352fa8SHong Zhang ierr = TSComputeIJacobianP(ts,adjoint_ptime,th->X0,th->Xdot,1./((th->Theta-1.0)*adjoint_time_step),ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 6037207e0fdSHong Zhang if (quadts) { 6041a352fa8SHong Zhang ierr = TSComputeRHSJacobianP(quadts,adjoint_ptime,th->X0,quadJp);CHKERRQ(ierr); 6057207e0fdSHong Zhang } 606abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 607b5e0532dSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam[nadj],VecsDeltaMu[nadj]);CHKERRQ(ierr); 6081a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],-adjoint_time_step*(1.0-th->Theta),VecsDeltaMu[nadj]);CHKERRQ(ierr); 60933f72c5dSHong Zhang if (ts->vecs_sensi2p) { /* second-order */ 61033f72c5dSHong Zhang /* Get w1 at t_n from TLM matrix */ 61133f72c5dSHong Zhang ierr = MatDenseGetColumn(th->MatFwdSensip0,0,&xarr);CHKERRQ(ierr); 61233f72c5dSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 613b5b4017aSHong Zhang /* lambda_s^T F_PU w_1 */ 6141a352fa8SHong Zhang ierr = TSComputeIHessianProductFunctionPU(ts,adjoint_ptime,th->X0,VecsDeltaLam,ts->vec_sensip_col,ts->vecs_fpu);CHKERRQ(ierr); 61533f72c5dSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 61633f72c5dSHong Zhang ierr = MatDenseRestoreColumn(th->MatFwdSensip0,&xarr);CHKERRQ(ierr); 617b5b4017aSHong Zhang /* lambda_s^T F_PP w_2 */ 6181a352fa8SHong Zhang ierr = TSComputeIHessianProductFunctionPP(ts,adjoint_ptime,th->X0,VecsDeltaLam,ts->vec_dir,ts->vecs_fpp);CHKERRQ(ierr); 619b5b4017aSHong Zhang for (nadj=0; nadj<ts->numcost; nadj++) { 62033f72c5dSHong Zhang /* Mu2 <- Mu2 + h(1-theta) F_P^T Lambda_s + h(1-theta) (lambda_s^T F_UU w_1 + lambda_s^T F_UP w_2) */ 621b5b4017aSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam2[nadj],VecsDeltaMu2[nadj]);CHKERRQ(ierr); 6221a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*(1.0-th->Theta),VecsDeltaMu2[nadj]);CHKERRQ(ierr); 623b5b4017aSHong Zhang if (ts->vecs_fpu) { 6241a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*(1.0-th->Theta),ts->vecs_fpu[nadj]);CHKERRQ(ierr); 625b5e0532dSHong Zhang } 626b5b4017aSHong Zhang if (ts->vecs_fpp) { 6271a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi2p[nadj],-adjoint_time_step*(1.0-th->Theta),ts->vecs_fpp[nadj]);CHKERRQ(ierr); 628b5b4017aSHong Zhang } 62936eaed60SHong Zhang } 63036eaed60SHong Zhang } 6313fd52205SHong Zhang } 632b5e0532dSHong Zhang } 6333fd52205SHong Zhang } else { /* one-stage case */ 6343e05ceb1SHong Zhang th->shift = 0.0; 63504f7482eSHong Zhang ierr = TSComputeSNESJacobian(ts,th->X,J,Jpre);CHKERRQ(ierr); /* get -f_y */ 63604f7482eSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 6377207e0fdSHong Zhang if (quadts) { 638cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,th->X,quadJ,NULL);CHKERRQ(ierr); 6397207e0fdSHong Zhang } 640abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 641b5e0532dSHong Zhang ierr = MatMultTranspose(J,VecsDeltaLam[nadj],VecsSensiTemp[nadj]);CHKERRQ(ierr); 6421a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi[nadj],-adjoint_time_step,VecsSensiTemp[nadj]);CHKERRQ(ierr); 643cd4cee2dSHong Zhang if (quadJ) { 644cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJ,nadj,&xarr);CHKERRQ(ierr); 645cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdu_col,xarr);CHKERRQ(ierr); 6461a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensi[nadj],adjoint_time_step,ts->vec_drdu_col);CHKERRQ(ierr); 647cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdu_col);CHKERRQ(ierr); 648cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJ,&xarr);CHKERRQ(ierr); 64936eaed60SHong Zhang } 6502ca6e920SHong Zhang } 6513fd52205SHong Zhang if (ts->vecs_sensip) { 6523e05ceb1SHong Zhang ierr = TSComputeIJacobianP(ts,th->stage_time,th->X,th->Xdot,th->shift,ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 6537207e0fdSHong Zhang if (quadts) { 654cd4cee2dSHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->stage_time,th->X,quadJp);CHKERRQ(ierr); 6557207e0fdSHong Zhang } 656abc2977eSBarry Smith for (nadj=0; nadj<ts->numcost; nadj++) { 65733f72c5dSHong Zhang ierr = MatMultTranspose(ts->Jacp,VecsDeltaLam[nadj],VecsDeltaMu[nadj]);CHKERRQ(ierr); 6581a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],-adjoint_time_step,VecsDeltaMu[nadj]);CHKERRQ(ierr); 659cd4cee2dSHong Zhang if (quadJp) { 660cd4cee2dSHong Zhang ierr = MatDenseGetColumn(quadJp,nadj,&xarr);CHKERRQ(ierr); 661cd4cee2dSHong Zhang ierr = VecPlaceArray(ts->vec_drdp_col,xarr);CHKERRQ(ierr); 6621a352fa8SHong Zhang ierr = VecAXPY(ts->vecs_sensip[nadj],adjoint_time_step,ts->vec_drdp_col);CHKERRQ(ierr); 663cd4cee2dSHong Zhang ierr = VecResetArray(ts->vec_drdp_col);CHKERRQ(ierr); 664cd4cee2dSHong Zhang ierr = MatDenseRestoreColumn(quadJp,&xarr);CHKERRQ(ierr); 66536eaed60SHong Zhang } 66636eaed60SHong Zhang } 6673fd52205SHong Zhang } 6682ca6e920SHong Zhang } 6692ca6e920SHong Zhang 6702ca6e920SHong Zhang th->status = TS_STEP_COMPLETE; 6712ca6e920SHong Zhang PetscFunctionReturn(0); 6722ca6e920SHong Zhang } 6732ca6e920SHong Zhang 674cd652676SJed Brown static PetscErrorCode TSInterpolate_Theta(TS ts,PetscReal t,Vec X) 675cd652676SJed Brown { 676cd652676SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 677be5899b3SLisandro Dalcin PetscReal dt = t - ts->ptime; 678cd652676SJed Brown PetscErrorCode ierr; 679cd652676SJed Brown 680cd652676SJed Brown PetscFunctionBegin; 681a43b19c4SJed Brown ierr = VecCopy(ts->vec_sol,th->X);CHKERRQ(ierr); 682be5899b3SLisandro Dalcin if (th->endpoint) dt *= th->Theta; 683be5899b3SLisandro Dalcin ierr = VecWAXPY(X,dt,th->Xdot,th->X);CHKERRQ(ierr); 684cd652676SJed Brown PetscFunctionReturn(0); 685cd652676SJed Brown } 686cd652676SJed Brown 6871566a47fSLisandro Dalcin static PetscErrorCode TSEvaluateWLTE_Theta(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 6881566a47fSLisandro Dalcin { 6891566a47fSLisandro Dalcin TS_Theta *th = (TS_Theta*)ts->data; 6901566a47fSLisandro Dalcin Vec X = ts->vec_sol; /* X = solution */ 6911566a47fSLisandro Dalcin Vec Y = th->vec_lte_work; /* Y = X + LTE */ 6927453f775SEmil Constantinescu PetscReal wltea,wlter; 6931566a47fSLisandro Dalcin PetscErrorCode ierr; 6941566a47fSLisandro Dalcin 6951566a47fSLisandro Dalcin PetscFunctionBegin; 6962ffb9264SLisandro Dalcin if (!th->vec_sol_prev) {*wlte = -1; PetscFunctionReturn(0);} 6971566a47fSLisandro Dalcin /* Cannot compute LTE in first step or in restart after event */ 698fecfb714SLisandro Dalcin if (ts->steprestart) {*wlte = -1; PetscFunctionReturn(0);} 6991566a47fSLisandro Dalcin /* Compute LTE using backward differences with non-constant time step */ 700fecfb714SLisandro Dalcin { 701be5899b3SLisandro Dalcin PetscReal h = ts->time_step, h_prev = ts->ptime - ts->ptime_prev; 702be5899b3SLisandro Dalcin PetscReal a = 1 + h_prev/h; 7031566a47fSLisandro Dalcin PetscScalar scal[3]; Vec vecs[3]; 7041566a47fSLisandro Dalcin scal[0] = +1/a; scal[1] = -1/(a-1); scal[2] = +1/(a*(a-1)); 7051566a47fSLisandro Dalcin vecs[0] = X; vecs[1] = th->X0; vecs[2] = th->vec_sol_prev; 7061566a47fSLisandro Dalcin ierr = VecCopy(X,Y);CHKERRQ(ierr); 7071566a47fSLisandro Dalcin ierr = VecMAXPY(Y,3,scal,vecs);CHKERRQ(ierr); 7087453f775SEmil Constantinescu ierr = TSErrorWeightedNorm(ts,X,Y,wnormtype,wlte,&wltea,&wlter);CHKERRQ(ierr); 7091566a47fSLisandro Dalcin } 7101566a47fSLisandro Dalcin if (order) *order = 2; 7111566a47fSLisandro Dalcin PetscFunctionReturn(0); 7121566a47fSLisandro Dalcin } 7131566a47fSLisandro Dalcin 7141566a47fSLisandro Dalcin static PetscErrorCode TSRollBack_Theta(TS ts) 7151566a47fSLisandro Dalcin { 7161566a47fSLisandro Dalcin TS_Theta *th = (TS_Theta*)ts->data; 7177207e0fdSHong Zhang TS quadts = ts->quadraturets; 7181566a47fSLisandro Dalcin PetscErrorCode ierr; 7191566a47fSLisandro Dalcin 7201566a47fSLisandro Dalcin PetscFunctionBegin; 7211566a47fSLisandro Dalcin ierr = VecCopy(th->X0,ts->vec_sol);CHKERRQ(ierr); 722cd4cee2dSHong Zhang if (quadts && ts->costintegralfwd) { 723cd4cee2dSHong Zhang ierr = VecCopy(th->VecCostIntegral0,quadts->vec_sol);CHKERRQ(ierr); 7241566a47fSLisandro Dalcin } 725715f1b00SHong Zhang th->status = TS_STEP_INCOMPLETE; 72613b1b0ffSHong Zhang if (ts->mat_sensip) { 72713b1b0ffSHong Zhang ierr = MatCopy(th->MatFwdSensip0,ts->mat_sensip,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 7286f92202bSHong Zhang } 7297207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 7307207e0fdSHong Zhang ierr = MatCopy(th->MatIntegralSensip0,quadts->mat_sensip,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 7316f92202bSHong Zhang } 732715f1b00SHong Zhang PetscFunctionReturn(0); 733715f1b00SHong Zhang } 734715f1b00SHong Zhang 735715f1b00SHong Zhang static PetscErrorCode TSForwardStep_Theta(TS ts) 736715f1b00SHong Zhang { 737715f1b00SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 738cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 73913b1b0ffSHong Zhang Mat MatDeltaFwdSensip = th->MatDeltaFwdSensip; 740b5b4017aSHong Zhang Vec VecDeltaFwdSensipCol = th->VecDeltaFwdSensipCol; 7417207e0fdSHong Zhang PetscInt ntlm; 742715f1b00SHong Zhang KSP ksp; 7437207e0fdSHong Zhang Mat J,Jpre,quadJ = NULL,quadJp = NULL; 74413b1b0ffSHong Zhang PetscScalar *barr,*xarr; 7451a352fa8SHong Zhang PetscReal previous_shift; 746715f1b00SHong Zhang PetscErrorCode ierr; 747715f1b00SHong Zhang 748715f1b00SHong Zhang PetscFunctionBegin; 7491a352fa8SHong Zhang previous_shift = th->shift; 75013b1b0ffSHong Zhang ierr = MatCopy(ts->mat_sensip,th->MatFwdSensip0,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 75113b1b0ffSHong Zhang 7527207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 7537207e0fdSHong Zhang ierr = MatCopy(quadts->mat_sensip,th->MatIntegralSensip0,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 7546f92202bSHong Zhang } 755715f1b00SHong Zhang ierr = SNESGetKSP(ts->snes,&ksp);CHKERRQ(ierr); 756cd4cee2dSHong Zhang ierr = TSGetIJacobian(ts,&J,&Jpre,NULL,NULL);CHKERRQ(ierr); 7577207e0fdSHong Zhang if (quadts) { 758cd4cee2dSHong Zhang ierr = TSGetRHSJacobian(quadts,&quadJ,NULL,NULL,NULL);CHKERRQ(ierr); 759cd4cee2dSHong Zhang ierr = TSGetRHSJacobianP(quadts,&quadJp,NULL,NULL);CHKERRQ(ierr); 7607207e0fdSHong Zhang } 761715f1b00SHong Zhang 762715f1b00SHong Zhang /* Build RHS */ 763715f1b00SHong Zhang if (th->endpoint) { /* 2-stage method*/ 7641a352fa8SHong Zhang th->shift = 1./((th->Theta-1.)*th->time_step0); 7651a352fa8SHong Zhang ierr = TSComputeIJacobian(ts,th->ptime0,th->X0,th->Xdot,th->shift,J,Jpre,PETSC_FALSE);CHKERRQ(ierr); 76613b1b0ffSHong Zhang ierr = MatMatMult(J,ts->mat_sensip,MAT_REUSE_MATRIX,PETSC_DEFAULT,&MatDeltaFwdSensip);CHKERRQ(ierr); 76713b1b0ffSHong Zhang ierr = MatScale(MatDeltaFwdSensip,(th->Theta-1.)/th->Theta);CHKERRQ(ierr); 768715f1b00SHong Zhang 769022c081aSHong Zhang /* Add the f_p forcing terms */ 7700e11c21fSHong Zhang if (ts->Jacp) { 7711a352fa8SHong Zhang ierr = TSComputeIJacobianP(ts,th->ptime0,th->X0,th->Xdot,th->shift,ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 77233f72c5dSHong Zhang ierr = MatAXPY(MatDeltaFwdSensip,(th->Theta-1.)/th->Theta,ts->Jacp,SUBSET_NONZERO_PATTERN);CHKERRQ(ierr); 7733e05ceb1SHong Zhang ierr = TSComputeIJacobianP(ts,th->stage_time,ts->vec_sol,th->Xdot,th->shift,ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 77433f72c5dSHong Zhang ierr = MatAXPY(MatDeltaFwdSensip,-1.,ts->Jacp,SUBSET_NONZERO_PATTERN);CHKERRQ(ierr); 7750e11c21fSHong Zhang } 776715f1b00SHong Zhang } else { /* 1-stage method */ 7773e05ceb1SHong Zhang th->shift = 0.0; 7783e05ceb1SHong Zhang ierr = TSComputeIJacobian(ts,th->stage_time,th->X,th->Xdot,th->shift,J,Jpre,PETSC_FALSE);CHKERRQ(ierr); 77913b1b0ffSHong Zhang ierr = MatMatMult(J,ts->mat_sensip,MAT_REUSE_MATRIX,PETSC_DEFAULT,&MatDeltaFwdSensip);CHKERRQ(ierr); 78013b1b0ffSHong Zhang ierr = MatScale(MatDeltaFwdSensip,-1.);CHKERRQ(ierr); 78113b1b0ffSHong Zhang 782022c081aSHong Zhang /* Add the f_p forcing terms */ 7830e11c21fSHong Zhang if (ts->Jacp) { 7843e05ceb1SHong Zhang ierr = TSComputeIJacobianP(ts,th->stage_time,th->X,th->Xdot,th->shift,ts->Jacp,PETSC_FALSE);CHKERRQ(ierr); 78533f72c5dSHong Zhang ierr = MatAXPY(MatDeltaFwdSensip,-1.,ts->Jacp,SUBSET_NONZERO_PATTERN);CHKERRQ(ierr); 786715f1b00SHong Zhang } 7870e11c21fSHong Zhang } 788715f1b00SHong Zhang 789715f1b00SHong Zhang /* Build LHS */ 7901a352fa8SHong Zhang th->shift = previous_shift; /* recover the previous shift used in TSStep_Theta() */ 791715f1b00SHong Zhang if (th->endpoint) { 7923e05ceb1SHong Zhang ierr = TSComputeIJacobian(ts,th->stage_time,ts->vec_sol,th->Xdot,th->shift,J,Jpre,PETSC_FALSE);CHKERRQ(ierr); 793715f1b00SHong Zhang } else { 7943e05ceb1SHong Zhang ierr = TSComputeIJacobian(ts,th->stage_time,th->X,th->Xdot,th->shift,J,Jpre,PETSC_FALSE);CHKERRQ(ierr); 795715f1b00SHong Zhang } 796cd4cee2dSHong Zhang ierr = KSPSetOperators(ksp,J,Jpre);CHKERRQ(ierr); 797715f1b00SHong Zhang 798715f1b00SHong Zhang /* 799715f1b00SHong Zhang Evaluate the first stage of integral gradients with the 2-stage method: 800c9ad9de0SHong Zhang drdu|t_n*S(t_n) + drdp|t_n 801715f1b00SHong Zhang This is done before the linear solve because the sensitivity variable S(t_n) will be propagated to S(t_{n+1}) 802715f1b00SHong Zhang */ 803715f1b00SHong Zhang if (th->endpoint) { /* 2-stage method only */ 8047207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 8051a352fa8SHong Zhang ierr = TSComputeRHSJacobian(quadts,th->ptime0,th->X0,quadJ,NULL);CHKERRQ(ierr); 8061a352fa8SHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->ptime0,th->X0,quadJp);CHKERRQ(ierr); 8077207e0fdSHong Zhang ierr = MatTransposeMatMult(ts->mat_sensip,quadJ,MAT_REUSE_MATRIX,PETSC_DEFAULT,&th->MatIntegralSensipTemp);CHKERRQ(ierr); 8087207e0fdSHong Zhang ierr = MatAXPY(th->MatIntegralSensipTemp,1,quadJp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 8091a352fa8SHong Zhang ierr = MatAXPY(quadts->mat_sensip,th->time_step0*(1.-th->Theta),th->MatIntegralSensipTemp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 810715f1b00SHong Zhang } 811715f1b00SHong Zhang } 812715f1b00SHong Zhang 813715f1b00SHong Zhang /* Solve the tangent linear equation for forward sensitivities to parameters */ 814022c081aSHong Zhang for (ntlm=0; ntlm<th->num_tlm; ntlm++) { 815b5b4017aSHong Zhang KSPConvergedReason kspreason; 81613b1b0ffSHong Zhang ierr = MatDenseGetColumn(MatDeltaFwdSensip,ntlm,&barr);CHKERRQ(ierr); 817b5b4017aSHong Zhang ierr = VecPlaceArray(VecDeltaFwdSensipCol,barr);CHKERRQ(ierr); 818715f1b00SHong Zhang if (th->endpoint) { 81913b1b0ffSHong Zhang ierr = MatDenseGetColumn(ts->mat_sensip,ntlm,&xarr);CHKERRQ(ierr); 820b5b4017aSHong Zhang ierr = VecPlaceArray(ts->vec_sensip_col,xarr);CHKERRQ(ierr); 821b5b4017aSHong Zhang ierr = KSPSolve(ksp,VecDeltaFwdSensipCol,ts->vec_sensip_col);CHKERRQ(ierr); 822b5b4017aSHong Zhang ierr = VecResetArray(ts->vec_sensip_col);CHKERRQ(ierr); 82313b1b0ffSHong Zhang ierr = MatDenseRestoreColumn(ts->mat_sensip,&xarr);CHKERRQ(ierr); 824715f1b00SHong Zhang } else { 825b5b4017aSHong Zhang ierr = KSPSolve(ksp,VecDeltaFwdSensipCol,VecDeltaFwdSensipCol);CHKERRQ(ierr); 826715f1b00SHong Zhang } 827b5b4017aSHong Zhang ierr = KSPGetConvergedReason(ksp,&kspreason);CHKERRQ(ierr); 828b5b4017aSHong Zhang if (kspreason < 0) { 829b5b4017aSHong Zhang ts->reason = TSFORWARD_DIVERGED_LINEAR_SOLVE; 830b5b4017aSHong Zhang ierr = PetscInfo2(ts,"Step=%D, %Dth tangent linear solve, linear solve fails, stopping tangent linear solve\n",ts->steps,ntlm);CHKERRQ(ierr); 831b5b4017aSHong Zhang } 832b5b4017aSHong Zhang ierr = VecResetArray(VecDeltaFwdSensipCol);CHKERRQ(ierr); 83313b1b0ffSHong Zhang ierr = MatDenseRestoreColumn(MatDeltaFwdSensip,&barr);CHKERRQ(ierr); 834715f1b00SHong Zhang } 835715f1b00SHong Zhang 83613b1b0ffSHong Zhang /* 83713b1b0ffSHong Zhang Evaluate the second stage of integral gradients with the 2-stage method: 838c9ad9de0SHong Zhang drdu|t_{n+1}*S(t_{n+1}) + drdp|t_{n+1} 83913b1b0ffSHong Zhang */ 8407207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 84113b1b0ffSHong Zhang if (!th->endpoint) { 8427207e0fdSHong Zhang ierr = MatAXPY(ts->mat_sensip,1,MatDeltaFwdSensip,SAME_NONZERO_PATTERN);CHKERRQ(ierr); /* stage sensitivity */ 843cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,th->X,quadJ,NULL);CHKERRQ(ierr); 844cd4cee2dSHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->stage_time,th->X,quadJp);CHKERRQ(ierr); 8457207e0fdSHong Zhang ierr = MatTransposeMatMult(ts->mat_sensip,quadJ,MAT_REUSE_MATRIX,PETSC_DEFAULT,&th->MatIntegralSensipTemp);CHKERRQ(ierr); 8467207e0fdSHong Zhang ierr = MatAXPY(th->MatIntegralSensipTemp,1,quadJp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 8471a352fa8SHong Zhang ierr = MatAXPY(quadts->mat_sensip,th->time_step0,th->MatIntegralSensipTemp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 84813b1b0ffSHong Zhang ierr = MatAXPY(ts->mat_sensip,(1.-th->Theta)/th->Theta,MatDeltaFwdSensip,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 84913b1b0ffSHong Zhang } else { 850cd4cee2dSHong Zhang ierr = TSComputeRHSJacobian(quadts,th->stage_time,ts->vec_sol,quadJ,NULL);CHKERRQ(ierr); 851cd4cee2dSHong Zhang ierr = TSComputeRHSJacobianP(quadts,th->stage_time,ts->vec_sol,quadJp);CHKERRQ(ierr); 8527207e0fdSHong Zhang ierr = MatTransposeMatMult(ts->mat_sensip,quadJ,MAT_REUSE_MATRIX,PETSC_DEFAULT,&th->MatIntegralSensipTemp);CHKERRQ(ierr); 8537207e0fdSHong Zhang ierr = MatAXPY(th->MatIntegralSensipTemp,1,quadJp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 8541a352fa8SHong Zhang ierr = MatAXPY(quadts->mat_sensip,th->time_step0*th->Theta,th->MatIntegralSensipTemp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 85513b1b0ffSHong Zhang } 85613b1b0ffSHong Zhang } else { 85713b1b0ffSHong Zhang if (!th->endpoint) { 85813b1b0ffSHong Zhang ierr = MatAXPY(ts->mat_sensip,1./th->Theta,MatDeltaFwdSensip,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 859715f1b00SHong Zhang } 860715f1b00SHong Zhang } 8611566a47fSLisandro Dalcin PetscFunctionReturn(0); 8621566a47fSLisandro Dalcin } 8631566a47fSLisandro Dalcin 8646affb6f8SHong Zhang static PetscErrorCode TSForwardGetStages_Theta(TS ts,PetscInt *ns,Mat **stagesensip) 8656affb6f8SHong Zhang { 8666affb6f8SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 8676affb6f8SHong Zhang 8686affb6f8SHong Zhang PetscFunctionBegin; 8696affb6f8SHong Zhang if (ns) *ns = 1; 8706affb6f8SHong Zhang if (stagesensip) *stagesensip = th->endpoint ? &(th->MatFwdSensip0) : &(th->MatDeltaFwdSensip); 8716affb6f8SHong Zhang PetscFunctionReturn(0); 8726affb6f8SHong Zhang } 8736affb6f8SHong Zhang 874316643e7SJed Brown /*------------------------------------------------------------*/ 875277b19d0SLisandro Dalcin static PetscErrorCode TSReset_Theta(TS ts) 876316643e7SJed Brown { 877316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 878316643e7SJed Brown PetscErrorCode ierr; 879316643e7SJed Brown 880316643e7SJed Brown PetscFunctionBegin; 8816bf464f9SBarry Smith ierr = VecDestroy(&th->X);CHKERRQ(ierr); 8826bf464f9SBarry Smith ierr = VecDestroy(&th->Xdot);CHKERRQ(ierr); 8833b1890cdSShri Abhyankar ierr = VecDestroy(&th->X0);CHKERRQ(ierr); 884eb284becSJed Brown ierr = VecDestroy(&th->affine);CHKERRQ(ierr); 8851566a47fSLisandro Dalcin 8861566a47fSLisandro Dalcin ierr = VecDestroy(&th->vec_sol_prev);CHKERRQ(ierr); 8871566a47fSLisandro Dalcin ierr = VecDestroy(&th->vec_lte_work);CHKERRQ(ierr); 8881566a47fSLisandro Dalcin 889b1cb36f3SHong Zhang ierr = VecDestroy(&th->VecCostIntegral0);CHKERRQ(ierr); 890277b19d0SLisandro Dalcin PetscFunctionReturn(0); 891277b19d0SLisandro Dalcin } 892277b19d0SLisandro Dalcin 893ece46509SHong Zhang static PetscErrorCode TSAdjointReset_Theta(TS ts) 894ece46509SHong Zhang { 895ece46509SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 896ece46509SHong Zhang PetscErrorCode ierr; 897ece46509SHong Zhang 898ece46509SHong Zhang PetscFunctionBegin; 899ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsDeltaLam);CHKERRQ(ierr); 900ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsDeltaMu);CHKERRQ(ierr); 901ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsDeltaLam2);CHKERRQ(ierr); 902ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsDeltaMu2);CHKERRQ(ierr); 903ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsSensiTemp);CHKERRQ(ierr); 904ece46509SHong Zhang ierr = VecDestroyVecs(ts->numcost,&th->VecsSensi2Temp);CHKERRQ(ierr); 905ece46509SHong Zhang PetscFunctionReturn(0); 906ece46509SHong Zhang } 907ece46509SHong Zhang 908277b19d0SLisandro Dalcin static PetscErrorCode TSDestroy_Theta(TS ts) 909277b19d0SLisandro Dalcin { 910277b19d0SLisandro Dalcin PetscErrorCode ierr; 911277b19d0SLisandro Dalcin 912277b19d0SLisandro Dalcin PetscFunctionBegin; 913277b19d0SLisandro Dalcin ierr = TSReset_Theta(ts);CHKERRQ(ierr); 914b3a6b972SJed Brown if (ts->dm) { 915b3a6b972SJed Brown ierr = DMCoarsenHookRemove(ts->dm,DMCoarsenHook_TSTheta,DMRestrictHook_TSTheta,ts);CHKERRQ(ierr); 916b3a6b972SJed Brown ierr = DMSubDomainHookRemove(ts->dm,DMSubDomainHook_TSTheta,DMSubDomainRestrictHook_TSTheta,ts);CHKERRQ(ierr); 917b3a6b972SJed Brown } 918277b19d0SLisandro Dalcin ierr = PetscFree(ts->data);CHKERRQ(ierr); 919bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaGetTheta_C",NULL);CHKERRQ(ierr); 920bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaSetTheta_C",NULL);CHKERRQ(ierr); 921bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaGetEndpoint_C",NULL);CHKERRQ(ierr); 922bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaSetEndpoint_C",NULL);CHKERRQ(ierr); 923316643e7SJed Brown PetscFunctionReturn(0); 924316643e7SJed Brown } 925316643e7SJed Brown 926316643e7SJed Brown /* 927316643e7SJed Brown This defines the nonlinear equation that is to be solved with SNES 9282b5a38e1SLisandro Dalcin G(U) = F[t0+Theta*dt, U, (U-U0)*shift] = 0 929316643e7SJed Brown */ 9300f5c6efeSJed Brown static PetscErrorCode SNESTSFormFunction_Theta(SNES snes,Vec x,Vec y,TS ts) 931316643e7SJed Brown { 932316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 933316643e7SJed Brown PetscErrorCode ierr; 9347445fe48SJed Brown Vec X0,Xdot; 9357445fe48SJed Brown DM dm,dmsave; 9363e05ceb1SHong Zhang PetscReal shift = th->shift; 937316643e7SJed Brown 938316643e7SJed Brown PetscFunctionBegin; 9397445fe48SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 9405a3a76d0SJed Brown /* When using the endpoint variant, this is actually 1/Theta * Xdot */ 9417445fe48SJed Brown ierr = TSThetaGetX0AndXdot(ts,dm,&X0,&Xdot);CHKERRQ(ierr); 942494ce9fcSHong Zhang if (x != X0) { 943b296d7d5SJed Brown ierr = VecAXPBYPCZ(Xdot,-shift,shift,0,X0,x);CHKERRQ(ierr); 944494ce9fcSHong Zhang } else { 945494ce9fcSHong Zhang ierr = VecZeroEntries(Xdot);CHKERRQ(ierr); 946494ce9fcSHong Zhang } 9477445fe48SJed Brown /* DM monkey-business allows user code to call TSGetDM() inside of functions evaluated on levels of FAS */ 9487445fe48SJed Brown dmsave = ts->dm; 9497445fe48SJed Brown ts->dm = dm; 9507445fe48SJed Brown ierr = TSComputeIFunction(ts,th->stage_time,x,Xdot,y,PETSC_FALSE);CHKERRQ(ierr); 9517445fe48SJed Brown ts->dm = dmsave; 9520d0b770aSPeter Brune ierr = TSThetaRestoreX0AndXdot(ts,dm,&X0,&Xdot);CHKERRQ(ierr); 953316643e7SJed Brown PetscFunctionReturn(0); 954316643e7SJed Brown } 955316643e7SJed Brown 956d1e9a80fSBarry Smith static PetscErrorCode SNESTSFormJacobian_Theta(SNES snes,Vec x,Mat A,Mat B,TS ts) 957316643e7SJed Brown { 958316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 959316643e7SJed Brown PetscErrorCode ierr; 9607445fe48SJed Brown Vec Xdot; 9617445fe48SJed Brown DM dm,dmsave; 9623e05ceb1SHong Zhang PetscReal shift = th->shift; 963316643e7SJed Brown 964316643e7SJed Brown PetscFunctionBegin; 9657445fe48SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 966be5899b3SLisandro Dalcin /* Xdot has already been computed in SNESTSFormFunction_Theta (SNES guarantees this) */ 9670298fd71SBarry Smith ierr = TSThetaGetX0AndXdot(ts,dm,NULL,&Xdot);CHKERRQ(ierr); 9687445fe48SJed Brown 9697445fe48SJed Brown dmsave = ts->dm; 9707445fe48SJed Brown ts->dm = dm; 971d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,th->stage_time,x,Xdot,shift,A,B,PETSC_FALSE);CHKERRQ(ierr); 9727445fe48SJed Brown ts->dm = dmsave; 9730298fd71SBarry Smith ierr = TSThetaRestoreX0AndXdot(ts,dm,NULL,&Xdot);CHKERRQ(ierr); 974316643e7SJed Brown PetscFunctionReturn(0); 975316643e7SJed Brown } 976316643e7SJed Brown 977715f1b00SHong Zhang static PetscErrorCode TSForwardSetUp_Theta(TS ts) 978715f1b00SHong Zhang { 979715f1b00SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 9807207e0fdSHong Zhang TS quadts = ts->quadraturets; 981715f1b00SHong Zhang PetscErrorCode ierr; 982715f1b00SHong Zhang 983715f1b00SHong Zhang PetscFunctionBegin; 984022c081aSHong Zhang /* combine sensitivities to parameters and sensitivities to initial values into one array */ 98513b1b0ffSHong Zhang th->num_tlm = ts->num_parameters; 98613b1b0ffSHong Zhang ierr = MatDuplicate(ts->mat_sensip,MAT_DO_NOT_COPY_VALUES,&th->MatDeltaFwdSensip);CHKERRQ(ierr); 9877207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 9887207e0fdSHong Zhang ierr = MatDuplicate(quadts->mat_sensip,MAT_DO_NOT_COPY_VALUES,&th->MatIntegralSensipTemp);CHKERRQ(ierr); 9897207e0fdSHong Zhang ierr = MatDuplicate(quadts->mat_sensip,MAT_DO_NOT_COPY_VALUES,&th->MatIntegralSensip0);CHKERRQ(ierr); 990715f1b00SHong Zhang } 9916f92202bSHong Zhang /* backup sensitivity results for roll-backs */ 99213b1b0ffSHong Zhang ierr = MatDuplicate(ts->mat_sensip,MAT_DO_NOT_COPY_VALUES,&th->MatFwdSensip0);CHKERRQ(ierr); 99313b1b0ffSHong Zhang 994b5b4017aSHong Zhang ierr = VecDuplicate(ts->vec_sol,&th->VecDeltaFwdSensipCol);CHKERRQ(ierr); 995715f1b00SHong Zhang PetscFunctionReturn(0); 996715f1b00SHong Zhang } 997715f1b00SHong Zhang 9987adebddeSHong Zhang static PetscErrorCode TSForwardReset_Theta(TS ts) 9997adebddeSHong Zhang { 10007adebddeSHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 10017207e0fdSHong Zhang TS quadts = ts->quadraturets; 10027adebddeSHong Zhang PetscErrorCode ierr; 10037adebddeSHong Zhang 10047adebddeSHong Zhang PetscFunctionBegin; 10057207e0fdSHong Zhang if (quadts && quadts->mat_sensip) { 10067207e0fdSHong Zhang ierr = MatDestroy(&th->MatIntegralSensipTemp);CHKERRQ(ierr); 10077207e0fdSHong Zhang ierr = MatDestroy(&th->MatIntegralSensip0);CHKERRQ(ierr); 10087adebddeSHong Zhang } 10097adebddeSHong Zhang ierr = VecDestroy(&th->VecDeltaFwdSensipCol);CHKERRQ(ierr); 10107adebddeSHong Zhang ierr = MatDestroy(&th->MatDeltaFwdSensip);CHKERRQ(ierr); 10117adebddeSHong Zhang ierr = MatDestroy(&th->MatFwdSensip0);CHKERRQ(ierr); 10127adebddeSHong Zhang PetscFunctionReturn(0); 10137adebddeSHong Zhang } 10147adebddeSHong Zhang 1015316643e7SJed Brown static PetscErrorCode TSSetUp_Theta(TS ts) 1016316643e7SJed Brown { 1017316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 1018cd4cee2dSHong Zhang TS quadts = ts->quadraturets; 10192ffb9264SLisandro Dalcin PetscBool match; 1020316643e7SJed Brown PetscErrorCode ierr; 1021316643e7SJed Brown 1022316643e7SJed Brown PetscFunctionBegin; 1023cd4cee2dSHong Zhang if (!th->VecCostIntegral0 && quadts && ts->costintegralfwd) { /* back up cost integral */ 1024cd4cee2dSHong Zhang ierr = VecDuplicate(quadts->vec_sol,&th->VecCostIntegral0);CHKERRQ(ierr); 1025b1cb36f3SHong Zhang } 102639d13666SHong Zhang if (!th->X) { 1027316643e7SJed Brown ierr = VecDuplicate(ts->vec_sol,&th->X);CHKERRQ(ierr); 102839d13666SHong Zhang } 102939d13666SHong Zhang if (!th->Xdot) { 1030316643e7SJed Brown ierr = VecDuplicate(ts->vec_sol,&th->Xdot);CHKERRQ(ierr); 103139d13666SHong Zhang } 103239d13666SHong Zhang if (!th->X0) { 10333b1890cdSShri Abhyankar ierr = VecDuplicate(ts->vec_sol,&th->X0);CHKERRQ(ierr); 103439d13666SHong Zhang } 10351566a47fSLisandro Dalcin if (th->endpoint) { 10361566a47fSLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&th->affine);CHKERRQ(ierr); 10377445fe48SJed Brown } 10383b1890cdSShri Abhyankar 10391566a47fSLisandro Dalcin th->order = (th->Theta == 0.5) ? 2 : 1; 104020d49056SMatthew G. Knepley th->shift = 1/(th->Theta*ts->time_step); 10411566a47fSLisandro Dalcin 10421566a47fSLisandro Dalcin ierr = TSGetDM(ts,&ts->dm);CHKERRQ(ierr); 10431566a47fSLisandro Dalcin ierr = DMCoarsenHookAdd(ts->dm,DMCoarsenHook_TSTheta,DMRestrictHook_TSTheta,ts);CHKERRQ(ierr); 10441566a47fSLisandro Dalcin ierr = DMSubDomainHookAdd(ts->dm,DMSubDomainHook_TSTheta,DMSubDomainRestrictHook_TSTheta,ts);CHKERRQ(ierr); 10451566a47fSLisandro Dalcin 10461566a47fSLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 10471566a47fSLisandro Dalcin ierr = TSAdaptCandidatesClear(ts->adapt);CHKERRQ(ierr); 10482ffb9264SLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&match);CHKERRQ(ierr); 10492ffb9264SLisandro Dalcin if (!match) { 10501566a47fSLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&th->vec_sol_prev);CHKERRQ(ierr); 10511566a47fSLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&th->vec_lte_work);CHKERRQ(ierr); 10523b1890cdSShri Abhyankar } 10531566a47fSLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 1054b4dd3bf9SBarry Smith PetscFunctionReturn(0); 1055b4dd3bf9SBarry Smith } 10560c7376e5SHong Zhang 1057b4dd3bf9SBarry Smith /*------------------------------------------------------------*/ 1058b4dd3bf9SBarry Smith 1059b4dd3bf9SBarry Smith static PetscErrorCode TSAdjointSetUp_Theta(TS ts) 1060b4dd3bf9SBarry Smith { 1061b4dd3bf9SBarry Smith TS_Theta *th = (TS_Theta*)ts->data; 1062b4dd3bf9SBarry Smith PetscErrorCode ierr; 1063b4dd3bf9SBarry Smith 1064b4dd3bf9SBarry Smith PetscFunctionBegin; 1065b5e0532dSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&th->VecsDeltaLam);CHKERRQ(ierr); 1066b5b4017aSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&th->VecsSensiTemp);CHKERRQ(ierr); 10672ca6e920SHong Zhang if (ts->vecs_sensip) { 1068b5e0532dSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&th->VecsDeltaMu);CHKERRQ(ierr); 10692ca6e920SHong Zhang } 1070b5b4017aSHong Zhang if (ts->vecs_sensi2) { 1071b5b4017aSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&th->VecsDeltaLam2);CHKERRQ(ierr); 1072b5b4017aSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensi2[0],ts->numcost,&th->VecsSensi2Temp);CHKERRQ(ierr); 107367633408SHong Zhang /* hack ts to make implicit TS solver work when users provide only explicit versions of callbacks (RHSFunction,RHSJacobian,RHSHessian etc.) */ 107467633408SHong Zhang if (!ts->ihessianproduct_fuu) ts->vecs_fuu = ts->vecs_guu; 107567633408SHong Zhang if (!ts->ihessianproduct_fup) ts->vecs_fup = ts->vecs_gup; 1076b5b4017aSHong Zhang } 1077c9681e5dSHong Zhang if (ts->vecs_sensi2p) { 1078c9681e5dSHong Zhang ierr = VecDuplicateVecs(ts->vecs_sensi2p[0],ts->numcost,&th->VecsDeltaMu2);CHKERRQ(ierr); 107967633408SHong Zhang /* hack ts to make implicit TS solver work when users provide only explicit versions of callbacks (RHSFunction,RHSJacobian,RHSHessian etc.) */ 108067633408SHong Zhang if (!ts->ihessianproduct_fpu) ts->vecs_fpu = ts->vecs_gpu; 108167633408SHong Zhang if (!ts->ihessianproduct_fpp) ts->vecs_fpp = ts->vecs_gpp; 1082b5b4017aSHong Zhang } 1083316643e7SJed Brown PetscFunctionReturn(0); 1084316643e7SJed Brown } 1085316643e7SJed Brown 10864416b707SBarry Smith static PetscErrorCode TSSetFromOptions_Theta(PetscOptionItems *PetscOptionsObject,TS ts) 1087316643e7SJed Brown { 1088316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 1089316643e7SJed Brown PetscErrorCode ierr; 1090316643e7SJed Brown 1091316643e7SJed Brown PetscFunctionBegin; 1092e55864a3SBarry Smith ierr = PetscOptionsHead(PetscOptionsObject,"Theta ODE solver options");CHKERRQ(ierr); 1093316643e7SJed Brown { 10940298fd71SBarry Smith ierr = PetscOptionsReal("-ts_theta_theta","Location of stage (0<Theta<=1)","TSThetaSetTheta",th->Theta,&th->Theta,NULL);CHKERRQ(ierr); 10950298fd71SBarry Smith ierr = PetscOptionsBool("-ts_theta_endpoint","Use the endpoint instead of midpoint form of the Theta method","TSThetaSetEndpoint",th->endpoint,&th->endpoint,NULL);CHKERRQ(ierr); 109603842d09SLisandro Dalcin ierr = PetscOptionsBool("-ts_theta_initial_guess_extrapolate","Extrapolate stage initial guess from previous solution (sometimes unstable)","TSThetaSetExtrapolate",th->extrapolate,&th->extrapolate,NULL);CHKERRQ(ierr); 1097316643e7SJed Brown } 1098316643e7SJed Brown ierr = PetscOptionsTail();CHKERRQ(ierr); 1099316643e7SJed Brown PetscFunctionReturn(0); 1100316643e7SJed Brown } 1101316643e7SJed Brown 1102316643e7SJed Brown static PetscErrorCode TSView_Theta(TS ts,PetscViewer viewer) 1103316643e7SJed Brown { 1104316643e7SJed Brown TS_Theta *th = (TS_Theta*)ts->data; 1105ace3abfcSBarry Smith PetscBool iascii; 1106316643e7SJed Brown PetscErrorCode ierr; 1107316643e7SJed Brown 1108316643e7SJed Brown PetscFunctionBegin; 1109251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1110316643e7SJed Brown if (iascii) { 11117c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Theta=%g\n",(double)th->Theta);CHKERRQ(ierr); 1112ace68cafSJed Brown ierr = PetscViewerASCIIPrintf(viewer," Extrapolation=%s\n",th->extrapolate ? "yes" : "no");CHKERRQ(ierr); 1113316643e7SJed Brown } 1114316643e7SJed Brown PetscFunctionReturn(0); 1115316643e7SJed Brown } 1116316643e7SJed Brown 1117560360afSLisandro Dalcin static PetscErrorCode TSThetaGetTheta_Theta(TS ts,PetscReal *theta) 11180de4c49aSJed Brown { 11190de4c49aSJed Brown TS_Theta *th = (TS_Theta*)ts->data; 11200de4c49aSJed Brown 11210de4c49aSJed Brown PetscFunctionBegin; 11220de4c49aSJed Brown *theta = th->Theta; 11230de4c49aSJed Brown PetscFunctionReturn(0); 11240de4c49aSJed Brown } 11250de4c49aSJed Brown 1126560360afSLisandro Dalcin static PetscErrorCode TSThetaSetTheta_Theta(TS ts,PetscReal theta) 11270de4c49aSJed Brown { 11280de4c49aSJed Brown TS_Theta *th = (TS_Theta*)ts->data; 11290de4c49aSJed Brown 11300de4c49aSJed Brown PetscFunctionBegin; 11317c8652ddSBarry Smith if (theta <= 0 || 1 < theta) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Theta %g not in range (0,1]",(double)theta); 11320de4c49aSJed Brown th->Theta = theta; 11331566a47fSLisandro Dalcin th->order = (th->Theta == 0.5) ? 2 : 1; 11340de4c49aSJed Brown PetscFunctionReturn(0); 11350de4c49aSJed Brown } 1136eb284becSJed Brown 1137560360afSLisandro Dalcin static PetscErrorCode TSThetaGetEndpoint_Theta(TS ts,PetscBool *endpoint) 113826f2ff8fSLisandro Dalcin { 113926f2ff8fSLisandro Dalcin TS_Theta *th = (TS_Theta*)ts->data; 114026f2ff8fSLisandro Dalcin 114126f2ff8fSLisandro Dalcin PetscFunctionBegin; 114226f2ff8fSLisandro Dalcin *endpoint = th->endpoint; 114326f2ff8fSLisandro Dalcin PetscFunctionReturn(0); 114426f2ff8fSLisandro Dalcin } 114526f2ff8fSLisandro Dalcin 1146560360afSLisandro Dalcin static PetscErrorCode TSThetaSetEndpoint_Theta(TS ts,PetscBool flg) 1147eb284becSJed Brown { 1148eb284becSJed Brown TS_Theta *th = (TS_Theta*)ts->data; 1149eb284becSJed Brown 1150eb284becSJed Brown PetscFunctionBegin; 1151eb284becSJed Brown th->endpoint = flg; 1152eb284becSJed Brown PetscFunctionReturn(0); 1153eb284becSJed Brown } 11540de4c49aSJed Brown 1155f9c1d6abSBarry Smith #if defined(PETSC_HAVE_COMPLEX) 1156f9c1d6abSBarry Smith static PetscErrorCode TSComputeLinearStability_Theta(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 1157f9c1d6abSBarry Smith { 1158f9c1d6abSBarry Smith PetscComplex z = xr + xi*PETSC_i,f; 1159f9c1d6abSBarry Smith TS_Theta *th = (TS_Theta*)ts->data; 11603fd8ae06SJed Brown const PetscReal one = 1.0; 1161f9c1d6abSBarry Smith 1162f9c1d6abSBarry Smith PetscFunctionBegin; 11633fd8ae06SJed Brown f = (one + (one - th->Theta)*z)/(one - th->Theta*z); 1164f9c1d6abSBarry Smith *yr = PetscRealPartComplex(f); 1165f9c1d6abSBarry Smith *yi = PetscImaginaryPartComplex(f); 1166f9c1d6abSBarry Smith PetscFunctionReturn(0); 1167f9c1d6abSBarry Smith } 1168f9c1d6abSBarry Smith #endif 1169f9c1d6abSBarry Smith 117042682096SHong Zhang static PetscErrorCode TSGetStages_Theta(TS ts,PetscInt *ns,Vec **Y) 117142682096SHong Zhang { 117242682096SHong Zhang TS_Theta *th = (TS_Theta*)ts->data; 117342682096SHong Zhang 117442682096SHong Zhang PetscFunctionBegin; 11751566a47fSLisandro Dalcin if (ns) *ns = 1; 11761566a47fSLisandro Dalcin if (Y) *Y = th->endpoint ? &(th->X0) : &(th->X); 117742682096SHong Zhang PetscFunctionReturn(0); 117842682096SHong Zhang } 1179f9c1d6abSBarry Smith 1180316643e7SJed Brown /* ------------------------------------------------------------ */ 1181316643e7SJed Brown /*MC 118296f5712cSJed Brown TSTHETA - DAE solver using the implicit Theta method 1183316643e7SJed Brown 1184316643e7SJed Brown Level: beginner 1185316643e7SJed Brown 11864eb428fdSBarry Smith Options Database: 1187c82ed962SBarry Smith + -ts_theta_theta <Theta> - Location of stage (0<Theta<=1) 1188c82ed962SBarry Smith . -ts_theta_endpoint <flag> - Use the endpoint (like Crank-Nicholson) instead of midpoint form of the Theta method 118903842d09SLisandro Dalcin - -ts_theta_initial_guess_extrapolate <flg> - Extrapolate stage initial guess from previous solution (sometimes unstable) 11904eb428fdSBarry Smith 1191eb284becSJed Brown Notes: 11920c3ba866SJed Brown $ -ts_type theta -ts_theta_theta 1.0 corresponds to backward Euler (TSBEULER) 11930c3ba866SJed Brown $ -ts_type theta -ts_theta_theta 0.5 corresponds to the implicit midpoint rule 11944eb428fdSBarry Smith $ -ts_type theta -ts_theta_theta 0.5 -ts_theta_endpoint corresponds to Crank-Nicholson (TSCN) 11954eb428fdSBarry Smith 1196eb284becSJed Brown This method can be applied to DAE. 1197eb284becSJed Brown 1198eb284becSJed Brown This method is cast as a 1-stage implicit Runge-Kutta method. 1199eb284becSJed Brown 1200eb284becSJed Brown .vb 1201eb284becSJed Brown Theta | Theta 1202eb284becSJed Brown ------------- 1203eb284becSJed Brown | 1 1204eb284becSJed Brown .ve 1205eb284becSJed Brown 1206eb284becSJed Brown For the default Theta=0.5, this is also known as the implicit midpoint rule. 1207eb284becSJed Brown 1208eb284becSJed Brown When the endpoint variant is chosen, the method becomes a 2-stage method with first stage explicit: 1209eb284becSJed Brown 1210eb284becSJed Brown .vb 1211eb284becSJed Brown 0 | 0 0 1212eb284becSJed Brown 1 | 1-Theta Theta 1213eb284becSJed Brown ------------------- 1214eb284becSJed Brown | 1-Theta Theta 1215eb284becSJed Brown .ve 1216eb284becSJed Brown 1217eb284becSJed Brown For the default Theta=0.5, this is the trapezoid rule (also known as Crank-Nicolson, see TSCN). 1218eb284becSJed Brown 1219eb284becSJed Brown To apply a diagonally implicit RK method to DAE, the stage formula 1220eb284becSJed Brown 1221eb284becSJed Brown $ Y_i = X + h sum_j a_ij Y'_j 1222eb284becSJed Brown 12234eb428fdSBarry Smith is interpreted as a formula for Y'_i in terms of Y_i and known values (Y'_j, j<i) 1224eb284becSJed Brown 1225eb284becSJed Brown .seealso: TSCreate(), TS, TSSetType(), TSCN, TSBEULER, TSThetaSetTheta(), TSThetaSetEndpoint() 1226316643e7SJed Brown 1227316643e7SJed Brown M*/ 12288cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_Theta(TS ts) 1229316643e7SJed Brown { 1230316643e7SJed Brown TS_Theta *th; 1231316643e7SJed Brown PetscErrorCode ierr; 1232316643e7SJed Brown 1233316643e7SJed Brown PetscFunctionBegin; 1234277b19d0SLisandro Dalcin ts->ops->reset = TSReset_Theta; 1235ece46509SHong Zhang ts->ops->adjointreset = TSAdjointReset_Theta; 1236316643e7SJed Brown ts->ops->destroy = TSDestroy_Theta; 1237316643e7SJed Brown ts->ops->view = TSView_Theta; 1238316643e7SJed Brown ts->ops->setup = TSSetUp_Theta; 123942f2b339SBarry Smith ts->ops->adjointsetup = TSAdjointSetUp_Theta; 1240ece46509SHong Zhang ts->ops->adjointreset = TSAdjointReset_Theta; 1241316643e7SJed Brown ts->ops->step = TSStep_Theta; 1242cd652676SJed Brown ts->ops->interpolate = TSInterpolate_Theta; 12431566a47fSLisandro Dalcin ts->ops->evaluatewlte = TSEvaluateWLTE_Theta; 124424655328SShri ts->ops->rollback = TSRollBack_Theta; 1245316643e7SJed Brown ts->ops->setfromoptions = TSSetFromOptions_Theta; 12460f5c6efeSJed Brown ts->ops->snesfunction = SNESTSFormFunction_Theta; 12470f5c6efeSJed Brown ts->ops->snesjacobian = SNESTSFormJacobian_Theta; 1248f9c1d6abSBarry Smith #if defined(PETSC_HAVE_COMPLEX) 1249f9c1d6abSBarry Smith ts->ops->linearstability = TSComputeLinearStability_Theta; 1250f9c1d6abSBarry Smith #endif 125142682096SHong Zhang ts->ops->getstages = TSGetStages_Theta; 125242f2b339SBarry Smith ts->ops->adjointstep = TSAdjointStep_Theta; 1253b1cb36f3SHong Zhang ts->ops->adjointintegral = TSAdjointCostIntegral_Theta; 1254b1cb36f3SHong Zhang ts->ops->forwardintegral = TSForwardCostIntegral_Theta; 12552ffb9264SLisandro Dalcin ts->default_adapt_type = TSADAPTNONE; 12566affb6f8SHong Zhang 1257715f1b00SHong Zhang ts->ops->forwardsetup = TSForwardSetUp_Theta; 12587adebddeSHong Zhang ts->ops->forwardreset = TSForwardReset_Theta; 1259715f1b00SHong Zhang ts->ops->forwardstep = TSForwardStep_Theta; 12606affb6f8SHong Zhang ts->ops->forwardgetstages = TSForwardGetStages_Theta; 1261316643e7SJed Brown 1262efd4aadfSBarry Smith ts->usessnes = PETSC_TRUE; 1263efd4aadfSBarry Smith 1264b00a9115SJed Brown ierr = PetscNewLog(ts,&th);CHKERRQ(ierr); 1265316643e7SJed Brown ts->data = (void*)th; 1266316643e7SJed Brown 1267715f1b00SHong Zhang th->VecsDeltaLam = NULL; 1268715f1b00SHong Zhang th->VecsDeltaMu = NULL; 1269715f1b00SHong Zhang th->VecsSensiTemp = NULL; 1270b5b4017aSHong Zhang th->VecsSensi2Temp = NULL; 1271715f1b00SHong Zhang 12726f700aefSJed Brown th->extrapolate = PETSC_FALSE; 1273316643e7SJed Brown th->Theta = 0.5; 12741566a47fSLisandro Dalcin th->order = 2; 1275bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaGetTheta_C",TSThetaGetTheta_Theta);CHKERRQ(ierr); 1276bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaSetTheta_C",TSThetaSetTheta_Theta);CHKERRQ(ierr); 1277bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaGetEndpoint_C",TSThetaGetEndpoint_Theta);CHKERRQ(ierr); 1278bdf89e91SBarry Smith ierr = PetscObjectComposeFunction((PetscObject)ts,"TSThetaSetEndpoint_C",TSThetaSetEndpoint_Theta);CHKERRQ(ierr); 1279316643e7SJed Brown PetscFunctionReturn(0); 1280316643e7SJed Brown } 12810de4c49aSJed Brown 12820de4c49aSJed Brown /*@ 12830de4c49aSJed Brown TSThetaGetTheta - Get the abscissa of the stage in (0,1]. 12840de4c49aSJed Brown 12850de4c49aSJed Brown Not Collective 12860de4c49aSJed Brown 12870de4c49aSJed Brown Input Parameter: 12880de4c49aSJed Brown . ts - timestepping context 12890de4c49aSJed Brown 12900de4c49aSJed Brown Output Parameter: 12910de4c49aSJed Brown . theta - stage abscissa 12920de4c49aSJed Brown 12930de4c49aSJed Brown Note: 12940de4c49aSJed Brown Use of this function is normally only required to hack TSTHETA to use a modified integration scheme. 12950de4c49aSJed Brown 12960de4c49aSJed Brown Level: Advanced 12970de4c49aSJed Brown 12980de4c49aSJed Brown .seealso: TSThetaSetTheta() 12990de4c49aSJed Brown @*/ 13007087cfbeSBarry Smith PetscErrorCode TSThetaGetTheta(TS ts,PetscReal *theta) 13010de4c49aSJed Brown { 13024ac538c5SBarry Smith PetscErrorCode ierr; 13030de4c49aSJed Brown 13040de4c49aSJed Brown PetscFunctionBegin; 1305afb20b64SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13060de4c49aSJed Brown PetscValidPointer(theta,2); 13074ac538c5SBarry Smith ierr = PetscUseMethod(ts,"TSThetaGetTheta_C",(TS,PetscReal*),(ts,theta));CHKERRQ(ierr); 13080de4c49aSJed Brown PetscFunctionReturn(0); 13090de4c49aSJed Brown } 13100de4c49aSJed Brown 13110de4c49aSJed Brown /*@ 13120de4c49aSJed Brown TSThetaSetTheta - Set the abscissa of the stage in (0,1]. 13130de4c49aSJed Brown 13140de4c49aSJed Brown Not Collective 13150de4c49aSJed Brown 13160de4c49aSJed Brown Input Parameter: 13170de4c49aSJed Brown + ts - timestepping context 13180de4c49aSJed Brown - theta - stage abscissa 13190de4c49aSJed Brown 13200de4c49aSJed Brown Options Database: 13210de4c49aSJed Brown . -ts_theta_theta <theta> 13220de4c49aSJed Brown 13230de4c49aSJed Brown Level: Intermediate 13240de4c49aSJed Brown 13250de4c49aSJed Brown .seealso: TSThetaGetTheta() 13260de4c49aSJed Brown @*/ 13277087cfbeSBarry Smith PetscErrorCode TSThetaSetTheta(TS ts,PetscReal theta) 13280de4c49aSJed Brown { 13294ac538c5SBarry Smith PetscErrorCode ierr; 13300de4c49aSJed Brown 13310de4c49aSJed Brown PetscFunctionBegin; 1332afb20b64SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13334ac538c5SBarry Smith ierr = PetscTryMethod(ts,"TSThetaSetTheta_C",(TS,PetscReal),(ts,theta));CHKERRQ(ierr); 13340de4c49aSJed Brown PetscFunctionReturn(0); 13350de4c49aSJed Brown } 1336f33bbcb6SJed Brown 133726f2ff8fSLisandro Dalcin /*@ 133826f2ff8fSLisandro Dalcin TSThetaGetEndpoint - Gets whether to use the endpoint variant of the method (e.g. trapezoid/Crank-Nicolson instead of midpoint rule). 133926f2ff8fSLisandro Dalcin 134026f2ff8fSLisandro Dalcin Not Collective 134126f2ff8fSLisandro Dalcin 134226f2ff8fSLisandro Dalcin Input Parameter: 134326f2ff8fSLisandro Dalcin . ts - timestepping context 134426f2ff8fSLisandro Dalcin 134526f2ff8fSLisandro Dalcin Output Parameter: 134626f2ff8fSLisandro Dalcin . endpoint - PETSC_TRUE when using the endpoint variant 134726f2ff8fSLisandro Dalcin 134826f2ff8fSLisandro Dalcin Level: Advanced 134926f2ff8fSLisandro Dalcin 135026f2ff8fSLisandro Dalcin .seealso: TSThetaSetEndpoint(), TSTHETA, TSCN 135126f2ff8fSLisandro Dalcin @*/ 135226f2ff8fSLisandro Dalcin PetscErrorCode TSThetaGetEndpoint(TS ts,PetscBool *endpoint) 135326f2ff8fSLisandro Dalcin { 135426f2ff8fSLisandro Dalcin PetscErrorCode ierr; 135526f2ff8fSLisandro Dalcin 135626f2ff8fSLisandro Dalcin PetscFunctionBegin; 135726f2ff8fSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 135826f2ff8fSLisandro Dalcin PetscValidPointer(endpoint,2); 1359163d334eSBarry Smith ierr = PetscUseMethod(ts,"TSThetaGetEndpoint_C",(TS,PetscBool*),(ts,endpoint));CHKERRQ(ierr); 136026f2ff8fSLisandro Dalcin PetscFunctionReturn(0); 136126f2ff8fSLisandro Dalcin } 136226f2ff8fSLisandro Dalcin 1363eb284becSJed Brown /*@ 1364eb284becSJed Brown TSThetaSetEndpoint - Sets whether to use the endpoint variant of the method (e.g. trapezoid/Crank-Nicolson instead of midpoint rule). 1365eb284becSJed Brown 1366eb284becSJed Brown Not Collective 1367eb284becSJed Brown 1368eb284becSJed Brown Input Parameter: 1369eb284becSJed Brown + ts - timestepping context 1370eb284becSJed Brown - flg - PETSC_TRUE to use the endpoint variant 1371eb284becSJed Brown 1372eb284becSJed Brown Options Database: 1373eb284becSJed Brown . -ts_theta_endpoint <flg> 1374eb284becSJed Brown 1375eb284becSJed Brown Level: Intermediate 1376eb284becSJed Brown 1377eb284becSJed Brown .seealso: TSTHETA, TSCN 1378eb284becSJed Brown @*/ 1379eb284becSJed Brown PetscErrorCode TSThetaSetEndpoint(TS ts,PetscBool flg) 1380eb284becSJed Brown { 1381eb284becSJed Brown PetscErrorCode ierr; 1382eb284becSJed Brown 1383eb284becSJed Brown PetscFunctionBegin; 1384eb284becSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1385eb284becSJed Brown ierr = PetscTryMethod(ts,"TSThetaSetEndpoint_C",(TS,PetscBool),(ts,flg));CHKERRQ(ierr); 1386eb284becSJed Brown PetscFunctionReturn(0); 1387eb284becSJed Brown } 1388eb284becSJed Brown 1389f33bbcb6SJed Brown /* 1390f33bbcb6SJed Brown * TSBEULER and TSCN are straightforward specializations of TSTHETA. 1391f33bbcb6SJed Brown * The creation functions for these specializations are below. 1392f33bbcb6SJed Brown */ 1393f33bbcb6SJed Brown 13941566a47fSLisandro Dalcin static PetscErrorCode TSSetUp_BEuler(TS ts) 13951566a47fSLisandro Dalcin { 13961566a47fSLisandro Dalcin TS_Theta *th = (TS_Theta*)ts->data; 13971566a47fSLisandro Dalcin PetscErrorCode ierr; 13981566a47fSLisandro Dalcin 13991566a47fSLisandro Dalcin PetscFunctionBegin; 14001566a47fSLisandro Dalcin if (th->Theta != 1.0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_OPT_OVERWRITE,"Can not change the default value (1) of theta when using backward Euler\n"); 14011566a47fSLisandro Dalcin if (th->endpoint) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_OPT_OVERWRITE,"Can not change to the endpoint form of the Theta methods when using backward Euler\n"); 14021566a47fSLisandro Dalcin ierr = TSSetUp_Theta(ts);CHKERRQ(ierr); 14031566a47fSLisandro Dalcin PetscFunctionReturn(0); 14041566a47fSLisandro Dalcin } 14051566a47fSLisandro Dalcin 1406f33bbcb6SJed Brown static PetscErrorCode TSView_BEuler(TS ts,PetscViewer viewer) 1407f33bbcb6SJed Brown { 1408f33bbcb6SJed Brown PetscFunctionBegin; 1409f33bbcb6SJed Brown PetscFunctionReturn(0); 1410f33bbcb6SJed Brown } 1411f33bbcb6SJed Brown 1412f33bbcb6SJed Brown /*MC 1413f33bbcb6SJed Brown TSBEULER - ODE solver using the implicit backward Euler method 1414f33bbcb6SJed Brown 1415f33bbcb6SJed Brown Level: beginner 1416f33bbcb6SJed Brown 14174eb428fdSBarry Smith Notes: 1418c7eb6c99SShri Abhyankar TSBEULER is equivalent to TSTHETA with Theta=1.0 14194eb428fdSBarry Smith 14201566a47fSLisandro Dalcin $ -ts_type theta -ts_theta_theta 1.0 14214eb428fdSBarry Smith 1422f33bbcb6SJed Brown .seealso: TSCreate(), TS, TSSetType(), TSEULER, TSCN, TSTHETA 1423f33bbcb6SJed Brown 1424f33bbcb6SJed Brown M*/ 14258cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_BEuler(TS ts) 1426f33bbcb6SJed Brown { 1427f33bbcb6SJed Brown PetscErrorCode ierr; 1428f33bbcb6SJed Brown 1429f33bbcb6SJed Brown PetscFunctionBegin; 1430f33bbcb6SJed Brown ierr = TSCreate_Theta(ts);CHKERRQ(ierr); 1431f33bbcb6SJed Brown ierr = TSThetaSetTheta(ts,1.0);CHKERRQ(ierr); 14321566a47fSLisandro Dalcin ierr = TSThetaSetEndpoint(ts,PETSC_FALSE);CHKERRQ(ierr); 14330c7376e5SHong Zhang ts->ops->setup = TSSetUp_BEuler; 1434f33bbcb6SJed Brown ts->ops->view = TSView_BEuler; 1435f33bbcb6SJed Brown PetscFunctionReturn(0); 1436f33bbcb6SJed Brown } 1437f33bbcb6SJed Brown 14381566a47fSLisandro Dalcin static PetscErrorCode TSSetUp_CN(TS ts) 14391566a47fSLisandro Dalcin { 14401566a47fSLisandro Dalcin TS_Theta *th = (TS_Theta*)ts->data; 14411566a47fSLisandro Dalcin PetscErrorCode ierr; 14421566a47fSLisandro Dalcin 14431566a47fSLisandro Dalcin PetscFunctionBegin; 14441566a47fSLisandro Dalcin if (th->Theta != 0.5) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_OPT_OVERWRITE,"Can not change the default value (0.5) of theta when using Crank-Nicolson\n"); 14451566a47fSLisandro Dalcin if (!th->endpoint) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_OPT_OVERWRITE,"Can not change to the midpoint form of the Theta methods when using Crank-Nicolson\n"); 14461566a47fSLisandro Dalcin ierr = TSSetUp_Theta(ts);CHKERRQ(ierr); 14471566a47fSLisandro Dalcin PetscFunctionReturn(0); 14481566a47fSLisandro Dalcin } 14491566a47fSLisandro Dalcin 1450f33bbcb6SJed Brown static PetscErrorCode TSView_CN(TS ts,PetscViewer viewer) 1451f33bbcb6SJed Brown { 1452f33bbcb6SJed Brown PetscFunctionBegin; 1453f33bbcb6SJed Brown PetscFunctionReturn(0); 1454f33bbcb6SJed Brown } 1455f33bbcb6SJed Brown 1456f33bbcb6SJed Brown /*MC 1457f33bbcb6SJed Brown TSCN - ODE solver using the implicit Crank-Nicolson method. 1458f33bbcb6SJed Brown 1459f33bbcb6SJed Brown Level: beginner 1460f33bbcb6SJed Brown 1461f33bbcb6SJed Brown Notes: 14627cf5af47SJed Brown TSCN is equivalent to TSTHETA with Theta=0.5 and the "endpoint" option set. I.e. 14637cf5af47SJed Brown 14647cf5af47SJed Brown $ -ts_type theta -ts_theta_theta 0.5 -ts_theta_endpoint 1465f33bbcb6SJed Brown 1466f33bbcb6SJed Brown .seealso: TSCreate(), TS, TSSetType(), TSBEULER, TSTHETA 1467f33bbcb6SJed Brown 1468f33bbcb6SJed Brown M*/ 14698cc058d9SJed Brown PETSC_EXTERN PetscErrorCode TSCreate_CN(TS ts) 1470f33bbcb6SJed Brown { 1471f33bbcb6SJed Brown PetscErrorCode ierr; 1472f33bbcb6SJed Brown 1473f33bbcb6SJed Brown PetscFunctionBegin; 1474f33bbcb6SJed Brown ierr = TSCreate_Theta(ts);CHKERRQ(ierr); 1475f33bbcb6SJed Brown ierr = TSThetaSetTheta(ts,0.5);CHKERRQ(ierr); 1476eb284becSJed Brown ierr = TSThetaSetEndpoint(ts,PETSC_TRUE);CHKERRQ(ierr); 14770c7376e5SHong Zhang ts->ops->setup = TSSetUp_CN; 1478f33bbcb6SJed Brown ts->ops->view = TSView_CN; 1479f33bbcb6SJed Brown PetscFunctionReturn(0); 1480f33bbcb6SJed Brown } 1481