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 144a2ae208SSatish Balay #undef __FUNCT__ 15e55864a3SBarry Smith #define __FUNCT__ "TSSetTypeFromOptions_Private" 16bdad233fSMatthew Knepley /* 17bdad233fSMatthew Knepley TSSetTypeFromOptions - Sets the type of ts from user options. 18bdad233fSMatthew Knepley 19bdad233fSMatthew Knepley Collective on TS 20bdad233fSMatthew Knepley 21bdad233fSMatthew Knepley Input Parameter: 22bdad233fSMatthew Knepley . ts - The ts 23bdad233fSMatthew Knepley 24bdad233fSMatthew Knepley Level: intermediate 25bdad233fSMatthew Knepley 26bdad233fSMatthew Knepley .keywords: TS, set, options, database, type 27bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType() 28bdad233fSMatthew Knepley */ 298c34d3f5SBarry Smith static PetscErrorCode TSSetTypeFromOptions_Private(PetscOptions *PetscOptionsObject,TS ts) 30bdad233fSMatthew Knepley { 31ace3abfcSBarry Smith PetscBool opt; 322fc52814SBarry Smith const char *defaultType; 33bdad233fSMatthew Knepley char typeName[256]; 34dfbe8321SBarry Smith PetscErrorCode ierr; 35bdad233fSMatthew Knepley 36bdad233fSMatthew Knepley PetscFunctionBegin; 37bbd56ea5SKarl Rupp if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 38bbd56ea5SKarl Rupp else defaultType = TSEULER; 39bdad233fSMatthew Knepley 40607a6623SBarry Smith if (!TSRegisterAllCalled) {ierr = TSRegisterAll();CHKERRQ(ierr);} 41a264d7a6SBarry Smith ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr); 42a7cc72afSBarry Smith if (opt) { 43bdad233fSMatthew Knepley ierr = TSSetType(ts, typeName);CHKERRQ(ierr); 44bdad233fSMatthew Knepley } else { 45bdad233fSMatthew Knepley ierr = TSSetType(ts, defaultType);CHKERRQ(ierr); 46bdad233fSMatthew Knepley } 47bdad233fSMatthew Knepley PetscFunctionReturn(0); 48bdad233fSMatthew Knepley } 49bdad233fSMatthew Knepley 502d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx { 512d5ee99bSBarry Smith PetscViewer viewer; 524b363babSBarry Smith PetscDrawAxis axis; 532d5ee99bSBarry Smith Vec initialsolution; 542d5ee99bSBarry Smith PetscBool showinitial; 552d5ee99bSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 562d5ee99bSBarry Smith PetscBool showtimestepandtime; 572d5ee99bSBarry Smith int color; 582d5ee99bSBarry Smith }; 592d5ee99bSBarry Smith 60bdad233fSMatthew Knepley #undef __FUNCT__ 61bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions" 62bdad233fSMatthew Knepley /*@ 63bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 64bdad233fSMatthew Knepley 65bdad233fSMatthew Knepley Collective on TS 66bdad233fSMatthew Knepley 67bdad233fSMatthew Knepley Input Parameter: 68bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 69bdad233fSMatthew Knepley 70bdad233fSMatthew Knepley Options Database Keys: 714d91e141SJed Brown + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP 72d2daff3dSHong Zhang . -ts_checkpoint - checkpoint for adjoint sensitivity analysis 73bdad233fSMatthew Knepley . -ts_max_steps maxsteps - maximum number of time-steps to take 743bca7d26SBarry Smith . -ts_final_time time - maximum time to compute to 75bdad233fSMatthew Knepley . -ts_dt dt - initial time step 76a3cdaa26SBarry 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 77a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 78a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 79a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 80a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 81a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 82bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 83de06c3feSJed Brown . -ts_monitor_lg_timestep - Monitor timestep size graphically 84de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 85de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 86de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 87de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 88de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 89de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 902d5ee99bSBarry Smith . -ts_monitor_draw_solution_phase - Monitor solution graphically with phase diagram 91de06c3feSJed Brown . -ts_monitor_draw_error - Monitor error graphically 9291b97e58SBarry Smith . -ts_monitor_solution_binary <filename> - Save each solution to a binary file 9391b97e58SBarry Smith - -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts 9491b97e58SBarry Smith 9591b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 96bdad233fSMatthew Knepley 97bdad233fSMatthew Knepley Level: beginner 98bdad233fSMatthew Knepley 99bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 100bdad233fSMatthew Knepley 101a313700dSBarry Smith .seealso: TSGetType() 102bdad233fSMatthew Knepley @*/ 1037087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 104bdad233fSMatthew Knepley { 105ace3abfcSBarry Smith PetscBool opt,flg; 106dfbe8321SBarry Smith PetscErrorCode ierr; 107649052a6SBarry Smith PetscViewer monviewer; 108eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 109089b2837SJed Brown SNES snes; 1101c3436cfSJed Brown TSAdapt adapt; 11131748224SBarry Smith PetscReal time_step; 11249354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 113d1212d36SBarry Smith char dir[16]; 114bdad233fSMatthew Knepley 115bdad233fSMatthew Knepley PetscFunctionBegin; 1160700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1173194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 118a43b19c4SJed Brown /* Handle TS type options */ 119e55864a3SBarry Smith ierr = TSSetTypeFromOptions_Private(PetscOptionsObject,ts);CHKERRQ(ierr); 120bdad233fSMatthew Knepley 121bdad233fSMatthew Knepley /* Handle generic TS options */ 122d2daff3dSHong Zhang ierr = PetscOptionsBool("-ts_checkpoint","Checkpoint for adjoint sensitivity analysis","TSSetCheckpoint",ts->checkpoint,&ts->checkpoint,NULL);CHKERRQ(ierr); 1230298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1240298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 1250298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 12631748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 12731748224SBarry Smith if (flg) { 12831748224SBarry Smith ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 12931748224SBarry Smith } 13049354f04SShri 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); 13149354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1320298fd71SBarry 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); 1330298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1340298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1350298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1360298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 137bdad233fSMatthew Knepley 13856f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 13956f85f32SBarry Smith { 14056f85f32SBarry Smith PetscBool set; 14156f85f32SBarry Smith flg = PETSC_FALSE; 14256f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 14356f85f32SBarry Smith if (set) { 14456f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 14556f85f32SBarry Smith } 14656f85f32SBarry Smith } 14756f85f32SBarry Smith #endif 14856f85f32SBarry Smith 149bdad233fSMatthew Knepley /* Monitor options */ 150a6570f20SBarry Smith ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 151eabae89aSBarry Smith if (flg) { 152ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr); 153649052a6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 154bdad233fSMatthew Knepley } 1555180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1565180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1575180491cSLisandro Dalcin 1584f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 159a7cc72afSBarry Smith if (opt) { 1600b039ecaSBarry Smith TSMonitorLGCtx ctx; 1613923b477SBarry Smith PetscInt howoften = 1; 162a80ad3e0SBarry Smith 1630298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 164ce94432eSBarry Smith ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 1654f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 166b3603a34SBarry Smith } 1674f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 168b3603a34SBarry Smith if (opt) { 1690b039ecaSBarry Smith TSMonitorLGCtx ctx; 1703923b477SBarry Smith PetscInt howoften = 1; 171b3603a34SBarry Smith 1720298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 17322d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1744f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 175bdad233fSMatthew Knepley } 1764f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 177ef20d060SBarry Smith if (opt) { 1780b039ecaSBarry Smith TSMonitorLGCtx ctx; 1793923b477SBarry Smith PetscInt howoften = 1; 180ef20d060SBarry Smith 1810298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 18222d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 1834f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 184ef20d060SBarry Smith } 185201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 186201da799SBarry Smith if (opt) { 187201da799SBarry Smith TSMonitorLGCtx ctx; 188201da799SBarry Smith PetscInt howoften = 1; 189201da799SBarry Smith 1900298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 19122d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 192201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 193201da799SBarry Smith } 194201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 195201da799SBarry Smith if (opt) { 196201da799SBarry Smith TSMonitorLGCtx ctx; 197201da799SBarry Smith PetscInt howoften = 1; 198201da799SBarry Smith 1990298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 20022d28d08SBarry Smith ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 201201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 202201da799SBarry Smith } 2038189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2048189c53fSBarry Smith if (opt) { 2058189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2068189c53fSBarry Smith PetscInt howoften = 1; 2078189c53fSBarry Smith 2080298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 20922d28d08SBarry Smith ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 2108189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2118189c53fSBarry Smith } 212ef20d060SBarry Smith opt = PETSC_FALSE; 2130dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 214a7cc72afSBarry Smith if (opt) { 21583a4ac43SBarry Smith TSMonitorDrawCtx ctx; 21683a4ac43SBarry Smith PetscInt howoften = 1; 217a80ad3e0SBarry Smith 2180298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 219ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 22083a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 221bdad233fSMatthew Knepley } 222fb1732b5SBarry Smith opt = PETSC_FALSE; 2232d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2242d5ee99bSBarry Smith if (opt) { 2252d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2262d5ee99bSBarry Smith PetscReal bounds[4]; 2272d5ee99bSBarry Smith PetscInt n = 4; 2282d5ee99bSBarry Smith PetscDraw draw; 2292d5ee99bSBarry Smith 2302d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2312d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2322d5ee99bSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr); 2332d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2342d5ee99bSBarry Smith ierr = PetscDrawClear(draw);CHKERRQ(ierr); 2354b363babSBarry Smith ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr); 2364b363babSBarry Smith ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 237f54adfc0SBarry Smith ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2384b363babSBarry Smith ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr); 23907995780SPeter Brune /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */ 2402d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2412d5ee99bSBarry Smith } 2422d5ee99bSBarry Smith opt = PETSC_FALSE; 2430dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2443a471f94SBarry Smith if (opt) { 24583a4ac43SBarry Smith TSMonitorDrawCtx ctx; 24683a4ac43SBarry Smith PetscInt howoften = 1; 2473a471f94SBarry Smith 2480298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 249ce94432eSBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr); 25083a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2513a471f94SBarry Smith } 2523a471f94SBarry Smith opt = PETSC_FALSE; 25391b97e58SBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 254fb1732b5SBarry Smith if (flg) { 255fb1732b5SBarry Smith PetscViewer ctx; 256fb1732b5SBarry Smith if (monfilename[0]) { 257ce94432eSBarry Smith ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr); 258c2fbc07fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 259fb1732b5SBarry Smith } else { 260ce94432eSBarry Smith ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts)); 2610298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr); 262fb1732b5SBarry Smith } 263fb1732b5SBarry Smith } 264ed81e22dSJed Brown opt = PETSC_FALSE; 26591b97e58SBarry 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); 266ed81e22dSJed Brown if (flg) { 267ed81e22dSJed Brown const char *ptr,*ptr2; 268ed81e22dSJed Brown char *filetemplate; 269ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 270ed81e22dSJed Brown /* Do some cursory validation of the input. */ 271ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 272ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 273ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 274ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 275ce94432eSBarry 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"); 276ed81e22dSJed Brown if (ptr2) break; 277ed81e22dSJed Brown } 278ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 279ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 280ed81e22dSJed Brown } 281bdad233fSMatthew Knepley 282d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 283d1212d36SBarry Smith if (flg) { 284d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 285d1212d36SBarry Smith int ray = 0; 286d1212d36SBarry Smith DMDADirection ddir; 287d1212d36SBarry Smith DM da; 288d1212d36SBarry Smith PetscMPIInt rank; 289d1212d36SBarry Smith 290ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 291d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 292d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 293ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 294d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 295d1212d36SBarry Smith 296d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 297b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 298d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 299d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 300ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 301d1212d36SBarry Smith if (!rank) { 302d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 303d1212d36SBarry Smith } 30451b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 305d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 306d1212d36SBarry Smith } 30751b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 30851b4a12fSMatthew G. Knepley if (flg) { 30951b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 31051b4a12fSMatthew G. Knepley int ray = 0; 31151b4a12fSMatthew G. Knepley DMDADirection ddir; 31251b4a12fSMatthew G. Knepley DM da; 31351b4a12fSMatthew G. Knepley PetscInt howoften = 1; 314d1212d36SBarry Smith 31551b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 31651b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 31751b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 31851b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 31951b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 32051b4a12fSMatthew G. Knepley 32151b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 322b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 32351b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 32451b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 32551b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 32651b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 32751b4a12fSMatthew G. Knepley } 328a7a1495cSBarry Smith 3297781c08eSBarry Smith /* 3307781c08eSBarry Smith This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui 3317781c08eSBarry Smith will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin() 3327781c08eSBarry Smith */ 333552698daSJed Brown ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr); 334e55864a3SBarry Smith ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr); 335d763cef2SBarry Smith 336d763cef2SBarry Smith ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 337d763cef2SBarry Smith if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);} 338d763cef2SBarry Smith 339d763cef2SBarry Smith /* Handle specific TS options */ 340d763cef2SBarry Smith if (ts->ops->setfromoptions) { 341e55864a3SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 342d763cef2SBarry Smith } 343d763cef2SBarry Smith 344d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 345d763cef2SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr); 346d763cef2SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 347d763cef2SBarry Smith PetscFunctionReturn(0); 348d763cef2SBarry Smith } 349d763cef2SBarry Smith 350d763cef2SBarry Smith #undef __FUNCT__ 351d2daff3dSHong Zhang #define __FUNCT__ "TSSetCheckpoint" 352d2daff3dSHong Zhang /*@ 353d2daff3dSHong Zhang TSSetCheckpoint - Allows one to checkpoint the forward run, 354d2daff3dSHong Zhang useful for adjoint sensitivity analysis. 355d2daff3dSHong Zhang 356d2daff3dSHong Zhang Collective on TS 357d2daff3dSHong Zhang 358d2daff3dSHong Zhang Input Parameters: 359d2daff3dSHong Zhang + ts - the TS context obtained from TSCreate() 360d2daff3dSHong Zhang - checkpoint - flag that indicates if the forward solution will be checkpointed 361d2daff3dSHong Zhang 362d2daff3dSHong Zhang Level: intermediate 363d2daff3dSHong Zhang 364d2daff3dSHong Zhang .seealso: 365d2daff3dSHong Zhang 366d2daff3dSHong Zhang .keywords: TS, set, checkpoint 367d2daff3dSHong Zhang @*/ 368d2daff3dSHong Zhang PetscErrorCode TSSetCheckpoint(TS ts,PetscBool checkpoint) 369d2daff3dSHong Zhang { 370d2daff3dSHong Zhang PetscFunctionBegin; 371d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 372d2daff3dSHong Zhang ts->checkpoint = checkpoint; 373d2daff3dSHong Zhang PetscFunctionReturn(0); 374d2daff3dSHong Zhang } 375d2daff3dSHong Zhang 376d2daff3dSHong Zhang #undef __FUNCT__ 377d2daff3dSHong Zhang #define __FUNCT__ "TSSetReverseMode" 378d2daff3dSHong Zhang /*@ 379e6ad8bfbSHong Zhang TSSetReverseMode - Allows one to reset the run mode, 380d2daff3dSHong Zhang useful for adjoint sensitivity analysis. 381d2daff3dSHong Zhang 382d2daff3dSHong Zhang Collective on TS 383d2daff3dSHong Zhang 384d2daff3dSHong Zhang Input Parameters: 385d2daff3dSHong Zhang + ts - the TS context obtained from TSCreate() 386d2daff3dSHong Zhang - reverse_mode - run in forward (default) or reverse mode 387d2daff3dSHong Zhang 388d2daff3dSHong Zhang Level: intermediate 389d2daff3dSHong Zhang 390d2daff3dSHong Zhang .seealso: 391d2daff3dSHong Zhang 392d2daff3dSHong Zhang .keywords: TS, set, reverse 393d2daff3dSHong Zhang @*/ 394d2daff3dSHong Zhang PetscErrorCode TSSetReverseMode(TS ts,PetscBool reverse_mode) 395d2daff3dSHong Zhang { 396f8fee759SHong Zhang PetscErrorCode ierr; 397d2daff3dSHong Zhang PetscFunctionBegin; 398d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 399d2daff3dSHong Zhang ts->reverse_mode = reverse_mode; 400f8fee759SHong Zhang ts->setupcalled = PETSC_FALSE; 401f8fee759SHong Zhang ierr = TSSetUp(ts);CHKERRQ(ierr); 402d2daff3dSHong Zhang PetscFunctionReturn(0); 403d2daff3dSHong Zhang } 404d2daff3dSHong Zhang 405a7a1495cSBarry Smith #undef __FUNCT__ 406a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian" 407a7a1495cSBarry Smith /*@ 408a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 409a7a1495cSBarry Smith set with TSSetRHSJacobian(). 410a7a1495cSBarry Smith 411a7a1495cSBarry Smith Collective on TS and Vec 412a7a1495cSBarry Smith 413a7a1495cSBarry Smith Input Parameters: 414316643e7SJed Brown + ts - the TS context 415a7a1495cSBarry Smith . t - current timestep 4160910c330SBarry Smith - U - input vector 417a7a1495cSBarry Smith 418a7a1495cSBarry Smith Output Parameters: 419a7a1495cSBarry Smith + A - Jacobian matrix 420a7a1495cSBarry Smith . B - optional preconditioning matrix 421a7a1495cSBarry Smith - flag - flag indicating matrix structure 422a7a1495cSBarry Smith 423a7a1495cSBarry Smith Notes: 424a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 425a7a1495cSBarry Smith is used internally within the nonlinear solvers. 426a7a1495cSBarry Smith 42794b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 428a7a1495cSBarry Smith flag parameter. 429a7a1495cSBarry Smith 430a7a1495cSBarry Smith Level: developer 431a7a1495cSBarry Smith 432a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 433a7a1495cSBarry Smith 43494b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 435a7a1495cSBarry Smith @*/ 436d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 437a7a1495cSBarry Smith { 438dfbe8321SBarry Smith PetscErrorCode ierr; 439270bf2e7SJed Brown PetscObjectState Ustate; 44024989b8cSPeter Brune DM dm; 441942e3340SBarry Smith DMTS tsdm; 44224989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 44324989b8cSPeter Brune void *ctx; 44424989b8cSPeter Brune TSIJacobian ijacobianfunc; 445a7a1495cSBarry Smith 446a7a1495cSBarry Smith PetscFunctionBegin; 4470700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4480910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4490910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 45024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 451942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 45224989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 4530298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 45459e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 4550910c330SBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) { 4560e4ef248SJed Brown PetscFunctionReturn(0); 457f8ede8e7SJed Brown } 458d90be118SSean Farley 459ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 460d90be118SSean Farley 461e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 46294ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 46394ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 46494ab13aaSBarry Smith if (A != B) { 46594ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 46694ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 467e1244c69SJed Brown } 468e1244c69SJed Brown ts->rhsjacobian.shift = 0; 469e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 470e1244c69SJed Brown } 471e1244c69SJed Brown 47224989b8cSPeter Brune if (rhsjacobianfunc) { 47394ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 474a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 475d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 476a7a1495cSBarry Smith PetscStackPop; 47794ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 478a7a1495cSBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 47994ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 48094ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 481ef66eb69SBarry Smith } else { 48294ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 48394ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 484ef66eb69SBarry Smith } 4850e4ef248SJed Brown ts->rhsjacobian.time = t; 4860910c330SBarry Smith ts->rhsjacobian.X = U; 48759e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 488a7a1495cSBarry Smith PetscFunctionReturn(0); 489a7a1495cSBarry Smith } 490a7a1495cSBarry Smith 4914a2ae208SSatish Balay #undef __FUNCT__ 4924a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction" 493316643e7SJed Brown /*@ 494d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 495d763cef2SBarry Smith 496316643e7SJed Brown Collective on TS and Vec 497316643e7SJed Brown 498316643e7SJed Brown Input Parameters: 499316643e7SJed Brown + ts - the TS context 500316643e7SJed Brown . t - current time 5010910c330SBarry Smith - U - state vector 502316643e7SJed Brown 503316643e7SJed Brown Output Parameter: 504316643e7SJed Brown . y - right hand side 505316643e7SJed Brown 506316643e7SJed Brown Note: 507316643e7SJed Brown Most users should not need to explicitly call this routine, as it 508316643e7SJed Brown is used internally within the nonlinear solvers. 509316643e7SJed Brown 510316643e7SJed Brown Level: developer 511316643e7SJed Brown 512316643e7SJed Brown .keywords: TS, compute 513316643e7SJed Brown 514316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 515316643e7SJed Brown @*/ 5160910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 517d763cef2SBarry Smith { 518dfbe8321SBarry Smith PetscErrorCode ierr; 51924989b8cSPeter Brune TSRHSFunction rhsfunction; 52024989b8cSPeter Brune TSIFunction ifunction; 52124989b8cSPeter Brune void *ctx; 52224989b8cSPeter Brune DM dm; 52324989b8cSPeter Brune 524d763cef2SBarry Smith PetscFunctionBegin; 5250700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5260910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5270700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 52824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 52924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 5300298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 531d763cef2SBarry Smith 532ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 533d763cef2SBarry Smith 5340910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 53524989b8cSPeter Brune if (rhsfunction) { 536d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 5370910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 538d763cef2SBarry Smith PetscStackPop; 539214bc6a2SJed Brown } else { 540214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 541b2cd27e8SJed Brown } 54244a41b28SSean Farley 5430910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 544d763cef2SBarry Smith PetscFunctionReturn(0); 545d763cef2SBarry Smith } 546d763cef2SBarry Smith 5474a2ae208SSatish Balay #undef __FUNCT__ 548ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction" 549ef20d060SBarry Smith /*@ 550ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 551ef20d060SBarry Smith 552ef20d060SBarry Smith Collective on TS and Vec 553ef20d060SBarry Smith 554ef20d060SBarry Smith Input Parameters: 555ef20d060SBarry Smith + ts - the TS context 556ef20d060SBarry Smith - t - current time 557ef20d060SBarry Smith 558ef20d060SBarry Smith Output Parameter: 5590910c330SBarry Smith . U - the solution 560ef20d060SBarry Smith 561ef20d060SBarry Smith Note: 562ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 563ef20d060SBarry Smith is used internally within the nonlinear solvers. 564ef20d060SBarry Smith 565ef20d060SBarry Smith Level: developer 566ef20d060SBarry Smith 567ef20d060SBarry Smith .keywords: TS, compute 568ef20d060SBarry Smith 569abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 570ef20d060SBarry Smith @*/ 5710910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 572ef20d060SBarry Smith { 573ef20d060SBarry Smith PetscErrorCode ierr; 574ef20d060SBarry Smith TSSolutionFunction solutionfunction; 575ef20d060SBarry Smith void *ctx; 576ef20d060SBarry Smith DM dm; 577ef20d060SBarry Smith 578ef20d060SBarry Smith PetscFunctionBegin; 579ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5800910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 581ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 582ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 583ef20d060SBarry Smith 584ef20d060SBarry Smith if (solutionfunction) { 5859b7cd975SBarry Smith PetscStackPush("TS user solution function"); 5860910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 587ef20d060SBarry Smith PetscStackPop; 588ef20d060SBarry Smith } 589ef20d060SBarry Smith PetscFunctionReturn(0); 590ef20d060SBarry Smith } 5919b7cd975SBarry Smith #undef __FUNCT__ 5929b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction" 5939b7cd975SBarry Smith /*@ 5949b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 5959b7cd975SBarry Smith 5969b7cd975SBarry Smith Collective on TS and Vec 5979b7cd975SBarry Smith 5989b7cd975SBarry Smith Input Parameters: 5999b7cd975SBarry Smith + ts - the TS context 6009b7cd975SBarry Smith - t - current time 6019b7cd975SBarry Smith 6029b7cd975SBarry Smith Output Parameter: 6039b7cd975SBarry Smith . U - the function value 6049b7cd975SBarry Smith 6059b7cd975SBarry Smith Note: 6069b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 6079b7cd975SBarry Smith is used internally within the nonlinear solvers. 6089b7cd975SBarry Smith 6099b7cd975SBarry Smith Level: developer 6109b7cd975SBarry Smith 6119b7cd975SBarry Smith .keywords: TS, compute 6129b7cd975SBarry Smith 6139b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 6149b7cd975SBarry Smith @*/ 6159b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 6169b7cd975SBarry Smith { 6179b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 6189b7cd975SBarry Smith void *ctx; 6199b7cd975SBarry Smith DM dm; 6209b7cd975SBarry Smith 6219b7cd975SBarry Smith PetscFunctionBegin; 6229b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6239b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6249b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 6259b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 6269b7cd975SBarry Smith 6279b7cd975SBarry Smith if (forcing) { 6289b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 6299b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 6309b7cd975SBarry Smith PetscStackPop; 6319b7cd975SBarry Smith } 6329b7cd975SBarry Smith PetscFunctionReturn(0); 6339b7cd975SBarry Smith } 634ef20d060SBarry Smith 635ef20d060SBarry Smith #undef __FUNCT__ 636214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private" 637214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 638214bc6a2SJed Brown { 6392dd45cf8SJed Brown Vec F; 640214bc6a2SJed Brown PetscErrorCode ierr; 641214bc6a2SJed Brown 642214bc6a2SJed Brown PetscFunctionBegin; 6430298fd71SBarry Smith *Frhs = NULL; 6440298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 645214bc6a2SJed Brown if (!ts->Frhs) { 6462dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 647214bc6a2SJed Brown } 648214bc6a2SJed Brown *Frhs = ts->Frhs; 649214bc6a2SJed Brown PetscFunctionReturn(0); 650214bc6a2SJed Brown } 651214bc6a2SJed Brown 652214bc6a2SJed Brown #undef __FUNCT__ 653214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private" 654214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 655214bc6a2SJed Brown { 656214bc6a2SJed Brown Mat A,B; 6572dd45cf8SJed Brown PetscErrorCode ierr; 658214bc6a2SJed Brown 659214bc6a2SJed Brown PetscFunctionBegin; 660c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 661c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 6620298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 663214bc6a2SJed Brown if (Arhs) { 664214bc6a2SJed Brown if (!ts->Arhs) { 665214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 666214bc6a2SJed Brown } 667214bc6a2SJed Brown *Arhs = ts->Arhs; 668214bc6a2SJed Brown } 669214bc6a2SJed Brown if (Brhs) { 670214bc6a2SJed Brown if (!ts->Brhs) { 671bdb70873SJed Brown if (A != B) { 672214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 673bdb70873SJed Brown } else { 674bdb70873SJed Brown ts->Brhs = ts->Arhs; 675bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 676bdb70873SJed Brown } 677214bc6a2SJed Brown } 678214bc6a2SJed Brown *Brhs = ts->Brhs; 679214bc6a2SJed Brown } 680214bc6a2SJed Brown PetscFunctionReturn(0); 681214bc6a2SJed Brown } 682214bc6a2SJed Brown 683214bc6a2SJed Brown #undef __FUNCT__ 684316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction" 685316643e7SJed Brown /*@ 6860910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 687316643e7SJed Brown 688316643e7SJed Brown Collective on TS and Vec 689316643e7SJed Brown 690316643e7SJed Brown Input Parameters: 691316643e7SJed Brown + ts - the TS context 692316643e7SJed Brown . t - current time 6930910c330SBarry Smith . U - state vector 6940910c330SBarry Smith . Udot - time derivative of state vector 695214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 696316643e7SJed Brown 697316643e7SJed Brown Output Parameter: 698316643e7SJed Brown . Y - right hand side 699316643e7SJed Brown 700316643e7SJed Brown Note: 701316643e7SJed Brown Most users should not need to explicitly call this routine, as it 702316643e7SJed Brown is used internally within the nonlinear solvers. 703316643e7SJed Brown 704316643e7SJed Brown If the user did did not write their equations in implicit form, this 705316643e7SJed Brown function recasts them in implicit form. 706316643e7SJed Brown 707316643e7SJed Brown Level: developer 708316643e7SJed Brown 709316643e7SJed Brown .keywords: TS, compute 710316643e7SJed Brown 711316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 712316643e7SJed Brown @*/ 7130910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 714316643e7SJed Brown { 715316643e7SJed Brown PetscErrorCode ierr; 71624989b8cSPeter Brune TSIFunction ifunction; 71724989b8cSPeter Brune TSRHSFunction rhsfunction; 71824989b8cSPeter Brune void *ctx; 71924989b8cSPeter Brune DM dm; 720316643e7SJed Brown 721316643e7SJed Brown PetscFunctionBegin; 7220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7230910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7240910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 7250700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 726316643e7SJed Brown 72724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 72824989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 7290298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 73024989b8cSPeter Brune 731ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 732d90be118SSean Farley 7330910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 73424989b8cSPeter Brune if (ifunction) { 735316643e7SJed Brown PetscStackPush("TS user implicit function"); 7360910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 737316643e7SJed Brown PetscStackPop; 738214bc6a2SJed Brown } 739214bc6a2SJed Brown if (imex) { 74024989b8cSPeter Brune if (!ifunction) { 7410910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 7422dd45cf8SJed Brown } 74324989b8cSPeter Brune } else if (rhsfunction) { 74424989b8cSPeter Brune if (ifunction) { 745214bc6a2SJed Brown Vec Frhs; 746214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 7470910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 748214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 7492dd45cf8SJed Brown } else { 7500910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 7510910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 752316643e7SJed Brown } 7534a6899ffSJed Brown } 7540910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 755316643e7SJed Brown PetscFunctionReturn(0); 756316643e7SJed Brown } 757316643e7SJed Brown 758316643e7SJed Brown #undef __FUNCT__ 759316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian" 760316643e7SJed Brown /*@ 761316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 762316643e7SJed Brown 763316643e7SJed Brown Collective on TS and Vec 764316643e7SJed Brown 765316643e7SJed Brown Input 766316643e7SJed Brown Input Parameters: 767316643e7SJed Brown + ts - the TS context 768316643e7SJed Brown . t - current timestep 7690910c330SBarry Smith . U - state vector 7700910c330SBarry Smith . Udot - time derivative of state vector 771214bc6a2SJed Brown . shift - shift to apply, see note below 772214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 773316643e7SJed Brown 774316643e7SJed Brown Output Parameters: 775316643e7SJed Brown + A - Jacobian matrix 776316643e7SJed Brown . B - optional preconditioning matrix 777316643e7SJed Brown - flag - flag indicating matrix structure 778316643e7SJed Brown 779316643e7SJed Brown Notes: 7800910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 781316643e7SJed Brown 7820910c330SBarry Smith dF/dU + shift*dF/dUdot 783316643e7SJed Brown 784316643e7SJed Brown Most users should not need to explicitly call this routine, as it 785316643e7SJed Brown is used internally within the nonlinear solvers. 786316643e7SJed Brown 787316643e7SJed Brown Level: developer 788316643e7SJed Brown 789316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 790316643e7SJed Brown 791316643e7SJed Brown .seealso: TSSetIJacobian() 79263495f91SJed Brown @*/ 793d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 794316643e7SJed Brown { 795316643e7SJed Brown PetscErrorCode ierr; 79624989b8cSPeter Brune TSIJacobian ijacobian; 79724989b8cSPeter Brune TSRHSJacobian rhsjacobian; 79824989b8cSPeter Brune DM dm; 79924989b8cSPeter Brune void *ctx; 800316643e7SJed Brown 801316643e7SJed Brown PetscFunctionBegin; 8020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8030910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8040910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 805316643e7SJed Brown PetscValidPointer(A,6); 80694ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 807316643e7SJed Brown PetscValidPointer(B,7); 80894ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 80924989b8cSPeter Brune 81024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 81124989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 8120298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 81324989b8cSPeter Brune 814ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 815316643e7SJed Brown 81694ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 81724989b8cSPeter Brune if (ijacobian) { 818316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 819d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 820316643e7SJed Brown PetscStackPop; 821214bc6a2SJed Brown /* make sure user returned a correct Jacobian and preconditioner */ 82294ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,4); 82394ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,5); 8244a6899ffSJed Brown } 825214bc6a2SJed Brown if (imex) { 826b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 82794ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 82894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 82994ab13aaSBarry Smith if (A != B) { 83094ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 83194ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 832214bc6a2SJed Brown } 833214bc6a2SJed Brown } 834214bc6a2SJed Brown } else { 835e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 836e1244c69SJed Brown if (rhsjacobian) { 837bd373395SBarry Smith if (ijacobian) { 838e1244c69SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 839bd373395SBarry Smith } else { 840bd373395SBarry Smith ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr); 841e1244c69SJed Brown } 842d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 843e1244c69SJed Brown } 84494ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 845e1244c69SJed Brown ts->rhsjacobian.scale = -1; 846e1244c69SJed Brown ts->rhsjacobian.shift = shift; 84794ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 84894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 84994ab13aaSBarry Smith if (A != B) { 85094ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 85194ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 852316643e7SJed Brown } 853e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 854e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 855e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 85694ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 85794ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 85894ab13aaSBarry Smith if (A != B) { 85994ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 86094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 861e1244c69SJed Brown } 862e1244c69SJed Brown } 86394ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 86494ab13aaSBarry Smith if (A != B) { 86594ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 866214bc6a2SJed Brown } 867316643e7SJed Brown } 868316643e7SJed Brown } 86994ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 870316643e7SJed Brown PetscFunctionReturn(0); 871316643e7SJed Brown } 872316643e7SJed Brown 873316643e7SJed Brown #undef __FUNCT__ 8744a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction" 875d763cef2SBarry Smith /*@C 876d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 877b5abc632SBarry Smith where U_t = G(t,u). 878d763cef2SBarry Smith 8793f9fe445SBarry Smith Logically Collective on TS 880d763cef2SBarry Smith 881d763cef2SBarry Smith Input Parameters: 882d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 8830298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 884d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 885d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 8860298fd71SBarry Smith function evaluation routine (may be NULL) 887d763cef2SBarry Smith 888d763cef2SBarry Smith Calling sequence of func: 88987828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 890d763cef2SBarry Smith 891d763cef2SBarry Smith + t - current timestep 892d763cef2SBarry Smith . u - input vector 893d763cef2SBarry Smith . F - function vector 894d763cef2SBarry Smith - ctx - [optional] user-defined function context 895d763cef2SBarry Smith 896d763cef2SBarry Smith Level: beginner 897d763cef2SBarry Smith 898d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 899d763cef2SBarry Smith 900ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 901d763cef2SBarry Smith @*/ 902089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 903d763cef2SBarry Smith { 904089b2837SJed Brown PetscErrorCode ierr; 905089b2837SJed Brown SNES snes; 9060298fd71SBarry Smith Vec ralloc = NULL; 90724989b8cSPeter Brune DM dm; 908d763cef2SBarry Smith 909089b2837SJed Brown PetscFunctionBegin; 9100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 911ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 91224989b8cSPeter Brune 91324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 91424989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 915089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 916e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 917e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 918e856ceecSJed Brown r = ralloc; 919e856ceecSJed Brown } 920089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 921e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 922d763cef2SBarry Smith PetscFunctionReturn(0); 923d763cef2SBarry Smith } 924d763cef2SBarry Smith 9254a2ae208SSatish Balay #undef __FUNCT__ 926ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction" 927ef20d060SBarry Smith /*@C 928abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 929ef20d060SBarry Smith 930ef20d060SBarry Smith Logically Collective on TS 931ef20d060SBarry Smith 932ef20d060SBarry Smith Input Parameters: 933ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 934ef20d060SBarry Smith . f - routine for evaluating the solution 935ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 9360298fd71SBarry Smith function evaluation routine (may be NULL) 937ef20d060SBarry Smith 938ef20d060SBarry Smith Calling sequence of func: 939ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 940ef20d060SBarry Smith 941ef20d060SBarry Smith + t - current timestep 942ef20d060SBarry Smith . u - output vector 943ef20d060SBarry Smith - ctx - [optional] user-defined function context 944ef20d060SBarry Smith 945abd5a294SJed Brown Notes: 946abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 947abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 948abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 949abd5a294SJed Brown 9504f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 951abd5a294SJed Brown 952ef20d060SBarry Smith Level: beginner 953ef20d060SBarry Smith 954ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 955ef20d060SBarry Smith 9569b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 957ef20d060SBarry Smith @*/ 958ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 959ef20d060SBarry Smith { 960ef20d060SBarry Smith PetscErrorCode ierr; 961ef20d060SBarry Smith DM dm; 962ef20d060SBarry Smith 963ef20d060SBarry Smith PetscFunctionBegin; 964ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 965ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 966ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 967ef20d060SBarry Smith PetscFunctionReturn(0); 968ef20d060SBarry Smith } 969ef20d060SBarry Smith 970ef20d060SBarry Smith #undef __FUNCT__ 9719b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction" 9729b7cd975SBarry Smith /*@C 9739b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 9749b7cd975SBarry Smith 9759b7cd975SBarry Smith Logically Collective on TS 9769b7cd975SBarry Smith 9779b7cd975SBarry Smith Input Parameters: 9789b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 9799b7cd975SBarry Smith . f - routine for evaluating the forcing function 9809b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 9810298fd71SBarry Smith function evaluation routine (may be NULL) 9829b7cd975SBarry Smith 9839b7cd975SBarry Smith Calling sequence of func: 9849b7cd975SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 9859b7cd975SBarry Smith 9869b7cd975SBarry Smith + t - current timestep 9879b7cd975SBarry Smith . u - output vector 9889b7cd975SBarry Smith - ctx - [optional] user-defined function context 9899b7cd975SBarry Smith 9909b7cd975SBarry Smith Notes: 9919b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 9929b7cd975SBarry Smith create closed-form solutions with a non-physical forcing term. 9939b7cd975SBarry Smith 9949b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 9959b7cd975SBarry Smith 9969b7cd975SBarry Smith Level: beginner 9979b7cd975SBarry Smith 9989b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 9999b7cd975SBarry Smith 10009b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 10019b7cd975SBarry Smith @*/ 10029b7cd975SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 10039b7cd975SBarry Smith { 10049b7cd975SBarry Smith PetscErrorCode ierr; 10059b7cd975SBarry Smith DM dm; 10069b7cd975SBarry Smith 10079b7cd975SBarry Smith PetscFunctionBegin; 10089b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 10099b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 10109b7cd975SBarry Smith ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr); 10119b7cd975SBarry Smith PetscFunctionReturn(0); 10129b7cd975SBarry Smith } 10139b7cd975SBarry Smith 10149b7cd975SBarry Smith #undef __FUNCT__ 10154a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian" 1016d763cef2SBarry Smith /*@C 1017d763cef2SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of F, 1018b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1019d763cef2SBarry Smith 10203f9fe445SBarry Smith Logically Collective on TS 1021d763cef2SBarry Smith 1022d763cef2SBarry Smith Input Parameters: 1023d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1024e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1025e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1026d763cef2SBarry Smith . f - the Jacobian evaluation routine 1027d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10280298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1029d763cef2SBarry Smith 1030d763cef2SBarry Smith Calling sequence of func: 1031ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1032d763cef2SBarry Smith 1033d763cef2SBarry Smith + t - current timestep 1034d763cef2SBarry Smith . u - input vector 1035e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1036e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1037d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1038d763cef2SBarry Smith 1039d763cef2SBarry Smith 1040d763cef2SBarry Smith Level: beginner 1041d763cef2SBarry Smith 1042d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1043d763cef2SBarry Smith 1044ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1045d763cef2SBarry Smith 1046d763cef2SBarry Smith @*/ 1047e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1048d763cef2SBarry Smith { 1049277b19d0SLisandro Dalcin PetscErrorCode ierr; 1050089b2837SJed Brown SNES snes; 105124989b8cSPeter Brune DM dm; 105224989b8cSPeter Brune TSIJacobian ijacobian; 1053277b19d0SLisandro Dalcin 1054d763cef2SBarry Smith PetscFunctionBegin; 10550700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1056e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1057e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1058e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1059e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1060d763cef2SBarry Smith 106124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 106224989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1063e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1064e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1065e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1066e1244c69SJed Brown } 10670298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1068089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 10695f659677SPeter Brune if (!ijacobian) { 1070e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 10710e4ef248SJed Brown } 1072e5d3d808SBarry Smith if (Amat) { 1073e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 10740e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1075bbd56ea5SKarl Rupp 1076e5d3d808SBarry Smith ts->Arhs = Amat; 10770e4ef248SJed Brown } 1078e5d3d808SBarry Smith if (Pmat) { 1079e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 10800e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1081bbd56ea5SKarl Rupp 1082e5d3d808SBarry Smith ts->Brhs = Pmat; 10830e4ef248SJed Brown } 1084d763cef2SBarry Smith PetscFunctionReturn(0); 1085d763cef2SBarry Smith } 1086d763cef2SBarry Smith 1087316643e7SJed Brown 1088316643e7SJed Brown #undef __FUNCT__ 1089316643e7SJed Brown #define __FUNCT__ "TSSetIFunction" 1090316643e7SJed Brown /*@C 1091b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1092316643e7SJed Brown 10933f9fe445SBarry Smith Logically Collective on TS 1094316643e7SJed Brown 1095316643e7SJed Brown Input Parameters: 1096316643e7SJed Brown + ts - the TS context obtained from TSCreate() 10970298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1098316643e7SJed Brown . f - the function evaluation routine 10990298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1100316643e7SJed Brown 1101316643e7SJed Brown Calling sequence of f: 1102316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1103316643e7SJed Brown 1104316643e7SJed Brown + t - time at step/stage being solved 1105316643e7SJed Brown . u - state vector 1106316643e7SJed Brown . u_t - time derivative of state vector 1107316643e7SJed Brown . F - function vector 1108316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1109316643e7SJed Brown 1110316643e7SJed Brown Important: 1111d6cbdb99SBarry Smith The user MUST call either this routine, TSSetRHSFunction(). This routine must be used when not solving an ODE, for example a DAE. 1112316643e7SJed Brown 1113316643e7SJed Brown Level: beginner 1114316643e7SJed Brown 1115316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1116316643e7SJed Brown 1117d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1118316643e7SJed Brown @*/ 1119089b2837SJed Brown PetscErrorCode TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx) 1120316643e7SJed Brown { 1121089b2837SJed Brown PetscErrorCode ierr; 1122089b2837SJed Brown SNES snes; 11230298fd71SBarry Smith Vec resalloc = NULL; 112424989b8cSPeter Brune DM dm; 1125316643e7SJed Brown 1126316643e7SJed Brown PetscFunctionBegin; 11270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1128ca94891dSJed Brown if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2); 112924989b8cSPeter Brune 113024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 113124989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 113224989b8cSPeter Brune 1133089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1134e856ceecSJed Brown if (!res && !ts->dm && ts->vec_sol) { 1135e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr); 1136e856ceecSJed Brown res = resalloc; 1137e856ceecSJed Brown } 1138089b2837SJed Brown ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr); 1139e856ceecSJed Brown ierr = VecDestroy(&resalloc);CHKERRQ(ierr); 1140089b2837SJed Brown PetscFunctionReturn(0); 1141089b2837SJed Brown } 1142089b2837SJed Brown 1143089b2837SJed Brown #undef __FUNCT__ 1144089b2837SJed Brown #define __FUNCT__ "TSGetIFunction" 1145089b2837SJed Brown /*@C 1146089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1147089b2837SJed Brown 1148089b2837SJed Brown Not Collective 1149089b2837SJed Brown 1150089b2837SJed Brown Input Parameter: 1151089b2837SJed Brown . ts - the TS context 1152089b2837SJed Brown 1153089b2837SJed Brown Output Parameter: 11540298fd71SBarry Smith + r - vector to hold residual (or NULL) 11550298fd71SBarry Smith . func - the function to compute residual (or NULL) 11560298fd71SBarry Smith - ctx - the function context (or NULL) 1157089b2837SJed Brown 1158089b2837SJed Brown Level: advanced 1159089b2837SJed Brown 1160089b2837SJed Brown .keywords: TS, nonlinear, get, function 1161089b2837SJed Brown 1162089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1163089b2837SJed Brown @*/ 1164089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1165089b2837SJed Brown { 1166089b2837SJed Brown PetscErrorCode ierr; 1167089b2837SJed Brown SNES snes; 116824989b8cSPeter Brune DM dm; 1169089b2837SJed Brown 1170089b2837SJed Brown PetscFunctionBegin; 1171089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1172089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11730298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 117424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 117524989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1176089b2837SJed Brown PetscFunctionReturn(0); 1177089b2837SJed Brown } 1178089b2837SJed Brown 1179089b2837SJed Brown #undef __FUNCT__ 1180089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction" 1181089b2837SJed Brown /*@C 1182089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1183089b2837SJed Brown 1184089b2837SJed Brown Not Collective 1185089b2837SJed Brown 1186089b2837SJed Brown Input Parameter: 1187089b2837SJed Brown . ts - the TS context 1188089b2837SJed Brown 1189089b2837SJed Brown Output Parameter: 11900298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 11910298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 11920298fd71SBarry Smith - ctx - the function context (or NULL) 1193089b2837SJed Brown 1194089b2837SJed Brown Level: advanced 1195089b2837SJed Brown 1196089b2837SJed Brown .keywords: TS, nonlinear, get, function 1197089b2837SJed Brown 1198089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction() 1199089b2837SJed Brown @*/ 1200089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1201089b2837SJed Brown { 1202089b2837SJed Brown PetscErrorCode ierr; 1203089b2837SJed Brown SNES snes; 120424989b8cSPeter Brune DM dm; 1205089b2837SJed Brown 1206089b2837SJed Brown PetscFunctionBegin; 1207089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1208089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12090298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 121024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 121124989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1212316643e7SJed Brown PetscFunctionReturn(0); 1213316643e7SJed Brown } 1214316643e7SJed Brown 1215316643e7SJed Brown #undef __FUNCT__ 1216316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian" 1217316643e7SJed Brown /*@C 1218a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1219ae8867d6SBarry Smith provided with TSSetIFunction(). 1220316643e7SJed Brown 12213f9fe445SBarry Smith Logically Collective on TS 1222316643e7SJed Brown 1223316643e7SJed Brown Input Parameters: 1224316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1225e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1226e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1227316643e7SJed Brown . f - the Jacobian evaluation routine 12280298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1229316643e7SJed Brown 1230316643e7SJed Brown Calling sequence of f: 1231ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1232316643e7SJed Brown 1233316643e7SJed Brown + t - time at step/stage being solved 12341b4a444bSJed Brown . U - state vector 12351b4a444bSJed Brown . U_t - time derivative of state vector 1236316643e7SJed Brown . a - shift 1237e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1238e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1239316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1240316643e7SJed Brown 1241316643e7SJed Brown Notes: 1242e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1243316643e7SJed Brown 1244a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1245b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1246a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1247a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1248a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1249a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1250a4f0a591SBarry Smith 1251316643e7SJed Brown Level: beginner 1252316643e7SJed Brown 1253316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1254316643e7SJed Brown 1255ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1256316643e7SJed Brown 1257316643e7SJed Brown @*/ 1258e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1259316643e7SJed Brown { 1260316643e7SJed Brown PetscErrorCode ierr; 1261089b2837SJed Brown SNES snes; 126224989b8cSPeter Brune DM dm; 1263316643e7SJed Brown 1264316643e7SJed Brown PetscFunctionBegin; 12650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1266e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1267e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1268e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1269e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 127024989b8cSPeter Brune 127124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 127224989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 127324989b8cSPeter Brune 1274089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1275e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1276316643e7SJed Brown PetscFunctionReturn(0); 1277316643e7SJed Brown } 1278316643e7SJed Brown 12794a2ae208SSatish Balay #undef __FUNCT__ 1280e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse" 1281e1244c69SJed Brown /*@ 1282e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1283e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1284e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1285e1244c69SJed Brown not been changed by the TS. 1286e1244c69SJed Brown 1287e1244c69SJed Brown Logically Collective 1288e1244c69SJed Brown 1289e1244c69SJed Brown Input Arguments: 1290e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1291e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1292e1244c69SJed Brown 1293e1244c69SJed Brown Level: intermediate 1294e1244c69SJed Brown 1295e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1296e1244c69SJed Brown @*/ 1297e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1298e1244c69SJed Brown { 1299e1244c69SJed Brown PetscFunctionBegin; 1300e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1301e1244c69SJed Brown PetscFunctionReturn(0); 1302e1244c69SJed Brown } 1303e1244c69SJed Brown 1304e1244c69SJed Brown #undef __FUNCT__ 130555849f57SBarry Smith #define __FUNCT__ "TSLoad" 130655849f57SBarry Smith /*@C 130755849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 130855849f57SBarry Smith 130955849f57SBarry Smith Collective on PetscViewer 131055849f57SBarry Smith 131155849f57SBarry Smith Input Parameters: 131255849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 131355849f57SBarry Smith some related function before a call to TSLoad(). 131455849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 131555849f57SBarry Smith 131655849f57SBarry Smith Level: intermediate 131755849f57SBarry Smith 131855849f57SBarry Smith Notes: 131955849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 132055849f57SBarry Smith 132155849f57SBarry Smith Notes for advanced users: 132255849f57SBarry Smith Most users should not need to know the details of the binary storage 132355849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 132455849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 132555849f57SBarry Smith format is 132655849f57SBarry Smith .vb 132755849f57SBarry Smith has not yet been determined 132855849f57SBarry Smith .ve 132955849f57SBarry Smith 133055849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 133155849f57SBarry Smith @*/ 1332f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 133355849f57SBarry Smith { 133455849f57SBarry Smith PetscErrorCode ierr; 133555849f57SBarry Smith PetscBool isbinary; 133655849f57SBarry Smith PetscInt classid; 133755849f57SBarry Smith char type[256]; 13382d53ad75SBarry Smith DMTS sdm; 1339ad6bc421SBarry Smith DM dm; 134055849f57SBarry Smith 134155849f57SBarry Smith PetscFunctionBegin; 1342f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 134355849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 134455849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 134555849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 134655849f57SBarry Smith 134755849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 1348ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 134955849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1350f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1351f2c2a1b9SBarry Smith if (ts->ops->load) { 1352f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1353f2c2a1b9SBarry Smith } 1354ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1355ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1356ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1357f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1358f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 13592d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 13602d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 136155849f57SBarry Smith PetscFunctionReturn(0); 136255849f57SBarry Smith } 136355849f57SBarry Smith 13649804daf3SBarry Smith #include <petscdraw.h> 1365e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1366e04113cfSBarry Smith #include <petscviewersaws.h> 1367f05ece33SBarry Smith #endif 136855849f57SBarry Smith #undef __FUNCT__ 13694a2ae208SSatish Balay #define __FUNCT__ "TSView" 13707e2c5f70SBarry Smith /*@C 1371d763cef2SBarry Smith TSView - Prints the TS data structure. 1372d763cef2SBarry Smith 13734c49b128SBarry Smith Collective on TS 1374d763cef2SBarry Smith 1375d763cef2SBarry Smith Input Parameters: 1376d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1377d763cef2SBarry Smith - viewer - visualization context 1378d763cef2SBarry Smith 1379d763cef2SBarry Smith Options Database Key: 1380d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1381d763cef2SBarry Smith 1382d763cef2SBarry Smith Notes: 1383d763cef2SBarry Smith The available visualization contexts include 1384b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1385b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1386d763cef2SBarry Smith output where only the first processor opens 1387d763cef2SBarry Smith the file. All other processors send their 1388d763cef2SBarry Smith data to the first processor to print. 1389d763cef2SBarry Smith 1390d763cef2SBarry Smith The user can open an alternative visualization context with 1391b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1392d763cef2SBarry Smith 1393d763cef2SBarry Smith Level: beginner 1394d763cef2SBarry Smith 1395d763cef2SBarry Smith .keywords: TS, timestep, view 1396d763cef2SBarry Smith 1397b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1398d763cef2SBarry Smith @*/ 13997087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1400d763cef2SBarry Smith { 1401dfbe8321SBarry Smith PetscErrorCode ierr; 140219fd82e9SBarry Smith TSType type; 14032b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 14042d53ad75SBarry Smith DMTS sdm; 1405e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1406f05ece33SBarry Smith PetscBool isams; 1407f05ece33SBarry Smith #endif 1408d763cef2SBarry Smith 1409d763cef2SBarry Smith PetscFunctionBegin; 14100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 14113050cee2SBarry Smith if (!viewer) { 1412ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 14133050cee2SBarry Smith } 14140700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1415c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1416fd16b177SBarry Smith 1417251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1418251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 141955849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 14202b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1421e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1422e04113cfSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr); 1423f05ece33SBarry Smith #endif 142432077d6dSBarry Smith if (iascii) { 1425dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 142677431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 14277c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1428d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 14295ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1430c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1431d763cef2SBarry Smith } 14325ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1433193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 14342d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 14352d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1436d52bd9f3SBarry Smith if (ts->ops->view) { 1437d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1438d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1439d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1440d52bd9f3SBarry Smith } 14410f5bd95cSBarry Smith } else if (isstring) { 1442a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1443b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 144455849f57SBarry Smith } else if (isbinary) { 144555849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 144655849f57SBarry Smith MPI_Comm comm; 144755849f57SBarry Smith PetscMPIInt rank; 144855849f57SBarry Smith char type[256]; 144955849f57SBarry Smith 145055849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 145155849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 145255849f57SBarry Smith if (!rank) { 145355849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 145455849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 145555849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 145655849f57SBarry Smith } 145755849f57SBarry Smith if (ts->ops->view) { 145855849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 145955849f57SBarry Smith } 1460f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1461f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 14622d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 14632d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 14642b0a91c0SBarry Smith } else if (isdraw) { 14652b0a91c0SBarry Smith PetscDraw draw; 14662b0a91c0SBarry Smith char str[36]; 146789fd9fafSBarry Smith PetscReal x,y,bottom,h; 14682b0a91c0SBarry Smith 14692b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 14702b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 14712b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 14722b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 14730298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 147489fd9fafSBarry Smith bottom = y - h; 14752b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 14762b0a91c0SBarry Smith if (ts->ops->view) { 14772b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14782b0a91c0SBarry Smith } 14792b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1480e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1481f05ece33SBarry Smith } else if (isams) { 1482d45a07a7SBarry Smith PetscMPIInt rank; 14832657e9d9SBarry Smith const char *name; 14842657e9d9SBarry Smith 14852657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1486d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1487d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1488d45a07a7SBarry Smith char dir[1024]; 1489d45a07a7SBarry Smith 1490e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1491a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 14922657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 14932657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 14942657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1495d763cef2SBarry Smith } 14960acecf5bSBarry Smith if (ts->ops->view) { 14970acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 14980acecf5bSBarry Smith } 1499f05ece33SBarry Smith #endif 1500f05ece33SBarry Smith } 1501f05ece33SBarry Smith 1502b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1503251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1504b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1505d763cef2SBarry Smith PetscFunctionReturn(0); 1506d763cef2SBarry Smith } 1507d763cef2SBarry Smith 1508d763cef2SBarry Smith 15094a2ae208SSatish Balay #undef __FUNCT__ 15104a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext" 1511b07ff414SBarry Smith /*@ 1512d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1513d763cef2SBarry Smith the timesteppers. 1514d763cef2SBarry Smith 15153f9fe445SBarry Smith Logically Collective on TS 1516d763cef2SBarry Smith 1517d763cef2SBarry Smith Input Parameters: 1518d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1519d763cef2SBarry Smith - usrP - optional user context 1520d763cef2SBarry Smith 1521d763cef2SBarry Smith Level: intermediate 1522d763cef2SBarry Smith 1523d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 1524d763cef2SBarry Smith 1525d763cef2SBarry Smith .seealso: TSGetApplicationContext() 1526d763cef2SBarry Smith @*/ 15277087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 1528d763cef2SBarry Smith { 1529d763cef2SBarry Smith PetscFunctionBegin; 15300700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1531d763cef2SBarry Smith ts->user = usrP; 1532d763cef2SBarry Smith PetscFunctionReturn(0); 1533d763cef2SBarry Smith } 1534d763cef2SBarry Smith 15354a2ae208SSatish Balay #undef __FUNCT__ 15364a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext" 1537b07ff414SBarry Smith /*@ 1538d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 1539d763cef2SBarry Smith timestepper. 1540d763cef2SBarry Smith 1541d763cef2SBarry Smith Not Collective 1542d763cef2SBarry Smith 1543d763cef2SBarry Smith Input Parameter: 1544d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1545d763cef2SBarry Smith 1546d763cef2SBarry Smith Output Parameter: 1547d763cef2SBarry Smith . usrP - user context 1548d763cef2SBarry Smith 1549d763cef2SBarry Smith Level: intermediate 1550d763cef2SBarry Smith 1551d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 1552d763cef2SBarry Smith 1553d763cef2SBarry Smith .seealso: TSSetApplicationContext() 1554d763cef2SBarry Smith @*/ 1555e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 1556d763cef2SBarry Smith { 1557d763cef2SBarry Smith PetscFunctionBegin; 15580700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1559e71120c6SJed Brown *(void**)usrP = ts->user; 1560d763cef2SBarry Smith PetscFunctionReturn(0); 1561d763cef2SBarry Smith } 1562d763cef2SBarry Smith 15634a2ae208SSatish Balay #undef __FUNCT__ 15644a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber" 1565d763cef2SBarry Smith /*@ 1566b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 1567d763cef2SBarry Smith 1568d763cef2SBarry Smith Not Collective 1569d763cef2SBarry Smith 1570d763cef2SBarry Smith Input Parameter: 1571d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1572d763cef2SBarry Smith 1573d763cef2SBarry Smith Output Parameter: 1574b8123daeSJed Brown . iter - number of steps completed so far 1575d763cef2SBarry Smith 1576d763cef2SBarry Smith Level: intermediate 1577d763cef2SBarry Smith 1578d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 15799be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 1580d763cef2SBarry Smith @*/ 15817087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 1582d763cef2SBarry Smith { 1583d763cef2SBarry Smith PetscFunctionBegin; 15840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 15854482741eSBarry Smith PetscValidIntPointer(iter,2); 1586d763cef2SBarry Smith *iter = ts->steps; 1587d763cef2SBarry Smith PetscFunctionReturn(0); 1588d763cef2SBarry Smith } 1589d763cef2SBarry Smith 15904a2ae208SSatish Balay #undef __FUNCT__ 15914a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep" 1592d763cef2SBarry Smith /*@ 1593d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 1594d763cef2SBarry Smith as well as the initial time. 1595d763cef2SBarry Smith 15963f9fe445SBarry Smith Logically Collective on TS 1597d763cef2SBarry Smith 1598d763cef2SBarry Smith Input Parameters: 1599d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1600d763cef2SBarry Smith . initial_time - the initial time 1601d763cef2SBarry Smith - time_step - the size of the timestep 1602d763cef2SBarry Smith 1603d763cef2SBarry Smith Level: intermediate 1604d763cef2SBarry Smith 1605d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 1606d763cef2SBarry Smith 1607d763cef2SBarry Smith .keywords: TS, set, initial, timestep 1608d763cef2SBarry Smith @*/ 16097087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 1610d763cef2SBarry Smith { 1611e144a568SJed Brown PetscErrorCode ierr; 1612e144a568SJed Brown 1613d763cef2SBarry Smith PetscFunctionBegin; 16140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1615e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 1616d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 1617d763cef2SBarry Smith PetscFunctionReturn(0); 1618d763cef2SBarry Smith } 1619d763cef2SBarry Smith 16204a2ae208SSatish Balay #undef __FUNCT__ 16214a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep" 1622d763cef2SBarry Smith /*@ 1623d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 1624d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 1625d763cef2SBarry Smith 16263f9fe445SBarry Smith Logically Collective on TS 1627d763cef2SBarry Smith 1628d763cef2SBarry Smith Input Parameters: 1629d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1630d763cef2SBarry Smith - time_step - the size of the timestep 1631d763cef2SBarry Smith 1632d763cef2SBarry Smith Level: intermediate 1633d763cef2SBarry Smith 1634d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1635d763cef2SBarry Smith 1636d763cef2SBarry Smith .keywords: TS, set, timestep 1637d763cef2SBarry Smith @*/ 16387087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 1639d763cef2SBarry Smith { 1640d763cef2SBarry Smith PetscFunctionBegin; 16410700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1642c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 1643d763cef2SBarry Smith ts->time_step = time_step; 164431748224SBarry Smith ts->time_step_orig = time_step; 1645d763cef2SBarry Smith PetscFunctionReturn(0); 1646d763cef2SBarry Smith } 1647d763cef2SBarry Smith 16484a2ae208SSatish Balay #undef __FUNCT__ 1649a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime" 1650a43b19c4SJed Brown /*@ 165149354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 165249354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 165349354f04SShri Abhyankar or just return at the final time TS computed. 1654a43b19c4SJed Brown 1655a43b19c4SJed Brown Logically Collective on TS 1656a43b19c4SJed Brown 1657a43b19c4SJed Brown Input Parameter: 1658a43b19c4SJed Brown + ts - the time-step context 165949354f04SShri Abhyankar - eftopt - exact final time option 1660a43b19c4SJed Brown 1661a43b19c4SJed Brown Level: beginner 1662a43b19c4SJed Brown 1663a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 1664a43b19c4SJed Brown @*/ 166549354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 1666a43b19c4SJed Brown { 1667a43b19c4SJed Brown PetscFunctionBegin; 1668a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 166949354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 167049354f04SShri Abhyankar ts->exact_final_time = eftopt; 1671a43b19c4SJed Brown PetscFunctionReturn(0); 1672a43b19c4SJed Brown } 1673a43b19c4SJed Brown 1674a43b19c4SJed Brown #undef __FUNCT__ 16754a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep" 1676d763cef2SBarry Smith /*@ 1677d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 1678d763cef2SBarry Smith 1679d763cef2SBarry Smith Not Collective 1680d763cef2SBarry Smith 1681d763cef2SBarry Smith Input Parameter: 1682d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1683d763cef2SBarry Smith 1684d763cef2SBarry Smith Output Parameter: 1685d763cef2SBarry Smith . dt - the current timestep size 1686d763cef2SBarry Smith 1687d763cef2SBarry Smith Level: intermediate 1688d763cef2SBarry Smith 1689d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 1690d763cef2SBarry Smith 1691d763cef2SBarry Smith .keywords: TS, get, timestep 1692d763cef2SBarry Smith @*/ 16937087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 1694d763cef2SBarry Smith { 1695d763cef2SBarry Smith PetscFunctionBegin; 16960700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1697f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 1698d763cef2SBarry Smith *dt = ts->time_step; 1699d763cef2SBarry Smith PetscFunctionReturn(0); 1700d763cef2SBarry Smith } 1701d763cef2SBarry Smith 17024a2ae208SSatish Balay #undef __FUNCT__ 17034a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution" 1704d8e5e3e6SSatish Balay /*@ 1705d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 1706d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 1707d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 1708d763cef2SBarry Smith the solution at the next timestep has been calculated. 1709d763cef2SBarry Smith 1710d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 1711d763cef2SBarry Smith 1712d763cef2SBarry Smith Input Parameter: 1713d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1714d763cef2SBarry Smith 1715d763cef2SBarry Smith Output Parameter: 1716d763cef2SBarry Smith . v - the vector containing the solution 1717d763cef2SBarry Smith 1718d763cef2SBarry Smith Level: intermediate 1719d763cef2SBarry Smith 1720d763cef2SBarry Smith .seealso: TSGetTimeStep() 1721d763cef2SBarry Smith 1722d763cef2SBarry Smith .keywords: TS, timestep, get, solution 1723d763cef2SBarry Smith @*/ 17247087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 1725d763cef2SBarry Smith { 1726d763cef2SBarry Smith PetscFunctionBegin; 17270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 17284482741eSBarry Smith PetscValidPointer(v,2); 17298737fe31SLisandro Dalcin *v = ts->vec_sol; 1730d763cef2SBarry Smith PetscFunctionReturn(0); 1731d763cef2SBarry Smith } 1732d763cef2SBarry Smith 1733c235aa8dSHong Zhang #undef __FUNCT__ 1734c235aa8dSHong Zhang #define __FUNCT__ "TSGetSensitivity" 1735c235aa8dSHong Zhang /*@ 1736c235aa8dSHong Zhang TSGetSensitivity - Returns the sensitivity in the reverse mode. 1737c235aa8dSHong Zhang 1738c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 1739c235aa8dSHong Zhang 1740c235aa8dSHong Zhang Input Parameter: 1741c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 1742c235aa8dSHong Zhang 1743c235aa8dSHong Zhang Output Parameter: 1744c235aa8dSHong Zhang . v - the vector containing the solution 1745c235aa8dSHong Zhang 1746c235aa8dSHong Zhang Level: intermediate 1747c235aa8dSHong Zhang 1748c235aa8dSHong Zhang .seealso: TSGetTimeStep() 1749c235aa8dSHong Zhang 1750c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 1751c235aa8dSHong Zhang @*/ 1752b18ea86cSHong Zhang PetscErrorCode TSGetSensitivity(TS ts,Vec **v,PetscInt *numberadjs) 1753c235aa8dSHong Zhang { 1754c235aa8dSHong Zhang PetscFunctionBegin; 1755c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1756c235aa8dSHong Zhang PetscValidPointer(v,2); 1757b18ea86cSHong Zhang *v = ts->vecs_sensi; 1758b18ea86cSHong Zhang if(numberadjs) *numberadjs = ts->numberadjs; 1759c235aa8dSHong Zhang PetscFunctionReturn(0); 1760c235aa8dSHong Zhang } 1761c235aa8dSHong Zhang 1762bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 17634a2ae208SSatish Balay #undef __FUNCT__ 1764bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType" 1765d8e5e3e6SSatish Balay /*@ 1766bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 1767d763cef2SBarry Smith 1768bdad233fSMatthew Knepley Not collective 1769d763cef2SBarry Smith 1770bdad233fSMatthew Knepley Input Parameters: 1771bdad233fSMatthew Knepley + ts - The TS 1772bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1773d763cef2SBarry Smith .vb 17740910c330SBarry Smith U_t - A U = 0 (linear) 17750910c330SBarry Smith U_t - A(t) U = 0 (linear) 17760910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 1777d763cef2SBarry Smith .ve 1778d763cef2SBarry Smith 1779d763cef2SBarry Smith Level: beginner 1780d763cef2SBarry Smith 1781bdad233fSMatthew Knepley .keywords: TS, problem type 1782bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1783d763cef2SBarry Smith @*/ 17847087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 1785a7cc72afSBarry Smith { 17869e2a6581SJed Brown PetscErrorCode ierr; 17879e2a6581SJed Brown 1788d763cef2SBarry Smith PetscFunctionBegin; 17890700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1790bdad233fSMatthew Knepley ts->problem_type = type; 17919e2a6581SJed Brown if (type == TS_LINEAR) { 17929e2a6581SJed Brown SNES snes; 17939e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 17949e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 17959e2a6581SJed Brown } 1796d763cef2SBarry Smith PetscFunctionReturn(0); 1797d763cef2SBarry Smith } 1798d763cef2SBarry Smith 1799bdad233fSMatthew Knepley #undef __FUNCT__ 1800bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType" 1801bdad233fSMatthew Knepley /*@C 1802bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 1803bdad233fSMatthew Knepley 1804bdad233fSMatthew Knepley Not collective 1805bdad233fSMatthew Knepley 1806bdad233fSMatthew Knepley Input Parameter: 1807bdad233fSMatthew Knepley . ts - The TS 1808bdad233fSMatthew Knepley 1809bdad233fSMatthew Knepley Output Parameter: 1810bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 1811bdad233fSMatthew Knepley .vb 1812089b2837SJed Brown M U_t = A U 1813089b2837SJed Brown M(t) U_t = A(t) U 1814b5abc632SBarry Smith F(t,U,U_t) 1815bdad233fSMatthew Knepley .ve 1816bdad233fSMatthew Knepley 1817bdad233fSMatthew Knepley Level: beginner 1818bdad233fSMatthew Knepley 1819bdad233fSMatthew Knepley .keywords: TS, problem type 1820bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 1821bdad233fSMatthew Knepley @*/ 18227087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 1823a7cc72afSBarry Smith { 1824bdad233fSMatthew Knepley PetscFunctionBegin; 18250700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 18264482741eSBarry Smith PetscValidIntPointer(type,2); 1827bdad233fSMatthew Knepley *type = ts->problem_type; 1828bdad233fSMatthew Knepley PetscFunctionReturn(0); 1829bdad233fSMatthew Knepley } 1830d763cef2SBarry Smith 18314a2ae208SSatish Balay #undef __FUNCT__ 18324a2ae208SSatish Balay #define __FUNCT__ "TSSetUp" 1833d763cef2SBarry Smith /*@ 1834d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 1835d763cef2SBarry Smith of a timestepper. 1836d763cef2SBarry Smith 1837d763cef2SBarry Smith Collective on TS 1838d763cef2SBarry Smith 1839d763cef2SBarry Smith Input Parameter: 1840d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1841d763cef2SBarry Smith 1842d763cef2SBarry Smith Notes: 1843d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 1844d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 1845d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 1846d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 1847d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 1848d763cef2SBarry Smith 1849d763cef2SBarry Smith Level: advanced 1850d763cef2SBarry Smith 1851d763cef2SBarry Smith .keywords: TS, timestep, setup 1852d763cef2SBarry Smith 1853d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 1854d763cef2SBarry Smith @*/ 18557087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 1856d763cef2SBarry Smith { 1857dfbe8321SBarry Smith PetscErrorCode ierr; 18586c6b9e74SPeter Brune DM dm; 18596c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 1860d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 18616c6b9e74SPeter Brune TSIJacobian ijac; 18626c6b9e74SPeter Brune TSRHSJacobian rhsjac; 1863d763cef2SBarry Smith 1864d763cef2SBarry Smith PetscFunctionBegin; 18650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1866277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 1867277b19d0SLisandro Dalcin 18687adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 18699596e0b4SJed Brown ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr); 1870d763cef2SBarry Smith } 1871277b19d0SLisandro Dalcin 1872277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 1873277b19d0SLisandro Dalcin 1874b18ea86cSHong Zhang if (ts->reverse_mode && !ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSensitivity() first"); 1875c235aa8dSHong Zhang 1876552698daSJed Brown ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 18771c3436cfSJed Brown 1878e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 1879e1244c69SJed Brown Mat Amat,Pmat; 1880e1244c69SJed Brown SNES snes; 1881e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1882e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 1883e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 1884e1244c69SJed Brown * have displaced the RHS matrix */ 1885e1244c69SJed Brown if (Amat == ts->Arhs) { 1886e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 1887e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 1888e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 1889e1244c69SJed Brown } 1890e1244c69SJed Brown if (Pmat == ts->Brhs) { 1891e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 1892e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 1893e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 1894e1244c69SJed Brown } 1895e1244c69SJed Brown } 1896277b19d0SLisandro Dalcin if (ts->ops->setup) { 1897000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 1898277b19d0SLisandro Dalcin } 1899277b19d0SLisandro Dalcin 19006c6b9e74SPeter Brune /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 19016c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 19026c6b9e74SPeter Brune */ 19036c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 19040298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 19056c6b9e74SPeter Brune if (!func) { 19066c6b9e74SPeter Brune ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 19076c6b9e74SPeter Brune } 19086c6b9e74SPeter 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. 19096c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 19106c6b9e74SPeter Brune */ 19110298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 19120298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 19130298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 19146c6b9e74SPeter Brune if (!jac && (ijac || rhsjac)) { 19156c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 19166c6b9e74SPeter Brune } 1917277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 1918277b19d0SLisandro Dalcin PetscFunctionReturn(0); 1919277b19d0SLisandro Dalcin } 1920277b19d0SLisandro Dalcin 1921277b19d0SLisandro Dalcin #undef __FUNCT__ 1922277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset" 1923277b19d0SLisandro Dalcin /*@ 1924277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 1925277b19d0SLisandro Dalcin 1926277b19d0SLisandro Dalcin Collective on TS 1927277b19d0SLisandro Dalcin 1928277b19d0SLisandro Dalcin Input Parameter: 1929277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 1930277b19d0SLisandro Dalcin 1931277b19d0SLisandro Dalcin Level: beginner 1932277b19d0SLisandro Dalcin 1933277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 1934277b19d0SLisandro Dalcin 1935277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 1936277b19d0SLisandro Dalcin @*/ 1937277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 1938277b19d0SLisandro Dalcin { 1939277b19d0SLisandro Dalcin PetscErrorCode ierr; 1940277b19d0SLisandro Dalcin 1941277b19d0SLisandro Dalcin PetscFunctionBegin; 1942277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1943b18ea86cSHong Zhang 1944277b19d0SLisandro Dalcin if (ts->ops->reset) { 1945277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 1946277b19d0SLisandro Dalcin } 1947277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 1948bbd56ea5SKarl Rupp 19494e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 19504e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1951214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 19526bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 1953e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 1954e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 195538637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 1956b18ea86cSHong Zhang if (ts->reverse_mode) { 1957f8fee759SHong Zhang ts->vecs_sensi = 0; 1958ad8e2604SHong Zhang if (ts->vecs_sensip) { 1959f8fee759SHong Zhang ts->vecs_sensip = 0; 1960ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 1961ad8e2604SHong Zhang } 1962c384f6ddSHong Zhang if (ts->vec_quad) { 1963c384f6ddSHong Zhang ierr = VecDestroy(&ts->vec_quad);CHKERRQ(ierr); 1964c384f6ddSHong Zhang } 1965b18ea86cSHong Zhang } 1966277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 1967d763cef2SBarry Smith PetscFunctionReturn(0); 1968d763cef2SBarry Smith } 1969d763cef2SBarry Smith 19704a2ae208SSatish Balay #undef __FUNCT__ 19714a2ae208SSatish Balay #define __FUNCT__ "TSDestroy" 1972d8e5e3e6SSatish Balay /*@ 1973d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 1974d763cef2SBarry Smith with TSCreate(). 1975d763cef2SBarry Smith 1976d763cef2SBarry Smith Collective on TS 1977d763cef2SBarry Smith 1978d763cef2SBarry Smith Input Parameter: 1979d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 1980d763cef2SBarry Smith 1981d763cef2SBarry Smith Level: beginner 1982d763cef2SBarry Smith 1983d763cef2SBarry Smith .keywords: TS, timestepper, destroy 1984d763cef2SBarry Smith 1985d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 1986d763cef2SBarry Smith @*/ 19876bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 1988d763cef2SBarry Smith { 19896849ba73SBarry Smith PetscErrorCode ierr; 1990d763cef2SBarry Smith 1991d763cef2SBarry Smith PetscFunctionBegin; 19926bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 19936bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 19946bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 1995d763cef2SBarry Smith 19966bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 1997277b19d0SLisandro Dalcin 1998e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 1999e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 20006bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 20016d4c513bSLisandro Dalcin 200284df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 2003aeb4809dSShri Abhyankar if ((*ts)->event) { 2004aeb4809dSShri Abhyankar ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr); 2005aeb4809dSShri Abhyankar } 20066bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 20076bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 20086bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 20096d4c513bSLisandro Dalcin 2010a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2011d763cef2SBarry Smith PetscFunctionReturn(0); 2012d763cef2SBarry Smith } 2013d763cef2SBarry Smith 20144a2ae208SSatish Balay #undef __FUNCT__ 20154a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES" 2016d8e5e3e6SSatish Balay /*@ 2017d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2018d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2019d763cef2SBarry Smith 2020d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2021d763cef2SBarry Smith 2022d763cef2SBarry Smith Input Parameter: 2023d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2024d763cef2SBarry Smith 2025d763cef2SBarry Smith Output Parameter: 2026d763cef2SBarry Smith . snes - the nonlinear solver context 2027d763cef2SBarry Smith 2028d763cef2SBarry Smith Notes: 2029d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2030d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 203194b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2032d763cef2SBarry Smith 2033d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 20340298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2035d763cef2SBarry Smith 2036d763cef2SBarry Smith Level: beginner 2037d763cef2SBarry Smith 2038d763cef2SBarry Smith .keywords: timestep, get, SNES 2039d763cef2SBarry Smith @*/ 20407087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2041d763cef2SBarry Smith { 2042d372ba47SLisandro Dalcin PetscErrorCode ierr; 2043d372ba47SLisandro Dalcin 2044d763cef2SBarry Smith PetscFunctionBegin; 20450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20464482741eSBarry Smith PetscValidPointer(snes,2); 2047d372ba47SLisandro Dalcin if (!ts->snes) { 2048ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 20490298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 20503bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2051d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2052496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 20539e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 20549e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 20559e2a6581SJed Brown } 2056d372ba47SLisandro Dalcin } 2057d763cef2SBarry Smith *snes = ts->snes; 2058d763cef2SBarry Smith PetscFunctionReturn(0); 2059d763cef2SBarry Smith } 2060d763cef2SBarry Smith 20614a2ae208SSatish Balay #undef __FUNCT__ 2062deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES" 2063deb2cd25SJed Brown /*@ 2064deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2065deb2cd25SJed Brown 2066deb2cd25SJed Brown Collective 2067deb2cd25SJed Brown 2068deb2cd25SJed Brown Input Parameter: 2069deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2070deb2cd25SJed Brown - snes - the nonlinear solver context 2071deb2cd25SJed Brown 2072deb2cd25SJed Brown Notes: 2073deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2074deb2cd25SJed Brown 2075deb2cd25SJed Brown Level: developer 2076deb2cd25SJed Brown 2077deb2cd25SJed Brown .keywords: timestep, set, SNES 2078deb2cd25SJed Brown @*/ 2079deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2080deb2cd25SJed Brown { 2081deb2cd25SJed Brown PetscErrorCode ierr; 2082d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2083deb2cd25SJed Brown 2084deb2cd25SJed Brown PetscFunctionBegin; 2085deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2086deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2087deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2088deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2089bbd56ea5SKarl Rupp 2090deb2cd25SJed Brown ts->snes = snes; 2091bbd56ea5SKarl Rupp 20920298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 20930298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2094740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 20950298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2096740132f1SEmil Constantinescu } 2097deb2cd25SJed Brown PetscFunctionReturn(0); 2098deb2cd25SJed Brown } 2099deb2cd25SJed Brown 2100deb2cd25SJed Brown #undef __FUNCT__ 210194b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP" 2102d8e5e3e6SSatish Balay /*@ 210394b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2104d763cef2SBarry Smith a TS (timestepper) context. 2105d763cef2SBarry Smith 210694b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2107d763cef2SBarry Smith 2108d763cef2SBarry Smith Input Parameter: 2109d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2110d763cef2SBarry Smith 2111d763cef2SBarry Smith Output Parameter: 211294b7f48cSBarry Smith . ksp - the nonlinear solver context 2113d763cef2SBarry Smith 2114d763cef2SBarry Smith Notes: 211594b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2116d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2117d763cef2SBarry Smith KSP and PC contexts as well. 2118d763cef2SBarry Smith 211994b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 21200298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2121d763cef2SBarry Smith 2122d763cef2SBarry Smith Level: beginner 2123d763cef2SBarry Smith 212494b7f48cSBarry Smith .keywords: timestep, get, KSP 2125d763cef2SBarry Smith @*/ 21267087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2127d763cef2SBarry Smith { 2128d372ba47SLisandro Dalcin PetscErrorCode ierr; 2129089b2837SJed Brown SNES snes; 2130d372ba47SLisandro Dalcin 2131d763cef2SBarry Smith PetscFunctionBegin; 21320700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 21334482741eSBarry Smith PetscValidPointer(ksp,2); 213417186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2135e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2136089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2137089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2138d763cef2SBarry Smith PetscFunctionReturn(0); 2139d763cef2SBarry Smith } 2140d763cef2SBarry Smith 2141d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2142d763cef2SBarry Smith 21434a2ae208SSatish Balay #undef __FUNCT__ 2144adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration" 2145adb62b0dSMatthew Knepley /*@ 2146adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2147adb62b0dSMatthew Knepley maximum time for iteration. 2148adb62b0dSMatthew Knepley 21493f9fe445SBarry Smith Not Collective 2150adb62b0dSMatthew Knepley 2151adb62b0dSMatthew Knepley Input Parameters: 2152adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 21530298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 21540298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2155adb62b0dSMatthew Knepley 2156adb62b0dSMatthew Knepley Level: intermediate 2157adb62b0dSMatthew Knepley 2158adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2159adb62b0dSMatthew Knepley @*/ 21607087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2161adb62b0dSMatthew Knepley { 2162adb62b0dSMatthew Knepley PetscFunctionBegin; 21630700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2164abc0a331SBarry Smith if (maxsteps) { 21654482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2166adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2167adb62b0dSMatthew Knepley } 2168abc0a331SBarry Smith if (maxtime) { 21694482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2170adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2171adb62b0dSMatthew Knepley } 2172adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2173adb62b0dSMatthew Knepley } 2174adb62b0dSMatthew Knepley 2175adb62b0dSMatthew Knepley #undef __FUNCT__ 21764a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration" 2177d763cef2SBarry Smith /*@ 2178d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2179d763cef2SBarry Smith maximum time for iteration. 2180d763cef2SBarry Smith 21813f9fe445SBarry Smith Logically Collective on TS 2182d763cef2SBarry Smith 2183d763cef2SBarry Smith Input Parameters: 2184d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2185d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2186d763cef2SBarry Smith - maxtime - final time to iterate to 2187d763cef2SBarry Smith 2188d763cef2SBarry Smith Options Database Keys: 2189d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 21903bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2191d763cef2SBarry Smith 2192d763cef2SBarry Smith Notes: 2193d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2194d763cef2SBarry Smith 2195d763cef2SBarry Smith Level: intermediate 2196d763cef2SBarry Smith 2197d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2198a43b19c4SJed Brown 2199a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2200d763cef2SBarry Smith @*/ 22017087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2202d763cef2SBarry Smith { 2203d763cef2SBarry Smith PetscFunctionBegin; 22040700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2205c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2206c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 220739b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 220839b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2209d763cef2SBarry Smith PetscFunctionReturn(0); 2210d763cef2SBarry Smith } 2211d763cef2SBarry Smith 22124a2ae208SSatish Balay #undef __FUNCT__ 22134a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution" 2214d763cef2SBarry Smith /*@ 2215d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2216d763cef2SBarry Smith for use by the TS routines. 2217d763cef2SBarry Smith 22183f9fe445SBarry Smith Logically Collective on TS and Vec 2219d763cef2SBarry Smith 2220d763cef2SBarry Smith Input Parameters: 2221d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 22220910c330SBarry Smith - u - the solution vector 2223d763cef2SBarry Smith 2224d763cef2SBarry Smith Level: beginner 2225d763cef2SBarry Smith 2226d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2227d763cef2SBarry Smith @*/ 22280910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2229d763cef2SBarry Smith { 22308737fe31SLisandro Dalcin PetscErrorCode ierr; 2231496e6a7aSJed Brown DM dm; 22328737fe31SLisandro Dalcin 2233d763cef2SBarry Smith PetscFunctionBegin; 22340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22350910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 22360910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 22376bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2238bbd56ea5SKarl Rupp 22390910c330SBarry Smith ts->vec_sol = u; 2240bbd56ea5SKarl Rupp 2241496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 22420910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2243d763cef2SBarry Smith PetscFunctionReturn(0); 2244d763cef2SBarry Smith } 2245d763cef2SBarry Smith 2246e74ef692SMatthew Knepley #undef __FUNCT__ 2247c235aa8dSHong Zhang #define __FUNCT__ "TSSetSensitivity" 2248c235aa8dSHong Zhang /*@ 2249ad8e2604SHong Zhang TSSetSensitivity - Sets the initial value of sensitivity (w.r.t. initial conditions) 2250c235aa8dSHong Zhang for use by the TS routines. 2251c235aa8dSHong Zhang 2252c235aa8dSHong Zhang Logically Collective on TS and Vec 2253c235aa8dSHong Zhang 2254c235aa8dSHong Zhang Input Parameters: 2255c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2256c235aa8dSHong Zhang - u - the solution vector 2257c235aa8dSHong Zhang 2258c235aa8dSHong Zhang Level: beginner 2259c235aa8dSHong Zhang 2260c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2261c235aa8dSHong Zhang @*/ 2262b18ea86cSHong Zhang PetscErrorCode TSSetSensitivity(TS ts,Vec *u,PetscInt numberadjs) 2263c235aa8dSHong Zhang { 2264c235aa8dSHong Zhang PetscFunctionBegin; 2265c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2266b18ea86cSHong Zhang PetscValidPointer(u,2); 2267b18ea86cSHong Zhang ts->vecs_sensi = u; 2268ad8e2604SHong Zhang if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSSetSensitivityP()"); 2269b18ea86cSHong Zhang ts->numberadjs = numberadjs; 2270c235aa8dSHong Zhang 2271ad8e2604SHong Zhang PetscFunctionReturn(0); 2272ad8e2604SHong Zhang } 2273ad8e2604SHong Zhang 2274ad8e2604SHong Zhang #undef __FUNCT__ 2275ad8e2604SHong Zhang #define __FUNCT__ "TSSetSensitivityP" 2276ad8e2604SHong Zhang /*@ 2277ad8e2604SHong Zhang TSSetSensitivityP - Sets the initial value of sensitivity (w.r.t. parameters) 2278ad8e2604SHong Zhang for use by the TS routines. 2279ad8e2604SHong Zhang 2280ad8e2604SHong Zhang Logically Collective on TS and Vec 2281ad8e2604SHong Zhang 2282ad8e2604SHong Zhang Input Parameters: 2283ad8e2604SHong Zhang + ts - the TS context obtained from TSCreate() 2284ad8e2604SHong Zhang - u - the solution vector 2285ad8e2604SHong Zhang 2286ad8e2604SHong Zhang Level: beginner 2287ad8e2604SHong Zhang 2288ad8e2604SHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2289ad8e2604SHong Zhang @*/ 2290ad8e2604SHong Zhang PetscErrorCode TSSetSensitivityP(TS ts,Vec *u,PetscInt numberadjs) 2291ad8e2604SHong Zhang { 2292ad8e2604SHong Zhang PetscFunctionBegin; 2293ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2294ad8e2604SHong Zhang PetscValidPointer(u,2); 2295ad8e2604SHong Zhang ts->vecs_sensip = u; 2296ad8e2604SHong Zhang if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSSetSensitivity()"); 2297ad8e2604SHong Zhang ts->numberadjs = numberadjs; 2298ad8e2604SHong Zhang 2299ad8e2604SHong Zhang PetscFunctionReturn(0); 2300ad8e2604SHong Zhang } 2301ad8e2604SHong Zhang 2302ad8e2604SHong Zhang #undef __FUNCT__ 2303ad8e2604SHong Zhang #define __FUNCT__ "TSSetRHSJacobianP" 2304ad8e2604SHong Zhang /*@C 2305ad8e2604SHong Zhang TSSetRHSJacobianP - Sets the function that computes the Jacobian w.r.t. parameters. 2306ad8e2604SHong Zhang 2307ad8e2604SHong Zhang Logically Collective on TS 2308ad8e2604SHong Zhang 2309ad8e2604SHong Zhang Input Parameters: 2310ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2311ad8e2604SHong Zhang - func - The function 2312ad8e2604SHong Zhang 2313ad8e2604SHong Zhang Calling sequence of func: 2314ad8e2604SHong Zhang . func (TS ts); 2315ad8e2604SHong Zhang 2316ad8e2604SHong Zhang Level: intermediate 2317ad8e2604SHong Zhang 2318ad8e2604SHong Zhang 2319ad8e2604SHong Zhang .keywords: TS, sensitivity 2320ad8e2604SHong Zhang .seealso: 2321ad8e2604SHong Zhang @*/ 2322ad8e2604SHong Zhang PetscErrorCode TSSetRHSJacobianP(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2323ad8e2604SHong Zhang { 2324ad8e2604SHong Zhang PetscErrorCode ierr; 2325ad8e2604SHong Zhang 2326ad8e2604SHong Zhang PetscFunctionBegin; 2327ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2328ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2329ad8e2604SHong Zhang 2330ad8e2604SHong Zhang ts->rhsjacobianp = func; 2331ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 2332ad8e2604SHong Zhang if(Amat) { 2333ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2334ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2335ad8e2604SHong Zhang 2336ad8e2604SHong Zhang ts->Jacp = Amat; 2337ad8e2604SHong Zhang } 2338ad8e2604SHong Zhang PetscFunctionReturn(0); 2339ad8e2604SHong Zhang } 2340ad8e2604SHong Zhang 2341ad8e2604SHong Zhang #undef __FUNCT__ 2342ad8e2604SHong Zhang #define __FUNCT__ "TSRHSJacobianP" 2343ad8e2604SHong Zhang /*@ 2344ad8e2604SHong Zhang TSRHSJacobianP - Runs the user-defined JacobianP function. 2345ad8e2604SHong Zhang 2346ad8e2604SHong Zhang Collective on TS 2347ad8e2604SHong Zhang 2348ad8e2604SHong Zhang Input Parameters: 2349ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 2350ad8e2604SHong Zhang 2351ad8e2604SHong Zhang Notes: 2352ad8e2604SHong Zhang TSJacobianP() is typically used for sensitivity implementation, 2353ad8e2604SHong Zhang so most users would not generally call this routine themselves. 2354ad8e2604SHong Zhang 2355ad8e2604SHong Zhang Level: developer 2356ad8e2604SHong Zhang 2357ad8e2604SHong Zhang .keywords: TS, sensitivity 2358ad8e2604SHong Zhang .seealso: TSSetRHSJacobianP() 2359ad8e2604SHong Zhang @*/ 2360ad8e2604SHong Zhang PetscErrorCode TSRHSJacobianP(TS ts,PetscReal t,Vec X,Mat Amat) 2361ad8e2604SHong Zhang { 2362ad8e2604SHong Zhang PetscErrorCode ierr; 2363ad8e2604SHong Zhang 2364ad8e2604SHong Zhang PetscFunctionBegin; 2365ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2366ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 2367ad8e2604SHong Zhang PetscValidPointer(Amat,4); 2368ad8e2604SHong Zhang 2369ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 2370ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 2371ad8e2604SHong Zhang PetscStackPop; 2372ad8e2604SHong Zhang 2373c235aa8dSHong Zhang PetscFunctionReturn(0); 2374c235aa8dSHong Zhang } 2375c235aa8dSHong Zhang 2376c235aa8dSHong Zhang #undef __FUNCT__ 2377*e4680132SHong Zhang #define __FUNCT__ "TSSetCostIntegrand" 23786fd0887fSHong Zhang /*@C 2379*e4680132SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the quadrature (or integral) term in a cost function, 23806fd0887fSHong Zhang where Q_t = r(t,u). 23816fd0887fSHong Zhang 23826fd0887fSHong Zhang Logically Collective on TS 23836fd0887fSHong Zhang 23846fd0887fSHong Zhang Input Parameters: 23856fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 23866fd0887fSHong Zhang . r - vector to put the computed right hand side (or NULL to have it created) 23876fd0887fSHong Zhang . fq - routine for evaluating the right-hand-side function 23886fd0887fSHong Zhang - ctx - [optional] user-defined context for private data for the 23896fd0887fSHong Zhang function evaluation routine (may be NULL) 23906fd0887fSHong Zhang 23916fd0887fSHong Zhang Calling sequence of func: 23926fd0887fSHong Zhang $ func (TS ts,PetscReal t,Vec u,PetscReal *r,void *ctx); 23936fd0887fSHong Zhang 23946fd0887fSHong Zhang + t - current timestep 23956fd0887fSHong Zhang . u - input vector 23966fd0887fSHong Zhang . r - function vector 23976fd0887fSHong Zhang - ctx - [optional] user-defined function context 23986fd0887fSHong Zhang 23996fd0887fSHong Zhang Level: beginner 24006fd0887fSHong Zhang 24016fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 24026fd0887fSHong Zhang 24036fd0887fSHong Zhang .seealso: TSSetRHSJacobianP(),TSSetSensitivity(),TSSetSensitivityP() 24046fd0887fSHong Zhang @*/ 2405*e4680132SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numberadjs,Vec r,PetscErrorCode (*fq)(TS,PetscReal,Vec,Vec,void*),void *ctx) 24066fd0887fSHong Zhang { 24076fd0887fSHong Zhang PetscErrorCode ierr; 2408c384f6ddSHong Zhang Vec ralloc = NULL; 24096fd0887fSHong Zhang 24106fd0887fSHong Zhang PetscFunctionBegin; 24116fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24126fd0887fSHong Zhang 24136fd0887fSHong Zhang if(!ts->numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSSetSensitivity() or TSSetSensitivityP() first so that the number of cost functions can be determined."); 24146fd0887fSHong Zhang if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter) is inconsistent with the one set by TSSetSensitivity() or TSSetSensitivityP()"); 24156fd0887fSHong Zhang 24166fd0887fSHong Zhang if(!r && ts->vec_quad) { 24176fd0887fSHong Zhang ierr = VecDuplicate(ts->vec_quad,&ralloc);CHKERRQ(ierr); 24186fd0887fSHong Zhang r = ralloc; 24196fd0887fSHong Zhang } 24206fd0887fSHong Zhang ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 24216fd0887fSHong Zhang 2422*e4680132SHong Zhang ts->costintegrand = fq; 24236fd0887fSHong Zhang 24246fd0887fSHong Zhang PetscFunctionReturn(0); 24256fd0887fSHong Zhang } 24266fd0887fSHong Zhang 24276fd0887fSHong Zhang #undef __FUNCT__ 2428*e4680132SHong Zhang #define __FUNCT__ "TSComputeCostIntegrand" 24296fd0887fSHong Zhang /*@ 2430*e4680132SHong Zhang TSComputeCostIntegrand - Evaluates the quadrature function in the cost functions. 24316fd0887fSHong Zhang 24326fd0887fSHong Zhang Input Parameters: 24336fd0887fSHong Zhang + ts - the TS context 24346fd0887fSHong Zhang . t - current time 2435c384f6ddSHong Zhang . U - state vector 2436c384f6ddSHong Zhang - ctx - [optional] user-defined context for private data for the 2437c384f6ddSHong Zhang function evaluation routine (may be NULL) 24386fd0887fSHong Zhang 24396fd0887fSHong Zhang Output Parameter: 24406fd0887fSHong Zhang . q - vector of size numberadjs to hold the outputs 24416fd0887fSHong Zhang 24426fd0887fSHong Zhang Note: 24436fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 24446fd0887fSHong Zhang is used internally within the sensitivity analysis context. 24456fd0887fSHong Zhang 24466fd0887fSHong Zhang Level: developer 24476fd0887fSHong Zhang 24486fd0887fSHong Zhang .keywords: TS, compute 24496fd0887fSHong Zhang 2450*e4680132SHong Zhang .seealso: TSSetCostIntegrand() 24516fd0887fSHong Zhang @*/ 2452*e4680132SHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec U,Vec q,void *ctx) 24536fd0887fSHong Zhang { 24546fd0887fSHong Zhang PetscErrorCode ierr; 24556fd0887fSHong Zhang 24566fd0887fSHong Zhang PetscFunctionBegin; 24576fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24586fd0887fSHong Zhang PetscValidHeaderSpecific(U,VEC_CLASSID,3); 24596fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 24606fd0887fSHong Zhang 24616fd0887fSHong Zhang ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr); 2462*e4680132SHong Zhang if (ts->costintegrand) { 2463*e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 2464*e4680132SHong Zhang ierr = (*ts->costintegrand)(ts,t,U,q,ctx);CHKERRQ(ierr); 24656fd0887fSHong Zhang PetscStackPop; 24666fd0887fSHong Zhang } else { 24676fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 24686fd0887fSHong Zhang } 24696fd0887fSHong Zhang 24706fd0887fSHong Zhang ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr); 24716fd0887fSHong Zhang PetscFunctionReturn(0); 24726fd0887fSHong Zhang } 24736fd0887fSHong Zhang 24746fd0887fSHong Zhang #undef __FUNCT__ 2475e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep" 2476ac226902SBarry Smith /*@C 2477000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 24783f2090d5SJed Brown called once at the beginning of each time step. 2479000e7ae3SMatthew Knepley 24803f9fe445SBarry Smith Logically Collective on TS 2481000e7ae3SMatthew Knepley 2482000e7ae3SMatthew Knepley Input Parameters: 2483000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2484000e7ae3SMatthew Knepley - func - The function 2485000e7ae3SMatthew Knepley 2486000e7ae3SMatthew Knepley Calling sequence of func: 2487000e7ae3SMatthew Knepley . func (TS ts); 2488000e7ae3SMatthew Knepley 2489000e7ae3SMatthew Knepley Level: intermediate 2490000e7ae3SMatthew Knepley 2491b8123daeSJed Brown Note: 2492b8123daeSJed Brown If a step is rejected, TSStep() will call this routine again before each attempt. 2493b8123daeSJed Brown The last completed time step number can be queried using TSGetTimeStepNumber(), the 2494b8123daeSJed Brown size of the step being attempted can be obtained using TSGetTimeStep(). 2495b8123daeSJed Brown 2496000e7ae3SMatthew Knepley .keywords: TS, timestep 24979be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 2498000e7ae3SMatthew Knepley @*/ 24997087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 2500000e7ae3SMatthew Knepley { 2501000e7ae3SMatthew Knepley PetscFunctionBegin; 25020700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2503ae60f76fSBarry Smith ts->prestep = func; 2504000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2505000e7ae3SMatthew Knepley } 2506000e7ae3SMatthew Knepley 2507e74ef692SMatthew Knepley #undef __FUNCT__ 25083f2090d5SJed Brown #define __FUNCT__ "TSPreStep" 250909ee8438SJed Brown /*@ 25103f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 25113f2090d5SJed Brown 25123f2090d5SJed Brown Collective on TS 25133f2090d5SJed Brown 25143f2090d5SJed Brown Input Parameters: 25153f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 25163f2090d5SJed Brown 25173f2090d5SJed Brown Notes: 25183f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 25193f2090d5SJed Brown so most users would not generally call this routine themselves. 25203f2090d5SJed Brown 25213f2090d5SJed Brown Level: developer 25223f2090d5SJed Brown 25233f2090d5SJed Brown .keywords: TS, timestep 25249be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 25253f2090d5SJed Brown @*/ 25267087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 25273f2090d5SJed Brown { 25283f2090d5SJed Brown PetscErrorCode ierr; 25293f2090d5SJed Brown 25303f2090d5SJed Brown PetscFunctionBegin; 25310700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2532ae60f76fSBarry Smith if (ts->prestep) { 2533ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 2534312ce896SJed Brown } 25353f2090d5SJed Brown PetscFunctionReturn(0); 25363f2090d5SJed Brown } 25373f2090d5SJed Brown 25383f2090d5SJed Brown #undef __FUNCT__ 2539b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage" 2540b8123daeSJed Brown /*@C 2541b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 2542b8123daeSJed Brown called once at the beginning of each stage. 2543b8123daeSJed Brown 2544b8123daeSJed Brown Logically Collective on TS 2545b8123daeSJed Brown 2546b8123daeSJed Brown Input Parameters: 2547b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 2548b8123daeSJed Brown - func - The function 2549b8123daeSJed Brown 2550b8123daeSJed Brown Calling sequence of func: 2551b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 2552b8123daeSJed Brown 2553b8123daeSJed Brown Level: intermediate 2554b8123daeSJed Brown 2555b8123daeSJed Brown Note: 2556b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 2557b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 2558b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 2559b8123daeSJed Brown 2560b8123daeSJed Brown .keywords: TS, timestep 25619be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 2562b8123daeSJed Brown @*/ 2563b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 2564b8123daeSJed Brown { 2565b8123daeSJed Brown PetscFunctionBegin; 2566b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2567ae60f76fSBarry Smith ts->prestage = func; 2568b8123daeSJed Brown PetscFunctionReturn(0); 2569b8123daeSJed Brown } 2570b8123daeSJed Brown 2571b8123daeSJed Brown #undef __FUNCT__ 25729be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage" 25739be3e283SDebojyoti Ghosh /*@C 25749be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 25759be3e283SDebojyoti Ghosh called once at the end of each stage. 25769be3e283SDebojyoti Ghosh 25779be3e283SDebojyoti Ghosh Logically Collective on TS 25789be3e283SDebojyoti Ghosh 25799be3e283SDebojyoti Ghosh Input Parameters: 25809be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 25819be3e283SDebojyoti Ghosh - func - The function 25829be3e283SDebojyoti Ghosh 25839be3e283SDebojyoti Ghosh Calling sequence of func: 25849be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 25859be3e283SDebojyoti Ghosh 25869be3e283SDebojyoti Ghosh Level: intermediate 25879be3e283SDebojyoti Ghosh 25889be3e283SDebojyoti Ghosh Note: 25899be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 25909be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 25919be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 25929be3e283SDebojyoti Ghosh 25939be3e283SDebojyoti Ghosh .keywords: TS, timestep 25949be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 25959be3e283SDebojyoti Ghosh @*/ 25969be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 25979be3e283SDebojyoti Ghosh { 25989be3e283SDebojyoti Ghosh PetscFunctionBegin; 25999be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 26009be3e283SDebojyoti Ghosh ts->poststage = func; 26019be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 26029be3e283SDebojyoti Ghosh } 26039be3e283SDebojyoti Ghosh 26049be3e283SDebojyoti Ghosh #undef __FUNCT__ 2605b8123daeSJed Brown #define __FUNCT__ "TSPreStage" 2606b8123daeSJed Brown /*@ 2607b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 2608b8123daeSJed Brown 2609b8123daeSJed Brown Collective on TS 2610b8123daeSJed Brown 2611b8123daeSJed Brown Input Parameters: 2612b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 26139be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 2614b8123daeSJed Brown 2615b8123daeSJed Brown Notes: 2616b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 2617b8123daeSJed Brown most users would not generally call this routine themselves. 2618b8123daeSJed Brown 2619b8123daeSJed Brown Level: developer 2620b8123daeSJed Brown 2621b8123daeSJed Brown .keywords: TS, timestep 26229be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 2623b8123daeSJed Brown @*/ 2624b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 2625b8123daeSJed Brown { 2626b8123daeSJed Brown PetscErrorCode ierr; 2627b8123daeSJed Brown 2628b8123daeSJed Brown PetscFunctionBegin; 2629b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2630ae60f76fSBarry Smith if (ts->prestage) { 2631ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 2632b8123daeSJed Brown } 2633b8123daeSJed Brown PetscFunctionReturn(0); 2634b8123daeSJed Brown } 2635b8123daeSJed Brown 2636b8123daeSJed Brown #undef __FUNCT__ 26379be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage" 26389be3e283SDebojyoti Ghosh /*@ 26399be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 26409be3e283SDebojyoti Ghosh 26419be3e283SDebojyoti Ghosh Collective on TS 26429be3e283SDebojyoti Ghosh 26439be3e283SDebojyoti Ghosh Input Parameters: 26449be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 26459be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 26469be3e283SDebojyoti Ghosh stageindex - Stage number 26479be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 26489be3e283SDebojyoti Ghosh of stages) with the stage solutions 26499be3e283SDebojyoti Ghosh 26509be3e283SDebojyoti Ghosh Notes: 26519be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 26529be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 26539be3e283SDebojyoti Ghosh 26549be3e283SDebojyoti Ghosh Level: developer 26559be3e283SDebojyoti Ghosh 26569be3e283SDebojyoti Ghosh .keywords: TS, timestep 26579be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 26589be3e283SDebojyoti Ghosh @*/ 26599be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 26609be3e283SDebojyoti Ghosh { 26619be3e283SDebojyoti Ghosh PetscErrorCode ierr; 26629be3e283SDebojyoti Ghosh 26639be3e283SDebojyoti Ghosh PetscFunctionBegin; 26649be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 26654beae5d8SLisandro Dalcin if (ts->poststage) { 26669be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 26679be3e283SDebojyoti Ghosh } 26689be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 26699be3e283SDebojyoti Ghosh } 26709be3e283SDebojyoti Ghosh 26719be3e283SDebojyoti Ghosh #undef __FUNCT__ 2672e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep" 2673ac226902SBarry Smith /*@C 2674000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 26753f2090d5SJed Brown called once at the end of each time step. 2676000e7ae3SMatthew Knepley 26773f9fe445SBarry Smith Logically Collective on TS 2678000e7ae3SMatthew Knepley 2679000e7ae3SMatthew Knepley Input Parameters: 2680000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 2681000e7ae3SMatthew Knepley - func - The function 2682000e7ae3SMatthew Knepley 2683000e7ae3SMatthew Knepley Calling sequence of func: 2684b8123daeSJed Brown $ func (TS ts); 2685000e7ae3SMatthew Knepley 2686000e7ae3SMatthew Knepley Level: intermediate 2687000e7ae3SMatthew Knepley 2688000e7ae3SMatthew Knepley .keywords: TS, timestep 2689b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 2690000e7ae3SMatthew Knepley @*/ 26917087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 2692000e7ae3SMatthew Knepley { 2693000e7ae3SMatthew Knepley PetscFunctionBegin; 26940700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2695ae60f76fSBarry Smith ts->poststep = func; 2696000e7ae3SMatthew Knepley PetscFunctionReturn(0); 2697000e7ae3SMatthew Knepley } 2698000e7ae3SMatthew Knepley 2699e74ef692SMatthew Knepley #undef __FUNCT__ 27003f2090d5SJed Brown #define __FUNCT__ "TSPostStep" 270109ee8438SJed Brown /*@ 27023f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 27033f2090d5SJed Brown 27043f2090d5SJed Brown Collective on TS 27053f2090d5SJed Brown 27063f2090d5SJed Brown Input Parameters: 27073f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 27083f2090d5SJed Brown 27093f2090d5SJed Brown Notes: 27103f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 27113f2090d5SJed Brown so most users would not generally call this routine themselves. 27123f2090d5SJed Brown 27133f2090d5SJed Brown Level: developer 27143f2090d5SJed Brown 27153f2090d5SJed Brown .keywords: TS, timestep 27163f2090d5SJed Brown @*/ 27177087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 27183f2090d5SJed Brown { 27193f2090d5SJed Brown PetscErrorCode ierr; 27203f2090d5SJed Brown 27213f2090d5SJed Brown PetscFunctionBegin; 27220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2723ae60f76fSBarry Smith if (ts->poststep) { 2724ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 272572ac3e02SJed Brown } 27263f2090d5SJed Brown PetscFunctionReturn(0); 27273f2090d5SJed Brown } 27283f2090d5SJed Brown 2729d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 2730d763cef2SBarry Smith 27314a2ae208SSatish Balay #undef __FUNCT__ 2732a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet" 2733d763cef2SBarry Smith /*@C 2734a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 2735d763cef2SBarry Smith timestep to display the iteration's progress. 2736d763cef2SBarry Smith 27373f9fe445SBarry Smith Logically Collective on TS 2738d763cef2SBarry Smith 2739d763cef2SBarry Smith Input Parameters: 2740d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2741e213d8f1SJed Brown . monitor - monitoring routine 2742329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 27430298fd71SBarry Smith monitor routine (use NULL if no context is desired) 2744b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 27450298fd71SBarry Smith (may be NULL) 2746d763cef2SBarry Smith 2747e213d8f1SJed Brown Calling sequence of monitor: 27480910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 2749d763cef2SBarry Smith 2750d763cef2SBarry Smith + ts - the TS context 275188c05cc5SBarry 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 275288c05cc5SBarry Smith been interpolated to) 27531f06c33eSBarry Smith . time - current time 27540910c330SBarry Smith . u - current iterate 2755d763cef2SBarry Smith - mctx - [optional] monitoring context 2756d763cef2SBarry Smith 2757d763cef2SBarry Smith Notes: 2758d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 2759d763cef2SBarry Smith already has been loaded. 2760d763cef2SBarry Smith 2761025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 2762025f1a04SBarry Smith 2763d763cef2SBarry Smith Level: intermediate 2764d763cef2SBarry Smith 2765d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2766d763cef2SBarry Smith 2767a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 2768d763cef2SBarry Smith @*/ 2769c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 2770d763cef2SBarry Smith { 2771d763cef2SBarry Smith PetscFunctionBegin; 27720700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 277317186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 2774d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 27758704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 2776d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 2777d763cef2SBarry Smith PetscFunctionReturn(0); 2778d763cef2SBarry Smith } 2779d763cef2SBarry Smith 27804a2ae208SSatish Balay #undef __FUNCT__ 2781a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel" 2782d763cef2SBarry Smith /*@C 2783a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 2784d763cef2SBarry Smith 27853f9fe445SBarry Smith Logically Collective on TS 2786d763cef2SBarry Smith 2787d763cef2SBarry Smith Input Parameters: 2788d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2789d763cef2SBarry Smith 2790d763cef2SBarry Smith Notes: 2791d763cef2SBarry Smith There is no way to remove a single, specific monitor. 2792d763cef2SBarry Smith 2793d763cef2SBarry Smith Level: intermediate 2794d763cef2SBarry Smith 2795d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 2796d763cef2SBarry Smith 2797a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 2798d763cef2SBarry Smith @*/ 27997087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 2800d763cef2SBarry Smith { 2801d952e501SBarry Smith PetscErrorCode ierr; 2802d952e501SBarry Smith PetscInt i; 2803d952e501SBarry Smith 2804d763cef2SBarry Smith PetscFunctionBegin; 28050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2806d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 28078704b422SBarry Smith if (ts->monitordestroy[i]) { 28088704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 2809d952e501SBarry Smith } 2810d952e501SBarry Smith } 2811d763cef2SBarry Smith ts->numbermonitors = 0; 2812d763cef2SBarry Smith PetscFunctionReturn(0); 2813d763cef2SBarry Smith } 2814d763cef2SBarry Smith 28154a2ae208SSatish Balay #undef __FUNCT__ 2816a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault" 2817d8e5e3e6SSatish Balay /*@ 2818a6570f20SBarry Smith TSMonitorDefault - Sets the Default monitor 28195516499fSSatish Balay 28205516499fSSatish Balay Level: intermediate 282141251cbbSSatish Balay 28225516499fSSatish Balay .keywords: TS, set, monitor 28235516499fSSatish Balay 282441251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet() 282541251cbbSSatish Balay @*/ 2826649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy) 2827d763cef2SBarry Smith { 2828dfbe8321SBarry Smith PetscErrorCode ierr; 2829ce94432eSBarry Smith PetscViewer viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts)); 2830d132466eSBarry Smith 2831d763cef2SBarry Smith PetscFunctionBegin; 2832649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2833971832b6SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr); 2834649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 2835d763cef2SBarry Smith PetscFunctionReturn(0); 2836d763cef2SBarry Smith } 2837d763cef2SBarry Smith 28384a2ae208SSatish Balay #undef __FUNCT__ 2839cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages" 2840cd652676SJed Brown /*@ 2841cd652676SJed Brown TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available. 2842cd652676SJed Brown 2843cd652676SJed Brown Logically Collective on TS 2844cd652676SJed Brown 2845cd652676SJed Brown Input Argument: 2846cd652676SJed Brown . ts - time stepping context 2847cd652676SJed Brown 2848cd652676SJed Brown Output Argument: 2849cd652676SJed Brown . flg - PETSC_TRUE or PETSC_FALSE 2850cd652676SJed Brown 2851cd652676SJed Brown Level: intermediate 2852cd652676SJed Brown 2853cd652676SJed Brown .keywords: TS, set 2854cd652676SJed Brown 2855cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep() 2856cd652676SJed Brown @*/ 2857cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg) 2858cd652676SJed Brown { 2859cd652676SJed Brown PetscFunctionBegin; 2860cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2861cd652676SJed Brown ts->retain_stages = flg; 2862cd652676SJed Brown PetscFunctionReturn(0); 2863cd652676SJed Brown } 2864cd652676SJed Brown 2865cd652676SJed Brown #undef __FUNCT__ 2866cd652676SJed Brown #define __FUNCT__ "TSInterpolate" 2867cd652676SJed Brown /*@ 2868cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 2869cd652676SJed Brown 2870cd652676SJed Brown Collective on TS 2871cd652676SJed Brown 2872cd652676SJed Brown Input Argument: 2873cd652676SJed Brown + ts - time stepping context 2874cd652676SJed Brown - t - time to interpolate to 2875cd652676SJed Brown 2876cd652676SJed Brown Output Argument: 28770910c330SBarry Smith . U - state at given time 2878cd652676SJed Brown 2879cd652676SJed Brown Notes: 2880cd652676SJed Brown The user should call TSSetRetainStages() before taking a step in which interpolation will be requested. 2881cd652676SJed Brown 2882cd652676SJed Brown Level: intermediate 2883cd652676SJed Brown 2884cd652676SJed Brown Developer Notes: 2885cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 2886cd652676SJed Brown 2887cd652676SJed Brown .keywords: TS, set 2888cd652676SJed Brown 2889cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep() 2890cd652676SJed Brown @*/ 28910910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 2892cd652676SJed Brown { 2893cd652676SJed Brown PetscErrorCode ierr; 2894cd652676SJed Brown 2895cd652676SJed Brown PetscFunctionBegin; 2896cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2897b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 28986712e2f1SBarry 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); 2899ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 29000910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 2901cd652676SJed Brown PetscFunctionReturn(0); 2902cd652676SJed Brown } 2903cd652676SJed Brown 2904cd652676SJed Brown #undef __FUNCT__ 29054a2ae208SSatish Balay #define __FUNCT__ "TSStep" 2906d763cef2SBarry Smith /*@ 29076d9e5789SSean Farley TSStep - Steps one time step 2908d763cef2SBarry Smith 2909d763cef2SBarry Smith Collective on TS 2910d763cef2SBarry Smith 2911d763cef2SBarry Smith Input Parameter: 2912d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2913d763cef2SBarry Smith 29146d9e5789SSean Farley Level: intermediate 2915d763cef2SBarry Smith 2916b8123daeSJed Brown Notes: 2917b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 2918b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 2919b8123daeSJed Brown 292025cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 292125cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 292225cb2221SBarry Smith 2923d763cef2SBarry Smith .keywords: TS, timestep, solve 2924d763cef2SBarry Smith 29259be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 2926d763cef2SBarry Smith @*/ 2927193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 2928d763cef2SBarry Smith { 29292fb8446cSMatthew G. Knepley DM dm; 2930dfbe8321SBarry Smith PetscErrorCode ierr; 2931fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 2932d763cef2SBarry Smith 2933d763cef2SBarry Smith PetscFunctionBegin; 29340700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2935fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 2936fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 2937fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 2938fffbeea8SBarry Smith " type = {Preprint},\n" 2939fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 2940fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 2941fffbeea8SBarry Smith " year = {2014}\n}\n",&cite); 2942fffbeea8SBarry Smith 29432fb8446cSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 2944d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 2945d405a339SMatthew Knepley 2946362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 294724655328SShri ts->ptime_prev = ts->ptime; 2948cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 29494e9ba7eeSMatthew G. Knepley ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr); 2950bbd56ea5SKarl Rupp 2951e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 2952d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2953d2daff3dSHong Zhang if(ts->reverse_mode) { 2954d2daff3dSHong Zhang if(!ts->ops->stepadj) { 2955d2daff3dSHong Zhang 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); 2956d2daff3dSHong Zhang }else { 2957d2daff3dSHong Zhang ierr = (*ts->ops->stepadj)(ts);CHKERRQ(ierr); 2958d2daff3dSHong Zhang } 2959d2daff3dSHong Zhang }else { 2960193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 2961d2daff3dSHong Zhang } 2962d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 2963bbd56ea5SKarl Rupp 296424655328SShri ts->time_step_prev = ts->ptime - ts->ptime_prev; 2965cdb7a50dSMatthew G. Knepley ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr); 2966362cd11cSLisandro Dalcin 2967362cd11cSLisandro Dalcin if (ts->reason < 0) { 2968cef5090cSJed Brown if (ts->errorifstepfailed) { 2969cef5090cSJed Brown if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) { 2970ce94432eSBarry Smith SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 29712a3a10ceSLisandro Dalcin } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) { 29722a3a10ceSLisandro 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]); 2973ce94432eSBarry Smith } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 2974cef5090cSJed Brown } 2975362cd11cSLisandro Dalcin } else if (!ts->reason) { 2976db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 2977db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 2978362cd11cSLisandro Dalcin } 2979d763cef2SBarry Smith PetscFunctionReturn(0); 2980d763cef2SBarry Smith } 2981d763cef2SBarry Smith 29824a2ae208SSatish Balay #undef __FUNCT__ 298305175c85SJed Brown #define __FUNCT__ "TSEvaluateStep" 298405175c85SJed Brown /*@ 298505175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 298605175c85SJed Brown 29871c3436cfSJed Brown Collective on TS 298805175c85SJed Brown 298905175c85SJed Brown Input Arguments: 29901c3436cfSJed Brown + ts - time stepping context 29911c3436cfSJed Brown . order - desired order of accuracy 29920298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 299305175c85SJed Brown 299405175c85SJed Brown Output Arguments: 29950910c330SBarry Smith . U - state at the end of the current step 299605175c85SJed Brown 299705175c85SJed Brown Level: advanced 299805175c85SJed Brown 2999108c343cSJed Brown Notes: 3000108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3001108c343cSJed 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. 3002108c343cSJed Brown 30031c3436cfSJed Brown .seealso: TSStep(), TSAdapt 300405175c85SJed Brown @*/ 30050910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 300605175c85SJed Brown { 300705175c85SJed Brown PetscErrorCode ierr; 300805175c85SJed Brown 300905175c85SJed Brown PetscFunctionBegin; 301005175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 301105175c85SJed Brown PetscValidType(ts,1); 30120910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3013ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 30140910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 301505175c85SJed Brown PetscFunctionReturn(0); 301605175c85SJed Brown } 301705175c85SJed Brown 301805175c85SJed Brown #undef __FUNCT__ 30196a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve" 30206a4d4014SLisandro Dalcin /*@ 30216a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 30226a4d4014SLisandro Dalcin 30236a4d4014SLisandro Dalcin Collective on TS 30246a4d4014SLisandro Dalcin 30256a4d4014SLisandro Dalcin Input Parameter: 30266a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 3027cc708dedSBarry Smith - u - the solution vector (can be null if TSSetSolution() was used, otherwise must contain the initial conditions) 30285a3a76d0SJed Brown 30296a4d4014SLisandro Dalcin Level: beginner 30306a4d4014SLisandro Dalcin 30315a3a76d0SJed Brown Notes: 30325a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 30335a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 30345a3a76d0SJed Brown stepped over the final time. 30355a3a76d0SJed Brown 30366a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 30376a4d4014SLisandro Dalcin 30386a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep() 30396a4d4014SLisandro Dalcin @*/ 3040cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 30416a4d4014SLisandro Dalcin { 3042b06615a5SLisandro Dalcin Vec solution; 30436a4d4014SLisandro Dalcin PetscErrorCode ierr; 3044f22f69f0SBarry Smith 30456a4d4014SLisandro Dalcin PetscFunctionBegin; 30460700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3047f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3048d2daff3dSHong Zhang if (!ts->reverse_mode && 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 */ 3049b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 30500910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3051b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3052b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3053b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 30545a3a76d0SJed Brown } 30550910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3056bbd56ea5SKarl Rupp } else if (u) { 30570910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 30585a3a76d0SJed Brown } 3059d2daff3dSHong Zhang ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/ 30606a4d4014SLisandro Dalcin /* reset time step and iteration counters */ 3061193ac0bcSJed Brown ts->steps = 0; 30625ef26d82SJed Brown ts->ksp_its = 0; 30635ef26d82SJed Brown ts->snes_its = 0; 3064c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3065c610991cSLisandro Dalcin ts->reject = 0; 3066193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3067193ac0bcSJed Brown 3068ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3069f05ece33SBarry Smith 3070193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3071193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 30720910c330SBarry Smith ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr); 3073cc708dedSBarry Smith ts->solvetime = ts->ptime; 3074193ac0bcSJed Brown } else { 30756a4d4014SLisandro Dalcin /* steps the requested number of timesteps. */ 3076db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3077d2daff3dSHong Zhang else if (!ts->reverse_mode && ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3078e1a7a14fSJed Brown while (!ts->reason) { 3079d2daff3dSHong Zhang if(!ts->reverse_mode) { 3080b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3081d2daff3dSHong Zhang }else { 3082d2daff3dSHong Zhang ierr = TSMonitor(ts,ts->max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 3083d2daff3dSHong Zhang } 3084193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3085aeb4809dSShri Abhyankar if (ts->event) { 3086aeb4809dSShri Abhyankar ierr = TSEventMonitor(ts);CHKERRQ(ierr); 30871eda64f1SShri Abhyankar if (ts->event->status != TSEVENT_PROCESSING) { 30881eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 30891eda64f1SShri Abhyankar } 30901eda64f1SShri Abhyankar } else { 30911eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3092aeb4809dSShri Abhyankar } 3093193ac0bcSJed Brown } 3094d2daff3dSHong Zhang if (!ts->reverse_mode && ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 30950910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3096cc708dedSBarry Smith ts->solvetime = ts->max_time; 3097b06615a5SLisandro Dalcin solution = u; 30980574a7fbSJed Brown } else { 3099ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3100cc708dedSBarry Smith ts->solvetime = ts->ptime; 3101b06615a5SLisandro Dalcin solution = ts->vec_sol; 31020574a7fbSJed Brown } 3103d2daff3dSHong Zhang if(!ts->reverse_mode) { 3104b06615a5SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr); 3105d2daff3dSHong Zhang } 31064e9ba7eeSMatthew G. Knepley ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr); 3107193ac0bcSJed Brown } 3108d2daff3dSHong Zhang 3109ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 311056f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 31116a4d4014SLisandro Dalcin PetscFunctionReturn(0); 31126a4d4014SLisandro Dalcin } 31136a4d4014SLisandro Dalcin 31146a4d4014SLisandro Dalcin #undef __FUNCT__ 31154a2ae208SSatish Balay #define __FUNCT__ "TSMonitor" 3116228d79bcSJed Brown /*@ 3117228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 3118228d79bcSJed Brown 3119228d79bcSJed Brown Collective on TS 3120228d79bcSJed Brown 3121228d79bcSJed Brown Input Parameters: 3122228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 3123228d79bcSJed Brown . step - step number that has just completed 3124228d79bcSJed Brown . ptime - model time of the state 31250910c330SBarry Smith - u - state at the current model time 3126228d79bcSJed Brown 3127228d79bcSJed Brown Notes: 3128228d79bcSJed Brown TSMonitor() is typically used within the time stepping implementations. 3129228d79bcSJed Brown Users might call this function when using the TSStep() interface instead of TSSolve(). 3130228d79bcSJed Brown 3131228d79bcSJed Brown Level: advanced 3132228d79bcSJed Brown 3133228d79bcSJed Brown .keywords: TS, timestep 3134228d79bcSJed Brown @*/ 31350910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 3136d763cef2SBarry Smith { 31376849ba73SBarry Smith PetscErrorCode ierr; 3138a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 3139d763cef2SBarry Smith 3140d763cef2SBarry Smith PetscFunctionBegin; 3141b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3142b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 31435edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 3144d763cef2SBarry Smith for (i=0; i<n; i++) { 31450910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 3146d763cef2SBarry Smith } 31475edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 3148d763cef2SBarry Smith PetscFunctionReturn(0); 3149d763cef2SBarry Smith } 3150d763cef2SBarry Smith 3151d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 31524a2ae208SSatish Balay #undef __FUNCT__ 3153a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate" 3154d763cef2SBarry Smith /*@C 3155a9f9c1f6SBarry Smith TSMonitorLGCtxCreate - Creates a line graph context for use with 3156a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 3157d763cef2SBarry Smith 3158d763cef2SBarry Smith Collective on TS 3159d763cef2SBarry Smith 3160d763cef2SBarry Smith Input Parameters: 3161d763cef2SBarry Smith + host - the X display to open, or null for the local machine 3162d763cef2SBarry Smith . label - the title to put in the title bar 31637c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 3164a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 3165a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 3166d763cef2SBarry Smith 3167d763cef2SBarry Smith Output Parameter: 31680b039ecaSBarry Smith . ctx - the context 3169d763cef2SBarry Smith 3170d763cef2SBarry Smith Options Database Key: 31714f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 31724f09c107SBarry Smith . -ts_monitor_lg_solution - 317399fdda47SBarry Smith . -ts_monitor_lg_error - 317499fdda47SBarry Smith . -ts_monitor_lg_ksp_iterations - 317599fdda47SBarry Smith . -ts_monitor_lg_snes_iterations - 317699fdda47SBarry Smith - -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true 3177d763cef2SBarry Smith 3178d763cef2SBarry Smith Notes: 3179a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 3180d763cef2SBarry Smith 3181d763cef2SBarry Smith Level: intermediate 3182d763cef2SBarry Smith 31837c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso 3184d763cef2SBarry Smith 31854f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 31867c922b88SBarry Smith 3187d763cef2SBarry Smith @*/ 3188a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 3189d763cef2SBarry Smith { 3190b0a32e0cSBarry Smith PetscDraw win; 3191dfbe8321SBarry Smith PetscErrorCode ierr; 3192d763cef2SBarry Smith 3193d763cef2SBarry Smith PetscFunctionBegin; 3194b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 3195a80ad3e0SBarry Smith ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr); 31963fbbecb0SBarry Smith ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr); 31970b039ecaSBarry Smith ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr); 31983bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr); 3199287de1a7SBarry Smith ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr); 3200287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 3201a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 3202d763cef2SBarry Smith PetscFunctionReturn(0); 3203d763cef2SBarry Smith } 3204d763cef2SBarry Smith 32054a2ae208SSatish Balay #undef __FUNCT__ 32064f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep" 3207b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 3208d763cef2SBarry Smith { 32090b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 3210c32365f1SBarry Smith PetscReal x = ptime,y; 3211dfbe8321SBarry Smith PetscErrorCode ierr; 3212d763cef2SBarry Smith 3213d763cef2SBarry Smith PetscFunctionBegin; 3214b06615a5SLisandro Dalcin if (!step) { 3215a9f9c1f6SBarry Smith PetscDrawAxis axis; 3216a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 3217a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr); 3218a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 3219287de1a7SBarry Smith ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr); 3220a9f9c1f6SBarry Smith } 3221c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 32220b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 3223b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 32240b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 32253923b477SBarry Smith } 3226d763cef2SBarry Smith PetscFunctionReturn(0); 3227d763cef2SBarry Smith } 3228d763cef2SBarry Smith 32294a2ae208SSatish Balay #undef __FUNCT__ 3230a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy" 3231d763cef2SBarry Smith /*@C 3232a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 3233a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 3234d763cef2SBarry Smith 32350b039ecaSBarry Smith Collective on TSMonitorLGCtx 3236d763cef2SBarry Smith 3237d763cef2SBarry Smith Input Parameter: 32380b039ecaSBarry Smith . ctx - the monitor context 3239d763cef2SBarry Smith 3240d763cef2SBarry Smith Level: intermediate 3241d763cef2SBarry Smith 3242d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 3243d763cef2SBarry Smith 32444f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 3245d763cef2SBarry Smith @*/ 3246a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 3247d763cef2SBarry Smith { 3248b0a32e0cSBarry Smith PetscDraw draw; 3249dfbe8321SBarry Smith PetscErrorCode ierr; 3250d763cef2SBarry Smith 3251d763cef2SBarry Smith PetscFunctionBegin; 32520b039ecaSBarry Smith ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr); 32536bf464f9SBarry Smith ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 32540b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 32550b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 3256d763cef2SBarry Smith PetscFunctionReturn(0); 3257d763cef2SBarry Smith } 3258d763cef2SBarry Smith 32594a2ae208SSatish Balay #undef __FUNCT__ 32604a2ae208SSatish Balay #define __FUNCT__ "TSGetTime" 3261d763cef2SBarry Smith /*@ 3262b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 3263d763cef2SBarry Smith 3264d763cef2SBarry Smith Not Collective 3265d763cef2SBarry Smith 3266d763cef2SBarry Smith Input Parameter: 3267d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3268d763cef2SBarry Smith 3269d763cef2SBarry Smith Output Parameter: 3270d763cef2SBarry Smith . t - the current time 3271d763cef2SBarry Smith 3272d763cef2SBarry Smith Level: beginner 3273d763cef2SBarry Smith 3274b8123daeSJed Brown Note: 3275b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 32769be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 3277b8123daeSJed Brown 3278d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3279d763cef2SBarry Smith 3280d763cef2SBarry Smith .keywords: TS, get, time 3281d763cef2SBarry Smith @*/ 32827087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 3283d763cef2SBarry Smith { 3284d763cef2SBarry Smith PetscFunctionBegin; 32850700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3286f7cf8827SBarry Smith PetscValidRealPointer(t,2); 3287d763cef2SBarry Smith *t = ts->ptime; 3288d763cef2SBarry Smith PetscFunctionReturn(0); 3289d763cef2SBarry Smith } 3290d763cef2SBarry Smith 32914a2ae208SSatish Balay #undef __FUNCT__ 3292e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime" 3293e5e524a1SHong Zhang /*@ 3294e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 3295e5e524a1SHong Zhang 3296e5e524a1SHong Zhang Not Collective 3297e5e524a1SHong Zhang 3298e5e524a1SHong Zhang Input Parameter: 3299e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 3300e5e524a1SHong Zhang 3301e5e524a1SHong Zhang Output Parameter: 3302e5e524a1SHong Zhang . t - the previous time 3303e5e524a1SHong Zhang 3304e5e524a1SHong Zhang Level: beginner 3305e5e524a1SHong Zhang 3306e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 3307e5e524a1SHong Zhang 3308e5e524a1SHong Zhang .keywords: TS, get, time 3309e5e524a1SHong Zhang @*/ 3310e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 3311e5e524a1SHong Zhang { 3312e5e524a1SHong Zhang PetscFunctionBegin; 3313e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3314e5e524a1SHong Zhang PetscValidRealPointer(t,2); 3315e5e524a1SHong Zhang *t = ts->ptime_prev; 3316e5e524a1SHong Zhang PetscFunctionReturn(0); 3317e5e524a1SHong Zhang } 3318e5e524a1SHong Zhang 3319e5e524a1SHong Zhang #undef __FUNCT__ 33206a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime" 33216a4d4014SLisandro Dalcin /*@ 33226a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 33236a4d4014SLisandro Dalcin 33243f9fe445SBarry Smith Logically Collective on TS 33256a4d4014SLisandro Dalcin 33266a4d4014SLisandro Dalcin Input Parameters: 33276a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 33286a4d4014SLisandro Dalcin - time - the time 33296a4d4014SLisandro Dalcin 33306a4d4014SLisandro Dalcin Level: intermediate 33316a4d4014SLisandro Dalcin 33326a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 33336a4d4014SLisandro Dalcin 33346a4d4014SLisandro Dalcin .keywords: TS, set, time 33356a4d4014SLisandro Dalcin @*/ 33367087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 33376a4d4014SLisandro Dalcin { 33386a4d4014SLisandro Dalcin PetscFunctionBegin; 33390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3340c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 33416a4d4014SLisandro Dalcin ts->ptime = t; 33426a4d4014SLisandro Dalcin PetscFunctionReturn(0); 33436a4d4014SLisandro Dalcin } 33446a4d4014SLisandro Dalcin 33456a4d4014SLisandro Dalcin #undef __FUNCT__ 33464a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix" 3347d763cef2SBarry Smith /*@C 3348d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 3349d763cef2SBarry Smith TS options in the database. 3350d763cef2SBarry Smith 33513f9fe445SBarry Smith Logically Collective on TS 3352d763cef2SBarry Smith 3353d763cef2SBarry Smith Input Parameter: 3354d763cef2SBarry Smith + ts - The TS context 3355d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3356d763cef2SBarry Smith 3357d763cef2SBarry Smith Notes: 3358d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3359d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3360d763cef2SBarry Smith hyphen. 3361d763cef2SBarry Smith 3362d763cef2SBarry Smith Level: advanced 3363d763cef2SBarry Smith 3364d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 3365d763cef2SBarry Smith 3366d763cef2SBarry Smith .seealso: TSSetFromOptions() 3367d763cef2SBarry Smith 3368d763cef2SBarry Smith @*/ 33697087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 3370d763cef2SBarry Smith { 3371dfbe8321SBarry Smith PetscErrorCode ierr; 3372089b2837SJed Brown SNES snes; 3373d763cef2SBarry Smith 3374d763cef2SBarry Smith PetscFunctionBegin; 33750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3376d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3377089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3378089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3379d763cef2SBarry Smith PetscFunctionReturn(0); 3380d763cef2SBarry Smith } 3381d763cef2SBarry Smith 3382d763cef2SBarry Smith 33834a2ae208SSatish Balay #undef __FUNCT__ 33844a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix" 3385d763cef2SBarry Smith /*@C 3386d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 3387d763cef2SBarry Smith TS options in the database. 3388d763cef2SBarry Smith 33893f9fe445SBarry Smith Logically Collective on TS 3390d763cef2SBarry Smith 3391d763cef2SBarry Smith Input Parameter: 3392d763cef2SBarry Smith + ts - The TS context 3393d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 3394d763cef2SBarry Smith 3395d763cef2SBarry Smith Notes: 3396d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 3397d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 3398d763cef2SBarry Smith hyphen. 3399d763cef2SBarry Smith 3400d763cef2SBarry Smith Level: advanced 3401d763cef2SBarry Smith 3402d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 3403d763cef2SBarry Smith 3404d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 3405d763cef2SBarry Smith 3406d763cef2SBarry Smith @*/ 34077087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 3408d763cef2SBarry Smith { 3409dfbe8321SBarry Smith PetscErrorCode ierr; 3410089b2837SJed Brown SNES snes; 3411d763cef2SBarry Smith 3412d763cef2SBarry Smith PetscFunctionBegin; 34130700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3414d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3415089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3416089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 3417d763cef2SBarry Smith PetscFunctionReturn(0); 3418d763cef2SBarry Smith } 3419d763cef2SBarry Smith 34204a2ae208SSatish Balay #undef __FUNCT__ 34214a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix" 3422d763cef2SBarry Smith /*@C 3423d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 3424d763cef2SBarry Smith TS options in the database. 3425d763cef2SBarry Smith 3426d763cef2SBarry Smith Not Collective 3427d763cef2SBarry Smith 3428d763cef2SBarry Smith Input Parameter: 3429d763cef2SBarry Smith . ts - The TS context 3430d763cef2SBarry Smith 3431d763cef2SBarry Smith Output Parameter: 3432d763cef2SBarry Smith . prefix - A pointer to the prefix string used 3433d763cef2SBarry Smith 3434d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 3435d763cef2SBarry Smith sufficient length to hold the prefix. 3436d763cef2SBarry Smith 3437d763cef2SBarry Smith Level: intermediate 3438d763cef2SBarry Smith 3439d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 3440d763cef2SBarry Smith 3441d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 3442d763cef2SBarry Smith @*/ 34437087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 3444d763cef2SBarry Smith { 3445dfbe8321SBarry Smith PetscErrorCode ierr; 3446d763cef2SBarry Smith 3447d763cef2SBarry Smith PetscFunctionBegin; 34480700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34494482741eSBarry Smith PetscValidPointer(prefix,2); 3450d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 3451d763cef2SBarry Smith PetscFunctionReturn(0); 3452d763cef2SBarry Smith } 3453d763cef2SBarry Smith 34544a2ae208SSatish Balay #undef __FUNCT__ 34554a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian" 3456d763cef2SBarry Smith /*@C 3457d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 3458d763cef2SBarry Smith 3459d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 3460d763cef2SBarry Smith 3461d763cef2SBarry Smith Input Parameter: 3462d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 3463d763cef2SBarry Smith 3464d763cef2SBarry Smith Output Parameters: 3465e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 3466e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 3467e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 3468e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 3469d763cef2SBarry Smith 34700298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 3471d763cef2SBarry Smith 3472d763cef2SBarry Smith Level: intermediate 3473d763cef2SBarry Smith 347426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 3475d763cef2SBarry Smith 3476d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 3477d763cef2SBarry Smith @*/ 3478e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 3479d763cef2SBarry Smith { 3480089b2837SJed Brown PetscErrorCode ierr; 3481089b2837SJed Brown SNES snes; 348224989b8cSPeter Brune DM dm; 3483089b2837SJed Brown 3484d763cef2SBarry Smith PetscFunctionBegin; 3485089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3486e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 348724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 348824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 3489d763cef2SBarry Smith PetscFunctionReturn(0); 3490d763cef2SBarry Smith } 3491d763cef2SBarry Smith 34921713a123SBarry Smith #undef __FUNCT__ 34932eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian" 34942eca1d9cSJed Brown /*@C 34952eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 34962eca1d9cSJed Brown 34972eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 34982eca1d9cSJed Brown 34992eca1d9cSJed Brown Input Parameter: 35002eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 35012eca1d9cSJed Brown 35022eca1d9cSJed Brown Output Parameters: 3503e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 3504e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 35052eca1d9cSJed Brown . f - The function to compute the matrices 35062eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 35072eca1d9cSJed Brown 35080298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 35092eca1d9cSJed Brown 35102eca1d9cSJed Brown Level: advanced 35112eca1d9cSJed Brown 35122eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 35132eca1d9cSJed Brown 35142eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 35152eca1d9cSJed Brown @*/ 3516e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 35172eca1d9cSJed Brown { 3518089b2837SJed Brown PetscErrorCode ierr; 3519089b2837SJed Brown SNES snes; 352024989b8cSPeter Brune DM dm; 35210910c330SBarry Smith 35222eca1d9cSJed Brown PetscFunctionBegin; 3523089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3524f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 3525e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 352624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 352724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 35282eca1d9cSJed Brown PetscFunctionReturn(0); 35292eca1d9cSJed Brown } 35302eca1d9cSJed Brown 35316083293cSBarry Smith 35322eca1d9cSJed Brown #undef __FUNCT__ 353383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution" 35341713a123SBarry Smith /*@C 353583a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 35361713a123SBarry Smith VecView() for the solution at each timestep 35371713a123SBarry Smith 35381713a123SBarry Smith Collective on TS 35391713a123SBarry Smith 35401713a123SBarry Smith Input Parameters: 35411713a123SBarry Smith + ts - the TS context 35421713a123SBarry Smith . step - current time-step 3543142b95e3SSatish Balay . ptime - current time 35440298fd71SBarry Smith - dummy - either a viewer or NULL 35451713a123SBarry Smith 354699fdda47SBarry Smith Options Database: 354799fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 354899fdda47SBarry Smith 354999fdda47SBarry 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 355099fdda47SBarry Smith will look bad 355199fdda47SBarry Smith 35521713a123SBarry Smith Level: intermediate 35531713a123SBarry Smith 35541713a123SBarry Smith .keywords: TS, vector, monitor, view 35551713a123SBarry Smith 3556a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 35571713a123SBarry Smith @*/ 35580910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 35591713a123SBarry Smith { 3560dfbe8321SBarry Smith PetscErrorCode ierr; 356183a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 3562473a3ab2SBarry Smith PetscDraw draw; 35631713a123SBarry Smith 35641713a123SBarry Smith PetscFunctionBegin; 35656083293cSBarry Smith if (!step && ictx->showinitial) { 35666083293cSBarry Smith if (!ictx->initialsolution) { 35670910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 35681713a123SBarry Smith } 35690910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 35706083293cSBarry Smith } 3571b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 35720dcf80beSBarry Smith 35736083293cSBarry Smith if (ictx->showinitial) { 35746083293cSBarry Smith PetscReal pause; 35756083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 35766083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 35776083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 35786083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 35796083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 35806083293cSBarry Smith } 35810910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 3582473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 3583473a3ab2SBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 3584473a3ab2SBarry Smith char time[32]; 3585473a3ab2SBarry Smith size_t len; 3586473a3ab2SBarry Smith 3587473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 3588473a3ab2SBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 3589473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 3590473a3ab2SBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 35910298fd71SBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 3592473a3ab2SBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 3593473a3ab2SBarry Smith h = yl + .95*(yr - yl); 3594473a3ab2SBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 3595473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 3596473a3ab2SBarry Smith } 3597473a3ab2SBarry Smith 35986083293cSBarry Smith if (ictx->showinitial) { 35996083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 36006083293cSBarry Smith } 36011713a123SBarry Smith PetscFunctionReturn(0); 36021713a123SBarry Smith } 36031713a123SBarry Smith 36042d5ee99bSBarry Smith #undef __FUNCT__ 36052d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase" 36062d5ee99bSBarry Smith /*@C 36072d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 36082d5ee99bSBarry Smith 36092d5ee99bSBarry Smith Collective on TS 36102d5ee99bSBarry Smith 36112d5ee99bSBarry Smith Input Parameters: 36122d5ee99bSBarry Smith + ts - the TS context 36132d5ee99bSBarry Smith . step - current time-step 36142d5ee99bSBarry Smith . ptime - current time 36152d5ee99bSBarry Smith - dummy - either a viewer or NULL 36162d5ee99bSBarry Smith 36172d5ee99bSBarry Smith Level: intermediate 36182d5ee99bSBarry Smith 36192d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 36202d5ee99bSBarry Smith 36212d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 36222d5ee99bSBarry Smith @*/ 36232d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 36242d5ee99bSBarry Smith { 36252d5ee99bSBarry Smith PetscErrorCode ierr; 36262d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 36272d5ee99bSBarry Smith PetscDraw draw; 36282d5ee99bSBarry Smith MPI_Comm comm; 36292d5ee99bSBarry Smith PetscInt n; 36302d5ee99bSBarry Smith PetscMPIInt size; 36312d5ee99bSBarry Smith PetscReal xl,yl,xr,yr,tw,w,h; 36322d5ee99bSBarry Smith char time[32]; 36332d5ee99bSBarry Smith size_t len; 36342d5ee99bSBarry Smith const PetscScalar *U; 36352d5ee99bSBarry Smith 36362d5ee99bSBarry Smith PetscFunctionBegin; 36372d5ee99bSBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 36382d5ee99bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr); 36392d5ee99bSBarry Smith if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs"); 36402d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 36412d5ee99bSBarry Smith if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 36422d5ee99bSBarry Smith 36432d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 36442d5ee99bSBarry Smith 36452d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 36464b363babSBarry Smith ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 3647ba5783adSMatthew G Knepley if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) { 3648a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 3649a4494fc1SBarry Smith PetscFunctionReturn(0); 3650a4494fc1SBarry Smith } 36512d5ee99bSBarry Smith if (!step) ictx->color++; 36522d5ee99bSBarry Smith ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr); 36532d5ee99bSBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 36542d5ee99bSBarry Smith 36552d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 36564b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 36572d5ee99bSBarry Smith ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr); 36582d5ee99bSBarry Smith ierr = PetscStrlen(time,&len);CHKERRQ(ierr); 36592d5ee99bSBarry Smith ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr); 36602d5ee99bSBarry Smith w = xl + .5*(xr - xl) - .5*len*tw; 36612d5ee99bSBarry Smith h = yl + .95*(yr - yl); 36622d5ee99bSBarry Smith ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 36632d5ee99bSBarry Smith } 36642d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 36652d5ee99bSBarry Smith PetscFunctionReturn(0); 36662d5ee99bSBarry Smith } 36672d5ee99bSBarry Smith 36681713a123SBarry Smith 36696c699258SBarry Smith #undef __FUNCT__ 367083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy" 36716083293cSBarry Smith /*@C 367283a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 36736083293cSBarry Smith 36746083293cSBarry Smith Collective on TS 36756083293cSBarry Smith 36766083293cSBarry Smith Input Parameters: 36776083293cSBarry Smith . ctx - the monitor context 36786083293cSBarry Smith 36796083293cSBarry Smith Level: intermediate 36806083293cSBarry Smith 36816083293cSBarry Smith .keywords: TS, vector, monitor, view 36826083293cSBarry Smith 368383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 36846083293cSBarry Smith @*/ 368583a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 36866083293cSBarry Smith { 36876083293cSBarry Smith PetscErrorCode ierr; 36886083293cSBarry Smith 36896083293cSBarry Smith PetscFunctionBegin; 36904b363babSBarry Smith ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr); 369183a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 369283a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 369383a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 36946083293cSBarry Smith PetscFunctionReturn(0); 36956083293cSBarry Smith } 36966083293cSBarry Smith 36976083293cSBarry Smith #undef __FUNCT__ 369883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate" 36996083293cSBarry Smith /*@C 370083a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 37016083293cSBarry Smith 37026083293cSBarry Smith Collective on TS 37036083293cSBarry Smith 37046083293cSBarry Smith Input Parameter: 37056083293cSBarry Smith . ts - time-step context 37066083293cSBarry Smith 37076083293cSBarry Smith Output Patameter: 37086083293cSBarry Smith . ctx - the monitor context 37096083293cSBarry Smith 371099fdda47SBarry Smith Options Database: 371199fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 371299fdda47SBarry Smith 37136083293cSBarry Smith Level: intermediate 37146083293cSBarry Smith 37156083293cSBarry Smith .keywords: TS, vector, monitor, view 37166083293cSBarry Smith 371783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 37186083293cSBarry Smith @*/ 371983a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 37206083293cSBarry Smith { 37216083293cSBarry Smith PetscErrorCode ierr; 37226083293cSBarry Smith 37236083293cSBarry Smith PetscFunctionBegin; 3724b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 372583a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 3726e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 3727bbd56ea5SKarl Rupp 372883a4ac43SBarry Smith (*ctx)->howoften = howoften; 3729473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 37300298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 3731473a3ab2SBarry Smith 3732473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 37330298fd71SBarry Smith ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 37342d5ee99bSBarry Smith (*ctx)->color = PETSC_DRAW_WHITE; 37356083293cSBarry Smith PetscFunctionReturn(0); 37366083293cSBarry Smith } 37376083293cSBarry Smith 37386083293cSBarry Smith #undef __FUNCT__ 373983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError" 37403a471f94SBarry Smith /*@C 374183a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 37423a471f94SBarry Smith VecView() for the error at each timestep 37433a471f94SBarry Smith 37443a471f94SBarry Smith Collective on TS 37453a471f94SBarry Smith 37463a471f94SBarry Smith Input Parameters: 37473a471f94SBarry Smith + ts - the TS context 37483a471f94SBarry Smith . step - current time-step 37493a471f94SBarry Smith . ptime - current time 37500298fd71SBarry Smith - dummy - either a viewer or NULL 37513a471f94SBarry Smith 37523a471f94SBarry Smith Level: intermediate 37533a471f94SBarry Smith 37543a471f94SBarry Smith .keywords: TS, vector, monitor, view 37553a471f94SBarry Smith 37563a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 37573a471f94SBarry Smith @*/ 37580910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 37593a471f94SBarry Smith { 37603a471f94SBarry Smith PetscErrorCode ierr; 376183a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 376283a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 37633a471f94SBarry Smith Vec work; 37643a471f94SBarry Smith 37653a471f94SBarry Smith PetscFunctionBegin; 3766b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 37670910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 37683a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 37690910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 37703a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 37713a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 37723a471f94SBarry Smith PetscFunctionReturn(0); 37733a471f94SBarry Smith } 37743a471f94SBarry Smith 37752a34c10cSBarry Smith #include <petsc-private/dmimpl.h> 37763a471f94SBarry Smith #undef __FUNCT__ 37776c699258SBarry Smith #define __FUNCT__ "TSSetDM" 37786c699258SBarry Smith /*@ 37796c699258SBarry Smith TSSetDM - Sets the DM that may be used by some preconditioners 37806c699258SBarry Smith 37813f9fe445SBarry Smith Logically Collective on TS and DM 37826c699258SBarry Smith 37836c699258SBarry Smith Input Parameters: 37846c699258SBarry Smith + ts - the preconditioner context 37856c699258SBarry Smith - dm - the dm 37866c699258SBarry Smith 37876c699258SBarry Smith Level: intermediate 37886c699258SBarry Smith 37896c699258SBarry Smith 37906c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 37916c699258SBarry Smith @*/ 37927087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 37936c699258SBarry Smith { 37946c699258SBarry Smith PetscErrorCode ierr; 3795089b2837SJed Brown SNES snes; 3796942e3340SBarry Smith DMTS tsdm; 37976c699258SBarry Smith 37986c699258SBarry Smith PetscFunctionBegin; 37990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 380070663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 3801942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 38022a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 3803942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 3804942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 380524989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 380624989b8cSPeter Brune tsdm->originaldm = dm; 380724989b8cSPeter Brune } 380824989b8cSPeter Brune } 38096bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 381024989b8cSPeter Brune } 38116c699258SBarry Smith ts->dm = dm; 3812bbd56ea5SKarl Rupp 3813089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 3814089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 38156c699258SBarry Smith PetscFunctionReturn(0); 38166c699258SBarry Smith } 38176c699258SBarry Smith 38186c699258SBarry Smith #undef __FUNCT__ 38196c699258SBarry Smith #define __FUNCT__ "TSGetDM" 38206c699258SBarry Smith /*@ 38216c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 38226c699258SBarry Smith 38233f9fe445SBarry Smith Not Collective 38246c699258SBarry Smith 38256c699258SBarry Smith Input Parameter: 38266c699258SBarry Smith . ts - the preconditioner context 38276c699258SBarry Smith 38286c699258SBarry Smith Output Parameter: 38296c699258SBarry Smith . dm - the dm 38306c699258SBarry Smith 38316c699258SBarry Smith Level: intermediate 38326c699258SBarry Smith 38336c699258SBarry Smith 38346c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 38356c699258SBarry Smith @*/ 38367087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 38376c699258SBarry Smith { 3838496e6a7aSJed Brown PetscErrorCode ierr; 3839496e6a7aSJed Brown 38406c699258SBarry Smith PetscFunctionBegin; 38410700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3842496e6a7aSJed Brown if (!ts->dm) { 3843ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 3844496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 3845496e6a7aSJed Brown } 38466c699258SBarry Smith *dm = ts->dm; 38476c699258SBarry Smith PetscFunctionReturn(0); 38486c699258SBarry Smith } 38491713a123SBarry Smith 38500f5c6efeSJed Brown #undef __FUNCT__ 38510f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction" 38520f5c6efeSJed Brown /*@ 38530f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 38540f5c6efeSJed Brown 38553f9fe445SBarry Smith Logically Collective on SNES 38560f5c6efeSJed Brown 38570f5c6efeSJed Brown Input Parameter: 3858d42a1c89SJed Brown + snes - nonlinear solver 38590910c330SBarry Smith . U - the current state at which to evaluate the residual 3860d42a1c89SJed Brown - ctx - user context, must be a TS 38610f5c6efeSJed Brown 38620f5c6efeSJed Brown Output Parameter: 38630f5c6efeSJed Brown . F - the nonlinear residual 38640f5c6efeSJed Brown 38650f5c6efeSJed Brown Notes: 38660f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 38670f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 38680f5c6efeSJed Brown 38690f5c6efeSJed Brown Level: advanced 38700f5c6efeSJed Brown 38710f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 38720f5c6efeSJed Brown @*/ 38730910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 38740f5c6efeSJed Brown { 38750f5c6efeSJed Brown TS ts = (TS)ctx; 38760f5c6efeSJed Brown PetscErrorCode ierr; 38770f5c6efeSJed Brown 38780f5c6efeSJed Brown PetscFunctionBegin; 38790f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38800910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 38810f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 38820f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 38830910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 38840f5c6efeSJed Brown PetscFunctionReturn(0); 38850f5c6efeSJed Brown } 38860f5c6efeSJed Brown 38870f5c6efeSJed Brown #undef __FUNCT__ 38880f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian" 38890f5c6efeSJed Brown /*@ 38900f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 38910f5c6efeSJed Brown 38920f5c6efeSJed Brown Collective on SNES 38930f5c6efeSJed Brown 38940f5c6efeSJed Brown Input Parameter: 38950f5c6efeSJed Brown + snes - nonlinear solver 38960910c330SBarry Smith . U - the current state at which to evaluate the residual 38970f5c6efeSJed Brown - ctx - user context, must be a TS 38980f5c6efeSJed Brown 38990f5c6efeSJed Brown Output Parameter: 39000f5c6efeSJed Brown + A - the Jacobian 39010f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 39020f5c6efeSJed Brown - flag - indicates any structure change in the matrix 39030f5c6efeSJed Brown 39040f5c6efeSJed Brown Notes: 39050f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 39060f5c6efeSJed Brown 39070f5c6efeSJed Brown Level: developer 39080f5c6efeSJed Brown 39090f5c6efeSJed Brown .seealso: SNESSetJacobian() 39100f5c6efeSJed Brown @*/ 3911d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 39120f5c6efeSJed Brown { 39130f5c6efeSJed Brown TS ts = (TS)ctx; 39140f5c6efeSJed Brown PetscErrorCode ierr; 39150f5c6efeSJed Brown 39160f5c6efeSJed Brown PetscFunctionBegin; 39170f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39180910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 39190f5c6efeSJed Brown PetscValidPointer(A,3); 392094ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 39210f5c6efeSJed Brown PetscValidPointer(B,4); 392294ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 39230f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 3924d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 39250f5c6efeSJed Brown PetscFunctionReturn(0); 39260f5c6efeSJed Brown } 3927325fc9f4SBarry Smith 39280e4ef248SJed Brown #undef __FUNCT__ 39290e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear" 39300e4ef248SJed Brown /*@C 39310e4ef248SJed Brown TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only 39320e4ef248SJed Brown 39330e4ef248SJed Brown Collective on TS 39340e4ef248SJed Brown 39350e4ef248SJed Brown Input Arguments: 39360e4ef248SJed Brown + ts - time stepping context 39370e4ef248SJed Brown . t - time at which to evaluate 39380910c330SBarry Smith . U - state at which to evaluate 39390e4ef248SJed Brown - ctx - context 39400e4ef248SJed Brown 39410e4ef248SJed Brown Output Arguments: 39420e4ef248SJed Brown . F - right hand side 39430e4ef248SJed Brown 39440e4ef248SJed Brown Level: intermediate 39450e4ef248SJed Brown 39460e4ef248SJed Brown Notes: 39470e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 39480e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 39490e4ef248SJed Brown 39500e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 39510e4ef248SJed Brown @*/ 39520910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 39530e4ef248SJed Brown { 39540e4ef248SJed Brown PetscErrorCode ierr; 39550e4ef248SJed Brown Mat Arhs,Brhs; 39560e4ef248SJed Brown 39570e4ef248SJed Brown PetscFunctionBegin; 39580e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 3959d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 39600910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 39610e4ef248SJed Brown PetscFunctionReturn(0); 39620e4ef248SJed Brown } 39630e4ef248SJed Brown 39640e4ef248SJed Brown #undef __FUNCT__ 39650e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant" 39660e4ef248SJed Brown /*@C 39670e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 39680e4ef248SJed Brown 39690e4ef248SJed Brown Collective on TS 39700e4ef248SJed Brown 39710e4ef248SJed Brown Input Arguments: 39720e4ef248SJed Brown + ts - time stepping context 39730e4ef248SJed Brown . t - time at which to evaluate 39740910c330SBarry Smith . U - state at which to evaluate 39750e4ef248SJed Brown - ctx - context 39760e4ef248SJed Brown 39770e4ef248SJed Brown Output Arguments: 39780e4ef248SJed Brown + A - pointer to operator 39790e4ef248SJed Brown . B - pointer to preconditioning matrix 39800e4ef248SJed Brown - flg - matrix structure flag 39810e4ef248SJed Brown 39820e4ef248SJed Brown Level: intermediate 39830e4ef248SJed Brown 39840e4ef248SJed Brown Notes: 39850e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 39860e4ef248SJed Brown 39870e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 39880e4ef248SJed Brown @*/ 3989d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 39900e4ef248SJed Brown { 39910e4ef248SJed Brown PetscFunctionBegin; 39920e4ef248SJed Brown PetscFunctionReturn(0); 39930e4ef248SJed Brown } 39940e4ef248SJed Brown 39950026cea9SSean Farley #undef __FUNCT__ 39960026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear" 39970026cea9SSean Farley /*@C 39980026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 39990026cea9SSean Farley 40000026cea9SSean Farley Collective on TS 40010026cea9SSean Farley 40020026cea9SSean Farley Input Arguments: 40030026cea9SSean Farley + ts - time stepping context 40040026cea9SSean Farley . t - time at which to evaluate 40050910c330SBarry Smith . U - state at which to evaluate 40060910c330SBarry Smith . Udot - time derivative of state vector 40070026cea9SSean Farley - ctx - context 40080026cea9SSean Farley 40090026cea9SSean Farley Output Arguments: 40100026cea9SSean Farley . F - left hand side 40110026cea9SSean Farley 40120026cea9SSean Farley Level: intermediate 40130026cea9SSean Farley 40140026cea9SSean Farley Notes: 40150910c330SBarry 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 40160026cea9SSean Farley user is required to write their own TSComputeIFunction. 40170026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 40180026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 40190026cea9SSean Farley 40200026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant() 40210026cea9SSean Farley @*/ 40220910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 40230026cea9SSean Farley { 40240026cea9SSean Farley PetscErrorCode ierr; 40250026cea9SSean Farley Mat A,B; 40260026cea9SSean Farley 40270026cea9SSean Farley PetscFunctionBegin; 40280298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4029d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 40300910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 40310026cea9SSean Farley PetscFunctionReturn(0); 40320026cea9SSean Farley } 40330026cea9SSean Farley 40340026cea9SSean Farley #undef __FUNCT__ 40350026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant" 40360026cea9SSean Farley /*@C 4037b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 40380026cea9SSean Farley 40390026cea9SSean Farley Collective on TS 40400026cea9SSean Farley 40410026cea9SSean Farley Input Arguments: 40420026cea9SSean Farley + ts - time stepping context 40430026cea9SSean Farley . t - time at which to evaluate 40440910c330SBarry Smith . U - state at which to evaluate 40450910c330SBarry Smith . Udot - time derivative of state vector 40460026cea9SSean Farley . shift - shift to apply 40470026cea9SSean Farley - ctx - context 40480026cea9SSean Farley 40490026cea9SSean Farley Output Arguments: 40500026cea9SSean Farley + A - pointer to operator 40510026cea9SSean Farley . B - pointer to preconditioning matrix 40520026cea9SSean Farley - flg - matrix structure flag 40530026cea9SSean Farley 4054b41af12eSJed Brown Level: advanced 40550026cea9SSean Farley 40560026cea9SSean Farley Notes: 40570026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 40580026cea9SSean Farley 4059b41af12eSJed Brown It is only appropriate for problems of the form 4060b41af12eSJed Brown 4061b41af12eSJed Brown $ M Udot = F(U,t) 4062b41af12eSJed Brown 4063b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4064b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4065b41af12eSJed Brown an implicit operator of the form 4066b41af12eSJed Brown 4067b41af12eSJed Brown $ shift*M + J 4068b41af12eSJed Brown 4069b41af12eSJed 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 4070b41af12eSJed Brown a copy of M or reassemble it when requested. 4071b41af12eSJed Brown 40720026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 40730026cea9SSean Farley @*/ 4074d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 40750026cea9SSean Farley { 4076b41af12eSJed Brown PetscErrorCode ierr; 4077b41af12eSJed Brown 40780026cea9SSean Farley PetscFunctionBegin; 407994ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4080b41af12eSJed Brown ts->ijacobian.shift = shift; 40810026cea9SSean Farley PetscFunctionReturn(0); 40820026cea9SSean Farley } 4083b41af12eSJed Brown 4084e817cc15SEmil Constantinescu #undef __FUNCT__ 4085e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType" 4086e817cc15SEmil Constantinescu /*@ 4087e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4088e817cc15SEmil Constantinescu 4089e817cc15SEmil Constantinescu Not Collective 4090e817cc15SEmil Constantinescu 4091e817cc15SEmil Constantinescu Input Parameter: 4092e817cc15SEmil Constantinescu . ts - the TS context 4093e817cc15SEmil Constantinescu 4094e817cc15SEmil Constantinescu Output Parameter: 40954e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4096e817cc15SEmil Constantinescu 4097e817cc15SEmil Constantinescu Level: beginner 4098e817cc15SEmil Constantinescu 4099e817cc15SEmil Constantinescu .keywords: TS, equation type 4100e817cc15SEmil Constantinescu 4101e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4102e817cc15SEmil Constantinescu @*/ 4103e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4104e817cc15SEmil Constantinescu { 4105e817cc15SEmil Constantinescu PetscFunctionBegin; 4106e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4107e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4108e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4109e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4110e817cc15SEmil Constantinescu } 4111e817cc15SEmil Constantinescu 4112e817cc15SEmil Constantinescu #undef __FUNCT__ 4113e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType" 4114e817cc15SEmil Constantinescu /*@ 4115e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4116e817cc15SEmil Constantinescu 4117e817cc15SEmil Constantinescu Not Collective 4118e817cc15SEmil Constantinescu 4119e817cc15SEmil Constantinescu Input Parameter: 4120e817cc15SEmil Constantinescu + ts - the TS context 41214e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4122e817cc15SEmil Constantinescu 4123e817cc15SEmil Constantinescu Level: advanced 4124e817cc15SEmil Constantinescu 4125e817cc15SEmil Constantinescu .keywords: TS, equation type 4126e817cc15SEmil Constantinescu 4127e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4128e817cc15SEmil Constantinescu @*/ 4129e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4130e817cc15SEmil Constantinescu { 4131e817cc15SEmil Constantinescu PetscFunctionBegin; 4132e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4133e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4134e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4135e817cc15SEmil Constantinescu } 41360026cea9SSean Farley 41374af1b03aSJed Brown #undef __FUNCT__ 41384af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason" 41394af1b03aSJed Brown /*@ 41404af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 41414af1b03aSJed Brown 41424af1b03aSJed Brown Not Collective 41434af1b03aSJed Brown 41444af1b03aSJed Brown Input Parameter: 41454af1b03aSJed Brown . ts - the TS context 41464af1b03aSJed Brown 41474af1b03aSJed Brown Output Parameter: 41484af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 41494af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 41504af1b03aSJed Brown 4151487e0bb9SJed Brown Level: beginner 41524af1b03aSJed Brown 4153cd652676SJed Brown Notes: 4154cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 41554af1b03aSJed Brown 41564af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 41574af1b03aSJed Brown 41584af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 41594af1b03aSJed Brown @*/ 41604af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 41614af1b03aSJed Brown { 41624af1b03aSJed Brown PetscFunctionBegin; 41634af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41644af1b03aSJed Brown PetscValidPointer(reason,2); 41654af1b03aSJed Brown *reason = ts->reason; 41664af1b03aSJed Brown PetscFunctionReturn(0); 41674af1b03aSJed Brown } 41684af1b03aSJed Brown 4169fb1732b5SBarry Smith #undef __FUNCT__ 4170d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason" 4171d6ad946cSShri Abhyankar /*@ 4172d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 4173d6ad946cSShri Abhyankar 4174d6ad946cSShri Abhyankar Not Collective 4175d6ad946cSShri Abhyankar 4176d6ad946cSShri Abhyankar Input Parameter: 4177d6ad946cSShri Abhyankar + ts - the TS context 4178d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 4179d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 4180d6ad946cSShri Abhyankar 4181f5abba47SShri Abhyankar Level: advanced 4182d6ad946cSShri Abhyankar 4183d6ad946cSShri Abhyankar Notes: 4184d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 4185d6ad946cSShri Abhyankar 4186d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 4187d6ad946cSShri Abhyankar 4188d6ad946cSShri Abhyankar .seealso: TSConvergedReason 4189d6ad946cSShri Abhyankar @*/ 4190d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 4191d6ad946cSShri Abhyankar { 4192d6ad946cSShri Abhyankar PetscFunctionBegin; 4193d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4194d6ad946cSShri Abhyankar ts->reason = reason; 4195d6ad946cSShri Abhyankar PetscFunctionReturn(0); 4196d6ad946cSShri Abhyankar } 4197d6ad946cSShri Abhyankar 4198d6ad946cSShri Abhyankar #undef __FUNCT__ 4199cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime" 4200cc708dedSBarry Smith /*@ 4201cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 4202cc708dedSBarry Smith 4203cc708dedSBarry Smith Not Collective 4204cc708dedSBarry Smith 4205cc708dedSBarry Smith Input Parameter: 4206cc708dedSBarry Smith . ts - the TS context 4207cc708dedSBarry Smith 4208cc708dedSBarry Smith Output Parameter: 4209cc708dedSBarry Smith . ftime - the final time. This time should correspond to the final time set with TSSetDuration() 4210cc708dedSBarry Smith 4211487e0bb9SJed Brown Level: beginner 4212cc708dedSBarry Smith 4213cc708dedSBarry Smith Notes: 4214cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 4215cc708dedSBarry Smith 4216cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 4217cc708dedSBarry Smith 4218cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 4219cc708dedSBarry Smith @*/ 4220cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 4221cc708dedSBarry Smith { 4222cc708dedSBarry Smith PetscFunctionBegin; 4223cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4224cc708dedSBarry Smith PetscValidPointer(ftime,2); 4225cc708dedSBarry Smith *ftime = ts->solvetime; 4226cc708dedSBarry Smith PetscFunctionReturn(0); 4227cc708dedSBarry Smith } 4228cc708dedSBarry Smith 4229cc708dedSBarry Smith #undef __FUNCT__ 42305ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations" 42319f67acb7SJed Brown /*@ 42325ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 42339f67acb7SJed Brown used by the time integrator. 42349f67acb7SJed Brown 42359f67acb7SJed Brown Not Collective 42369f67acb7SJed Brown 42379f67acb7SJed Brown Input Parameter: 42389f67acb7SJed Brown . ts - TS context 42399f67acb7SJed Brown 42409f67acb7SJed Brown Output Parameter: 42419f67acb7SJed Brown . nits - number of nonlinear iterations 42429f67acb7SJed Brown 42439f67acb7SJed Brown Notes: 42449f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 42459f67acb7SJed Brown 42469f67acb7SJed Brown Level: intermediate 42479f67acb7SJed Brown 42489f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 42499f67acb7SJed Brown 42505ef26d82SJed Brown .seealso: TSGetKSPIterations() 42519f67acb7SJed Brown @*/ 42525ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 42539f67acb7SJed Brown { 42549f67acb7SJed Brown PetscFunctionBegin; 42559f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42569f67acb7SJed Brown PetscValidIntPointer(nits,2); 42575ef26d82SJed Brown *nits = ts->snes_its; 42589f67acb7SJed Brown PetscFunctionReturn(0); 42599f67acb7SJed Brown } 42609f67acb7SJed Brown 42619f67acb7SJed Brown #undef __FUNCT__ 42625ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations" 42639f67acb7SJed Brown /*@ 42645ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 42659f67acb7SJed Brown used by the time integrator. 42669f67acb7SJed Brown 42679f67acb7SJed Brown Not Collective 42689f67acb7SJed Brown 42699f67acb7SJed Brown Input Parameter: 42709f67acb7SJed Brown . ts - TS context 42719f67acb7SJed Brown 42729f67acb7SJed Brown Output Parameter: 42739f67acb7SJed Brown . lits - number of linear iterations 42749f67acb7SJed Brown 42759f67acb7SJed Brown Notes: 42769f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 42779f67acb7SJed Brown 42789f67acb7SJed Brown Level: intermediate 42799f67acb7SJed Brown 42809f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 42819f67acb7SJed Brown 42825ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 42839f67acb7SJed Brown @*/ 42845ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 42859f67acb7SJed Brown { 42869f67acb7SJed Brown PetscFunctionBegin; 42879f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42889f67acb7SJed Brown PetscValidIntPointer(lits,2); 42895ef26d82SJed Brown *lits = ts->ksp_its; 42909f67acb7SJed Brown PetscFunctionReturn(0); 42919f67acb7SJed Brown } 42929f67acb7SJed Brown 42939f67acb7SJed Brown #undef __FUNCT__ 4294cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections" 4295cef5090cSJed Brown /*@ 4296cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 4297cef5090cSJed Brown 4298cef5090cSJed Brown Not Collective 4299cef5090cSJed Brown 4300cef5090cSJed Brown Input Parameter: 4301cef5090cSJed Brown . ts - TS context 4302cef5090cSJed Brown 4303cef5090cSJed Brown Output Parameter: 4304cef5090cSJed Brown . rejects - number of steps rejected 4305cef5090cSJed Brown 4306cef5090cSJed Brown Notes: 4307cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4308cef5090cSJed Brown 4309cef5090cSJed Brown Level: intermediate 4310cef5090cSJed Brown 4311cef5090cSJed Brown .keywords: TS, get, number 4312cef5090cSJed Brown 43135ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 4314cef5090cSJed Brown @*/ 4315cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 4316cef5090cSJed Brown { 4317cef5090cSJed Brown PetscFunctionBegin; 4318cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4319cef5090cSJed Brown PetscValidIntPointer(rejects,2); 4320cef5090cSJed Brown *rejects = ts->reject; 4321cef5090cSJed Brown PetscFunctionReturn(0); 4322cef5090cSJed Brown } 4323cef5090cSJed Brown 4324cef5090cSJed Brown #undef __FUNCT__ 4325cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures" 4326cef5090cSJed Brown /*@ 4327cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 4328cef5090cSJed Brown 4329cef5090cSJed Brown Not Collective 4330cef5090cSJed Brown 4331cef5090cSJed Brown Input Parameter: 4332cef5090cSJed Brown . ts - TS context 4333cef5090cSJed Brown 4334cef5090cSJed Brown Output Parameter: 4335cef5090cSJed Brown . fails - number of failed nonlinear solves 4336cef5090cSJed Brown 4337cef5090cSJed Brown Notes: 4338cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4339cef5090cSJed Brown 4340cef5090cSJed Brown Level: intermediate 4341cef5090cSJed Brown 4342cef5090cSJed Brown .keywords: TS, get, number 4343cef5090cSJed Brown 43445ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 4345cef5090cSJed Brown @*/ 4346cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 4347cef5090cSJed Brown { 4348cef5090cSJed Brown PetscFunctionBegin; 4349cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4350cef5090cSJed Brown PetscValidIntPointer(fails,2); 4351cef5090cSJed Brown *fails = ts->num_snes_failures; 4352cef5090cSJed Brown PetscFunctionReturn(0); 4353cef5090cSJed Brown } 4354cef5090cSJed Brown 4355cef5090cSJed Brown #undef __FUNCT__ 4356cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections" 4357cef5090cSJed Brown /*@ 4358cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 4359cef5090cSJed Brown 4360cef5090cSJed Brown Not Collective 4361cef5090cSJed Brown 4362cef5090cSJed Brown Input Parameter: 4363cef5090cSJed Brown + ts - TS context 4364cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 4365cef5090cSJed Brown 4366cef5090cSJed Brown Notes: 4367cef5090cSJed Brown The counter is reset to zero for each step 4368cef5090cSJed Brown 4369cef5090cSJed Brown Options Database Key: 4370cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 4371cef5090cSJed Brown 4372cef5090cSJed Brown Level: intermediate 4373cef5090cSJed Brown 4374cef5090cSJed Brown .keywords: TS, set, maximum, number 4375cef5090cSJed Brown 43765ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4377cef5090cSJed Brown @*/ 4378cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 4379cef5090cSJed Brown { 4380cef5090cSJed Brown PetscFunctionBegin; 4381cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4382cef5090cSJed Brown ts->max_reject = rejects; 4383cef5090cSJed Brown PetscFunctionReturn(0); 4384cef5090cSJed Brown } 4385cef5090cSJed Brown 4386cef5090cSJed Brown #undef __FUNCT__ 4387cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures" 4388cef5090cSJed Brown /*@ 4389cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 4390cef5090cSJed Brown 4391cef5090cSJed Brown Not Collective 4392cef5090cSJed Brown 4393cef5090cSJed Brown Input Parameter: 4394cef5090cSJed Brown + ts - TS context 4395cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4396cef5090cSJed Brown 4397cef5090cSJed Brown Notes: 4398cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 4399cef5090cSJed Brown 4400cef5090cSJed Brown Options Database Key: 4401cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4402cef5090cSJed Brown 4403cef5090cSJed Brown Level: intermediate 4404cef5090cSJed Brown 4405cef5090cSJed Brown .keywords: TS, set, maximum, number 4406cef5090cSJed Brown 44075ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 4408cef5090cSJed Brown @*/ 4409cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 4410cef5090cSJed Brown { 4411cef5090cSJed Brown PetscFunctionBegin; 4412cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4413cef5090cSJed Brown ts->max_snes_failures = fails; 4414cef5090cSJed Brown PetscFunctionReturn(0); 4415cef5090cSJed Brown } 4416cef5090cSJed Brown 4417cef5090cSJed Brown #undef __FUNCT__ 44184e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails" 4419cef5090cSJed Brown /*@ 4420cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 4421cef5090cSJed Brown 4422cef5090cSJed Brown Not Collective 4423cef5090cSJed Brown 4424cef5090cSJed Brown Input Parameter: 4425cef5090cSJed Brown + ts - TS context 4426cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 4427cef5090cSJed Brown 4428cef5090cSJed Brown Options Database Key: 4429cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 4430cef5090cSJed Brown 4431cef5090cSJed Brown Level: intermediate 4432cef5090cSJed Brown 4433cef5090cSJed Brown .keywords: TS, set, error 4434cef5090cSJed Brown 44355ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 4436cef5090cSJed Brown @*/ 4437cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 4438cef5090cSJed Brown { 4439cef5090cSJed Brown PetscFunctionBegin; 4440cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4441cef5090cSJed Brown ts->errorifstepfailed = err; 4442cef5090cSJed Brown PetscFunctionReturn(0); 4443cef5090cSJed Brown } 4444cef5090cSJed Brown 4445cef5090cSJed Brown #undef __FUNCT__ 4446fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary" 4447fb1732b5SBarry Smith /*@C 4448fb1732b5SBarry Smith TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file 4449fb1732b5SBarry Smith 4450fb1732b5SBarry Smith Collective on TS 4451fb1732b5SBarry Smith 4452fb1732b5SBarry Smith Input Parameters: 4453fb1732b5SBarry Smith + ts - the TS context 4454fb1732b5SBarry Smith . step - current time-step 4455fb1732b5SBarry Smith . ptime - current time 44560910c330SBarry Smith . u - current state 4457fb1732b5SBarry Smith - viewer - binary viewer 4458fb1732b5SBarry Smith 4459fb1732b5SBarry Smith Level: intermediate 4460fb1732b5SBarry Smith 4461fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 4462fb1732b5SBarry Smith 4463fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4464fb1732b5SBarry Smith @*/ 44650910c330SBarry Smith PetscErrorCode TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer) 4466fb1732b5SBarry Smith { 4467fb1732b5SBarry Smith PetscErrorCode ierr; 4468ed81e22dSJed Brown PetscViewer v = (PetscViewer)viewer; 4469fb1732b5SBarry Smith 4470fb1732b5SBarry Smith PetscFunctionBegin; 44710910c330SBarry Smith ierr = VecView(u,v);CHKERRQ(ierr); 4472ed81e22dSJed Brown PetscFunctionReturn(0); 4473ed81e22dSJed Brown } 4474ed81e22dSJed Brown 4475ed81e22dSJed Brown #undef __FUNCT__ 4476ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK" 4477ed81e22dSJed Brown /*@C 4478ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 4479ed81e22dSJed Brown 4480ed81e22dSJed Brown Collective on TS 4481ed81e22dSJed Brown 4482ed81e22dSJed Brown Input Parameters: 4483ed81e22dSJed Brown + ts - the TS context 4484ed81e22dSJed Brown . step - current time-step 4485ed81e22dSJed Brown . ptime - current time 44860910c330SBarry Smith . u - current state 4487ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4488ed81e22dSJed Brown 4489ed81e22dSJed Brown Level: intermediate 4490ed81e22dSJed Brown 4491ed81e22dSJed Brown Notes: 4492ed81e22dSJed 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. 4493ed81e22dSJed Brown These are named according to the file name template. 4494ed81e22dSJed Brown 4495ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 4496ed81e22dSJed Brown 4497ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4498ed81e22dSJed Brown 4499ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 4500ed81e22dSJed Brown @*/ 45010910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 4502ed81e22dSJed Brown { 4503ed81e22dSJed Brown PetscErrorCode ierr; 4504ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 4505ed81e22dSJed Brown PetscViewer viewer; 4506ed81e22dSJed Brown 4507ed81e22dSJed Brown PetscFunctionBegin; 45088caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 4509ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 45100910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 4511ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 4512ed81e22dSJed Brown PetscFunctionReturn(0); 4513ed81e22dSJed Brown } 4514ed81e22dSJed Brown 4515ed81e22dSJed Brown #undef __FUNCT__ 4516ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy" 4517ed81e22dSJed Brown /*@C 4518ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 4519ed81e22dSJed Brown 4520ed81e22dSJed Brown Collective on TS 4521ed81e22dSJed Brown 4522ed81e22dSJed Brown Input Parameters: 4523ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 4524ed81e22dSJed Brown 4525ed81e22dSJed Brown Level: intermediate 4526ed81e22dSJed Brown 4527ed81e22dSJed Brown Note: 4528ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 4529ed81e22dSJed Brown 4530ed81e22dSJed Brown .keywords: TS, vector, monitor, view 4531ed81e22dSJed Brown 4532ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 4533ed81e22dSJed Brown @*/ 4534ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 4535ed81e22dSJed Brown { 4536ed81e22dSJed Brown PetscErrorCode ierr; 4537ed81e22dSJed Brown 4538ed81e22dSJed Brown PetscFunctionBegin; 4539ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 4540fb1732b5SBarry Smith PetscFunctionReturn(0); 4541fb1732b5SBarry Smith } 4542fb1732b5SBarry Smith 454384df9cb4SJed Brown #undef __FUNCT__ 4544552698daSJed Brown #define __FUNCT__ "TSGetAdapt" 454584df9cb4SJed Brown /*@ 4546552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 454784df9cb4SJed Brown 4548ed81e22dSJed Brown Collective on TS if controller has not been created yet 454984df9cb4SJed Brown 455084df9cb4SJed Brown Input Arguments: 4551ed81e22dSJed Brown . ts - time stepping context 455284df9cb4SJed Brown 455384df9cb4SJed Brown Output Arguments: 4554ed81e22dSJed Brown . adapt - adaptive controller 455584df9cb4SJed Brown 455684df9cb4SJed Brown Level: intermediate 455784df9cb4SJed Brown 4558ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 455984df9cb4SJed Brown @*/ 4560552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 456184df9cb4SJed Brown { 456284df9cb4SJed Brown PetscErrorCode ierr; 456384df9cb4SJed Brown 456484df9cb4SJed Brown PetscFunctionBegin; 456584df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 456684df9cb4SJed Brown PetscValidPointer(adapt,2); 456784df9cb4SJed Brown if (!ts->adapt) { 4568ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 45693bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 45701c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 457184df9cb4SJed Brown } 457284df9cb4SJed Brown *adapt = ts->adapt; 457384df9cb4SJed Brown PetscFunctionReturn(0); 457484df9cb4SJed Brown } 4575d6ebe24aSShri Abhyankar 4576d6ebe24aSShri Abhyankar #undef __FUNCT__ 45771c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances" 45781c3436cfSJed Brown /*@ 45791c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 45801c3436cfSJed Brown 45811c3436cfSJed Brown Logically Collective 45821c3436cfSJed Brown 45831c3436cfSJed Brown Input Arguments: 45841c3436cfSJed Brown + ts - time integration context 45851c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 45860298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 45871c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 45880298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 45891c3436cfSJed Brown 4590a3cdaa26SBarry Smith Options Database keys: 4591a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 4592a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 4593a3cdaa26SBarry Smith 45941c3436cfSJed Brown Level: beginner 45951c3436cfSJed Brown 4596c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 45971c3436cfSJed Brown @*/ 45981c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 45991c3436cfSJed Brown { 46001c3436cfSJed Brown PetscErrorCode ierr; 46011c3436cfSJed Brown 46021c3436cfSJed Brown PetscFunctionBegin; 4603c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 46041c3436cfSJed Brown if (vatol) { 46051c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 46061c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 4607bbd56ea5SKarl Rupp 46081c3436cfSJed Brown ts->vatol = vatol; 46091c3436cfSJed Brown } 4610c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 46111c3436cfSJed Brown if (vrtol) { 46121c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 46131c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 4614bbd56ea5SKarl Rupp 46151c3436cfSJed Brown ts->vrtol = vrtol; 46161c3436cfSJed Brown } 46171c3436cfSJed Brown PetscFunctionReturn(0); 46181c3436cfSJed Brown } 46191c3436cfSJed Brown 46201c3436cfSJed Brown #undef __FUNCT__ 4621c5033834SJed Brown #define __FUNCT__ "TSGetTolerances" 4622c5033834SJed Brown /*@ 4623c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4624c5033834SJed Brown 4625c5033834SJed Brown Logically Collective 4626c5033834SJed Brown 4627c5033834SJed Brown Input Arguments: 4628c5033834SJed Brown . ts - time integration context 4629c5033834SJed Brown 4630c5033834SJed Brown Output Arguments: 46310298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 46320298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 46330298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 46340298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 4635c5033834SJed Brown 4636c5033834SJed Brown Level: beginner 4637c5033834SJed Brown 4638c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 4639c5033834SJed Brown @*/ 4640c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 4641c5033834SJed Brown { 4642c5033834SJed Brown PetscFunctionBegin; 4643c5033834SJed Brown if (atol) *atol = ts->atol; 4644c5033834SJed Brown if (vatol) *vatol = ts->vatol; 4645c5033834SJed Brown if (rtol) *rtol = ts->rtol; 4646c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 4647c5033834SJed Brown PetscFunctionReturn(0); 4648c5033834SJed Brown } 4649c5033834SJed Brown 4650c5033834SJed Brown #undef __FUNCT__ 46511c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS" 46521c3436cfSJed Brown /*@ 46531c3436cfSJed Brown TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state 46541c3436cfSJed Brown 46551c3436cfSJed Brown Collective on TS 46561c3436cfSJed Brown 46571c3436cfSJed Brown Input Arguments: 46581c3436cfSJed Brown + ts - time stepping context 46591c3436cfSJed Brown - Y - state vector to be compared to ts->vec_sol 46601c3436cfSJed Brown 46611c3436cfSJed Brown Output Arguments: 46621c3436cfSJed Brown . norm - weighted norm, a value of 1.0 is considered small 46631c3436cfSJed Brown 46641c3436cfSJed Brown Level: developer 46651c3436cfSJed Brown 46661c3436cfSJed Brown .seealso: TSSetTolerances() 46671c3436cfSJed Brown @*/ 46681c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm) 46691c3436cfSJed Brown { 46701c3436cfSJed Brown PetscErrorCode ierr; 46711c3436cfSJed Brown PetscInt i,n,N; 46720910c330SBarry Smith const PetscScalar *u,*y; 46730910c330SBarry Smith Vec U; 46741c3436cfSJed Brown PetscReal sum,gsum; 46751c3436cfSJed Brown 46761c3436cfSJed Brown PetscFunctionBegin; 46771c3436cfSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46781c3436cfSJed Brown PetscValidHeaderSpecific(Y,VEC_CLASSID,2); 46791c3436cfSJed Brown PetscValidPointer(norm,3); 46800910c330SBarry Smith U = ts->vec_sol; 46810910c330SBarry Smith PetscCheckSameTypeAndComm(U,1,Y,2); 4682ce94432eSBarry Smith if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector"); 46831c3436cfSJed Brown 46840910c330SBarry Smith ierr = VecGetSize(U,&N);CHKERRQ(ierr); 46850910c330SBarry Smith ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 46860910c330SBarry Smith ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 46871c3436cfSJed Brown ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 46881c3436cfSJed Brown sum = 0.; 4689ceefc113SJed Brown if (ts->vatol && ts->vrtol) { 4690ceefc113SJed Brown const PetscScalar *atol,*rtol; 4691ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4692ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4693ceefc113SJed Brown for (i=0; i<n; i++) { 46940910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 46950910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4696ceefc113SJed Brown } 4697ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4698ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4699ceefc113SJed Brown } else if (ts->vatol) { /* vector atol, scalar rtol */ 4700ceefc113SJed Brown const PetscScalar *atol; 4701ceefc113SJed Brown ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4702ceefc113SJed Brown for (i=0; i<n; i++) { 47030910c330SBarry Smith PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 47040910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4705ceefc113SJed Brown } 4706ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 4707ceefc113SJed Brown } else if (ts->vrtol) { /* scalar atol, vector rtol */ 4708ceefc113SJed Brown const PetscScalar *rtol; 4709ceefc113SJed Brown ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4710ceefc113SJed Brown for (i=0; i<n; i++) { 47110910c330SBarry Smith PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 47120910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 4713ceefc113SJed Brown } 4714ceefc113SJed Brown ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 4715ceefc113SJed Brown } else { /* scalar atol, scalar rtol */ 47161c3436cfSJed Brown for (i=0; i<n; i++) { 47170910c330SBarry Smith PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 47180910c330SBarry Smith sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol); 47191c3436cfSJed Brown } 4720ceefc113SJed Brown } 47210910c330SBarry Smith ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 47221c3436cfSJed Brown ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 47231c3436cfSJed Brown 4724ce94432eSBarry Smith ierr = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 47251c3436cfSJed Brown *norm = PetscSqrtReal(gsum / N); 4726620fc8aaSSatish Balay if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 47271c3436cfSJed Brown PetscFunctionReturn(0); 47281c3436cfSJed Brown } 47291c3436cfSJed Brown 47301c3436cfSJed Brown #undef __FUNCT__ 47318d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal" 47328d59e960SJed Brown /*@ 47338d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 47348d59e960SJed Brown 47358d59e960SJed Brown Logically Collective on TS 47368d59e960SJed Brown 47378d59e960SJed Brown Input Arguments: 47388d59e960SJed Brown + ts - time stepping context 47398d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 47408d59e960SJed Brown 47418d59e960SJed Brown Note: 47428d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 47438d59e960SJed Brown 47448d59e960SJed Brown Level: intermediate 47458d59e960SJed Brown 47468d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 47478d59e960SJed Brown @*/ 47488d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 47498d59e960SJed Brown { 47508d59e960SJed Brown PetscFunctionBegin; 47518d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 47528d59e960SJed Brown ts->cfltime_local = cfltime; 47538d59e960SJed Brown ts->cfltime = -1.; 47548d59e960SJed Brown PetscFunctionReturn(0); 47558d59e960SJed Brown } 47568d59e960SJed Brown 47578d59e960SJed Brown #undef __FUNCT__ 47588d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime" 47598d59e960SJed Brown /*@ 47608d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 47618d59e960SJed Brown 47628d59e960SJed Brown Collective on TS 47638d59e960SJed Brown 47648d59e960SJed Brown Input Arguments: 47658d59e960SJed Brown . ts - time stepping context 47668d59e960SJed Brown 47678d59e960SJed Brown Output Arguments: 47688d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 47698d59e960SJed Brown 47708d59e960SJed Brown Level: advanced 47718d59e960SJed Brown 47728d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 47738d59e960SJed Brown @*/ 47748d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 47758d59e960SJed Brown { 47768d59e960SJed Brown PetscErrorCode ierr; 47778d59e960SJed Brown 47788d59e960SJed Brown PetscFunctionBegin; 47798d59e960SJed Brown if (ts->cfltime < 0) { 4780ce94432eSBarry Smith ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 47818d59e960SJed Brown } 47828d59e960SJed Brown *cfltime = ts->cfltime; 47838d59e960SJed Brown PetscFunctionReturn(0); 47848d59e960SJed Brown } 47858d59e960SJed Brown 47868d59e960SJed Brown #undef __FUNCT__ 4787d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds" 4788d6ebe24aSShri Abhyankar /*@ 4789d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 4790d6ebe24aSShri Abhyankar 4791d6ebe24aSShri Abhyankar Input Parameters: 4792d6ebe24aSShri Abhyankar . ts - the TS context. 4793d6ebe24aSShri Abhyankar . xl - lower bound. 4794d6ebe24aSShri Abhyankar . xu - upper bound. 4795d6ebe24aSShri Abhyankar 4796d6ebe24aSShri Abhyankar Notes: 4797d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 4798e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 4799d6ebe24aSShri Abhyankar 48002bd2b0e6SSatish Balay Level: advanced 48012bd2b0e6SSatish Balay 4802d6ebe24aSShri Abhyankar @*/ 4803d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 4804d6ebe24aSShri Abhyankar { 4805d6ebe24aSShri Abhyankar PetscErrorCode ierr; 4806d6ebe24aSShri Abhyankar SNES snes; 4807d6ebe24aSShri Abhyankar 4808d6ebe24aSShri Abhyankar PetscFunctionBegin; 4809d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4810d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 4811d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 4812d6ebe24aSShri Abhyankar } 4813d6ebe24aSShri Abhyankar 4814325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4815c6db04a5SJed Brown #include <mex.h> 4816325fc9f4SBarry Smith 4817325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 4818325fc9f4SBarry Smith 4819325fc9f4SBarry Smith #undef __FUNCT__ 4820325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab" 4821325fc9f4SBarry Smith /* 4822325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 4823325fc9f4SBarry Smith TSSetFunctionMatlab(). 4824325fc9f4SBarry Smith 4825325fc9f4SBarry Smith Collective on TS 4826325fc9f4SBarry Smith 4827325fc9f4SBarry Smith Input Parameters: 4828325fc9f4SBarry Smith + snes - the TS context 48290910c330SBarry Smith - u - input vector 4830325fc9f4SBarry Smith 4831325fc9f4SBarry Smith Output Parameter: 4832325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 4833325fc9f4SBarry Smith 4834325fc9f4SBarry Smith Notes: 4835325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 4836325fc9f4SBarry Smith implementations, so most users would not generally call this routine 4837325fc9f4SBarry Smith themselves. 4838325fc9f4SBarry Smith 4839325fc9f4SBarry Smith Level: developer 4840325fc9f4SBarry Smith 4841325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4842325fc9f4SBarry Smith 4843325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4844325fc9f4SBarry Smith */ 48450910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 4846325fc9f4SBarry Smith { 4847325fc9f4SBarry Smith PetscErrorCode ierr; 4848325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4849325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 4850325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 4851325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 4852325fc9f4SBarry Smith 4853325fc9f4SBarry Smith PetscFunctionBegin; 4854325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 48550910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 48560910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 4857325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 48580910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 4859325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 4860325fc9f4SBarry Smith 4861325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 48620910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 48630910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 48640910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 4865bbd56ea5SKarl Rupp 4866325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4867325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 4868325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4869325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4870325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 4871325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 4872325fc9f4SBarry Smith prhs[6] = sctx->ctx; 4873325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 4874325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4875325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4876325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4877325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4878325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4879325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4880325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4881325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4882325fc9f4SBarry Smith PetscFunctionReturn(0); 4883325fc9f4SBarry Smith } 4884325fc9f4SBarry Smith 4885325fc9f4SBarry Smith 4886325fc9f4SBarry Smith #undef __FUNCT__ 4887325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab" 4888325fc9f4SBarry Smith /* 4889325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 4890325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 4891e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 4892325fc9f4SBarry Smith 4893325fc9f4SBarry Smith Logically Collective on TS 4894325fc9f4SBarry Smith 4895325fc9f4SBarry Smith Input Parameters: 4896325fc9f4SBarry Smith + ts - the TS context 4897325fc9f4SBarry Smith - func - function evaluation routine 4898325fc9f4SBarry Smith 4899325fc9f4SBarry Smith Calling sequence of func: 49000910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 4901325fc9f4SBarry Smith 4902325fc9f4SBarry Smith Level: beginner 4903325fc9f4SBarry Smith 4904325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 4905325fc9f4SBarry Smith 4906325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 4907325fc9f4SBarry Smith */ 4908cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 4909325fc9f4SBarry Smith { 4910325fc9f4SBarry Smith PetscErrorCode ierr; 4911325fc9f4SBarry Smith TSMatlabContext *sctx; 4912325fc9f4SBarry Smith 4913325fc9f4SBarry Smith PetscFunctionBegin; 4914325fc9f4SBarry Smith /* currently sctx is memory bleed */ 4915325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 4916325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 4917325fc9f4SBarry Smith /* 4918325fc9f4SBarry Smith This should work, but it doesn't 4919325fc9f4SBarry Smith sctx->ctx = ctx; 4920325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 4921325fc9f4SBarry Smith */ 4922325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 4923bbd56ea5SKarl Rupp 49240298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 4925325fc9f4SBarry Smith PetscFunctionReturn(0); 4926325fc9f4SBarry Smith } 4927325fc9f4SBarry Smith 4928325fc9f4SBarry Smith #undef __FUNCT__ 4929325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab" 4930325fc9f4SBarry Smith /* 4931325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 4932325fc9f4SBarry Smith TSSetJacobianMatlab(). 4933325fc9f4SBarry Smith 4934325fc9f4SBarry Smith Collective on TS 4935325fc9f4SBarry Smith 4936325fc9f4SBarry Smith Input Parameters: 4937cdcf91faSSean Farley + ts - the TS context 49380910c330SBarry Smith . u - input vector 4939325fc9f4SBarry Smith . A, B - the matrices 4940325fc9f4SBarry Smith - ctx - user context 4941325fc9f4SBarry Smith 4942325fc9f4SBarry Smith Level: developer 4943325fc9f4SBarry Smith 4944325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 4945325fc9f4SBarry Smith 4946325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 4947325fc9f4SBarry Smith @*/ 4948f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 4949325fc9f4SBarry Smith { 4950325fc9f4SBarry Smith PetscErrorCode ierr; 4951325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 4952325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 4953325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 4954325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 4955325fc9f4SBarry Smith 4956325fc9f4SBarry Smith PetscFunctionBegin; 4957cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49580910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 4959325fc9f4SBarry Smith 49600910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 4961325fc9f4SBarry Smith 4962cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 49630910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 49640910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 49650910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 49660910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 4967bbd56ea5SKarl Rupp 4968325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 4969325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 4970325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 4971325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 4972325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 4973325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 4974325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 4975325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 4976325fc9f4SBarry Smith prhs[8] = sctx->ctx; 4977325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 4978325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4979325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 4980325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 4981325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 4982325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 4983325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 4984325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 4985325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 4986325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 4987325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 4988325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 4989325fc9f4SBarry Smith PetscFunctionReturn(0); 4990325fc9f4SBarry Smith } 4991325fc9f4SBarry Smith 4992325fc9f4SBarry Smith 4993325fc9f4SBarry Smith #undef __FUNCT__ 4994325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab" 4995325fc9f4SBarry Smith /* 4996325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 4997e3c5b3baSBarry 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 4998325fc9f4SBarry Smith 4999325fc9f4SBarry Smith Logically Collective on TS 5000325fc9f4SBarry Smith 5001325fc9f4SBarry Smith Input Parameters: 5002cdcf91faSSean Farley + ts - the TS context 5003325fc9f4SBarry Smith . A,B - Jacobian matrices 5004325fc9f4SBarry Smith . func - function evaluation routine 5005325fc9f4SBarry Smith - ctx - user context 5006325fc9f4SBarry Smith 5007325fc9f4SBarry Smith Calling sequence of func: 50080910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 5009325fc9f4SBarry Smith 5010325fc9f4SBarry Smith 5011325fc9f4SBarry Smith Level: developer 5012325fc9f4SBarry Smith 5013325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 5014325fc9f4SBarry Smith 5015325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5016325fc9f4SBarry Smith */ 5017cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 5018325fc9f4SBarry Smith { 5019325fc9f4SBarry Smith PetscErrorCode ierr; 5020325fc9f4SBarry Smith TSMatlabContext *sctx; 5021325fc9f4SBarry Smith 5022325fc9f4SBarry Smith PetscFunctionBegin; 5023325fc9f4SBarry Smith /* currently sctx is memory bleed */ 5024325fc9f4SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5025325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5026325fc9f4SBarry Smith /* 5027325fc9f4SBarry Smith This should work, but it doesn't 5028325fc9f4SBarry Smith sctx->ctx = ctx; 5029325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5030325fc9f4SBarry Smith */ 5031325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5032bbd56ea5SKarl Rupp 5033cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 5034325fc9f4SBarry Smith PetscFunctionReturn(0); 5035325fc9f4SBarry Smith } 5036325fc9f4SBarry Smith 5037b5b1a830SBarry Smith #undef __FUNCT__ 5038b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab" 5039b5b1a830SBarry Smith /* 5040b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 5041b5b1a830SBarry Smith 5042b5b1a830SBarry Smith Collective on TS 5043b5b1a830SBarry Smith 5044b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 5045b5b1a830SBarry Smith @*/ 50460910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 5047b5b1a830SBarry Smith { 5048b5b1a830SBarry Smith PetscErrorCode ierr; 5049b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 5050a530c242SBarry Smith int nlhs = 1,nrhs = 6; 5051b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 5052b5b1a830SBarry Smith long long int lx = 0,ls = 0; 5053b5b1a830SBarry Smith 5054b5b1a830SBarry Smith PetscFunctionBegin; 5055cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 50560910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 5057b5b1a830SBarry Smith 5058cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 50590910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 5060bbd56ea5SKarl Rupp 5061b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 5062b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 5063b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 5064b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 5065b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 5066b5b1a830SBarry Smith prhs[5] = sctx->ctx; 5067b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 5068b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 5069b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 5070b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 5071b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 5072b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 5073b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 5074b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 5075b5b1a830SBarry Smith PetscFunctionReturn(0); 5076b5b1a830SBarry Smith } 5077b5b1a830SBarry Smith 5078b5b1a830SBarry Smith 5079b5b1a830SBarry Smith #undef __FUNCT__ 5080b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab" 5081b5b1a830SBarry Smith /* 5082b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 5083b5b1a830SBarry Smith 5084b5b1a830SBarry Smith Level: developer 5085b5b1a830SBarry Smith 5086b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 5087b5b1a830SBarry Smith 5088b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 5089b5b1a830SBarry Smith */ 5090cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 5091b5b1a830SBarry Smith { 5092b5b1a830SBarry Smith PetscErrorCode ierr; 5093b5b1a830SBarry Smith TSMatlabContext *sctx; 5094b5b1a830SBarry Smith 5095b5b1a830SBarry Smith PetscFunctionBegin; 5096b5b1a830SBarry Smith /* currently sctx is memory bleed */ 5097b5b1a830SBarry Smith ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr); 5098b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 5099b5b1a830SBarry Smith /* 5100b5b1a830SBarry Smith This should work, but it doesn't 5101b5b1a830SBarry Smith sctx->ctx = ctx; 5102b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 5103b5b1a830SBarry Smith */ 5104b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 5105bbd56ea5SKarl Rupp 51060298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 5107b5b1a830SBarry Smith PetscFunctionReturn(0); 5108b5b1a830SBarry Smith } 5109325fc9f4SBarry Smith #endif 5110b3603a34SBarry Smith 51110b039ecaSBarry Smith 51120b039ecaSBarry Smith 5113b3603a34SBarry Smith #undef __FUNCT__ 51144f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution" 5115b3603a34SBarry Smith /*@C 51164f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 5117b3603a34SBarry Smith in a time based line graph 5118b3603a34SBarry Smith 5119b3603a34SBarry Smith Collective on TS 5120b3603a34SBarry Smith 5121b3603a34SBarry Smith Input Parameters: 5122b3603a34SBarry Smith + ts - the TS context 5123b3603a34SBarry Smith . step - current time-step 5124b3603a34SBarry Smith . ptime - current time 5125b3603a34SBarry Smith - lg - a line graph object 5126b3603a34SBarry Smith 5127b3603a34SBarry Smith Level: intermediate 5128b3603a34SBarry Smith 51290b039ecaSBarry Smith Notes: each process in a parallel run displays its component solutions in a separate window 5130b3603a34SBarry Smith 5131b3603a34SBarry Smith .keywords: TS, vector, monitor, view 5132b3603a34SBarry Smith 5133b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5134b3603a34SBarry Smith @*/ 51350910c330SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 5136b3603a34SBarry Smith { 5137b3603a34SBarry Smith PetscErrorCode ierr; 51380b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 5139b3603a34SBarry Smith const PetscScalar *yy; 514058ff32f7SBarry Smith PetscInt dim; 5141b3603a34SBarry Smith 5142b3603a34SBarry Smith PetscFunctionBegin; 514358ff32f7SBarry Smith if (!step) { 5144a9f9c1f6SBarry Smith PetscDrawAxis axis; 5145a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5146a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 51470910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 51480b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 51490b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 515058ff32f7SBarry Smith } 51510910c330SBarry Smith ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 5152e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 5153e3efe391SJed Brown { 5154e3efe391SJed Brown PetscReal *yreal; 5155e3efe391SJed Brown PetscInt i,n; 51560910c330SBarry Smith ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr); 5157785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 5158e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 51590b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 5160e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 5161e3efe391SJed Brown } 5162e3efe391SJed Brown #else 51630b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 5164e3efe391SJed Brown #endif 51650910c330SBarry Smith ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 5166b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 51670b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 51683923b477SBarry Smith } 5169b3603a34SBarry Smith PetscFunctionReturn(0); 5170b3603a34SBarry Smith } 5171b3603a34SBarry Smith 5172b3603a34SBarry Smith #undef __FUNCT__ 51734f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError" 5174ef20d060SBarry Smith /*@C 51754f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 5176ef20d060SBarry Smith in a time based line graph 5177ef20d060SBarry Smith 5178ef20d060SBarry Smith Collective on TS 5179ef20d060SBarry Smith 5180ef20d060SBarry Smith Input Parameters: 5181ef20d060SBarry Smith + ts - the TS context 5182ef20d060SBarry Smith . step - current time-step 5183ef20d060SBarry Smith . ptime - current time 5184ef20d060SBarry Smith - lg - a line graph object 5185ef20d060SBarry Smith 5186ef20d060SBarry Smith Level: intermediate 5187ef20d060SBarry Smith 5188abd5a294SJed Brown Notes: 5189abd5a294SJed Brown Only for sequential solves. 5190abd5a294SJed Brown 5191abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 5192abd5a294SJed Brown 5193abd5a294SJed Brown Options Database Keys: 51944f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 5195ef20d060SBarry Smith 5196ef20d060SBarry Smith .keywords: TS, vector, monitor, view 5197ef20d060SBarry Smith 5198abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 5199ef20d060SBarry Smith @*/ 52000910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 5201ef20d060SBarry Smith { 5202ef20d060SBarry Smith PetscErrorCode ierr; 52030b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 5204ef20d060SBarry Smith const PetscScalar *yy; 5205ef20d060SBarry Smith Vec y; 5206a9f9c1f6SBarry Smith PetscInt dim; 5207ef20d060SBarry Smith 5208ef20d060SBarry Smith PetscFunctionBegin; 5209a9f9c1f6SBarry Smith if (!step) { 5210a9f9c1f6SBarry Smith PetscDrawAxis axis; 5211a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 52121ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 52130910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 5214a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 5215a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5216a9f9c1f6SBarry Smith } 52170910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 5218ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 52190910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 5220ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 5221e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 5222e3efe391SJed Brown { 5223e3efe391SJed Brown PetscReal *yreal; 5224e3efe391SJed Brown PetscInt i,n; 5225e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 5226785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 5227e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 52280b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 5229e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 5230e3efe391SJed Brown } 5231e3efe391SJed Brown #else 52320b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 5233e3efe391SJed Brown #endif 5234ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 5235ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 5236b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 52370b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 52383923b477SBarry Smith } 5239ef20d060SBarry Smith PetscFunctionReturn(0); 5240ef20d060SBarry Smith } 5241ef20d060SBarry Smith 5242201da799SBarry Smith #undef __FUNCT__ 5243201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations" 5244201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 5245201da799SBarry Smith { 5246201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 5247201da799SBarry Smith PetscReal x = ptime,y; 5248201da799SBarry Smith PetscErrorCode ierr; 5249201da799SBarry Smith PetscInt its; 5250201da799SBarry Smith 5251201da799SBarry Smith PetscFunctionBegin; 5252201da799SBarry Smith if (!n) { 5253201da799SBarry Smith PetscDrawAxis axis; 5254bbd56ea5SKarl Rupp 5255201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5256201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 5257201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5258bbd56ea5SKarl Rupp 5259201da799SBarry Smith ctx->snes_its = 0; 5260201da799SBarry Smith } 5261201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 5262201da799SBarry Smith y = its - ctx->snes_its; 5263201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 52643fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 5265201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 5266201da799SBarry Smith } 5267201da799SBarry Smith ctx->snes_its = its; 5268201da799SBarry Smith PetscFunctionReturn(0); 5269201da799SBarry Smith } 5270201da799SBarry Smith 5271201da799SBarry Smith #undef __FUNCT__ 5272201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations" 5273201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 5274201da799SBarry Smith { 5275201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 5276201da799SBarry Smith PetscReal x = ptime,y; 5277201da799SBarry Smith PetscErrorCode ierr; 5278201da799SBarry Smith PetscInt its; 5279201da799SBarry Smith 5280201da799SBarry Smith PetscFunctionBegin; 5281201da799SBarry Smith if (!n) { 5282201da799SBarry Smith PetscDrawAxis axis; 5283bbd56ea5SKarl Rupp 5284201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 5285201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 5286201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 5287bbd56ea5SKarl Rupp 5288201da799SBarry Smith ctx->ksp_its = 0; 5289201da799SBarry Smith } 5290201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 5291201da799SBarry Smith y = its - ctx->ksp_its; 5292201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 529399fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 5294201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 5295201da799SBarry Smith } 5296201da799SBarry Smith ctx->ksp_its = its; 5297201da799SBarry Smith PetscFunctionReturn(0); 5298201da799SBarry Smith } 5299f9c1d6abSBarry Smith 5300f9c1d6abSBarry Smith #undef __FUNCT__ 5301f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability" 5302f9c1d6abSBarry Smith /*@ 5303f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 5304f9c1d6abSBarry Smith 5305f9c1d6abSBarry Smith Collective on TS and Vec 5306f9c1d6abSBarry Smith 5307f9c1d6abSBarry Smith Input Parameters: 5308f9c1d6abSBarry Smith + ts - the TS context 5309f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 5310f9c1d6abSBarry Smith 5311f9c1d6abSBarry Smith Output Parameters: 5312f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 5313f9c1d6abSBarry Smith 5314f9c1d6abSBarry Smith Level: developer 5315f9c1d6abSBarry Smith 5316f9c1d6abSBarry Smith .keywords: TS, compute 5317f9c1d6abSBarry Smith 5318f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 5319f9c1d6abSBarry Smith @*/ 5320f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 5321f9c1d6abSBarry Smith { 5322f9c1d6abSBarry Smith PetscErrorCode ierr; 5323f9c1d6abSBarry Smith 5324f9c1d6abSBarry Smith PetscFunctionBegin; 5325f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5326ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 5327f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 5328f9c1d6abSBarry Smith PetscFunctionReturn(0); 5329f9c1d6abSBarry Smith } 533024655328SShri 533124655328SShri #undef __FUNCT__ 533224655328SShri #define __FUNCT__ "TSRollBack" 533324655328SShri /*@ 533424655328SShri TSRollBack - Rolls back one time step 533524655328SShri 533624655328SShri Collective on TS 533724655328SShri 533824655328SShri Input Parameter: 533924655328SShri . ts - the TS context obtained from TSCreate() 534024655328SShri 534124655328SShri Level: advanced 534224655328SShri 534324655328SShri .keywords: TS, timestep, rollback 534424655328SShri 534524655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 534624655328SShri @*/ 534724655328SShri PetscErrorCode TSRollBack(TS ts) 534824655328SShri { 534924655328SShri PetscErrorCode ierr; 535024655328SShri 535124655328SShri PetscFunctionBegin; 535224655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 535324655328SShri 535424655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 535524655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 535624655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 535724655328SShri ts->ptime = ts->ptime_prev; 535824655328SShri PetscFunctionReturn(0); 535924655328SShri } 5360aeb4809dSShri Abhyankar 5361ff22ae23SHong Zhang #undef __FUNCT__ 5362ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages" 5363ff22ae23SHong Zhang /*@ 5364ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 5365ff22ae23SHong Zhang 5366ff22ae23SHong Zhang Input Parameter: 5367ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 5368ff22ae23SHong Zhang 5369ff22ae23SHong Zhang Level: advanced 5370ff22ae23SHong Zhang 5371ff22ae23SHong Zhang .keywords: TS, getstages 5372ff22ae23SHong Zhang 5373ff22ae23SHong Zhang .seealso: TSCreate() 5374ff22ae23SHong Zhang @*/ 5375ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns, Vec **Y) 5376ff22ae23SHong Zhang { 5377ff22ae23SHong Zhang PetscErrorCode ierr; 5378ff22ae23SHong Zhang 5379ff22ae23SHong Zhang PetscFunctionBegin; 5380ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 5381ff22ae23SHong Zhang PetscValidPointer(ns,2); 5382ff22ae23SHong Zhang 5383ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 5384ff22ae23SHong Zhang else { 5385ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 5386ff22ae23SHong Zhang } 5387ff22ae23SHong Zhang PetscFunctionReturn(0); 5388ff22ae23SHong Zhang } 5389ff22ae23SHong Zhang 5390ff22ae23SHong Zhang 5391ff22ae23SHong Zhang 5392