163dd3a1aSKris Buschelman 2af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 3496e6a7aSJed Brown #include <petscdmshell.h> 41e25c274SJed Brown #include <petscdmda.h> 52d5ee99bSBarry Smith #include <petscviewer.h> 62d5ee99bSBarry Smith #include <petscdraw.h> 7d763cef2SBarry Smith 8d5ba7fb7SMatthew Knepley /* Logging support */ 9d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 10166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 11d405a339SMatthew Knepley 1249354f04SShri Abhyankar const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 1349354f04SShri Abhyankar 142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx { 152d5ee99bSBarry Smith PetscViewer viewer; 164b363babSBarry Smith PetscDrawAxis axis; 172d5ee99bSBarry Smith Vec initialsolution; 182d5ee99bSBarry Smith PetscBool showinitial; 192d5ee99bSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 202d5ee99bSBarry Smith PetscBool showtimestepandtime; 212d5ee99bSBarry Smith int color; 222d5ee99bSBarry Smith }; 232d5ee99bSBarry Smith 24bdad233fSMatthew Knepley #undef __FUNCT__ 25bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 26bdad233fSMatthew Knepley /*@ 27bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 28bdad233fSMatthew Knepley 29bdad233fSMatthew Knepley Collective on TS 30bdad233fSMatthew Knepley 31bdad233fSMatthew Knepley Input Parameter: 32bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 33bdad233fSMatthew Knepley 34bdad233fSMatthew Knepley Options Database Keys: 354d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 36ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 373e4cdcaaSBarry Smith . -ts_max_steps <maxsteps> - maximum number of time-steps to take 383e4cdcaaSBarry Smith . -ts_final_time <time> - maximum time to compute to 393e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 40a3cdaa26SBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> whether to stop at the exact given final time and how to compute the solution at that ti,e 41a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 42a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 43a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 44a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 45a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 46ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 47847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 48bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 49de06c3feSJed Brown . -ts_monitor_lg_timestep - Monitor timestep size graphically 50de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 51de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 52de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 53de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 54de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 55de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 563e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 573e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 5891b97e58SBarry Smith . -ts_monitor_solution_binary <filename> - Save each solution to a binary file 59b3d3934dSBarry Smith . -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 60110eb670SHong Zhang . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 61110eb670SHong Zhang . -ts_adjoint_monitor - print information at each adjoint time step 6253ea634cSHong Zhang - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically 6353ea634cSHong Zhang 6491b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 65bdad233fSMatthew Knepley 66bdad233fSMatthew Knepley Level: beginner 67bdad233fSMatthew Knepley 68bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 69bdad233fSMatthew Knepley 70a313700dSBarry Smith .seealso: TSGetType() 71bdad233fSMatthew Knepley @*/ 727087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 73bdad233fSMatthew Knepley { 74bc952696SBarry Smith PetscBool opt,flg,tflg; 75dfbe8321SBarry Smith PetscErrorCode ierr; 76649052a6SBarry Smith PetscViewer monviewer; 77eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 78089b2837SJed Brown SNES snes; 791c3436cfSJed Brown TSAdapt adapt; 8031748224SBarry Smith PetscReal time_step; 8149354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 82d1212d36SBarry Smith char dir[16]; 836991f827SBarry Smith const char *defaultType; 846991f827SBarry Smith char typeName[256]; 85bdad233fSMatthew Knepley 86bdad233fSMatthew Knepley PetscFunctionBegin; 870700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 883194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 896991f827SBarry Smith if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 906991f827SBarry Smith else defaultType = TSEULER; 916991f827SBarry Smith 926991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 936991f827SBarry Smith ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 946991f827SBarry Smith if (opt) { 956991f827SBarry Smith ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 966991f827SBarry Smith } else { 976991f827SBarry Smith ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 986991f827SBarry Smith } 99bdad233fSMatthew Knepley 100bdad233fSMatthew Knepley /* Handle generic TS options */ 101844594baSBarry Smith if (ts->trajectory) tflg = PETSC_TRUE; 102844594baSBarry Smith else tflg = PETSC_FALSE; 103920aabf2SBarry Smith ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 104bc952696SBarry Smith if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);} 105ef222394SBarry Smith if (ts->adjoint_solve) tflg = PETSC_TRUE; 106ef222394SBarry Smith else tflg = PETSC_FALSE; 107ef222394SBarry Smith ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr); 108ef222394SBarry Smith if (flg) { 109ef222394SBarry Smith ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 110e87fd094SBarry Smith ts->adjoint_solve = tflg; 111ef222394SBarry Smith } 1120298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1130298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 1140298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 11531748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 11631748224SBarry Smith if (flg) { 11731748224SBarry Smith ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 11831748224SBarry Smith } 11949354f04SShri Abhyankar ierr = PetscOptionsEnum("-ts_exact_final_time","Option for handling of final time step","TSSetExactFinalTime",TSExactFinalTimeOptions,(PetscEnum)ts->exact_final_time,(PetscEnum*)&eftopt,&flg);CHKERRQ(ierr); 12049354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1210298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_snes_failures","Maximum number of nonlinear solve failures","TSSetMaxSNESFailures",ts->max_snes_failures,&ts->max_snes_failures,NULL);CHKERRQ(ierr); 1220298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1230298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1240298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1250298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 126bdad233fSMatthew Knepley 12756f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 12856f85f32SBarry Smith { 12956f85f32SBarry Smith PetscBool set; 13056f85f32SBarry Smith flg = PETSC_FALSE; 13156f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 13256f85f32SBarry Smith if (set) { 13356f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 13456f85f32SBarry Smith } 13556f85f32SBarry Smith } 13656f85f32SBarry Smith #endif 13756f85f32SBarry Smith 138bdad233fSMatthew Knepley /* Monitor options */ 139a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 140eabae89aSBarry Smith if (flg) { 141ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 142649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 143bdad233fSMatthew Knepley } 1445180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1455180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1465180491cSLisandro Dalcin 1474f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 148a7cc72afSBarry Smith if (opt) { 1490b039ecaSBarry Smith TSMonitorLGCtx ctx; 1503923b477SBarry Smith PetscInt howoften = 1; 151a80ad3e0SBarry Smith 1520298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 1537f52daa2SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1544f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 155b3603a34SBarry Smith } 1564f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 157b3603a34SBarry Smith if (opt) { 1580b039ecaSBarry Smith TSMonitorLGCtx ctx; 1593923b477SBarry Smith PetscInt howoften = 1; 160b3603a34SBarry Smith 1610298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 16222d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1634f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 164bdad233fSMatthew Knepley } 1654f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 166ef20d060SBarry Smith if (opt) { 1670b039ecaSBarry Smith TSMonitorLGCtx ctx; 1683923b477SBarry Smith PetscInt howoften = 1; 169ef20d060SBarry Smith 1700298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 17122d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1724f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 173ef20d060SBarry Smith } 174201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 175201da799SBarry Smith if (opt) { 176201da799SBarry Smith TSMonitorLGCtx ctx; 177201da799SBarry Smith PetscInt howoften = 1; 178201da799SBarry Smith 1790298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 1807f52daa2SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 181201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 182201da799SBarry Smith } 183201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 184201da799SBarry Smith if (opt) { 185201da799SBarry Smith TSMonitorLGCtx ctx; 186201da799SBarry Smith PetscInt howoften = 1; 187201da799SBarry Smith 1880298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 1897f52daa2SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 190201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 191201da799SBarry Smith } 1928189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 1938189c53fSBarry Smith if (opt) { 1948189c53fSBarry Smith TSMonitorSPEigCtx ctx; 1958189c53fSBarry Smith PetscInt howoften = 1; 1968189c53fSBarry Smith 1970298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 19822d28d08SBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1998189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2008189c53fSBarry Smith } 201ef20d060SBarry Smith opt = PETSC_FALSE; 2020dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 203a7cc72afSBarry Smith if (opt) { 20483a4ac43SBarry Smith TSMonitorDrawCtx ctx; 20583a4ac43SBarry Smith PetscInt howoften = 1; 206a80ad3e0SBarry Smith 2070298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 208ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 20983a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 210bdad233fSMatthew Knepley } 211fb1732b5SBarry Smith opt = PETSC_FALSE; 2129110b2e7SHong Zhang ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr); 2139110b2e7SHong Zhang if (opt) { 2149110b2e7SHong Zhang TSMonitorDrawCtx ctx; 2159110b2e7SHong Zhang PetscInt howoften = 1; 2169110b2e7SHong Zhang 2179110b2e7SHong Zhang ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr); 2189110b2e7SHong Zhang ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 2199110b2e7SHong Zhang ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2209110b2e7SHong Zhang } 2219110b2e7SHong Zhang opt = PETSC_FALSE; 2222d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2232d5ee99bSBarry Smith if (opt) { 2242d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2252d5ee99bSBarry Smith PetscReal bounds[4]; 2262d5ee99bSBarry Smith PetscInt n = 4; 2272d5ee99bSBarry Smith PetscDraw draw; 2282d5ee99bSBarry Smith 2292d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2302d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2312d5ee99bSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 2322d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2332d5ee99bSBarry Smith ierr = PetscDrawClear(draw);CHKERRQ(ierr); 2344b363babSBarry Smith ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 2354b363babSBarry Smith ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 236f54adfc0SBarry Smith ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2374b363babSBarry Smith ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 23807995780SPeter Brune /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 2392d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2402d5ee99bSBarry Smith } 2412d5ee99bSBarry Smith opt = PETSC_FALSE; 2420dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2433a471f94SBarry Smith if (opt) { 24483a4ac43SBarry Smith TSMonitorDrawCtx ctx; 24583a4ac43SBarry Smith PetscInt howoften = 1; 2463a471f94SBarry Smith 2470298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 248ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 24983a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2503a471f94SBarry Smith } 2513a471f94SBarry Smith opt = PETSC_FALSE; 25291b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 253fb1732b5SBarry Smith if (flg) { 254fb1732b5SBarry Smith PetscViewer ctx; 255fb1732b5SBarry Smith if (monfilename[0]) { 256ce94432eSBarry Smith ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 257c2fbc07fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 258fb1732b5SBarry Smith } else { 259ce94432eSBarry Smith ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 2600298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 261fb1732b5SBarry Smith } 262fb1732b5SBarry Smith } 263ed81e22dSJed Brown opt = PETSC_FALSE; 26491b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 265ed81e22dSJed Brown if (flg) { 266ed81e22dSJed Brown const char *ptr,*ptr2; 267ed81e22dSJed Brown char *filetemplate; 268ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 269ed81e22dSJed Brown /* Do some cursory validation of the input. */ 270ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 271ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 272ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 273ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 274ce94432eSBarry Smith if (!ptr2 && (*ptr < '0' || '9' < *ptr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03D.vts"); 275ed81e22dSJed Brown if (ptr2) break; 276ed81e22dSJed Brown } 277ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 278ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 279ed81e22dSJed Brown } 280bdad233fSMatthew Knepley 281d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 282d1212d36SBarry Smith if (flg) { 283d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 284d1212d36SBarry Smith int ray = 0; 285d1212d36SBarry Smith DMDADirection ddir; 286d1212d36SBarry Smith DM da; 287d1212d36SBarry Smith PetscMPIInt rank; 288d1212d36SBarry Smith 289ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 290d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 291d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 292ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 293d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 294d1212d36SBarry Smith 295d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 296b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 297d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 298d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 299ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 300d1212d36SBarry Smith if (!rank) { 301d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 302d1212d36SBarry Smith } 30351b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 304d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 305d1212d36SBarry Smith } 30651b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 30751b4a12fSMatthew G. Knepley if (flg) { 30851b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 30951b4a12fSMatthew G. Knepley int ray = 0; 31051b4a12fSMatthew G. Knepley DMDADirection ddir; 31151b4a12fSMatthew G. Knepley DM da; 31251b4a12fSMatthew G. Knepley PetscInt howoften = 1; 313d1212d36SBarry Smith 31451b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 31551b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 31651b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 31751b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 31851b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3191c3436cfSJed Brown 32051b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 321b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 32251b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 32351b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 32451b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 32551b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 32651b4a12fSMatthew G. Knepley } 327a7a1495cSBarry Smith 328b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 329b3d3934dSBarry Smith if (opt) { 330b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 331b3d3934dSBarry Smith 332b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 333b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 334b3d3934dSBarry Smith } 335b3d3934dSBarry Smith 336847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 337847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 338847ff0e1SMatthew G. Knepley if (flg) { 339847ff0e1SMatthew G. Knepley DM dm; 340847ff0e1SMatthew G. Knepley DMTS tdm; 341847ff0e1SMatthew G. Knepley 342847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 343847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 344847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 345847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 346847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 347847ff0e1SMatthew G. Knepley } 348847ff0e1SMatthew G. Knepley 349110eb670SHong Zhang ierr = PetscOptionsString("-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 350110eb670SHong Zhang if (flg) { 351110eb670SHong Zhang ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 352110eb670SHong Zhang ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 353110eb670SHong Zhang } 354110eb670SHong Zhang 3557781c08eSBarry Smith /* 3567781c08eSBarry Smith This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui 3577781c08eSBarry Smith will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin() 3587781c08eSBarry Smith */ 359552698daSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 360e55864a3SBarry Smith ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr); 361d763cef2SBarry Smith 362d763cef2SBarry Smith /* Handle specific TS options */ 363d763cef2SBarry Smith if (ts->ops->setfromoptions) { 3646991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 365d763cef2SBarry Smith } 3666991f827SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 367d763cef2SBarry Smith 368d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 369d763cef2SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 370d763cef2SBarry Smith 371bc952696SBarry Smith if (ts->trajectory) { 372bc952696SBarry Smith ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr); 373bc952696SBarry Smith } 374bc952696SBarry Smith 3756991f827SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3766991f827SBarry Smith if (snes) { 3776991f827SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 37849c41c37SLisandro Dalcin ierr = SNESSetFromOptions(snes);CHKERRQ(ierr); 379d763cef2SBarry Smith } 380d763cef2SBarry Smith PetscFunctionReturn(0); 381d763cef2SBarry Smith } 382d763cef2SBarry Smith 383d763cef2SBarry Smith #undef __FUNCT__ 384bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory" 385d2daff3dSHong Zhang /*@ 386bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 387d2daff3dSHong Zhang 388d2daff3dSHong Zhang Collective on TS 389d2daff3dSHong Zhang 390d2daff3dSHong Zhang Input Parameters: 391bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 392bc952696SBarry Smith 393d2daff3dSHong Zhang 394d2daff3dSHong Zhang Level: intermediate 395d2daff3dSHong Zhang 396bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve() 397d2daff3dSHong Zhang 398bc952696SBarry Smith .keywords: TS, set, checkpoint, 399d2daff3dSHong Zhang @*/ 400bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 401d2daff3dSHong Zhang { 402bc952696SBarry Smith PetscErrorCode ierr; 403bc952696SBarry Smith 404d2daff3dSHong Zhang PetscFunctionBegin; 405d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 406bc952696SBarry Smith if (!ts->trajectory) { 407bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 408920aabf2SBarry Smith ierr = TSTrajectorySetType(ts->trajectory,TSTRAJECTORYBASIC);CHKERRQ(ierr); 409648b50deSBarry Smith ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr); 410bc952696SBarry Smith } 411d2daff3dSHong Zhang PetscFunctionReturn(0); 412d2daff3dSHong Zhang } 413d2daff3dSHong Zhang 414a7a1495cSBarry Smith #undef __FUNCT__ 415a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian" 416a7a1495cSBarry Smith /*@ 417a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 418a7a1495cSBarry Smith set with TSSetRHSJacobian(). 419a7a1495cSBarry Smith 420a7a1495cSBarry Smith Collective on TS and Vec 421a7a1495cSBarry Smith 422a7a1495cSBarry Smith Input Parameters: 423316643e7SJed Brown + ts - the TS context 424a7a1495cSBarry Smith . t - current timestep 4250910c330SBarry Smith - U - input vector 426a7a1495cSBarry Smith 427a7a1495cSBarry Smith Output Parameters: 428a7a1495cSBarry Smith + A - Jacobian matrix 429a7a1495cSBarry Smith . B - optional preconditioning matrix 430a7a1495cSBarry Smith - flag - flag indicating matrix structure 431a7a1495cSBarry Smith 432a7a1495cSBarry Smith Notes: 433a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 434a7a1495cSBarry Smith is used internally within the nonlinear solvers. 435a7a1495cSBarry Smith 43694b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 437a7a1495cSBarry Smith flag parameter. 438a7a1495cSBarry Smith 439a7a1495cSBarry Smith Level: developer 440a7a1495cSBarry Smith 441a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 442a7a1495cSBarry Smith 44394b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 444a7a1495cSBarry Smith @*/ 445d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 446a7a1495cSBarry Smith { 447dfbe8321SBarry Smith PetscErrorCode ierr; 448270bf2e7SJed Brown PetscObjectState Ustate; 44924989b8cSPeter Brune DM dm; 450942e3340SBarry Smith DMTS tsdm; 45124989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 45224989b8cSPeter Brune void *ctx; 45324989b8cSPeter Brune TSIJacobian ijacobianfunc; 454b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 455a7a1495cSBarry Smith 456a7a1495cSBarry Smith PetscFunctionBegin; 4570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4580910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4590910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 46024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 461942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 46224989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 4630298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 464b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 46559e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 466b2df71adSDebojyoti Ghosh if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 4670e4ef248SJed Brown PetscFunctionReturn(0); 468f8ede8e7SJed Brown } 469d90be118SSean Farley 470ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 471d90be118SSean Farley 472e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 47394ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 47494ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 47594ab13aaSBarry Smith if (A != B) { 47694ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 47794ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 478e1244c69SJed Brown } 479e1244c69SJed Brown ts->rhsjacobian.shift = 0; 480e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 481e1244c69SJed Brown } 482e1244c69SJed Brown 48324989b8cSPeter Brune if (rhsjacobianfunc) { 48494ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 485a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 486d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 487a7a1495cSBarry Smith PetscStackPop; 48894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 489a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 49094ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 49194ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 492ef66eb69SBarry Smith } else { 49394ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 49494ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 495ef66eb69SBarry Smith } 4960e4ef248SJed Brown ts->rhsjacobian.time = t; 4970910c330SBarry Smith ts->rhsjacobian.X = U; 49859e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 499a7a1495cSBarry Smith PetscFunctionReturn(0); 500a7a1495cSBarry Smith } 501a7a1495cSBarry Smith 5024a2ae208SSatish Balay #undef __FUNCT__ 5034a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 504316643e7SJed Brown /*@ 505d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 506d763cef2SBarry Smith 507316643e7SJed Brown Collective on TS and Vec 508316643e7SJed Brown 509316643e7SJed Brown Input Parameters: 510316643e7SJed Brown + ts - the TS context 511316643e7SJed Brown . t - current time 5120910c330SBarry Smith - U - state vector 513316643e7SJed Brown 514316643e7SJed Brown Output Parameter: 515316643e7SJed Brown . y - right hand side 516316643e7SJed Brown 517316643e7SJed Brown Note: 518316643e7SJed Brown Most users should not need to explicitly call this routine, as it 519316643e7SJed Brown is used internally within the nonlinear solvers. 520316643e7SJed Brown 521316643e7SJed Brown Level: developer 522316643e7SJed Brown 523316643e7SJed Brown .keywords: TS, compute 524316643e7SJed Brown 525316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 526316643e7SJed Brown @*/ 5270910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 528d763cef2SBarry Smith { 529dfbe8321SBarry Smith PetscErrorCode ierr; 53024989b8cSPeter Brune TSRHSFunction rhsfunction; 53124989b8cSPeter Brune TSIFunction ifunction; 53224989b8cSPeter Brune void *ctx; 53324989b8cSPeter Brune DM dm; 53424989b8cSPeter Brune 535d763cef2SBarry Smith PetscFunctionBegin; 5360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5370910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5380700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 53924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 54024989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 5410298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 542d763cef2SBarry Smith 543ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 544d763cef2SBarry Smith 5450910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 54624989b8cSPeter Brune if (rhsfunction) { 547d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 5480910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 549d763cef2SBarry Smith PetscStackPop; 550214bc6a2SJed Brown } else { 551214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 552b2cd27e8SJed Brown } 55344a41b28SSean Farley 5540910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 555d763cef2SBarry Smith PetscFunctionReturn(0); 556d763cef2SBarry Smith } 557d763cef2SBarry Smith 5584a2ae208SSatish Balay #undef __FUNCT__ 559ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 560ef20d060SBarry Smith /*@ 561ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 562ef20d060SBarry Smith 563ef20d060SBarry Smith Collective on TS and Vec 564ef20d060SBarry Smith 565ef20d060SBarry Smith Input Parameters: 566ef20d060SBarry Smith + ts - the TS context 567ef20d060SBarry Smith - t - current time 568ef20d060SBarry Smith 569ef20d060SBarry Smith Output Parameter: 5700910c330SBarry Smith . U - the solution 571ef20d060SBarry Smith 572ef20d060SBarry Smith Note: 573ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 574ef20d060SBarry Smith is used internally within the nonlinear solvers. 575ef20d060SBarry Smith 576ef20d060SBarry Smith Level: developer 577ef20d060SBarry Smith 578ef20d060SBarry Smith .keywords: TS, compute 579ef20d060SBarry Smith 580abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 581ef20d060SBarry Smith @*/ 5820910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 583ef20d060SBarry Smith { 584ef20d060SBarry Smith PetscErrorCode ierr; 585ef20d060SBarry Smith TSSolutionFunction solutionfunction; 586ef20d060SBarry Smith void *ctx; 587ef20d060SBarry Smith DM dm; 588ef20d060SBarry Smith 589ef20d060SBarry Smith PetscFunctionBegin; 590ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5910910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 592ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 593ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 594ef20d060SBarry Smith 595ef20d060SBarry Smith if (solutionfunction) { 5969b7cd975SBarry Smith PetscStackPush("TS user solution function"); 5970910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 598ef20d060SBarry Smith PetscStackPop; 599ef20d060SBarry Smith } 600ef20d060SBarry Smith PetscFunctionReturn(0); 601ef20d060SBarry Smith } 6029b7cd975SBarry Smith #undef __FUNCT__ 6039b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction" 6049b7cd975SBarry Smith /*@ 6059b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 6069b7cd975SBarry Smith 6079b7cd975SBarry Smith Collective on TS and Vec 6089b7cd975SBarry Smith 6099b7cd975SBarry Smith Input Parameters: 6109b7cd975SBarry Smith + ts - the TS context 6119b7cd975SBarry Smith - t - current time 6129b7cd975SBarry Smith 6139b7cd975SBarry Smith Output Parameter: 6149b7cd975SBarry Smith . U - the function value 6159b7cd975SBarry Smith 6169b7cd975SBarry Smith Note: 6179b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 6189b7cd975SBarry Smith is used internally within the nonlinear solvers. 6199b7cd975SBarry Smith 6209b7cd975SBarry Smith Level: developer 6219b7cd975SBarry Smith 6229b7cd975SBarry Smith .keywords: TS, compute 6239b7cd975SBarry Smith 6249b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 6259b7cd975SBarry Smith @*/ 6269b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 6279b7cd975SBarry Smith { 6289b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 6299b7cd975SBarry Smith void *ctx; 6309b7cd975SBarry Smith DM dm; 6319b7cd975SBarry Smith 6329b7cd975SBarry Smith PetscFunctionBegin; 6339b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6349b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6359b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 6369b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 6379b7cd975SBarry Smith 6389b7cd975SBarry Smith if (forcing) { 6399b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 6409b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 6419b7cd975SBarry Smith PetscStackPop; 6429b7cd975SBarry Smith } 6439b7cd975SBarry Smith PetscFunctionReturn(0); 6449b7cd975SBarry Smith } 645ef20d060SBarry Smith 646ef20d060SBarry Smith #undef __FUNCT__ 647214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 648214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 649214bc6a2SJed Brown { 6502dd45cf8SJed Brown Vec F; 651214bc6a2SJed Brown PetscErrorCode ierr; 652214bc6a2SJed Brown 653214bc6a2SJed Brown PetscFunctionBegin; 6540298fd71SBarry Smith *Frhs = NULL; 6550298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 656214bc6a2SJed Brown if (!ts->Frhs) { 6572dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 658214bc6a2SJed Brown } 659214bc6a2SJed Brown *Frhs = ts->Frhs; 660214bc6a2SJed Brown PetscFunctionReturn(0); 661214bc6a2SJed Brown } 662214bc6a2SJed Brown 663214bc6a2SJed Brown #undef __FUNCT__ 664214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 665214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 666214bc6a2SJed Brown { 667214bc6a2SJed Brown Mat A,B; 6682dd45cf8SJed Brown PetscErrorCode ierr; 669214bc6a2SJed Brown 670214bc6a2SJed Brown PetscFunctionBegin; 671c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 672c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 6730298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 674214bc6a2SJed Brown if (Arhs) { 675214bc6a2SJed Brown if (!ts->Arhs) { 676214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 677214bc6a2SJed Brown } 678214bc6a2SJed Brown *Arhs = ts->Arhs; 679214bc6a2SJed Brown } 680214bc6a2SJed Brown if (Brhs) { 681214bc6a2SJed Brown if (!ts->Brhs) { 682bdb70873SJed Brown if (A != B) { 683214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 684bdb70873SJed Brown } else { 685bdb70873SJed Brown ts->Brhs = ts->Arhs; 686bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 687bdb70873SJed Brown } 688214bc6a2SJed Brown } 689214bc6a2SJed Brown *Brhs = ts->Brhs; 690214bc6a2SJed Brown } 691214bc6a2SJed Brown PetscFunctionReturn(0); 692214bc6a2SJed Brown } 693214bc6a2SJed Brown 694214bc6a2SJed Brown #undef __FUNCT__ 695316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 696316643e7SJed Brown /*@ 6970910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 698316643e7SJed Brown 699316643e7SJed Brown Collective on TS and Vec 700316643e7SJed Brown 701316643e7SJed Brown Input Parameters: 702316643e7SJed Brown + ts - the TS context 703316643e7SJed Brown . t - current time 7040910c330SBarry Smith . U - state vector 7050910c330SBarry Smith . Udot - time derivative of state vector 706214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 707316643e7SJed Brown 708316643e7SJed Brown Output Parameter: 709316643e7SJed Brown . Y - right hand side 710316643e7SJed Brown 711316643e7SJed Brown Note: 712316643e7SJed Brown Most users should not need to explicitly call this routine, as it 713316643e7SJed Brown is used internally within the nonlinear solvers. 714316643e7SJed Brown 715316643e7SJed Brown If the user did did not write their equations in implicit form, this 716316643e7SJed Brown function recasts them in implicit form. 717316643e7SJed Brown 718316643e7SJed Brown Level: developer 719316643e7SJed Brown 720316643e7SJed Brown .keywords: TS, compute 721316643e7SJed Brown 722316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 723316643e7SJed Brown @*/ 7240910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 725316643e7SJed Brown { 726316643e7SJed Brown PetscErrorCode ierr; 72724989b8cSPeter Brune TSIFunction ifunction; 72824989b8cSPeter Brune TSRHSFunction rhsfunction; 72924989b8cSPeter Brune void *ctx; 73024989b8cSPeter Brune DM dm; 731316643e7SJed Brown 732316643e7SJed Brown PetscFunctionBegin; 7330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7340910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7350910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 7360700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 737316643e7SJed Brown 73824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 73924989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 7400298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 74124989b8cSPeter Brune 742ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 743d90be118SSean Farley 7440910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 74524989b8cSPeter Brune if (ifunction) { 746316643e7SJed Brown PetscStackPush("TS user implicit function"); 7470910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 748316643e7SJed Brown PetscStackPop; 749214bc6a2SJed Brown } 750214bc6a2SJed Brown if (imex) { 75124989b8cSPeter Brune if (!ifunction) { 7520910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 7532dd45cf8SJed Brown } 75424989b8cSPeter Brune } else if (rhsfunction) { 75524989b8cSPeter Brune if (ifunction) { 756214bc6a2SJed Brown Vec Frhs; 757214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 7580910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 759214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 7602dd45cf8SJed Brown } else { 7610910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 7620910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 763316643e7SJed Brown } 7644a6899ffSJed Brown } 7650910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 766316643e7SJed Brown PetscFunctionReturn(0); 767316643e7SJed Brown } 768316643e7SJed Brown 769316643e7SJed Brown #undef __FUNCT__ 770316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 771316643e7SJed Brown /*@ 772316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 773316643e7SJed Brown 774316643e7SJed Brown Collective on TS and Vec 775316643e7SJed Brown 776316643e7SJed Brown Input 777316643e7SJed Brown Input Parameters: 778316643e7SJed Brown + ts - the TS context 779316643e7SJed Brown . t - current timestep 7800910c330SBarry Smith . U - state vector 7810910c330SBarry Smith . Udot - time derivative of state vector 782214bc6a2SJed Brown . shift - shift to apply, see note below 783214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 784316643e7SJed Brown 785316643e7SJed Brown Output Parameters: 786316643e7SJed Brown + A - Jacobian matrix 787316643e7SJed Brown . B - optional preconditioning matrix 788316643e7SJed Brown - flag - flag indicating matrix structure 789316643e7SJed Brown 790316643e7SJed Brown Notes: 7910910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 792316643e7SJed Brown 7930910c330SBarry Smith dF/dU + shift*dF/dUdot 794316643e7SJed Brown 795316643e7SJed Brown Most users should not need to explicitly call this routine, as it 796316643e7SJed Brown is used internally within the nonlinear solvers. 797316643e7SJed Brown 798316643e7SJed Brown Level: developer 799316643e7SJed Brown 800316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 801316643e7SJed Brown 802316643e7SJed Brown .seealso: TSSetIJacobian() 80363495f91SJed Brown @*/ 804d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 805316643e7SJed Brown { 806316643e7SJed Brown PetscErrorCode ierr; 80724989b8cSPeter Brune TSIJacobian ijacobian; 80824989b8cSPeter Brune TSRHSJacobian rhsjacobian; 80924989b8cSPeter Brune DM dm; 81024989b8cSPeter Brune void *ctx; 811316643e7SJed Brown 812316643e7SJed Brown PetscFunctionBegin; 8130700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8140910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8150910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 816316643e7SJed Brown PetscValidPointer(A,6); 81794ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 818316643e7SJed Brown PetscValidPointer(B,7); 81994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 82024989b8cSPeter Brune 82124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 82224989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 8230298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 82424989b8cSPeter Brune 825ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 826316643e7SJed Brown 82794ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 82824989b8cSPeter Brune if (ijacobian) { 829316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 830d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 831316643e7SJed Brown PetscStackPop; 832214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 83394ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 83494ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 8354a6899ffSJed Brown } 836214bc6a2SJed Brown if (imex) { 837b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 83894ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 83994ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 84094ab13aaSBarry Smith if (A != B) { 84194ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 84294ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 843214bc6a2SJed Brown } 844214bc6a2SJed Brown } 845214bc6a2SJed Brown } else { 846e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 847e1244c69SJed Brown if (rhsjacobian) { 848bd373395SBarry Smith if (ijacobian) { 849214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 850bd373395SBarry Smith } else { 851bd373395SBarry Smith ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr); 852214bc6a2SJed Brown } 853d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 854e1244c69SJed Brown } 85594ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 856e1244c69SJed Brown ts->rhsjacobian.scale = -1; 857e1244c69SJed Brown ts->rhsjacobian.shift = shift; 85894ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 85994ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 86094ab13aaSBarry Smith if (A != B) { 86194ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 86294ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 863316643e7SJed Brown } 864e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 865e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 866e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 86794ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 86894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 86994ab13aaSBarry Smith if (A != B) { 87094ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 87194ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 872214bc6a2SJed Brown } 873316643e7SJed Brown } 87494ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 87594ab13aaSBarry Smith if (A != B) { 87694ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 877316643e7SJed Brown } 878316643e7SJed Brown } 879316643e7SJed Brown } 88094ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 881316643e7SJed Brown PetscFunctionReturn(0); 882316643e7SJed Brown } 883316643e7SJed Brown 884316643e7SJed Brown #undef __FUNCT__ 8854a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 886d763cef2SBarry Smith /*@C 887d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 888b5abc632SBarry Smith where U_t = G(t,u). 889d763cef2SBarry Smith 8903f9fe445SBarry Smith Logically Collective on TS 891d763cef2SBarry Smith 892d763cef2SBarry Smith Input Parameters: 893d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 8940298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 895d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 896d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 8970298fd71SBarry Smith function evaluation routine (may be NULL) 898d763cef2SBarry Smith 899d763cef2SBarry Smith Calling sequence of func: 90087828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 901d763cef2SBarry Smith 902d763cef2SBarry Smith + t - current timestep 903d763cef2SBarry Smith . u - input vector 904d763cef2SBarry Smith . F - function vector 905d763cef2SBarry Smith - ctx - [optional] user-defined function context 906d763cef2SBarry Smith 907d763cef2SBarry Smith Level: beginner 908d763cef2SBarry Smith 9092bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 9102bbac0d3SBarry Smith 911d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 912d763cef2SBarry Smith 913ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 914d763cef2SBarry Smith @*/ 915089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 916d763cef2SBarry Smith { 917089b2837SJed Brown PetscErrorCode ierr; 918089b2837SJed Brown SNES snes; 9190298fd71SBarry Smith Vec ralloc = NULL; 92024989b8cSPeter Brune DM dm; 921d763cef2SBarry Smith 922089b2837SJed Brown PetscFunctionBegin; 9230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 924ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 92524989b8cSPeter Brune 92624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 92724989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 928089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 929e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 930e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 931e856ceecSJed Brown r = ralloc; 932e856ceecSJed Brown } 933089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 934e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 935d763cef2SBarry Smith PetscFunctionReturn(0); 936d763cef2SBarry Smith } 937d763cef2SBarry Smith 9384a2ae208SSatish Balay #undef __FUNCT__ 939ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 940ef20d060SBarry Smith /*@C 941abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 942ef20d060SBarry Smith 943ef20d060SBarry Smith Logically Collective on TS 944ef20d060SBarry Smith 945ef20d060SBarry Smith Input Parameters: 946ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 947ef20d060SBarry Smith . f - routine for evaluating the solution 948ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 9490298fd71SBarry Smith function evaluation routine (may be NULL) 950ef20d060SBarry Smith 951ef20d060SBarry Smith Calling sequence of func: 952ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 953ef20d060SBarry Smith 954ef20d060SBarry Smith + t - current timestep 955ef20d060SBarry Smith . u - output vector 956ef20d060SBarry Smith - ctx - [optional] user-defined function context 957ef20d060SBarry Smith 958abd5a294SJed Brown Notes: 959abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 960abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 961abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 962abd5a294SJed Brown 9634f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 964abd5a294SJed Brown 965ef20d060SBarry Smith Level: beginner 966ef20d060SBarry Smith 967ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 968ef20d060SBarry Smith 9699b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 970ef20d060SBarry Smith @*/ 971ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 972ef20d060SBarry Smith { 973ef20d060SBarry Smith PetscErrorCode ierr; 974ef20d060SBarry Smith DM dm; 975ef20d060SBarry Smith 976ef20d060SBarry Smith PetscFunctionBegin; 977ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 978ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 979ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 980ef20d060SBarry Smith PetscFunctionReturn(0); 981ef20d060SBarry Smith } 982ef20d060SBarry Smith 983ef20d060SBarry Smith #undef __FUNCT__ 9849b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction" 9859b7cd975SBarry Smith /*@C 9869b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 9879b7cd975SBarry Smith 9889b7cd975SBarry Smith Logically Collective on TS 9899b7cd975SBarry Smith 9909b7cd975SBarry Smith Input Parameters: 9919b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 9929b7cd975SBarry Smith . f - routine for evaluating the forcing function 9939b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 9940298fd71SBarry Smith function evaluation routine (may be NULL) 9959b7cd975SBarry Smith 9969b7cd975SBarry Smith Calling sequence of func: 9979b7cd975SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 9989b7cd975SBarry Smith 9999b7cd975SBarry Smith + t - current timestep 10009b7cd975SBarry Smith . u - output vector 10019b7cd975SBarry Smith - ctx - [optional] user-defined function context 10029b7cd975SBarry Smith 10039b7cd975SBarry Smith Notes: 10049b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 10059b7cd975SBarry Smith create closed-form solutions with a non-physical forcing term. 10069b7cd975SBarry Smith 10079b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 10089b7cd975SBarry Smith 10099b7cd975SBarry Smith Level: beginner 10109b7cd975SBarry Smith 10119b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 10129b7cd975SBarry Smith 10139b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 10149b7cd975SBarry Smith @*/ 10159b7cd975SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 10169b7cd975SBarry Smith { 10179b7cd975SBarry Smith PetscErrorCode ierr; 10189b7cd975SBarry Smith DM dm; 10199b7cd975SBarry Smith 10209b7cd975SBarry Smith PetscFunctionBegin; 10219b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10229b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 10239b7cd975SBarry Smith ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 10249b7cd975SBarry Smith PetscFunctionReturn(0); 10259b7cd975SBarry Smith } 10269b7cd975SBarry Smith 10279b7cd975SBarry Smith #undef __FUNCT__ 10284a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 1029d763cef2SBarry Smith /*@C 1030f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1031b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1032d763cef2SBarry Smith 10333f9fe445SBarry Smith Logically Collective on TS 1034d763cef2SBarry Smith 1035d763cef2SBarry Smith Input Parameters: 1036d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1037e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1038e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1039d763cef2SBarry Smith . f - the Jacobian evaluation routine 1040d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10410298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1042d763cef2SBarry Smith 1043f7ab8db6SBarry Smith Calling sequence of f: 1044ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1045d763cef2SBarry Smith 1046d763cef2SBarry Smith + t - current timestep 1047d763cef2SBarry Smith . u - input vector 1048e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1049e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1050d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1051d763cef2SBarry Smith 1052d763cef2SBarry Smith 1053d763cef2SBarry Smith Level: beginner 1054d763cef2SBarry Smith 1055d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1056d763cef2SBarry Smith 1057ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1058d763cef2SBarry Smith 1059d763cef2SBarry Smith @*/ 1060e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1061d763cef2SBarry Smith { 1062277b19d0SLisandro Dalcin PetscErrorCode ierr; 1063089b2837SJed Brown SNES snes; 106424989b8cSPeter Brune DM dm; 106524989b8cSPeter Brune TSIJacobian ijacobian; 1066277b19d0SLisandro Dalcin 1067d763cef2SBarry Smith PetscFunctionBegin; 10680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1069e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1070e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1071e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1072e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1073d763cef2SBarry Smith 107424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 107524989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1076e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1077e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1078e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1079e1244c69SJed Brown } 10800298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1081089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 10825f659677SPeter Brune if (!ijacobian) { 1083e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 10840e4ef248SJed Brown } 1085e5d3d808SBarry Smith if (Amat) { 1086e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 10870e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1088bbd56ea5SKarl Rupp 1089e5d3d808SBarry Smith ts->Arhs = Amat; 10900e4ef248SJed Brown } 1091e5d3d808SBarry Smith if (Pmat) { 1092e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 10930e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1094bbd56ea5SKarl Rupp 1095e5d3d808SBarry Smith ts->Brhs = Pmat; 10960e4ef248SJed Brown } 1097d763cef2SBarry Smith PetscFunctionReturn(0); 1098d763cef2SBarry Smith } 1099d763cef2SBarry Smith 1100316643e7SJed Brown 1101316643e7SJed Brown #undef __FUNCT__ 1102316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 1103316643e7SJed Brown /*@C 1104b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1105316643e7SJed Brown 11063f9fe445SBarry Smith Logically Collective on TS 1107316643e7SJed Brown 1108316643e7SJed Brown Input Parameters: 1109316643e7SJed Brown + ts - the TS context obtained from TSCreate() 11100298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1111316643e7SJed Brown . f - the function evaluation routine 11120298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1113316643e7SJed Brown 1114316643e7SJed Brown Calling sequence of f: 1115316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1116316643e7SJed Brown 1117316643e7SJed Brown + t - time at step/stage being solved 1118316643e7SJed Brown . u - state vector 1119316643e7SJed Brown . u_t - time derivative of state vector 1120316643e7SJed Brown . F - function vector 1121316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1122316643e7SJed Brown 1123316643e7SJed Brown Important: 11242bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1125316643e7SJed Brown 1126316643e7SJed Brown Level: beginner 1127316643e7SJed Brown 1128316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1129316643e7SJed Brown 1130d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1131316643e7SJed Brown @*/ 1132089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1133316643e7SJed Brown { 1134089b2837SJed Brown PetscErrorCode ierr; 1135089b2837SJed Brown SNES snes; 11360298fd71SBarry Smith Vec resalloc = NULL; 113724989b8cSPeter Brune DM dm; 1138316643e7SJed Brown 1139316643e7SJed Brown PetscFunctionBegin; 11400700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1141ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 114224989b8cSPeter Brune 114324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 114424989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 114524989b8cSPeter Brune 1146089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1147e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 1148e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1149e856ceecSJed Brown res = resalloc; 1150e856ceecSJed Brown } 1151089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1152e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1153089b2837SJed Brown PetscFunctionReturn(0); 1154089b2837SJed Brown } 1155089b2837SJed Brown 1156089b2837SJed Brown #undef __FUNCT__ 1157089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 1158089b2837SJed Brown /*@C 1159089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1160089b2837SJed Brown 1161089b2837SJed Brown Not Collective 1162089b2837SJed Brown 1163089b2837SJed Brown Input Parameter: 1164089b2837SJed Brown . ts - the TS context 1165089b2837SJed Brown 1166089b2837SJed Brown Output Parameter: 11670298fd71SBarry Smith + r - vector to hold residual (or NULL) 11680298fd71SBarry Smith . func - the function to compute residual (or NULL) 11690298fd71SBarry Smith - ctx - the function context (or NULL) 1170089b2837SJed Brown 1171089b2837SJed Brown Level: advanced 1172089b2837SJed Brown 1173089b2837SJed Brown .keywords: TS, nonlinear, get, function 1174089b2837SJed Brown 1175089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1176089b2837SJed Brown @*/ 1177089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1178089b2837SJed Brown { 1179089b2837SJed Brown PetscErrorCode ierr; 1180089b2837SJed Brown SNES snes; 118124989b8cSPeter Brune DM dm; 1182089b2837SJed Brown 1183089b2837SJed Brown PetscFunctionBegin; 1184089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1185089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11860298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 118724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 118824989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1189089b2837SJed Brown PetscFunctionReturn(0); 1190089b2837SJed Brown } 1191089b2837SJed Brown 1192089b2837SJed Brown #undef __FUNCT__ 1193089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 1194089b2837SJed Brown /*@C 1195089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1196089b2837SJed Brown 1197089b2837SJed Brown Not Collective 1198089b2837SJed Brown 1199089b2837SJed Brown Input Parameter: 1200089b2837SJed Brown . ts - the TS context 1201089b2837SJed Brown 1202089b2837SJed Brown Output Parameter: 12030298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 12040298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 12050298fd71SBarry Smith - ctx - the function context (or NULL) 1206089b2837SJed Brown 1207089b2837SJed Brown Level: advanced 1208089b2837SJed Brown 1209089b2837SJed Brown .keywords: TS, nonlinear, get, function 1210089b2837SJed Brown 12112bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1212089b2837SJed Brown @*/ 1213089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1214089b2837SJed Brown { 1215089b2837SJed Brown PetscErrorCode ierr; 1216089b2837SJed Brown SNES snes; 121724989b8cSPeter Brune DM dm; 1218089b2837SJed Brown 1219089b2837SJed Brown PetscFunctionBegin; 1220089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1221089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12220298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 122324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 122424989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1225316643e7SJed Brown PetscFunctionReturn(0); 1226316643e7SJed Brown } 1227316643e7SJed Brown 1228316643e7SJed Brown #undef __FUNCT__ 1229316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 1230316643e7SJed Brown /*@C 1231a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1232ae8867d6SBarry Smith provided with TSSetIFunction(). 1233316643e7SJed Brown 12343f9fe445SBarry Smith Logically Collective on TS 1235316643e7SJed Brown 1236316643e7SJed Brown Input Parameters: 1237316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1238e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1239e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1240316643e7SJed Brown . f - the Jacobian evaluation routine 12410298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1242316643e7SJed Brown 1243316643e7SJed Brown Calling sequence of f: 1244ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1245316643e7SJed Brown 1246316643e7SJed Brown + t - time at step/stage being solved 12471b4a444bSJed Brown . U - state vector 12481b4a444bSJed Brown . U_t - time derivative of state vector 1249316643e7SJed Brown . a - shift 1250e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1251e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1252316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1253316643e7SJed Brown 1254316643e7SJed Brown Notes: 1255e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1256316643e7SJed Brown 1257895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1258895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1259895c21f2SBarry Smith 1260a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1261b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1262a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1263a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1264a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1265a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1266a4f0a591SBarry Smith 1267316643e7SJed Brown Level: beginner 1268316643e7SJed Brown 1269316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1270316643e7SJed Brown 1271ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1272316643e7SJed Brown 1273316643e7SJed Brown @*/ 1274e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1275316643e7SJed Brown { 1276316643e7SJed Brown PetscErrorCode ierr; 1277089b2837SJed Brown SNES snes; 127824989b8cSPeter Brune DM dm; 1279316643e7SJed Brown 1280316643e7SJed Brown PetscFunctionBegin; 12810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1282e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1283e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1284e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1285e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 128624989b8cSPeter Brune 128724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 128824989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 128924989b8cSPeter Brune 1290089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1291e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1292316643e7SJed Brown PetscFunctionReturn(0); 1293316643e7SJed Brown } 1294316643e7SJed Brown 12954a2ae208SSatish Balay #undef __FUNCT__ 1296e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse" 1297e1244c69SJed Brown /*@ 1298e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1299e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1300e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1301e1244c69SJed Brown not been changed by the TS. 1302e1244c69SJed Brown 1303e1244c69SJed Brown Logically Collective 1304e1244c69SJed Brown 1305e1244c69SJed Brown Input Arguments: 1306e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1307e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1308e1244c69SJed Brown 1309e1244c69SJed Brown Level: intermediate 1310e1244c69SJed Brown 1311e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1312e1244c69SJed Brown @*/ 1313e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1314e1244c69SJed Brown { 1315e1244c69SJed Brown PetscFunctionBegin; 1316e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1317e1244c69SJed Brown PetscFunctionReturn(0); 1318e1244c69SJed Brown } 1319e1244c69SJed Brown 1320e1244c69SJed Brown #undef __FUNCT__ 132155849f57SBarry Smith #define __FUNCT__ "TSLoad" 132255849f57SBarry Smith /*@C 132355849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 132455849f57SBarry Smith 132555849f57SBarry Smith Collective on PetscViewer 132655849f57SBarry Smith 132755849f57SBarry Smith Input Parameters: 132855849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 132955849f57SBarry Smith some related function before a call to TSLoad(). 133055849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 133155849f57SBarry Smith 133255849f57SBarry Smith Level: intermediate 133355849f57SBarry Smith 133455849f57SBarry Smith Notes: 133555849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 133655849f57SBarry Smith 133755849f57SBarry Smith Notes for advanced users: 133855849f57SBarry Smith Most users should not need to know the details of the binary storage 133955849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 134055849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 134155849f57SBarry Smith format is 134255849f57SBarry Smith .vb 134355849f57SBarry Smith has not yet been determined 134455849f57SBarry Smith .ve 134555849f57SBarry Smith 134655849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 134755849f57SBarry Smith @*/ 1348f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 134955849f57SBarry Smith { 135055849f57SBarry Smith PetscErrorCode ierr; 135155849f57SBarry Smith PetscBool isbinary; 135255849f57SBarry Smith PetscInt classid; 135355849f57SBarry Smith char type[256]; 13542d53ad75SBarry Smith DMTS sdm; 1355ad6bc421SBarry Smith DM dm; 135655849f57SBarry Smith 135755849f57SBarry Smith PetscFunctionBegin; 1358f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 135955849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 136055849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 136155849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 136255849f57SBarry Smith 1363060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1364ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1365060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1366f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1367f2c2a1b9SBarry Smith if (ts->ops->load) { 1368f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1369f2c2a1b9SBarry Smith } 1370ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1371ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1372ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1373f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1374f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 13752d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13762d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 137755849f57SBarry Smith PetscFunctionReturn(0); 137855849f57SBarry Smith } 137955849f57SBarry Smith 13809804daf3SBarry Smith #include <petscdraw.h> 1381e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1382e04113cfSBarry Smith #include <petscviewersaws.h> 1383f05ece33SBarry Smith #endif 138455849f57SBarry Smith #undef __FUNCT__ 13854a2ae208SSatish Balay #define __FUNCT__ "TSView" 13867e2c5f70SBarry Smith /*@C 1387d763cef2SBarry Smith TSView - Prints the TS data structure. 1388d763cef2SBarry Smith 13894c49b128SBarry Smith Collective on TS 1390d763cef2SBarry Smith 1391d763cef2SBarry Smith Input Parameters: 1392d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1393d763cef2SBarry Smith - viewer - visualization context 1394d763cef2SBarry Smith 1395d763cef2SBarry Smith Options Database Key: 1396d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1397d763cef2SBarry Smith 1398d763cef2SBarry Smith Notes: 1399d763cef2SBarry Smith The available visualization contexts include 1400b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1401b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1402d763cef2SBarry Smith output where only the first processor opens 1403d763cef2SBarry Smith the file. All other processors send their 1404d763cef2SBarry Smith data to the first processor to print. 1405d763cef2SBarry Smith 1406d763cef2SBarry Smith The user can open an alternative visualization context with 1407b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1408d763cef2SBarry Smith 1409d763cef2SBarry Smith Level: beginner 1410d763cef2SBarry Smith 1411d763cef2SBarry Smith .keywords: TS, timestep, view 1412d763cef2SBarry Smith 1413b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1414d763cef2SBarry Smith @*/ 14157087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1416d763cef2SBarry Smith { 1417dfbe8321SBarry Smith PetscErrorCode ierr; 141819fd82e9SBarry Smith TSType type; 14192b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 14202d53ad75SBarry Smith DMTS sdm; 1421e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1422536b137fSBarry Smith PetscBool issaws; 1423f05ece33SBarry Smith #endif 1424d763cef2SBarry Smith 1425d763cef2SBarry Smith PetscFunctionBegin; 14260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14273050cee2SBarry Smith if (!viewer) { 1428ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 14293050cee2SBarry Smith } 14300700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1431c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1432fd16b177SBarry Smith 1433251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1434251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 143555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 14362b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1437e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1438536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1439f05ece33SBarry Smith #endif 144032077d6dSBarry Smith if (iascii) { 1441dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 144277431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 14437c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1444d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 14455ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1446c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1447d763cef2SBarry Smith } 14485ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1449193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 14502d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 14512d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1452d52bd9f3SBarry Smith if (ts->ops->view) { 1453d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1454d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1455d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1456d52bd9f3SBarry Smith } 14570f5bd95cSBarry Smith } else if (isstring) { 1458a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1459b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 146055849f57SBarry Smith } else if (isbinary) { 146155849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 146255849f57SBarry Smith MPI_Comm comm; 146355849f57SBarry Smith PetscMPIInt rank; 146455849f57SBarry Smith char type[256]; 146555849f57SBarry Smith 146655849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 146755849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 146855849f57SBarry Smith if (!rank) { 146955849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 147055849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 147155849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 147255849f57SBarry Smith } 147355849f57SBarry Smith if (ts->ops->view) { 147455849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 147555849f57SBarry Smith } 1476f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1477f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 14782d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 14792d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 14802b0a91c0SBarry Smith } else if (isdraw) { 14812b0a91c0SBarry Smith PetscDraw draw; 14822b0a91c0SBarry Smith char str[36]; 148389fd9fafSBarry Smith PetscReal x,y,bottom,h; 14842b0a91c0SBarry Smith 14852b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 14862b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 14872b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 14882b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 148951fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 149089fd9fafSBarry Smith bottom = y - h; 14912b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 14922b0a91c0SBarry Smith if (ts->ops->view) { 14932b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14942b0a91c0SBarry Smith } 14952b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1496e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1497536b137fSBarry Smith } else if (issaws) { 1498d45a07a7SBarry Smith PetscMPIInt rank; 14992657e9d9SBarry Smith const char *name; 15002657e9d9SBarry Smith 15012657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1502d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1503d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1504d45a07a7SBarry Smith char dir[1024]; 1505d45a07a7SBarry Smith 1506e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1507a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 15082657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 15092657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 15102657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1511d763cef2SBarry Smith } 15120acecf5bSBarry Smith if (ts->ops->view) { 15130acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 15140acecf5bSBarry Smith } 1515f05ece33SBarry Smith #endif 1516f05ece33SBarry Smith } 1517f05ece33SBarry Smith 1518b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1519251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1520b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1521d763cef2SBarry Smith PetscFunctionReturn(0); 1522d763cef2SBarry Smith } 1523d763cef2SBarry Smith 1524d763cef2SBarry Smith 15254a2ae208SSatish Balay #undef __FUNCT__ 15264a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1527b07ff414SBarry Smith /*@ 1528d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1529d763cef2SBarry Smith the timesteppers. 1530d763cef2SBarry Smith 15313f9fe445SBarry Smith Logically Collective on TS 1532d763cef2SBarry Smith 1533d763cef2SBarry Smith Input Parameters: 1534d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1535d763cef2SBarry Smith - usrP - optional user context 1536d763cef2SBarry Smith 1537daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 1538daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 1539daf670e6SBarry Smith 1540d763cef2SBarry Smith Level: intermediate 1541d763cef2SBarry Smith 1542d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1543d763cef2SBarry Smith 1544d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1545d763cef2SBarry Smith @*/ 15467087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1547d763cef2SBarry Smith { 1548d763cef2SBarry Smith PetscFunctionBegin; 15490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1550d763cef2SBarry Smith ts->user = usrP; 1551d763cef2SBarry Smith PetscFunctionReturn(0); 1552d763cef2SBarry Smith } 1553d763cef2SBarry Smith 15544a2ae208SSatish Balay #undef __FUNCT__ 15554a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1556b07ff414SBarry Smith /*@ 1557d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1558d763cef2SBarry Smith timestepper. 1559d763cef2SBarry Smith 1560d763cef2SBarry Smith Not Collective 1561d763cef2SBarry Smith 1562d763cef2SBarry Smith Input Parameter: 1563d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1564d763cef2SBarry Smith 1565d763cef2SBarry Smith Output Parameter: 1566d763cef2SBarry Smith . usrP - user context 1567d763cef2SBarry Smith 1568daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 1569daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 1570daf670e6SBarry Smith 1571d763cef2SBarry Smith Level: intermediate 1572d763cef2SBarry Smith 1573d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1574d763cef2SBarry Smith 1575d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1576d763cef2SBarry Smith @*/ 1577e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1578d763cef2SBarry Smith { 1579d763cef2SBarry Smith PetscFunctionBegin; 15800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1581e71120c6SJed Brown *(void**)usrP = ts->user; 1582d763cef2SBarry Smith PetscFunctionReturn(0); 1583d763cef2SBarry Smith } 1584d763cef2SBarry Smith 15854a2ae208SSatish Balay #undef __FUNCT__ 15864a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1587d763cef2SBarry Smith /*@ 1588b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1589d763cef2SBarry Smith 1590d763cef2SBarry Smith Not Collective 1591d763cef2SBarry Smith 1592d763cef2SBarry Smith Input Parameter: 1593d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1594d763cef2SBarry Smith 1595d763cef2SBarry Smith Output Parameter: 1596b8123daeSJed Brown . iter - number of steps completed so far 1597d763cef2SBarry Smith 1598d763cef2SBarry Smith Level: intermediate 1599d763cef2SBarry Smith 1600d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 16019be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 1602d763cef2SBarry Smith @*/ 16037087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1604d763cef2SBarry Smith { 1605d763cef2SBarry Smith PetscFunctionBegin; 16060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 16074482741eSBarry Smith PetscValidIntPointer(iter,2); 1608d763cef2SBarry Smith *iter = ts->steps; 1609d763cef2SBarry Smith PetscFunctionReturn(0); 1610d763cef2SBarry Smith } 1611d763cef2SBarry Smith 16124a2ae208SSatish Balay #undef __FUNCT__ 16134a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1614d763cef2SBarry Smith /*@ 1615d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1616d763cef2SBarry Smith as well as the initial time. 1617d763cef2SBarry Smith 16183f9fe445SBarry Smith Logically Collective on TS 1619d763cef2SBarry Smith 1620d763cef2SBarry Smith Input Parameters: 1621d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1622d763cef2SBarry Smith . initial_time - the initial time 1623d763cef2SBarry Smith - time_step - the size of the timestep 1624d763cef2SBarry Smith 1625d763cef2SBarry Smith Level: intermediate 1626d763cef2SBarry Smith 1627d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1628d763cef2SBarry Smith 1629d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1630d763cef2SBarry Smith @*/ 16317087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1632d763cef2SBarry Smith { 1633e144a568SJed Brown PetscErrorCode ierr; 1634e144a568SJed Brown 1635d763cef2SBarry Smith PetscFunctionBegin; 16360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1637e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1638d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1639d763cef2SBarry Smith PetscFunctionReturn(0); 1640d763cef2SBarry Smith } 1641d763cef2SBarry Smith 16424a2ae208SSatish Balay #undef __FUNCT__ 16434a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1644d763cef2SBarry Smith /*@ 1645d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1646d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1647d763cef2SBarry Smith 16483f9fe445SBarry Smith Logically Collective on TS 1649d763cef2SBarry Smith 1650d763cef2SBarry Smith Input Parameters: 1651d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1652d763cef2SBarry Smith - time_step - the size of the timestep 1653d763cef2SBarry Smith 1654d763cef2SBarry Smith Level: intermediate 1655d763cef2SBarry Smith 1656d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1657d763cef2SBarry Smith 1658d763cef2SBarry Smith .keywords: TS, set, timestep 1659d763cef2SBarry Smith @*/ 16607087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1661d763cef2SBarry Smith { 1662d763cef2SBarry Smith PetscFunctionBegin; 16630700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1664c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1665d763cef2SBarry Smith ts->time_step = time_step; 166631748224SBarry Smith ts->time_step_orig = time_step; 1667d763cef2SBarry Smith PetscFunctionReturn(0); 1668d763cef2SBarry Smith } 1669d763cef2SBarry Smith 16704a2ae208SSatish Balay #undef __FUNCT__ 1671a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1672a43b19c4SJed Brown /*@ 167349354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 167449354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 167549354f04SShri Abhyankar or just return at the final time TS computed. 1676a43b19c4SJed Brown 1677a43b19c4SJed Brown Logically Collective on TS 1678a43b19c4SJed Brown 1679a43b19c4SJed Brown Input Parameter: 1680a43b19c4SJed Brown + ts - the time-step context 168149354f04SShri Abhyankar - eftopt - exact final time option 1682a43b19c4SJed Brown 1683a43b19c4SJed Brown Level: beginner 1684a43b19c4SJed Brown 1685a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 1686a43b19c4SJed Brown @*/ 168749354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1688a43b19c4SJed Brown { 1689a43b19c4SJed Brown PetscFunctionBegin; 1690a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 169149354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 169249354f04SShri Abhyankar ts->exact_final_time = eftopt; 1693a43b19c4SJed Brown PetscFunctionReturn(0); 1694a43b19c4SJed Brown } 1695a43b19c4SJed Brown 1696a43b19c4SJed Brown #undef __FUNCT__ 16974a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1698d763cef2SBarry Smith /*@ 1699d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1700d763cef2SBarry Smith 1701d763cef2SBarry Smith Not Collective 1702d763cef2SBarry Smith 1703d763cef2SBarry Smith Input Parameter: 1704d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1705d763cef2SBarry Smith 1706d763cef2SBarry Smith Output Parameter: 1707d763cef2SBarry Smith . dt - the current timestep size 1708d763cef2SBarry Smith 1709d763cef2SBarry Smith Level: intermediate 1710d763cef2SBarry Smith 1711d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1712d763cef2SBarry Smith 1713d763cef2SBarry Smith .keywords: TS, get, timestep 1714d763cef2SBarry Smith @*/ 17157087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1716d763cef2SBarry Smith { 1717d763cef2SBarry Smith PetscFunctionBegin; 17180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1719f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1720d763cef2SBarry Smith *dt = ts->time_step; 1721d763cef2SBarry Smith PetscFunctionReturn(0); 1722d763cef2SBarry Smith } 1723d763cef2SBarry Smith 17244a2ae208SSatish Balay #undef __FUNCT__ 17254a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1726d8e5e3e6SSatish Balay /*@ 1727d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1728d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1729d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1730d763cef2SBarry Smith the solution at the next timestep has been calculated. 1731d763cef2SBarry Smith 1732d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1733d763cef2SBarry Smith 1734d763cef2SBarry Smith Input Parameter: 1735d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1736d763cef2SBarry Smith 1737d763cef2SBarry Smith Output Parameter: 1738d763cef2SBarry Smith . v - the vector containing the solution 1739d763cef2SBarry Smith 1740d763cef2SBarry Smith Level: intermediate 1741d763cef2SBarry Smith 1742d763cef2SBarry Smith .seealso: TSGetTimeStep() 1743d763cef2SBarry Smith 1744d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1745d763cef2SBarry Smith @*/ 17467087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1747d763cef2SBarry Smith { 1748d763cef2SBarry Smith PetscFunctionBegin; 17490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 17504482741eSBarry Smith PetscValidPointer(v,2); 17518737fe31SLisandro Dalcin *v = ts->vec_sol; 1752d763cef2SBarry Smith PetscFunctionReturn(0); 1753d763cef2SBarry Smith } 1754d763cef2SBarry Smith 1755c235aa8dSHong Zhang #undef __FUNCT__ 1756dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients" 1757c235aa8dSHong Zhang /*@ 1758dfb21088SHong Zhang TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 1759c235aa8dSHong Zhang 1760c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 1761c235aa8dSHong Zhang 1762c235aa8dSHong Zhang Input Parameter: 1763c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 1764c235aa8dSHong Zhang 1765c235aa8dSHong Zhang Output Parameter: 1766abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 1767abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 1768c235aa8dSHong Zhang 1769c235aa8dSHong Zhang Level: intermediate 1770c235aa8dSHong Zhang 1771c235aa8dSHong Zhang .seealso: TSGetTimeStep() 1772c235aa8dSHong Zhang 1773c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 1774c235aa8dSHong Zhang @*/ 1775dfb21088SHong Zhang PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 1776c235aa8dSHong Zhang { 1777c235aa8dSHong Zhang PetscFunctionBegin; 1778c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1779abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 1780abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 1781abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 1782c235aa8dSHong Zhang PetscFunctionReturn(0); 1783c235aa8dSHong Zhang } 1784c235aa8dSHong Zhang 1785bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 17864a2ae208SSatish Balay #undef __FUNCT__ 1787bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1788d8e5e3e6SSatish Balay /*@ 1789bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1790d763cef2SBarry Smith 1791bdad233fSMatthew Knepley Not collective 1792d763cef2SBarry Smith 1793bdad233fSMatthew Knepley Input Parameters: 1794bdad233fSMatthew Knepley + ts - The TS 1795bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1796d763cef2SBarry Smith .vb 17970910c330SBarry Smith U_t - A U = 0 (linear) 17980910c330SBarry Smith U_t - A(t) U = 0 (linear) 17990910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1800d763cef2SBarry Smith .ve 1801d763cef2SBarry Smith 1802d763cef2SBarry Smith Level: beginner 1803d763cef2SBarry Smith 1804bdad233fSMatthew Knepley .keywords: TS, problem type 1805bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1806d763cef2SBarry Smith @*/ 18077087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1808a7cc72afSBarry Smith { 18099e2a6581SJed Brown PetscErrorCode ierr; 18109e2a6581SJed Brown 1811d763cef2SBarry Smith PetscFunctionBegin; 18120700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1813bdad233fSMatthew Knepley ts->problem_type = type; 18149e2a6581SJed Brown if (type == TS_LINEAR) { 18159e2a6581SJed Brown SNES snes; 18169e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 18179e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 18189e2a6581SJed Brown } 1819d763cef2SBarry Smith PetscFunctionReturn(0); 1820d763cef2SBarry Smith } 1821d763cef2SBarry Smith 1822bdad233fSMatthew Knepley #undef __FUNCT__ 1823bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1824bdad233fSMatthew Knepley /*@C 1825bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1826bdad233fSMatthew Knepley 1827bdad233fSMatthew Knepley Not collective 1828bdad233fSMatthew Knepley 1829bdad233fSMatthew Knepley Input Parameter: 1830bdad233fSMatthew Knepley . ts - The TS 1831bdad233fSMatthew Knepley 1832bdad233fSMatthew Knepley Output Parameter: 1833bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1834bdad233fSMatthew Knepley .vb 1835089b2837SJed Brown M U_t = A U 1836089b2837SJed Brown M(t) U_t = A(t) U 1837b5abc632SBarry Smith F(t,U,U_t) 1838bdad233fSMatthew Knepley .ve 1839bdad233fSMatthew Knepley 1840bdad233fSMatthew Knepley Level: beginner 1841bdad233fSMatthew Knepley 1842bdad233fSMatthew Knepley .keywords: TS, problem type 1843bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1844bdad233fSMatthew Knepley @*/ 18457087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1846a7cc72afSBarry Smith { 1847bdad233fSMatthew Knepley PetscFunctionBegin; 18480700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 18494482741eSBarry Smith PetscValidIntPointer(type,2); 1850bdad233fSMatthew Knepley *type = ts->problem_type; 1851bdad233fSMatthew Knepley PetscFunctionReturn(0); 1852bdad233fSMatthew Knepley } 1853d763cef2SBarry Smith 18544a2ae208SSatish Balay #undef __FUNCT__ 18554a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1856d763cef2SBarry Smith /*@ 1857d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1858d763cef2SBarry Smith of a timestepper. 1859d763cef2SBarry Smith 1860d763cef2SBarry Smith Collective on TS 1861d763cef2SBarry Smith 1862d763cef2SBarry Smith Input Parameter: 1863d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1864d763cef2SBarry Smith 1865d763cef2SBarry Smith Notes: 1866d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1867d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1868d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1869d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1870d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1871d763cef2SBarry Smith 1872d763cef2SBarry Smith Level: advanced 1873d763cef2SBarry Smith 1874d763cef2SBarry Smith .keywords: TS, timestep, setup 1875d763cef2SBarry Smith 1876d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1877d763cef2SBarry Smith @*/ 18787087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1879d763cef2SBarry Smith { 1880dfbe8321SBarry Smith PetscErrorCode ierr; 18816c6b9e74SPeter Brune DM dm; 18826c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 1883d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 18846c6b9e74SPeter Brune TSIJacobian ijac; 18856c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1886d763cef2SBarry Smith 1887d763cef2SBarry Smith PetscFunctionBegin; 18880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1889277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1890277b19d0SLisandro Dalcin 18912c18e0fdSBarry Smith ts->total_steps = 0; 18927adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 18939596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1894d763cef2SBarry Smith } 1895277b19d0SLisandro Dalcin 1896277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1897277b19d0SLisandro Dalcin 18981c3436cfSJed Brown 1899552698daSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 1900277b19d0SLisandro Dalcin 1901e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 1902e1244c69SJed Brown Mat Amat,Pmat; 1903e1244c69SJed Brown SNES snes; 1904e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1905e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 1906e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 1907e1244c69SJed Brown * have displaced the RHS matrix */ 1908e1244c69SJed Brown if (Amat == ts->Arhs) { 1909e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 1910e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 1911e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 1912e1244c69SJed Brown } 1913e1244c69SJed Brown if (Pmat == ts->Brhs) { 1914e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 1915e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 1916e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 1917e1244c69SJed Brown } 1918e1244c69SJed Brown } 1919277b19d0SLisandro Dalcin if (ts->ops->setup) { 1920000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1921277b19d0SLisandro Dalcin } 1922277b19d0SLisandro Dalcin 19236c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 19246c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 19256c6b9e74SPeter Brune */ 19266c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 19270298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 19286c6b9e74SPeter Brune if (!func) { 19296c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 19306c6b9e74SPeter Brune } 19316c6b9e74SPeter Brune /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 19326c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 19336c6b9e74SPeter Brune */ 19340298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 19350298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 19360298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 19376c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 19386c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 19396c6b9e74SPeter Brune } 1940277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1941277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1942277b19d0SLisandro Dalcin } 1943277b19d0SLisandro Dalcin 1944277b19d0SLisandro Dalcin #undef __FUNCT__ 1945f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp" 1946f6a906c0SBarry Smith /*@ 1947f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 1948f6a906c0SBarry Smith of an adjoint solver 1949f6a906c0SBarry Smith 1950f6a906c0SBarry Smith Collective on TS 1951f6a906c0SBarry Smith 1952f6a906c0SBarry Smith Input Parameter: 1953f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 1954f6a906c0SBarry Smith 1955f6a906c0SBarry Smith Level: advanced 1956f6a906c0SBarry Smith 1957f6a906c0SBarry Smith .keywords: TS, timestep, setup 1958f6a906c0SBarry Smith 1959947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 1960f6a906c0SBarry Smith @*/ 1961f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 1962f6a906c0SBarry Smith { 1963f6a906c0SBarry Smith PetscErrorCode ierr; 1964f6a906c0SBarry Smith 1965f6a906c0SBarry Smith PetscFunctionBegin; 1966f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1967f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 1968dfb21088SHong Zhang if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 1969d8151eeaSBarry Smith 1970947abb85SHong Zhang if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 1971d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 1972d8151eeaSBarry Smith if (ts->vecs_sensip){ 1973d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 1974d8151eeaSBarry Smith } 1975947abb85SHong Zhang } 1976d8151eeaSBarry Smith 197742f2b339SBarry Smith if (ts->ops->adjointsetup) { 197842f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 1979f6a906c0SBarry Smith } 1980f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 1981f6a906c0SBarry Smith PetscFunctionReturn(0); 1982f6a906c0SBarry Smith } 1983f6a906c0SBarry Smith 1984f6a906c0SBarry Smith #undef __FUNCT__ 1985277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1986277b19d0SLisandro Dalcin /*@ 1987277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1988277b19d0SLisandro Dalcin 1989277b19d0SLisandro Dalcin Collective on TS 1990277b19d0SLisandro Dalcin 1991277b19d0SLisandro Dalcin Input Parameter: 1992277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1993277b19d0SLisandro Dalcin 1994277b19d0SLisandro Dalcin Level: beginner 1995277b19d0SLisandro Dalcin 1996277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1997277b19d0SLisandro Dalcin 1998277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1999277b19d0SLisandro Dalcin @*/ 2000277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2001277b19d0SLisandro Dalcin { 2002277b19d0SLisandro Dalcin PetscErrorCode ierr; 2003277b19d0SLisandro Dalcin 2004277b19d0SLisandro Dalcin PetscFunctionBegin; 2005277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2006b18ea86cSHong Zhang 2007277b19d0SLisandro Dalcin if (ts->ops->reset) { 2008277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2009277b19d0SLisandro Dalcin } 2010277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2011e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2012bbd56ea5SKarl Rupp 20134e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 20144e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2015214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 20166bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2017e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2018e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 201938637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2020bbd56ea5SKarl Rupp 2021947abb85SHong Zhang if (ts->vec_costintegral) { 2022d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2023d8151eeaSBarry Smith if (ts->vecs_drdp){ 2024d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2025d8151eeaSBarry Smith } 2026947abb85SHong Zhang } 2027d8151eeaSBarry Smith ts->vecs_sensi = NULL; 2028d8151eeaSBarry Smith ts->vecs_sensip = NULL; 2029ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 20302c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 203136eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2032277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2033d763cef2SBarry Smith PetscFunctionReturn(0); 2034d763cef2SBarry Smith } 2035d763cef2SBarry Smith 20364a2ae208SSatish Balay #undef __FUNCT__ 20374a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 2038d8e5e3e6SSatish Balay /*@ 2039d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2040d763cef2SBarry Smith with TSCreate(). 2041d763cef2SBarry Smith 2042d763cef2SBarry Smith Collective on TS 2043d763cef2SBarry Smith 2044d763cef2SBarry Smith Input Parameter: 2045d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2046d763cef2SBarry Smith 2047d763cef2SBarry Smith Level: beginner 2048d763cef2SBarry Smith 2049d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2050d763cef2SBarry Smith 2051d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2052d763cef2SBarry Smith @*/ 20536bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2054d763cef2SBarry Smith { 20556849ba73SBarry Smith PetscErrorCode ierr; 2056d763cef2SBarry Smith 2057d763cef2SBarry Smith PetscFunctionBegin; 20586bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 20596bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 20606bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2061d763cef2SBarry Smith 20626bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2063277b19d0SLisandro Dalcin 2064e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2065e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 20666bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 20676d4c513bSLisandro Dalcin 2068bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2069bc952696SBarry Smith 207084df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 2071aeb4809dSShri Abhyankar if ((*ts)->event) { 2072aeb4809dSShri Abhyankar ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr); 2073aeb4809dSShri Abhyankar } 20746bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 20756bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 20766bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 20770dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 20786d4c513bSLisandro Dalcin 2079a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2080d763cef2SBarry Smith PetscFunctionReturn(0); 2081d763cef2SBarry Smith } 2082d763cef2SBarry Smith 20834a2ae208SSatish Balay #undef __FUNCT__ 20844a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 2085d8e5e3e6SSatish Balay /*@ 2086d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2087d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2088d763cef2SBarry Smith 2089d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2090d763cef2SBarry Smith 2091d763cef2SBarry Smith Input Parameter: 2092d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2093d763cef2SBarry Smith 2094d763cef2SBarry Smith Output Parameter: 2095d763cef2SBarry Smith . snes - the nonlinear solver context 2096d763cef2SBarry Smith 2097d763cef2SBarry Smith Notes: 2098d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2099d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 210094b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2101d763cef2SBarry Smith 2102d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 21030298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2104d763cef2SBarry Smith 2105d763cef2SBarry Smith Level: beginner 2106d763cef2SBarry Smith 2107d763cef2SBarry Smith .keywords: timestep, get, SNES 2108d763cef2SBarry Smith @*/ 21097087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2110d763cef2SBarry Smith { 2111d372ba47SLisandro Dalcin PetscErrorCode ierr; 2112d372ba47SLisandro Dalcin 2113d763cef2SBarry Smith PetscFunctionBegin; 21140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21154482741eSBarry Smith PetscValidPointer(snes,2); 2116d372ba47SLisandro Dalcin if (!ts->snes) { 2117ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 21180298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 21193bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2120d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2121496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 21229e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 21239e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 21249e2a6581SJed Brown } 2125d372ba47SLisandro Dalcin } 2126d763cef2SBarry Smith *snes = ts->snes; 2127d763cef2SBarry Smith PetscFunctionReturn(0); 2128d763cef2SBarry Smith } 2129d763cef2SBarry Smith 21304a2ae208SSatish Balay #undef __FUNCT__ 2131deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES" 2132deb2cd25SJed Brown /*@ 2133deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2134deb2cd25SJed Brown 2135deb2cd25SJed Brown Collective 2136deb2cd25SJed Brown 2137deb2cd25SJed Brown Input Parameter: 2138deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2139deb2cd25SJed Brown - snes - the nonlinear solver context 2140deb2cd25SJed Brown 2141deb2cd25SJed Brown Notes: 2142deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2143deb2cd25SJed Brown 2144deb2cd25SJed Brown Level: developer 2145deb2cd25SJed Brown 2146deb2cd25SJed Brown .keywords: timestep, set, SNES 2147deb2cd25SJed Brown @*/ 2148deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2149deb2cd25SJed Brown { 2150deb2cd25SJed Brown PetscErrorCode ierr; 2151d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2152deb2cd25SJed Brown 2153deb2cd25SJed Brown PetscFunctionBegin; 2154deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2155deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2156deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2157deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2158bbd56ea5SKarl Rupp 2159deb2cd25SJed Brown ts->snes = snes; 2160bbd56ea5SKarl Rupp 21610298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 21620298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2163740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 21640298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2165740132f1SEmil Constantinescu } 2166deb2cd25SJed Brown PetscFunctionReturn(0); 2167deb2cd25SJed Brown } 2168deb2cd25SJed Brown 2169deb2cd25SJed Brown #undef __FUNCT__ 217094b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 2171d8e5e3e6SSatish Balay /*@ 217294b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2173d763cef2SBarry Smith a TS (timestepper) context. 2174d763cef2SBarry Smith 217594b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2176d763cef2SBarry Smith 2177d763cef2SBarry Smith Input Parameter: 2178d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2179d763cef2SBarry Smith 2180d763cef2SBarry Smith Output Parameter: 218194b7f48cSBarry Smith . ksp - the nonlinear solver context 2182d763cef2SBarry Smith 2183d763cef2SBarry Smith Notes: 218494b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2185d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2186d763cef2SBarry Smith KSP and PC contexts as well. 2187d763cef2SBarry Smith 218894b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 21890298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2190d763cef2SBarry Smith 2191d763cef2SBarry Smith Level: beginner 2192d763cef2SBarry Smith 219394b7f48cSBarry Smith .keywords: timestep, get, KSP 2194d763cef2SBarry Smith @*/ 21957087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2196d763cef2SBarry Smith { 2197d372ba47SLisandro Dalcin PetscErrorCode ierr; 2198089b2837SJed Brown SNES snes; 2199d372ba47SLisandro Dalcin 2200d763cef2SBarry Smith PetscFunctionBegin; 22010700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22024482741eSBarry Smith PetscValidPointer(ksp,2); 220317186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2204e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2205089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2206089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2207d763cef2SBarry Smith PetscFunctionReturn(0); 2208d763cef2SBarry Smith } 2209d763cef2SBarry Smith 2210d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2211d763cef2SBarry Smith 22124a2ae208SSatish Balay #undef __FUNCT__ 2213adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 2214adb62b0dSMatthew Knepley /*@ 2215adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2216adb62b0dSMatthew Knepley maximum time for iteration. 2217adb62b0dSMatthew Knepley 22183f9fe445SBarry Smith Not Collective 2219adb62b0dSMatthew Knepley 2220adb62b0dSMatthew Knepley Input Parameters: 2221adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 22220298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 22230298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2224adb62b0dSMatthew Knepley 2225adb62b0dSMatthew Knepley Level: intermediate 2226adb62b0dSMatthew Knepley 2227adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2228adb62b0dSMatthew Knepley @*/ 22297087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2230adb62b0dSMatthew Knepley { 2231adb62b0dSMatthew Knepley PetscFunctionBegin; 22320700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2233abc0a331SBarry Smith if (maxsteps) { 22344482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2235adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2236adb62b0dSMatthew Knepley } 2237abc0a331SBarry Smith if (maxtime) { 22384482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2239adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2240adb62b0dSMatthew Knepley } 2241adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2242adb62b0dSMatthew Knepley } 2243adb62b0dSMatthew Knepley 2244adb62b0dSMatthew Knepley #undef __FUNCT__ 22454a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 2246d763cef2SBarry Smith /*@ 2247d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2248d763cef2SBarry Smith maximum time for iteration. 2249d763cef2SBarry Smith 22503f9fe445SBarry Smith Logically Collective on TS 2251d763cef2SBarry Smith 2252d763cef2SBarry Smith Input Parameters: 2253d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2254d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2255d763cef2SBarry Smith - maxtime - final time to iterate to 2256d763cef2SBarry Smith 2257d763cef2SBarry Smith Options Database Keys: 2258d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 22593bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2260d763cef2SBarry Smith 2261d763cef2SBarry Smith Notes: 2262d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2263d763cef2SBarry Smith 2264d763cef2SBarry Smith Level: intermediate 2265d763cef2SBarry Smith 2266d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2267a43b19c4SJed Brown 2268a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2269d763cef2SBarry Smith @*/ 22707087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2271d763cef2SBarry Smith { 2272d763cef2SBarry Smith PetscFunctionBegin; 22730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2274c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2275c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 227639b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 227739b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2278d763cef2SBarry Smith PetscFunctionReturn(0); 2279d763cef2SBarry Smith } 2280d763cef2SBarry Smith 22814a2ae208SSatish Balay #undef __FUNCT__ 22824a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 2283d763cef2SBarry Smith /*@ 2284d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2285d763cef2SBarry Smith for use by the TS routines. 2286d763cef2SBarry Smith 22873f9fe445SBarry Smith Logically Collective on TS and Vec 2288d763cef2SBarry Smith 2289d763cef2SBarry Smith Input Parameters: 2290d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 22910910c330SBarry Smith - u - the solution vector 2292d763cef2SBarry Smith 2293d763cef2SBarry Smith Level: beginner 2294d763cef2SBarry Smith 2295d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2296d763cef2SBarry Smith @*/ 22970910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2298d763cef2SBarry Smith { 22998737fe31SLisandro Dalcin PetscErrorCode ierr; 2300496e6a7aSJed Brown DM dm; 23018737fe31SLisandro Dalcin 2302d763cef2SBarry Smith PetscFunctionBegin; 23030700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23040910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 23050910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 23066bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2307bbd56ea5SKarl Rupp 23080910c330SBarry Smith ts->vec_sol = u; 2309bbd56ea5SKarl Rupp 2310496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 23110910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2312d763cef2SBarry Smith PetscFunctionReturn(0); 2313d763cef2SBarry Smith } 2314d763cef2SBarry Smith 2315e74ef692SMatthew Knepley #undef __FUNCT__ 231673b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps" 231773b18844SBarry Smith /*@ 231873b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 231973b18844SBarry Smith 232073b18844SBarry Smith Logically Collective on TS 232173b18844SBarry Smith 232273b18844SBarry Smith Input Parameters: 232373b18844SBarry Smith + ts - the TS context obtained from TSCreate() 232473b18844SBarry Smith . steps - number of steps to use 232573b18844SBarry Smith 232673b18844SBarry Smith Level: intermediate 232773b18844SBarry Smith 232873b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 232973b18844SBarry Smith so as to integrate back to less than the original timestep 233073b18844SBarry Smith 233173b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 233273b18844SBarry Smith 233373b18844SBarry Smith .seealso: TSSetExactFinalTime() 233473b18844SBarry Smith @*/ 233573b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 233673b18844SBarry Smith { 233773b18844SBarry Smith PetscFunctionBegin; 233873b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 233973b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 234073b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 234173b18844SBarry Smith if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps"); 234273b18844SBarry Smith ts->adjoint_max_steps = steps; 234373b18844SBarry Smith PetscFunctionReturn(0); 234473b18844SBarry Smith } 234573b18844SBarry Smith 234673b18844SBarry Smith #undef __FUNCT__ 2347dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients" 2348c235aa8dSHong Zhang /*@ 2349dfb21088SHong Zhang TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters 23500cf82b59SBarry Smith for use by the TSAdjoint routines. 2351c235aa8dSHong Zhang 2352c235aa8dSHong Zhang Logically Collective on TS and Vec 2353c235aa8dSHong Zhang 2354c235aa8dSHong Zhang Input Parameters: 2355c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2356abc2977eSBarry Smith . lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector 2357abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2358c235aa8dSHong Zhang 2359c235aa8dSHong Zhang Level: beginner 2360c235aa8dSHong Zhang 2361abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 23620cf82b59SBarry Smith 2363c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2364c235aa8dSHong Zhang @*/ 2365dfb21088SHong Zhang PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2366c235aa8dSHong Zhang { 2367c235aa8dSHong Zhang PetscFunctionBegin; 2368c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2369abc2977eSBarry Smith PetscValidPointer(lambda,2); 2370abc2977eSBarry Smith ts->vecs_sensi = lambda; 2371abc2977eSBarry Smith ts->vecs_sensip = mu; 2372dfb21088SHong Zhang if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand"); 2373abc2977eSBarry Smith ts->numcost = numcost; 2374ad8e2604SHong Zhang PetscFunctionReturn(0); 2375ad8e2604SHong Zhang } 2376ad8e2604SHong Zhang 2377ad8e2604SHong Zhang #undef __FUNCT__ 23785bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian" 2379ad8e2604SHong Zhang /*@C 23800cf82b59SBarry Smith TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix. 2381ad8e2604SHong Zhang 2382ad8e2604SHong Zhang Logically Collective on TS 2383ad8e2604SHong Zhang 2384ad8e2604SHong Zhang Input Parameters: 2385ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2386ad8e2604SHong Zhang - func - The function 2387ad8e2604SHong Zhang 2388ad8e2604SHong Zhang Calling sequence of func: 23890cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 239005755b9cSHong Zhang + t - current timestep 23910cf82b59SBarry Smith . y - input vector (current ODE solution) 239205755b9cSHong Zhang . A - output matrix 239305755b9cSHong Zhang - ctx - [optional] user-defined function context 2394ad8e2604SHong Zhang 2395ad8e2604SHong Zhang Level: intermediate 2396ad8e2604SHong Zhang 23970cf82b59SBarry Smith Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p 23980cf82b59SBarry Smith 2399ad8e2604SHong Zhang .keywords: TS, sensitivity 2400ad8e2604SHong Zhang .seealso: 2401ad8e2604SHong Zhang @*/ 24025bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2403ad8e2604SHong Zhang { 2404ad8e2604SHong Zhang PetscErrorCode ierr; 2405ad8e2604SHong Zhang 2406ad8e2604SHong Zhang PetscFunctionBegin; 2407ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2408ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2409ad8e2604SHong Zhang 2410ad8e2604SHong Zhang ts->rhsjacobianp = func; 2411ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 2412ad8e2604SHong Zhang if(Amat) { 2413ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2414ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2415ad8e2604SHong Zhang ts->Jacp = Amat; 2416ad8e2604SHong Zhang } 2417ad8e2604SHong Zhang PetscFunctionReturn(0); 2418ad8e2604SHong Zhang } 2419ad8e2604SHong Zhang 2420ad8e2604SHong Zhang #undef __FUNCT__ 24215bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian" 24220cf82b59SBarry Smith /*@C 24235bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 2424ad8e2604SHong Zhang 2425ad8e2604SHong Zhang Collective on TS 2426ad8e2604SHong Zhang 2427ad8e2604SHong Zhang Input Parameters: 2428ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 2429ad8e2604SHong Zhang 2430ad8e2604SHong Zhang Level: developer 2431ad8e2604SHong Zhang 2432ad8e2604SHong Zhang .keywords: TS, sensitivity 24335bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 2434ad8e2604SHong Zhang @*/ 24355bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 2436ad8e2604SHong Zhang { 2437ad8e2604SHong Zhang PetscErrorCode ierr; 2438ad8e2604SHong Zhang 2439ad8e2604SHong Zhang PetscFunctionBegin; 2440ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2441ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 2442ad8e2604SHong Zhang PetscValidPointer(Amat,4); 2443ad8e2604SHong Zhang 2444ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 2445ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 2446ad8e2604SHong Zhang PetscStackPop; 2447c235aa8dSHong Zhang PetscFunctionReturn(0); 2448c235aa8dSHong Zhang } 2449c235aa8dSHong Zhang 2450c235aa8dSHong Zhang #undef __FUNCT__ 2451dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand" 24526fd0887fSHong Zhang /*@C 2453dfb21088SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 24546fd0887fSHong Zhang 24556fd0887fSHong Zhang Logically Collective on TS 24566fd0887fSHong Zhang 24576fd0887fSHong Zhang Input Parameters: 24586fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 2459abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 24600cf82b59SBarry Smith . rf - routine for evaluating the integrand function 2461b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 2462b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 2463b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 24646fd0887fSHong Zhang 24650cf82b59SBarry Smith Calling sequence of rf: 24660cf82b59SBarry Smith $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 24676fd0887fSHong Zhang 24686fd0887fSHong Zhang + t - current timestep 24690cf82b59SBarry Smith . y - input vector 24700cf82b59SBarry Smith . f - function result; one vector entry for each cost function 24716fd0887fSHong Zhang - ctx - [optional] user-defined function context 24726fd0887fSHong Zhang 2473b612ec54SBarry Smith Calling sequence of drdyf: 24740cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 2475b612ec54SBarry Smith 2476b612ec54SBarry Smith Calling sequence of drdpf: 24770cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 2478b612ec54SBarry Smith 2479b612ec54SBarry Smith Level: intermediate 24806fd0887fSHong Zhang 2481abc2977eSBarry Smith Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 24820cf82b59SBarry Smith 24836fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 24846fd0887fSHong Zhang 2485dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 24866fd0887fSHong Zhang @*/ 2487dfb21088SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 2488d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 2489d8151eeaSBarry Smith PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx) 24906fd0887fSHong Zhang { 24916fd0887fSHong Zhang PetscErrorCode ierr; 24926fd0887fSHong Zhang 24936fd0887fSHong Zhang PetscFunctionBegin; 24946fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2495dfb21088SHong Zhang if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()"); 2496c72ed514SHong Zhang if (!ts->numcost) ts->numcost=numcost; 24976fd0887fSHong Zhang 2498abc2977eSBarry Smith ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 24992c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 25000cf82b59SBarry Smith ts->costintegrand = rf; 250105755b9cSHong Zhang ts->costintegrandctx = ctx; 2502b612ec54SBarry Smith ts->drdyfunction = drdyf; 2503b612ec54SBarry Smith ts->drdpfunction = drdpf; 25046fd0887fSHong Zhang PetscFunctionReturn(0); 25056fd0887fSHong Zhang } 25066fd0887fSHong Zhang 25076fd0887fSHong Zhang #undef __FUNCT__ 2508dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral" 250936eaed60SHong Zhang /*@ 2510dfb21088SHong Zhang TSGetCostIntegral - Returns the values of the integral term in the cost functions. 251136eaed60SHong Zhang It is valid to call the routine after a backward run. 251236eaed60SHong Zhang 251336eaed60SHong Zhang Not Collective 251436eaed60SHong Zhang 251536eaed60SHong Zhang Input Parameter: 251636eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 251736eaed60SHong Zhang 251836eaed60SHong Zhang Output Parameter: 25192c39e106SBarry Smith . v - the vector containing the integrals for each cost function 252036eaed60SHong Zhang 252136eaed60SHong Zhang Level: intermediate 252236eaed60SHong Zhang 2523dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 252436eaed60SHong Zhang 252536eaed60SHong Zhang .keywords: TS, sensitivity analysis 252636eaed60SHong Zhang @*/ 2527dfb21088SHong Zhang PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 252836eaed60SHong Zhang { 252936eaed60SHong Zhang PetscFunctionBegin; 253036eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 253136eaed60SHong Zhang PetscValidPointer(v,2); 25322c39e106SBarry Smith *v = ts->vec_costintegral; 253336eaed60SHong Zhang PetscFunctionReturn(0); 253436eaed60SHong Zhang } 253536eaed60SHong Zhang 253636eaed60SHong Zhang #undef __FUNCT__ 2537d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand" 25386fd0887fSHong Zhang /*@ 25392c39e106SBarry Smith TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 25406fd0887fSHong Zhang 25416fd0887fSHong Zhang Input Parameters: 25426fd0887fSHong Zhang + ts - the TS context 25436fd0887fSHong Zhang . t - current time 25440cf82b59SBarry Smith - y - state vector, i.e. current solution 25456fd0887fSHong Zhang 25466fd0887fSHong Zhang Output Parameter: 2547abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 25486fd0887fSHong Zhang 25496fd0887fSHong Zhang Note: 25506fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 25516fd0887fSHong Zhang is used internally within the sensitivity analysis context. 25526fd0887fSHong Zhang 25536fd0887fSHong Zhang Level: developer 25546fd0887fSHong Zhang 25556fd0887fSHong Zhang .keywords: TS, compute 25566fd0887fSHong Zhang 2557dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 25586fd0887fSHong Zhang @*/ 25590cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 25606fd0887fSHong Zhang { 25616fd0887fSHong Zhang PetscErrorCode ierr; 25626fd0887fSHong Zhang 25636fd0887fSHong Zhang PetscFunctionBegin; 25646fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25650cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 25666fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 25676fd0887fSHong Zhang 25680cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 2569e4680132SHong Zhang if (ts->costintegrand) { 2570e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 25710cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 25726fd0887fSHong Zhang PetscStackPop; 25736fd0887fSHong Zhang } else { 25746fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 25756fd0887fSHong Zhang } 25766fd0887fSHong Zhang 25770cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 25786fd0887fSHong Zhang PetscFunctionReturn(0); 25796fd0887fSHong Zhang } 25806fd0887fSHong Zhang 25816fd0887fSHong Zhang #undef __FUNCT__ 2582d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction" 258305755b9cSHong Zhang /*@ 2584d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 258505755b9cSHong Zhang 258605755b9cSHong Zhang Collective on TS 258705755b9cSHong Zhang 258805755b9cSHong Zhang Input Parameters: 258905755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 259005755b9cSHong Zhang 259105755b9cSHong Zhang Notes: 2592d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 259305755b9cSHong Zhang so most users would not generally call this routine themselves. 259405755b9cSHong Zhang 259505755b9cSHong Zhang Level: developer 259605755b9cSHong Zhang 259705755b9cSHong Zhang .keywords: TS, sensitivity 2598d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 259905755b9cSHong Zhang @*/ 26000cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 260105755b9cSHong Zhang { 260205755b9cSHong Zhang PetscErrorCode ierr; 260305755b9cSHong Zhang 260405755b9cSHong Zhang PetscFunctionBegin; 260505755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 26060cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 260705755b9cSHong Zhang 260805755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 26090cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 261005755b9cSHong Zhang PetscStackPop; 261105755b9cSHong Zhang PetscFunctionReturn(0); 261205755b9cSHong Zhang } 261305755b9cSHong Zhang 261405755b9cSHong Zhang #undef __FUNCT__ 2615d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction" 261605755b9cSHong Zhang /*@ 2617d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 261805755b9cSHong Zhang 261905755b9cSHong Zhang Collective on TS 262005755b9cSHong Zhang 262105755b9cSHong Zhang Input Parameters: 262205755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 262305755b9cSHong Zhang 262405755b9cSHong Zhang Notes: 262505755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 262605755b9cSHong Zhang so most users would not generally call this routine themselves. 262705755b9cSHong Zhang 262805755b9cSHong Zhang Level: developer 262905755b9cSHong Zhang 263005755b9cSHong Zhang .keywords: TS, sensitivity 2631d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 263205755b9cSHong Zhang @*/ 26330cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 263405755b9cSHong Zhang { 263505755b9cSHong Zhang PetscErrorCode ierr; 263605755b9cSHong Zhang 263705755b9cSHong Zhang PetscFunctionBegin; 263805755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 26390cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 264005755b9cSHong Zhang 264105755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 26420cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 264305755b9cSHong Zhang PetscStackPop; 264405755b9cSHong Zhang PetscFunctionReturn(0); 264505755b9cSHong Zhang } 264605755b9cSHong Zhang 264705755b9cSHong Zhang #undef __FUNCT__ 2648e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 2649ac226902SBarry Smith /*@C 2650000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 26513f2090d5SJed Brown called once at the beginning of each time step. 2652000e7ae3SMatthew Knepley 26533f9fe445SBarry Smith Logically Collective on TS 2654000e7ae3SMatthew Knepley 2655000e7ae3SMatthew Knepley Input Parameters: 2656000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2657000e7ae3SMatthew Knepley - func - The function 2658000e7ae3SMatthew Knepley 2659000e7ae3SMatthew Knepley Calling sequence of func: 2660000e7ae3SMatthew Knepley . func (TS ts); 2661000e7ae3SMatthew Knepley 2662000e7ae3SMatthew Knepley Level: intermediate 2663000e7ae3SMatthew Knepley 2664b8123daeSJed Brown Note: 2665b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 2666b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 2667b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 2668b8123daeSJed Brown 2669000e7ae3SMatthew Knepley .keywords: TS, timestep 26709be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 2671000e7ae3SMatthew Knepley @*/ 26727087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2673000e7ae3SMatthew Knepley { 2674000e7ae3SMatthew Knepley PetscFunctionBegin; 26750700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2676ae60f76fSBarry Smith ts->prestep = func; 2677000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2678000e7ae3SMatthew Knepley } 2679000e7ae3SMatthew Knepley 2680e74ef692SMatthew Knepley #undef __FUNCT__ 26813f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 268209ee8438SJed Brown /*@ 26833f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 26843f2090d5SJed Brown 26853f2090d5SJed Brown Collective on TS 26863f2090d5SJed Brown 26873f2090d5SJed Brown Input Parameters: 26883f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 26893f2090d5SJed Brown 26903f2090d5SJed Brown Notes: 26913f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 26923f2090d5SJed Brown so most users would not generally call this routine themselves. 26933f2090d5SJed Brown 26943f2090d5SJed Brown Level: developer 26953f2090d5SJed Brown 26963f2090d5SJed Brown .keywords: TS, timestep 26979be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 26983f2090d5SJed Brown @*/ 26997087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 27003f2090d5SJed Brown { 27013f2090d5SJed Brown PetscErrorCode ierr; 27023f2090d5SJed Brown 27033f2090d5SJed Brown PetscFunctionBegin; 27040700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2705ae60f76fSBarry Smith if (ts->prestep) { 2706ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 2707312ce896SJed Brown } 27083f2090d5SJed Brown PetscFunctionReturn(0); 27093f2090d5SJed Brown } 27103f2090d5SJed Brown 27113f2090d5SJed Brown #undef __FUNCT__ 2712b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 2713b8123daeSJed Brown /*@C 2714b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 2715b8123daeSJed Brown called once at the beginning of each stage. 2716b8123daeSJed Brown 2717b8123daeSJed Brown Logically Collective on TS 2718b8123daeSJed Brown 2719b8123daeSJed Brown Input Parameters: 2720b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 2721b8123daeSJed Brown - func - The function 2722b8123daeSJed Brown 2723b8123daeSJed Brown Calling sequence of func: 2724b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 2725b8123daeSJed Brown 2726b8123daeSJed Brown Level: intermediate 2727b8123daeSJed Brown 2728b8123daeSJed Brown Note: 2729b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2730b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2731b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2732b8123daeSJed Brown 2733b8123daeSJed Brown .keywords: TS, timestep 27349be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2735b8123daeSJed Brown @*/ 2736b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2737b8123daeSJed Brown { 2738b8123daeSJed Brown PetscFunctionBegin; 2739b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2740ae60f76fSBarry Smith ts->prestage = func; 2741b8123daeSJed Brown PetscFunctionReturn(0); 2742b8123daeSJed Brown } 2743b8123daeSJed Brown 2744b8123daeSJed Brown #undef __FUNCT__ 27459be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage" 27469be3e283SDebojyoti Ghosh /*@C 27479be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 27489be3e283SDebojyoti Ghosh called once at the end of each stage. 27499be3e283SDebojyoti Ghosh 27509be3e283SDebojyoti Ghosh Logically Collective on TS 27519be3e283SDebojyoti Ghosh 27529be3e283SDebojyoti Ghosh Input Parameters: 27539be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 27549be3e283SDebojyoti Ghosh - func - The function 27559be3e283SDebojyoti Ghosh 27569be3e283SDebojyoti Ghosh Calling sequence of func: 27579be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 27589be3e283SDebojyoti Ghosh 27599be3e283SDebojyoti Ghosh Level: intermediate 27609be3e283SDebojyoti Ghosh 27619be3e283SDebojyoti Ghosh Note: 27629be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 27639be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 27649be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 27659be3e283SDebojyoti Ghosh 27669be3e283SDebojyoti Ghosh .keywords: TS, timestep 27679be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 27689be3e283SDebojyoti Ghosh @*/ 27699be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 27709be3e283SDebojyoti Ghosh { 27719be3e283SDebojyoti Ghosh PetscFunctionBegin; 27729be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 27739be3e283SDebojyoti Ghosh ts->poststage = func; 27749be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 27759be3e283SDebojyoti Ghosh } 27769be3e283SDebojyoti Ghosh 27779be3e283SDebojyoti Ghosh #undef __FUNCT__ 2778b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 2779b8123daeSJed Brown /*@ 2780b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2781b8123daeSJed Brown 2782b8123daeSJed Brown Collective on TS 2783b8123daeSJed Brown 2784b8123daeSJed Brown Input Parameters: 2785b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 27869be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 2787b8123daeSJed Brown 2788b8123daeSJed Brown Notes: 2789b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 2790b8123daeSJed Brown most users would not generally call this routine themselves. 2791b8123daeSJed Brown 2792b8123daeSJed Brown Level: developer 2793b8123daeSJed Brown 2794b8123daeSJed Brown .keywords: TS, timestep 27959be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 2796b8123daeSJed Brown @*/ 2797b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2798b8123daeSJed Brown { 2799b8123daeSJed Brown PetscErrorCode ierr; 2800b8123daeSJed Brown 2801b8123daeSJed Brown PetscFunctionBegin; 2802b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2803ae60f76fSBarry Smith if (ts->prestage) { 2804ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2805b8123daeSJed Brown } 2806b8123daeSJed Brown PetscFunctionReturn(0); 2807b8123daeSJed Brown } 2808b8123daeSJed Brown 2809b8123daeSJed Brown #undef __FUNCT__ 28109be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage" 28119be3e283SDebojyoti Ghosh /*@ 28129be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 28139be3e283SDebojyoti Ghosh 28149be3e283SDebojyoti Ghosh Collective on TS 28159be3e283SDebojyoti Ghosh 28169be3e283SDebojyoti Ghosh Input Parameters: 28179be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 28189be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 28199be3e283SDebojyoti Ghosh stageindex - Stage number 28209be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 28219be3e283SDebojyoti Ghosh of stages) with the stage solutions 28229be3e283SDebojyoti Ghosh 28239be3e283SDebojyoti Ghosh Notes: 28249be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 28259be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 28269be3e283SDebojyoti Ghosh 28279be3e283SDebojyoti Ghosh Level: developer 28289be3e283SDebojyoti Ghosh 28299be3e283SDebojyoti Ghosh .keywords: TS, timestep 28309be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 28319be3e283SDebojyoti Ghosh @*/ 28329be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 28339be3e283SDebojyoti Ghosh { 28349be3e283SDebojyoti Ghosh PetscErrorCode ierr; 28359be3e283SDebojyoti Ghosh 28369be3e283SDebojyoti Ghosh PetscFunctionBegin; 28379be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28384beae5d8SLisandro Dalcin if (ts->poststage) { 28399be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 28409be3e283SDebojyoti Ghosh } 28419be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 28429be3e283SDebojyoti Ghosh } 28439be3e283SDebojyoti Ghosh 28449be3e283SDebojyoti Ghosh #undef __FUNCT__ 2845e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 2846ac226902SBarry Smith /*@C 2847000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 28483f2090d5SJed Brown called once at the end of each time step. 2849000e7ae3SMatthew Knepley 28503f9fe445SBarry Smith Logically Collective on TS 2851000e7ae3SMatthew Knepley 2852000e7ae3SMatthew Knepley Input Parameters: 2853000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2854000e7ae3SMatthew Knepley - func - The function 2855000e7ae3SMatthew Knepley 2856000e7ae3SMatthew Knepley Calling sequence of func: 2857b8123daeSJed Brown $ func (TS ts); 2858000e7ae3SMatthew Knepley 2859000e7ae3SMatthew Knepley Level: intermediate 2860000e7ae3SMatthew Knepley 2861000e7ae3SMatthew Knepley .keywords: TS, timestep 2862b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2863000e7ae3SMatthew Knepley @*/ 28647087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2865000e7ae3SMatthew Knepley { 2866000e7ae3SMatthew Knepley PetscFunctionBegin; 28670700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2868ae60f76fSBarry Smith ts->poststep = func; 2869000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2870000e7ae3SMatthew Knepley } 2871000e7ae3SMatthew Knepley 2872e74ef692SMatthew Knepley #undef __FUNCT__ 28733f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 287409ee8438SJed Brown /*@ 28753f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 28763f2090d5SJed Brown 28773f2090d5SJed Brown Collective on TS 28783f2090d5SJed Brown 28793f2090d5SJed Brown Input Parameters: 28803f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 28813f2090d5SJed Brown 28823f2090d5SJed Brown Notes: 28833f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 28843f2090d5SJed Brown so most users would not generally call this routine themselves. 28853f2090d5SJed Brown 28863f2090d5SJed Brown Level: developer 28873f2090d5SJed Brown 28883f2090d5SJed Brown .keywords: TS, timestep 28893f2090d5SJed Brown @*/ 28907087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 28913f2090d5SJed Brown { 28923f2090d5SJed Brown PetscErrorCode ierr; 28933f2090d5SJed Brown 28943f2090d5SJed Brown PetscFunctionBegin; 28950700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2896ae60f76fSBarry Smith if (ts->poststep) { 2897ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 289872ac3e02SJed Brown } 28993f2090d5SJed Brown PetscFunctionReturn(0); 29003f2090d5SJed Brown } 29013f2090d5SJed Brown 2902d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2903d763cef2SBarry Smith 29044a2ae208SSatish Balay #undef __FUNCT__ 2905a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2906d763cef2SBarry Smith /*@C 2907a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2908d763cef2SBarry Smith timestep to display the iteration's progress. 2909d763cef2SBarry Smith 29103f9fe445SBarry Smith Logically Collective on TS 2911d763cef2SBarry Smith 2912d763cef2SBarry Smith Input Parameters: 2913d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2914e213d8f1SJed Brown . monitor - monitoring routine 2915329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 29160298fd71SBarry Smith monitor routine (use NULL if no context is desired) 2917b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 29180298fd71SBarry Smith (may be NULL) 2919d763cef2SBarry Smith 2920e213d8f1SJed Brown Calling sequence of monitor: 29210910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2922d763cef2SBarry Smith 2923d763cef2SBarry Smith + ts - the TS context 292488c05cc5SBarry Smith . steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have 292588c05cc5SBarry Smith been interpolated to) 29261f06c33eSBarry Smith . time - current time 29270910c330SBarry Smith . u - current iterate 2928d763cef2SBarry Smith - mctx - [optional] monitoring context 2929d763cef2SBarry Smith 2930d763cef2SBarry Smith Notes: 2931d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2932d763cef2SBarry Smith already has been loaded. 2933d763cef2SBarry Smith 2934025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2935025f1a04SBarry Smith 2936d763cef2SBarry Smith Level: intermediate 2937d763cef2SBarry Smith 2938d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2939d763cef2SBarry Smith 2940a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2941d763cef2SBarry Smith @*/ 2942c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2943d763cef2SBarry Smith { 2944d763cef2SBarry Smith PetscFunctionBegin; 29450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 294617186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2947d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 29488704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2949d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2950d763cef2SBarry Smith PetscFunctionReturn(0); 2951d763cef2SBarry Smith } 2952d763cef2SBarry Smith 29534a2ae208SSatish Balay #undef __FUNCT__ 2954a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2955d763cef2SBarry Smith /*@C 2956a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2957d763cef2SBarry Smith 29583f9fe445SBarry Smith Logically Collective on TS 2959d763cef2SBarry Smith 2960d763cef2SBarry Smith Input Parameters: 2961d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2962d763cef2SBarry Smith 2963d763cef2SBarry Smith Notes: 2964d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2965d763cef2SBarry Smith 2966d763cef2SBarry Smith Level: intermediate 2967d763cef2SBarry Smith 2968d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2969d763cef2SBarry Smith 2970a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2971d763cef2SBarry Smith @*/ 29727087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2973d763cef2SBarry Smith { 2974d952e501SBarry Smith PetscErrorCode ierr; 2975d952e501SBarry Smith PetscInt i; 2976d952e501SBarry Smith 2977d763cef2SBarry Smith PetscFunctionBegin; 29780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2979d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 29808704b422SBarry Smith if (ts->monitordestroy[i]) { 29818704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2982d952e501SBarry Smith } 2983d952e501SBarry Smith } 2984d763cef2SBarry Smith ts->numbermonitors = 0; 2985d763cef2SBarry Smith PetscFunctionReturn(0); 2986d763cef2SBarry Smith } 2987d763cef2SBarry Smith 29884a2ae208SSatish Balay #undef __FUNCT__ 2989a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2990d8e5e3e6SSatish Balay /*@ 2991a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 29925516499fSSatish Balay 29935516499fSSatish Balay Level: intermediate 299441251cbbSSatish Balay 29955516499fSSatish Balay .keywords: TS, set, monitor 29965516499fSSatish Balay 299741251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 299841251cbbSSatish Balay @*/ 2999649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 3000d763cef2SBarry Smith { 3001dfbe8321SBarry Smith PetscErrorCode ierr; 30024d4332d5SBarry Smith PetscViewer viewer = (PetscViewer) dummy; 3003d132466eSBarry Smith 3004d763cef2SBarry Smith PetscFunctionBegin; 30054d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3006649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 30078392e04aSShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3008649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3009d763cef2SBarry Smith PetscFunctionReturn(0); 3010d763cef2SBarry Smith } 3011d763cef2SBarry Smith 30124a2ae208SSatish Balay #undef __FUNCT__ 30139110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet" 30149110b2e7SHong Zhang /*@C 30159110b2e7SHong Zhang TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 30169110b2e7SHong Zhang timestep to display the iteration's progress. 30179110b2e7SHong Zhang 30189110b2e7SHong Zhang Logically Collective on TS 30199110b2e7SHong Zhang 30209110b2e7SHong Zhang Input Parameters: 30219110b2e7SHong Zhang + ts - the TS context obtained from TSCreate() 30229110b2e7SHong Zhang . adjointmonitor - monitoring routine 30239110b2e7SHong Zhang . adjointmctx - [optional] user-defined context for private data for the 30249110b2e7SHong Zhang monitor routine (use NULL if no context is desired) 30259110b2e7SHong Zhang - adjointmonitordestroy - [optional] routine that frees monitor context 30269110b2e7SHong Zhang (may be NULL) 30279110b2e7SHong Zhang 30289110b2e7SHong Zhang Calling sequence of monitor: 30299110b2e7SHong Zhang $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 30309110b2e7SHong Zhang 30319110b2e7SHong Zhang + ts - the TS context 30329110b2e7SHong Zhang . steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have 30339110b2e7SHong Zhang been interpolated to) 30349110b2e7SHong Zhang . time - current time 30359110b2e7SHong Zhang . u - current iterate 30369110b2e7SHong Zhang . numcost - number of cost functionos 30379110b2e7SHong Zhang . lambda - sensitivities to initial conditions 30389110b2e7SHong Zhang . mu - sensitivities to parameters 30399110b2e7SHong Zhang - adjointmctx - [optional] adjoint monitoring context 30409110b2e7SHong Zhang 30419110b2e7SHong Zhang Notes: 30429110b2e7SHong Zhang This routine adds an additional monitor to the list of monitors that 30439110b2e7SHong Zhang already has been loaded. 30449110b2e7SHong Zhang 30459110b2e7SHong Zhang Fortran notes: Only a single monitor function can be set for each TS object 30469110b2e7SHong Zhang 30479110b2e7SHong Zhang Level: intermediate 30489110b2e7SHong Zhang 30499110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 30509110b2e7SHong Zhang 30519110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel() 30529110b2e7SHong Zhang @*/ 30539110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 30549110b2e7SHong Zhang { 30559110b2e7SHong Zhang PetscFunctionBegin; 30569110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30579110b2e7SHong Zhang if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 30589110b2e7SHong Zhang ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 30599110b2e7SHong Zhang ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 30609110b2e7SHong Zhang ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 30619110b2e7SHong Zhang PetscFunctionReturn(0); 30629110b2e7SHong Zhang } 30639110b2e7SHong Zhang 30649110b2e7SHong Zhang #undef __FUNCT__ 30659110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel" 30669110b2e7SHong Zhang /*@C 30679110b2e7SHong Zhang TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 30689110b2e7SHong Zhang 30699110b2e7SHong Zhang Logically Collective on TS 30709110b2e7SHong Zhang 30719110b2e7SHong Zhang Input Parameters: 30729110b2e7SHong Zhang . ts - the TS context obtained from TSCreate() 30739110b2e7SHong Zhang 30749110b2e7SHong Zhang Notes: 30759110b2e7SHong Zhang There is no way to remove a single, specific monitor. 30769110b2e7SHong Zhang 30779110b2e7SHong Zhang Level: intermediate 30789110b2e7SHong Zhang 30799110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 30809110b2e7SHong Zhang 30819110b2e7SHong Zhang .seealso: TSAdjointMonitorSet() 30829110b2e7SHong Zhang @*/ 30839110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorCancel(TS ts) 30849110b2e7SHong Zhang { 30859110b2e7SHong Zhang PetscErrorCode ierr; 30869110b2e7SHong Zhang PetscInt i; 30879110b2e7SHong Zhang 30889110b2e7SHong Zhang PetscFunctionBegin; 30899110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30909110b2e7SHong Zhang for (i=0; i<ts->numberadjointmonitors; i++) { 30919110b2e7SHong Zhang if (ts->adjointmonitordestroy[i]) { 30929110b2e7SHong Zhang ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 30939110b2e7SHong Zhang } 30949110b2e7SHong Zhang } 30959110b2e7SHong Zhang ts->numberadjointmonitors = 0; 30969110b2e7SHong Zhang PetscFunctionReturn(0); 30979110b2e7SHong Zhang } 30989110b2e7SHong Zhang 30999110b2e7SHong Zhang #undef __FUNCT__ 3100110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault" 3101110eb670SHong Zhang /*@ 3102110eb670SHong Zhang TSAdjointMonitorDefault - Sets the Default monitor 3103110eb670SHong Zhang 3104110eb670SHong Zhang Level: intermediate 3105110eb670SHong Zhang 3106110eb670SHong Zhang .keywords: TS, set, monitor 3107110eb670SHong Zhang 3108110eb670SHong Zhang .seealso: TSAdjointMonitorSet() 3109110eb670SHong Zhang @*/ 3110110eb670SHong Zhang PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 3111110eb670SHong Zhang { 3112110eb670SHong Zhang PetscErrorCode ierr; 3113110eb670SHong Zhang PetscViewer viewer = (PetscViewer) dummy; 3114110eb670SHong Zhang 3115110eb670SHong Zhang PetscFunctionBegin; 3116110eb670SHong Zhang PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3117110eb670SHong Zhang ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3118110eb670SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3119110eb670SHong Zhang ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3120110eb670SHong Zhang PetscFunctionReturn(0); 3121110eb670SHong Zhang } 3122110eb670SHong Zhang 3123110eb670SHong Zhang #undef __FUNCT__ 3124cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 3125cd652676SJed Brown /*@ 3126cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 3127cd652676SJed Brown 3128cd652676SJed Brown Logically Collective on TS 3129cd652676SJed Brown 3130cd652676SJed Brown Input Argument: 3131cd652676SJed Brown . ts - time stepping context 3132cd652676SJed Brown 3133cd652676SJed Brown Output Argument: 3134cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 3135cd652676SJed Brown 3136cd652676SJed Brown Level: intermediate 3137cd652676SJed Brown 3138cd652676SJed Brown .keywords: TS, set 3139cd652676SJed Brown 3140cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 3141cd652676SJed Brown @*/ 3142cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 3143cd652676SJed Brown { 3144cd652676SJed Brown PetscFunctionBegin; 3145cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3146cd652676SJed Brown ts->retain_stages = flg; 3147cd652676SJed Brown PetscFunctionReturn(0); 3148cd652676SJed Brown } 3149cd652676SJed Brown 3150cd652676SJed Brown #undef __FUNCT__ 3151cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 3152cd652676SJed Brown /*@ 3153cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3154cd652676SJed Brown 3155cd652676SJed Brown Collective on TS 3156cd652676SJed Brown 3157cd652676SJed Brown Input Argument: 3158cd652676SJed Brown + ts - time stepping context 3159cd652676SJed Brown - t - time to interpolate to 3160cd652676SJed Brown 3161cd652676SJed Brown Output Argument: 31620910c330SBarry Smith . U - state at given time 3163cd652676SJed Brown 3164cd652676SJed Brown Notes: 3165cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 3166cd652676SJed Brown 3167cd652676SJed Brown Level: intermediate 3168cd652676SJed Brown 3169cd652676SJed Brown Developer Notes: 3170cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3171cd652676SJed Brown 3172cd652676SJed Brown .keywords: TS, set 3173cd652676SJed Brown 3174cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 3175cd652676SJed Brown @*/ 31760910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3177cd652676SJed Brown { 3178cd652676SJed Brown PetscErrorCode ierr; 3179cd652676SJed Brown 3180cd652676SJed Brown PetscFunctionBegin; 3181cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3182b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 31836712e2f1SBarry Smith if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime); 3184ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 31850910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3186cd652676SJed Brown PetscFunctionReturn(0); 3187cd652676SJed Brown } 3188cd652676SJed Brown 3189cd652676SJed Brown #undef __FUNCT__ 31904a2ae208SSatish Balay #define __FUNCT__ "TSStep" 3191d763cef2SBarry Smith /*@ 31926d9e5789SSean Farley TSStep - Steps one time step 3193d763cef2SBarry Smith 3194d763cef2SBarry Smith Collective on TS 3195d763cef2SBarry Smith 3196d763cef2SBarry Smith Input Parameter: 3197d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3198d763cef2SBarry Smith 319927829d71SBarry Smith Level: developer 3200d763cef2SBarry Smith 3201b8123daeSJed Brown Notes: 320227829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 320327829d71SBarry Smith 3204b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3205b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3206b8123daeSJed Brown 320725cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 320825cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 320925cb2221SBarry Smith 3210d763cef2SBarry Smith .keywords: TS, timestep, solve 3211d763cef2SBarry Smith 32129be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3213d763cef2SBarry Smith @*/ 3214193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3215d763cef2SBarry Smith { 32162fb8446cSMatthew G. Knepley DM dm; 3217dfbe8321SBarry Smith PetscErrorCode ierr; 3218fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3219d763cef2SBarry Smith 3220d763cef2SBarry Smith PetscFunctionBegin; 32210700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3222fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3223fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3224fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3225fffbeea8SBarry Smith " type = {Preprint},\n" 3226fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3227fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3228302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3229fffbeea8SBarry Smith 32302fb8446cSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 3231d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 3232d405a339SMatthew Knepley 3233362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 323424655328SShri ts->ptime_prev = ts->ptime; 3235cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3236bbd56ea5SKarl Rupp 3237e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3238d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3239193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3240d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3241bbd56ea5SKarl Rupp 324224655328SShri ts->time_step_prev = ts->ptime - ts->ptime_prev; 3243cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3244362cd11cSLisandro Dalcin 3245362cd11cSLisandro Dalcin if (ts->reason < 0) { 3246cef5090cSJed Brown if (ts->errorifstepfailed) { 324708c7845fSBarry Smith if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 324808c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3249d2daff3dSHong Zhang } 325008c7845fSBarry Smith } else if (!ts->reason) { 325108c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 325208c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 325308c7845fSBarry Smith } 32542c18e0fdSBarry Smith ts->total_steps++; 32558392e04aSShri Abhyankar ts->steprollback = PETSC_FALSE; 325608c7845fSBarry Smith PetscFunctionReturn(0); 325708c7845fSBarry Smith } 325808c7845fSBarry Smith 325908c7845fSBarry Smith #undef __FUNCT__ 326008c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep" 326108c7845fSBarry Smith /*@ 3262b957a604SHong Zhang TSAdjointStep - Steps one time step backward in the adjoint run 326308c7845fSBarry Smith 326408c7845fSBarry Smith Collective on TS 326508c7845fSBarry Smith 326608c7845fSBarry Smith Input Parameter: 326708c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 326808c7845fSBarry Smith 32696a4d4014SLisandro Dalcin Level: intermediate 32706a4d4014SLisandro Dalcin 3271b957a604SHong Zhang .keywords: TS, adjoint, step 32726a4d4014SLisandro Dalcin 3273b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve() 32746a4d4014SLisandro Dalcin @*/ 327508c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 32766a4d4014SLisandro Dalcin { 327708c7845fSBarry Smith DM dm; 32786a4d4014SLisandro Dalcin PetscErrorCode ierr; 32796a4d4014SLisandro Dalcin 32806a4d4014SLisandro Dalcin PetscFunctionBegin; 32814a2ae208SSatish Balay PetscValidHeaderSpecific(ts, TS_CLASSID,1); 328208c7845fSBarry Smith ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 328308c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3284d763cef2SBarry Smith 3285d763cef2SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 328608c7845fSBarry Smith ts->ptime_prev = ts->ptime; 328708c7845fSBarry Smith ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3288685405a1SBarry Smith ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts, "-ts_view_solution");CHKERRQ(ierr); 3289d763cef2SBarry Smith 32906849ba73SBarry Smith ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 329142f2b339SBarry Smith if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name); 329242f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 3293a6570f20SBarry Smith ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3294d763cef2SBarry Smith 3295cef5090cSJed Brown ts->time_step_prev = ts->ptime - ts->ptime_prev; 3296cef5090cSJed Brown ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3297362cd11cSLisandro Dalcin 3298362cd11cSLisandro Dalcin if (ts->reason < 0) { 3299cef5090cSJed Brown if (ts->errorifstepfailed) { 3300cef5090cSJed Brown if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 3301ce94432eSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 33022a3a10ceSLisandro Dalcin } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) { 33032a3a10ceSLisandro Dalcin SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 3304ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3305cef5090cSJed Brown } 3306362cd11cSLisandro Dalcin } else if (!ts->reason) { 330773b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3308db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3309362cd11cSLisandro Dalcin } 33102c18e0fdSBarry Smith ts->total_steps--; 3311d763cef2SBarry Smith PetscFunctionReturn(0); 3312d763cef2SBarry Smith } 3313d763cef2SBarry Smith 3314d763cef2SBarry Smith #undef __FUNCT__ 331505175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 331605175c85SJed Brown /*@ 331705175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 331805175c85SJed Brown 33191c3436cfSJed Brown Collective on TS 332005175c85SJed Brown 332105175c85SJed Brown Input Arguments: 33221c3436cfSJed Brown + ts - time stepping context 33231c3436cfSJed Brown . order - desired order of accuracy 33240298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 332505175c85SJed Brown 332605175c85SJed Brown Output Arguments: 33270910c330SBarry Smith . U - state at the end of the current step 332805175c85SJed Brown 332905175c85SJed Brown Level: advanced 333005175c85SJed Brown 3331108c343cSJed Brown Notes: 3332108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3333108c343cSJed Brown It is normally called by adaptive controllers before a step has been accepted and may also be called by the user after TSStep() has returned. 3334108c343cSJed Brown 33351c3436cfSJed Brown .seealso: TSStep(), TSAdapt 333605175c85SJed Brown @*/ 33370910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 333805175c85SJed Brown { 333905175c85SJed Brown PetscErrorCode ierr; 334005175c85SJed Brown 334105175c85SJed Brown PetscFunctionBegin; 334205175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 334305175c85SJed Brown PetscValidType(ts,1); 33440910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3345ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 33460910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 334705175c85SJed Brown PetscFunctionReturn(0); 334805175c85SJed Brown } 334905175c85SJed Brown 3350d67e68b7SBarry Smith 335105175c85SJed Brown #undef __FUNCT__ 3352d763cef2SBarry Smith #define __FUNCT__ "TSSolve" 3353d763cef2SBarry Smith /*@ 3354d763cef2SBarry Smith TSSolve - Steps the requested number of timesteps. 3355d763cef2SBarry Smith 3356d763cef2SBarry Smith Collective on TS 3357d763cef2SBarry Smith 3358d763cef2SBarry Smith Input Parameter: 3359d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3360cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 33615a3a76d0SJed Brown 3362d763cef2SBarry Smith Level: beginner 3363d763cef2SBarry Smith 33645a3a76d0SJed Brown Notes: 33655a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 33665a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 33675a3a76d0SJed Brown stepped over the final time. 33685a3a76d0SJed Brown 3369d763cef2SBarry Smith .keywords: TS, timestep, solve 3370d763cef2SBarry Smith 3371d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep() 3372d763cef2SBarry Smith @*/ 3373cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 3374d763cef2SBarry Smith { 3375b06615a5SLisandro Dalcin Vec solution; 3376d763cef2SBarry Smith PetscErrorCode ierr; 3377d763cef2SBarry Smith 3378d763cef2SBarry Smith PetscFunctionBegin; 3379d763cef2SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3380f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 338149354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 3382b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 33830910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3384b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3385b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3386b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 33875a3a76d0SJed Brown } 33880910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3389bbd56ea5SKarl Rupp } else if (u) { 33900910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 33915a3a76d0SJed Brown } 3392b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 3393d763cef2SBarry Smith /* reset time step and iteration counters */ 3394193ac0bcSJed Brown ts->steps = 0; 33955ef26d82SJed Brown ts->ksp_its = 0; 33965ef26d82SJed Brown ts->snes_its = 0; 3397c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3398c610991cSLisandro Dalcin ts->reject = 0; 3399193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3400193ac0bcSJed Brown 3401ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3402ec8db0baSMatthew G. Knepley { 3403ec8db0baSMatthew G. Knepley DM dm; 3404ec8db0baSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 3405ec8db0baSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3406ec8db0baSMatthew G. Knepley } 3407f05ece33SBarry Smith 3408193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3409193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 34100910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 3411cc708dedSBarry Smith ts->solvetime = ts->ptime; 3412193ac0bcSJed Brown } else { 3413d763cef2SBarry Smith /* steps the requested number of timesteps. */ 3414db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3415db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3416cdf0de3dSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 341711b05f00SHong Zhang if (ts->vec_costintegral) ts->costintegralfwd=PETSC_TRUE; 34186fea3669SShri Abhyankar if(ts->event) { 34196fea3669SShri Abhyankar ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr); 34206fea3669SShri Abhyankar } 3421e1a7a14fSJed Brown while (!ts->reason) { 3422193ac0bcSJed Brown ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3423193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3424aeb4809dSShri Abhyankar if (ts->event) { 3425aeb4809dSShri Abhyankar ierr = TSEventMonitor(ts);CHKERRQ(ierr); 34261eda64f1SShri Abhyankar } 34278392e04aSShri Abhyankar if(!ts->steprollback) { 3428cdf0de3dSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 34291eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3430aeb4809dSShri Abhyankar } 3431193ac0bcSJed Brown } 343249354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 34330910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3434cc708dedSBarry Smith ts->solvetime = ts->max_time; 3435b06615a5SLisandro Dalcin solution = u; 34360574a7fbSJed Brown } else { 3437ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3438cc708dedSBarry Smith ts->solvetime = ts->ptime; 3439b06615a5SLisandro Dalcin solution = ts->vec_sol; 34400574a7fbSJed Brown } 3441b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 3442685405a1SBarry Smith ierr = VecViewFromOptions(solution,(PetscObject) ts,"-ts_view_solution");CHKERRQ(ierr); 3443193ac0bcSJed Brown } 3444d2daff3dSHong Zhang 3445ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 3446dc1cb503SEmil Constantinescu ierr = VecViewFromOptions(ts->vec_sol,NULL,"-ts_view_solution");CHKERRQ(ierr); 344756f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 3448ef222394SBarry Smith if (ts->adjoint_solve) { 3449ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 34502b0a91c0SBarry Smith } 3451d763cef2SBarry Smith PetscFunctionReturn(0); 3452d763cef2SBarry Smith } 3453d763cef2SBarry Smith 3454d763cef2SBarry Smith #undef __FUNCT__ 3455c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve" 3456c88f2d44SBarry Smith /*@ 3457c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 3458c88f2d44SBarry Smith 3459c88f2d44SBarry Smith Collective on TS 3460c88f2d44SBarry Smith 3461c88f2d44SBarry Smith Input Parameter: 34622c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 3463c88f2d44SBarry Smith 3464e87fd094SBarry Smith Options Database: 3465e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 3466e87fd094SBarry Smith 3467c88f2d44SBarry Smith Level: intermediate 3468c88f2d44SBarry Smith 3469c88f2d44SBarry Smith Notes: 3470c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 3471c88f2d44SBarry Smith 347273b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 347373b18844SBarry Smith 3474c88f2d44SBarry Smith .keywords: TS, timestep, solve 3475c88f2d44SBarry Smith 3476b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 3477c88f2d44SBarry Smith @*/ 34782c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 3479c88f2d44SBarry Smith { 3480c88f2d44SBarry Smith PetscErrorCode ierr; 3481c88f2d44SBarry Smith 3482c88f2d44SBarry Smith PetscFunctionBegin; 3483c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3484c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3485c88f2d44SBarry Smith /* reset time step and iteration counters */ 3486c88f2d44SBarry Smith ts->steps = 0; 3487c88f2d44SBarry Smith ts->ksp_its = 0; 3488c88f2d44SBarry Smith ts->snes_its = 0; 3489c88f2d44SBarry Smith ts->num_snes_failures = 0; 3490c88f2d44SBarry Smith ts->reject = 0; 3491c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 3492c88f2d44SBarry Smith 349373b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 3494c88f2d44SBarry Smith 349573b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3496c88f2d44SBarry Smith while (!ts->reason) { 349755c52731SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 34989110b2e7SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 3499c88f2d44SBarry Smith if (ts->event) { 3500d0578d90SShri Abhyankar ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr); 3501d0578d90SShri Abhyankar } 3502616946c1SHong Zhang ierr = TSAdjointStep(ts);CHKERRQ(ierr); 3503c88f2d44SBarry Smith } 350426656371SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 350526656371SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 3506c88f2d44SBarry Smith ts->solvetime = ts->ptime; 3507685405a1SBarry Smith ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 3508c88f2d44SBarry Smith PetscFunctionReturn(0); 3509c88f2d44SBarry Smith } 3510c88f2d44SBarry Smith 3511c88f2d44SBarry Smith #undef __FUNCT__ 3512d763cef2SBarry Smith #define __FUNCT__ "TSMonitor" 3513*7db568b7SBarry Smith /*@C 3514228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 3515228d79bcSJed Brown 3516228d79bcSJed Brown Collective on TS 3517228d79bcSJed Brown 3518228d79bcSJed Brown Input Parameters: 3519228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 3520228d79bcSJed Brown . step - step number that has just completed 3521228d79bcSJed Brown . ptime - model time of the state 35220910c330SBarry Smith - u - state at the current model time 3523228d79bcSJed Brown 3524228d79bcSJed Brown Notes: 3525*7db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 3526*7db568b7SBarry Smith Users would almost never call this routine directly. 3527228d79bcSJed Brown 3528*7db568b7SBarry Smith Level: developer 3529228d79bcSJed Brown 3530228d79bcSJed Brown .keywords: TS, timestep 3531228d79bcSJed Brown @*/ 35320910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 3533d763cef2SBarry Smith { 3534d763cef2SBarry Smith PetscErrorCode ierr; 3535d763cef2SBarry Smith PetscInt i,n = ts->numbermonitors; 3536d763cef2SBarry Smith 3537d763cef2SBarry Smith PetscFunctionBegin; 3538b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3539b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 35405edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 3541d763cef2SBarry Smith for (i=0; i<n; i++) { 35420910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 3543d763cef2SBarry Smith } 35445edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 3545d763cef2SBarry Smith PetscFunctionReturn(0); 3546d763cef2SBarry Smith } 3547d763cef2SBarry Smith 35489110b2e7SHong Zhang #undef __FUNCT__ 35499110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor" 3550*7db568b7SBarry Smith /*@C 35519110b2e7SHong Zhang TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 35529110b2e7SHong Zhang 35539110b2e7SHong Zhang Collective on TS 35549110b2e7SHong Zhang 35559110b2e7SHong Zhang Input Parameters: 35569110b2e7SHong Zhang + ts - time stepping context obtained from TSCreate() 35579110b2e7SHong Zhang . step - step number that has just completed 35589110b2e7SHong Zhang . ptime - model time of the state 35599110b2e7SHong Zhang . u - state at the current model time 35609110b2e7SHong Zhang . numcost - number of cost functions (dimension of lambda or mu) 35619110b2e7SHong Zhang . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 35629110b2e7SHong Zhang - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 35639110b2e7SHong Zhang 35649110b2e7SHong Zhang Notes: 3565*7db568b7SBarry Smith TSAdjointMonitor() is typically used automatically within the time stepping implementations. 3566*7db568b7SBarry Smith Users would almost never call this routine directly. 35679110b2e7SHong Zhang 3568*7db568b7SBarry Smith Level: developer 35699110b2e7SHong Zhang 35709110b2e7SHong Zhang .keywords: TS, timestep 35719110b2e7SHong Zhang @*/ 35729110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 35739110b2e7SHong Zhang { 35749110b2e7SHong Zhang PetscErrorCode ierr; 35759110b2e7SHong Zhang PetscInt i,n = ts->numberadjointmonitors; 35769110b2e7SHong Zhang 35779110b2e7SHong Zhang PetscFunctionBegin; 35789110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 35799110b2e7SHong Zhang PetscValidHeaderSpecific(u,VEC_CLASSID,4); 35809110b2e7SHong Zhang ierr = VecLockPush(u);CHKERRQ(ierr); 35819110b2e7SHong Zhang for (i=0; i<n; i++) { 35829110b2e7SHong Zhang ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 35839110b2e7SHong Zhang } 35849110b2e7SHong Zhang ierr = VecLockPop(u);CHKERRQ(ierr); 35859110b2e7SHong Zhang PetscFunctionReturn(0); 35869110b2e7SHong Zhang } 35879110b2e7SHong Zhang 3588d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 3589d763cef2SBarry Smith #undef __FUNCT__ 3590a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 3591d763cef2SBarry Smith /*@C 3592*7db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 3593a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 3594d763cef2SBarry Smith 3595d763cef2SBarry Smith Collective on TS 3596d763cef2SBarry Smith 3597d763cef2SBarry Smith Input Parameters: 3598d763cef2SBarry Smith + host - the X display to open, or null for the local machine 3599d763cef2SBarry Smith . label - the title to put in the title bar 36007c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 3601a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 3602a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 3603d763cef2SBarry Smith 3604d763cef2SBarry Smith Output Parameter: 36050b039ecaSBarry Smith . ctx - the context 3606d763cef2SBarry Smith 3607d763cef2SBarry Smith Options Database Key: 36084f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 3609*7db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 3610*7db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 3611*7db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 3612*7db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 3613b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 3614d763cef2SBarry Smith 3615d763cef2SBarry Smith Notes: 3616a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 3617d763cef2SBarry Smith 3618*7db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 3619*7db568b7SBarry Smith 3620*7db568b7SBarry Smith Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the 3621*7db568b7SBarry Smith first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object 3622*7db568b7SBarry Smith as the first argument. 3623*7db568b7SBarry Smith 3624*7db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 3625*7db568b7SBarry Smith 3626*7db568b7SBarry Smith 3627d763cef2SBarry Smith Level: intermediate 3628d763cef2SBarry Smith 3629*7db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 3630d763cef2SBarry Smith 3631*7db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 3632*7db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 3633*7db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 3634*7db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 3635*7db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 36367c922b88SBarry Smith 3637d763cef2SBarry Smith @*/ 3638a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 3639d763cef2SBarry Smith { 36407f52daa2SLisandro Dalcin PetscDraw draw; 3641dfbe8321SBarry Smith PetscErrorCode ierr; 3642d763cef2SBarry Smith 3643d763cef2SBarry Smith PetscFunctionBegin; 3644b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 36457f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 36467f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 36477f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 3648b6fe0379SLisandro Dalcin ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr); 3649287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 36507f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 3651a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 3652d763cef2SBarry Smith PetscFunctionReturn(0); 3653d763cef2SBarry Smith } 3654d763cef2SBarry Smith 36554a2ae208SSatish Balay #undef __FUNCT__ 36564f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 3657b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 3658d763cef2SBarry Smith { 36590b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 3660c32365f1SBarry Smith PetscReal x = ptime,y; 3661dfbe8321SBarry Smith PetscErrorCode ierr; 3662d763cef2SBarry Smith 3663d763cef2SBarry Smith PetscFunctionBegin; 3664b06615a5SLisandro Dalcin if (!step) { 3665a9f9c1f6SBarry Smith PetscDrawAxis axis; 3666a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 3667a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 3668a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 3669a9f9c1f6SBarry Smith } 3670c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 36710b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 3672b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 36730b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 36743923b477SBarry Smith } 3675d763cef2SBarry Smith PetscFunctionReturn(0); 3676d763cef2SBarry Smith } 3677d763cef2SBarry Smith 36784a2ae208SSatish Balay #undef __FUNCT__ 3679a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 3680d763cef2SBarry Smith /*@C 3681a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 3682a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 3683d763cef2SBarry Smith 36840b039ecaSBarry Smith Collective on TSMonitorLGCtx 3685d763cef2SBarry Smith 3686d763cef2SBarry Smith Input Parameter: 36870b039ecaSBarry Smith . ctx - the monitor context 3688d763cef2SBarry Smith 3689d763cef2SBarry Smith Level: intermediate 3690d763cef2SBarry Smith 3691d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 3692d763cef2SBarry Smith 36934f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 3694d763cef2SBarry Smith @*/ 3695a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 3696d763cef2SBarry Smith { 3697dfbe8321SBarry Smith PetscErrorCode ierr; 3698d763cef2SBarry Smith 3699d763cef2SBarry Smith PetscFunctionBegin; 37007684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 37017684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 37027684fa3eSBarry Smith } 37030b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 370431152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 3705387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 3706387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 3707387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 37080b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 3709d763cef2SBarry Smith PetscFunctionReturn(0); 3710d763cef2SBarry Smith } 3711d763cef2SBarry Smith 37124a2ae208SSatish Balay #undef __FUNCT__ 37134a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 3714d763cef2SBarry Smith /*@ 3715b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 3716d763cef2SBarry Smith 3717d763cef2SBarry Smith Not Collective 3718d763cef2SBarry Smith 3719d763cef2SBarry Smith Input Parameter: 3720d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3721d763cef2SBarry Smith 3722d763cef2SBarry Smith Output Parameter: 3723d763cef2SBarry Smith . t - the current time 3724d763cef2SBarry Smith 3725d763cef2SBarry Smith Level: beginner 3726d763cef2SBarry Smith 3727b8123daeSJed Brown Note: 3728b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 37299be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 3730b8123daeSJed Brown 3731d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3732d763cef2SBarry Smith 3733d763cef2SBarry Smith .keywords: TS, get, time 3734d763cef2SBarry Smith @*/ 37357087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 3736d763cef2SBarry Smith { 3737d763cef2SBarry Smith PetscFunctionBegin; 37380700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3739f7cf8827SBarry Smith PetscValidRealPointer(t,2); 3740d763cef2SBarry Smith *t = ts->ptime; 3741d763cef2SBarry Smith PetscFunctionReturn(0); 3742d763cef2SBarry Smith } 3743d763cef2SBarry Smith 37444a2ae208SSatish Balay #undef __FUNCT__ 3745e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime" 3746e5e524a1SHong Zhang /*@ 3747e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 3748e5e524a1SHong Zhang 3749e5e524a1SHong Zhang Not Collective 3750e5e524a1SHong Zhang 3751e5e524a1SHong Zhang Input Parameter: 3752e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 3753e5e524a1SHong Zhang 3754e5e524a1SHong Zhang Output Parameter: 3755e5e524a1SHong Zhang . t - the previous time 3756e5e524a1SHong Zhang 3757e5e524a1SHong Zhang Level: beginner 3758e5e524a1SHong Zhang 3759e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3760e5e524a1SHong Zhang 3761e5e524a1SHong Zhang .keywords: TS, get, time 3762e5e524a1SHong Zhang @*/ 3763e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 3764e5e524a1SHong Zhang { 3765e5e524a1SHong Zhang PetscFunctionBegin; 3766e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3767e5e524a1SHong Zhang PetscValidRealPointer(t,2); 3768e5e524a1SHong Zhang *t = ts->ptime_prev; 3769e5e524a1SHong Zhang PetscFunctionReturn(0); 3770e5e524a1SHong Zhang } 3771e5e524a1SHong Zhang 3772e5e524a1SHong Zhang #undef __FUNCT__ 37736a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 37746a4d4014SLisandro Dalcin /*@ 37756a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 37766a4d4014SLisandro Dalcin 37773f9fe445SBarry Smith Logically Collective on TS 37786a4d4014SLisandro Dalcin 37796a4d4014SLisandro Dalcin Input Parameters: 37806a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 37816a4d4014SLisandro Dalcin - time - the time 37826a4d4014SLisandro Dalcin 37836a4d4014SLisandro Dalcin Level: intermediate 37846a4d4014SLisandro Dalcin 37856a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 37866a4d4014SLisandro Dalcin 37876a4d4014SLisandro Dalcin .keywords: TS, set, time 37886a4d4014SLisandro Dalcin @*/ 37897087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 37906a4d4014SLisandro Dalcin { 37916a4d4014SLisandro Dalcin PetscFunctionBegin; 37920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3793c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 37946a4d4014SLisandro Dalcin ts->ptime = t; 37956a4d4014SLisandro Dalcin PetscFunctionReturn(0); 37966a4d4014SLisandro Dalcin } 37976a4d4014SLisandro Dalcin 37986a4d4014SLisandro Dalcin #undef __FUNCT__ 37994a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 3800d763cef2SBarry Smith /*@C 3801d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 3802d763cef2SBarry Smith TS options in the database. 3803d763cef2SBarry Smith 38043f9fe445SBarry Smith Logically Collective on TS 3805d763cef2SBarry Smith 3806d763cef2SBarry Smith Input Parameter: 3807d763cef2SBarry Smith + ts - The TS context 3808d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3809d763cef2SBarry Smith 3810d763cef2SBarry Smith Notes: 3811d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3812d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3813d763cef2SBarry Smith hyphen. 3814d763cef2SBarry Smith 3815d763cef2SBarry Smith Level: advanced 3816d763cef2SBarry Smith 3817d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 3818d763cef2SBarry Smith 3819d763cef2SBarry Smith .seealso: TSSetFromOptions() 3820d763cef2SBarry Smith 3821d763cef2SBarry Smith @*/ 38227087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 3823d763cef2SBarry Smith { 3824dfbe8321SBarry Smith PetscErrorCode ierr; 3825089b2837SJed Brown SNES snes; 3826d763cef2SBarry Smith 3827d763cef2SBarry Smith PetscFunctionBegin; 38280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3829d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3830089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3831089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3832d763cef2SBarry Smith PetscFunctionReturn(0); 3833d763cef2SBarry Smith } 3834d763cef2SBarry Smith 3835d763cef2SBarry Smith 38364a2ae208SSatish Balay #undef __FUNCT__ 38374a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 3838d763cef2SBarry Smith /*@C 3839d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 3840d763cef2SBarry Smith TS options in the database. 3841d763cef2SBarry Smith 38423f9fe445SBarry Smith Logically Collective on TS 3843d763cef2SBarry Smith 3844d763cef2SBarry Smith Input Parameter: 3845d763cef2SBarry Smith + ts - The TS context 3846d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3847d763cef2SBarry Smith 3848d763cef2SBarry Smith Notes: 3849d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3850d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3851d763cef2SBarry Smith hyphen. 3852d763cef2SBarry Smith 3853d763cef2SBarry Smith Level: advanced 3854d763cef2SBarry Smith 3855d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 3856d763cef2SBarry Smith 3857d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 3858d763cef2SBarry Smith 3859d763cef2SBarry Smith @*/ 38607087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 3861d763cef2SBarry Smith { 3862dfbe8321SBarry Smith PetscErrorCode ierr; 3863089b2837SJed Brown SNES snes; 3864d763cef2SBarry Smith 3865d763cef2SBarry Smith PetscFunctionBegin; 38660700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3867d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3868089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3869089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3870d763cef2SBarry Smith PetscFunctionReturn(0); 3871d763cef2SBarry Smith } 3872d763cef2SBarry Smith 38734a2ae208SSatish Balay #undef __FUNCT__ 38744a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 3875d763cef2SBarry Smith /*@C 3876d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 3877d763cef2SBarry Smith TS options in the database. 3878d763cef2SBarry Smith 3879d763cef2SBarry Smith Not Collective 3880d763cef2SBarry Smith 3881d763cef2SBarry Smith Input Parameter: 3882d763cef2SBarry Smith . ts - The TS context 3883d763cef2SBarry Smith 3884d763cef2SBarry Smith Output Parameter: 3885d763cef2SBarry Smith . prefix - A pointer to the prefix string used 3886d763cef2SBarry Smith 3887d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 3888d763cef2SBarry Smith sufficient length to hold the prefix. 3889d763cef2SBarry Smith 3890d763cef2SBarry Smith Level: intermediate 3891d763cef2SBarry Smith 3892d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 3893d763cef2SBarry Smith 3894d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 3895d763cef2SBarry Smith @*/ 38967087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 3897d763cef2SBarry Smith { 3898dfbe8321SBarry Smith PetscErrorCode ierr; 3899d763cef2SBarry Smith 3900d763cef2SBarry Smith PetscFunctionBegin; 39010700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 39024482741eSBarry Smith PetscValidPointer(prefix,2); 3903d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3904d763cef2SBarry Smith PetscFunctionReturn(0); 3905d763cef2SBarry Smith } 3906d763cef2SBarry Smith 39074a2ae208SSatish Balay #undef __FUNCT__ 39084a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 3909d763cef2SBarry Smith /*@C 3910d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 3911d763cef2SBarry Smith 3912d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 3913d763cef2SBarry Smith 3914d763cef2SBarry Smith Input Parameter: 3915d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 3916d763cef2SBarry Smith 3917d763cef2SBarry Smith Output Parameters: 3918e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 3919e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 3920e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 3921e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 3922d763cef2SBarry Smith 39230298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 3924d763cef2SBarry Smith 3925d763cef2SBarry Smith Level: intermediate 3926d763cef2SBarry Smith 392726d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3928d763cef2SBarry Smith 3929d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 3930d763cef2SBarry Smith @*/ 3931e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 3932d763cef2SBarry Smith { 3933089b2837SJed Brown PetscErrorCode ierr; 3934089b2837SJed Brown SNES snes; 393524989b8cSPeter Brune DM dm; 3936089b2837SJed Brown 3937d763cef2SBarry Smith PetscFunctionBegin; 3938089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3939e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 394024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 394124989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 3942d763cef2SBarry Smith PetscFunctionReturn(0); 3943d763cef2SBarry Smith } 3944d763cef2SBarry Smith 39451713a123SBarry Smith #undef __FUNCT__ 39462eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 39472eca1d9cSJed Brown /*@C 39482eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 39492eca1d9cSJed Brown 39502eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 39512eca1d9cSJed Brown 39522eca1d9cSJed Brown Input Parameter: 39532eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 39542eca1d9cSJed Brown 39552eca1d9cSJed Brown Output Parameters: 3956e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 3957e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 39582eca1d9cSJed Brown . f - The function to compute the matrices 39592eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 39602eca1d9cSJed Brown 39610298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 39622eca1d9cSJed Brown 39632eca1d9cSJed Brown Level: advanced 39642eca1d9cSJed Brown 39652eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 39662eca1d9cSJed Brown 39672eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 39682eca1d9cSJed Brown @*/ 3969e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 39702eca1d9cSJed Brown { 3971089b2837SJed Brown PetscErrorCode ierr; 3972089b2837SJed Brown SNES snes; 397324989b8cSPeter Brune DM dm; 39740910c330SBarry Smith 39752eca1d9cSJed Brown PetscFunctionBegin; 3976089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3977f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 3978e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 397924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 398024989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 39812eca1d9cSJed Brown PetscFunctionReturn(0); 39822eca1d9cSJed Brown } 39832eca1d9cSJed Brown 39846083293cSBarry Smith 39852eca1d9cSJed Brown #undef __FUNCT__ 398683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 39871713a123SBarry Smith /*@C 398883a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 39891713a123SBarry Smith VecView() for the solution at each timestep 39901713a123SBarry Smith 39911713a123SBarry Smith Collective on TS 39921713a123SBarry Smith 39931713a123SBarry Smith Input Parameters: 39941713a123SBarry Smith + ts - the TS context 39951713a123SBarry Smith . step - current time-step 3996142b95e3SSatish Balay . ptime - current time 39970298fd71SBarry Smith - dummy - either a viewer or NULL 39981713a123SBarry Smith 399999fdda47SBarry Smith Options Database: 400099fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 400199fdda47SBarry Smith 4002387f4636SBarry Smith Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 400399fdda47SBarry Smith will look bad 400499fdda47SBarry Smith 40051713a123SBarry Smith Level: intermediate 40061713a123SBarry Smith 40071713a123SBarry Smith .keywords: TS, vector, monitor, view 40081713a123SBarry Smith 4009a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 40101713a123SBarry Smith @*/ 40110910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 40121713a123SBarry Smith { 4013dfbe8321SBarry Smith PetscErrorCode ierr; 401483a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4015473a3ab2SBarry Smith PetscDraw draw; 40161713a123SBarry Smith 40171713a123SBarry Smith PetscFunctionBegin; 40186083293cSBarry Smith if (!step && ictx->showinitial) { 40196083293cSBarry Smith if (!ictx->initialsolution) { 40200910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 40211713a123SBarry Smith } 40220910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 40236083293cSBarry Smith } 4024b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 40250dcf80beSBarry Smith 40266083293cSBarry Smith if (ictx->showinitial) { 40276083293cSBarry Smith PetscReal pause; 40286083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 40296083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 40306083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 40316083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 40326083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 40336083293cSBarry Smith } 40340910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4035473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 403651fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4037473a3ab2SBarry Smith char time[32]; 4038473a3ab2SBarry Smith 4039473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 404085b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4041473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4042473a3ab2SBarry Smith h = yl + .95*(yr - yl); 404351fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4044473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4045473a3ab2SBarry Smith } 4046473a3ab2SBarry Smith 40476083293cSBarry Smith if (ictx->showinitial) { 40486083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 40496083293cSBarry Smith } 40501713a123SBarry Smith PetscFunctionReturn(0); 40511713a123SBarry Smith } 40521713a123SBarry Smith 40532d5ee99bSBarry Smith #undef __FUNCT__ 40549110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi" 40559110b2e7SHong Zhang /*@C 40569110b2e7SHong Zhang TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 40579110b2e7SHong Zhang VecView() for the sensitivities to initial states at each timestep 40589110b2e7SHong Zhang 40599110b2e7SHong Zhang Collective on TS 40609110b2e7SHong Zhang 40619110b2e7SHong Zhang Input Parameters: 40629110b2e7SHong Zhang + ts - the TS context 40639110b2e7SHong Zhang . step - current time-step 40649110b2e7SHong Zhang . ptime - current time 40659110b2e7SHong Zhang . u - current state 40669110b2e7SHong Zhang . numcost - number of cost functions 40679110b2e7SHong Zhang . lambda - sensitivities to initial conditions 40689110b2e7SHong Zhang . mu - sensitivities to parameters 40699110b2e7SHong Zhang - dummy - either a viewer or NULL 40709110b2e7SHong Zhang 40719110b2e7SHong Zhang Level: intermediate 40729110b2e7SHong Zhang 40739110b2e7SHong Zhang .keywords: TS, vector, adjoint, monitor, view 40749110b2e7SHong Zhang 40759110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 40769110b2e7SHong Zhang @*/ 40779110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 40789110b2e7SHong Zhang { 40799110b2e7SHong Zhang PetscErrorCode ierr; 40809110b2e7SHong Zhang TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 40819110b2e7SHong Zhang PetscDraw draw; 4082a0046e2cSSatish Balay PetscReal xl,yl,xr,yr,h; 4083a0046e2cSSatish Balay char time[32]; 40849110b2e7SHong Zhang 40859110b2e7SHong Zhang PetscFunctionBegin; 40869110b2e7SHong Zhang if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 40879110b2e7SHong Zhang 40889110b2e7SHong Zhang ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 40899110b2e7SHong Zhang ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 40909110b2e7SHong Zhang ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 40919110b2e7SHong Zhang ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 40929110b2e7SHong Zhang h = yl + .95*(yr - yl); 40939110b2e7SHong Zhang ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 40949110b2e7SHong Zhang ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 40959110b2e7SHong Zhang 40969110b2e7SHong Zhang PetscFunctionReturn(0); 40979110b2e7SHong Zhang } 40989110b2e7SHong Zhang 40999110b2e7SHong Zhang #undef __FUNCT__ 41002d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase" 41012d5ee99bSBarry Smith /*@C 41022d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 41032d5ee99bSBarry Smith 41042d5ee99bSBarry Smith Collective on TS 41052d5ee99bSBarry Smith 41062d5ee99bSBarry Smith Input Parameters: 41072d5ee99bSBarry Smith + ts - the TS context 41082d5ee99bSBarry Smith . step - current time-step 41092d5ee99bSBarry Smith . ptime - current time 41102d5ee99bSBarry Smith - dummy - either a viewer or NULL 41112d5ee99bSBarry Smith 41122d5ee99bSBarry Smith Level: intermediate 41132d5ee99bSBarry Smith 41142d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 41152d5ee99bSBarry Smith 41162d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 41172d5ee99bSBarry Smith @*/ 41182d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 41192d5ee99bSBarry Smith { 41202d5ee99bSBarry Smith PetscErrorCode ierr; 41212d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 41222d5ee99bSBarry Smith PetscDraw draw; 41232d5ee99bSBarry Smith MPI_Comm comm; 41242d5ee99bSBarry Smith PetscInt n; 41252d5ee99bSBarry Smith PetscMPIInt size; 412651fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 41272d5ee99bSBarry Smith char time[32]; 41282d5ee99bSBarry Smith const PetscScalar *U; 41292d5ee99bSBarry Smith 41302d5ee99bSBarry Smith PetscFunctionBegin; 41312d5ee99bSBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 41322d5ee99bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 41332d5ee99bSBarry Smith if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 41342d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 41352d5ee99bSBarry Smith if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 41362d5ee99bSBarry Smith 41372d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 41382d5ee99bSBarry Smith 41392d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 41404b363babSBarry Smith ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 4141ba5783adSMatthew G Knepley if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 4142a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 4143a4494fc1SBarry Smith PetscFunctionReturn(0); 4144a4494fc1SBarry Smith } 41452d5ee99bSBarry Smith if (!step) ictx->color++; 41462d5ee99bSBarry Smith ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 41472d5ee99bSBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 41482d5ee99bSBarry Smith 41492d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 41504b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 415185b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 41522d5ee99bSBarry Smith h = yl + .95*(yr - yl); 415351fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 41542d5ee99bSBarry Smith } 41552d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 41562d5ee99bSBarry Smith PetscFunctionReturn(0); 41572d5ee99bSBarry Smith } 41582d5ee99bSBarry Smith 41591713a123SBarry Smith 41606c699258SBarry Smith #undef __FUNCT__ 416183a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 41626083293cSBarry Smith /*@C 416383a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 41646083293cSBarry Smith 41656083293cSBarry Smith Collective on TS 41666083293cSBarry Smith 41676083293cSBarry Smith Input Parameters: 41686083293cSBarry Smith . ctx - the monitor context 41696083293cSBarry Smith 41706083293cSBarry Smith Level: intermediate 41716083293cSBarry Smith 41726083293cSBarry Smith .keywords: TS, vector, monitor, view 41736083293cSBarry Smith 417483a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 41756083293cSBarry Smith @*/ 417683a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 41776083293cSBarry Smith { 41786083293cSBarry Smith PetscErrorCode ierr; 41796083293cSBarry Smith 41806083293cSBarry Smith PetscFunctionBegin; 41814b363babSBarry Smith ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 418283a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 418383a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 418483a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 41856083293cSBarry Smith PetscFunctionReturn(0); 41866083293cSBarry Smith } 41876083293cSBarry Smith 41886083293cSBarry Smith #undef __FUNCT__ 418983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 41906083293cSBarry Smith /*@C 419183a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 41926083293cSBarry Smith 41936083293cSBarry Smith Collective on TS 41946083293cSBarry Smith 41956083293cSBarry Smith Input Parameter: 41966083293cSBarry Smith . ts - time-step context 41976083293cSBarry Smith 41986083293cSBarry Smith Output Patameter: 41996083293cSBarry Smith . ctx - the monitor context 42006083293cSBarry Smith 420199fdda47SBarry Smith Options Database: 420299fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 420399fdda47SBarry Smith 42046083293cSBarry Smith Level: intermediate 42056083293cSBarry Smith 42066083293cSBarry Smith .keywords: TS, vector, monitor, view 42076083293cSBarry Smith 420883a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 42096083293cSBarry Smith @*/ 421083a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 42116083293cSBarry Smith { 42126083293cSBarry Smith PetscErrorCode ierr; 42136083293cSBarry Smith 42146083293cSBarry Smith PetscFunctionBegin; 4215b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 421683a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4217e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4218bbd56ea5SKarl Rupp 421983a4ac43SBarry Smith (*ctx)->howoften = howoften; 4220473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 42210298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4222473a3ab2SBarry Smith 4223473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 42240298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 42252d5ee99bSBarry Smith (*ctx)->color = PETSC_DRAW_WHITE; 42266083293cSBarry Smith PetscFunctionReturn(0); 42276083293cSBarry Smith } 42286083293cSBarry Smith 42296083293cSBarry Smith #undef __FUNCT__ 423083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 42313a471f94SBarry Smith /*@C 423283a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 42333a471f94SBarry Smith VecView() for the error at each timestep 42343a471f94SBarry Smith 42353a471f94SBarry Smith Collective on TS 42363a471f94SBarry Smith 42373a471f94SBarry Smith Input Parameters: 42383a471f94SBarry Smith + ts - the TS context 42393a471f94SBarry Smith . step - current time-step 42403a471f94SBarry Smith . ptime - current time 42410298fd71SBarry Smith - dummy - either a viewer or NULL 42423a471f94SBarry Smith 42433a471f94SBarry Smith Level: intermediate 42443a471f94SBarry Smith 42453a471f94SBarry Smith .keywords: TS, vector, monitor, view 42463a471f94SBarry Smith 42473a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 42483a471f94SBarry Smith @*/ 42490910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 42503a471f94SBarry Smith { 42513a471f94SBarry Smith PetscErrorCode ierr; 425283a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 425383a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 42543a471f94SBarry Smith Vec work; 42553a471f94SBarry Smith 42563a471f94SBarry Smith PetscFunctionBegin; 4257b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 42580910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 42593a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 42600910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 42613a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 42623a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 42633a471f94SBarry Smith PetscFunctionReturn(0); 42643a471f94SBarry Smith } 42653a471f94SBarry Smith 4266af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 42673a471f94SBarry Smith #undef __FUNCT__ 42686c699258SBarry Smith #define __FUNCT__ "TSSetDM" 42696c699258SBarry Smith /*@ 42706c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 42716c699258SBarry Smith 42723f9fe445SBarry Smith Logically Collective on TS and DM 42736c699258SBarry Smith 42746c699258SBarry Smith Input Parameters: 42756c699258SBarry Smith + ts - the preconditioner context 42766c699258SBarry Smith - dm - the dm 42776c699258SBarry Smith 42786c699258SBarry Smith Level: intermediate 42796c699258SBarry Smith 42806c699258SBarry Smith 42816c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 42826c699258SBarry Smith @*/ 42837087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 42846c699258SBarry Smith { 42856c699258SBarry Smith PetscErrorCode ierr; 4286089b2837SJed Brown SNES snes; 4287942e3340SBarry Smith DMTS tsdm; 42886c699258SBarry Smith 42896c699258SBarry Smith PetscFunctionBegin; 42900700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 429170663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4292942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 42932a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4294942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4295942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 429624989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 429724989b8cSPeter Brune tsdm->originaldm = dm; 429824989b8cSPeter Brune } 429924989b8cSPeter Brune } 43006bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 430124989b8cSPeter Brune } 43026c699258SBarry Smith ts->dm = dm; 4303bbd56ea5SKarl Rupp 4304089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4305089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 43066c699258SBarry Smith PetscFunctionReturn(0); 43076c699258SBarry Smith } 43086c699258SBarry Smith 43096c699258SBarry Smith #undef __FUNCT__ 43106c699258SBarry Smith #define __FUNCT__ "TSGetDM" 43116c699258SBarry Smith /*@ 43126c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 43136c699258SBarry Smith 43143f9fe445SBarry Smith Not Collective 43156c699258SBarry Smith 43166c699258SBarry Smith Input Parameter: 43176c699258SBarry Smith . ts - the preconditioner context 43186c699258SBarry Smith 43196c699258SBarry Smith Output Parameter: 43206c699258SBarry Smith . dm - the dm 43216c699258SBarry Smith 43226c699258SBarry Smith Level: intermediate 43236c699258SBarry Smith 43246c699258SBarry Smith 43256c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 43266c699258SBarry Smith @*/ 43277087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 43286c699258SBarry Smith { 4329496e6a7aSJed Brown PetscErrorCode ierr; 4330496e6a7aSJed Brown 43316c699258SBarry Smith PetscFunctionBegin; 43320700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4333496e6a7aSJed Brown if (!ts->dm) { 4334ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4335496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4336496e6a7aSJed Brown } 43376c699258SBarry Smith *dm = ts->dm; 43386c699258SBarry Smith PetscFunctionReturn(0); 43396c699258SBarry Smith } 43401713a123SBarry Smith 43410f5c6efeSJed Brown #undef __FUNCT__ 43420f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 43430f5c6efeSJed Brown /*@ 43440f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 43450f5c6efeSJed Brown 43463f9fe445SBarry Smith Logically Collective on SNES 43470f5c6efeSJed Brown 43480f5c6efeSJed Brown Input Parameter: 4349d42a1c89SJed Brown + snes - nonlinear solver 43500910c330SBarry Smith . U - the current state at which to evaluate the residual 4351d42a1c89SJed Brown - ctx - user context, must be a TS 43520f5c6efeSJed Brown 43530f5c6efeSJed Brown Output Parameter: 43540f5c6efeSJed Brown . F - the nonlinear residual 43550f5c6efeSJed Brown 43560f5c6efeSJed Brown Notes: 43570f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 43580f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 43590f5c6efeSJed Brown 43600f5c6efeSJed Brown Level: advanced 43610f5c6efeSJed Brown 43620f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 43630f5c6efeSJed Brown @*/ 43640910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 43650f5c6efeSJed Brown { 43660f5c6efeSJed Brown TS ts = (TS)ctx; 43670f5c6efeSJed Brown PetscErrorCode ierr; 43680f5c6efeSJed Brown 43690f5c6efeSJed Brown PetscFunctionBegin; 43700f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 43710910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 43720f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 43730f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 43740910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 43750f5c6efeSJed Brown PetscFunctionReturn(0); 43760f5c6efeSJed Brown } 43770f5c6efeSJed Brown 43780f5c6efeSJed Brown #undef __FUNCT__ 43790f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 43800f5c6efeSJed Brown /*@ 43810f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 43820f5c6efeSJed Brown 43830f5c6efeSJed Brown Collective on SNES 43840f5c6efeSJed Brown 43850f5c6efeSJed Brown Input Parameter: 43860f5c6efeSJed Brown + snes - nonlinear solver 43870910c330SBarry Smith . U - the current state at which to evaluate the residual 43880f5c6efeSJed Brown - ctx - user context, must be a TS 43890f5c6efeSJed Brown 43900f5c6efeSJed Brown Output Parameter: 43910f5c6efeSJed Brown + A - the Jacobian 43920f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 43930f5c6efeSJed Brown - flag - indicates any structure change in the matrix 43940f5c6efeSJed Brown 43950f5c6efeSJed Brown Notes: 43960f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 43970f5c6efeSJed Brown 43980f5c6efeSJed Brown Level: developer 43990f5c6efeSJed Brown 44000f5c6efeSJed Brown .seealso: SNESSetJacobian() 44010f5c6efeSJed Brown @*/ 4402d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 44030f5c6efeSJed Brown { 44040f5c6efeSJed Brown TS ts = (TS)ctx; 44050f5c6efeSJed Brown PetscErrorCode ierr; 44060f5c6efeSJed Brown 44070f5c6efeSJed Brown PetscFunctionBegin; 44080f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 44090910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 44100f5c6efeSJed Brown PetscValidPointer(A,3); 441194ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 44120f5c6efeSJed Brown PetscValidPointer(B,4); 441394ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 44140f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 4415d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 44160f5c6efeSJed Brown PetscFunctionReturn(0); 44170f5c6efeSJed Brown } 4418325fc9f4SBarry Smith 44190e4ef248SJed Brown #undef __FUNCT__ 44200e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 44210e4ef248SJed Brown /*@C 44220e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 44230e4ef248SJed Brown 44240e4ef248SJed Brown Collective on TS 44250e4ef248SJed Brown 44260e4ef248SJed Brown Input Arguments: 44270e4ef248SJed Brown + ts - time stepping context 44280e4ef248SJed Brown . t - time at which to evaluate 44290910c330SBarry Smith . U - state at which to evaluate 44300e4ef248SJed Brown - ctx - context 44310e4ef248SJed Brown 44320e4ef248SJed Brown Output Arguments: 44330e4ef248SJed Brown . F - right hand side 44340e4ef248SJed Brown 44350e4ef248SJed Brown Level: intermediate 44360e4ef248SJed Brown 44370e4ef248SJed Brown Notes: 44380e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 44390e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 44400e4ef248SJed Brown 44410e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 44420e4ef248SJed Brown @*/ 44430910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 44440e4ef248SJed Brown { 44450e4ef248SJed Brown PetscErrorCode ierr; 44460e4ef248SJed Brown Mat Arhs,Brhs; 44470e4ef248SJed Brown 44480e4ef248SJed Brown PetscFunctionBegin; 44490e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 4450d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 44510910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 44520e4ef248SJed Brown PetscFunctionReturn(0); 44530e4ef248SJed Brown } 44540e4ef248SJed Brown 44550e4ef248SJed Brown #undef __FUNCT__ 44560e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 44570e4ef248SJed Brown /*@C 44580e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 44590e4ef248SJed Brown 44600e4ef248SJed Brown Collective on TS 44610e4ef248SJed Brown 44620e4ef248SJed Brown Input Arguments: 44630e4ef248SJed Brown + ts - time stepping context 44640e4ef248SJed Brown . t - time at which to evaluate 44650910c330SBarry Smith . U - state at which to evaluate 44660e4ef248SJed Brown - ctx - context 44670e4ef248SJed Brown 44680e4ef248SJed Brown Output Arguments: 44690e4ef248SJed Brown + A - pointer to operator 44700e4ef248SJed Brown . B - pointer to preconditioning matrix 44710e4ef248SJed Brown - flg - matrix structure flag 44720e4ef248SJed Brown 44730e4ef248SJed Brown Level: intermediate 44740e4ef248SJed Brown 44750e4ef248SJed Brown Notes: 44760e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 44770e4ef248SJed Brown 44780e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 44790e4ef248SJed Brown @*/ 4480d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 44810e4ef248SJed Brown { 44820e4ef248SJed Brown PetscFunctionBegin; 44830e4ef248SJed Brown PetscFunctionReturn(0); 44840e4ef248SJed Brown } 44850e4ef248SJed Brown 44860026cea9SSean Farley #undef __FUNCT__ 44870026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 44880026cea9SSean Farley /*@C 44890026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 44900026cea9SSean Farley 44910026cea9SSean Farley Collective on TS 44920026cea9SSean Farley 44930026cea9SSean Farley Input Arguments: 44940026cea9SSean Farley + ts - time stepping context 44950026cea9SSean Farley . t - time at which to evaluate 44960910c330SBarry Smith . U - state at which to evaluate 44970910c330SBarry Smith . Udot - time derivative of state vector 44980026cea9SSean Farley - ctx - context 44990026cea9SSean Farley 45000026cea9SSean Farley Output Arguments: 45010026cea9SSean Farley . F - left hand side 45020026cea9SSean Farley 45030026cea9SSean Farley Level: intermediate 45040026cea9SSean Farley 45050026cea9SSean Farley Notes: 45060910c330SBarry Smith The assumption here is that the left hand side is of the form A*Udot (and not A*Udot + B*U). For other cases, the 45070026cea9SSean Farley user is required to write their own TSComputeIFunction. 45080026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 45090026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 45100026cea9SSean Farley 45110026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 45120026cea9SSean Farley @*/ 45130910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 45140026cea9SSean Farley { 45150026cea9SSean Farley PetscErrorCode ierr; 45160026cea9SSean Farley Mat A,B; 45170026cea9SSean Farley 45180026cea9SSean Farley PetscFunctionBegin; 45190298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4520d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 45210910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 45220026cea9SSean Farley PetscFunctionReturn(0); 45230026cea9SSean Farley } 45240026cea9SSean Farley 45250026cea9SSean Farley #undef __FUNCT__ 45260026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 45270026cea9SSean Farley /*@C 4528b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 45290026cea9SSean Farley 45300026cea9SSean Farley Collective on TS 45310026cea9SSean Farley 45320026cea9SSean Farley Input Arguments: 45330026cea9SSean Farley + ts - time stepping context 45340026cea9SSean Farley . t - time at which to evaluate 45350910c330SBarry Smith . U - state at which to evaluate 45360910c330SBarry Smith . Udot - time derivative of state vector 45370026cea9SSean Farley . shift - shift to apply 45380026cea9SSean Farley - ctx - context 45390026cea9SSean Farley 45400026cea9SSean Farley Output Arguments: 45410026cea9SSean Farley + A - pointer to operator 45420026cea9SSean Farley . B - pointer to preconditioning matrix 45430026cea9SSean Farley - flg - matrix structure flag 45440026cea9SSean Farley 4545b41af12eSJed Brown Level: advanced 45460026cea9SSean Farley 45470026cea9SSean Farley Notes: 45480026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 45490026cea9SSean Farley 4550b41af12eSJed Brown It is only appropriate for problems of the form 4551b41af12eSJed Brown 4552b41af12eSJed Brown $ M Udot = F(U,t) 4553b41af12eSJed Brown 4554b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4555b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4556b41af12eSJed Brown an implicit operator of the form 4557b41af12eSJed Brown 4558b41af12eSJed Brown $ shift*M + J 4559b41af12eSJed Brown 4560b41af12eSJed Brown where J is the Jacobian of -F(U). Support may be added in a future version of PETSc, but for now, the user must store 4561b41af12eSJed Brown a copy of M or reassemble it when requested. 4562b41af12eSJed Brown 45630026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 45640026cea9SSean Farley @*/ 4565d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 45660026cea9SSean Farley { 4567b41af12eSJed Brown PetscErrorCode ierr; 4568b41af12eSJed Brown 45690026cea9SSean Farley PetscFunctionBegin; 457094ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4571b41af12eSJed Brown ts->ijacobian.shift = shift; 45720026cea9SSean Farley PetscFunctionReturn(0); 45730026cea9SSean Farley } 4574b41af12eSJed Brown 4575e817cc15SEmil Constantinescu #undef __FUNCT__ 4576e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType" 4577e817cc15SEmil Constantinescu /*@ 4578e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4579e817cc15SEmil Constantinescu 4580e817cc15SEmil Constantinescu Not Collective 4581e817cc15SEmil Constantinescu 4582e817cc15SEmil Constantinescu Input Parameter: 4583e817cc15SEmil Constantinescu . ts - the TS context 4584e817cc15SEmil Constantinescu 4585e817cc15SEmil Constantinescu Output Parameter: 45864e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4587e817cc15SEmil Constantinescu 4588e817cc15SEmil Constantinescu Level: beginner 4589e817cc15SEmil Constantinescu 4590e817cc15SEmil Constantinescu .keywords: TS, equation type 4591e817cc15SEmil Constantinescu 4592e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4593e817cc15SEmil Constantinescu @*/ 4594e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4595e817cc15SEmil Constantinescu { 4596e817cc15SEmil Constantinescu PetscFunctionBegin; 4597e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4598e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4599e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4600e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4601e817cc15SEmil Constantinescu } 4602e817cc15SEmil Constantinescu 4603e817cc15SEmil Constantinescu #undef __FUNCT__ 4604e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType" 4605e817cc15SEmil Constantinescu /*@ 4606e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4607e817cc15SEmil Constantinescu 4608e817cc15SEmil Constantinescu Not Collective 4609e817cc15SEmil Constantinescu 4610e817cc15SEmil Constantinescu Input Parameter: 4611e817cc15SEmil Constantinescu + ts - the TS context 46121297b224SEmil Constantinescu - equation_type - see TSEquationType 4613e817cc15SEmil Constantinescu 4614e817cc15SEmil Constantinescu Level: advanced 4615e817cc15SEmil Constantinescu 4616e817cc15SEmil Constantinescu .keywords: TS, equation type 4617e817cc15SEmil Constantinescu 4618e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4619e817cc15SEmil Constantinescu @*/ 4620e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4621e817cc15SEmil Constantinescu { 4622e817cc15SEmil Constantinescu PetscFunctionBegin; 4623e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4624e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4625e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4626e817cc15SEmil Constantinescu } 46270026cea9SSean Farley 46284af1b03aSJed Brown #undef __FUNCT__ 46294af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 46304af1b03aSJed Brown /*@ 46314af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 46324af1b03aSJed Brown 46334af1b03aSJed Brown Not Collective 46344af1b03aSJed Brown 46354af1b03aSJed Brown Input Parameter: 46364af1b03aSJed Brown . ts - the TS context 46374af1b03aSJed Brown 46384af1b03aSJed Brown Output Parameter: 46394af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 46404af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 46414af1b03aSJed Brown 4642487e0bb9SJed Brown Level: beginner 46434af1b03aSJed Brown 4644cd652676SJed Brown Notes: 4645cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 46464af1b03aSJed Brown 46474af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 46484af1b03aSJed Brown 46494af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 46504af1b03aSJed Brown @*/ 46514af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 46524af1b03aSJed Brown { 46534af1b03aSJed Brown PetscFunctionBegin; 46544af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46554af1b03aSJed Brown PetscValidPointer(reason,2); 46564af1b03aSJed Brown *reason = ts->reason; 46574af1b03aSJed Brown PetscFunctionReturn(0); 46584af1b03aSJed Brown } 46594af1b03aSJed Brown 4660fb1732b5SBarry Smith #undef __FUNCT__ 4661d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason" 4662d6ad946cSShri Abhyankar /*@ 4663d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 4664d6ad946cSShri Abhyankar 4665d6ad946cSShri Abhyankar Not Collective 4666d6ad946cSShri Abhyankar 4667d6ad946cSShri Abhyankar Input Parameter: 4668d6ad946cSShri Abhyankar + ts - the TS context 4669d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 4670d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 4671d6ad946cSShri Abhyankar 4672f5abba47SShri Abhyankar Level: advanced 4673d6ad946cSShri Abhyankar 4674d6ad946cSShri Abhyankar Notes: 4675d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 4676d6ad946cSShri Abhyankar 4677d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 4678d6ad946cSShri Abhyankar 4679d6ad946cSShri Abhyankar .seealso: TSConvergedReason 4680d6ad946cSShri Abhyankar @*/ 4681d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 4682d6ad946cSShri Abhyankar { 4683d6ad946cSShri Abhyankar PetscFunctionBegin; 4684d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4685d6ad946cSShri Abhyankar ts->reason = reason; 4686d6ad946cSShri Abhyankar PetscFunctionReturn(0); 4687d6ad946cSShri Abhyankar } 4688d6ad946cSShri Abhyankar 4689d6ad946cSShri Abhyankar #undef __FUNCT__ 4690cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 4691cc708dedSBarry Smith /*@ 4692cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 4693cc708dedSBarry Smith 4694cc708dedSBarry Smith Not Collective 4695cc708dedSBarry Smith 4696cc708dedSBarry Smith Input Parameter: 4697cc708dedSBarry Smith . ts - the TS context 4698cc708dedSBarry Smith 4699cc708dedSBarry Smith Output Parameter: 4700cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 4701cc708dedSBarry Smith 4702487e0bb9SJed Brown Level: beginner 4703cc708dedSBarry Smith 4704cc708dedSBarry Smith Notes: 4705cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 4706cc708dedSBarry Smith 4707cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 4708cc708dedSBarry Smith 4709cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 4710cc708dedSBarry Smith @*/ 4711cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 4712cc708dedSBarry Smith { 4713cc708dedSBarry Smith PetscFunctionBegin; 4714cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4715cc708dedSBarry Smith PetscValidPointer(ftime,2); 4716cc708dedSBarry Smith *ftime = ts->solvetime; 4717cc708dedSBarry Smith PetscFunctionReturn(0); 4718cc708dedSBarry Smith } 4719cc708dedSBarry Smith 4720cc708dedSBarry Smith #undef __FUNCT__ 47212c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps" 47222c18e0fdSBarry Smith /*@ 47232c18e0fdSBarry Smith TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 47242c18e0fdSBarry Smith 47252c18e0fdSBarry Smith Not Collective 47262c18e0fdSBarry Smith 47272c18e0fdSBarry Smith Input Parameter: 47282c18e0fdSBarry Smith . ts - the TS context 47292c18e0fdSBarry Smith 47302c18e0fdSBarry Smith Output Parameter: 47312c18e0fdSBarry Smith . steps - the number of steps 47322c18e0fdSBarry Smith 47332c18e0fdSBarry Smith Level: beginner 47342c18e0fdSBarry Smith 47352c18e0fdSBarry Smith Notes: 47362c18e0fdSBarry Smith Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 47372c18e0fdSBarry Smith 47382c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test 47392c18e0fdSBarry Smith 47402c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 47412c18e0fdSBarry Smith @*/ 47422c18e0fdSBarry Smith PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 47432c18e0fdSBarry Smith { 47442c18e0fdSBarry Smith PetscFunctionBegin; 47452c18e0fdSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 47462c18e0fdSBarry Smith PetscValidPointer(steps,2); 47472c18e0fdSBarry Smith *steps = ts->total_steps; 47482c18e0fdSBarry Smith PetscFunctionReturn(0); 47492c18e0fdSBarry Smith } 47502c18e0fdSBarry Smith 47512c18e0fdSBarry Smith #undef __FUNCT__ 47525ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 47539f67acb7SJed Brown /*@ 47545ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 47559f67acb7SJed Brown used by the time integrator. 47569f67acb7SJed Brown 47579f67acb7SJed Brown Not Collective 47589f67acb7SJed Brown 47599f67acb7SJed Brown Input Parameter: 47609f67acb7SJed Brown . ts - TS context 47619f67acb7SJed Brown 47629f67acb7SJed Brown Output Parameter: 47639f67acb7SJed Brown . nits - number of nonlinear iterations 47649f67acb7SJed Brown 47659f67acb7SJed Brown Notes: 47669f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 47679f67acb7SJed Brown 47689f67acb7SJed Brown Level: intermediate 47699f67acb7SJed Brown 47709f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 47719f67acb7SJed Brown 47725ef26d82SJed Brown .seealso: TSGetKSPIterations() 47739f67acb7SJed Brown @*/ 47745ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 47759f67acb7SJed Brown { 47769f67acb7SJed Brown PetscFunctionBegin; 47779f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 47789f67acb7SJed Brown PetscValidIntPointer(nits,2); 47795ef26d82SJed Brown *nits = ts->snes_its; 47809f67acb7SJed Brown PetscFunctionReturn(0); 47819f67acb7SJed Brown } 47829f67acb7SJed Brown 47839f67acb7SJed Brown #undef __FUNCT__ 47845ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 47859f67acb7SJed Brown /*@ 47865ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 47879f67acb7SJed Brown used by the time integrator. 47889f67acb7SJed Brown 47899f67acb7SJed Brown Not Collective 47909f67acb7SJed Brown 47919f67acb7SJed Brown Input Parameter: 47929f67acb7SJed Brown . ts - TS context 47939f67acb7SJed Brown 47949f67acb7SJed Brown Output Parameter: 47959f67acb7SJed Brown . lits - number of linear iterations 47969f67acb7SJed Brown 47979f67acb7SJed Brown Notes: 47989f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 47999f67acb7SJed Brown 48009f67acb7SJed Brown Level: intermediate 48019f67acb7SJed Brown 48029f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 48039f67acb7SJed Brown 48045ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 48059f67acb7SJed Brown @*/ 48065ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 48079f67acb7SJed Brown { 48089f67acb7SJed Brown PetscFunctionBegin; 48099f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 48109f67acb7SJed Brown PetscValidIntPointer(lits,2); 48115ef26d82SJed Brown *lits = ts->ksp_its; 48129f67acb7SJed Brown PetscFunctionReturn(0); 48139f67acb7SJed Brown } 48149f67acb7SJed Brown 48159f67acb7SJed Brown #undef __FUNCT__ 4816cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 4817cef5090cSJed Brown /*@ 4818cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 4819cef5090cSJed Brown 4820cef5090cSJed Brown Not Collective 4821cef5090cSJed Brown 4822cef5090cSJed Brown Input Parameter: 4823cef5090cSJed Brown . ts - TS context 4824cef5090cSJed Brown 4825cef5090cSJed Brown Output Parameter: 4826cef5090cSJed Brown . rejects - number of steps rejected 4827cef5090cSJed Brown 4828cef5090cSJed Brown Notes: 4829cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4830cef5090cSJed Brown 4831cef5090cSJed Brown Level: intermediate 4832cef5090cSJed Brown 4833cef5090cSJed Brown .keywords: TS, get, number 4834cef5090cSJed Brown 48355ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 4836cef5090cSJed Brown @*/ 4837cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 4838cef5090cSJed Brown { 4839cef5090cSJed Brown PetscFunctionBegin; 4840cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4841cef5090cSJed Brown PetscValidIntPointer(rejects,2); 4842cef5090cSJed Brown *rejects = ts->reject; 4843cef5090cSJed Brown PetscFunctionReturn(0); 4844cef5090cSJed Brown } 4845cef5090cSJed Brown 4846cef5090cSJed Brown #undef __FUNCT__ 4847cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 4848cef5090cSJed Brown /*@ 4849cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 4850cef5090cSJed Brown 4851cef5090cSJed Brown Not Collective 4852cef5090cSJed Brown 4853cef5090cSJed Brown Input Parameter: 4854cef5090cSJed Brown . ts - TS context 4855cef5090cSJed Brown 4856cef5090cSJed Brown Output Parameter: 4857cef5090cSJed Brown . fails - number of failed nonlinear solves 4858cef5090cSJed Brown 4859cef5090cSJed Brown Notes: 4860cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4861cef5090cSJed Brown 4862cef5090cSJed Brown Level: intermediate 4863cef5090cSJed Brown 4864cef5090cSJed Brown .keywords: TS, get, number 4865cef5090cSJed Brown 48665ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 4867cef5090cSJed Brown @*/ 4868cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 4869cef5090cSJed Brown { 4870cef5090cSJed Brown PetscFunctionBegin; 4871cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4872cef5090cSJed Brown PetscValidIntPointer(fails,2); 4873cef5090cSJed Brown *fails = ts->num_snes_failures; 4874cef5090cSJed Brown PetscFunctionReturn(0); 4875cef5090cSJed Brown } 4876cef5090cSJed Brown 4877cef5090cSJed Brown #undef __FUNCT__ 4878cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 4879cef5090cSJed Brown /*@ 4880cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 4881cef5090cSJed Brown 4882cef5090cSJed Brown Not Collective 4883cef5090cSJed Brown 4884cef5090cSJed Brown Input Parameter: 4885cef5090cSJed Brown + ts - TS context 4886cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 4887cef5090cSJed Brown 4888cef5090cSJed Brown Notes: 4889cef5090cSJed Brown The counter is reset to zero for each step 4890cef5090cSJed Brown 4891cef5090cSJed Brown Options Database Key: 4892cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 4893cef5090cSJed Brown 4894cef5090cSJed Brown Level: intermediate 4895cef5090cSJed Brown 4896cef5090cSJed Brown .keywords: TS, set, maximum, number 4897cef5090cSJed Brown 48985ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4899cef5090cSJed Brown @*/ 4900cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 4901cef5090cSJed Brown { 4902cef5090cSJed Brown PetscFunctionBegin; 4903cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4904cef5090cSJed Brown ts->max_reject = rejects; 4905cef5090cSJed Brown PetscFunctionReturn(0); 4906cef5090cSJed Brown } 4907cef5090cSJed Brown 4908cef5090cSJed Brown #undef __FUNCT__ 4909cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 4910cef5090cSJed Brown /*@ 4911cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 4912cef5090cSJed Brown 4913cef5090cSJed Brown Not Collective 4914cef5090cSJed Brown 4915cef5090cSJed Brown Input Parameter: 4916cef5090cSJed Brown + ts - TS context 4917cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4918cef5090cSJed Brown 4919cef5090cSJed Brown Notes: 4920cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 4921cef5090cSJed Brown 4922cef5090cSJed Brown Options Database Key: 4923cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4924cef5090cSJed Brown 4925cef5090cSJed Brown Level: intermediate 4926cef5090cSJed Brown 4927cef5090cSJed Brown .keywords: TS, set, maximum, number 4928cef5090cSJed Brown 49295ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 4930cef5090cSJed Brown @*/ 4931cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 4932cef5090cSJed Brown { 4933cef5090cSJed Brown PetscFunctionBegin; 4934cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4935cef5090cSJed Brown ts->max_snes_failures = fails; 4936cef5090cSJed Brown PetscFunctionReturn(0); 4937cef5090cSJed Brown } 4938cef5090cSJed Brown 4939cef5090cSJed Brown #undef __FUNCT__ 49404e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails" 4941cef5090cSJed Brown /*@ 4942cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 4943cef5090cSJed Brown 4944cef5090cSJed Brown Not Collective 4945cef5090cSJed Brown 4946cef5090cSJed Brown Input Parameter: 4947cef5090cSJed Brown + ts - TS context 4948cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 4949cef5090cSJed Brown 4950cef5090cSJed Brown Options Database Key: 4951cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 4952cef5090cSJed Brown 4953cef5090cSJed Brown Level: intermediate 4954cef5090cSJed Brown 4955cef5090cSJed Brown .keywords: TS, set, error 4956cef5090cSJed Brown 49575ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4958cef5090cSJed Brown @*/ 4959cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 4960cef5090cSJed Brown { 4961cef5090cSJed Brown PetscFunctionBegin; 4962cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4963cef5090cSJed Brown ts->errorifstepfailed = err; 4964cef5090cSJed Brown PetscFunctionReturn(0); 4965cef5090cSJed Brown } 4966cef5090cSJed Brown 4967cef5090cSJed Brown #undef __FUNCT__ 4968fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 4969fb1732b5SBarry Smith /*@C 4970fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 4971fb1732b5SBarry Smith 4972fb1732b5SBarry Smith Collective on TS 4973fb1732b5SBarry Smith 4974fb1732b5SBarry Smith Input Parameters: 4975fb1732b5SBarry Smith + ts - the TS context 4976fb1732b5SBarry Smith . step - current time-step 4977fb1732b5SBarry Smith . ptime - current time 49780910c330SBarry Smith . u - current state 4979fb1732b5SBarry Smith - viewer - binary viewer 4980fb1732b5SBarry Smith 4981fb1732b5SBarry Smith Level: intermediate 4982fb1732b5SBarry Smith 4983fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 4984fb1732b5SBarry Smith 4985fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4986fb1732b5SBarry Smith @*/ 49870910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 4988fb1732b5SBarry Smith { 4989fb1732b5SBarry Smith PetscErrorCode ierr; 4990ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 4991fb1732b5SBarry Smith 4992fb1732b5SBarry Smith PetscFunctionBegin; 49930910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 4994ed81e22dSJed Brown PetscFunctionReturn(0); 4995ed81e22dSJed Brown } 4996ed81e22dSJed Brown 4997ed81e22dSJed Brown #undef __FUNCT__ 4998ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 4999ed81e22dSJed Brown /*@C 5000ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5001ed81e22dSJed Brown 5002ed81e22dSJed Brown Collective on TS 5003ed81e22dSJed Brown 5004ed81e22dSJed Brown Input Parameters: 5005ed81e22dSJed Brown + ts - the TS context 5006ed81e22dSJed Brown . step - current time-step 5007ed81e22dSJed Brown . ptime - current time 50080910c330SBarry Smith . u - current state 5009ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5010ed81e22dSJed Brown 5011ed81e22dSJed Brown Level: intermediate 5012ed81e22dSJed Brown 5013ed81e22dSJed Brown Notes: 5014ed81e22dSJed Brown The VTK format does not allow writing multiple time steps in the same file, therefore a different file will be written for each time step. 5015ed81e22dSJed Brown These are named according to the file name template. 5016ed81e22dSJed Brown 5017ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5018ed81e22dSJed Brown 5019ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5020ed81e22dSJed Brown 5021ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5022ed81e22dSJed Brown @*/ 50230910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5024ed81e22dSJed Brown { 5025ed81e22dSJed Brown PetscErrorCode ierr; 5026ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5027ed81e22dSJed Brown PetscViewer viewer; 5028ed81e22dSJed Brown 5029ed81e22dSJed Brown PetscFunctionBegin; 50308caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5031ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 50320910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5033ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5034ed81e22dSJed Brown PetscFunctionReturn(0); 5035ed81e22dSJed Brown } 5036ed81e22dSJed Brown 5037ed81e22dSJed Brown #undef __FUNCT__ 5038ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 5039ed81e22dSJed Brown /*@C 5040ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5041ed81e22dSJed Brown 5042ed81e22dSJed Brown Collective on TS 5043ed81e22dSJed Brown 5044ed81e22dSJed Brown Input Parameters: 5045ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5046ed81e22dSJed Brown 5047ed81e22dSJed Brown Level: intermediate 5048ed81e22dSJed Brown 5049ed81e22dSJed Brown Note: 5050ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5051ed81e22dSJed Brown 5052ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5053ed81e22dSJed Brown 5054ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5055ed81e22dSJed Brown @*/ 5056ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5057ed81e22dSJed Brown { 5058ed81e22dSJed Brown PetscErrorCode ierr; 5059ed81e22dSJed Brown 5060ed81e22dSJed Brown PetscFunctionBegin; 5061ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5062fb1732b5SBarry Smith PetscFunctionReturn(0); 5063fb1732b5SBarry Smith } 5064fb1732b5SBarry Smith 506584df9cb4SJed Brown #undef __FUNCT__ 5066552698daSJed Brown #define __FUNCT__ "TSGetAdapt" 506784df9cb4SJed Brown /*@ 5068552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 506984df9cb4SJed Brown 5070ed81e22dSJed Brown Collective on TS if controller has not been created yet 507184df9cb4SJed Brown 507284df9cb4SJed Brown Input Arguments: 5073ed81e22dSJed Brown . ts - time stepping context 507484df9cb4SJed Brown 507584df9cb4SJed Brown Output Arguments: 5076ed81e22dSJed Brown . adapt - adaptive controller 507784df9cb4SJed Brown 507884df9cb4SJed Brown Level: intermediate 507984df9cb4SJed Brown 5080ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 508184df9cb4SJed Brown @*/ 5082552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 508384df9cb4SJed Brown { 508484df9cb4SJed Brown PetscErrorCode ierr; 508584df9cb4SJed Brown 508684df9cb4SJed Brown PetscFunctionBegin; 508784df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 508884df9cb4SJed Brown PetscValidPointer(adapt,2); 508984df9cb4SJed Brown if (!ts->adapt) { 5090ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 50913bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 50921c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 509384df9cb4SJed Brown } 509484df9cb4SJed Brown *adapt = ts->adapt; 509584df9cb4SJed Brown PetscFunctionReturn(0); 509684df9cb4SJed Brown } 5097d6ebe24aSShri Abhyankar 5098d6ebe24aSShri Abhyankar #undef __FUNCT__ 50991c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 51001c3436cfSJed Brown /*@ 51011c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 51021c3436cfSJed Brown 51031c3436cfSJed Brown Logically Collective 51041c3436cfSJed Brown 51051c3436cfSJed Brown Input Arguments: 51061c3436cfSJed Brown + ts - time integration context 51071c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 51080298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 51091c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 51100298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 51111c3436cfSJed Brown 5112a3cdaa26SBarry Smith Options Database keys: 5113a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5114a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5115a3cdaa26SBarry Smith 51163ff766beSShri Abhyankar Notes: 51173ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 51183ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 51193ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 51203ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 51213ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 51223ff766beSShri Abhyankar differential variables. 51233ff766beSShri Abhyankar 51241c3436cfSJed Brown Level: beginner 51251c3436cfSJed Brown 5126c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 51271c3436cfSJed Brown @*/ 51281c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 51291c3436cfSJed Brown { 51301c3436cfSJed Brown PetscErrorCode ierr; 51311c3436cfSJed Brown 51321c3436cfSJed Brown PetscFunctionBegin; 5133c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 51341c3436cfSJed Brown if (vatol) { 51351c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 51361c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 5137bbd56ea5SKarl Rupp 51381c3436cfSJed Brown ts->vatol = vatol; 51391c3436cfSJed Brown } 5140c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 51411c3436cfSJed Brown if (vrtol) { 51421c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 51431c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 5144bbd56ea5SKarl Rupp 51451c3436cfSJed Brown ts->vrtol = vrtol; 51461c3436cfSJed Brown } 51471c3436cfSJed Brown PetscFunctionReturn(0); 51481c3436cfSJed Brown } 51491c3436cfSJed Brown 51501c3436cfSJed Brown #undef __FUNCT__ 5151c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 5152c5033834SJed Brown /*@ 5153c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5154c5033834SJed Brown 5155c5033834SJed Brown Logically Collective 5156c5033834SJed Brown 5157c5033834SJed Brown Input Arguments: 5158c5033834SJed Brown . ts - time integration context 5159c5033834SJed Brown 5160c5033834SJed Brown Output Arguments: 51610298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 51620298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 51630298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 51640298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5165c5033834SJed Brown 5166c5033834SJed Brown Level: beginner 5167c5033834SJed Brown 5168c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5169c5033834SJed Brown @*/ 5170c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5171c5033834SJed Brown { 5172c5033834SJed Brown PetscFunctionBegin; 5173c5033834SJed Brown if (atol) *atol = ts->atol; 5174c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5175c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5176c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5177c5033834SJed Brown PetscFunctionReturn(0); 5178c5033834SJed Brown } 5179c5033834SJed Brown 5180c5033834SJed Brown #undef __FUNCT__ 51819c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2" 51829c6b16b5SShri Abhyankar /*@ 5183a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 51849c6b16b5SShri Abhyankar 51859c6b16b5SShri Abhyankar Collective on TS 51869c6b16b5SShri Abhyankar 51879c6b16b5SShri Abhyankar Input Arguments: 51889c6b16b5SShri Abhyankar + ts - time stepping context 5189a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5190a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 51919c6b16b5SShri Abhyankar 51929c6b16b5SShri Abhyankar Output Arguments: 51939c6b16b5SShri Abhyankar . norm - weighted norm, a value of 1.0 is considered small 51949c6b16b5SShri Abhyankar 51959c6b16b5SShri Abhyankar Level: developer 51969c6b16b5SShri Abhyankar 5197deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 51989c6b16b5SShri Abhyankar @*/ 5199a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm) 52009c6b16b5SShri Abhyankar { 52019c6b16b5SShri Abhyankar PetscErrorCode ierr; 52029c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 52039c6b16b5SShri Abhyankar const PetscScalar *u,*y; 52049c6b16b5SShri Abhyankar PetscReal sum,gsum; 52059c6b16b5SShri Abhyankar PetscReal tol; 52069c6b16b5SShri Abhyankar 52079c6b16b5SShri Abhyankar PetscFunctionBegin; 52089c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5209a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5210a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5211a4868fbcSLisandro Dalcin PetscValidType(U,2); 5212a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5213a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5214a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 5215a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 52169c6b16b5SShri Abhyankar 52179c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 52189c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 52199c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 52209c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 52219c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 52229c6b16b5SShri Abhyankar sum = 0.; 52239c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 52249c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 52259c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52269c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52279c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 52289c6b16b5SShri Abhyankar tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52299c6b16b5SShri Abhyankar sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 52309c6b16b5SShri Abhyankar } 52319c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52329c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52339c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 52349c6b16b5SShri Abhyankar const PetscScalar *atol; 52359c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52369c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 52379c6b16b5SShri Abhyankar tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52389c6b16b5SShri Abhyankar sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 52399c6b16b5SShri Abhyankar } 52409c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 52419c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 52429c6b16b5SShri Abhyankar const PetscScalar *rtol; 52439c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52449c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 52459c6b16b5SShri Abhyankar tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52469c6b16b5SShri Abhyankar sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 52479c6b16b5SShri Abhyankar } 52489c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 52499c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 52509c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 52519c6b16b5SShri Abhyankar tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 52529c6b16b5SShri Abhyankar sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 52539c6b16b5SShri Abhyankar } 52549c6b16b5SShri Abhyankar } 52559c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 52569c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 52579c6b16b5SShri Abhyankar 52589c6b16b5SShri Abhyankar ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 52599c6b16b5SShri Abhyankar *norm = PetscSqrtReal(gsum / N); 52609c6b16b5SShri Abhyankar 52619c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 52629c6b16b5SShri Abhyankar PetscFunctionReturn(0); 52639c6b16b5SShri Abhyankar } 52649c6b16b5SShri Abhyankar 52659c6b16b5SShri Abhyankar #undef __FUNCT__ 52669c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity" 52679c6b16b5SShri Abhyankar /*@ 5268a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 52699c6b16b5SShri Abhyankar 52709c6b16b5SShri Abhyankar Collective on TS 52719c6b16b5SShri Abhyankar 52729c6b16b5SShri Abhyankar Input Arguments: 52739c6b16b5SShri Abhyankar + ts - time stepping context 5274a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5275a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 52769c6b16b5SShri Abhyankar 52779c6b16b5SShri Abhyankar Output Arguments: 52789c6b16b5SShri Abhyankar . norm - weighted norm, a value of 1.0 is considered small 52799c6b16b5SShri Abhyankar 52809c6b16b5SShri Abhyankar Level: developer 52819c6b16b5SShri Abhyankar 5282deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 52839c6b16b5SShri Abhyankar @*/ 5284a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm) 52859c6b16b5SShri Abhyankar { 52869c6b16b5SShri Abhyankar PetscErrorCode ierr; 52879c6b16b5SShri Abhyankar PetscInt i,n,N,rstart,k; 52889c6b16b5SShri Abhyankar const PetscScalar *u,*y; 52899c6b16b5SShri Abhyankar PetscReal max,gmax; 52909c6b16b5SShri Abhyankar PetscReal tol; 52919c6b16b5SShri Abhyankar 52929c6b16b5SShri Abhyankar PetscFunctionBegin; 52939c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5294a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5295a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5296a4868fbcSLisandro Dalcin PetscValidType(U,2); 5297a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5298a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5299a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 5300a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 53019c6b16b5SShri Abhyankar 53029c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 53039c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 53049c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 53059c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 53069c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 53079c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 53089c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 53099c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53109c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53119c6b16b5SShri Abhyankar k = 0; 53129c6b16b5SShri Abhyankar tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 53139c6b16b5SShri Abhyankar max = PetscAbsScalar(y[k] - u[k]) / tol; 53149c6b16b5SShri Abhyankar for (i=1; i<n; i++) { 53159c6b16b5SShri Abhyankar tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53169c6b16b5SShri Abhyankar max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 53179c6b16b5SShri Abhyankar } 53189c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53199c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53209c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 53219c6b16b5SShri Abhyankar const PetscScalar *atol; 53229c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53239c6b16b5SShri Abhyankar k = 0; 53249c6b16b5SShri Abhyankar tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 53259c6b16b5SShri Abhyankar max = PetscAbsScalar(y[k] - u[k]) / tol; 53269c6b16b5SShri Abhyankar for (i=1; i<n; i++) { 53279c6b16b5SShri Abhyankar tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53289c6b16b5SShri Abhyankar max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 53299c6b16b5SShri Abhyankar } 53309c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53319c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 53329c6b16b5SShri Abhyankar const PetscScalar *rtol; 53339c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53349c6b16b5SShri Abhyankar k = 0; 53359c6b16b5SShri Abhyankar tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 53369c6b16b5SShri Abhyankar max = PetscAbsScalar(y[k] - u[k]) / tol; 53379c6b16b5SShri Abhyankar for (i=1; i<n; i++) { 53389c6b16b5SShri Abhyankar tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53399c6b16b5SShri Abhyankar max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 53409c6b16b5SShri Abhyankar } 53419c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53429c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 53439c6b16b5SShri Abhyankar k = 0; 53449c6b16b5SShri Abhyankar tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k])); 53459c6b16b5SShri Abhyankar max = PetscAbsScalar(y[k] - u[k]) / tol; 53469c6b16b5SShri Abhyankar for (i=1; i<n; i++) { 53479c6b16b5SShri Abhyankar tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53489c6b16b5SShri Abhyankar max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol); 53499c6b16b5SShri Abhyankar } 53509c6b16b5SShri Abhyankar } 53519c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 53529c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 53539c6b16b5SShri Abhyankar 53549c6b16b5SShri Abhyankar ierr = MPI_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 53559c6b16b5SShri Abhyankar *norm = gmax; 53569c6b16b5SShri Abhyankar 53579c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 53589c6b16b5SShri Abhyankar PetscFunctionReturn(0); 53599c6b16b5SShri Abhyankar } 53609c6b16b5SShri Abhyankar 53619c6b16b5SShri Abhyankar #undef __FUNCT__ 53627619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm" 53631c3436cfSJed Brown /*@ 5364a4868fbcSLisandro Dalcin TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors 53651c3436cfSJed Brown 53661c3436cfSJed Brown Collective on TS 53671c3436cfSJed Brown 53681c3436cfSJed Brown Input Arguments: 53691c3436cfSJed Brown + ts - time stepping context 5370a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5371a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 5372a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 53737619abb3SShri 53741c3436cfSJed Brown Output Arguments: 53751c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 53761c3436cfSJed Brown 5377a4868fbcSLisandro Dalcin 5378a4868fbcSLisandro Dalcin Options Database Keys: 5379a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5380a4868fbcSLisandro Dalcin 53811c3436cfSJed Brown Level: developer 53821c3436cfSJed Brown 5383deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 53841c3436cfSJed Brown @*/ 5385a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm) 53861c3436cfSJed Brown { 53878beabaa1SBarry Smith PetscErrorCode ierr; 53881c3436cfSJed Brown 53891c3436cfSJed Brown PetscFunctionBegin; 5390a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 5391a4868fbcSLisandro Dalcin ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr); 5392a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 5393a4868fbcSLisandro Dalcin ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr); 5394a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 53951c3436cfSJed Brown PetscFunctionReturn(0); 53961c3436cfSJed Brown } 53971c3436cfSJed Brown 53981c3436cfSJed Brown #undef __FUNCT__ 53998d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 54008d59e960SJed Brown /*@ 54018d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 54028d59e960SJed Brown 54038d59e960SJed Brown Logically Collective on TS 54048d59e960SJed Brown 54058d59e960SJed Brown Input Arguments: 54068d59e960SJed Brown + ts - time stepping context 54078d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 54088d59e960SJed Brown 54098d59e960SJed Brown Note: 54108d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 54118d59e960SJed Brown 54128d59e960SJed Brown Level: intermediate 54138d59e960SJed Brown 54148d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 54158d59e960SJed Brown @*/ 54168d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 54178d59e960SJed Brown { 54188d59e960SJed Brown PetscFunctionBegin; 54198d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54208d59e960SJed Brown ts->cfltime_local = cfltime; 54218d59e960SJed Brown ts->cfltime = -1.; 54228d59e960SJed Brown PetscFunctionReturn(0); 54238d59e960SJed Brown } 54248d59e960SJed Brown 54258d59e960SJed Brown #undef __FUNCT__ 54268d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 54278d59e960SJed Brown /*@ 54288d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 54298d59e960SJed Brown 54308d59e960SJed Brown Collective on TS 54318d59e960SJed Brown 54328d59e960SJed Brown Input Arguments: 54338d59e960SJed Brown . ts - time stepping context 54348d59e960SJed Brown 54358d59e960SJed Brown Output Arguments: 54368d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 54378d59e960SJed Brown 54388d59e960SJed Brown Level: advanced 54398d59e960SJed Brown 54408d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 54418d59e960SJed Brown @*/ 54428d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 54438d59e960SJed Brown { 54448d59e960SJed Brown PetscErrorCode ierr; 54458d59e960SJed Brown 54468d59e960SJed Brown PetscFunctionBegin; 54478d59e960SJed Brown if (ts->cfltime < 0) { 5448ce94432eSBarry Smith ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 54498d59e960SJed Brown } 54508d59e960SJed Brown *cfltime = ts->cfltime; 54518d59e960SJed Brown PetscFunctionReturn(0); 54528d59e960SJed Brown } 54538d59e960SJed Brown 54548d59e960SJed Brown #undef __FUNCT__ 5455d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 5456d6ebe24aSShri Abhyankar /*@ 5457d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 5458d6ebe24aSShri Abhyankar 5459d6ebe24aSShri Abhyankar Input Parameters: 5460d6ebe24aSShri Abhyankar . ts - the TS context. 5461d6ebe24aSShri Abhyankar . xl - lower bound. 5462d6ebe24aSShri Abhyankar . xu - upper bound. 5463d6ebe24aSShri Abhyankar 5464d6ebe24aSShri Abhyankar Notes: 5465d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 5466e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 5467d6ebe24aSShri Abhyankar 54682bd2b0e6SSatish Balay Level: advanced 54692bd2b0e6SSatish Balay 5470d6ebe24aSShri Abhyankar @*/ 5471d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 5472d6ebe24aSShri Abhyankar { 5473d6ebe24aSShri Abhyankar PetscErrorCode ierr; 5474d6ebe24aSShri Abhyankar SNES snes; 5475d6ebe24aSShri Abhyankar 5476d6ebe24aSShri Abhyankar PetscFunctionBegin; 5477d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 5478d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 5479d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 5480d6ebe24aSShri Abhyankar } 5481d6ebe24aSShri Abhyankar 5482325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 5483c6db04a5SJed Brown #include <mex.h> 5484325fc9f4SBarry Smith 5485325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 5486325fc9f4SBarry Smith 5487325fc9f4SBarry Smith #undef __FUNCT__ 5488325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 5489325fc9f4SBarry Smith /* 5490325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 5491325fc9f4SBarry Smith TSSetFunctionMatlab(). 5492325fc9f4SBarry Smith 5493325fc9f4SBarry Smith Collective on TS 5494325fc9f4SBarry Smith 5495325fc9f4SBarry Smith Input Parameters: 5496325fc9f4SBarry Smith + snes - the TS context 54970910c330SBarry Smith - u - input vector 5498325fc9f4SBarry Smith 5499325fc9f4SBarry Smith Output Parameter: 5500325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 5501325fc9f4SBarry Smith 5502325fc9f4SBarry Smith Notes: 5503325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 5504325fc9f4SBarry Smith implementations, so most users would not generally call this routine 5505325fc9f4SBarry Smith themselves. 5506325fc9f4SBarry Smith 5507325fc9f4SBarry Smith Level: developer 5508325fc9f4SBarry Smith 5509325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 5510325fc9f4SBarry Smith 5511325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5512325fc9f4SBarry Smith */ 55130910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 5514325fc9f4SBarry Smith { 5515325fc9f4SBarry Smith PetscErrorCode ierr; 5516325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5517325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 5518325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 5519325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 5520325fc9f4SBarry Smith 5521325fc9f4SBarry Smith PetscFunctionBegin; 5522325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 55230910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 55240910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 5525325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 55260910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 5527325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 5528325fc9f4SBarry Smith 5529325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 55300910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 55310910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 55320910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 5533bbd56ea5SKarl Rupp 5534325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5535325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 5536325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 5537325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 5538325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 5539325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 5540325fc9f4SBarry Smith prhs[6] = sctx->ctx; 5541325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 5542325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5543325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 5544325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 5545325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 5546325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 5547325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 5548325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 5549325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 5550325fc9f4SBarry Smith PetscFunctionReturn(0); 5551325fc9f4SBarry Smith } 5552325fc9f4SBarry Smith 5553325fc9f4SBarry Smith 5554325fc9f4SBarry Smith #undef __FUNCT__ 5555325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 5556325fc9f4SBarry Smith /* 5557325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 5558325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 5559e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 5560325fc9f4SBarry Smith 5561325fc9f4SBarry Smith Logically Collective on TS 5562325fc9f4SBarry Smith 5563325fc9f4SBarry Smith Input Parameters: 5564325fc9f4SBarry Smith + ts - the TS context 5565325fc9f4SBarry Smith - func - function evaluation routine 5566325fc9f4SBarry Smith 5567325fc9f4SBarry Smith Calling sequence of func: 55680910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 5569325fc9f4SBarry Smith 5570325fc9f4SBarry Smith Level: beginner 5571325fc9f4SBarry Smith 5572325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 5573325fc9f4SBarry Smith 5574325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5575325fc9f4SBarry Smith */ 5576cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 5577325fc9f4SBarry Smith { 5578325fc9f4SBarry Smith PetscErrorCode ierr; 5579325fc9f4SBarry Smith TSMatlabContext *sctx; 5580325fc9f4SBarry Smith 5581325fc9f4SBarry Smith PetscFunctionBegin; 5582325fc9f4SBarry Smith /* currently sctx is memory bleed */ 5583325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5584325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5585325fc9f4SBarry Smith /* 5586325fc9f4SBarry Smith This should work, but it doesn't 5587325fc9f4SBarry Smith sctx->ctx = ctx; 5588325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5589325fc9f4SBarry Smith */ 5590325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5591bbd56ea5SKarl Rupp 55920298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 5593325fc9f4SBarry Smith PetscFunctionReturn(0); 5594325fc9f4SBarry Smith } 5595325fc9f4SBarry Smith 5596325fc9f4SBarry Smith #undef __FUNCT__ 5597325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 5598325fc9f4SBarry Smith /* 5599325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 5600325fc9f4SBarry Smith TSSetJacobianMatlab(). 5601325fc9f4SBarry Smith 5602325fc9f4SBarry Smith Collective on TS 5603325fc9f4SBarry Smith 5604325fc9f4SBarry Smith Input Parameters: 5605cdcf91faSSean Farley + ts - the TS context 56060910c330SBarry Smith . u - input vector 5607325fc9f4SBarry Smith . A, B - the matrices 5608325fc9f4SBarry Smith - ctx - user context 5609325fc9f4SBarry Smith 5610325fc9f4SBarry Smith Level: developer 5611325fc9f4SBarry Smith 5612325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 5613325fc9f4SBarry Smith 5614325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5615325fc9f4SBarry Smith @*/ 5616f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 5617325fc9f4SBarry Smith { 5618325fc9f4SBarry Smith PetscErrorCode ierr; 5619325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5620325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 5621325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 5622325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 5623325fc9f4SBarry Smith 5624325fc9f4SBarry Smith PetscFunctionBegin; 5625cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 56260910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 5627325fc9f4SBarry Smith 56280910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 5629325fc9f4SBarry Smith 5630cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 56310910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 56320910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 56330910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 56340910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 5635bbd56ea5SKarl Rupp 5636325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5637325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 5638325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 5639325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 5640325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 5641325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 5642325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 5643325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 5644325fc9f4SBarry Smith prhs[8] = sctx->ctx; 5645325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 5646325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5647325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 5648325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 5649325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 5650325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 5651325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 5652325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 5653325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 5654325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 5655325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 5656325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 5657325fc9f4SBarry Smith PetscFunctionReturn(0); 5658325fc9f4SBarry Smith } 5659325fc9f4SBarry Smith 5660325fc9f4SBarry Smith 5661325fc9f4SBarry Smith #undef __FUNCT__ 5662325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 5663325fc9f4SBarry Smith /* 5664325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 5665e3c5b3baSBarry Smith vector for use by the TS routines in solving ODEs from MATLAB. Here the function is a string containing the name of a MATLAB function 5666325fc9f4SBarry Smith 5667325fc9f4SBarry Smith Logically Collective on TS 5668325fc9f4SBarry Smith 5669325fc9f4SBarry Smith Input Parameters: 5670cdcf91faSSean Farley + ts - the TS context 5671325fc9f4SBarry Smith . A,B - Jacobian matrices 5672325fc9f4SBarry Smith . func - function evaluation routine 5673325fc9f4SBarry Smith - ctx - user context 5674325fc9f4SBarry Smith 5675325fc9f4SBarry Smith Calling sequence of func: 56760910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 5677325fc9f4SBarry Smith 5678325fc9f4SBarry Smith 5679325fc9f4SBarry Smith Level: developer 5680325fc9f4SBarry Smith 5681325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 5682325fc9f4SBarry Smith 5683325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5684325fc9f4SBarry Smith */ 5685cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 5686325fc9f4SBarry Smith { 5687325fc9f4SBarry Smith PetscErrorCode ierr; 5688325fc9f4SBarry Smith TSMatlabContext *sctx; 5689325fc9f4SBarry Smith 5690325fc9f4SBarry Smith PetscFunctionBegin; 5691325fc9f4SBarry Smith /* currently sctx is memory bleed */ 5692325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5693325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5694325fc9f4SBarry Smith /* 5695325fc9f4SBarry Smith This should work, but it doesn't 5696325fc9f4SBarry Smith sctx->ctx = ctx; 5697325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5698325fc9f4SBarry Smith */ 5699325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5700bbd56ea5SKarl Rupp 5701cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 5702325fc9f4SBarry Smith PetscFunctionReturn(0); 5703325fc9f4SBarry Smith } 5704325fc9f4SBarry Smith 5705b5b1a830SBarry Smith #undef __FUNCT__ 5706b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 5707b5b1a830SBarry Smith /* 5708b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 5709b5b1a830SBarry Smith 5710b5b1a830SBarry Smith Collective on TS 5711b5b1a830SBarry Smith 5712b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5713b5b1a830SBarry Smith @*/ 57140910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 5715b5b1a830SBarry Smith { 5716b5b1a830SBarry Smith PetscErrorCode ierr; 5717b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5718a530c242SBarry Smith int nlhs = 1,nrhs = 6; 5719b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 5720b5b1a830SBarry Smith long long int lx = 0,ls = 0; 5721b5b1a830SBarry Smith 5722b5b1a830SBarry Smith PetscFunctionBegin; 5723cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 57240910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 5725b5b1a830SBarry Smith 5726cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 57270910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 5728bbd56ea5SKarl Rupp 5729b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5730b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 5731b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 5732b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 5733b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 5734b5b1a830SBarry Smith prhs[5] = sctx->ctx; 5735b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 5736b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5737b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 5738b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 5739b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 5740b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 5741b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 5742b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 5743b5b1a830SBarry Smith PetscFunctionReturn(0); 5744b5b1a830SBarry Smith } 5745b5b1a830SBarry Smith 5746b5b1a830SBarry Smith 5747b5b1a830SBarry Smith #undef __FUNCT__ 5748b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 5749b5b1a830SBarry Smith /* 5750b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 5751b5b1a830SBarry Smith 5752b5b1a830SBarry Smith Level: developer 5753b5b1a830SBarry Smith 5754b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 5755b5b1a830SBarry Smith 5756b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5757b5b1a830SBarry Smith */ 5758cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 5759b5b1a830SBarry Smith { 5760b5b1a830SBarry Smith PetscErrorCode ierr; 5761b5b1a830SBarry Smith TSMatlabContext *sctx; 5762b5b1a830SBarry Smith 5763b5b1a830SBarry Smith PetscFunctionBegin; 5764b5b1a830SBarry Smith /* currently sctx is memory bleed */ 5765b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5766b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5767b5b1a830SBarry Smith /* 5768b5b1a830SBarry Smith This should work, but it doesn't 5769b5b1a830SBarry Smith sctx->ctx = ctx; 5770b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5771b5b1a830SBarry Smith */ 5772b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5773bbd56ea5SKarl Rupp 57740298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 5775b5b1a830SBarry Smith PetscFunctionReturn(0); 5776b5b1a830SBarry Smith } 5777325fc9f4SBarry Smith #endif 5778b3603a34SBarry Smith 5779b3603a34SBarry Smith #undef __FUNCT__ 57804f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 5781b3603a34SBarry Smith /*@C 57824f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 5783b3603a34SBarry Smith in a time based line graph 5784b3603a34SBarry Smith 5785b3603a34SBarry Smith Collective on TS 5786b3603a34SBarry Smith 5787b3603a34SBarry Smith Input Parameters: 5788b3603a34SBarry Smith + ts - the TS context 5789b3603a34SBarry Smith . step - current time-step 5790b3603a34SBarry Smith . ptime - current time 5791*7db568b7SBarry Smith . u - current solution 5792*7db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 5793b3603a34SBarry Smith 5794b3d3934dSBarry Smith Options Database: 57959ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 5796b3d3934dSBarry Smith 5797b3603a34SBarry Smith Level: intermediate 5798b3603a34SBarry Smith 57990b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 5800b3603a34SBarry Smith 5801b3603a34SBarry Smith .keywords: TS, vector, monitor, view 5802b3603a34SBarry Smith 5803*7db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 5804*7db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 5805*7db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 5806*7db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 5807b3603a34SBarry Smith @*/ 5808*7db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 5809b3603a34SBarry Smith { 5810b3603a34SBarry Smith PetscErrorCode ierr; 5811*7db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 5812b3603a34SBarry Smith const PetscScalar *yy; 581358ff32f7SBarry Smith PetscInt dim; 581480666b62SBarry Smith Vec v; 5815b3603a34SBarry Smith 5816b3603a34SBarry Smith PetscFunctionBegin; 581758ff32f7SBarry Smith if (!step) { 5818a9f9c1f6SBarry Smith PetscDrawAxis axis; 5819a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5820a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 5821387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 5822387f4636SBarry Smith char **displaynames; 5823387f4636SBarry Smith PetscBool flg; 5824387f4636SBarry Smith 5825387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 5826387f4636SBarry Smith ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr); 5827387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 58289ae14b6eSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 5829387f4636SBarry Smith if (flg) { 5830a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 5831387f4636SBarry Smith } 5832387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 5833387f4636SBarry Smith } 5834387f4636SBarry Smith if (ctx->displaynames) { 5835387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 5836387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 5837387f4636SBarry Smith } else if (ctx->names) { 58380910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 58390b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 5840387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 5841387f4636SBarry Smith } 58420b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 584358ff32f7SBarry Smith } 584480666b62SBarry Smith if (ctx->transform) { 5845e673d494SBarry Smith ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr); 584680666b62SBarry Smith } else { 584780666b62SBarry Smith v = u; 584880666b62SBarry Smith } 584980666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 5850e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 5851e3efe391SJed Brown { 5852e3efe391SJed Brown PetscReal *yreal; 5853e3efe391SJed Brown PetscInt i,n; 585480666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 5855785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 5856e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 58570b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 5858e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 5859e3efe391SJed Brown } 5860e3efe391SJed Brown #else 5861387f4636SBarry Smith if (ctx->displaynames) { 5862387f4636SBarry Smith PetscInt i; 5863387f4636SBarry Smith for (i=0; i<ctx->ndisplayvariables; i++) { 5864387f4636SBarry Smith ctx->displayvalues[i] = yy[ctx->displayvariables[i]]; 5865387f4636SBarry Smith } 5866387f4636SBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 5867387f4636SBarry Smith } else { 58680b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 5869387f4636SBarry Smith } 5870e3efe391SJed Brown #endif 587180666b62SBarry Smith ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 587280666b62SBarry Smith if (ctx->transform) { 587380666b62SBarry Smith ierr = VecDestroy(&v);CHKERRQ(ierr); 587480666b62SBarry Smith } 5875b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 58760b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 58773923b477SBarry Smith } 5878b3603a34SBarry Smith PetscFunctionReturn(0); 5879b3603a34SBarry Smith } 5880b3603a34SBarry Smith 5881387f4636SBarry Smith 5882b3603a34SBarry Smith #undef __FUNCT__ 588331152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames" 5884b037adc7SBarry Smith /*@C 588531152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 5886b037adc7SBarry Smith 5887b037adc7SBarry Smith Collective on TS 5888b037adc7SBarry Smith 5889b037adc7SBarry Smith Input Parameters: 5890b037adc7SBarry Smith + ts - the TS context 5891b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 5892b037adc7SBarry Smith 5893b037adc7SBarry Smith Level: intermediate 5894b037adc7SBarry Smith 5895*7db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 5896*7db568b7SBarry Smith 5897b037adc7SBarry Smith .keywords: TS, vector, monitor, view 5898b037adc7SBarry Smith 5899a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 5900b037adc7SBarry Smith @*/ 590131152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 5902b037adc7SBarry Smith { 5903b037adc7SBarry Smith PetscErrorCode ierr; 5904b037adc7SBarry Smith PetscInt i; 5905b037adc7SBarry Smith 5906b037adc7SBarry Smith PetscFunctionBegin; 5907b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 5908b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 59095537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 5910b3d3934dSBarry Smith break; 5911b3d3934dSBarry Smith } 5912b3d3934dSBarry Smith } 5913b3d3934dSBarry Smith PetscFunctionReturn(0); 5914b3d3934dSBarry Smith } 5915b3d3934dSBarry Smith 5916b3d3934dSBarry Smith #undef __FUNCT__ 5917e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames" 5918e673d494SBarry Smith /*@C 5919e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 5920e673d494SBarry Smith 5921e673d494SBarry Smith Collective on TS 5922e673d494SBarry Smith 5923e673d494SBarry Smith Input Parameters: 5924e673d494SBarry Smith + ts - the TS context 5925e673d494SBarry Smith - names - the names of the components, final string must be NULL 5926e673d494SBarry Smith 5927e673d494SBarry Smith Level: intermediate 5928e673d494SBarry Smith 5929e673d494SBarry Smith .keywords: TS, vector, monitor, view 5930e673d494SBarry Smith 5931a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 5932e673d494SBarry Smith @*/ 5933e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 5934e673d494SBarry Smith { 5935e673d494SBarry Smith PetscErrorCode ierr; 5936e673d494SBarry Smith 5937e673d494SBarry Smith PetscFunctionBegin; 5938e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 5939e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 5940e673d494SBarry Smith PetscFunctionReturn(0); 5941e673d494SBarry Smith } 5942e673d494SBarry Smith 5943e673d494SBarry Smith #undef __FUNCT__ 5944b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames" 5945b3d3934dSBarry Smith /*@C 5946b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 5947b3d3934dSBarry Smith 5948b3d3934dSBarry Smith Collective on TS 5949b3d3934dSBarry Smith 5950b3d3934dSBarry Smith Input Parameter: 5951b3d3934dSBarry Smith . ts - the TS context 5952b3d3934dSBarry Smith 5953b3d3934dSBarry Smith Output Parameter: 5954b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 5955b3d3934dSBarry Smith 5956b3d3934dSBarry Smith Level: intermediate 5957b3d3934dSBarry Smith 5958*7db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 5959*7db568b7SBarry Smith 5960b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 5961b3d3934dSBarry Smith 5962b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 5963b3d3934dSBarry Smith @*/ 5964b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 5965b3d3934dSBarry Smith { 5966b3d3934dSBarry Smith PetscInt i; 5967b3d3934dSBarry Smith 5968b3d3934dSBarry Smith PetscFunctionBegin; 5969b3d3934dSBarry Smith *names = NULL; 5970b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 5971b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 59725537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 5973b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 5974b3d3934dSBarry Smith break; 5975387f4636SBarry Smith } 5976387f4636SBarry Smith } 5977387f4636SBarry Smith PetscFunctionReturn(0); 5978387f4636SBarry Smith } 5979387f4636SBarry Smith 5980387f4636SBarry Smith #undef __FUNCT__ 5981a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables" 5982a66092f1SBarry Smith /*@C 5983a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 5984a66092f1SBarry Smith 5985a66092f1SBarry Smith Collective on TS 5986a66092f1SBarry Smith 5987a66092f1SBarry Smith Input Parameters: 5988a66092f1SBarry Smith + ctx - the TSMonitorLG context 5989a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 5990a66092f1SBarry Smith 5991a66092f1SBarry Smith Level: intermediate 5992a66092f1SBarry Smith 5993a66092f1SBarry Smith .keywords: TS, vector, monitor, view 5994a66092f1SBarry Smith 5995a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 5996a66092f1SBarry Smith @*/ 5997a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 5998a66092f1SBarry Smith { 5999a66092f1SBarry Smith PetscInt j = 0,k; 6000a66092f1SBarry Smith PetscErrorCode ierr; 6001a66092f1SBarry Smith 6002a66092f1SBarry Smith PetscFunctionBegin; 6003a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 6004a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6005a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6006a66092f1SBarry Smith while (displaynames[j]) j++; 6007a66092f1SBarry Smith ctx->ndisplayvariables = j; 6008a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6009a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6010a66092f1SBarry Smith j = 0; 6011a66092f1SBarry Smith while (displaynames[j]) { 6012a66092f1SBarry Smith k = 0; 6013a66092f1SBarry Smith while (ctx->names[k]) { 6014a66092f1SBarry Smith PetscBool flg; 6015a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6016a66092f1SBarry Smith if (flg) { 6017a66092f1SBarry Smith ctx->displayvariables[j] = k; 6018a66092f1SBarry Smith break; 6019a66092f1SBarry Smith } 6020a66092f1SBarry Smith k++; 6021a66092f1SBarry Smith } 6022a66092f1SBarry Smith j++; 6023a66092f1SBarry Smith } 6024a66092f1SBarry Smith PetscFunctionReturn(0); 6025a66092f1SBarry Smith } 6026a66092f1SBarry Smith 6027a66092f1SBarry Smith 6028a66092f1SBarry Smith #undef __FUNCT__ 6029387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables" 6030387f4636SBarry Smith /*@C 6031387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6032387f4636SBarry Smith 6033387f4636SBarry Smith Collective on TS 6034387f4636SBarry Smith 6035387f4636SBarry Smith Input Parameters: 6036387f4636SBarry Smith + ts - the TS context 6037387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 6038387f4636SBarry Smith 6039*7db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6040*7db568b7SBarry Smith 6041387f4636SBarry Smith Level: intermediate 6042387f4636SBarry Smith 6043387f4636SBarry Smith .keywords: TS, vector, monitor, view 6044387f4636SBarry Smith 6045387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6046387f4636SBarry Smith @*/ 6047387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6048387f4636SBarry Smith { 6049a66092f1SBarry Smith PetscInt i; 6050387f4636SBarry Smith PetscErrorCode ierr; 6051387f4636SBarry Smith 6052387f4636SBarry Smith PetscFunctionBegin; 6053387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6054387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 60555537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6056b3d3934dSBarry Smith break; 6057b037adc7SBarry Smith } 6058b037adc7SBarry Smith } 6059b037adc7SBarry Smith PetscFunctionReturn(0); 6060b037adc7SBarry Smith } 6061b037adc7SBarry Smith 6062b037adc7SBarry Smith #undef __FUNCT__ 606380666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform" 606480666b62SBarry Smith /*@C 606580666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 606680666b62SBarry Smith 606780666b62SBarry Smith Collective on TS 606880666b62SBarry Smith 606980666b62SBarry Smith Input Parameters: 607080666b62SBarry Smith + ts - the TS context 607180666b62SBarry Smith . transform - the transform function 60727684fa3eSBarry Smith . destroy - function to destroy the optional context 607380666b62SBarry Smith - ctx - optional context used by transform function 607480666b62SBarry Smith 6075*7db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 6076*7db568b7SBarry Smith 607780666b62SBarry Smith Level: intermediate 607880666b62SBarry Smith 607980666b62SBarry Smith .keywords: TS, vector, monitor, view 608080666b62SBarry Smith 6081a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 608280666b62SBarry Smith @*/ 60837684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 608480666b62SBarry Smith { 608580666b62SBarry Smith PetscInt i; 6086a66092f1SBarry Smith PetscErrorCode ierr; 608780666b62SBarry Smith 608880666b62SBarry Smith PetscFunctionBegin; 608980666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 609080666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 60915537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 609280666b62SBarry Smith } 609380666b62SBarry Smith } 609480666b62SBarry Smith PetscFunctionReturn(0); 609580666b62SBarry Smith } 609680666b62SBarry Smith 609780666b62SBarry Smith #undef __FUNCT__ 6098e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform" 6099e673d494SBarry Smith /*@C 6100e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6101e673d494SBarry Smith 6102e673d494SBarry Smith Collective on TSLGCtx 6103e673d494SBarry Smith 6104e673d494SBarry Smith Input Parameters: 6105e673d494SBarry Smith + ts - the TS context 6106e673d494SBarry Smith . transform - the transform function 61077684fa3eSBarry Smith . destroy - function to destroy the optional context 6108e673d494SBarry Smith - ctx - optional context used by transform function 6109e673d494SBarry Smith 6110e673d494SBarry Smith Level: intermediate 6111e673d494SBarry Smith 6112e673d494SBarry Smith .keywords: TS, vector, monitor, view 6113e673d494SBarry Smith 6114a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6115e673d494SBarry Smith @*/ 61167684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6117e673d494SBarry Smith { 6118e673d494SBarry Smith PetscFunctionBegin; 6119e673d494SBarry Smith ctx->transform = transform; 61207684fa3eSBarry Smith ctx->transformdestroy = destroy; 6121e673d494SBarry Smith ctx->transformctx = tctx; 6122e673d494SBarry Smith PetscFunctionReturn(0); 6123e673d494SBarry Smith } 6124e673d494SBarry Smith 6125b3603a34SBarry Smith #undef __FUNCT__ 61264f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 6127ef20d060SBarry Smith /*@C 61284f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 6129ef20d060SBarry Smith in a time based line graph 6130ef20d060SBarry Smith 6131ef20d060SBarry Smith Collective on TS 6132ef20d060SBarry Smith 6133ef20d060SBarry Smith Input Parameters: 6134ef20d060SBarry Smith + ts - the TS context 6135ef20d060SBarry Smith . step - current time-step 6136ef20d060SBarry Smith . ptime - current time 6137*7db568b7SBarry Smith . u - current solution 6138*7db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6139ef20d060SBarry Smith 6140ef20d060SBarry Smith Level: intermediate 6141ef20d060SBarry Smith 6142abd5a294SJed Brown Notes: 6143abd5a294SJed Brown Only for sequential solves. 6144abd5a294SJed Brown 6145abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6146abd5a294SJed Brown 6147abd5a294SJed Brown Options Database Keys: 61484f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 6149ef20d060SBarry Smith 6150ef20d060SBarry Smith .keywords: TS, vector, monitor, view 6151ef20d060SBarry Smith 6152abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6153ef20d060SBarry Smith @*/ 61540910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6155ef20d060SBarry Smith { 6156ef20d060SBarry Smith PetscErrorCode ierr; 61570b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6158ef20d060SBarry Smith const PetscScalar *yy; 6159ef20d060SBarry Smith Vec y; 6160a9f9c1f6SBarry Smith PetscInt dim; 6161ef20d060SBarry Smith 6162ef20d060SBarry Smith PetscFunctionBegin; 6163a9f9c1f6SBarry Smith if (!step) { 6164a9f9c1f6SBarry Smith PetscDrawAxis axis; 6165a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 61661ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 61670910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6168a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6169a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6170a9f9c1f6SBarry Smith } 61710910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6172ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 61730910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6174ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6175e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6176e3efe391SJed Brown { 6177e3efe391SJed Brown PetscReal *yreal; 6178e3efe391SJed Brown PetscInt i,n; 6179e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6180785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6181e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 61820b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6183e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6184e3efe391SJed Brown } 6185e3efe391SJed Brown #else 61860b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6187e3efe391SJed Brown #endif 6188ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6189ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 6190b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 61910b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 61923923b477SBarry Smith } 6193ef20d060SBarry Smith PetscFunctionReturn(0); 6194ef20d060SBarry Smith } 6195ef20d060SBarry Smith 6196201da799SBarry Smith #undef __FUNCT__ 6197201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 6198201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6199201da799SBarry Smith { 6200201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6201201da799SBarry Smith PetscReal x = ptime,y; 6202201da799SBarry Smith PetscErrorCode ierr; 6203201da799SBarry Smith PetscInt its; 6204201da799SBarry Smith 6205201da799SBarry Smith PetscFunctionBegin; 6206201da799SBarry Smith if (!n) { 6207201da799SBarry Smith PetscDrawAxis axis; 6208bbd56ea5SKarl Rupp 6209201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6210201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 6211201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6212bbd56ea5SKarl Rupp 6213201da799SBarry Smith ctx->snes_its = 0; 6214201da799SBarry Smith } 6215201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 6216201da799SBarry Smith y = its - ctx->snes_its; 6217201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 62183fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6219201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6220201da799SBarry Smith } 6221201da799SBarry Smith ctx->snes_its = its; 6222201da799SBarry Smith PetscFunctionReturn(0); 6223201da799SBarry Smith } 6224201da799SBarry Smith 6225201da799SBarry Smith #undef __FUNCT__ 6226201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 6227201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6228201da799SBarry Smith { 6229201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6230201da799SBarry Smith PetscReal x = ptime,y; 6231201da799SBarry Smith PetscErrorCode ierr; 6232201da799SBarry Smith PetscInt its; 6233201da799SBarry Smith 6234201da799SBarry Smith PetscFunctionBegin; 6235201da799SBarry Smith if (!n) { 6236201da799SBarry Smith PetscDrawAxis axis; 6237bbd56ea5SKarl Rupp 6238201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6239201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 6240201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6241bbd56ea5SKarl Rupp 6242201da799SBarry Smith ctx->ksp_its = 0; 6243201da799SBarry Smith } 6244201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 6245201da799SBarry Smith y = its - ctx->ksp_its; 6246201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 624799fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6248201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 6249201da799SBarry Smith } 6250201da799SBarry Smith ctx->ksp_its = its; 6251201da799SBarry Smith PetscFunctionReturn(0); 6252201da799SBarry Smith } 6253f9c1d6abSBarry Smith 6254f9c1d6abSBarry Smith #undef __FUNCT__ 6255f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 6256f9c1d6abSBarry Smith /*@ 6257f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 6258f9c1d6abSBarry Smith 6259f9c1d6abSBarry Smith Collective on TS and Vec 6260f9c1d6abSBarry Smith 6261f9c1d6abSBarry Smith Input Parameters: 6262f9c1d6abSBarry Smith + ts - the TS context 6263f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 6264f9c1d6abSBarry Smith 6265f9c1d6abSBarry Smith Output Parameters: 6266f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 6267f9c1d6abSBarry Smith 6268f9c1d6abSBarry Smith Level: developer 6269f9c1d6abSBarry Smith 6270f9c1d6abSBarry Smith .keywords: TS, compute 6271f9c1d6abSBarry Smith 6272f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 6273f9c1d6abSBarry Smith @*/ 6274f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 6275f9c1d6abSBarry Smith { 6276f9c1d6abSBarry Smith PetscErrorCode ierr; 6277f9c1d6abSBarry Smith 6278f9c1d6abSBarry Smith PetscFunctionBegin; 6279f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6280ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 6281f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 6282f9c1d6abSBarry Smith PetscFunctionReturn(0); 6283f9c1d6abSBarry Smith } 628424655328SShri 6285b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 6286b3d3934dSBarry Smith #undef __FUNCT__ 6287b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate" 6288b3d3934dSBarry Smith /*@C 6289b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 6290b3d3934dSBarry Smith 6291b3d3934dSBarry Smith Collective on TS 6292b3d3934dSBarry Smith 6293b3d3934dSBarry Smith Input Parameters: 6294b3d3934dSBarry Smith . ts - the ODE solver object 6295b3d3934dSBarry Smith 6296b3d3934dSBarry Smith Output Parameter: 6297b3d3934dSBarry Smith . ctx - the context 6298b3d3934dSBarry Smith 6299b3d3934dSBarry Smith Level: intermediate 6300b3d3934dSBarry Smith 6301b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 6302b3d3934dSBarry Smith 6303b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 6304b3d3934dSBarry Smith 6305b3d3934dSBarry Smith @*/ 6306b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 6307b3d3934dSBarry Smith { 6308b3d3934dSBarry Smith PetscErrorCode ierr; 6309b3d3934dSBarry Smith 6310b3d3934dSBarry Smith PetscFunctionBegin; 6311a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 6312b3d3934dSBarry Smith PetscFunctionReturn(0); 6313b3d3934dSBarry Smith } 6314b3d3934dSBarry Smith 6315b3d3934dSBarry Smith #undef __FUNCT__ 6316b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope" 6317b3d3934dSBarry Smith /*@C 6318b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 6319b3d3934dSBarry Smith 6320b3d3934dSBarry Smith Collective on TS 6321b3d3934dSBarry Smith 6322b3d3934dSBarry Smith Input Parameters: 6323b3d3934dSBarry Smith + ts - the TS context 6324b3d3934dSBarry Smith . step - current time-step 6325b3d3934dSBarry Smith . ptime - current time 6326*7db568b7SBarry Smith . u - current solution 6327*7db568b7SBarry Smith - dctx - the envelope context 6328b3d3934dSBarry Smith 6329b3d3934dSBarry Smith Options Database: 6330b3d3934dSBarry Smith . -ts_monitor_envelope 6331b3d3934dSBarry Smith 6332b3d3934dSBarry Smith Level: intermediate 6333b3d3934dSBarry Smith 6334b3d3934dSBarry Smith Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 6335b3d3934dSBarry Smith 6336b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 6337b3d3934dSBarry Smith 6338*7db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 6339b3d3934dSBarry Smith @*/ 6340*7db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6341b3d3934dSBarry Smith { 6342b3d3934dSBarry Smith PetscErrorCode ierr; 6343*7db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 6344b3d3934dSBarry Smith 6345b3d3934dSBarry Smith PetscFunctionBegin; 6346b3d3934dSBarry Smith if (!ctx->max) { 6347b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 6348b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 6349b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 6350b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 6351b3d3934dSBarry Smith } else { 6352b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 6353b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 6354b3d3934dSBarry Smith } 6355b3d3934dSBarry Smith PetscFunctionReturn(0); 6356b3d3934dSBarry Smith } 6357b3d3934dSBarry Smith 6358b3d3934dSBarry Smith 6359b3d3934dSBarry Smith #undef __FUNCT__ 6360b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds" 6361b3d3934dSBarry Smith /*@C 6362b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 6363b3d3934dSBarry Smith 6364b3d3934dSBarry Smith Collective on TS 6365b3d3934dSBarry Smith 6366b3d3934dSBarry Smith Input Parameter: 6367b3d3934dSBarry Smith . ts - the TS context 6368b3d3934dSBarry Smith 6369b3d3934dSBarry Smith Output Parameter: 6370b3d3934dSBarry Smith + max - the maximum values 6371b3d3934dSBarry Smith - min - the minimum values 6372b3d3934dSBarry Smith 6373*7db568b7SBarry Smith Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 6374*7db568b7SBarry Smith 6375b3d3934dSBarry Smith Level: intermediate 6376b3d3934dSBarry Smith 6377b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 6378b3d3934dSBarry Smith 6379b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6380b3d3934dSBarry Smith @*/ 6381b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 6382b3d3934dSBarry Smith { 6383b3d3934dSBarry Smith PetscInt i; 6384b3d3934dSBarry Smith 6385b3d3934dSBarry Smith PetscFunctionBegin; 6386b3d3934dSBarry Smith if (max) *max = NULL; 6387b3d3934dSBarry Smith if (min) *min = NULL; 6388b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6389b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 63905537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 6391b3d3934dSBarry Smith if (max) *max = ctx->max; 6392b3d3934dSBarry Smith if (min) *min = ctx->min; 6393b3d3934dSBarry Smith break; 6394b3d3934dSBarry Smith } 6395b3d3934dSBarry Smith } 6396b3d3934dSBarry Smith PetscFunctionReturn(0); 6397b3d3934dSBarry Smith } 6398b3d3934dSBarry Smith 6399b3d3934dSBarry Smith #undef __FUNCT__ 6400b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy" 6401b3d3934dSBarry Smith /*@C 6402b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 6403b3d3934dSBarry Smith 6404b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 6405b3d3934dSBarry Smith 6406b3d3934dSBarry Smith Input Parameter: 6407b3d3934dSBarry Smith . ctx - the monitor context 6408b3d3934dSBarry Smith 6409b3d3934dSBarry Smith Level: intermediate 6410b3d3934dSBarry Smith 6411b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 6412b3d3934dSBarry Smith 6413*7db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 6414b3d3934dSBarry Smith @*/ 6415b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 6416b3d3934dSBarry Smith { 6417b3d3934dSBarry Smith PetscErrorCode ierr; 6418b3d3934dSBarry Smith 6419b3d3934dSBarry Smith PetscFunctionBegin; 6420b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 6421b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 6422b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 6423b3d3934dSBarry Smith PetscFunctionReturn(0); 6424b3d3934dSBarry Smith } 6425f2dee214SBarry Smith 642624655328SShri #undef __FUNCT__ 642724655328SShri #define __FUNCT__ "TSRollBack" 642824655328SShri /*@ 642924655328SShri TSRollBack - Rolls back one time step 643024655328SShri 643124655328SShri Collective on TS 643224655328SShri 643324655328SShri Input Parameter: 643424655328SShri . ts - the TS context obtained from TSCreate() 643524655328SShri 643624655328SShri Level: advanced 643724655328SShri 643824655328SShri .keywords: TS, timestep, rollback 643924655328SShri 644024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 644124655328SShri @*/ 644224655328SShri PetscErrorCode TSRollBack(TS ts) 644324655328SShri { 644424655328SShri PetscErrorCode ierr; 644524655328SShri 644624655328SShri PetscFunctionBegin; 644724655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 644824655328SShri 644924655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 645024655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 645124655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 645224655328SShri ts->ptime = ts->ptime_prev; 64538392e04aSShri Abhyankar ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */ 645424655328SShri PetscFunctionReturn(0); 645524655328SShri } 6456aeb4809dSShri Abhyankar 6457ff22ae23SHong Zhang #undef __FUNCT__ 6458ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages" 6459ff22ae23SHong Zhang /*@ 6460ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 6461ff22ae23SHong Zhang 6462ff22ae23SHong Zhang Input Parameter: 6463ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 6464ff22ae23SHong Zhang 6465ff22ae23SHong Zhang Level: advanced 6466ff22ae23SHong Zhang 6467ff22ae23SHong Zhang .keywords: TS, getstages 6468ff22ae23SHong Zhang 6469ff22ae23SHong Zhang .seealso: TSCreate() 6470ff22ae23SHong Zhang @*/ 6471ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns, Vec **Y) 6472ff22ae23SHong Zhang { 6473ff22ae23SHong Zhang PetscErrorCode ierr; 6474ff22ae23SHong Zhang 6475ff22ae23SHong Zhang PetscFunctionBegin; 6476ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 6477ff22ae23SHong Zhang PetscValidPointer(ns,2); 6478ff22ae23SHong Zhang 6479ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 6480ff22ae23SHong Zhang else { 6481ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 6482ff22ae23SHong Zhang } 6483ff22ae23SHong Zhang PetscFunctionReturn(0); 6484ff22ae23SHong Zhang } 6485ff22ae23SHong Zhang 6486847ff0e1SMatthew G. Knepley #undef __FUNCT__ 6487847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor" 6488847ff0e1SMatthew G. Knepley /*@C 6489847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 6490847ff0e1SMatthew G. Knepley 6491847ff0e1SMatthew G. Knepley Collective on SNES 6492847ff0e1SMatthew G. Knepley 6493847ff0e1SMatthew G. Knepley Input Parameters: 6494847ff0e1SMatthew G. Knepley + ts - the TS context 6495847ff0e1SMatthew G. Knepley . t - current timestep 6496847ff0e1SMatthew G. Knepley . U - state vector 6497847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 6498847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 6499847ff0e1SMatthew G. Knepley - ctx - an optional user context 6500847ff0e1SMatthew G. Knepley 6501847ff0e1SMatthew G. Knepley Output Parameters: 6502847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 6503847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 6504847ff0e1SMatthew G. Knepley 6505847ff0e1SMatthew G. Knepley Level: intermediate 6506847ff0e1SMatthew G. Knepley 6507847ff0e1SMatthew G. Knepley Notes: 6508847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 6509847ff0e1SMatthew G. Knepley 6510847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 6511847ff0e1SMatthew G. Knepley 6512847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 6513847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 6514847ff0e1SMatthew G. Knepley 6515847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 6516847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 6517847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 6518847ff0e1SMatthew G. Knepley 6519847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 6520847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 6521847ff0e1SMatthew G. Knepley @*/ 6522847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 6523847ff0e1SMatthew G. Knepley { 6524847ff0e1SMatthew G. Knepley SNES snes; 6525847ff0e1SMatthew G. Knepley MatFDColoring color; 6526847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 6527847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 6528847ff0e1SMatthew G. Knepley 6529847ff0e1SMatthew G. Knepley PetscFunctionBegin; 6530847ff0e1SMatthew G. Knepley ierr = PetscOptionsGetBool(((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 6531847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 6532847ff0e1SMatthew G. Knepley if (!color) { 6533847ff0e1SMatthew G. Knepley DM dm; 6534847ff0e1SMatthew G. Knepley ISColoring iscoloring; 6535847ff0e1SMatthew G. Knepley 6536847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 6537847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 6538847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 6539847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 6540847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 6541847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 6542847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 6543847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 6544847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 6545847ff0e1SMatthew G. Knepley } else { 6546847ff0e1SMatthew G. Knepley MatColoring mc; 6547847ff0e1SMatthew G. Knepley 6548847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 6549847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 6550847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 6551847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 6552847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 6553847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 6554847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 6555847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 6556847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 6557847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 6558847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 6559847ff0e1SMatthew G. Knepley } 6560847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 6561847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 6562847ff0e1SMatthew G. Knepley } 6563847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 6564847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 6565847ff0e1SMatthew G. Knepley if (J != B) { 6566847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 6567847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 6568847ff0e1SMatthew G. Knepley } 6569847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 6570847ff0e1SMatthew G. Knepley } 657193b34091SDebojyoti Ghosh 657293b34091SDebojyoti Ghosh #undef __FUNCT__ 6573e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone" 657493b34091SDebojyoti Ghosh /*@C 6575e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 657693b34091SDebojyoti Ghosh 657793b34091SDebojyoti Ghosh Collective on MPI_Comm 657893b34091SDebojyoti Ghosh 657993b34091SDebojyoti Ghosh Input Parameter: 658093b34091SDebojyoti Ghosh . tsin - The input TS 658193b34091SDebojyoti Ghosh 658293b34091SDebojyoti Ghosh Output Parameter: 6583e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 658493b34091SDebojyoti Ghosh 65855eca1a21SEmil Constantinescu Notes: 65865eca1a21SEmil Constantinescu This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly. 65875eca1a21SEmil Constantinescu 6588baa10174SEmil Constantinescu When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup); 65895eca1a21SEmil Constantinescu 65905eca1a21SEmil Constantinescu Level: developer 659193b34091SDebojyoti Ghosh 6592e5168f73SEmil Constantinescu .keywords: TS, clone 6593e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 659493b34091SDebojyoti Ghosh @*/ 6595baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 659693b34091SDebojyoti Ghosh { 659793b34091SDebojyoti Ghosh TS t; 659893b34091SDebojyoti Ghosh PetscErrorCode ierr; 6599dc846ba4SSatish Balay SNES snes_start; 6600dc846ba4SSatish Balay DM dm; 6601dc846ba4SSatish Balay TSType type; 660293b34091SDebojyoti Ghosh 660393b34091SDebojyoti Ghosh PetscFunctionBegin; 660493b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 660593b34091SDebojyoti Ghosh *tsout = NULL; 660693b34091SDebojyoti Ghosh 66077a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 660893b34091SDebojyoti Ghosh 660993b34091SDebojyoti Ghosh /* General TS description */ 661093b34091SDebojyoti Ghosh t->numbermonitors = 0; 661193b34091SDebojyoti Ghosh t->setupcalled = 0; 661293b34091SDebojyoti Ghosh t->ksp_its = 0; 661393b34091SDebojyoti Ghosh t->snes_its = 0; 661493b34091SDebojyoti Ghosh t->nwork = 0; 661593b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 661693b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 661793b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 661893b34091SDebojyoti Ghosh 661934561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start); CHKERRQ(ierr); 662034561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start); CHKERRQ(ierr); 6621d15a3a53SEmil Constantinescu 662293b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm); CHKERRQ(ierr); 662393b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm); CHKERRQ(ierr); 662493b34091SDebojyoti Ghosh 662593b34091SDebojyoti Ghosh t->adapt=tsin->adapt; 662693b34091SDebojyoti Ghosh PetscObjectReference((PetscObject)t->adapt); 662793b34091SDebojyoti Ghosh 662893b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 662993b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 663093b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 663193b34091SDebojyoti Ghosh t->time_step_orig = tsin->time_step_orig; 663293b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 663393b34091SDebojyoti Ghosh t->steps = tsin->steps; 663493b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 663593b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 663693b34091SDebojyoti Ghosh t->atol = tsin->atol; 663793b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 663893b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 663993b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 664093b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 664193b34091SDebojyoti Ghosh 664293b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type); CHKERRQ(ierr); 664393b34091SDebojyoti Ghosh ierr = TSSetType(t,type); CHKERRQ(ierr); 664493b34091SDebojyoti Ghosh 664593b34091SDebojyoti Ghosh t->vec_sol = NULL; 664693b34091SDebojyoti Ghosh 664793b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 664893b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 664993b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 665093b34091SDebojyoti Ghosh 665193b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 665293b34091SDebojyoti Ghosh 665393b34091SDebojyoti Ghosh *tsout = t; 665493b34091SDebojyoti Ghosh PetscFunctionReturn(0); 665593b34091SDebojyoti Ghosh } 6656