163dd3a1aSKris Buschelman 2b45d2f2cSJed Brown #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 36abc2977eSBarry Smith . -ts_save_trajectories - 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 46bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 47de06c3feSJed Brown . -ts_monitor_lg_timestep - Monitor timestep size graphically 48de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 49de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 50de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 51de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 52de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 53de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 543e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 553e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 5691b97e58SBarry Smith . -ts_monitor_solution_binary <filename> - Save each solution to a binary file 5791b97e58SBarry Smith - -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 5891b97e58SBarry Smith 5991b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 60bdad233fSMatthew Knepley 61bdad233fSMatthew Knepley Level: beginner 62bdad233fSMatthew Knepley 63bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 64bdad233fSMatthew Knepley 65a313700dSBarry Smith .seealso: TSGetType() 66bdad233fSMatthew Knepley @*/ 677087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 68bdad233fSMatthew Knepley { 69bc952696SBarry Smith PetscBool opt,flg,tflg; 70dfbe8321SBarry Smith PetscErrorCode ierr; 71649052a6SBarry Smith PetscViewer monviewer; 72eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 73089b2837SJed Brown SNES snes; 741c3436cfSJed Brown TSAdapt adapt; 7531748224SBarry Smith PetscReal time_step; 7649354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 77d1212d36SBarry Smith char dir[16]; 786991f827SBarry Smith const char *defaultType; 796991f827SBarry Smith char typeName[256]; 80bdad233fSMatthew Knepley 81bdad233fSMatthew Knepley PetscFunctionBegin; 820700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 833194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 846991f827SBarry Smith if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 856991f827SBarry Smith else defaultType = TSEULER; 866991f827SBarry Smith 876991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 886991f827SBarry Smith ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 896991f827SBarry Smith if (opt) { 906991f827SBarry Smith ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 916991f827SBarry Smith } else { 926991f827SBarry Smith ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 936991f827SBarry Smith } 94bdad233fSMatthew Knepley 95bdad233fSMatthew Knepley /* Handle generic TS options */ 96844594baSBarry Smith if (ts->trajectory) tflg = PETSC_TRUE; 97844594baSBarry Smith else tflg = PETSC_FALSE; 98920aabf2SBarry Smith ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 99bc952696SBarry Smith if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);} 1000298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1010298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 1020298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 10331748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 10431748224SBarry Smith if (flg) { 10531748224SBarry Smith ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 10631748224SBarry Smith } 10749354f04SShri 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); 10849354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1090298fd71SBarry 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); 1100298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1110298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1120298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1130298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 114bdad233fSMatthew Knepley 11556f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 11656f85f32SBarry Smith { 11756f85f32SBarry Smith PetscBool set; 11856f85f32SBarry Smith flg = PETSC_FALSE; 11956f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 12056f85f32SBarry Smith if (set) { 12156f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 12256f85f32SBarry Smith } 12356f85f32SBarry Smith } 12456f85f32SBarry Smith #endif 12556f85f32SBarry Smith 126bdad233fSMatthew Knepley /* Monitor options */ 127a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 128eabae89aSBarry Smith if (flg) { 129ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 130649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 131bdad233fSMatthew Knepley } 1325180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1335180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1345180491cSLisandro Dalcin 1354f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 136a7cc72afSBarry Smith if (opt) { 1370b039ecaSBarry Smith TSMonitorLGCtx ctx; 1383923b477SBarry Smith PetscInt howoften = 1; 139a80ad3e0SBarry Smith 1400298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 141ce94432eSBarry Smith ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1424f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 143b3603a34SBarry Smith } 1444f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 145b3603a34SBarry Smith if (opt) { 1460b039ecaSBarry Smith TSMonitorLGCtx ctx; 1473923b477SBarry Smith PetscInt howoften = 1; 148b3603a34SBarry Smith 1490298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 15022d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1514f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 152bdad233fSMatthew Knepley } 1534f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 154ef20d060SBarry Smith if (opt) { 1550b039ecaSBarry Smith TSMonitorLGCtx ctx; 1563923b477SBarry Smith PetscInt howoften = 1; 157ef20d060SBarry Smith 1580298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 15922d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1604f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 161ef20d060SBarry Smith } 162201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 163201da799SBarry Smith if (opt) { 164201da799SBarry Smith TSMonitorLGCtx ctx; 165201da799SBarry Smith PetscInt howoften = 1; 166201da799SBarry Smith 1670298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 16822d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 169201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 170201da799SBarry Smith } 171201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 172201da799SBarry Smith if (opt) { 173201da799SBarry Smith TSMonitorLGCtx ctx; 174201da799SBarry Smith PetscInt howoften = 1; 175201da799SBarry Smith 1760298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 17722d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 178201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 179201da799SBarry Smith } 1808189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 1818189c53fSBarry Smith if (opt) { 1828189c53fSBarry Smith TSMonitorSPEigCtx ctx; 1838189c53fSBarry Smith PetscInt howoften = 1; 1848189c53fSBarry Smith 1850298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 18622d28d08SBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1878189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 1888189c53fSBarry Smith } 189ef20d060SBarry Smith opt = PETSC_FALSE; 1900dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 191a7cc72afSBarry Smith if (opt) { 19283a4ac43SBarry Smith TSMonitorDrawCtx ctx; 19383a4ac43SBarry Smith PetscInt howoften = 1; 194a80ad3e0SBarry Smith 1950298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 196ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 19783a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 198bdad233fSMatthew Knepley } 199fb1732b5SBarry Smith opt = PETSC_FALSE; 2002d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2012d5ee99bSBarry Smith if (opt) { 2022d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2032d5ee99bSBarry Smith PetscReal bounds[4]; 2042d5ee99bSBarry Smith PetscInt n = 4; 2052d5ee99bSBarry Smith PetscDraw draw; 2062d5ee99bSBarry Smith 2072d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2082d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2092d5ee99bSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 2102d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2112d5ee99bSBarry Smith ierr = PetscDrawClear(draw);CHKERRQ(ierr); 2124b363babSBarry Smith ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 2134b363babSBarry Smith ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 214f54adfc0SBarry Smith ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2154b363babSBarry Smith ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 21607995780SPeter Brune /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 2172d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2182d5ee99bSBarry Smith } 2192d5ee99bSBarry Smith opt = PETSC_FALSE; 2200dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2213a471f94SBarry Smith if (opt) { 22283a4ac43SBarry Smith TSMonitorDrawCtx ctx; 22383a4ac43SBarry Smith PetscInt howoften = 1; 2243a471f94SBarry Smith 2250298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 226ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 22783a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2283a471f94SBarry Smith } 2293a471f94SBarry Smith opt = PETSC_FALSE; 23091b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 231fb1732b5SBarry Smith if (flg) { 232fb1732b5SBarry Smith PetscViewer ctx; 233fb1732b5SBarry Smith if (monfilename[0]) { 234ce94432eSBarry Smith ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 235c2fbc07fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 236fb1732b5SBarry Smith } else { 237ce94432eSBarry Smith ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 2380298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 239fb1732b5SBarry Smith } 240fb1732b5SBarry Smith } 241ed81e22dSJed Brown opt = PETSC_FALSE; 24291b97e58SBarry 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); 243ed81e22dSJed Brown if (flg) { 244ed81e22dSJed Brown const char *ptr,*ptr2; 245ed81e22dSJed Brown char *filetemplate; 246ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 247ed81e22dSJed Brown /* Do some cursory validation of the input. */ 248ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 249ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 250ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 251ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 252ce94432eSBarry 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"); 253ed81e22dSJed Brown if (ptr2) break; 254ed81e22dSJed Brown } 255ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 256ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 257ed81e22dSJed Brown } 258bdad233fSMatthew Knepley 259d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 260d1212d36SBarry Smith if (flg) { 261d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 262d1212d36SBarry Smith int ray = 0; 263d1212d36SBarry Smith DMDADirection ddir; 264d1212d36SBarry Smith DM da; 265d1212d36SBarry Smith PetscMPIInt rank; 266d1212d36SBarry Smith 267ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 268d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 269d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 270ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 271d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 272d1212d36SBarry Smith 273d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 274b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 275d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 276d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 277ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 278d1212d36SBarry Smith if (!rank) { 279d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 280d1212d36SBarry Smith } 28151b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 282d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 283d1212d36SBarry Smith } 28451b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 28551b4a12fSMatthew G. Knepley if (flg) { 28651b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 28751b4a12fSMatthew G. Knepley int ray = 0; 28851b4a12fSMatthew G. Knepley DMDADirection ddir; 28951b4a12fSMatthew G. Knepley DM da; 29051b4a12fSMatthew G. Knepley PetscInt howoften = 1; 291d1212d36SBarry Smith 29251b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 29351b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 29451b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 29551b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 29651b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 29751b4a12fSMatthew G. Knepley 29851b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 299b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 30051b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 30151b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 30251b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 30351b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 30451b4a12fSMatthew G. Knepley } 305a7a1495cSBarry Smith 3067781c08eSBarry Smith /* 3077781c08eSBarry Smith This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui 3087781c08eSBarry Smith will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin() 3097781c08eSBarry Smith */ 310552698daSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 311e55864a3SBarry Smith ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr); 312d763cef2SBarry Smith 3136991f827SBarry Smith /* Handle specific TS options */ 3146991f827SBarry Smith if (ts->ops->setfromoptions) { 3156991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 3166991f827SBarry Smith } 3176991f827SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 3186991f827SBarry Smith 3196991f827SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 3206991f827SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 321d763cef2SBarry Smith 322bc952696SBarry Smith if (ts->trajectory) { 323bc952696SBarry Smith ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr); 324bc952696SBarry Smith } 325bc952696SBarry Smith 3266991f827SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3276991f827SBarry Smith if (snes) { 3286991f827SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 3296991f827SBarry Smith ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 330d763cef2SBarry Smith } 331d763cef2SBarry Smith PetscFunctionReturn(0); 332d763cef2SBarry Smith } 333d763cef2SBarry Smith 334d763cef2SBarry Smith #undef __FUNCT__ 335bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory" 336d2daff3dSHong Zhang /*@ 337bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 338d2daff3dSHong Zhang 339d2daff3dSHong Zhang Collective on TS 340d2daff3dSHong Zhang 341d2daff3dSHong Zhang Input Parameters: 342bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 343bc952696SBarry Smith 344d2daff3dSHong Zhang 345d2daff3dSHong Zhang Level: intermediate 346d2daff3dSHong Zhang 347bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve() 348d2daff3dSHong Zhang 349bc952696SBarry Smith .keywords: TS, set, checkpoint, 350d2daff3dSHong Zhang @*/ 351bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 352d2daff3dSHong Zhang { 353bc952696SBarry Smith PetscErrorCode ierr; 354bc952696SBarry Smith 355d2daff3dSHong Zhang PetscFunctionBegin; 356d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 357bc952696SBarry Smith if (!ts->trajectory) { 358bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 359920aabf2SBarry Smith ierr = TSTrajectorySetType(ts->trajectory,TSTRAJECTORYBASIC);CHKERRQ(ierr); 360bc952696SBarry Smith } 361d2daff3dSHong Zhang PetscFunctionReturn(0); 362d2daff3dSHong Zhang } 363d2daff3dSHong Zhang 364a7a1495cSBarry Smith #undef __FUNCT__ 365a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian" 366a7a1495cSBarry Smith /*@ 367a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 368a7a1495cSBarry Smith set with TSSetRHSJacobian(). 369a7a1495cSBarry Smith 370a7a1495cSBarry Smith Collective on TS and Vec 371a7a1495cSBarry Smith 372a7a1495cSBarry Smith Input Parameters: 373316643e7SJed Brown + ts - the TS context 374a7a1495cSBarry Smith . t - current timestep 3750910c330SBarry Smith - U - input vector 376a7a1495cSBarry Smith 377a7a1495cSBarry Smith Output Parameters: 378a7a1495cSBarry Smith + A - Jacobian matrix 379a7a1495cSBarry Smith . B - optional preconditioning matrix 380a7a1495cSBarry Smith - flag - flag indicating matrix structure 381a7a1495cSBarry Smith 382a7a1495cSBarry Smith Notes: 383a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 384a7a1495cSBarry Smith is used internally within the nonlinear solvers. 385a7a1495cSBarry Smith 38694b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 387a7a1495cSBarry Smith flag parameter. 388a7a1495cSBarry Smith 389a7a1495cSBarry Smith Level: developer 390a7a1495cSBarry Smith 391a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 392a7a1495cSBarry Smith 39394b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 394a7a1495cSBarry Smith @*/ 395d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 396a7a1495cSBarry Smith { 397dfbe8321SBarry Smith PetscErrorCode ierr; 398270bf2e7SJed Brown PetscObjectState Ustate; 39924989b8cSPeter Brune DM dm; 400942e3340SBarry Smith DMTS tsdm; 40124989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 40224989b8cSPeter Brune void *ctx; 40324989b8cSPeter Brune TSIJacobian ijacobianfunc; 404a7a1495cSBarry Smith 405a7a1495cSBarry Smith PetscFunctionBegin; 4060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4070910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4080910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 40924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 410942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 41124989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 4120298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 41359e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 4140910c330SBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 4150e4ef248SJed Brown PetscFunctionReturn(0); 416f8ede8e7SJed Brown } 417d90be118SSean Farley 418ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 419d90be118SSean Farley 420e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 42194ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 42294ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 42394ab13aaSBarry Smith if (A != B) { 42494ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 42594ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 426e1244c69SJed Brown } 427e1244c69SJed Brown ts->rhsjacobian.shift = 0; 428e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 429e1244c69SJed Brown } 430e1244c69SJed Brown 43124989b8cSPeter Brune if (rhsjacobianfunc) { 43294ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 433a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 434d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 435a7a1495cSBarry Smith PetscStackPop; 43694ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 437a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 43894ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 43994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 440ef66eb69SBarry Smith } else { 44194ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 44294ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 443ef66eb69SBarry Smith } 4440e4ef248SJed Brown ts->rhsjacobian.time = t; 4450910c330SBarry Smith ts->rhsjacobian.X = U; 44659e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 447a7a1495cSBarry Smith PetscFunctionReturn(0); 448a7a1495cSBarry Smith } 449a7a1495cSBarry Smith 4504a2ae208SSatish Balay #undef __FUNCT__ 4514a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 452316643e7SJed Brown /*@ 453d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 454d763cef2SBarry Smith 455316643e7SJed Brown Collective on TS and Vec 456316643e7SJed Brown 457316643e7SJed Brown Input Parameters: 458316643e7SJed Brown + ts - the TS context 459316643e7SJed Brown . t - current time 4600910c330SBarry Smith - U - state vector 461316643e7SJed Brown 462316643e7SJed Brown Output Parameter: 463316643e7SJed Brown . y - right hand side 464316643e7SJed Brown 465316643e7SJed Brown Note: 466316643e7SJed Brown Most users should not need to explicitly call this routine, as it 467316643e7SJed Brown is used internally within the nonlinear solvers. 468316643e7SJed Brown 469316643e7SJed Brown Level: developer 470316643e7SJed Brown 471316643e7SJed Brown .keywords: TS, compute 472316643e7SJed Brown 473316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 474316643e7SJed Brown @*/ 4750910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 476d763cef2SBarry Smith { 477dfbe8321SBarry Smith PetscErrorCode ierr; 47824989b8cSPeter Brune TSRHSFunction rhsfunction; 47924989b8cSPeter Brune TSIFunction ifunction; 48024989b8cSPeter Brune void *ctx; 48124989b8cSPeter Brune DM dm; 48224989b8cSPeter Brune 483d763cef2SBarry Smith PetscFunctionBegin; 4840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4850910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4860700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 48724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 48824989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 4890298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 490d763cef2SBarry Smith 491ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 492d763cef2SBarry Smith 4930910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 49424989b8cSPeter Brune if (rhsfunction) { 495d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 4960910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 497d763cef2SBarry Smith PetscStackPop; 498214bc6a2SJed Brown } else { 499214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 500b2cd27e8SJed Brown } 50144a41b28SSean Farley 5020910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 503d763cef2SBarry Smith PetscFunctionReturn(0); 504d763cef2SBarry Smith } 505d763cef2SBarry Smith 5064a2ae208SSatish Balay #undef __FUNCT__ 507ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 508ef20d060SBarry Smith /*@ 509ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 510ef20d060SBarry Smith 511ef20d060SBarry Smith Collective on TS and Vec 512ef20d060SBarry Smith 513ef20d060SBarry Smith Input Parameters: 514ef20d060SBarry Smith + ts - the TS context 515ef20d060SBarry Smith - t - current time 516ef20d060SBarry Smith 517ef20d060SBarry Smith Output Parameter: 5180910c330SBarry Smith . U - the solution 519ef20d060SBarry Smith 520ef20d060SBarry Smith Note: 521ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 522ef20d060SBarry Smith is used internally within the nonlinear solvers. 523ef20d060SBarry Smith 524ef20d060SBarry Smith Level: developer 525ef20d060SBarry Smith 526ef20d060SBarry Smith .keywords: TS, compute 527ef20d060SBarry Smith 528abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 529ef20d060SBarry Smith @*/ 5300910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 531ef20d060SBarry Smith { 532ef20d060SBarry Smith PetscErrorCode ierr; 533ef20d060SBarry Smith TSSolutionFunction solutionfunction; 534ef20d060SBarry Smith void *ctx; 535ef20d060SBarry Smith DM dm; 536ef20d060SBarry Smith 537ef20d060SBarry Smith PetscFunctionBegin; 538ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5390910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 540ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 541ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 542ef20d060SBarry Smith 543ef20d060SBarry Smith if (solutionfunction) { 5449b7cd975SBarry Smith PetscStackPush("TS user solution function"); 5450910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 546ef20d060SBarry Smith PetscStackPop; 547ef20d060SBarry Smith } 548ef20d060SBarry Smith PetscFunctionReturn(0); 549ef20d060SBarry Smith } 5509b7cd975SBarry Smith #undef __FUNCT__ 5519b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction" 5529b7cd975SBarry Smith /*@ 5539b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 5549b7cd975SBarry Smith 5559b7cd975SBarry Smith Collective on TS and Vec 5569b7cd975SBarry Smith 5579b7cd975SBarry Smith Input Parameters: 5589b7cd975SBarry Smith + ts - the TS context 5599b7cd975SBarry Smith - t - current time 5609b7cd975SBarry Smith 5619b7cd975SBarry Smith Output Parameter: 5629b7cd975SBarry Smith . U - the function value 5639b7cd975SBarry Smith 5649b7cd975SBarry Smith Note: 5659b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 5669b7cd975SBarry Smith is used internally within the nonlinear solvers. 5679b7cd975SBarry Smith 5689b7cd975SBarry Smith Level: developer 5699b7cd975SBarry Smith 5709b7cd975SBarry Smith .keywords: TS, compute 5719b7cd975SBarry Smith 5729b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 5739b7cd975SBarry Smith @*/ 5749b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 5759b7cd975SBarry Smith { 5769b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 5779b7cd975SBarry Smith void *ctx; 5789b7cd975SBarry Smith DM dm; 5799b7cd975SBarry Smith 5809b7cd975SBarry Smith PetscFunctionBegin; 5819b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5829b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5839b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 5849b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 5859b7cd975SBarry Smith 5869b7cd975SBarry Smith if (forcing) { 5879b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 5889b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 5899b7cd975SBarry Smith PetscStackPop; 5909b7cd975SBarry Smith } 5919b7cd975SBarry Smith PetscFunctionReturn(0); 5929b7cd975SBarry Smith } 593ef20d060SBarry Smith 594ef20d060SBarry Smith #undef __FUNCT__ 595214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 596214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 597214bc6a2SJed Brown { 5982dd45cf8SJed Brown Vec F; 599214bc6a2SJed Brown PetscErrorCode ierr; 600214bc6a2SJed Brown 601214bc6a2SJed Brown PetscFunctionBegin; 6020298fd71SBarry Smith *Frhs = NULL; 6030298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 604214bc6a2SJed Brown if (!ts->Frhs) { 6052dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 606214bc6a2SJed Brown } 607214bc6a2SJed Brown *Frhs = ts->Frhs; 608214bc6a2SJed Brown PetscFunctionReturn(0); 609214bc6a2SJed Brown } 610214bc6a2SJed Brown 611214bc6a2SJed Brown #undef __FUNCT__ 612214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 613214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 614214bc6a2SJed Brown { 615214bc6a2SJed Brown Mat A,B; 6162dd45cf8SJed Brown PetscErrorCode ierr; 617214bc6a2SJed Brown 618214bc6a2SJed Brown PetscFunctionBegin; 619c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 620c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 6210298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 622214bc6a2SJed Brown if (Arhs) { 623214bc6a2SJed Brown if (!ts->Arhs) { 624214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 625214bc6a2SJed Brown } 626214bc6a2SJed Brown *Arhs = ts->Arhs; 627214bc6a2SJed Brown } 628214bc6a2SJed Brown if (Brhs) { 629214bc6a2SJed Brown if (!ts->Brhs) { 630bdb70873SJed Brown if (A != B) { 631214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 632bdb70873SJed Brown } else { 633bdb70873SJed Brown ts->Brhs = ts->Arhs; 634bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 635bdb70873SJed Brown } 636214bc6a2SJed Brown } 637214bc6a2SJed Brown *Brhs = ts->Brhs; 638214bc6a2SJed Brown } 639214bc6a2SJed Brown PetscFunctionReturn(0); 640214bc6a2SJed Brown } 641214bc6a2SJed Brown 642214bc6a2SJed Brown #undef __FUNCT__ 643316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 644316643e7SJed Brown /*@ 6450910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 646316643e7SJed Brown 647316643e7SJed Brown Collective on TS and Vec 648316643e7SJed Brown 649316643e7SJed Brown Input Parameters: 650316643e7SJed Brown + ts - the TS context 651316643e7SJed Brown . t - current time 6520910c330SBarry Smith . U - state vector 6530910c330SBarry Smith . Udot - time derivative of state vector 654214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 655316643e7SJed Brown 656316643e7SJed Brown Output Parameter: 657316643e7SJed Brown . Y - right hand side 658316643e7SJed Brown 659316643e7SJed Brown Note: 660316643e7SJed Brown Most users should not need to explicitly call this routine, as it 661316643e7SJed Brown is used internally within the nonlinear solvers. 662316643e7SJed Brown 663316643e7SJed Brown If the user did did not write their equations in implicit form, this 664316643e7SJed Brown function recasts them in implicit form. 665316643e7SJed Brown 666316643e7SJed Brown Level: developer 667316643e7SJed Brown 668316643e7SJed Brown .keywords: TS, compute 669316643e7SJed Brown 670316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 671316643e7SJed Brown @*/ 6720910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 673316643e7SJed Brown { 674316643e7SJed Brown PetscErrorCode ierr; 67524989b8cSPeter Brune TSIFunction ifunction; 67624989b8cSPeter Brune TSRHSFunction rhsfunction; 67724989b8cSPeter Brune void *ctx; 67824989b8cSPeter Brune DM dm; 679316643e7SJed Brown 680316643e7SJed Brown PetscFunctionBegin; 6810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6820910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6830910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 6840700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 685316643e7SJed Brown 68624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 68724989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 6880298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 68924989b8cSPeter Brune 690ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 691d90be118SSean Farley 6920910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 69324989b8cSPeter Brune if (ifunction) { 694316643e7SJed Brown PetscStackPush("TS user implicit function"); 6950910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 696316643e7SJed Brown PetscStackPop; 697214bc6a2SJed Brown } 698214bc6a2SJed Brown if (imex) { 69924989b8cSPeter Brune if (!ifunction) { 7000910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 7012dd45cf8SJed Brown } 70224989b8cSPeter Brune } else if (rhsfunction) { 70324989b8cSPeter Brune if (ifunction) { 704214bc6a2SJed Brown Vec Frhs; 705214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 7060910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 707214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 7082dd45cf8SJed Brown } else { 7090910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 7100910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 711316643e7SJed Brown } 7124a6899ffSJed Brown } 7130910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 714316643e7SJed Brown PetscFunctionReturn(0); 715316643e7SJed Brown } 716316643e7SJed Brown 717316643e7SJed Brown #undef __FUNCT__ 718316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 719316643e7SJed Brown /*@ 720316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 721316643e7SJed Brown 722316643e7SJed Brown Collective on TS and Vec 723316643e7SJed Brown 724316643e7SJed Brown Input 725316643e7SJed Brown Input Parameters: 726316643e7SJed Brown + ts - the TS context 727316643e7SJed Brown . t - current timestep 7280910c330SBarry Smith . U - state vector 7290910c330SBarry Smith . Udot - time derivative of state vector 730214bc6a2SJed Brown . shift - shift to apply, see note below 731214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 732316643e7SJed Brown 733316643e7SJed Brown Output Parameters: 734316643e7SJed Brown + A - Jacobian matrix 735316643e7SJed Brown . B - optional preconditioning matrix 736316643e7SJed Brown - flag - flag indicating matrix structure 737316643e7SJed Brown 738316643e7SJed Brown Notes: 7390910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 740316643e7SJed Brown 7410910c330SBarry Smith dF/dU + shift*dF/dUdot 742316643e7SJed Brown 743316643e7SJed Brown Most users should not need to explicitly call this routine, as it 744316643e7SJed Brown is used internally within the nonlinear solvers. 745316643e7SJed Brown 746316643e7SJed Brown Level: developer 747316643e7SJed Brown 748316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 749316643e7SJed Brown 750316643e7SJed Brown .seealso: TSSetIJacobian() 75163495f91SJed Brown @*/ 752d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 753316643e7SJed Brown { 754316643e7SJed Brown PetscErrorCode ierr; 75524989b8cSPeter Brune TSIJacobian ijacobian; 75624989b8cSPeter Brune TSRHSJacobian rhsjacobian; 75724989b8cSPeter Brune DM dm; 75824989b8cSPeter Brune void *ctx; 759316643e7SJed Brown 760316643e7SJed Brown PetscFunctionBegin; 7610700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7620910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7630910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 764316643e7SJed Brown PetscValidPointer(A,6); 76594ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 766316643e7SJed Brown PetscValidPointer(B,7); 76794ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 76824989b8cSPeter Brune 76924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 77024989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 7710298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 77224989b8cSPeter Brune 773ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 774316643e7SJed Brown 77594ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 77624989b8cSPeter Brune if (ijacobian) { 777316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 778d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 779316643e7SJed Brown PetscStackPop; 780214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 78194ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 78294ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 7834a6899ffSJed Brown } 784214bc6a2SJed Brown if (imex) { 785b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 78694ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 78794ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 78894ab13aaSBarry Smith if (A != B) { 78994ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 79094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 791214bc6a2SJed Brown } 792214bc6a2SJed Brown } 793214bc6a2SJed Brown } else { 794e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 795e1244c69SJed Brown if (rhsjacobian) { 796bd373395SBarry Smith if (ijacobian) { 797e1244c69SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 798bd373395SBarry Smith } else { 799bd373395SBarry Smith ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr); 800e1244c69SJed Brown } 801d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 802e1244c69SJed Brown } 80394ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 804e1244c69SJed Brown ts->rhsjacobian.scale = -1; 805e1244c69SJed Brown ts->rhsjacobian.shift = shift; 80694ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 80794ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 80894ab13aaSBarry Smith if (A != B) { 80994ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 81094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 811316643e7SJed Brown } 812e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 813e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 814e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 81594ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 81694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 81794ab13aaSBarry Smith if (A != B) { 81894ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 81994ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 820e1244c69SJed Brown } 821e1244c69SJed Brown } 82294ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 82394ab13aaSBarry Smith if (A != B) { 82494ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 825214bc6a2SJed Brown } 826316643e7SJed Brown } 827316643e7SJed Brown } 82894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 829316643e7SJed Brown PetscFunctionReturn(0); 830316643e7SJed Brown } 831316643e7SJed Brown 832316643e7SJed Brown #undef __FUNCT__ 8334a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 834d763cef2SBarry Smith /*@C 835d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 836b5abc632SBarry Smith where U_t = G(t,u). 837d763cef2SBarry Smith 8383f9fe445SBarry Smith Logically Collective on TS 839d763cef2SBarry Smith 840d763cef2SBarry Smith Input Parameters: 841d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 8420298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 843d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 844d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 8450298fd71SBarry Smith function evaluation routine (may be NULL) 846d763cef2SBarry Smith 847d763cef2SBarry Smith Calling sequence of func: 84887828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 849d763cef2SBarry Smith 850d763cef2SBarry Smith + t - current timestep 851d763cef2SBarry Smith . u - input vector 852d763cef2SBarry Smith . F - function vector 853d763cef2SBarry Smith - ctx - [optional] user-defined function context 854d763cef2SBarry Smith 855d763cef2SBarry Smith Level: beginner 856d763cef2SBarry Smith 8572bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 8582bbac0d3SBarry Smith 859d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 860d763cef2SBarry Smith 861ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 862d763cef2SBarry Smith @*/ 863089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 864d763cef2SBarry Smith { 865089b2837SJed Brown PetscErrorCode ierr; 866089b2837SJed Brown SNES snes; 8670298fd71SBarry Smith Vec ralloc = NULL; 86824989b8cSPeter Brune DM dm; 869d763cef2SBarry Smith 870089b2837SJed Brown PetscFunctionBegin; 8710700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 872ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 87324989b8cSPeter Brune 87424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 87524989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 876089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 877e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 878e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 879e856ceecSJed Brown r = ralloc; 880e856ceecSJed Brown } 881089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 882e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 883d763cef2SBarry Smith PetscFunctionReturn(0); 884d763cef2SBarry Smith } 885d763cef2SBarry Smith 8864a2ae208SSatish Balay #undef __FUNCT__ 887ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 888ef20d060SBarry Smith /*@C 889abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 890ef20d060SBarry Smith 891ef20d060SBarry Smith Logically Collective on TS 892ef20d060SBarry Smith 893ef20d060SBarry Smith Input Parameters: 894ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 895ef20d060SBarry Smith . f - routine for evaluating the solution 896ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 8970298fd71SBarry Smith function evaluation routine (may be NULL) 898ef20d060SBarry Smith 899ef20d060SBarry Smith Calling sequence of func: 900ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 901ef20d060SBarry Smith 902ef20d060SBarry Smith + t - current timestep 903ef20d060SBarry Smith . u - output vector 904ef20d060SBarry Smith - ctx - [optional] user-defined function context 905ef20d060SBarry Smith 906abd5a294SJed Brown Notes: 907abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 908abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 909abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 910abd5a294SJed Brown 9114f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 912abd5a294SJed Brown 913ef20d060SBarry Smith Level: beginner 914ef20d060SBarry Smith 915ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 916ef20d060SBarry Smith 9179b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 918ef20d060SBarry Smith @*/ 919ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 920ef20d060SBarry Smith { 921ef20d060SBarry Smith PetscErrorCode ierr; 922ef20d060SBarry Smith DM dm; 923ef20d060SBarry Smith 924ef20d060SBarry Smith PetscFunctionBegin; 925ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 926ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 927ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 928ef20d060SBarry Smith PetscFunctionReturn(0); 929ef20d060SBarry Smith } 930ef20d060SBarry Smith 931ef20d060SBarry Smith #undef __FUNCT__ 9329b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction" 9339b7cd975SBarry Smith /*@C 9349b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 9359b7cd975SBarry Smith 9369b7cd975SBarry Smith Logically Collective on TS 9379b7cd975SBarry Smith 9389b7cd975SBarry Smith Input Parameters: 9399b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 9409b7cd975SBarry Smith . f - routine for evaluating the forcing function 9419b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 9420298fd71SBarry Smith function evaluation routine (may be NULL) 9439b7cd975SBarry Smith 9449b7cd975SBarry Smith Calling sequence of func: 9459b7cd975SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 9469b7cd975SBarry Smith 9479b7cd975SBarry Smith + t - current timestep 9489b7cd975SBarry Smith . u - output vector 9499b7cd975SBarry Smith - ctx - [optional] user-defined function context 9509b7cd975SBarry Smith 9519b7cd975SBarry Smith Notes: 9529b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 9539b7cd975SBarry Smith create closed-form solutions with a non-physical forcing term. 9549b7cd975SBarry Smith 9559b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 9569b7cd975SBarry Smith 9579b7cd975SBarry Smith Level: beginner 9589b7cd975SBarry Smith 9599b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 9609b7cd975SBarry Smith 9619b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 9629b7cd975SBarry Smith @*/ 9639b7cd975SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 9649b7cd975SBarry Smith { 9659b7cd975SBarry Smith PetscErrorCode ierr; 9669b7cd975SBarry Smith DM dm; 9679b7cd975SBarry Smith 9689b7cd975SBarry Smith PetscFunctionBegin; 9699b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9709b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 9719b7cd975SBarry Smith ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 9729b7cd975SBarry Smith PetscFunctionReturn(0); 9739b7cd975SBarry Smith } 9749b7cd975SBarry Smith 9759b7cd975SBarry Smith #undef __FUNCT__ 9764a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 977d763cef2SBarry Smith /*@C 978f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 979b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 980d763cef2SBarry Smith 9813f9fe445SBarry Smith Logically Collective on TS 982d763cef2SBarry Smith 983d763cef2SBarry Smith Input Parameters: 984d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 985e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 986e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 987d763cef2SBarry Smith . f - the Jacobian evaluation routine 988d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 9890298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 990d763cef2SBarry Smith 991f7ab8db6SBarry Smith Calling sequence of f: 992ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 993d763cef2SBarry Smith 994d763cef2SBarry Smith + t - current timestep 995d763cef2SBarry Smith . u - input vector 996e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 997e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 998d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 999d763cef2SBarry Smith 1000d763cef2SBarry Smith 1001d763cef2SBarry Smith Level: beginner 1002d763cef2SBarry Smith 1003d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1004d763cef2SBarry Smith 1005ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1006d763cef2SBarry Smith 1007d763cef2SBarry Smith @*/ 1008e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1009d763cef2SBarry Smith { 1010277b19d0SLisandro Dalcin PetscErrorCode ierr; 1011089b2837SJed Brown SNES snes; 101224989b8cSPeter Brune DM dm; 101324989b8cSPeter Brune TSIJacobian ijacobian; 1014277b19d0SLisandro Dalcin 1015d763cef2SBarry Smith PetscFunctionBegin; 10160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1017e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1018e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1019e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1020e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1021d763cef2SBarry Smith 102224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 102324989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1024e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1025e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1026e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1027e1244c69SJed Brown } 10280298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1029089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 10305f659677SPeter Brune if (!ijacobian) { 1031e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 10320e4ef248SJed Brown } 1033e5d3d808SBarry Smith if (Amat) { 1034e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 10350e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1036bbd56ea5SKarl Rupp 1037e5d3d808SBarry Smith ts->Arhs = Amat; 10380e4ef248SJed Brown } 1039e5d3d808SBarry Smith if (Pmat) { 1040e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 10410e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1042bbd56ea5SKarl Rupp 1043e5d3d808SBarry Smith ts->Brhs = Pmat; 10440e4ef248SJed Brown } 1045d763cef2SBarry Smith PetscFunctionReturn(0); 1046d763cef2SBarry Smith } 1047d763cef2SBarry Smith 1048316643e7SJed Brown 1049316643e7SJed Brown #undef __FUNCT__ 1050316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 1051316643e7SJed Brown /*@C 1052b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1053316643e7SJed Brown 10543f9fe445SBarry Smith Logically Collective on TS 1055316643e7SJed Brown 1056316643e7SJed Brown Input Parameters: 1057316643e7SJed Brown + ts - the TS context obtained from TSCreate() 10580298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1059316643e7SJed Brown . f - the function evaluation routine 10600298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1061316643e7SJed Brown 1062316643e7SJed Brown Calling sequence of f: 1063316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1064316643e7SJed Brown 1065316643e7SJed Brown + t - time at step/stage being solved 1066316643e7SJed Brown . u - state vector 1067316643e7SJed Brown . u_t - time derivative of state vector 1068316643e7SJed Brown . F - function vector 1069316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1070316643e7SJed Brown 1071316643e7SJed Brown Important: 10722bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1073316643e7SJed Brown 1074316643e7SJed Brown Level: beginner 1075316643e7SJed Brown 1076316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1077316643e7SJed Brown 1078d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1079316643e7SJed Brown @*/ 1080089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1081316643e7SJed Brown { 1082089b2837SJed Brown PetscErrorCode ierr; 1083089b2837SJed Brown SNES snes; 10840298fd71SBarry Smith Vec resalloc = NULL; 108524989b8cSPeter Brune DM dm; 1086316643e7SJed Brown 1087316643e7SJed Brown PetscFunctionBegin; 10880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1089ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 109024989b8cSPeter Brune 109124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 109224989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 109324989b8cSPeter Brune 1094089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1095e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 1096e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1097e856ceecSJed Brown res = resalloc; 1098e856ceecSJed Brown } 1099089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1100e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1101089b2837SJed Brown PetscFunctionReturn(0); 1102089b2837SJed Brown } 1103089b2837SJed Brown 1104089b2837SJed Brown #undef __FUNCT__ 1105089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 1106089b2837SJed Brown /*@C 1107089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1108089b2837SJed Brown 1109089b2837SJed Brown Not Collective 1110089b2837SJed Brown 1111089b2837SJed Brown Input Parameter: 1112089b2837SJed Brown . ts - the TS context 1113089b2837SJed Brown 1114089b2837SJed Brown Output Parameter: 11150298fd71SBarry Smith + r - vector to hold residual (or NULL) 11160298fd71SBarry Smith . func - the function to compute residual (or NULL) 11170298fd71SBarry Smith - ctx - the function context (or NULL) 1118089b2837SJed Brown 1119089b2837SJed Brown Level: advanced 1120089b2837SJed Brown 1121089b2837SJed Brown .keywords: TS, nonlinear, get, function 1122089b2837SJed Brown 1123089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1124089b2837SJed Brown @*/ 1125089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1126089b2837SJed Brown { 1127089b2837SJed Brown PetscErrorCode ierr; 1128089b2837SJed Brown SNES snes; 112924989b8cSPeter Brune DM dm; 1130089b2837SJed Brown 1131089b2837SJed Brown PetscFunctionBegin; 1132089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1133089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11340298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 113524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 113624989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1137089b2837SJed Brown PetscFunctionReturn(0); 1138089b2837SJed Brown } 1139089b2837SJed Brown 1140089b2837SJed Brown #undef __FUNCT__ 1141089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 1142089b2837SJed Brown /*@C 1143089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1144089b2837SJed Brown 1145089b2837SJed Brown Not Collective 1146089b2837SJed Brown 1147089b2837SJed Brown Input Parameter: 1148089b2837SJed Brown . ts - the TS context 1149089b2837SJed Brown 1150089b2837SJed Brown Output Parameter: 11510298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 11520298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 11530298fd71SBarry Smith - ctx - the function context (or NULL) 1154089b2837SJed Brown 1155089b2837SJed Brown Level: advanced 1156089b2837SJed Brown 1157089b2837SJed Brown .keywords: TS, nonlinear, get, function 1158089b2837SJed Brown 11592bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1160089b2837SJed Brown @*/ 1161089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1162089b2837SJed Brown { 1163089b2837SJed Brown PetscErrorCode ierr; 1164089b2837SJed Brown SNES snes; 116524989b8cSPeter Brune DM dm; 1166089b2837SJed Brown 1167089b2837SJed Brown PetscFunctionBegin; 1168089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1169089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11700298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 117124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 117224989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1173316643e7SJed Brown PetscFunctionReturn(0); 1174316643e7SJed Brown } 1175316643e7SJed Brown 1176316643e7SJed Brown #undef __FUNCT__ 1177316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 1178316643e7SJed Brown /*@C 1179a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1180ae8867d6SBarry Smith provided with TSSetIFunction(). 1181316643e7SJed Brown 11823f9fe445SBarry Smith Logically Collective on TS 1183316643e7SJed Brown 1184316643e7SJed Brown Input Parameters: 1185316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1186e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1187e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1188316643e7SJed Brown . f - the Jacobian evaluation routine 11890298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1190316643e7SJed Brown 1191316643e7SJed Brown Calling sequence of f: 1192ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1193316643e7SJed Brown 1194316643e7SJed Brown + t - time at step/stage being solved 11951b4a444bSJed Brown . U - state vector 11961b4a444bSJed Brown . U_t - time derivative of state vector 1197316643e7SJed Brown . a - shift 1198e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1199e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1200316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1201316643e7SJed Brown 1202316643e7SJed Brown Notes: 1203e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1204316643e7SJed Brown 1205a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1206b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1207a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1208a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1209a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1210a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1211a4f0a591SBarry Smith 1212316643e7SJed Brown Level: beginner 1213316643e7SJed Brown 1214316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1215316643e7SJed Brown 1216ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1217316643e7SJed Brown 1218316643e7SJed Brown @*/ 1219e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1220316643e7SJed Brown { 1221316643e7SJed Brown PetscErrorCode ierr; 1222089b2837SJed Brown SNES snes; 122324989b8cSPeter Brune DM dm; 1224316643e7SJed Brown 1225316643e7SJed Brown PetscFunctionBegin; 12260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1227e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1228e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1229e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1230e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 123124989b8cSPeter Brune 123224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 123324989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 123424989b8cSPeter Brune 1235089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1236e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1237316643e7SJed Brown PetscFunctionReturn(0); 1238316643e7SJed Brown } 1239316643e7SJed Brown 12404a2ae208SSatish Balay #undef __FUNCT__ 1241e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse" 1242e1244c69SJed Brown /*@ 1243e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1244e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1245e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1246e1244c69SJed Brown not been changed by the TS. 1247e1244c69SJed Brown 1248e1244c69SJed Brown Logically Collective 1249e1244c69SJed Brown 1250e1244c69SJed Brown Input Arguments: 1251e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1252e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1253e1244c69SJed Brown 1254e1244c69SJed Brown Level: intermediate 1255e1244c69SJed Brown 1256e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1257e1244c69SJed Brown @*/ 1258e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1259e1244c69SJed Brown { 1260e1244c69SJed Brown PetscFunctionBegin; 1261e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1262e1244c69SJed Brown PetscFunctionReturn(0); 1263e1244c69SJed Brown } 1264e1244c69SJed Brown 1265e1244c69SJed Brown #undef __FUNCT__ 126655849f57SBarry Smith #define __FUNCT__ "TSLoad" 126755849f57SBarry Smith /*@C 126855849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 126955849f57SBarry Smith 127055849f57SBarry Smith Collective on PetscViewer 127155849f57SBarry Smith 127255849f57SBarry Smith Input Parameters: 127355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 127455849f57SBarry Smith some related function before a call to TSLoad(). 127555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 127655849f57SBarry Smith 127755849f57SBarry Smith Level: intermediate 127855849f57SBarry Smith 127955849f57SBarry Smith Notes: 128055849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 128155849f57SBarry Smith 128255849f57SBarry Smith Notes for advanced users: 128355849f57SBarry Smith Most users should not need to know the details of the binary storage 128455849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 128555849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 128655849f57SBarry Smith format is 128755849f57SBarry Smith .vb 128855849f57SBarry Smith has not yet been determined 128955849f57SBarry Smith .ve 129055849f57SBarry Smith 129155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 129255849f57SBarry Smith @*/ 1293f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 129455849f57SBarry Smith { 129555849f57SBarry Smith PetscErrorCode ierr; 129655849f57SBarry Smith PetscBool isbinary; 129755849f57SBarry Smith PetscInt classid; 129855849f57SBarry Smith char type[256]; 12992d53ad75SBarry Smith DMTS sdm; 1300ad6bc421SBarry Smith DM dm; 130155849f57SBarry Smith 130255849f57SBarry Smith PetscFunctionBegin; 1303f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 130455849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 130555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 130655849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 130755849f57SBarry Smith 130855849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1309ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 131055849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1311f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1312f2c2a1b9SBarry Smith if (ts->ops->load) { 1313f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1314f2c2a1b9SBarry Smith } 1315ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1316ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1317ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1318f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1319f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 13202d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13212d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 132255849f57SBarry Smith PetscFunctionReturn(0); 132355849f57SBarry Smith } 132455849f57SBarry Smith 13259804daf3SBarry Smith #include <petscdraw.h> 1326e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1327e04113cfSBarry Smith #include <petscviewersaws.h> 1328f05ece33SBarry Smith #endif 132955849f57SBarry Smith #undef __FUNCT__ 13304a2ae208SSatish Balay #define __FUNCT__ "TSView" 13317e2c5f70SBarry Smith /*@C 1332d763cef2SBarry Smith TSView - Prints the TS data structure. 1333d763cef2SBarry Smith 13344c49b128SBarry Smith Collective on TS 1335d763cef2SBarry Smith 1336d763cef2SBarry Smith Input Parameters: 1337d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1338d763cef2SBarry Smith - viewer - visualization context 1339d763cef2SBarry Smith 1340d763cef2SBarry Smith Options Database Key: 1341d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1342d763cef2SBarry Smith 1343d763cef2SBarry Smith Notes: 1344d763cef2SBarry Smith The available visualization contexts include 1345b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1346b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1347d763cef2SBarry Smith output where only the first processor opens 1348d763cef2SBarry Smith the file. All other processors send their 1349d763cef2SBarry Smith data to the first processor to print. 1350d763cef2SBarry Smith 1351d763cef2SBarry Smith The user can open an alternative visualization context with 1352b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1353d763cef2SBarry Smith 1354d763cef2SBarry Smith Level: beginner 1355d763cef2SBarry Smith 1356d763cef2SBarry Smith .keywords: TS, timestep, view 1357d763cef2SBarry Smith 1358b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1359d763cef2SBarry Smith @*/ 13607087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1361d763cef2SBarry Smith { 1362dfbe8321SBarry Smith PetscErrorCode ierr; 136319fd82e9SBarry Smith TSType type; 13642b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 13652d53ad75SBarry Smith DMTS sdm; 1366e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1367536b137fSBarry Smith PetscBool issaws; 1368f05ece33SBarry Smith #endif 1369d763cef2SBarry Smith 1370d763cef2SBarry Smith PetscFunctionBegin; 13710700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 13723050cee2SBarry Smith if (!viewer) { 1373ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 13743050cee2SBarry Smith } 13750700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1376c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1377fd16b177SBarry Smith 1378251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1379251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 138055849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 13812b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1382e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1383536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1384f05ece33SBarry Smith #endif 138532077d6dSBarry Smith if (iascii) { 1386dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 138777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 13887c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1389d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 13905ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1391c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1392d763cef2SBarry Smith } 13935ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1394193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 13952d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13962d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1397d52bd9f3SBarry Smith if (ts->ops->view) { 1398d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1399d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1400d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1401d52bd9f3SBarry Smith } 14020f5bd95cSBarry Smith } else if (isstring) { 1403a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1404b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 140555849f57SBarry Smith } else if (isbinary) { 140655849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 140755849f57SBarry Smith MPI_Comm comm; 140855849f57SBarry Smith PetscMPIInt rank; 140955849f57SBarry Smith char type[256]; 141055849f57SBarry Smith 141155849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 141255849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 141355849f57SBarry Smith if (!rank) { 141455849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 141555849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 141655849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 141755849f57SBarry Smith } 141855849f57SBarry Smith if (ts->ops->view) { 141955849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 142055849f57SBarry Smith } 1421f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1422f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 14232d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 14242d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 14252b0a91c0SBarry Smith } else if (isdraw) { 14262b0a91c0SBarry Smith PetscDraw draw; 14272b0a91c0SBarry Smith char str[36]; 142889fd9fafSBarry Smith PetscReal x,y,bottom,h; 14292b0a91c0SBarry Smith 14302b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 14312b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 14322b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 14332b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 14340298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 143589fd9fafSBarry Smith bottom = y - h; 14362b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 14372b0a91c0SBarry Smith if (ts->ops->view) { 14382b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14392b0a91c0SBarry Smith } 14402b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1441e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1442536b137fSBarry Smith } else if (issaws) { 1443d45a07a7SBarry Smith PetscMPIInt rank; 14442657e9d9SBarry Smith const char *name; 14452657e9d9SBarry Smith 14462657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1447d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1448d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1449d45a07a7SBarry Smith char dir[1024]; 1450d45a07a7SBarry Smith 1451e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1452a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 14532657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 14542657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 14552657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1456d763cef2SBarry Smith } 14570acecf5bSBarry Smith if (ts->ops->view) { 14580acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14590acecf5bSBarry Smith } 1460f05ece33SBarry Smith #endif 1461f05ece33SBarry Smith } 1462f05ece33SBarry Smith 1463b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1464251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1465b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1466d763cef2SBarry Smith PetscFunctionReturn(0); 1467d763cef2SBarry Smith } 1468d763cef2SBarry Smith 1469d763cef2SBarry Smith 14704a2ae208SSatish Balay #undef __FUNCT__ 14714a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1472b07ff414SBarry Smith /*@ 1473d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1474d763cef2SBarry Smith the timesteppers. 1475d763cef2SBarry Smith 14763f9fe445SBarry Smith Logically Collective on TS 1477d763cef2SBarry Smith 1478d763cef2SBarry Smith Input Parameters: 1479d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1480d763cef2SBarry Smith - usrP - optional user context 1481d763cef2SBarry Smith 1482d763cef2SBarry Smith Level: intermediate 1483d763cef2SBarry Smith 1484d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1485d763cef2SBarry Smith 1486d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1487d763cef2SBarry Smith @*/ 14887087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1489d763cef2SBarry Smith { 1490d763cef2SBarry Smith PetscFunctionBegin; 14910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1492d763cef2SBarry Smith ts->user = usrP; 1493d763cef2SBarry Smith PetscFunctionReturn(0); 1494d763cef2SBarry Smith } 1495d763cef2SBarry Smith 14964a2ae208SSatish Balay #undef __FUNCT__ 14974a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1498b07ff414SBarry Smith /*@ 1499d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1500d763cef2SBarry Smith timestepper. 1501d763cef2SBarry Smith 1502d763cef2SBarry Smith Not Collective 1503d763cef2SBarry Smith 1504d763cef2SBarry Smith Input Parameter: 1505d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1506d763cef2SBarry Smith 1507d763cef2SBarry Smith Output Parameter: 1508d763cef2SBarry Smith . usrP - user context 1509d763cef2SBarry Smith 1510d763cef2SBarry Smith Level: intermediate 1511d763cef2SBarry Smith 1512d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1513d763cef2SBarry Smith 1514d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1515d763cef2SBarry Smith @*/ 1516e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1517d763cef2SBarry Smith { 1518d763cef2SBarry Smith PetscFunctionBegin; 15190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1520e71120c6SJed Brown *(void**)usrP = ts->user; 1521d763cef2SBarry Smith PetscFunctionReturn(0); 1522d763cef2SBarry Smith } 1523d763cef2SBarry Smith 15244a2ae208SSatish Balay #undef __FUNCT__ 15254a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1526d763cef2SBarry Smith /*@ 1527b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1528d763cef2SBarry Smith 1529d763cef2SBarry Smith Not Collective 1530d763cef2SBarry Smith 1531d763cef2SBarry Smith Input Parameter: 1532d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1533d763cef2SBarry Smith 1534d763cef2SBarry Smith Output Parameter: 1535b8123daeSJed Brown . iter - number of steps completed so far 1536d763cef2SBarry Smith 1537d763cef2SBarry Smith Level: intermediate 1538d763cef2SBarry Smith 1539d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 15409be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 1541d763cef2SBarry Smith @*/ 15427087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1543d763cef2SBarry Smith { 1544d763cef2SBarry Smith PetscFunctionBegin; 15450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 15464482741eSBarry Smith PetscValidIntPointer(iter,2); 1547d763cef2SBarry Smith *iter = ts->steps; 1548d763cef2SBarry Smith PetscFunctionReturn(0); 1549d763cef2SBarry Smith } 1550d763cef2SBarry Smith 15514a2ae208SSatish Balay #undef __FUNCT__ 15524a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1553d763cef2SBarry Smith /*@ 1554d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1555d763cef2SBarry Smith as well as the initial time. 1556d763cef2SBarry Smith 15573f9fe445SBarry Smith Logically Collective on TS 1558d763cef2SBarry Smith 1559d763cef2SBarry Smith Input Parameters: 1560d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1561d763cef2SBarry Smith . initial_time - the initial time 1562d763cef2SBarry Smith - time_step - the size of the timestep 1563d763cef2SBarry Smith 1564d763cef2SBarry Smith Level: intermediate 1565d763cef2SBarry Smith 1566d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1567d763cef2SBarry Smith 1568d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1569d763cef2SBarry Smith @*/ 15707087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1571d763cef2SBarry Smith { 1572e144a568SJed Brown PetscErrorCode ierr; 1573e144a568SJed Brown 1574d763cef2SBarry Smith PetscFunctionBegin; 15750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1576e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1577d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1578d763cef2SBarry Smith PetscFunctionReturn(0); 1579d763cef2SBarry Smith } 1580d763cef2SBarry Smith 15814a2ae208SSatish Balay #undef __FUNCT__ 15824a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1583d763cef2SBarry Smith /*@ 1584d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1585d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1586d763cef2SBarry Smith 15873f9fe445SBarry Smith Logically Collective on TS 1588d763cef2SBarry Smith 1589d763cef2SBarry Smith Input Parameters: 1590d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1591d763cef2SBarry Smith - time_step - the size of the timestep 1592d763cef2SBarry Smith 1593d763cef2SBarry Smith Level: intermediate 1594d763cef2SBarry Smith 1595d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1596d763cef2SBarry Smith 1597d763cef2SBarry Smith .keywords: TS, set, timestep 1598d763cef2SBarry Smith @*/ 15997087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1600d763cef2SBarry Smith { 1601d763cef2SBarry Smith PetscFunctionBegin; 16020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1603c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1604d763cef2SBarry Smith ts->time_step = time_step; 160531748224SBarry Smith ts->time_step_orig = time_step; 1606d763cef2SBarry Smith PetscFunctionReturn(0); 1607d763cef2SBarry Smith } 1608d763cef2SBarry Smith 16094a2ae208SSatish Balay #undef __FUNCT__ 1610a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1611a43b19c4SJed Brown /*@ 161249354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 161349354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 161449354f04SShri Abhyankar or just return at the final time TS computed. 1615a43b19c4SJed Brown 1616a43b19c4SJed Brown Logically Collective on TS 1617a43b19c4SJed Brown 1618a43b19c4SJed Brown Input Parameter: 1619a43b19c4SJed Brown + ts - the time-step context 162049354f04SShri Abhyankar - eftopt - exact final time option 1621a43b19c4SJed Brown 1622a43b19c4SJed Brown Level: beginner 1623a43b19c4SJed Brown 1624a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 1625a43b19c4SJed Brown @*/ 162649354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1627a43b19c4SJed Brown { 1628a43b19c4SJed Brown PetscFunctionBegin; 1629a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 163049354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 163149354f04SShri Abhyankar ts->exact_final_time = eftopt; 1632a43b19c4SJed Brown PetscFunctionReturn(0); 1633a43b19c4SJed Brown } 1634a43b19c4SJed Brown 1635a43b19c4SJed Brown #undef __FUNCT__ 16364a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1637d763cef2SBarry Smith /*@ 1638d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1639d763cef2SBarry Smith 1640d763cef2SBarry Smith Not Collective 1641d763cef2SBarry Smith 1642d763cef2SBarry Smith Input Parameter: 1643d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1644d763cef2SBarry Smith 1645d763cef2SBarry Smith Output Parameter: 1646d763cef2SBarry Smith . dt - the current timestep size 1647d763cef2SBarry Smith 1648d763cef2SBarry Smith Level: intermediate 1649d763cef2SBarry Smith 1650d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1651d763cef2SBarry Smith 1652d763cef2SBarry Smith .keywords: TS, get, timestep 1653d763cef2SBarry Smith @*/ 16547087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1655d763cef2SBarry Smith { 1656d763cef2SBarry Smith PetscFunctionBegin; 16570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1658f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1659d763cef2SBarry Smith *dt = ts->time_step; 1660d763cef2SBarry Smith PetscFunctionReturn(0); 1661d763cef2SBarry Smith } 1662d763cef2SBarry Smith 16634a2ae208SSatish Balay #undef __FUNCT__ 16644a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1665d8e5e3e6SSatish Balay /*@ 1666d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1667d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1668d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1669d763cef2SBarry Smith the solution at the next timestep has been calculated. 1670d763cef2SBarry Smith 1671d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1672d763cef2SBarry Smith 1673d763cef2SBarry Smith Input Parameter: 1674d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1675d763cef2SBarry Smith 1676d763cef2SBarry Smith Output Parameter: 1677d763cef2SBarry Smith . v - the vector containing the solution 1678d763cef2SBarry Smith 1679d763cef2SBarry Smith Level: intermediate 1680d763cef2SBarry Smith 1681d763cef2SBarry Smith .seealso: TSGetTimeStep() 1682d763cef2SBarry Smith 1683d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1684d763cef2SBarry Smith @*/ 16857087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1686d763cef2SBarry Smith { 1687d763cef2SBarry Smith PetscFunctionBegin; 16880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 16894482741eSBarry Smith PetscValidPointer(v,2); 16908737fe31SLisandro Dalcin *v = ts->vec_sol; 1691d763cef2SBarry Smith PetscFunctionReturn(0); 1692d763cef2SBarry Smith } 1693d763cef2SBarry Smith 1694c235aa8dSHong Zhang #undef __FUNCT__ 16950cf82b59SBarry Smith #define __FUNCT__ "TSAdjointGetCostGradients" 1696c235aa8dSHong Zhang /*@ 16970cf82b59SBarry Smith TSAdjointGetCostGradients - Returns the gradients from the TSAdjointSolve() 1698c235aa8dSHong Zhang 1699c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 1700c235aa8dSHong Zhang 1701c235aa8dSHong Zhang Input Parameter: 1702c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 1703c235aa8dSHong Zhang 1704c235aa8dSHong Zhang Output Parameter: 1705abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 1706abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 1707c235aa8dSHong Zhang 1708c235aa8dSHong Zhang Level: intermediate 1709c235aa8dSHong Zhang 1710c235aa8dSHong Zhang .seealso: TSGetTimeStep() 1711c235aa8dSHong Zhang 1712c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 1713c235aa8dSHong Zhang @*/ 1714abc2977eSBarry Smith PetscErrorCode TSAdjointGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 1715c235aa8dSHong Zhang { 1716c235aa8dSHong Zhang PetscFunctionBegin; 1717c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1718abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 1719abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 1720abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 1721c235aa8dSHong Zhang PetscFunctionReturn(0); 1722c235aa8dSHong Zhang } 1723c235aa8dSHong Zhang 1724bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 17254a2ae208SSatish Balay #undef __FUNCT__ 1726bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1727d8e5e3e6SSatish Balay /*@ 1728bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1729d763cef2SBarry Smith 1730bdad233fSMatthew Knepley Not collective 1731d763cef2SBarry Smith 1732bdad233fSMatthew Knepley Input Parameters: 1733bdad233fSMatthew Knepley + ts - The TS 1734bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1735d763cef2SBarry Smith .vb 17360910c330SBarry Smith U_t - A U = 0 (linear) 17370910c330SBarry Smith U_t - A(t) U = 0 (linear) 17380910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1739d763cef2SBarry Smith .ve 1740d763cef2SBarry Smith 1741d763cef2SBarry Smith Level: beginner 1742d763cef2SBarry Smith 1743bdad233fSMatthew Knepley .keywords: TS, problem type 1744bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1745d763cef2SBarry Smith @*/ 17467087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1747a7cc72afSBarry Smith { 17489e2a6581SJed Brown PetscErrorCode ierr; 17499e2a6581SJed Brown 1750d763cef2SBarry Smith PetscFunctionBegin; 17510700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1752bdad233fSMatthew Knepley ts->problem_type = type; 17539e2a6581SJed Brown if (type == TS_LINEAR) { 17549e2a6581SJed Brown SNES snes; 17559e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 17569e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 17579e2a6581SJed Brown } 1758d763cef2SBarry Smith PetscFunctionReturn(0); 1759d763cef2SBarry Smith } 1760d763cef2SBarry Smith 1761bdad233fSMatthew Knepley #undef __FUNCT__ 1762bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1763bdad233fSMatthew Knepley /*@C 1764bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1765bdad233fSMatthew Knepley 1766bdad233fSMatthew Knepley Not collective 1767bdad233fSMatthew Knepley 1768bdad233fSMatthew Knepley Input Parameter: 1769bdad233fSMatthew Knepley . ts - The TS 1770bdad233fSMatthew Knepley 1771bdad233fSMatthew Knepley Output Parameter: 1772bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1773bdad233fSMatthew Knepley .vb 1774089b2837SJed Brown M U_t = A U 1775089b2837SJed Brown M(t) U_t = A(t) U 1776b5abc632SBarry Smith F(t,U,U_t) 1777bdad233fSMatthew Knepley .ve 1778bdad233fSMatthew Knepley 1779bdad233fSMatthew Knepley Level: beginner 1780bdad233fSMatthew Knepley 1781bdad233fSMatthew Knepley .keywords: TS, problem type 1782bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1783bdad233fSMatthew Knepley @*/ 17847087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1785a7cc72afSBarry Smith { 1786bdad233fSMatthew Knepley PetscFunctionBegin; 17870700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 17884482741eSBarry Smith PetscValidIntPointer(type,2); 1789bdad233fSMatthew Knepley *type = ts->problem_type; 1790bdad233fSMatthew Knepley PetscFunctionReturn(0); 1791bdad233fSMatthew Knepley } 1792d763cef2SBarry Smith 17934a2ae208SSatish Balay #undef __FUNCT__ 17944a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1795d763cef2SBarry Smith /*@ 1796d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1797d763cef2SBarry Smith of a timestepper. 1798d763cef2SBarry Smith 1799d763cef2SBarry Smith Collective on TS 1800d763cef2SBarry Smith 1801d763cef2SBarry Smith Input Parameter: 1802d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1803d763cef2SBarry Smith 1804d763cef2SBarry Smith Notes: 1805d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1806d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1807d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1808d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1809d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1810d763cef2SBarry Smith 1811d763cef2SBarry Smith Level: advanced 1812d763cef2SBarry Smith 1813d763cef2SBarry Smith .keywords: TS, timestep, setup 1814d763cef2SBarry Smith 1815d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1816d763cef2SBarry Smith @*/ 18177087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1818d763cef2SBarry Smith { 1819dfbe8321SBarry Smith PetscErrorCode ierr; 18206c6b9e74SPeter Brune DM dm; 18216c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 1822d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 18236c6b9e74SPeter Brune TSIJacobian ijac; 18246c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1825d763cef2SBarry Smith 1826d763cef2SBarry Smith PetscFunctionBegin; 18270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1828277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1829277b19d0SLisandro Dalcin 18302c18e0fdSBarry Smith ts->total_steps = 0; 18317adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 18329596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1833d763cef2SBarry Smith } 1834277b19d0SLisandro Dalcin 1835277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1836277b19d0SLisandro Dalcin 1837c235aa8dSHong Zhang 1838552698daSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 18391c3436cfSJed Brown 1840e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 1841e1244c69SJed Brown Mat Amat,Pmat; 1842e1244c69SJed Brown SNES snes; 1843e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1844e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 1845e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 1846e1244c69SJed Brown * have displaced the RHS matrix */ 1847e1244c69SJed Brown if (Amat == ts->Arhs) { 1848e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 1849e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 1850e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 1851e1244c69SJed Brown } 1852e1244c69SJed Brown if (Pmat == ts->Brhs) { 1853e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 1854e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 1855e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 1856e1244c69SJed Brown } 1857e1244c69SJed Brown } 1858277b19d0SLisandro Dalcin if (ts->ops->setup) { 1859000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1860277b19d0SLisandro Dalcin } 1861277b19d0SLisandro Dalcin 18626c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 18636c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 18646c6b9e74SPeter Brune */ 18656c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 18660298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 18676c6b9e74SPeter Brune if (!func) { 18686c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 18696c6b9e74SPeter Brune } 18706c6b9e74SPeter 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. 18716c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 18726c6b9e74SPeter Brune */ 18730298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 18740298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 18750298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 18766c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 18776c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 18786c6b9e74SPeter Brune } 1879277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1880277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1881277b19d0SLisandro Dalcin } 1882277b19d0SLisandro Dalcin 1883277b19d0SLisandro Dalcin #undef __FUNCT__ 1884f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp" 1885f6a906c0SBarry Smith /*@ 1886f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 1887f6a906c0SBarry Smith of an adjoint solver 1888f6a906c0SBarry Smith 1889f6a906c0SBarry Smith Collective on TS 1890f6a906c0SBarry Smith 1891f6a906c0SBarry Smith Input Parameter: 1892f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 1893f6a906c0SBarry Smith 1894f6a906c0SBarry Smith Notes: 1895f6a906c0SBarry Smith For basic use of the TS solvers the user need not explicitly call 1896f6a906c0SBarry Smith TSSetUp(), since these actions will automatically occur during 1897f6a906c0SBarry Smith the call to TSStep(). However, if one wishes to control this 1898f6a906c0SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1899f6a906c0SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1900f6a906c0SBarry Smith 1901f6a906c0SBarry Smith Level: advanced 1902f6a906c0SBarry Smith 1903f6a906c0SBarry Smith .keywords: TS, timestep, setup 1904f6a906c0SBarry Smith 1905f6a906c0SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1906f6a906c0SBarry Smith @*/ 1907f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 1908f6a906c0SBarry Smith { 1909f6a906c0SBarry Smith PetscErrorCode ierr; 1910f6a906c0SBarry Smith 1911f6a906c0SBarry Smith PetscFunctionBegin; 1912f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1913f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 19140cf82b59SBarry Smith if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetCostGradients() first"); 1915*d8151eeaSBarry Smith 1916*d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 1917*d8151eeaSBarry Smith if (ts->vecs_sensip){ 1918*d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 1919*d8151eeaSBarry Smith } 1920*d8151eeaSBarry Smith 192142f2b339SBarry Smith if (ts->ops->adjointsetup) { 192242f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 1923f6a906c0SBarry Smith } 1924f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 1925f6a906c0SBarry Smith PetscFunctionReturn(0); 1926f6a906c0SBarry Smith } 1927f6a906c0SBarry Smith 1928f6a906c0SBarry Smith #undef __FUNCT__ 1929277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1930277b19d0SLisandro Dalcin /*@ 1931277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1932277b19d0SLisandro Dalcin 1933277b19d0SLisandro Dalcin Collective on TS 1934277b19d0SLisandro Dalcin 1935277b19d0SLisandro Dalcin Input Parameter: 1936277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1937277b19d0SLisandro Dalcin 1938277b19d0SLisandro Dalcin Level: beginner 1939277b19d0SLisandro Dalcin 1940277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1941277b19d0SLisandro Dalcin 1942277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1943277b19d0SLisandro Dalcin @*/ 1944277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1945277b19d0SLisandro Dalcin { 1946277b19d0SLisandro Dalcin PetscErrorCode ierr; 1947277b19d0SLisandro Dalcin 1948277b19d0SLisandro Dalcin PetscFunctionBegin; 1949277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1950b18ea86cSHong Zhang 1951277b19d0SLisandro Dalcin if (ts->ops->reset) { 1952277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1953277b19d0SLisandro Dalcin } 1954277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 1955bbd56ea5SKarl Rupp 19564e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 19574e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1958214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 19596bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1960e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1961e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 196238637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1963*d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 1964*d8151eeaSBarry Smith if (ts->vecs_drdp){ 1965*d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 1966*d8151eeaSBarry Smith } 1967*d8151eeaSBarry Smith ts->vecs_sensi = NULL; 1968*d8151eeaSBarry Smith ts->vecs_sensip = NULL; 1969ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 19702c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 197136eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 1972277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1973d763cef2SBarry Smith PetscFunctionReturn(0); 1974d763cef2SBarry Smith } 1975d763cef2SBarry Smith 19764a2ae208SSatish Balay #undef __FUNCT__ 19774a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1978d8e5e3e6SSatish Balay /*@ 1979d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1980d763cef2SBarry Smith with TSCreate(). 1981d763cef2SBarry Smith 1982d763cef2SBarry Smith Collective on TS 1983d763cef2SBarry Smith 1984d763cef2SBarry Smith Input Parameter: 1985d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1986d763cef2SBarry Smith 1987d763cef2SBarry Smith Level: beginner 1988d763cef2SBarry Smith 1989d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1990d763cef2SBarry Smith 1991d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1992d763cef2SBarry Smith @*/ 19936bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1994d763cef2SBarry Smith { 19956849ba73SBarry Smith PetscErrorCode ierr; 1996d763cef2SBarry Smith 1997d763cef2SBarry Smith PetscFunctionBegin; 19986bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 19996bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 20006bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2001d763cef2SBarry Smith 20026bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2003277b19d0SLisandro Dalcin 2004e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2005e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 20066bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 20076d4c513bSLisandro Dalcin 2008bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2009bc952696SBarry Smith 201084df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 2011aeb4809dSShri Abhyankar if ((*ts)->event) { 2012aeb4809dSShri Abhyankar ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr); 2013aeb4809dSShri Abhyankar } 20146bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 20156bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 20166bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 20176d4c513bSLisandro Dalcin 2018a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2019d763cef2SBarry Smith PetscFunctionReturn(0); 2020d763cef2SBarry Smith } 2021d763cef2SBarry Smith 20224a2ae208SSatish Balay #undef __FUNCT__ 20234a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 2024d8e5e3e6SSatish Balay /*@ 2025d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2026d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2027d763cef2SBarry Smith 2028d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2029d763cef2SBarry Smith 2030d763cef2SBarry Smith Input Parameter: 2031d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2032d763cef2SBarry Smith 2033d763cef2SBarry Smith Output Parameter: 2034d763cef2SBarry Smith . snes - the nonlinear solver context 2035d763cef2SBarry Smith 2036d763cef2SBarry Smith Notes: 2037d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2038d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 203994b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2040d763cef2SBarry Smith 2041d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 20420298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2043d763cef2SBarry Smith 2044d763cef2SBarry Smith Level: beginner 2045d763cef2SBarry Smith 2046d763cef2SBarry Smith .keywords: timestep, get, SNES 2047d763cef2SBarry Smith @*/ 20487087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2049d763cef2SBarry Smith { 2050d372ba47SLisandro Dalcin PetscErrorCode ierr; 2051d372ba47SLisandro Dalcin 2052d763cef2SBarry Smith PetscFunctionBegin; 20530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20544482741eSBarry Smith PetscValidPointer(snes,2); 2055d372ba47SLisandro Dalcin if (!ts->snes) { 2056ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 20570298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 20583bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2059d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2060496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 20619e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 20629e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 20639e2a6581SJed Brown } 2064d372ba47SLisandro Dalcin } 2065d763cef2SBarry Smith *snes = ts->snes; 2066d763cef2SBarry Smith PetscFunctionReturn(0); 2067d763cef2SBarry Smith } 2068d763cef2SBarry Smith 20694a2ae208SSatish Balay #undef __FUNCT__ 2070deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES" 2071deb2cd25SJed Brown /*@ 2072deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2073deb2cd25SJed Brown 2074deb2cd25SJed Brown Collective 2075deb2cd25SJed Brown 2076deb2cd25SJed Brown Input Parameter: 2077deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2078deb2cd25SJed Brown - snes - the nonlinear solver context 2079deb2cd25SJed Brown 2080deb2cd25SJed Brown Notes: 2081deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2082deb2cd25SJed Brown 2083deb2cd25SJed Brown Level: developer 2084deb2cd25SJed Brown 2085deb2cd25SJed Brown .keywords: timestep, set, SNES 2086deb2cd25SJed Brown @*/ 2087deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2088deb2cd25SJed Brown { 2089deb2cd25SJed Brown PetscErrorCode ierr; 2090d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2091deb2cd25SJed Brown 2092deb2cd25SJed Brown PetscFunctionBegin; 2093deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2094deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2095deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2096deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2097bbd56ea5SKarl Rupp 2098deb2cd25SJed Brown ts->snes = snes; 2099bbd56ea5SKarl Rupp 21000298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 21010298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2102740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 21030298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2104740132f1SEmil Constantinescu } 2105deb2cd25SJed Brown PetscFunctionReturn(0); 2106deb2cd25SJed Brown } 2107deb2cd25SJed Brown 2108deb2cd25SJed Brown #undef __FUNCT__ 210994b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 2110d8e5e3e6SSatish Balay /*@ 211194b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2112d763cef2SBarry Smith a TS (timestepper) context. 2113d763cef2SBarry Smith 211494b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2115d763cef2SBarry Smith 2116d763cef2SBarry Smith Input Parameter: 2117d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2118d763cef2SBarry Smith 2119d763cef2SBarry Smith Output Parameter: 212094b7f48cSBarry Smith . ksp - the nonlinear solver context 2121d763cef2SBarry Smith 2122d763cef2SBarry Smith Notes: 212394b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2124d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2125d763cef2SBarry Smith KSP and PC contexts as well. 2126d763cef2SBarry Smith 212794b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 21280298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2129d763cef2SBarry Smith 2130d763cef2SBarry Smith Level: beginner 2131d763cef2SBarry Smith 213294b7f48cSBarry Smith .keywords: timestep, get, KSP 2133d763cef2SBarry Smith @*/ 21347087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2135d763cef2SBarry Smith { 2136d372ba47SLisandro Dalcin PetscErrorCode ierr; 2137089b2837SJed Brown SNES snes; 2138d372ba47SLisandro Dalcin 2139d763cef2SBarry Smith PetscFunctionBegin; 21400700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21414482741eSBarry Smith PetscValidPointer(ksp,2); 214217186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2143e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2144089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2145089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2146d763cef2SBarry Smith PetscFunctionReturn(0); 2147d763cef2SBarry Smith } 2148d763cef2SBarry Smith 2149d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2150d763cef2SBarry Smith 21514a2ae208SSatish Balay #undef __FUNCT__ 2152adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 2153adb62b0dSMatthew Knepley /*@ 2154adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2155adb62b0dSMatthew Knepley maximum time for iteration. 2156adb62b0dSMatthew Knepley 21573f9fe445SBarry Smith Not Collective 2158adb62b0dSMatthew Knepley 2159adb62b0dSMatthew Knepley Input Parameters: 2160adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 21610298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 21620298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2163adb62b0dSMatthew Knepley 2164adb62b0dSMatthew Knepley Level: intermediate 2165adb62b0dSMatthew Knepley 2166adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2167adb62b0dSMatthew Knepley @*/ 21687087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2169adb62b0dSMatthew Knepley { 2170adb62b0dSMatthew Knepley PetscFunctionBegin; 21710700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2172abc0a331SBarry Smith if (maxsteps) { 21734482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2174adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2175adb62b0dSMatthew Knepley } 2176abc0a331SBarry Smith if (maxtime) { 21774482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2178adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2179adb62b0dSMatthew Knepley } 2180adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2181adb62b0dSMatthew Knepley } 2182adb62b0dSMatthew Knepley 2183adb62b0dSMatthew Knepley #undef __FUNCT__ 21844a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 2185d763cef2SBarry Smith /*@ 2186d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2187d763cef2SBarry Smith maximum time for iteration. 2188d763cef2SBarry Smith 21893f9fe445SBarry Smith Logically Collective on TS 2190d763cef2SBarry Smith 2191d763cef2SBarry Smith Input Parameters: 2192d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2193d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2194d763cef2SBarry Smith - maxtime - final time to iterate to 2195d763cef2SBarry Smith 2196d763cef2SBarry Smith Options Database Keys: 2197d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 21983bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2199d763cef2SBarry Smith 2200d763cef2SBarry Smith Notes: 2201d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2202d763cef2SBarry Smith 2203d763cef2SBarry Smith Level: intermediate 2204d763cef2SBarry Smith 2205d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2206a43b19c4SJed Brown 2207a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2208d763cef2SBarry Smith @*/ 22097087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2210d763cef2SBarry Smith { 2211d763cef2SBarry Smith PetscFunctionBegin; 22120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2213c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2214c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 221539b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 221639b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2217d763cef2SBarry Smith PetscFunctionReturn(0); 2218d763cef2SBarry Smith } 2219d763cef2SBarry Smith 22204a2ae208SSatish Balay #undef __FUNCT__ 22214a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 2222d763cef2SBarry Smith /*@ 2223d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2224d763cef2SBarry Smith for use by the TS routines. 2225d763cef2SBarry Smith 22263f9fe445SBarry Smith Logically Collective on TS and Vec 2227d763cef2SBarry Smith 2228d763cef2SBarry Smith Input Parameters: 2229d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 22300910c330SBarry Smith - u - the solution vector 2231d763cef2SBarry Smith 2232d763cef2SBarry Smith Level: beginner 2233d763cef2SBarry Smith 2234d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2235d763cef2SBarry Smith @*/ 22360910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2237d763cef2SBarry Smith { 22388737fe31SLisandro Dalcin PetscErrorCode ierr; 2239496e6a7aSJed Brown DM dm; 22408737fe31SLisandro Dalcin 2241d763cef2SBarry Smith PetscFunctionBegin; 22420700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22430910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 22440910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 22456bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2246bbd56ea5SKarl Rupp 22470910c330SBarry Smith ts->vec_sol = u; 2248bbd56ea5SKarl Rupp 2249496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 22500910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2251d763cef2SBarry Smith PetscFunctionReturn(0); 2252d763cef2SBarry Smith } 2253d763cef2SBarry Smith 2254e74ef692SMatthew Knepley #undef __FUNCT__ 225573b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps" 225673b18844SBarry Smith /*@ 225773b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 225873b18844SBarry Smith 225973b18844SBarry Smith Logically Collective on TS 226073b18844SBarry Smith 226173b18844SBarry Smith Input Parameters: 226273b18844SBarry Smith + ts - the TS context obtained from TSCreate() 226373b18844SBarry Smith . steps - number of steps to use 226473b18844SBarry Smith 226573b18844SBarry Smith Level: intermediate 226673b18844SBarry Smith 226773b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 226873b18844SBarry Smith so as to integrate back to less than the original timestep 226973b18844SBarry Smith 227073b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 227173b18844SBarry Smith 227273b18844SBarry Smith .seealso: TSSetExactFinalTime() 227373b18844SBarry Smith @*/ 227473b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 227573b18844SBarry Smith { 227673b18844SBarry Smith PetscFunctionBegin; 227773b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 227873b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 227973b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 228073b18844SBarry 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"); 228173b18844SBarry Smith ts->adjoint_max_steps = steps; 228273b18844SBarry Smith PetscFunctionReturn(0); 228373b18844SBarry Smith } 228473b18844SBarry Smith 228573b18844SBarry Smith #undef __FUNCT__ 22860cf82b59SBarry Smith #define __FUNCT__ "TSAdjointSetCostGradients" 2287c235aa8dSHong Zhang /*@ 22880cf82b59SBarry Smith TSAdjointSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters 22890cf82b59SBarry Smith for use by the TSAdjoint routines. 2290c235aa8dSHong Zhang 2291c235aa8dSHong Zhang Logically Collective on TS and Vec 2292c235aa8dSHong Zhang 2293c235aa8dSHong Zhang Input Parameters: 2294c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2295abc2977eSBarry 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 2296abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2297c235aa8dSHong Zhang 2298c235aa8dSHong Zhang Level: beginner 2299c235aa8dSHong Zhang 2300abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 23010cf82b59SBarry Smith 2302c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2303c235aa8dSHong Zhang @*/ 2304abc2977eSBarry Smith PetscErrorCode TSAdjointSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2305c235aa8dSHong Zhang { 2306c235aa8dSHong Zhang PetscFunctionBegin; 2307c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2308abc2977eSBarry Smith PetscValidPointer(lambda,2); 2309abc2977eSBarry Smith ts->vecs_sensi = lambda; 2310abc2977eSBarry Smith ts->vecs_sensip = mu; 2311abc2977eSBarry Smith ts->numcost = numcost; 2312ad8e2604SHong Zhang PetscFunctionReturn(0); 2313ad8e2604SHong Zhang } 2314ad8e2604SHong Zhang 2315ad8e2604SHong Zhang #undef __FUNCT__ 23165bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian" 2317ad8e2604SHong Zhang /*@C 23180cf82b59SBarry 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. 2319ad8e2604SHong Zhang 2320ad8e2604SHong Zhang Logically Collective on TS 2321ad8e2604SHong Zhang 2322ad8e2604SHong Zhang Input Parameters: 2323ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2324ad8e2604SHong Zhang - func - The function 2325ad8e2604SHong Zhang 2326ad8e2604SHong Zhang Calling sequence of func: 23270cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 232805755b9cSHong Zhang + t - current timestep 23290cf82b59SBarry Smith . y - input vector (current ODE solution) 233005755b9cSHong Zhang . A - output matrix 233105755b9cSHong Zhang - ctx - [optional] user-defined function context 2332ad8e2604SHong Zhang 2333ad8e2604SHong Zhang Level: intermediate 2334ad8e2604SHong Zhang 23350cf82b59SBarry 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 23360cf82b59SBarry Smith 2337ad8e2604SHong Zhang .keywords: TS, sensitivity 2338ad8e2604SHong Zhang .seealso: 2339ad8e2604SHong Zhang @*/ 23405bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2341ad8e2604SHong Zhang { 2342ad8e2604SHong Zhang PetscErrorCode ierr; 2343ad8e2604SHong Zhang 2344ad8e2604SHong Zhang PetscFunctionBegin; 2345ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2346ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2347ad8e2604SHong Zhang 2348ad8e2604SHong Zhang ts->rhsjacobianp = func; 2349ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 2350ad8e2604SHong Zhang if(Amat) { 2351ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2352ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2353ad8e2604SHong Zhang ts->Jacp = Amat; 2354ad8e2604SHong Zhang } 2355ad8e2604SHong Zhang PetscFunctionReturn(0); 2356ad8e2604SHong Zhang } 2357ad8e2604SHong Zhang 2358ad8e2604SHong Zhang #undef __FUNCT__ 23595bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian" 23600cf82b59SBarry Smith /*@C 23615bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 2362ad8e2604SHong Zhang 2363ad8e2604SHong Zhang Collective on TS 2364ad8e2604SHong Zhang 2365ad8e2604SHong Zhang Input Parameters: 2366ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 2367ad8e2604SHong Zhang 2368ad8e2604SHong Zhang Level: developer 2369ad8e2604SHong Zhang 2370ad8e2604SHong Zhang .keywords: TS, sensitivity 23715bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 2372ad8e2604SHong Zhang @*/ 23735bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 2374ad8e2604SHong Zhang { 2375ad8e2604SHong Zhang PetscErrorCode ierr; 2376ad8e2604SHong Zhang 2377ad8e2604SHong Zhang PetscFunctionBegin; 2378ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2379ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 2380ad8e2604SHong Zhang PetscValidPointer(Amat,4); 2381ad8e2604SHong Zhang 2382ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 2383ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 2384ad8e2604SHong Zhang PetscStackPop; 2385c235aa8dSHong Zhang PetscFunctionReturn(0); 2386c235aa8dSHong Zhang } 2387c235aa8dSHong Zhang 2388c235aa8dSHong Zhang #undef __FUNCT__ 2389d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetCostIntegrand" 23906fd0887fSHong Zhang /*@C 23910cf82b59SBarry Smith TSAdjointSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 23926fd0887fSHong Zhang 23936fd0887fSHong Zhang Logically Collective on TS 23946fd0887fSHong Zhang 23956fd0887fSHong Zhang Input Parameters: 23966fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 2397abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 23980cf82b59SBarry Smith . rf - routine for evaluating the integrand function 2399b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 2400b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 2401b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 24026fd0887fSHong Zhang 24030cf82b59SBarry Smith Calling sequence of rf: 24040cf82b59SBarry Smith $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 24056fd0887fSHong Zhang 24066fd0887fSHong Zhang + t - current timestep 24070cf82b59SBarry Smith . y - input vector 24080cf82b59SBarry Smith . f - function result; one vector entry for each cost function 24096fd0887fSHong Zhang - ctx - [optional] user-defined function context 24106fd0887fSHong Zhang 2411b612ec54SBarry Smith Calling sequence of drdyf: 24120cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 2413b612ec54SBarry Smith 2414b612ec54SBarry Smith Calling sequence of drdpf: 24150cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 2416b612ec54SBarry Smith 2417b612ec54SBarry Smith Level: intermediate 24186fd0887fSHong Zhang 2419abc2977eSBarry Smith Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 24200cf82b59SBarry Smith 24216fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 24226fd0887fSHong Zhang 24230cf82b59SBarry Smith .seealso: TSAdjointSetRHSJacobian(),TSAdjointGetCostGradients(), TSAdjointSetCostGradients() 24246fd0887fSHong Zhang @*/ 2425abc2977eSBarry Smith PetscErrorCode TSAdjointSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 2426*d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 2427*d8151eeaSBarry Smith PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx) 24286fd0887fSHong Zhang { 24296fd0887fSHong Zhang PetscErrorCode ierr; 24306fd0887fSHong Zhang 24316fd0887fSHong Zhang PetscFunctionBegin; 24326fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2433abc2977eSBarry Smith if (!ts->numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSAdjointSetCostGradients() first so that the number of cost functions can be determined."); 2434abc2977eSBarry Smith if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSAdjointSetCostIntegrand()) is inconsistent with the one set by TSAdjointSetCostGradients()"); 24356fd0887fSHong Zhang 2436abc2977eSBarry Smith ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 24372c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 24380cf82b59SBarry Smith ts->costintegrand = rf; 243905755b9cSHong Zhang ts->costintegrandctx = ctx; 2440b612ec54SBarry Smith ts->drdyfunction = drdyf; 2441b612ec54SBarry Smith ts->drdpfunction = drdpf; 24426fd0887fSHong Zhang PetscFunctionReturn(0); 24436fd0887fSHong Zhang } 24446fd0887fSHong Zhang 24456fd0887fSHong Zhang #undef __FUNCT__ 24462c39e106SBarry Smith #define __FUNCT__ "TSAdjointGetCostIntegral" 244736eaed60SHong Zhang /*@ 24482c39e106SBarry Smith TSAdjointGetCostIntegral - Returns the values of the integral term in the cost functions. 244936eaed60SHong Zhang It is valid to call the routine after a backward run. 245036eaed60SHong Zhang 245136eaed60SHong Zhang Not Collective 245236eaed60SHong Zhang 245336eaed60SHong Zhang Input Parameter: 245436eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 245536eaed60SHong Zhang 245636eaed60SHong Zhang Output Parameter: 24572c39e106SBarry Smith . v - the vector containing the integrals for each cost function 245836eaed60SHong Zhang 245936eaed60SHong Zhang Level: intermediate 246036eaed60SHong Zhang 2461d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand() 246236eaed60SHong Zhang 246336eaed60SHong Zhang .keywords: TS, sensitivity analysis 246436eaed60SHong Zhang @*/ 24652c39e106SBarry Smith PetscErrorCode TSAdjointGetCostIntegral(TS ts,Vec *v) 246636eaed60SHong Zhang { 246736eaed60SHong Zhang PetscFunctionBegin; 246836eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 246936eaed60SHong Zhang PetscValidPointer(v,2); 24702c39e106SBarry Smith *v = ts->vec_costintegral; 247136eaed60SHong Zhang PetscFunctionReturn(0); 247236eaed60SHong Zhang } 247336eaed60SHong Zhang 247436eaed60SHong Zhang #undef __FUNCT__ 2475d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand" 24766fd0887fSHong Zhang /*@ 24772c39e106SBarry Smith TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 24786fd0887fSHong Zhang 24796fd0887fSHong Zhang Input Parameters: 24806fd0887fSHong Zhang + ts - the TS context 24816fd0887fSHong Zhang . t - current time 24820cf82b59SBarry Smith - y - state vector, i.e. current solution 24836fd0887fSHong Zhang 24846fd0887fSHong Zhang Output Parameter: 2485abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 24866fd0887fSHong Zhang 24876fd0887fSHong Zhang Note: 24886fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 24896fd0887fSHong Zhang is used internally within the sensitivity analysis context. 24906fd0887fSHong Zhang 24916fd0887fSHong Zhang Level: developer 24926fd0887fSHong Zhang 24936fd0887fSHong Zhang .keywords: TS, compute 24946fd0887fSHong Zhang 2495d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand() 24966fd0887fSHong Zhang @*/ 24970cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 24986fd0887fSHong Zhang { 24996fd0887fSHong Zhang PetscErrorCode ierr; 25006fd0887fSHong Zhang 25016fd0887fSHong Zhang PetscFunctionBegin; 25026fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25030cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 25046fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 25056fd0887fSHong Zhang 25060cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 2507e4680132SHong Zhang if (ts->costintegrand) { 2508e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 25090cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 25106fd0887fSHong Zhang PetscStackPop; 25116fd0887fSHong Zhang } else { 25126fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 25136fd0887fSHong Zhang } 25146fd0887fSHong Zhang 25150cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 25166fd0887fSHong Zhang PetscFunctionReturn(0); 25176fd0887fSHong Zhang } 25186fd0887fSHong Zhang 25196fd0887fSHong Zhang #undef __FUNCT__ 2520d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction" 252105755b9cSHong Zhang /*@ 2522d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 252305755b9cSHong Zhang 252405755b9cSHong Zhang Collective on TS 252505755b9cSHong Zhang 252605755b9cSHong Zhang Input Parameters: 252705755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 252805755b9cSHong Zhang 252905755b9cSHong Zhang Notes: 2530d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 253105755b9cSHong Zhang so most users would not generally call this routine themselves. 253205755b9cSHong Zhang 253305755b9cSHong Zhang Level: developer 253405755b9cSHong Zhang 253505755b9cSHong Zhang .keywords: TS, sensitivity 2536d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 253705755b9cSHong Zhang @*/ 25380cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 253905755b9cSHong Zhang { 254005755b9cSHong Zhang PetscErrorCode ierr; 254105755b9cSHong Zhang 254205755b9cSHong Zhang PetscFunctionBegin; 254305755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25440cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 254505755b9cSHong Zhang 254605755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 25470cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 254805755b9cSHong Zhang PetscStackPop; 254905755b9cSHong Zhang PetscFunctionReturn(0); 255005755b9cSHong Zhang } 255105755b9cSHong Zhang 255205755b9cSHong Zhang #undef __FUNCT__ 2553d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction" 255405755b9cSHong Zhang /*@ 2555d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 255605755b9cSHong Zhang 255705755b9cSHong Zhang Collective on TS 255805755b9cSHong Zhang 255905755b9cSHong Zhang Input Parameters: 256005755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 256105755b9cSHong Zhang 256205755b9cSHong Zhang Notes: 256305755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 256405755b9cSHong Zhang so most users would not generally call this routine themselves. 256505755b9cSHong Zhang 256605755b9cSHong Zhang Level: developer 256705755b9cSHong Zhang 256805755b9cSHong Zhang .keywords: TS, sensitivity 2569d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 257005755b9cSHong Zhang @*/ 25710cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 257205755b9cSHong Zhang { 257305755b9cSHong Zhang PetscErrorCode ierr; 257405755b9cSHong Zhang 257505755b9cSHong Zhang PetscFunctionBegin; 257605755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25770cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 257805755b9cSHong Zhang 257905755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 25800cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 258105755b9cSHong Zhang PetscStackPop; 258205755b9cSHong Zhang PetscFunctionReturn(0); 258305755b9cSHong Zhang } 258405755b9cSHong Zhang 258505755b9cSHong Zhang #undef __FUNCT__ 2586e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 2587ac226902SBarry Smith /*@C 2588000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 25893f2090d5SJed Brown called once at the beginning of each time step. 2590000e7ae3SMatthew Knepley 25913f9fe445SBarry Smith Logically Collective on TS 2592000e7ae3SMatthew Knepley 2593000e7ae3SMatthew Knepley Input Parameters: 2594000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2595000e7ae3SMatthew Knepley - func - The function 2596000e7ae3SMatthew Knepley 2597000e7ae3SMatthew Knepley Calling sequence of func: 2598000e7ae3SMatthew Knepley . func (TS ts); 2599000e7ae3SMatthew Knepley 2600000e7ae3SMatthew Knepley Level: intermediate 2601000e7ae3SMatthew Knepley 2602b8123daeSJed Brown Note: 2603b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 2604b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 2605b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 2606b8123daeSJed Brown 2607000e7ae3SMatthew Knepley .keywords: TS, timestep 26089be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 2609000e7ae3SMatthew Knepley @*/ 26107087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2611000e7ae3SMatthew Knepley { 2612000e7ae3SMatthew Knepley PetscFunctionBegin; 26130700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2614ae60f76fSBarry Smith ts->prestep = func; 2615000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2616000e7ae3SMatthew Knepley } 2617000e7ae3SMatthew Knepley 2618e74ef692SMatthew Knepley #undef __FUNCT__ 26193f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 262009ee8438SJed Brown /*@ 26213f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 26223f2090d5SJed Brown 26233f2090d5SJed Brown Collective on TS 26243f2090d5SJed Brown 26253f2090d5SJed Brown Input Parameters: 26263f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 26273f2090d5SJed Brown 26283f2090d5SJed Brown Notes: 26293f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 26303f2090d5SJed Brown so most users would not generally call this routine themselves. 26313f2090d5SJed Brown 26323f2090d5SJed Brown Level: developer 26333f2090d5SJed Brown 26343f2090d5SJed Brown .keywords: TS, timestep 26359be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 26363f2090d5SJed Brown @*/ 26377087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 26383f2090d5SJed Brown { 26393f2090d5SJed Brown PetscErrorCode ierr; 26403f2090d5SJed Brown 26413f2090d5SJed Brown PetscFunctionBegin; 26420700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2643ae60f76fSBarry Smith if (ts->prestep) { 2644ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 2645312ce896SJed Brown } 26463f2090d5SJed Brown PetscFunctionReturn(0); 26473f2090d5SJed Brown } 26483f2090d5SJed Brown 26493f2090d5SJed Brown #undef __FUNCT__ 2650b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 2651b8123daeSJed Brown /*@C 2652b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 2653b8123daeSJed Brown called once at the beginning of each stage. 2654b8123daeSJed Brown 2655b8123daeSJed Brown Logically Collective on TS 2656b8123daeSJed Brown 2657b8123daeSJed Brown Input Parameters: 2658b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 2659b8123daeSJed Brown - func - The function 2660b8123daeSJed Brown 2661b8123daeSJed Brown Calling sequence of func: 2662b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 2663b8123daeSJed Brown 2664b8123daeSJed Brown Level: intermediate 2665b8123daeSJed Brown 2666b8123daeSJed Brown Note: 2667b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2668b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2669b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2670b8123daeSJed Brown 2671b8123daeSJed Brown .keywords: TS, timestep 26729be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2673b8123daeSJed Brown @*/ 2674b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2675b8123daeSJed Brown { 2676b8123daeSJed Brown PetscFunctionBegin; 2677b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2678ae60f76fSBarry Smith ts->prestage = func; 2679b8123daeSJed Brown PetscFunctionReturn(0); 2680b8123daeSJed Brown } 2681b8123daeSJed Brown 2682b8123daeSJed Brown #undef __FUNCT__ 26839be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage" 26849be3e283SDebojyoti Ghosh /*@C 26859be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 26869be3e283SDebojyoti Ghosh called once at the end of each stage. 26879be3e283SDebojyoti Ghosh 26889be3e283SDebojyoti Ghosh Logically Collective on TS 26899be3e283SDebojyoti Ghosh 26909be3e283SDebojyoti Ghosh Input Parameters: 26919be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 26929be3e283SDebojyoti Ghosh - func - The function 26939be3e283SDebojyoti Ghosh 26949be3e283SDebojyoti Ghosh Calling sequence of func: 26959be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 26969be3e283SDebojyoti Ghosh 26979be3e283SDebojyoti Ghosh Level: intermediate 26989be3e283SDebojyoti Ghosh 26999be3e283SDebojyoti Ghosh Note: 27009be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 27019be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 27029be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 27039be3e283SDebojyoti Ghosh 27049be3e283SDebojyoti Ghosh .keywords: TS, timestep 27059be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 27069be3e283SDebojyoti Ghosh @*/ 27079be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 27089be3e283SDebojyoti Ghosh { 27099be3e283SDebojyoti Ghosh PetscFunctionBegin; 27109be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 27119be3e283SDebojyoti Ghosh ts->poststage = func; 27129be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 27139be3e283SDebojyoti Ghosh } 27149be3e283SDebojyoti Ghosh 27159be3e283SDebojyoti Ghosh #undef __FUNCT__ 2716b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 2717b8123daeSJed Brown /*@ 2718b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2719b8123daeSJed Brown 2720b8123daeSJed Brown Collective on TS 2721b8123daeSJed Brown 2722b8123daeSJed Brown Input Parameters: 2723b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 27249be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 2725b8123daeSJed Brown 2726b8123daeSJed Brown Notes: 2727b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 2728b8123daeSJed Brown most users would not generally call this routine themselves. 2729b8123daeSJed Brown 2730b8123daeSJed Brown Level: developer 2731b8123daeSJed Brown 2732b8123daeSJed Brown .keywords: TS, timestep 27339be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 2734b8123daeSJed Brown @*/ 2735b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2736b8123daeSJed Brown { 2737b8123daeSJed Brown PetscErrorCode ierr; 2738b8123daeSJed Brown 2739b8123daeSJed Brown PetscFunctionBegin; 2740b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2741ae60f76fSBarry Smith if (ts->prestage) { 2742ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2743b8123daeSJed Brown } 2744b8123daeSJed Brown PetscFunctionReturn(0); 2745b8123daeSJed Brown } 2746b8123daeSJed Brown 2747b8123daeSJed Brown #undef __FUNCT__ 27489be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage" 27499be3e283SDebojyoti Ghosh /*@ 27509be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 27519be3e283SDebojyoti Ghosh 27529be3e283SDebojyoti Ghosh Collective on TS 27539be3e283SDebojyoti Ghosh 27549be3e283SDebojyoti Ghosh Input Parameters: 27559be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 27569be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 27579be3e283SDebojyoti Ghosh stageindex - Stage number 27589be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 27599be3e283SDebojyoti Ghosh of stages) with the stage solutions 27609be3e283SDebojyoti Ghosh 27619be3e283SDebojyoti Ghosh Notes: 27629be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 27639be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 27649be3e283SDebojyoti Ghosh 27659be3e283SDebojyoti Ghosh Level: developer 27669be3e283SDebojyoti Ghosh 27679be3e283SDebojyoti Ghosh .keywords: TS, timestep 27689be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 27699be3e283SDebojyoti Ghosh @*/ 27709be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 27719be3e283SDebojyoti Ghosh { 27729be3e283SDebojyoti Ghosh PetscErrorCode ierr; 27739be3e283SDebojyoti Ghosh 27749be3e283SDebojyoti Ghosh PetscFunctionBegin; 27759be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27764beae5d8SLisandro Dalcin if (ts->poststage) { 27779be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 27789be3e283SDebojyoti Ghosh } 27799be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 27809be3e283SDebojyoti Ghosh } 27819be3e283SDebojyoti Ghosh 27829be3e283SDebojyoti Ghosh #undef __FUNCT__ 2783e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 2784ac226902SBarry Smith /*@C 2785000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 27863f2090d5SJed Brown called once at the end of each time step. 2787000e7ae3SMatthew Knepley 27883f9fe445SBarry Smith Logically Collective on TS 2789000e7ae3SMatthew Knepley 2790000e7ae3SMatthew Knepley Input Parameters: 2791000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2792000e7ae3SMatthew Knepley - func - The function 2793000e7ae3SMatthew Knepley 2794000e7ae3SMatthew Knepley Calling sequence of func: 2795b8123daeSJed Brown $ func (TS ts); 2796000e7ae3SMatthew Knepley 2797000e7ae3SMatthew Knepley Level: intermediate 2798000e7ae3SMatthew Knepley 2799000e7ae3SMatthew Knepley .keywords: TS, timestep 2800b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2801000e7ae3SMatthew Knepley @*/ 28027087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2803000e7ae3SMatthew Knepley { 2804000e7ae3SMatthew Knepley PetscFunctionBegin; 28050700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2806ae60f76fSBarry Smith ts->poststep = func; 2807000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2808000e7ae3SMatthew Knepley } 2809000e7ae3SMatthew Knepley 2810e74ef692SMatthew Knepley #undef __FUNCT__ 28113f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 281209ee8438SJed Brown /*@ 28133f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 28143f2090d5SJed Brown 28153f2090d5SJed Brown Collective on TS 28163f2090d5SJed Brown 28173f2090d5SJed Brown Input Parameters: 28183f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 28193f2090d5SJed Brown 28203f2090d5SJed Brown Notes: 28213f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 28223f2090d5SJed Brown so most users would not generally call this routine themselves. 28233f2090d5SJed Brown 28243f2090d5SJed Brown Level: developer 28253f2090d5SJed Brown 28263f2090d5SJed Brown .keywords: TS, timestep 28273f2090d5SJed Brown @*/ 28287087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 28293f2090d5SJed Brown { 28303f2090d5SJed Brown PetscErrorCode ierr; 28313f2090d5SJed Brown 28323f2090d5SJed Brown PetscFunctionBegin; 28330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2834ae60f76fSBarry Smith if (ts->poststep) { 2835ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 283672ac3e02SJed Brown } 28373f2090d5SJed Brown PetscFunctionReturn(0); 28383f2090d5SJed Brown } 28393f2090d5SJed Brown 2840d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2841d763cef2SBarry Smith 28424a2ae208SSatish Balay #undef __FUNCT__ 2843a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2844d763cef2SBarry Smith /*@C 2845a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2846d763cef2SBarry Smith timestep to display the iteration's progress. 2847d763cef2SBarry Smith 28483f9fe445SBarry Smith Logically Collective on TS 2849d763cef2SBarry Smith 2850d763cef2SBarry Smith Input Parameters: 2851d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2852e213d8f1SJed Brown . monitor - monitoring routine 2853329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 28540298fd71SBarry Smith monitor routine (use NULL if no context is desired) 2855b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 28560298fd71SBarry Smith (may be NULL) 2857d763cef2SBarry Smith 2858e213d8f1SJed Brown Calling sequence of monitor: 28590910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2860d763cef2SBarry Smith 2861d763cef2SBarry Smith + ts - the TS context 286288c05cc5SBarry 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 286388c05cc5SBarry Smith been interpolated to) 28641f06c33eSBarry Smith . time - current time 28650910c330SBarry Smith . u - current iterate 2866d763cef2SBarry Smith - mctx - [optional] monitoring context 2867d763cef2SBarry Smith 2868d763cef2SBarry Smith Notes: 2869d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2870d763cef2SBarry Smith already has been loaded. 2871d763cef2SBarry Smith 2872025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2873025f1a04SBarry Smith 2874d763cef2SBarry Smith Level: intermediate 2875d763cef2SBarry Smith 2876d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2877d763cef2SBarry Smith 2878a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2879d763cef2SBarry Smith @*/ 2880c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2881d763cef2SBarry Smith { 2882d763cef2SBarry Smith PetscFunctionBegin; 28830700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 288417186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2885d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 28868704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2887d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2888d763cef2SBarry Smith PetscFunctionReturn(0); 2889d763cef2SBarry Smith } 2890d763cef2SBarry Smith 28914a2ae208SSatish Balay #undef __FUNCT__ 2892a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2893d763cef2SBarry Smith /*@C 2894a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2895d763cef2SBarry Smith 28963f9fe445SBarry Smith Logically Collective on TS 2897d763cef2SBarry Smith 2898d763cef2SBarry Smith Input Parameters: 2899d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2900d763cef2SBarry Smith 2901d763cef2SBarry Smith Notes: 2902d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2903d763cef2SBarry Smith 2904d763cef2SBarry Smith Level: intermediate 2905d763cef2SBarry Smith 2906d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2907d763cef2SBarry Smith 2908a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2909d763cef2SBarry Smith @*/ 29107087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2911d763cef2SBarry Smith { 2912d952e501SBarry Smith PetscErrorCode ierr; 2913d952e501SBarry Smith PetscInt i; 2914d952e501SBarry Smith 2915d763cef2SBarry Smith PetscFunctionBegin; 29160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2917d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 29188704b422SBarry Smith if (ts->monitordestroy[i]) { 29198704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2920d952e501SBarry Smith } 2921d952e501SBarry Smith } 2922d763cef2SBarry Smith ts->numbermonitors = 0; 2923d763cef2SBarry Smith PetscFunctionReturn(0); 2924d763cef2SBarry Smith } 2925d763cef2SBarry Smith 29264a2ae208SSatish Balay #undef __FUNCT__ 2927a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2928d8e5e3e6SSatish Balay /*@ 2929a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 29305516499fSSatish Balay 29315516499fSSatish Balay Level: intermediate 293241251cbbSSatish Balay 29335516499fSSatish Balay .keywords: TS, set, monitor 29345516499fSSatish Balay 293541251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 293641251cbbSSatish Balay @*/ 2937649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2938d763cef2SBarry Smith { 2939dfbe8321SBarry Smith PetscErrorCode ierr; 2940ce94432eSBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 2941d132466eSBarry Smith 2942d763cef2SBarry Smith PetscFunctionBegin; 2943649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2944971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2945649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2946d763cef2SBarry Smith PetscFunctionReturn(0); 2947d763cef2SBarry Smith } 2948d763cef2SBarry Smith 29494a2ae208SSatish Balay #undef __FUNCT__ 2950cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 2951cd652676SJed Brown /*@ 2952cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2953cd652676SJed Brown 2954cd652676SJed Brown Logically Collective on TS 2955cd652676SJed Brown 2956cd652676SJed Brown Input Argument: 2957cd652676SJed Brown . ts - time stepping context 2958cd652676SJed Brown 2959cd652676SJed Brown Output Argument: 2960cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 2961cd652676SJed Brown 2962cd652676SJed Brown Level: intermediate 2963cd652676SJed Brown 2964cd652676SJed Brown .keywords: TS, set 2965cd652676SJed Brown 2966cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 2967cd652676SJed Brown @*/ 2968cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2969cd652676SJed Brown { 2970cd652676SJed Brown PetscFunctionBegin; 2971cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2972cd652676SJed Brown ts->retain_stages = flg; 2973cd652676SJed Brown PetscFunctionReturn(0); 2974cd652676SJed Brown } 2975cd652676SJed Brown 2976cd652676SJed Brown #undef __FUNCT__ 2977cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 2978cd652676SJed Brown /*@ 2979cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2980cd652676SJed Brown 2981cd652676SJed Brown Collective on TS 2982cd652676SJed Brown 2983cd652676SJed Brown Input Argument: 2984cd652676SJed Brown + ts - time stepping context 2985cd652676SJed Brown - t - time to interpolate to 2986cd652676SJed Brown 2987cd652676SJed Brown Output Argument: 29880910c330SBarry Smith . U - state at given time 2989cd652676SJed Brown 2990cd652676SJed Brown Notes: 2991cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2992cd652676SJed Brown 2993cd652676SJed Brown Level: intermediate 2994cd652676SJed Brown 2995cd652676SJed Brown Developer Notes: 2996cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2997cd652676SJed Brown 2998cd652676SJed Brown .keywords: TS, set 2999cd652676SJed Brown 3000cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 3001cd652676SJed Brown @*/ 30020910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3003cd652676SJed Brown { 3004cd652676SJed Brown PetscErrorCode ierr; 3005cd652676SJed Brown 3006cd652676SJed Brown PetscFunctionBegin; 3007cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3008b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 30096712e2f1SBarry 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); 3010ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 30110910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3012cd652676SJed Brown PetscFunctionReturn(0); 3013cd652676SJed Brown } 3014cd652676SJed Brown 3015cd652676SJed Brown #undef __FUNCT__ 30164a2ae208SSatish Balay #define __FUNCT__ "TSStep" 3017d763cef2SBarry Smith /*@ 30186d9e5789SSean Farley TSStep - Steps one time step 3019d763cef2SBarry Smith 3020d763cef2SBarry Smith Collective on TS 3021d763cef2SBarry Smith 3022d763cef2SBarry Smith Input Parameter: 3023d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3024d763cef2SBarry Smith 302527829d71SBarry Smith Level: developer 3026d763cef2SBarry Smith 3027b8123daeSJed Brown Notes: 302827829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 302927829d71SBarry Smith 3030b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3031b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3032b8123daeSJed Brown 303325cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 303425cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 303525cb2221SBarry Smith 3036d763cef2SBarry Smith .keywords: TS, timestep, solve 3037d763cef2SBarry Smith 30389be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3039d763cef2SBarry Smith @*/ 3040193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3041d763cef2SBarry Smith { 30422fb8446cSMatthew G. Knepley DM dm; 3043dfbe8321SBarry Smith PetscErrorCode ierr; 3044fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3045d763cef2SBarry Smith 3046d763cef2SBarry Smith PetscFunctionBegin; 30470700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3048fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3049fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3050fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3051fffbeea8SBarry Smith " type = {Preprint},\n" 3052fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3053fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3054fffbeea8SBarry Smith " year = {2014}\n}\n",&cite); 3055fffbeea8SBarry Smith 30562fb8446cSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 3057d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 3058d405a339SMatthew Knepley 3059362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 306024655328SShri ts->ptime_prev = ts->ptime; 3061cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3062bbd56ea5SKarl Rupp 3063e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3064d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3065193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3066d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3067bbd56ea5SKarl Rupp 306824655328SShri ts->time_step_prev = ts->ptime - ts->ptime_prev; 3069cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3070362cd11cSLisandro Dalcin 3071362cd11cSLisandro Dalcin if (ts->reason < 0) { 3072cef5090cSJed Brown if (ts->errorifstepfailed) { 307308c7845fSBarry 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]); 307408c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3075d2daff3dSHong Zhang } 307608c7845fSBarry Smith } else if (!ts->reason) { 307708c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 307808c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 307908c7845fSBarry Smith } 30802c18e0fdSBarry Smith ts->total_steps++; 308108c7845fSBarry Smith PetscFunctionReturn(0); 308208c7845fSBarry Smith } 308308c7845fSBarry Smith 308408c7845fSBarry Smith #undef __FUNCT__ 308508c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep" 308608c7845fSBarry Smith /*@ 308708c7845fSBarry Smith TSAdjointStep - Steps one time step 308808c7845fSBarry Smith 308908c7845fSBarry Smith Collective on TS 309008c7845fSBarry Smith 309108c7845fSBarry Smith Input Parameter: 309208c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 309308c7845fSBarry Smith 309408c7845fSBarry Smith Level: intermediate 309508c7845fSBarry Smith 309608c7845fSBarry Smith Notes: 309708c7845fSBarry Smith The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 309808c7845fSBarry Smith be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 309908c7845fSBarry Smith 310008c7845fSBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 310108c7845fSBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 310208c7845fSBarry Smith 310308c7845fSBarry Smith .keywords: TS, timestep, solve 310408c7845fSBarry Smith 310508c7845fSBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 310608c7845fSBarry Smith @*/ 310708c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 310808c7845fSBarry Smith { 310908c7845fSBarry Smith DM dm; 311008c7845fSBarry Smith PetscErrorCode ierr; 311108c7845fSBarry Smith 311208c7845fSBarry Smith PetscFunctionBegin; 311308c7845fSBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 311408c7845fSBarry Smith ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 311508c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 311608c7845fSBarry Smith 311708c7845fSBarry Smith ts->reason = TS_CONVERGED_ITERATING; 311808c7845fSBarry Smith ts->ptime_prev = ts->ptime; 311908c7845fSBarry Smith ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 312008c7845fSBarry Smith ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr); 312108c7845fSBarry Smith 312208c7845fSBarry Smith ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 312342f2b339SBarry 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); 312442f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 3125362cd11cSLisandro Dalcin ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3126362cd11cSLisandro Dalcin 3127cef5090cSJed Brown ts->time_step_prev = ts->ptime - ts->ptime_prev; 3128cef5090cSJed Brown ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 3129ce94432eSBarry Smith 3130ce94432eSBarry Smith if (ts->reason < 0) { 3131cef5090cSJed Brown if (ts->errorifstepfailed) { 3132362cd11cSLisandro Dalcin if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 3133db4deed7SKarl Rupp 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]); 31342a3a10ceSLisandro Dalcin } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) { 31352a3a10ceSLisandro 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]); 3136362cd11cSLisandro Dalcin } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3137362cd11cSLisandro Dalcin } 3138362cd11cSLisandro Dalcin } else if (!ts->reason) { 313973b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3140db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3141362cd11cSLisandro Dalcin } 31422c18e0fdSBarry Smith ts->total_steps--; 3143d763cef2SBarry Smith PetscFunctionReturn(0); 3144d763cef2SBarry Smith } 3145d763cef2SBarry Smith 31464a2ae208SSatish Balay #undef __FUNCT__ 314705175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 314805175c85SJed Brown /*@ 314905175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 315005175c85SJed Brown 31511c3436cfSJed Brown Collective on TS 315205175c85SJed Brown 315305175c85SJed Brown Input Arguments: 31541c3436cfSJed Brown + ts - time stepping context 31551c3436cfSJed Brown . order - desired order of accuracy 31560298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 315705175c85SJed Brown 315805175c85SJed Brown Output Arguments: 31590910c330SBarry Smith . U - state at the end of the current step 316005175c85SJed Brown 316105175c85SJed Brown Level: advanced 316205175c85SJed Brown 3163108c343cSJed Brown Notes: 3164108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3165108c343cSJed 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. 3166108c343cSJed Brown 31671c3436cfSJed Brown .seealso: TSStep(), TSAdapt 316805175c85SJed Brown @*/ 31690910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 317005175c85SJed Brown { 317105175c85SJed Brown PetscErrorCode ierr; 317205175c85SJed Brown 317305175c85SJed Brown PetscFunctionBegin; 317405175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 317505175c85SJed Brown PetscValidType(ts,1); 31760910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3177ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 31780910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 317905175c85SJed Brown PetscFunctionReturn(0); 318005175c85SJed Brown } 318105175c85SJed Brown 3182d67e68b7SBarry Smith 318305175c85SJed Brown #undef __FUNCT__ 31846a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 31856a4d4014SLisandro Dalcin /*@ 31866a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 31876a4d4014SLisandro Dalcin 31886a4d4014SLisandro Dalcin Collective on TS 31896a4d4014SLisandro Dalcin 31906a4d4014SLisandro Dalcin Input Parameter: 31916a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 3192cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 31935a3a76d0SJed Brown 31946a4d4014SLisandro Dalcin Level: beginner 31956a4d4014SLisandro Dalcin 31965a3a76d0SJed Brown Notes: 31975a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 31985a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 31995a3a76d0SJed Brown stepped over the final time. 32005a3a76d0SJed Brown 32016a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 32026a4d4014SLisandro Dalcin 32036a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 32046a4d4014SLisandro Dalcin @*/ 3205cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 32066a4d4014SLisandro Dalcin { 3207b06615a5SLisandro Dalcin Vec solution; 32086a4d4014SLisandro Dalcin PetscErrorCode ierr; 3209f22f69f0SBarry Smith 32106a4d4014SLisandro Dalcin PetscFunctionBegin; 32110700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3212f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 321349354f04SShri 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 */ 3214b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 32150910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3216b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3217b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3218b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 32195a3a76d0SJed Brown } 32200910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3221bbd56ea5SKarl Rupp } else if (u) { 32220910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 32235a3a76d0SJed Brown } 3224d2daff3dSHong Zhang ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/ 32256a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 3226193ac0bcSJed Brown ts->steps = 0; 32275ef26d82SJed Brown ts->ksp_its = 0; 32285ef26d82SJed Brown ts->snes_its = 0; 3229c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3230c610991cSLisandro Dalcin ts->reject = 0; 3231193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3232193ac0bcSJed Brown 3233ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3234f05ece33SBarry Smith 3235193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3236193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 32370910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 3238cc708dedSBarry Smith ts->solvetime = ts->ptime; 3239193ac0bcSJed Brown } else { 32406a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 3241db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3242db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3243e1a7a14fSJed Brown while (!ts->reason) { 3244b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3245bc952696SBarry Smith ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3246193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3247aeb4809dSShri Abhyankar if (ts->event) { 3248aeb4809dSShri Abhyankar ierr = TSEventMonitor(ts);CHKERRQ(ierr); 32491eda64f1SShri Abhyankar if (ts->event->status != TSEVENT_PROCESSING) { 32501eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 32511eda64f1SShri Abhyankar } 32521eda64f1SShri Abhyankar } else { 32531eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3254aeb4809dSShri Abhyankar } 3255193ac0bcSJed Brown } 325649354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 32570910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3258cc708dedSBarry Smith ts->solvetime = ts->max_time; 3259b06615a5SLisandro Dalcin solution = u; 32600574a7fbSJed Brown } else { 3261ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3262cc708dedSBarry Smith ts->solvetime = ts->ptime; 3263b06615a5SLisandro Dalcin solution = ts->vec_sol; 32640574a7fbSJed Brown } 3265bc952696SBarry Smith ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 3266b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 326727829d71SBarry Smith ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr); 3268193ac0bcSJed Brown } 3269d2daff3dSHong Zhang 3270ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 327156f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 32726a4d4014SLisandro Dalcin PetscFunctionReturn(0); 32736a4d4014SLisandro Dalcin } 32746a4d4014SLisandro Dalcin 32756a4d4014SLisandro Dalcin #undef __FUNCT__ 3276c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve" 3277c88f2d44SBarry Smith /*@ 3278c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 3279c88f2d44SBarry Smith 3280c88f2d44SBarry Smith Collective on TS 3281c88f2d44SBarry Smith 3282c88f2d44SBarry Smith Input Parameter: 32832c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 3284c88f2d44SBarry Smith 3285c88f2d44SBarry Smith Level: intermediate 3286c88f2d44SBarry Smith 3287c88f2d44SBarry Smith Notes: 3288c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 3289c88f2d44SBarry Smith 329073b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 329173b18844SBarry Smith 3292c88f2d44SBarry Smith .keywords: TS, timestep, solve 3293c88f2d44SBarry Smith 3294c88f2d44SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep() 3295c88f2d44SBarry Smith @*/ 32962c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 3297c88f2d44SBarry Smith { 3298c88f2d44SBarry Smith PetscErrorCode ierr; 3299c88f2d44SBarry Smith 3300c88f2d44SBarry Smith PetscFunctionBegin; 3301c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3302c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3303c88f2d44SBarry Smith /* reset time step and iteration counters */ 3304c88f2d44SBarry Smith ts->steps = 0; 3305c88f2d44SBarry Smith ts->ksp_its = 0; 3306c88f2d44SBarry Smith ts->snes_its = 0; 3307c88f2d44SBarry Smith ts->num_snes_failures = 0; 3308c88f2d44SBarry Smith ts->reject = 0; 3309c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 3310c88f2d44SBarry Smith 331173b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 3312c88f2d44SBarry Smith 331373b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3314c88f2d44SBarry Smith while (!ts->reason) { 331573b18844SBarry Smith ierr = TSTrajectoryGet(ts->trajectory,ts,ts->adjoint_max_steps-ts->steps,ts->ptime);CHKERRQ(ierr); 331673b18844SBarry Smith ierr = TSMonitor(ts,ts->adjoint_max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 331708c7845fSBarry Smith ierr = TSAdjointStep(ts);CHKERRQ(ierr); 3318c88f2d44SBarry Smith if (ts->event) { 3319c88f2d44SBarry Smith ierr = TSEventMonitor(ts);CHKERRQ(ierr); 3320c88f2d44SBarry Smith if (ts->event->status != TSEVENT_PROCESSING) { 3321c88f2d44SBarry Smith ierr = TSPostStep(ts);CHKERRQ(ierr); 3322c88f2d44SBarry Smith } 3323c88f2d44SBarry Smith } else { 3324c88f2d44SBarry Smith ierr = TSPostStep(ts);CHKERRQ(ierr); 3325c88f2d44SBarry Smith } 3326c88f2d44SBarry Smith } 3327c88f2d44SBarry Smith ts->solvetime = ts->ptime; 3328c88f2d44SBarry Smith PetscFunctionReturn(0); 3329c88f2d44SBarry Smith } 3330c88f2d44SBarry Smith 3331c88f2d44SBarry Smith #undef __FUNCT__ 33324a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 3333228d79bcSJed Brown /*@ 3334228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 3335228d79bcSJed Brown 3336228d79bcSJed Brown Collective on TS 3337228d79bcSJed Brown 3338228d79bcSJed Brown Input Parameters: 3339228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 3340228d79bcSJed Brown . step - step number that has just completed 3341228d79bcSJed Brown . ptime - model time of the state 33420910c330SBarry Smith - u - state at the current model time 3343228d79bcSJed Brown 3344228d79bcSJed Brown Notes: 3345228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 3346228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 3347228d79bcSJed Brown 3348228d79bcSJed Brown Level: advanced 3349228d79bcSJed Brown 3350228d79bcSJed Brown .keywords: TS, timestep 3351228d79bcSJed Brown @*/ 33520910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 3353d763cef2SBarry Smith { 33546849ba73SBarry Smith PetscErrorCode ierr; 3355a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 3356d763cef2SBarry Smith 3357d763cef2SBarry Smith PetscFunctionBegin; 3358b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3359b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 33605edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 3361d763cef2SBarry Smith for (i=0; i<n; i++) { 33620910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 3363d763cef2SBarry Smith } 33645edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 3365d763cef2SBarry Smith PetscFunctionReturn(0); 3366d763cef2SBarry Smith } 3367d763cef2SBarry Smith 3368d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 33694a2ae208SSatish Balay #undef __FUNCT__ 3370a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 3371d763cef2SBarry Smith /*@C 3372a9f9c1f6SBarry Smith TSMonitorLGCtxCreate - Creates a line graph context for use with 3373a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 3374d763cef2SBarry Smith 3375d763cef2SBarry Smith Collective on TS 3376d763cef2SBarry Smith 3377d763cef2SBarry Smith Input Parameters: 3378d763cef2SBarry Smith + host - the X display to open, or null for the local machine 3379d763cef2SBarry Smith . label - the title to put in the title bar 33807c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 3381a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 3382a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 3383d763cef2SBarry Smith 3384d763cef2SBarry Smith Output Parameter: 33850b039ecaSBarry Smith . ctx - the context 3386d763cef2SBarry Smith 3387d763cef2SBarry Smith Options Database Key: 33884f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 33894f09c107SBarry Smith . -ts_monitor_lg_solution - 339099fdda47SBarry Smith . -ts_monitor_lg_error - 339199fdda47SBarry Smith . -ts_monitor_lg_ksp_iterations - 339299fdda47SBarry Smith . -ts_monitor_lg_snes_iterations - 339399fdda47SBarry Smith - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 3394d763cef2SBarry Smith 3395d763cef2SBarry Smith Notes: 3396a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 3397d763cef2SBarry Smith 3398d763cef2SBarry Smith Level: intermediate 3399d763cef2SBarry Smith 34007c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 3401d763cef2SBarry Smith 34024f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 34037c922b88SBarry Smith 3404d763cef2SBarry Smith @*/ 3405a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 3406d763cef2SBarry Smith { 3407b0a32e0cSBarry Smith PetscDraw win; 3408dfbe8321SBarry Smith PetscErrorCode ierr; 3409d763cef2SBarry Smith 3410d763cef2SBarry Smith PetscFunctionBegin; 3411b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 3412a80ad3e0SBarry Smith ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 34133fbbecb0SBarry Smith ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 34140b039ecaSBarry Smith ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 34153bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr); 3416287de1a7SBarry Smith ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr); 3417287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 3418a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 3419d763cef2SBarry Smith PetscFunctionReturn(0); 3420d763cef2SBarry Smith } 3421d763cef2SBarry Smith 34224a2ae208SSatish Balay #undef __FUNCT__ 34234f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 3424b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 3425d763cef2SBarry Smith { 34260b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 3427c32365f1SBarry Smith PetscReal x = ptime,y; 3428dfbe8321SBarry Smith PetscErrorCode ierr; 3429d763cef2SBarry Smith 3430d763cef2SBarry Smith PetscFunctionBegin; 3431b06615a5SLisandro Dalcin if (!step) { 3432a9f9c1f6SBarry Smith PetscDrawAxis axis; 3433a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 3434a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 3435a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 3436287de1a7SBarry Smith ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr); 3437a9f9c1f6SBarry Smith } 3438c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 34390b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 3440b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 34410b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 34423923b477SBarry Smith } 3443d763cef2SBarry Smith PetscFunctionReturn(0); 3444d763cef2SBarry Smith } 3445d763cef2SBarry Smith 34464a2ae208SSatish Balay #undef __FUNCT__ 3447a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 3448d763cef2SBarry Smith /*@C 3449a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 3450a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 3451d763cef2SBarry Smith 34520b039ecaSBarry Smith Collective on TSMonitorLGCtx 3453d763cef2SBarry Smith 3454d763cef2SBarry Smith Input Parameter: 34550b039ecaSBarry Smith . ctx - the monitor context 3456d763cef2SBarry Smith 3457d763cef2SBarry Smith Level: intermediate 3458d763cef2SBarry Smith 3459d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 3460d763cef2SBarry Smith 34614f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 3462d763cef2SBarry Smith @*/ 3463a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 3464d763cef2SBarry Smith { 3465b0a32e0cSBarry Smith PetscDraw draw; 3466dfbe8321SBarry Smith PetscErrorCode ierr; 3467d763cef2SBarry Smith 3468d763cef2SBarry Smith PetscFunctionBegin; 34690b039ecaSBarry Smith ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 34706bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 34710b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 34720b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 3473d763cef2SBarry Smith PetscFunctionReturn(0); 3474d763cef2SBarry Smith } 3475d763cef2SBarry Smith 34764a2ae208SSatish Balay #undef __FUNCT__ 34774a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 3478d763cef2SBarry Smith /*@ 3479b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 3480d763cef2SBarry Smith 3481d763cef2SBarry Smith Not Collective 3482d763cef2SBarry Smith 3483d763cef2SBarry Smith Input Parameter: 3484d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3485d763cef2SBarry Smith 3486d763cef2SBarry Smith Output Parameter: 3487d763cef2SBarry Smith . t - the current time 3488d763cef2SBarry Smith 3489d763cef2SBarry Smith Level: beginner 3490d763cef2SBarry Smith 3491b8123daeSJed Brown Note: 3492b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 34939be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 3494b8123daeSJed Brown 3495d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3496d763cef2SBarry Smith 3497d763cef2SBarry Smith .keywords: TS, get, time 3498d763cef2SBarry Smith @*/ 34997087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 3500d763cef2SBarry Smith { 3501d763cef2SBarry Smith PetscFunctionBegin; 35020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3503f7cf8827SBarry Smith PetscValidRealPointer(t,2); 3504d763cef2SBarry Smith *t = ts->ptime; 3505d763cef2SBarry Smith PetscFunctionReturn(0); 3506d763cef2SBarry Smith } 3507d763cef2SBarry Smith 35084a2ae208SSatish Balay #undef __FUNCT__ 3509e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime" 3510e5e524a1SHong Zhang /*@ 3511e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 3512e5e524a1SHong Zhang 3513e5e524a1SHong Zhang Not Collective 3514e5e524a1SHong Zhang 3515e5e524a1SHong Zhang Input Parameter: 3516e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 3517e5e524a1SHong Zhang 3518e5e524a1SHong Zhang Output Parameter: 3519e5e524a1SHong Zhang . t - the previous time 3520e5e524a1SHong Zhang 3521e5e524a1SHong Zhang Level: beginner 3522e5e524a1SHong Zhang 3523e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3524e5e524a1SHong Zhang 3525e5e524a1SHong Zhang .keywords: TS, get, time 3526e5e524a1SHong Zhang @*/ 3527e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 3528e5e524a1SHong Zhang { 3529e5e524a1SHong Zhang PetscFunctionBegin; 3530e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3531e5e524a1SHong Zhang PetscValidRealPointer(t,2); 3532e5e524a1SHong Zhang *t = ts->ptime_prev; 3533e5e524a1SHong Zhang PetscFunctionReturn(0); 3534e5e524a1SHong Zhang } 3535e5e524a1SHong Zhang 3536e5e524a1SHong Zhang #undef __FUNCT__ 35376a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 35386a4d4014SLisandro Dalcin /*@ 35396a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 35406a4d4014SLisandro Dalcin 35413f9fe445SBarry Smith Logically Collective on TS 35426a4d4014SLisandro Dalcin 35436a4d4014SLisandro Dalcin Input Parameters: 35446a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 35456a4d4014SLisandro Dalcin - time - the time 35466a4d4014SLisandro Dalcin 35476a4d4014SLisandro Dalcin Level: intermediate 35486a4d4014SLisandro Dalcin 35496a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 35506a4d4014SLisandro Dalcin 35516a4d4014SLisandro Dalcin .keywords: TS, set, time 35526a4d4014SLisandro Dalcin @*/ 35537087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 35546a4d4014SLisandro Dalcin { 35556a4d4014SLisandro Dalcin PetscFunctionBegin; 35560700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3557c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 35586a4d4014SLisandro Dalcin ts->ptime = t; 35596a4d4014SLisandro Dalcin PetscFunctionReturn(0); 35606a4d4014SLisandro Dalcin } 35616a4d4014SLisandro Dalcin 35626a4d4014SLisandro Dalcin #undef __FUNCT__ 35634a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 3564d763cef2SBarry Smith /*@C 3565d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 3566d763cef2SBarry Smith TS options in the database. 3567d763cef2SBarry Smith 35683f9fe445SBarry Smith Logically Collective on TS 3569d763cef2SBarry Smith 3570d763cef2SBarry Smith Input Parameter: 3571d763cef2SBarry Smith + ts - The TS context 3572d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3573d763cef2SBarry Smith 3574d763cef2SBarry Smith Notes: 3575d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3576d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3577d763cef2SBarry Smith hyphen. 3578d763cef2SBarry Smith 3579d763cef2SBarry Smith Level: advanced 3580d763cef2SBarry Smith 3581d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 3582d763cef2SBarry Smith 3583d763cef2SBarry Smith .seealso: TSSetFromOptions() 3584d763cef2SBarry Smith 3585d763cef2SBarry Smith @*/ 35867087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 3587d763cef2SBarry Smith { 3588dfbe8321SBarry Smith PetscErrorCode ierr; 3589089b2837SJed Brown SNES snes; 3590d763cef2SBarry Smith 3591d763cef2SBarry Smith PetscFunctionBegin; 35920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3593d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3594089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3595089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3596d763cef2SBarry Smith PetscFunctionReturn(0); 3597d763cef2SBarry Smith } 3598d763cef2SBarry Smith 3599d763cef2SBarry Smith 36004a2ae208SSatish Balay #undef __FUNCT__ 36014a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 3602d763cef2SBarry Smith /*@C 3603d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 3604d763cef2SBarry Smith TS options in the database. 3605d763cef2SBarry Smith 36063f9fe445SBarry Smith Logically Collective on TS 3607d763cef2SBarry Smith 3608d763cef2SBarry Smith Input Parameter: 3609d763cef2SBarry Smith + ts - The TS context 3610d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3611d763cef2SBarry Smith 3612d763cef2SBarry Smith Notes: 3613d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3614d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3615d763cef2SBarry Smith hyphen. 3616d763cef2SBarry Smith 3617d763cef2SBarry Smith Level: advanced 3618d763cef2SBarry Smith 3619d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 3620d763cef2SBarry Smith 3621d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 3622d763cef2SBarry Smith 3623d763cef2SBarry Smith @*/ 36247087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 3625d763cef2SBarry Smith { 3626dfbe8321SBarry Smith PetscErrorCode ierr; 3627089b2837SJed Brown SNES snes; 3628d763cef2SBarry Smith 3629d763cef2SBarry Smith PetscFunctionBegin; 36300700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3631d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3632089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3633089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3634d763cef2SBarry Smith PetscFunctionReturn(0); 3635d763cef2SBarry Smith } 3636d763cef2SBarry Smith 36374a2ae208SSatish Balay #undef __FUNCT__ 36384a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 3639d763cef2SBarry Smith /*@C 3640d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 3641d763cef2SBarry Smith TS options in the database. 3642d763cef2SBarry Smith 3643d763cef2SBarry Smith Not Collective 3644d763cef2SBarry Smith 3645d763cef2SBarry Smith Input Parameter: 3646d763cef2SBarry Smith . ts - The TS context 3647d763cef2SBarry Smith 3648d763cef2SBarry Smith Output Parameter: 3649d763cef2SBarry Smith . prefix - A pointer to the prefix string used 3650d763cef2SBarry Smith 3651d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 3652d763cef2SBarry Smith sufficient length to hold the prefix. 3653d763cef2SBarry Smith 3654d763cef2SBarry Smith Level: intermediate 3655d763cef2SBarry Smith 3656d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 3657d763cef2SBarry Smith 3658d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 3659d763cef2SBarry Smith @*/ 36607087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 3661d763cef2SBarry Smith { 3662dfbe8321SBarry Smith PetscErrorCode ierr; 3663d763cef2SBarry Smith 3664d763cef2SBarry Smith PetscFunctionBegin; 36650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 36664482741eSBarry Smith PetscValidPointer(prefix,2); 3667d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3668d763cef2SBarry Smith PetscFunctionReturn(0); 3669d763cef2SBarry Smith } 3670d763cef2SBarry Smith 36714a2ae208SSatish Balay #undef __FUNCT__ 36724a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 3673d763cef2SBarry Smith /*@C 3674d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 3675d763cef2SBarry Smith 3676d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 3677d763cef2SBarry Smith 3678d763cef2SBarry Smith Input Parameter: 3679d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 3680d763cef2SBarry Smith 3681d763cef2SBarry Smith Output Parameters: 3682e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 3683e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 3684e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 3685e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 3686d763cef2SBarry Smith 36870298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 3688d763cef2SBarry Smith 3689d763cef2SBarry Smith Level: intermediate 3690d763cef2SBarry Smith 369126d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3692d763cef2SBarry Smith 3693d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 3694d763cef2SBarry Smith @*/ 3695e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 3696d763cef2SBarry Smith { 3697089b2837SJed Brown PetscErrorCode ierr; 3698089b2837SJed Brown SNES snes; 369924989b8cSPeter Brune DM dm; 3700089b2837SJed Brown 3701d763cef2SBarry Smith PetscFunctionBegin; 3702089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3703e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 370424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 370524989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 3706d763cef2SBarry Smith PetscFunctionReturn(0); 3707d763cef2SBarry Smith } 3708d763cef2SBarry Smith 37091713a123SBarry Smith #undef __FUNCT__ 37102eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 37112eca1d9cSJed Brown /*@C 37122eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 37132eca1d9cSJed Brown 37142eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 37152eca1d9cSJed Brown 37162eca1d9cSJed Brown Input Parameter: 37172eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 37182eca1d9cSJed Brown 37192eca1d9cSJed Brown Output Parameters: 3720e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 3721e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 37222eca1d9cSJed Brown . f - The function to compute the matrices 37232eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 37242eca1d9cSJed Brown 37250298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 37262eca1d9cSJed Brown 37272eca1d9cSJed Brown Level: advanced 37282eca1d9cSJed Brown 37292eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 37302eca1d9cSJed Brown 37312eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 37322eca1d9cSJed Brown @*/ 3733e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 37342eca1d9cSJed Brown { 3735089b2837SJed Brown PetscErrorCode ierr; 3736089b2837SJed Brown SNES snes; 373724989b8cSPeter Brune DM dm; 37380910c330SBarry Smith 37392eca1d9cSJed Brown PetscFunctionBegin; 3740089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3741f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 3742e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 374324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 374424989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 37452eca1d9cSJed Brown PetscFunctionReturn(0); 37462eca1d9cSJed Brown } 37472eca1d9cSJed Brown 37486083293cSBarry Smith 37492eca1d9cSJed Brown #undef __FUNCT__ 375083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 37511713a123SBarry Smith /*@C 375283a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 37531713a123SBarry Smith VecView() for the solution at each timestep 37541713a123SBarry Smith 37551713a123SBarry Smith Collective on TS 37561713a123SBarry Smith 37571713a123SBarry Smith Input Parameters: 37581713a123SBarry Smith + ts - the TS context 37591713a123SBarry Smith . step - current time-step 3760142b95e3SSatish Balay . ptime - current time 37610298fd71SBarry Smith - dummy - either a viewer or NULL 37621713a123SBarry Smith 376399fdda47SBarry Smith Options Database: 376499fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 376599fdda47SBarry Smith 376699fdda47SBarry Smith Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 376799fdda47SBarry Smith will look bad 376899fdda47SBarry Smith 37691713a123SBarry Smith Level: intermediate 37701713a123SBarry Smith 37711713a123SBarry Smith .keywords: TS, vector, monitor, view 37721713a123SBarry Smith 3773a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 37741713a123SBarry Smith @*/ 37750910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 37761713a123SBarry Smith { 3777dfbe8321SBarry Smith PetscErrorCode ierr; 377883a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3779473a3ab2SBarry Smith PetscDraw draw; 37801713a123SBarry Smith 37811713a123SBarry Smith PetscFunctionBegin; 37826083293cSBarry Smith if (!step && ictx->showinitial) { 37836083293cSBarry Smith if (!ictx->initialsolution) { 37840910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 37851713a123SBarry Smith } 37860910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 37876083293cSBarry Smith } 3788b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 37890dcf80beSBarry Smith 37906083293cSBarry Smith if (ictx->showinitial) { 37916083293cSBarry Smith PetscReal pause; 37926083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 37936083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 37946083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 37956083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 37966083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 37976083293cSBarry Smith } 37980910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 3799473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 3800473a3ab2SBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 3801473a3ab2SBarry Smith char time[32]; 3802473a3ab2SBarry Smith size_t len; 3803473a3ab2SBarry Smith 3804473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 380585b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 3806473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3807473a3ab2SBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 38080298fd71SBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3809473a3ab2SBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 3810473a3ab2SBarry Smith h = yl + .95*(yr - yl); 3811473a3ab2SBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3812473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3813473a3ab2SBarry Smith } 3814473a3ab2SBarry Smith 38156083293cSBarry Smith if (ictx->showinitial) { 38166083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 38176083293cSBarry Smith } 38181713a123SBarry Smith PetscFunctionReturn(0); 38191713a123SBarry Smith } 38201713a123SBarry Smith 38212d5ee99bSBarry Smith #undef __FUNCT__ 38222d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase" 38232d5ee99bSBarry Smith /*@C 38242d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 38252d5ee99bSBarry Smith 38262d5ee99bSBarry Smith Collective on TS 38272d5ee99bSBarry Smith 38282d5ee99bSBarry Smith Input Parameters: 38292d5ee99bSBarry Smith + ts - the TS context 38302d5ee99bSBarry Smith . step - current time-step 38312d5ee99bSBarry Smith . ptime - current time 38322d5ee99bSBarry Smith - dummy - either a viewer or NULL 38332d5ee99bSBarry Smith 38342d5ee99bSBarry Smith Level: intermediate 38352d5ee99bSBarry Smith 38362d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 38372d5ee99bSBarry Smith 38382d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 38392d5ee99bSBarry Smith @*/ 38402d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 38412d5ee99bSBarry Smith { 38422d5ee99bSBarry Smith PetscErrorCode ierr; 38432d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 38442d5ee99bSBarry Smith PetscDraw draw; 38452d5ee99bSBarry Smith MPI_Comm comm; 38462d5ee99bSBarry Smith PetscInt n; 38472d5ee99bSBarry Smith PetscMPIInt size; 38482d5ee99bSBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 38492d5ee99bSBarry Smith char time[32]; 38502d5ee99bSBarry Smith size_t len; 38512d5ee99bSBarry Smith const PetscScalar *U; 38522d5ee99bSBarry Smith 38532d5ee99bSBarry Smith PetscFunctionBegin; 38542d5ee99bSBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 38552d5ee99bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 38562d5ee99bSBarry Smith if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 38572d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 38582d5ee99bSBarry Smith if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 38592d5ee99bSBarry Smith 38602d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 38612d5ee99bSBarry Smith 38622d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 38634b363babSBarry Smith ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 3864ba5783adSMatthew G Knepley if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 3865a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3866a4494fc1SBarry Smith PetscFunctionReturn(0); 3867a4494fc1SBarry Smith } 38682d5ee99bSBarry Smith if (!step) ictx->color++; 38692d5ee99bSBarry Smith ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 38702d5ee99bSBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 38712d5ee99bSBarry Smith 38722d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 38734b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 387485b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 38752d5ee99bSBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 38762d5ee99bSBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 38772d5ee99bSBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 38782d5ee99bSBarry Smith h = yl + .95*(yr - yl); 38792d5ee99bSBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 38802d5ee99bSBarry Smith } 38812d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 38822d5ee99bSBarry Smith PetscFunctionReturn(0); 38832d5ee99bSBarry Smith } 38842d5ee99bSBarry Smith 38851713a123SBarry Smith 38866c699258SBarry Smith #undef __FUNCT__ 388783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 38886083293cSBarry Smith /*@C 388983a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 38906083293cSBarry Smith 38916083293cSBarry Smith Collective on TS 38926083293cSBarry Smith 38936083293cSBarry Smith Input Parameters: 38946083293cSBarry Smith . ctx - the monitor context 38956083293cSBarry Smith 38966083293cSBarry Smith Level: intermediate 38976083293cSBarry Smith 38986083293cSBarry Smith .keywords: TS, vector, monitor, view 38996083293cSBarry Smith 390083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 39016083293cSBarry Smith @*/ 390283a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 39036083293cSBarry Smith { 39046083293cSBarry Smith PetscErrorCode ierr; 39056083293cSBarry Smith 39066083293cSBarry Smith PetscFunctionBegin; 39074b363babSBarry Smith ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 390883a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 390983a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 391083a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 39116083293cSBarry Smith PetscFunctionReturn(0); 39126083293cSBarry Smith } 39136083293cSBarry Smith 39146083293cSBarry Smith #undef __FUNCT__ 391583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 39166083293cSBarry Smith /*@C 391783a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 39186083293cSBarry Smith 39196083293cSBarry Smith Collective on TS 39206083293cSBarry Smith 39216083293cSBarry Smith Input Parameter: 39226083293cSBarry Smith . ts - time-step context 39236083293cSBarry Smith 39246083293cSBarry Smith Output Patameter: 39256083293cSBarry Smith . ctx - the monitor context 39266083293cSBarry Smith 392799fdda47SBarry Smith Options Database: 392899fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 392999fdda47SBarry Smith 39306083293cSBarry Smith Level: intermediate 39316083293cSBarry Smith 39326083293cSBarry Smith .keywords: TS, vector, monitor, view 39336083293cSBarry Smith 393483a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 39356083293cSBarry Smith @*/ 393683a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 39376083293cSBarry Smith { 39386083293cSBarry Smith PetscErrorCode ierr; 39396083293cSBarry Smith 39406083293cSBarry Smith PetscFunctionBegin; 3941b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 394283a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 3943e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 3944bbd56ea5SKarl Rupp 394583a4ac43SBarry Smith (*ctx)->howoften = howoften; 3946473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 39470298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 3948473a3ab2SBarry Smith 3949473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 39500298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 39512d5ee99bSBarry Smith (*ctx)->color = PETSC_DRAW_WHITE; 39526083293cSBarry Smith PetscFunctionReturn(0); 39536083293cSBarry Smith } 39546083293cSBarry Smith 39556083293cSBarry Smith #undef __FUNCT__ 395683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 39573a471f94SBarry Smith /*@C 395883a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 39593a471f94SBarry Smith VecView() for the error at each timestep 39603a471f94SBarry Smith 39613a471f94SBarry Smith Collective on TS 39623a471f94SBarry Smith 39633a471f94SBarry Smith Input Parameters: 39643a471f94SBarry Smith + ts - the TS context 39653a471f94SBarry Smith . step - current time-step 39663a471f94SBarry Smith . ptime - current time 39670298fd71SBarry Smith - dummy - either a viewer or NULL 39683a471f94SBarry Smith 39693a471f94SBarry Smith Level: intermediate 39703a471f94SBarry Smith 39713a471f94SBarry Smith .keywords: TS, vector, monitor, view 39723a471f94SBarry Smith 39733a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 39743a471f94SBarry Smith @*/ 39750910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 39763a471f94SBarry Smith { 39773a471f94SBarry Smith PetscErrorCode ierr; 397883a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 397983a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 39803a471f94SBarry Smith Vec work; 39813a471f94SBarry Smith 39823a471f94SBarry Smith PetscFunctionBegin; 3983b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 39840910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 39853a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 39860910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 39873a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 39883a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 39893a471f94SBarry Smith PetscFunctionReturn(0); 39903a471f94SBarry Smith } 39913a471f94SBarry Smith 39922a34c10cSBarry Smith #include <petsc-private/dmimpl.h> 39933a471f94SBarry Smith #undef __FUNCT__ 39946c699258SBarry Smith #define __FUNCT__ "TSSetDM" 39956c699258SBarry Smith /*@ 39966c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 39976c699258SBarry Smith 39983f9fe445SBarry Smith Logically Collective on TS and DM 39996c699258SBarry Smith 40006c699258SBarry Smith Input Parameters: 40016c699258SBarry Smith + ts - the preconditioner context 40026c699258SBarry Smith - dm - the dm 40036c699258SBarry Smith 40046c699258SBarry Smith Level: intermediate 40056c699258SBarry Smith 40066c699258SBarry Smith 40076c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 40086c699258SBarry Smith @*/ 40097087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 40106c699258SBarry Smith { 40116c699258SBarry Smith PetscErrorCode ierr; 4012089b2837SJed Brown SNES snes; 4013942e3340SBarry Smith DMTS tsdm; 40146c699258SBarry Smith 40156c699258SBarry Smith PetscFunctionBegin; 40160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 401770663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4018942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 40192a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4020942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4021942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 402224989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 402324989b8cSPeter Brune tsdm->originaldm = dm; 402424989b8cSPeter Brune } 402524989b8cSPeter Brune } 40266bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 402724989b8cSPeter Brune } 40286c699258SBarry Smith ts->dm = dm; 4029bbd56ea5SKarl Rupp 4030089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4031089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 40326c699258SBarry Smith PetscFunctionReturn(0); 40336c699258SBarry Smith } 40346c699258SBarry Smith 40356c699258SBarry Smith #undef __FUNCT__ 40366c699258SBarry Smith #define __FUNCT__ "TSGetDM" 40376c699258SBarry Smith /*@ 40386c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 40396c699258SBarry Smith 40403f9fe445SBarry Smith Not Collective 40416c699258SBarry Smith 40426c699258SBarry Smith Input Parameter: 40436c699258SBarry Smith . ts - the preconditioner context 40446c699258SBarry Smith 40456c699258SBarry Smith Output Parameter: 40466c699258SBarry Smith . dm - the dm 40476c699258SBarry Smith 40486c699258SBarry Smith Level: intermediate 40496c699258SBarry Smith 40506c699258SBarry Smith 40516c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 40526c699258SBarry Smith @*/ 40537087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 40546c699258SBarry Smith { 4055496e6a7aSJed Brown PetscErrorCode ierr; 4056496e6a7aSJed Brown 40576c699258SBarry Smith PetscFunctionBegin; 40580700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4059496e6a7aSJed Brown if (!ts->dm) { 4060ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4061496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4062496e6a7aSJed Brown } 40636c699258SBarry Smith *dm = ts->dm; 40646c699258SBarry Smith PetscFunctionReturn(0); 40656c699258SBarry Smith } 40661713a123SBarry Smith 40670f5c6efeSJed Brown #undef __FUNCT__ 40680f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 40690f5c6efeSJed Brown /*@ 40700f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 40710f5c6efeSJed Brown 40723f9fe445SBarry Smith Logically Collective on SNES 40730f5c6efeSJed Brown 40740f5c6efeSJed Brown Input Parameter: 4075d42a1c89SJed Brown + snes - nonlinear solver 40760910c330SBarry Smith . U - the current state at which to evaluate the residual 4077d42a1c89SJed Brown - ctx - user context, must be a TS 40780f5c6efeSJed Brown 40790f5c6efeSJed Brown Output Parameter: 40800f5c6efeSJed Brown . F - the nonlinear residual 40810f5c6efeSJed Brown 40820f5c6efeSJed Brown Notes: 40830f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 40840f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 40850f5c6efeSJed Brown 40860f5c6efeSJed Brown Level: advanced 40870f5c6efeSJed Brown 40880f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 40890f5c6efeSJed Brown @*/ 40900910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 40910f5c6efeSJed Brown { 40920f5c6efeSJed Brown TS ts = (TS)ctx; 40930f5c6efeSJed Brown PetscErrorCode ierr; 40940f5c6efeSJed Brown 40950f5c6efeSJed Brown PetscFunctionBegin; 40960f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40970910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 40980f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 40990f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 41000910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 41010f5c6efeSJed Brown PetscFunctionReturn(0); 41020f5c6efeSJed Brown } 41030f5c6efeSJed Brown 41040f5c6efeSJed Brown #undef __FUNCT__ 41050f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 41060f5c6efeSJed Brown /*@ 41070f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 41080f5c6efeSJed Brown 41090f5c6efeSJed Brown Collective on SNES 41100f5c6efeSJed Brown 41110f5c6efeSJed Brown Input Parameter: 41120f5c6efeSJed Brown + snes - nonlinear solver 41130910c330SBarry Smith . U - the current state at which to evaluate the residual 41140f5c6efeSJed Brown - ctx - user context, must be a TS 41150f5c6efeSJed Brown 41160f5c6efeSJed Brown Output Parameter: 41170f5c6efeSJed Brown + A - the Jacobian 41180f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 41190f5c6efeSJed Brown - flag - indicates any structure change in the matrix 41200f5c6efeSJed Brown 41210f5c6efeSJed Brown Notes: 41220f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 41230f5c6efeSJed Brown 41240f5c6efeSJed Brown Level: developer 41250f5c6efeSJed Brown 41260f5c6efeSJed Brown .seealso: SNESSetJacobian() 41270f5c6efeSJed Brown @*/ 4128d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 41290f5c6efeSJed Brown { 41300f5c6efeSJed Brown TS ts = (TS)ctx; 41310f5c6efeSJed Brown PetscErrorCode ierr; 41320f5c6efeSJed Brown 41330f5c6efeSJed Brown PetscFunctionBegin; 41340f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 41350910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 41360f5c6efeSJed Brown PetscValidPointer(A,3); 413794ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 41380f5c6efeSJed Brown PetscValidPointer(B,4); 413994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 41400f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 4141d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 41420f5c6efeSJed Brown PetscFunctionReturn(0); 41430f5c6efeSJed Brown } 4144325fc9f4SBarry Smith 41450e4ef248SJed Brown #undef __FUNCT__ 41460e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 41470e4ef248SJed Brown /*@C 41480e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 41490e4ef248SJed Brown 41500e4ef248SJed Brown Collective on TS 41510e4ef248SJed Brown 41520e4ef248SJed Brown Input Arguments: 41530e4ef248SJed Brown + ts - time stepping context 41540e4ef248SJed Brown . t - time at which to evaluate 41550910c330SBarry Smith . U - state at which to evaluate 41560e4ef248SJed Brown - ctx - context 41570e4ef248SJed Brown 41580e4ef248SJed Brown Output Arguments: 41590e4ef248SJed Brown . F - right hand side 41600e4ef248SJed Brown 41610e4ef248SJed Brown Level: intermediate 41620e4ef248SJed Brown 41630e4ef248SJed Brown Notes: 41640e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 41650e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 41660e4ef248SJed Brown 41670e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 41680e4ef248SJed Brown @*/ 41690910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 41700e4ef248SJed Brown { 41710e4ef248SJed Brown PetscErrorCode ierr; 41720e4ef248SJed Brown Mat Arhs,Brhs; 41730e4ef248SJed Brown 41740e4ef248SJed Brown PetscFunctionBegin; 41750e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 4176d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 41770910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 41780e4ef248SJed Brown PetscFunctionReturn(0); 41790e4ef248SJed Brown } 41800e4ef248SJed Brown 41810e4ef248SJed Brown #undef __FUNCT__ 41820e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 41830e4ef248SJed Brown /*@C 41840e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 41850e4ef248SJed Brown 41860e4ef248SJed Brown Collective on TS 41870e4ef248SJed Brown 41880e4ef248SJed Brown Input Arguments: 41890e4ef248SJed Brown + ts - time stepping context 41900e4ef248SJed Brown . t - time at which to evaluate 41910910c330SBarry Smith . U - state at which to evaluate 41920e4ef248SJed Brown - ctx - context 41930e4ef248SJed Brown 41940e4ef248SJed Brown Output Arguments: 41950e4ef248SJed Brown + A - pointer to operator 41960e4ef248SJed Brown . B - pointer to preconditioning matrix 41970e4ef248SJed Brown - flg - matrix structure flag 41980e4ef248SJed Brown 41990e4ef248SJed Brown Level: intermediate 42000e4ef248SJed Brown 42010e4ef248SJed Brown Notes: 42020e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 42030e4ef248SJed Brown 42040e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 42050e4ef248SJed Brown @*/ 4206d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 42070e4ef248SJed Brown { 42080e4ef248SJed Brown PetscFunctionBegin; 42090e4ef248SJed Brown PetscFunctionReturn(0); 42100e4ef248SJed Brown } 42110e4ef248SJed Brown 42120026cea9SSean Farley #undef __FUNCT__ 42130026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 42140026cea9SSean Farley /*@C 42150026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 42160026cea9SSean Farley 42170026cea9SSean Farley Collective on TS 42180026cea9SSean Farley 42190026cea9SSean Farley Input Arguments: 42200026cea9SSean Farley + ts - time stepping context 42210026cea9SSean Farley . t - time at which to evaluate 42220910c330SBarry Smith . U - state at which to evaluate 42230910c330SBarry Smith . Udot - time derivative of state vector 42240026cea9SSean Farley - ctx - context 42250026cea9SSean Farley 42260026cea9SSean Farley Output Arguments: 42270026cea9SSean Farley . F - left hand side 42280026cea9SSean Farley 42290026cea9SSean Farley Level: intermediate 42300026cea9SSean Farley 42310026cea9SSean Farley Notes: 42320910c330SBarry 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 42330026cea9SSean Farley user is required to write their own TSComputeIFunction. 42340026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 42350026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 42360026cea9SSean Farley 42370026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 42380026cea9SSean Farley @*/ 42390910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 42400026cea9SSean Farley { 42410026cea9SSean Farley PetscErrorCode ierr; 42420026cea9SSean Farley Mat A,B; 42430026cea9SSean Farley 42440026cea9SSean Farley PetscFunctionBegin; 42450298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4246d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 42470910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 42480026cea9SSean Farley PetscFunctionReturn(0); 42490026cea9SSean Farley } 42500026cea9SSean Farley 42510026cea9SSean Farley #undef __FUNCT__ 42520026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 42530026cea9SSean Farley /*@C 4254b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 42550026cea9SSean Farley 42560026cea9SSean Farley Collective on TS 42570026cea9SSean Farley 42580026cea9SSean Farley Input Arguments: 42590026cea9SSean Farley + ts - time stepping context 42600026cea9SSean Farley . t - time at which to evaluate 42610910c330SBarry Smith . U - state at which to evaluate 42620910c330SBarry Smith . Udot - time derivative of state vector 42630026cea9SSean Farley . shift - shift to apply 42640026cea9SSean Farley - ctx - context 42650026cea9SSean Farley 42660026cea9SSean Farley Output Arguments: 42670026cea9SSean Farley + A - pointer to operator 42680026cea9SSean Farley . B - pointer to preconditioning matrix 42690026cea9SSean Farley - flg - matrix structure flag 42700026cea9SSean Farley 4271b41af12eSJed Brown Level: advanced 42720026cea9SSean Farley 42730026cea9SSean Farley Notes: 42740026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 42750026cea9SSean Farley 4276b41af12eSJed Brown It is only appropriate for problems of the form 4277b41af12eSJed Brown 4278b41af12eSJed Brown $ M Udot = F(U,t) 4279b41af12eSJed Brown 4280b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4281b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4282b41af12eSJed Brown an implicit operator of the form 4283b41af12eSJed Brown 4284b41af12eSJed Brown $ shift*M + J 4285b41af12eSJed Brown 4286b41af12eSJed 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 4287b41af12eSJed Brown a copy of M or reassemble it when requested. 4288b41af12eSJed Brown 42890026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 42900026cea9SSean Farley @*/ 4291d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 42920026cea9SSean Farley { 4293b41af12eSJed Brown PetscErrorCode ierr; 4294b41af12eSJed Brown 42950026cea9SSean Farley PetscFunctionBegin; 429694ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4297b41af12eSJed Brown ts->ijacobian.shift = shift; 42980026cea9SSean Farley PetscFunctionReturn(0); 42990026cea9SSean Farley } 4300b41af12eSJed Brown 4301e817cc15SEmil Constantinescu #undef __FUNCT__ 4302e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType" 4303e817cc15SEmil Constantinescu /*@ 4304e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4305e817cc15SEmil Constantinescu 4306e817cc15SEmil Constantinescu Not Collective 4307e817cc15SEmil Constantinescu 4308e817cc15SEmil Constantinescu Input Parameter: 4309e817cc15SEmil Constantinescu . ts - the TS context 4310e817cc15SEmil Constantinescu 4311e817cc15SEmil Constantinescu Output Parameter: 43124e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4313e817cc15SEmil Constantinescu 4314e817cc15SEmil Constantinescu Level: beginner 4315e817cc15SEmil Constantinescu 4316e817cc15SEmil Constantinescu .keywords: TS, equation type 4317e817cc15SEmil Constantinescu 4318e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4319e817cc15SEmil Constantinescu @*/ 4320e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4321e817cc15SEmil Constantinescu { 4322e817cc15SEmil Constantinescu PetscFunctionBegin; 4323e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4324e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4325e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4326e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4327e817cc15SEmil Constantinescu } 4328e817cc15SEmil Constantinescu 4329e817cc15SEmil Constantinescu #undef __FUNCT__ 4330e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType" 4331e817cc15SEmil Constantinescu /*@ 4332e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4333e817cc15SEmil Constantinescu 4334e817cc15SEmil Constantinescu Not Collective 4335e817cc15SEmil Constantinescu 4336e817cc15SEmil Constantinescu Input Parameter: 4337e817cc15SEmil Constantinescu + ts - the TS context 43384e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4339e817cc15SEmil Constantinescu 4340e817cc15SEmil Constantinescu Level: advanced 4341e817cc15SEmil Constantinescu 4342e817cc15SEmil Constantinescu .keywords: TS, equation type 4343e817cc15SEmil Constantinescu 4344e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4345e817cc15SEmil Constantinescu @*/ 4346e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4347e817cc15SEmil Constantinescu { 4348e817cc15SEmil Constantinescu PetscFunctionBegin; 4349e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4350e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4351e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4352e817cc15SEmil Constantinescu } 43530026cea9SSean Farley 43544af1b03aSJed Brown #undef __FUNCT__ 43554af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 43564af1b03aSJed Brown /*@ 43574af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 43584af1b03aSJed Brown 43594af1b03aSJed Brown Not Collective 43604af1b03aSJed Brown 43614af1b03aSJed Brown Input Parameter: 43624af1b03aSJed Brown . ts - the TS context 43634af1b03aSJed Brown 43644af1b03aSJed Brown Output Parameter: 43654af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 43664af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 43674af1b03aSJed Brown 4368487e0bb9SJed Brown Level: beginner 43694af1b03aSJed Brown 4370cd652676SJed Brown Notes: 4371cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 43724af1b03aSJed Brown 43734af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 43744af1b03aSJed Brown 43754af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 43764af1b03aSJed Brown @*/ 43774af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 43784af1b03aSJed Brown { 43794af1b03aSJed Brown PetscFunctionBegin; 43804af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 43814af1b03aSJed Brown PetscValidPointer(reason,2); 43824af1b03aSJed Brown *reason = ts->reason; 43834af1b03aSJed Brown PetscFunctionReturn(0); 43844af1b03aSJed Brown } 43854af1b03aSJed Brown 4386fb1732b5SBarry Smith #undef __FUNCT__ 4387d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason" 4388d6ad946cSShri Abhyankar /*@ 4389d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 4390d6ad946cSShri Abhyankar 4391d6ad946cSShri Abhyankar Not Collective 4392d6ad946cSShri Abhyankar 4393d6ad946cSShri Abhyankar Input Parameter: 4394d6ad946cSShri Abhyankar + ts - the TS context 4395d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 4396d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 4397d6ad946cSShri Abhyankar 4398f5abba47SShri Abhyankar Level: advanced 4399d6ad946cSShri Abhyankar 4400d6ad946cSShri Abhyankar Notes: 4401d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 4402d6ad946cSShri Abhyankar 4403d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 4404d6ad946cSShri Abhyankar 4405d6ad946cSShri Abhyankar .seealso: TSConvergedReason 4406d6ad946cSShri Abhyankar @*/ 4407d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 4408d6ad946cSShri Abhyankar { 4409d6ad946cSShri Abhyankar PetscFunctionBegin; 4410d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4411d6ad946cSShri Abhyankar ts->reason = reason; 4412d6ad946cSShri Abhyankar PetscFunctionReturn(0); 4413d6ad946cSShri Abhyankar } 4414d6ad946cSShri Abhyankar 4415d6ad946cSShri Abhyankar #undef __FUNCT__ 4416cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 4417cc708dedSBarry Smith /*@ 4418cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 4419cc708dedSBarry Smith 4420cc708dedSBarry Smith Not Collective 4421cc708dedSBarry Smith 4422cc708dedSBarry Smith Input Parameter: 4423cc708dedSBarry Smith . ts - the TS context 4424cc708dedSBarry Smith 4425cc708dedSBarry Smith Output Parameter: 4426cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 4427cc708dedSBarry Smith 4428487e0bb9SJed Brown Level: beginner 4429cc708dedSBarry Smith 4430cc708dedSBarry Smith Notes: 4431cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 4432cc708dedSBarry Smith 4433cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 4434cc708dedSBarry Smith 4435cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 4436cc708dedSBarry Smith @*/ 4437cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 4438cc708dedSBarry Smith { 4439cc708dedSBarry Smith PetscFunctionBegin; 4440cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4441cc708dedSBarry Smith PetscValidPointer(ftime,2); 4442cc708dedSBarry Smith *ftime = ts->solvetime; 4443cc708dedSBarry Smith PetscFunctionReturn(0); 4444cc708dedSBarry Smith } 4445cc708dedSBarry Smith 4446cc708dedSBarry Smith #undef __FUNCT__ 44472c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps" 44482c18e0fdSBarry Smith /*@ 44492c18e0fdSBarry Smith TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 44502c18e0fdSBarry Smith 44512c18e0fdSBarry Smith Not Collective 44522c18e0fdSBarry Smith 44532c18e0fdSBarry Smith Input Parameter: 44542c18e0fdSBarry Smith . ts - the TS context 44552c18e0fdSBarry Smith 44562c18e0fdSBarry Smith Output Parameter: 44572c18e0fdSBarry Smith . steps - the number of steps 44582c18e0fdSBarry Smith 44592c18e0fdSBarry Smith Level: beginner 44602c18e0fdSBarry Smith 44612c18e0fdSBarry Smith Notes: 44622c18e0fdSBarry Smith Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 44632c18e0fdSBarry Smith 44642c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test 44652c18e0fdSBarry Smith 44662c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 44672c18e0fdSBarry Smith @*/ 44682c18e0fdSBarry Smith PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 44692c18e0fdSBarry Smith { 44702c18e0fdSBarry Smith PetscFunctionBegin; 44712c18e0fdSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 44722c18e0fdSBarry Smith PetscValidPointer(steps,2); 44732c18e0fdSBarry Smith *steps = ts->total_steps; 44742c18e0fdSBarry Smith PetscFunctionReturn(0); 44752c18e0fdSBarry Smith } 44762c18e0fdSBarry Smith 44772c18e0fdSBarry Smith #undef __FUNCT__ 44785ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 44799f67acb7SJed Brown /*@ 44805ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 44819f67acb7SJed Brown used by the time integrator. 44829f67acb7SJed Brown 44839f67acb7SJed Brown Not Collective 44849f67acb7SJed Brown 44859f67acb7SJed Brown Input Parameter: 44869f67acb7SJed Brown . ts - TS context 44879f67acb7SJed Brown 44889f67acb7SJed Brown Output Parameter: 44899f67acb7SJed Brown . nits - number of nonlinear iterations 44909f67acb7SJed Brown 44919f67acb7SJed Brown Notes: 44929f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 44939f67acb7SJed Brown 44949f67acb7SJed Brown Level: intermediate 44959f67acb7SJed Brown 44969f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 44979f67acb7SJed Brown 44985ef26d82SJed Brown .seealso: TSGetKSPIterations() 44999f67acb7SJed Brown @*/ 45005ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 45019f67acb7SJed Brown { 45029f67acb7SJed Brown PetscFunctionBegin; 45039f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45049f67acb7SJed Brown PetscValidIntPointer(nits,2); 45055ef26d82SJed Brown *nits = ts->snes_its; 45069f67acb7SJed Brown PetscFunctionReturn(0); 45079f67acb7SJed Brown } 45089f67acb7SJed Brown 45099f67acb7SJed Brown #undef __FUNCT__ 45105ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 45119f67acb7SJed Brown /*@ 45125ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 45139f67acb7SJed Brown used by the time integrator. 45149f67acb7SJed Brown 45159f67acb7SJed Brown Not Collective 45169f67acb7SJed Brown 45179f67acb7SJed Brown Input Parameter: 45189f67acb7SJed Brown . ts - TS context 45199f67acb7SJed Brown 45209f67acb7SJed Brown Output Parameter: 45219f67acb7SJed Brown . lits - number of linear iterations 45229f67acb7SJed Brown 45239f67acb7SJed Brown Notes: 45249f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 45259f67acb7SJed Brown 45269f67acb7SJed Brown Level: intermediate 45279f67acb7SJed Brown 45289f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 45299f67acb7SJed Brown 45305ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 45319f67acb7SJed Brown @*/ 45325ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 45339f67acb7SJed Brown { 45349f67acb7SJed Brown PetscFunctionBegin; 45359f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45369f67acb7SJed Brown PetscValidIntPointer(lits,2); 45375ef26d82SJed Brown *lits = ts->ksp_its; 45389f67acb7SJed Brown PetscFunctionReturn(0); 45399f67acb7SJed Brown } 45409f67acb7SJed Brown 45419f67acb7SJed Brown #undef __FUNCT__ 4542cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 4543cef5090cSJed Brown /*@ 4544cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 4545cef5090cSJed Brown 4546cef5090cSJed Brown Not Collective 4547cef5090cSJed Brown 4548cef5090cSJed Brown Input Parameter: 4549cef5090cSJed Brown . ts - TS context 4550cef5090cSJed Brown 4551cef5090cSJed Brown Output Parameter: 4552cef5090cSJed Brown . rejects - number of steps rejected 4553cef5090cSJed Brown 4554cef5090cSJed Brown Notes: 4555cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4556cef5090cSJed Brown 4557cef5090cSJed Brown Level: intermediate 4558cef5090cSJed Brown 4559cef5090cSJed Brown .keywords: TS, get, number 4560cef5090cSJed Brown 45615ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 4562cef5090cSJed Brown @*/ 4563cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 4564cef5090cSJed Brown { 4565cef5090cSJed Brown PetscFunctionBegin; 4566cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4567cef5090cSJed Brown PetscValidIntPointer(rejects,2); 4568cef5090cSJed Brown *rejects = ts->reject; 4569cef5090cSJed Brown PetscFunctionReturn(0); 4570cef5090cSJed Brown } 4571cef5090cSJed Brown 4572cef5090cSJed Brown #undef __FUNCT__ 4573cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 4574cef5090cSJed Brown /*@ 4575cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 4576cef5090cSJed Brown 4577cef5090cSJed Brown Not Collective 4578cef5090cSJed Brown 4579cef5090cSJed Brown Input Parameter: 4580cef5090cSJed Brown . ts - TS context 4581cef5090cSJed Brown 4582cef5090cSJed Brown Output Parameter: 4583cef5090cSJed Brown . fails - number of failed nonlinear solves 4584cef5090cSJed Brown 4585cef5090cSJed Brown Notes: 4586cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4587cef5090cSJed Brown 4588cef5090cSJed Brown Level: intermediate 4589cef5090cSJed Brown 4590cef5090cSJed Brown .keywords: TS, get, number 4591cef5090cSJed Brown 45925ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 4593cef5090cSJed Brown @*/ 4594cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 4595cef5090cSJed Brown { 4596cef5090cSJed Brown PetscFunctionBegin; 4597cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4598cef5090cSJed Brown PetscValidIntPointer(fails,2); 4599cef5090cSJed Brown *fails = ts->num_snes_failures; 4600cef5090cSJed Brown PetscFunctionReturn(0); 4601cef5090cSJed Brown } 4602cef5090cSJed Brown 4603cef5090cSJed Brown #undef __FUNCT__ 4604cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 4605cef5090cSJed Brown /*@ 4606cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 4607cef5090cSJed Brown 4608cef5090cSJed Brown Not Collective 4609cef5090cSJed Brown 4610cef5090cSJed Brown Input Parameter: 4611cef5090cSJed Brown + ts - TS context 4612cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 4613cef5090cSJed Brown 4614cef5090cSJed Brown Notes: 4615cef5090cSJed Brown The counter is reset to zero for each step 4616cef5090cSJed Brown 4617cef5090cSJed Brown Options Database Key: 4618cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 4619cef5090cSJed Brown 4620cef5090cSJed Brown Level: intermediate 4621cef5090cSJed Brown 4622cef5090cSJed Brown .keywords: TS, set, maximum, number 4623cef5090cSJed Brown 46245ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4625cef5090cSJed Brown @*/ 4626cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 4627cef5090cSJed Brown { 4628cef5090cSJed Brown PetscFunctionBegin; 4629cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4630cef5090cSJed Brown ts->max_reject = rejects; 4631cef5090cSJed Brown PetscFunctionReturn(0); 4632cef5090cSJed Brown } 4633cef5090cSJed Brown 4634cef5090cSJed Brown #undef __FUNCT__ 4635cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 4636cef5090cSJed Brown /*@ 4637cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 4638cef5090cSJed Brown 4639cef5090cSJed Brown Not Collective 4640cef5090cSJed Brown 4641cef5090cSJed Brown Input Parameter: 4642cef5090cSJed Brown + ts - TS context 4643cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4644cef5090cSJed Brown 4645cef5090cSJed Brown Notes: 4646cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 4647cef5090cSJed Brown 4648cef5090cSJed Brown Options Database Key: 4649cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4650cef5090cSJed Brown 4651cef5090cSJed Brown Level: intermediate 4652cef5090cSJed Brown 4653cef5090cSJed Brown .keywords: TS, set, maximum, number 4654cef5090cSJed Brown 46555ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 4656cef5090cSJed Brown @*/ 4657cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 4658cef5090cSJed Brown { 4659cef5090cSJed Brown PetscFunctionBegin; 4660cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4661cef5090cSJed Brown ts->max_snes_failures = fails; 4662cef5090cSJed Brown PetscFunctionReturn(0); 4663cef5090cSJed Brown } 4664cef5090cSJed Brown 4665cef5090cSJed Brown #undef __FUNCT__ 46664e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails" 4667cef5090cSJed Brown /*@ 4668cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 4669cef5090cSJed Brown 4670cef5090cSJed Brown Not Collective 4671cef5090cSJed Brown 4672cef5090cSJed Brown Input Parameter: 4673cef5090cSJed Brown + ts - TS context 4674cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 4675cef5090cSJed Brown 4676cef5090cSJed Brown Options Database Key: 4677cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 4678cef5090cSJed Brown 4679cef5090cSJed Brown Level: intermediate 4680cef5090cSJed Brown 4681cef5090cSJed Brown .keywords: TS, set, error 4682cef5090cSJed Brown 46835ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4684cef5090cSJed Brown @*/ 4685cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 4686cef5090cSJed Brown { 4687cef5090cSJed Brown PetscFunctionBegin; 4688cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4689cef5090cSJed Brown ts->errorifstepfailed = err; 4690cef5090cSJed Brown PetscFunctionReturn(0); 4691cef5090cSJed Brown } 4692cef5090cSJed Brown 4693cef5090cSJed Brown #undef __FUNCT__ 4694fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 4695fb1732b5SBarry Smith /*@C 4696fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 4697fb1732b5SBarry Smith 4698fb1732b5SBarry Smith Collective on TS 4699fb1732b5SBarry Smith 4700fb1732b5SBarry Smith Input Parameters: 4701fb1732b5SBarry Smith + ts - the TS context 4702fb1732b5SBarry Smith . step - current time-step 4703fb1732b5SBarry Smith . ptime - current time 47040910c330SBarry Smith . u - current state 4705fb1732b5SBarry Smith - viewer - binary viewer 4706fb1732b5SBarry Smith 4707fb1732b5SBarry Smith Level: intermediate 4708fb1732b5SBarry Smith 4709fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 4710fb1732b5SBarry Smith 4711fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4712fb1732b5SBarry Smith @*/ 47130910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 4714fb1732b5SBarry Smith { 4715fb1732b5SBarry Smith PetscErrorCode ierr; 4716ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 4717fb1732b5SBarry Smith 4718fb1732b5SBarry Smith PetscFunctionBegin; 47190910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 4720ed81e22dSJed Brown PetscFunctionReturn(0); 4721ed81e22dSJed Brown } 4722ed81e22dSJed Brown 4723ed81e22dSJed Brown #undef __FUNCT__ 4724ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 4725ed81e22dSJed Brown /*@C 4726ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 4727ed81e22dSJed Brown 4728ed81e22dSJed Brown Collective on TS 4729ed81e22dSJed Brown 4730ed81e22dSJed Brown Input Parameters: 4731ed81e22dSJed Brown + ts - the TS context 4732ed81e22dSJed Brown . step - current time-step 4733ed81e22dSJed Brown . ptime - current time 47340910c330SBarry Smith . u - current state 4735ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4736ed81e22dSJed Brown 4737ed81e22dSJed Brown Level: intermediate 4738ed81e22dSJed Brown 4739ed81e22dSJed Brown Notes: 4740ed81e22dSJed 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. 4741ed81e22dSJed Brown These are named according to the file name template. 4742ed81e22dSJed Brown 4743ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 4744ed81e22dSJed Brown 4745ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4746ed81e22dSJed Brown 4747ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4748ed81e22dSJed Brown @*/ 47490910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 4750ed81e22dSJed Brown { 4751ed81e22dSJed Brown PetscErrorCode ierr; 4752ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 4753ed81e22dSJed Brown PetscViewer viewer; 4754ed81e22dSJed Brown 4755ed81e22dSJed Brown PetscFunctionBegin; 47568caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 4757ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 47580910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 4759ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 4760ed81e22dSJed Brown PetscFunctionReturn(0); 4761ed81e22dSJed Brown } 4762ed81e22dSJed Brown 4763ed81e22dSJed Brown #undef __FUNCT__ 4764ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 4765ed81e22dSJed Brown /*@C 4766ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 4767ed81e22dSJed Brown 4768ed81e22dSJed Brown Collective on TS 4769ed81e22dSJed Brown 4770ed81e22dSJed Brown Input Parameters: 4771ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4772ed81e22dSJed Brown 4773ed81e22dSJed Brown Level: intermediate 4774ed81e22dSJed Brown 4775ed81e22dSJed Brown Note: 4776ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 4777ed81e22dSJed Brown 4778ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4779ed81e22dSJed Brown 4780ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 4781ed81e22dSJed Brown @*/ 4782ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 4783ed81e22dSJed Brown { 4784ed81e22dSJed Brown PetscErrorCode ierr; 4785ed81e22dSJed Brown 4786ed81e22dSJed Brown PetscFunctionBegin; 4787ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 4788fb1732b5SBarry Smith PetscFunctionReturn(0); 4789fb1732b5SBarry Smith } 4790fb1732b5SBarry Smith 479184df9cb4SJed Brown #undef __FUNCT__ 4792552698daSJed Brown #define __FUNCT__ "TSGetAdapt" 479384df9cb4SJed Brown /*@ 4794552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 479584df9cb4SJed Brown 4796ed81e22dSJed Brown Collective on TS if controller has not been created yet 479784df9cb4SJed Brown 479884df9cb4SJed Brown Input Arguments: 4799ed81e22dSJed Brown . ts - time stepping context 480084df9cb4SJed Brown 480184df9cb4SJed Brown Output Arguments: 4802ed81e22dSJed Brown . adapt - adaptive controller 480384df9cb4SJed Brown 480484df9cb4SJed Brown Level: intermediate 480584df9cb4SJed Brown 4806ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 480784df9cb4SJed Brown @*/ 4808552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 480984df9cb4SJed Brown { 481084df9cb4SJed Brown PetscErrorCode ierr; 481184df9cb4SJed Brown 481284df9cb4SJed Brown PetscFunctionBegin; 481384df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 481484df9cb4SJed Brown PetscValidPointer(adapt,2); 481584df9cb4SJed Brown if (!ts->adapt) { 4816ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 48173bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 48181c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 481984df9cb4SJed Brown } 482084df9cb4SJed Brown *adapt = ts->adapt; 482184df9cb4SJed Brown PetscFunctionReturn(0); 482284df9cb4SJed Brown } 4823d6ebe24aSShri Abhyankar 4824d6ebe24aSShri Abhyankar #undef __FUNCT__ 48251c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 48261c3436cfSJed Brown /*@ 48271c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 48281c3436cfSJed Brown 48291c3436cfSJed Brown Logically Collective 48301c3436cfSJed Brown 48311c3436cfSJed Brown Input Arguments: 48321c3436cfSJed Brown + ts - time integration context 48331c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 48340298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 48351c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 48360298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 48371c3436cfSJed Brown 4838a3cdaa26SBarry Smith Options Database keys: 4839a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 4840a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 4841a3cdaa26SBarry Smith 48421c3436cfSJed Brown Level: beginner 48431c3436cfSJed Brown 4844c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 48451c3436cfSJed Brown @*/ 48461c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 48471c3436cfSJed Brown { 48481c3436cfSJed Brown PetscErrorCode ierr; 48491c3436cfSJed Brown 48501c3436cfSJed Brown PetscFunctionBegin; 4851c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 48521c3436cfSJed Brown if (vatol) { 48531c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 48541c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 4855bbd56ea5SKarl Rupp 48561c3436cfSJed Brown ts->vatol = vatol; 48571c3436cfSJed Brown } 4858c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 48591c3436cfSJed Brown if (vrtol) { 48601c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 48611c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 4862bbd56ea5SKarl Rupp 48631c3436cfSJed Brown ts->vrtol = vrtol; 48641c3436cfSJed Brown } 48651c3436cfSJed Brown PetscFunctionReturn(0); 48661c3436cfSJed Brown } 48671c3436cfSJed Brown 48681c3436cfSJed Brown #undef __FUNCT__ 4869c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 4870c5033834SJed Brown /*@ 4871c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4872c5033834SJed Brown 4873c5033834SJed Brown Logically Collective 4874c5033834SJed Brown 4875c5033834SJed Brown Input Arguments: 4876c5033834SJed Brown . ts - time integration context 4877c5033834SJed Brown 4878c5033834SJed Brown Output Arguments: 48790298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 48800298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 48810298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 48820298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 4883c5033834SJed Brown 4884c5033834SJed Brown Level: beginner 4885c5033834SJed Brown 4886c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 4887c5033834SJed Brown @*/ 4888c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4889c5033834SJed Brown { 4890c5033834SJed Brown PetscFunctionBegin; 4891c5033834SJed Brown if (atol) *atol = ts->atol; 4892c5033834SJed Brown if (vatol) *vatol = ts->vatol; 4893c5033834SJed Brown if (rtol) *rtol = ts->rtol; 4894c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 4895c5033834SJed Brown PetscFunctionReturn(0); 4896c5033834SJed Brown } 4897c5033834SJed Brown 4898c5033834SJed Brown #undef __FUNCT__ 48991c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 49001c3436cfSJed Brown /*@ 49011c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 49021c3436cfSJed Brown 49031c3436cfSJed Brown Collective on TS 49041c3436cfSJed Brown 49051c3436cfSJed Brown Input Arguments: 49061c3436cfSJed Brown + ts - time stepping context 49071c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 49081c3436cfSJed Brown 49091c3436cfSJed Brown Output Arguments: 49101c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 49111c3436cfSJed Brown 49121c3436cfSJed Brown Level: developer 49131c3436cfSJed Brown 49141c3436cfSJed Brown .seealso: TSSetTolerances() 49151c3436cfSJed Brown @*/ 49161c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 49171c3436cfSJed Brown { 49181c3436cfSJed Brown PetscErrorCode ierr; 49191c3436cfSJed Brown PetscInt i,n,N; 49200910c330SBarry Smith const PetscScalar *u,*y; 49210910c330SBarry Smith Vec U; 49221c3436cfSJed Brown PetscReal sum,gsum; 49231c3436cfSJed Brown 49241c3436cfSJed Brown PetscFunctionBegin; 49251c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49261c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 49271c3436cfSJed Brown PetscValidPointer(norm,3); 49280910c330SBarry Smith U = ts->vec_sol; 49290910c330SBarry Smith PetscCheckSameTypeAndComm(U,1,Y,2); 4930ce94432eSBarry Smith if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 49311c3436cfSJed Brown 49320910c330SBarry Smith ierr = VecGetSize(U,&N);CHKERRQ(ierr); 49330910c330SBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 49340910c330SBarry Smith ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 49351c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 49361c3436cfSJed Brown sum = 0.; 4937ceefc113SJed Brown if (ts->vatol && ts->vrtol) { 4938ceefc113SJed Brown const PetscScalar *atol,*rtol; 4939ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4940ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4941ceefc113SJed Brown for (i=0; i<n; i++) { 49420910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 49430910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4944ceefc113SJed Brown } 4945ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4946ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4947ceefc113SJed Brown } else if (ts->vatol) { /* vector atol, scalar rtol */ 4948ceefc113SJed Brown const PetscScalar *atol; 4949ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4950ceefc113SJed Brown for (i=0; i<n; i++) { 49510910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 49520910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4953ceefc113SJed Brown } 4954ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4955ceefc113SJed Brown } else if (ts->vrtol) { /* scalar atol, vector rtol */ 4956ceefc113SJed Brown const PetscScalar *rtol; 4957ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4958ceefc113SJed Brown for (i=0; i<n; i++) { 49590910c330SBarry Smith PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 49600910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4961ceefc113SJed Brown } 4962ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4963ceefc113SJed Brown } else { /* scalar atol, scalar rtol */ 49641c3436cfSJed Brown for (i=0; i<n; i++) { 49650910c330SBarry Smith PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 49660910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 49671c3436cfSJed Brown } 4968ceefc113SJed Brown } 49690910c330SBarry Smith ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 49701c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 49711c3436cfSJed Brown 4972ce94432eSBarry Smith ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 49731c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 4974620fc8aaSSatish Balay if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 49751c3436cfSJed Brown PetscFunctionReturn(0); 49761c3436cfSJed Brown } 49771c3436cfSJed Brown 49781c3436cfSJed Brown #undef __FUNCT__ 49798d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 49808d59e960SJed Brown /*@ 49818d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 49828d59e960SJed Brown 49838d59e960SJed Brown Logically Collective on TS 49848d59e960SJed Brown 49858d59e960SJed Brown Input Arguments: 49868d59e960SJed Brown + ts - time stepping context 49878d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 49888d59e960SJed Brown 49898d59e960SJed Brown Note: 49908d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 49918d59e960SJed Brown 49928d59e960SJed Brown Level: intermediate 49938d59e960SJed Brown 49948d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 49958d59e960SJed Brown @*/ 49968d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 49978d59e960SJed Brown { 49988d59e960SJed Brown PetscFunctionBegin; 49998d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 50008d59e960SJed Brown ts->cfltime_local = cfltime; 50018d59e960SJed Brown ts->cfltime = -1.; 50028d59e960SJed Brown PetscFunctionReturn(0); 50038d59e960SJed Brown } 50048d59e960SJed Brown 50058d59e960SJed Brown #undef __FUNCT__ 50068d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 50078d59e960SJed Brown /*@ 50088d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 50098d59e960SJed Brown 50108d59e960SJed Brown Collective on TS 50118d59e960SJed Brown 50128d59e960SJed Brown Input Arguments: 50138d59e960SJed Brown . ts - time stepping context 50148d59e960SJed Brown 50158d59e960SJed Brown Output Arguments: 50168d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 50178d59e960SJed Brown 50188d59e960SJed Brown Level: advanced 50198d59e960SJed Brown 50208d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 50218d59e960SJed Brown @*/ 50228d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 50238d59e960SJed Brown { 50248d59e960SJed Brown PetscErrorCode ierr; 50258d59e960SJed Brown 50268d59e960SJed Brown PetscFunctionBegin; 50278d59e960SJed Brown if (ts->cfltime < 0) { 5028ce94432eSBarry Smith ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 50298d59e960SJed Brown } 50308d59e960SJed Brown *cfltime = ts->cfltime; 50318d59e960SJed Brown PetscFunctionReturn(0); 50328d59e960SJed Brown } 50338d59e960SJed Brown 50348d59e960SJed Brown #undef __FUNCT__ 5035d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 5036d6ebe24aSShri Abhyankar /*@ 5037d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 5038d6ebe24aSShri Abhyankar 5039d6ebe24aSShri Abhyankar Input Parameters: 5040d6ebe24aSShri Abhyankar . ts - the TS context. 5041d6ebe24aSShri Abhyankar . xl - lower bound. 5042d6ebe24aSShri Abhyankar . xu - upper bound. 5043d6ebe24aSShri Abhyankar 5044d6ebe24aSShri Abhyankar Notes: 5045d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 5046e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 5047d6ebe24aSShri Abhyankar 50482bd2b0e6SSatish Balay Level: advanced 50492bd2b0e6SSatish Balay 5050d6ebe24aSShri Abhyankar @*/ 5051d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 5052d6ebe24aSShri Abhyankar { 5053d6ebe24aSShri Abhyankar PetscErrorCode ierr; 5054d6ebe24aSShri Abhyankar SNES snes; 5055d6ebe24aSShri Abhyankar 5056d6ebe24aSShri Abhyankar PetscFunctionBegin; 5057d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 5058d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 5059d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 5060d6ebe24aSShri Abhyankar } 5061d6ebe24aSShri Abhyankar 5062325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 5063c6db04a5SJed Brown #include <mex.h> 5064325fc9f4SBarry Smith 5065325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 5066325fc9f4SBarry Smith 5067325fc9f4SBarry Smith #undef __FUNCT__ 5068325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 5069325fc9f4SBarry Smith /* 5070325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 5071325fc9f4SBarry Smith TSSetFunctionMatlab(). 5072325fc9f4SBarry Smith 5073325fc9f4SBarry Smith Collective on TS 5074325fc9f4SBarry Smith 5075325fc9f4SBarry Smith Input Parameters: 5076325fc9f4SBarry Smith + snes - the TS context 50770910c330SBarry Smith - u - input vector 5078325fc9f4SBarry Smith 5079325fc9f4SBarry Smith Output Parameter: 5080325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 5081325fc9f4SBarry Smith 5082325fc9f4SBarry Smith Notes: 5083325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 5084325fc9f4SBarry Smith implementations, so most users would not generally call this routine 5085325fc9f4SBarry Smith themselves. 5086325fc9f4SBarry Smith 5087325fc9f4SBarry Smith Level: developer 5088325fc9f4SBarry Smith 5089325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 5090325fc9f4SBarry Smith 5091325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5092325fc9f4SBarry Smith */ 50930910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 5094325fc9f4SBarry Smith { 5095325fc9f4SBarry Smith PetscErrorCode ierr; 5096325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5097325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 5098325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 5099325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 5100325fc9f4SBarry Smith 5101325fc9f4SBarry Smith PetscFunctionBegin; 5102325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 51030910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 51040910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 5105325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 51060910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 5107325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 5108325fc9f4SBarry Smith 5109325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 51100910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 51110910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 51120910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 5113bbd56ea5SKarl Rupp 5114325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5115325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 5116325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 5117325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 5118325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 5119325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 5120325fc9f4SBarry Smith prhs[6] = sctx->ctx; 5121325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 5122325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5123325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 5124325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 5125325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 5126325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 5127325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 5128325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 5129325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 5130325fc9f4SBarry Smith PetscFunctionReturn(0); 5131325fc9f4SBarry Smith } 5132325fc9f4SBarry Smith 5133325fc9f4SBarry Smith 5134325fc9f4SBarry Smith #undef __FUNCT__ 5135325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 5136325fc9f4SBarry Smith /* 5137325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 5138325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 5139e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 5140325fc9f4SBarry Smith 5141325fc9f4SBarry Smith Logically Collective on TS 5142325fc9f4SBarry Smith 5143325fc9f4SBarry Smith Input Parameters: 5144325fc9f4SBarry Smith + ts - the TS context 5145325fc9f4SBarry Smith - func - function evaluation routine 5146325fc9f4SBarry Smith 5147325fc9f4SBarry Smith Calling sequence of func: 51480910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 5149325fc9f4SBarry Smith 5150325fc9f4SBarry Smith Level: beginner 5151325fc9f4SBarry Smith 5152325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 5153325fc9f4SBarry Smith 5154325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5155325fc9f4SBarry Smith */ 5156cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 5157325fc9f4SBarry Smith { 5158325fc9f4SBarry Smith PetscErrorCode ierr; 5159325fc9f4SBarry Smith TSMatlabContext *sctx; 5160325fc9f4SBarry Smith 5161325fc9f4SBarry Smith PetscFunctionBegin; 5162325fc9f4SBarry Smith /* currently sctx is memory bleed */ 5163325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5164325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5165325fc9f4SBarry Smith /* 5166325fc9f4SBarry Smith This should work, but it doesn't 5167325fc9f4SBarry Smith sctx->ctx = ctx; 5168325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5169325fc9f4SBarry Smith */ 5170325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5171bbd56ea5SKarl Rupp 51720298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 5173325fc9f4SBarry Smith PetscFunctionReturn(0); 5174325fc9f4SBarry Smith } 5175325fc9f4SBarry Smith 5176325fc9f4SBarry Smith #undef __FUNCT__ 5177325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 5178325fc9f4SBarry Smith /* 5179325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 5180325fc9f4SBarry Smith TSSetJacobianMatlab(). 5181325fc9f4SBarry Smith 5182325fc9f4SBarry Smith Collective on TS 5183325fc9f4SBarry Smith 5184325fc9f4SBarry Smith Input Parameters: 5185cdcf91faSSean Farley + ts - the TS context 51860910c330SBarry Smith . u - input vector 5187325fc9f4SBarry Smith . A, B - the matrices 5188325fc9f4SBarry Smith - ctx - user context 5189325fc9f4SBarry Smith 5190325fc9f4SBarry Smith Level: developer 5191325fc9f4SBarry Smith 5192325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 5193325fc9f4SBarry Smith 5194325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5195325fc9f4SBarry Smith @*/ 5196f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 5197325fc9f4SBarry Smith { 5198325fc9f4SBarry Smith PetscErrorCode ierr; 5199325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5200325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 5201325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 5202325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 5203325fc9f4SBarry Smith 5204325fc9f4SBarry Smith PetscFunctionBegin; 5205cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 52060910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 5207325fc9f4SBarry Smith 52080910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 5209325fc9f4SBarry Smith 5210cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 52110910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 52120910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 52130910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 52140910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 5215bbd56ea5SKarl Rupp 5216325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5217325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 5218325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 5219325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 5220325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 5221325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 5222325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 5223325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 5224325fc9f4SBarry Smith prhs[8] = sctx->ctx; 5225325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 5226325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5227325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 5228325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 5229325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 5230325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 5231325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 5232325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 5233325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 5234325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 5235325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 5236325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 5237325fc9f4SBarry Smith PetscFunctionReturn(0); 5238325fc9f4SBarry Smith } 5239325fc9f4SBarry Smith 5240325fc9f4SBarry Smith 5241325fc9f4SBarry Smith #undef __FUNCT__ 5242325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 5243325fc9f4SBarry Smith /* 5244325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 5245e3c5b3baSBarry 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 5246325fc9f4SBarry Smith 5247325fc9f4SBarry Smith Logically Collective on TS 5248325fc9f4SBarry Smith 5249325fc9f4SBarry Smith Input Parameters: 5250cdcf91faSSean Farley + ts - the TS context 5251325fc9f4SBarry Smith . A,B - Jacobian matrices 5252325fc9f4SBarry Smith . func - function evaluation routine 5253325fc9f4SBarry Smith - ctx - user context 5254325fc9f4SBarry Smith 5255325fc9f4SBarry Smith Calling sequence of func: 52560910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 5257325fc9f4SBarry Smith 5258325fc9f4SBarry Smith 5259325fc9f4SBarry Smith Level: developer 5260325fc9f4SBarry Smith 5261325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 5262325fc9f4SBarry Smith 5263325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5264325fc9f4SBarry Smith */ 5265cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 5266325fc9f4SBarry Smith { 5267325fc9f4SBarry Smith PetscErrorCode ierr; 5268325fc9f4SBarry Smith TSMatlabContext *sctx; 5269325fc9f4SBarry Smith 5270325fc9f4SBarry Smith PetscFunctionBegin; 5271325fc9f4SBarry Smith /* currently sctx is memory bleed */ 5272325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5273325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5274325fc9f4SBarry Smith /* 5275325fc9f4SBarry Smith This should work, but it doesn't 5276325fc9f4SBarry Smith sctx->ctx = ctx; 5277325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5278325fc9f4SBarry Smith */ 5279325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5280bbd56ea5SKarl Rupp 5281cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 5282325fc9f4SBarry Smith PetscFunctionReturn(0); 5283325fc9f4SBarry Smith } 5284325fc9f4SBarry Smith 5285b5b1a830SBarry Smith #undef __FUNCT__ 5286b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 5287b5b1a830SBarry Smith /* 5288b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 5289b5b1a830SBarry Smith 5290b5b1a830SBarry Smith Collective on TS 5291b5b1a830SBarry Smith 5292b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5293b5b1a830SBarry Smith @*/ 52940910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 5295b5b1a830SBarry Smith { 5296b5b1a830SBarry Smith PetscErrorCode ierr; 5297b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5298a530c242SBarry Smith int nlhs = 1,nrhs = 6; 5299b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 5300b5b1a830SBarry Smith long long int lx = 0,ls = 0; 5301b5b1a830SBarry Smith 5302b5b1a830SBarry Smith PetscFunctionBegin; 5303cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53040910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 5305b5b1a830SBarry Smith 5306cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 53070910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 5308bbd56ea5SKarl Rupp 5309b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5310b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 5311b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 5312b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 5313b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 5314b5b1a830SBarry Smith prhs[5] = sctx->ctx; 5315b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 5316b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5317b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 5318b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 5319b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 5320b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 5321b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 5322b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 5323b5b1a830SBarry Smith PetscFunctionReturn(0); 5324b5b1a830SBarry Smith } 5325b5b1a830SBarry Smith 5326b5b1a830SBarry Smith 5327b5b1a830SBarry Smith #undef __FUNCT__ 5328b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 5329b5b1a830SBarry Smith /* 5330b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 5331b5b1a830SBarry Smith 5332b5b1a830SBarry Smith Level: developer 5333b5b1a830SBarry Smith 5334b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 5335b5b1a830SBarry Smith 5336b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5337b5b1a830SBarry Smith */ 5338cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 5339b5b1a830SBarry Smith { 5340b5b1a830SBarry Smith PetscErrorCode ierr; 5341b5b1a830SBarry Smith TSMatlabContext *sctx; 5342b5b1a830SBarry Smith 5343b5b1a830SBarry Smith PetscFunctionBegin; 5344b5b1a830SBarry Smith /* currently sctx is memory bleed */ 5345b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5346b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5347b5b1a830SBarry Smith /* 5348b5b1a830SBarry Smith This should work, but it doesn't 5349b5b1a830SBarry Smith sctx->ctx = ctx; 5350b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5351b5b1a830SBarry Smith */ 5352b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5353bbd56ea5SKarl Rupp 53540298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 5355b5b1a830SBarry Smith PetscFunctionReturn(0); 5356b5b1a830SBarry Smith } 5357325fc9f4SBarry Smith #endif 5358b3603a34SBarry Smith 53590b039ecaSBarry Smith 53600b039ecaSBarry Smith 5361b3603a34SBarry Smith #undef __FUNCT__ 53624f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 5363b3603a34SBarry Smith /*@C 53644f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 5365b3603a34SBarry Smith in a time based line graph 5366b3603a34SBarry Smith 5367b3603a34SBarry Smith Collective on TS 5368b3603a34SBarry Smith 5369b3603a34SBarry Smith Input Parameters: 5370b3603a34SBarry Smith + ts - the TS context 5371b3603a34SBarry Smith . step - current time-step 5372b3603a34SBarry Smith . ptime - current time 5373b3603a34SBarry Smith - lg - a line graph object 5374b3603a34SBarry Smith 5375b3603a34SBarry Smith Level: intermediate 5376b3603a34SBarry Smith 53770b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 5378b3603a34SBarry Smith 5379b3603a34SBarry Smith .keywords: TS, vector, monitor, view 5380b3603a34SBarry Smith 5381b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5382b3603a34SBarry Smith @*/ 53830910c330SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 5384b3603a34SBarry Smith { 5385b3603a34SBarry Smith PetscErrorCode ierr; 53860b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 5387b3603a34SBarry Smith const PetscScalar *yy; 538858ff32f7SBarry Smith PetscInt dim; 5389b3603a34SBarry Smith 5390b3603a34SBarry Smith PetscFunctionBegin; 539158ff32f7SBarry Smith if (!step) { 5392a9f9c1f6SBarry Smith PetscDrawAxis axis; 5393a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5394a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 53950910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 53960b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 53970b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 539858ff32f7SBarry Smith } 53990910c330SBarry Smith ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 5400e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 5401e3efe391SJed Brown { 5402e3efe391SJed Brown PetscReal *yreal; 5403e3efe391SJed Brown PetscInt i,n; 54040910c330SBarry Smith ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 5405785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 5406e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 54070b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 5408e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 5409e3efe391SJed Brown } 5410e3efe391SJed Brown #else 54110b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 5412e3efe391SJed Brown #endif 54130910c330SBarry Smith ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 5414b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 54150b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 54163923b477SBarry Smith } 5417b3603a34SBarry Smith PetscFunctionReturn(0); 5418b3603a34SBarry Smith } 5419b3603a34SBarry Smith 5420b3603a34SBarry Smith #undef __FUNCT__ 54214f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 5422ef20d060SBarry Smith /*@C 54234f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 5424ef20d060SBarry Smith in a time based line graph 5425ef20d060SBarry Smith 5426ef20d060SBarry Smith Collective on TS 5427ef20d060SBarry Smith 5428ef20d060SBarry Smith Input Parameters: 5429ef20d060SBarry Smith + ts - the TS context 5430ef20d060SBarry Smith . step - current time-step 5431ef20d060SBarry Smith . ptime - current time 5432ef20d060SBarry Smith - lg - a line graph object 5433ef20d060SBarry Smith 5434ef20d060SBarry Smith Level: intermediate 5435ef20d060SBarry Smith 5436abd5a294SJed Brown Notes: 5437abd5a294SJed Brown Only for sequential solves. 5438abd5a294SJed Brown 5439abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 5440abd5a294SJed Brown 5441abd5a294SJed Brown Options Database Keys: 54424f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 5443ef20d060SBarry Smith 5444ef20d060SBarry Smith .keywords: TS, vector, monitor, view 5445ef20d060SBarry Smith 5446abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 5447ef20d060SBarry Smith @*/ 54480910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 5449ef20d060SBarry Smith { 5450ef20d060SBarry Smith PetscErrorCode ierr; 54510b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 5452ef20d060SBarry Smith const PetscScalar *yy; 5453ef20d060SBarry Smith Vec y; 5454a9f9c1f6SBarry Smith PetscInt dim; 5455ef20d060SBarry Smith 5456ef20d060SBarry Smith PetscFunctionBegin; 5457a9f9c1f6SBarry Smith if (!step) { 5458a9f9c1f6SBarry Smith PetscDrawAxis axis; 5459a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 54601ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 54610910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 5462a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 5463a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5464a9f9c1f6SBarry Smith } 54650910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 5466ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 54670910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 5468ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 5469e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 5470e3efe391SJed Brown { 5471e3efe391SJed Brown PetscReal *yreal; 5472e3efe391SJed Brown PetscInt i,n; 5473e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 5474785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 5475e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 54760b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 5477e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 5478e3efe391SJed Brown } 5479e3efe391SJed Brown #else 54800b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 5481e3efe391SJed Brown #endif 5482ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 5483ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 5484b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 54850b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 54863923b477SBarry Smith } 5487ef20d060SBarry Smith PetscFunctionReturn(0); 5488ef20d060SBarry Smith } 5489ef20d060SBarry Smith 5490201da799SBarry Smith #undef __FUNCT__ 5491201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 5492201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 5493201da799SBarry Smith { 5494201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 5495201da799SBarry Smith PetscReal x = ptime,y; 5496201da799SBarry Smith PetscErrorCode ierr; 5497201da799SBarry Smith PetscInt its; 5498201da799SBarry Smith 5499201da799SBarry Smith PetscFunctionBegin; 5500201da799SBarry Smith if (!n) { 5501201da799SBarry Smith PetscDrawAxis axis; 5502bbd56ea5SKarl Rupp 5503201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5504201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 5505201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5506bbd56ea5SKarl Rupp 5507201da799SBarry Smith ctx->snes_its = 0; 5508201da799SBarry Smith } 5509201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 5510201da799SBarry Smith y = its - ctx->snes_its; 5511201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 55123fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 5513201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 5514201da799SBarry Smith } 5515201da799SBarry Smith ctx->snes_its = its; 5516201da799SBarry Smith PetscFunctionReturn(0); 5517201da799SBarry Smith } 5518201da799SBarry Smith 5519201da799SBarry Smith #undef __FUNCT__ 5520201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 5521201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 5522201da799SBarry Smith { 5523201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 5524201da799SBarry Smith PetscReal x = ptime,y; 5525201da799SBarry Smith PetscErrorCode ierr; 5526201da799SBarry Smith PetscInt its; 5527201da799SBarry Smith 5528201da799SBarry Smith PetscFunctionBegin; 5529201da799SBarry Smith if (!n) { 5530201da799SBarry Smith PetscDrawAxis axis; 5531bbd56ea5SKarl Rupp 5532201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5533201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 5534201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5535bbd56ea5SKarl Rupp 5536201da799SBarry Smith ctx->ksp_its = 0; 5537201da799SBarry Smith } 5538201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 5539201da799SBarry Smith y = its - ctx->ksp_its; 5540201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 554199fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 5542201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 5543201da799SBarry Smith } 5544201da799SBarry Smith ctx->ksp_its = its; 5545201da799SBarry Smith PetscFunctionReturn(0); 5546201da799SBarry Smith } 5547f9c1d6abSBarry Smith 5548f9c1d6abSBarry Smith #undef __FUNCT__ 5549f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 5550f9c1d6abSBarry Smith /*@ 5551f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 5552f9c1d6abSBarry Smith 5553f9c1d6abSBarry Smith Collective on TS and Vec 5554f9c1d6abSBarry Smith 5555f9c1d6abSBarry Smith Input Parameters: 5556f9c1d6abSBarry Smith + ts - the TS context 5557f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 5558f9c1d6abSBarry Smith 5559f9c1d6abSBarry Smith Output Parameters: 5560f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 5561f9c1d6abSBarry Smith 5562f9c1d6abSBarry Smith Level: developer 5563f9c1d6abSBarry Smith 5564f9c1d6abSBarry Smith .keywords: TS, compute 5565f9c1d6abSBarry Smith 5566f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 5567f9c1d6abSBarry Smith @*/ 5568f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 5569f9c1d6abSBarry Smith { 5570f9c1d6abSBarry Smith PetscErrorCode ierr; 5571f9c1d6abSBarry Smith 5572f9c1d6abSBarry Smith PetscFunctionBegin; 5573f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5574ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 5575f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 5576f9c1d6abSBarry Smith PetscFunctionReturn(0); 5577f9c1d6abSBarry Smith } 557824655328SShri 557924655328SShri #undef __FUNCT__ 558024655328SShri #define __FUNCT__ "TSRollBack" 558124655328SShri /*@ 558224655328SShri TSRollBack - Rolls back one time step 558324655328SShri 558424655328SShri Collective on TS 558524655328SShri 558624655328SShri Input Parameter: 558724655328SShri . ts - the TS context obtained from TSCreate() 558824655328SShri 558924655328SShri Level: advanced 559024655328SShri 559124655328SShri .keywords: TS, timestep, rollback 559224655328SShri 559324655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 559424655328SShri @*/ 559524655328SShri PetscErrorCode TSRollBack(TS ts) 559624655328SShri { 559724655328SShri PetscErrorCode ierr; 559824655328SShri 559924655328SShri PetscFunctionBegin; 560024655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 560124655328SShri 560224655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 560324655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 560424655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 560524655328SShri ts->ptime = ts->ptime_prev; 560624655328SShri PetscFunctionReturn(0); 560724655328SShri } 5608aeb4809dSShri Abhyankar 5609ff22ae23SHong Zhang #undef __FUNCT__ 5610ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages" 5611ff22ae23SHong Zhang /*@ 5612ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 5613ff22ae23SHong Zhang 5614ff22ae23SHong Zhang Input Parameter: 5615ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 5616ff22ae23SHong Zhang 5617ff22ae23SHong Zhang Level: advanced 5618ff22ae23SHong Zhang 5619ff22ae23SHong Zhang .keywords: TS, getstages 5620ff22ae23SHong Zhang 5621ff22ae23SHong Zhang .seealso: TSCreate() 5622ff22ae23SHong Zhang @*/ 5623ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns, Vec **Y) 5624ff22ae23SHong Zhang { 5625ff22ae23SHong Zhang PetscErrorCode ierr; 5626ff22ae23SHong Zhang 5627ff22ae23SHong Zhang PetscFunctionBegin; 5628ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 5629ff22ae23SHong Zhang PetscValidPointer(ns,2); 5630ff22ae23SHong Zhang 5631ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 5632ff22ae23SHong Zhang else { 5633ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 5634ff22ae23SHong Zhang } 5635ff22ae23SHong Zhang PetscFunctionReturn(0); 5636ff22ae23SHong Zhang } 5637ff22ae23SHong Zhang 5638