163dd3a1aSKris Buschelman 2af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 3496e6a7aSJed Brown #include <petscdmshell.h> 41e25c274SJed Brown #include <petscdmda.h> 52d5ee99bSBarry Smith #include <petscviewer.h> 62d5ee99bSBarry Smith #include <petscdraw.h> 7d763cef2SBarry Smith 8d5ba7fb7SMatthew Knepley /* Logging support */ 9d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 108d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 11d405a339SMatthew Knepley 12feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 1349354f04SShri Abhyankar 142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx { 152d5ee99bSBarry Smith PetscViewer viewer; 162d5ee99bSBarry Smith Vec initialsolution; 172d5ee99bSBarry Smith PetscBool showinitial; 182d5ee99bSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 192d5ee99bSBarry Smith PetscBool showtimestepandtime; 202d5ee99bSBarry Smith }; 212d5ee99bSBarry Smith 22fde5950dSBarry Smith /*@C 23fde5950dSBarry Smith TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 24fde5950dSBarry Smith 25fde5950dSBarry Smith Collective on TS 26fde5950dSBarry Smith 27fde5950dSBarry Smith Input Parameters: 28fde5950dSBarry Smith + ts - TS object you wish to monitor 29fde5950dSBarry Smith . name - the monitor type one is seeking 30fde5950dSBarry Smith . help - message indicating what monitoring is done 31fde5950dSBarry Smith . manual - manual page for the monitor 32fde5950dSBarry Smith . monitor - the monitor function 33fde5950dSBarry Smith - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects 34fde5950dSBarry Smith 35fde5950dSBarry Smith Level: developer 36fde5950dSBarry Smith 37fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 38fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 39fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 40fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 41fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 42fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 43fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 44fde5950dSBarry Smith @*/ 45721cd6eeSBarry Smith PetscErrorCode TSMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*)) 46fde5950dSBarry Smith { 47fde5950dSBarry Smith PetscErrorCode ierr; 48fde5950dSBarry Smith PetscViewer viewer; 49fde5950dSBarry Smith PetscViewerFormat format; 50fde5950dSBarry Smith PetscBool flg; 51fde5950dSBarry Smith 52fde5950dSBarry Smith PetscFunctionBegin; 53fde5950dSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 54fde5950dSBarry Smith if (flg) { 55721cd6eeSBarry Smith PetscViewerAndFormat *vf; 56721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 57721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 58fde5950dSBarry Smith if (monitorsetup) { 59721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 60fde5950dSBarry Smith } 61721cd6eeSBarry Smith ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 62fde5950dSBarry Smith } 63fde5950dSBarry Smith PetscFunctionReturn(0); 64fde5950dSBarry Smith } 65fde5950dSBarry Smith 66fde5950dSBarry Smith /*@C 67fde5950dSBarry Smith TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 68fde5950dSBarry Smith 69fde5950dSBarry Smith Collective on TS 70fde5950dSBarry Smith 71fde5950dSBarry Smith Input Parameters: 72fde5950dSBarry Smith + ts - TS object you wish to monitor 73fde5950dSBarry Smith . name - the monitor type one is seeking 74fde5950dSBarry Smith . help - message indicating what monitoring is done 75fde5950dSBarry Smith . manual - manual page for the monitor 76fde5950dSBarry Smith . monitor - the monitor function 77fde5950dSBarry Smith - monitorsetup - a function that is called once ONLY if the user selected this monitor that may set additional features of the TS or PetscViewer objects 78fde5950dSBarry Smith 79fde5950dSBarry Smith Level: developer 80fde5950dSBarry Smith 81fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 82fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 83fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 84fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 85fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 86fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 87fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 88fde5950dSBarry Smith @*/ 89721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorSetFromOptions(TS ts,const char name[],const char help[], const char manual[],PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*monitorsetup)(TS,PetscViewerAndFormat*)) 90fde5950dSBarry Smith { 91fde5950dSBarry Smith PetscErrorCode ierr; 92fde5950dSBarry Smith PetscViewer viewer; 93fde5950dSBarry Smith PetscViewerFormat format; 94fde5950dSBarry Smith PetscBool flg; 95fde5950dSBarry Smith 96fde5950dSBarry Smith PetscFunctionBegin; 97fde5950dSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 98fde5950dSBarry Smith if (flg) { 99721cd6eeSBarry Smith PetscViewerAndFormat *vf; 100721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 101721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 102fde5950dSBarry Smith if (monitorsetup) { 103721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 104fde5950dSBarry Smith } 105721cd6eeSBarry Smith ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 106fde5950dSBarry Smith } 107fde5950dSBarry Smith PetscFunctionReturn(0); 108fde5950dSBarry Smith } 109fde5950dSBarry Smith 110bdad233fSMatthew Knepley /*@ 111bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 112bdad233fSMatthew Knepley 113bdad233fSMatthew Knepley Collective on TS 114bdad233fSMatthew Knepley 115bdad233fSMatthew Knepley Input Parameter: 116bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 117bdad233fSMatthew Knepley 118bdad233fSMatthew Knepley Options Database Keys: 119b6a60446SDebojyoti Ghosh + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE 120ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 1213e4cdcaaSBarry Smith . -ts_max_steps <maxsteps> - maximum number of time-steps to take 1223e4cdcaaSBarry Smith . -ts_final_time <time> - maximum time to compute to 1233e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 124a3cdaa26SBarry 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 125a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 126a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 127a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 128a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 129a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 130ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 131847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 132bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 133de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 134de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 1356934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 136de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 137de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 138de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 139de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 1403e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 1413e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 142fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 143e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 144110eb670SHong Zhang . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 145110eb670SHong Zhang . -ts_adjoint_monitor - print information at each adjoint time step 14653ea634cSHong Zhang - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically 14753ea634cSHong Zhang 14891b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 149bdad233fSMatthew Knepley 150bdad233fSMatthew Knepley Level: beginner 151bdad233fSMatthew Knepley 152bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 153bdad233fSMatthew Knepley 154a313700dSBarry Smith .seealso: TSGetType() 155bdad233fSMatthew Knepley @*/ 1567087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 157bdad233fSMatthew Knepley { 158bc952696SBarry Smith PetscBool opt,flg,tflg; 159dfbe8321SBarry Smith PetscErrorCode ierr; 160eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 16131748224SBarry Smith PetscReal time_step; 16249354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 163d1212d36SBarry Smith char dir[16]; 164cd11d68dSLisandro Dalcin TSIFunction ifun; 1656991f827SBarry Smith const char *defaultType; 1666991f827SBarry Smith char typeName[256]; 167bdad233fSMatthew Knepley 168bdad233fSMatthew Knepley PetscFunctionBegin; 1690700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1706991f827SBarry Smith 1716991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 172cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 173cd11d68dSLisandro Dalcin 174cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 175cd11d68dSLisandro Dalcin if (((PetscObject)ts)->type_name) 176cd11d68dSLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 177cd11d68dSLisandro Dalcin else 178cd11d68dSLisandro Dalcin defaultType = ifun ? TSBEULER : TSEULER; 1796991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1806991f827SBarry Smith if (opt) { 1816991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1826991f827SBarry Smith } else { 1836991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1846991f827SBarry Smith } 185bdad233fSMatthew Knepley 186bdad233fSMatthew Knepley /* Handle generic TS options */ 1870298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1880298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 1890298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 19031748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 191cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 19249354f04SShri 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); 19349354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1940298fd71SBarry 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); 1950298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1960298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1970298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1980298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 199bdad233fSMatthew Knepley 20056f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 20156f85f32SBarry Smith { 20256f85f32SBarry Smith PetscBool set; 20356f85f32SBarry Smith flg = PETSC_FALSE; 20456f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 20556f85f32SBarry Smith if (set) { 20656f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 20756f85f32SBarry Smith } 20856f85f32SBarry Smith } 20956f85f32SBarry Smith #endif 21056f85f32SBarry Smith 211bdad233fSMatthew Knepley /* Monitor options */ 212cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 213fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 214fde5950dSBarry Smith ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr); 215fde5950dSBarry Smith 2165180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 2175180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 2185180491cSLisandro Dalcin 2194f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 220b3603a34SBarry Smith if (opt) { 2210b039ecaSBarry Smith TSMonitorLGCtx ctx; 2223923b477SBarry Smith PetscInt howoften = 1; 223b3603a34SBarry Smith 2240298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2256ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2264f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 227bdad233fSMatthew Knepley } 2286ba87a44SLisandro Dalcin 2294f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 230ef20d060SBarry Smith if (opt) { 2310b039ecaSBarry Smith TSMonitorLGCtx ctx; 2323923b477SBarry Smith PetscInt howoften = 1; 233ef20d060SBarry Smith 2340298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 2356ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2364f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 237ef20d060SBarry Smith } 2386934998bSLisandro Dalcin 2396934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2406934998bSLisandro Dalcin if (opt) { 2416934998bSLisandro Dalcin TSMonitorLGCtx ctx; 2426934998bSLisandro Dalcin PetscInt howoften = 1; 2436934998bSLisandro Dalcin 2446934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2456ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2466934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2476934998bSLisandro Dalcin } 248201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 249201da799SBarry Smith if (opt) { 250201da799SBarry Smith TSMonitorLGCtx ctx; 251201da799SBarry Smith PetscInt howoften = 1; 252201da799SBarry Smith 2530298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2546ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 255201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 256201da799SBarry Smith } 257201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 258201da799SBarry Smith if (opt) { 259201da799SBarry Smith TSMonitorLGCtx ctx; 260201da799SBarry Smith PetscInt howoften = 1; 261201da799SBarry Smith 2620298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2636ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 264201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 265201da799SBarry Smith } 2668189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2678189c53fSBarry Smith if (opt) { 2688189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2698189c53fSBarry Smith PetscInt howoften = 1; 2708189c53fSBarry Smith 2710298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 2726934998bSLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2738189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2748189c53fSBarry Smith } 275ef20d060SBarry Smith opt = PETSC_FALSE; 2760dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 277a7cc72afSBarry Smith if (opt) { 27883a4ac43SBarry Smith TSMonitorDrawCtx ctx; 27983a4ac43SBarry Smith PetscInt howoften = 1; 280a80ad3e0SBarry Smith 2810298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2826934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 28383a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 284bdad233fSMatthew Knepley } 285fb1732b5SBarry Smith opt = PETSC_FALSE; 2869110b2e7SHong Zhang ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr); 2879110b2e7SHong Zhang if (opt) { 2889110b2e7SHong Zhang TSMonitorDrawCtx ctx; 2899110b2e7SHong Zhang PetscInt howoften = 1; 2909110b2e7SHong Zhang 2919110b2e7SHong Zhang ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr); 2926934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2939110b2e7SHong Zhang ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2949110b2e7SHong Zhang } 2959110b2e7SHong Zhang opt = PETSC_FALSE; 2962d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2972d5ee99bSBarry Smith if (opt) { 2982d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2992d5ee99bSBarry Smith PetscReal bounds[4]; 3002d5ee99bSBarry Smith PetscInt n = 4; 3012d5ee99bSBarry Smith PetscDraw draw; 3026934998bSLisandro Dalcin PetscDrawAxis axis; 3032d5ee99bSBarry Smith 3042d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 3052d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 3066934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 3072d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 3086934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 3096934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 3106934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 3112d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3122d5ee99bSBarry Smith } 3132d5ee99bSBarry Smith opt = PETSC_FALSE; 3140dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 3153a471f94SBarry Smith if (opt) { 31683a4ac43SBarry Smith TSMonitorDrawCtx ctx; 31783a4ac43SBarry Smith PetscInt howoften = 1; 3183a471f94SBarry Smith 3190298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 3206934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 32183a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3223a471f94SBarry Smith } 323fde5950dSBarry Smith 324ed81e22dSJed Brown opt = PETSC_FALSE; 32591b97e58SBarry 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); 326ed81e22dSJed Brown if (flg) { 327ed81e22dSJed Brown const char *ptr,*ptr2; 328ed81e22dSJed Brown char *filetemplate; 329ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 330ed81e22dSJed Brown /* Do some cursory validation of the input. */ 331ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 332ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 333ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 334ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 335ce94432eSBarry 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"); 336ed81e22dSJed Brown if (ptr2) break; 337ed81e22dSJed Brown } 338ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 339ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 340ed81e22dSJed Brown } 341bdad233fSMatthew Knepley 342d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 343d1212d36SBarry Smith if (flg) { 344d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 345d1212d36SBarry Smith int ray = 0; 346d1212d36SBarry Smith DMDADirection ddir; 347d1212d36SBarry Smith DM da; 348d1212d36SBarry Smith PetscMPIInt rank; 349d1212d36SBarry Smith 350ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 351d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 352d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 353ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 354d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 355d1212d36SBarry Smith 356d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 357b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 358d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 359d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 360ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 361d1212d36SBarry Smith if (!rank) { 362d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 363d1212d36SBarry Smith } 36451b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 365d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 366d1212d36SBarry Smith } 36751b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 36851b4a12fSMatthew G. Knepley if (flg) { 36951b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 37051b4a12fSMatthew G. Knepley int ray = 0; 37151b4a12fSMatthew G. Knepley DMDADirection ddir; 37251b4a12fSMatthew G. Knepley DM da; 37351b4a12fSMatthew G. Knepley PetscInt howoften = 1; 374d1212d36SBarry Smith 37551b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 37651b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 37751b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 37851b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 37951b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3801c3436cfSJed Brown 38151b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 382b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 38351b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 38451b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 38551b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 38651b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 38751b4a12fSMatthew G. Knepley } 388a7a1495cSBarry Smith 389b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 390b3d3934dSBarry Smith if (opt) { 391b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 392b3d3934dSBarry Smith 393b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 394b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 395b3d3934dSBarry Smith } 396b3d3934dSBarry Smith 397847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 398847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 399847ff0e1SMatthew G. Knepley if (flg) { 400847ff0e1SMatthew G. Knepley DM dm; 401847ff0e1SMatthew G. Knepley DMTS tdm; 402847ff0e1SMatthew G. Knepley 403847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 404847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 405847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 406847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 407847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 408847ff0e1SMatthew G. Knepley } 409847ff0e1SMatthew G. Knepley 410ee346746SBarry Smith if (ts->adapt) { 411ee346746SBarry Smith ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 412ee346746SBarry Smith } 413d763cef2SBarry Smith 414d763cef2SBarry Smith /* Handle specific TS options */ 415d763cef2SBarry Smith if (ts->ops->setfromoptions) { 4166991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 417d763cef2SBarry Smith } 418fbc52257SHong Zhang 41968bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 4204f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 42168bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 42268bece0bSHong Zhang if (tflg) { 42368bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 42468bece0bSHong Zhang } 4254f122a70SLisandro Dalcin tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE; 42668bece0bSHong Zhang ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr); 42768bece0bSHong Zhang if (flg) { 42868bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 42968bece0bSHong Zhang ts->adjoint_solve = tflg; 43068bece0bSHong Zhang } 431d763cef2SBarry Smith 432d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4330633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 434fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 435d763cef2SBarry Smith 4364f122a70SLisandro Dalcin if (ts->trajectory) { 4374f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 438d763cef2SBarry Smith } 43968bece0bSHong Zhang 4404f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4414f122a70SLisandro Dalcin if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);} 4424f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 443d763cef2SBarry Smith PetscFunctionReturn(0); 444d763cef2SBarry Smith } 445d763cef2SBarry Smith 446d2daff3dSHong Zhang /*@ 447*78fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 448*78fbdcc8SBarry Smith 449*78fbdcc8SBarry Smith Collective on TS 450*78fbdcc8SBarry Smith 451*78fbdcc8SBarry Smith Input Parameters: 452*78fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 453*78fbdcc8SBarry Smith 454*78fbdcc8SBarry Smith Output Parameters; 455*78fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 456*78fbdcc8SBarry Smith 457*78fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 458*78fbdcc8SBarry Smith 459*78fbdcc8SBarry Smith Level: advanced 460*78fbdcc8SBarry Smith 461*78fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 462*78fbdcc8SBarry Smith 463*78fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 464*78fbdcc8SBarry Smith @*/ 465*78fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 466*78fbdcc8SBarry Smith { 467*78fbdcc8SBarry Smith PetscFunctionBegin; 468*78fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 469*78fbdcc8SBarry Smith *tr = ts->trajectory; 470*78fbdcc8SBarry Smith PetscFunctionReturn(0); 471*78fbdcc8SBarry Smith } 472*78fbdcc8SBarry Smith 473*78fbdcc8SBarry Smith /*@ 474bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 475d2daff3dSHong Zhang 476d2daff3dSHong Zhang Collective on TS 477d2daff3dSHong Zhang 478d2daff3dSHong Zhang Input Parameters: 479bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 480bc952696SBarry Smith 481*78fbdcc8SBarry Smith Options Database: 482*78fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 483*78fbdcc8SBarry Smith - -ts_trajectory_type type 484*78fbdcc8SBarry Smith 48568bece0bSHong Zhang Note: This routine should be called after all TS options have been set 486d2daff3dSHong Zhang 487*78fbdcc8SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and 488*78fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 489*78fbdcc8SBarry Smith 490d2daff3dSHong Zhang Level: intermediate 491d2daff3dSHong Zhang 492*78fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType() 493d2daff3dSHong Zhang 494bc952696SBarry Smith .keywords: TS, set, checkpoint, 495d2daff3dSHong Zhang @*/ 496bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 497d2daff3dSHong Zhang { 498bc952696SBarry Smith PetscErrorCode ierr; 499bc952696SBarry Smith 500d2daff3dSHong Zhang PetscFunctionBegin; 501d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 502bc952696SBarry Smith if (!ts->trajectory) { 503bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 504972caf09SHong Zhang ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 505bc952696SBarry Smith } 506d2daff3dSHong Zhang PetscFunctionReturn(0); 507d2daff3dSHong Zhang } 508d2daff3dSHong Zhang 509a7a1495cSBarry Smith /*@ 510a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 511a7a1495cSBarry Smith set with TSSetRHSJacobian(). 512a7a1495cSBarry Smith 513a7a1495cSBarry Smith Collective on TS and Vec 514a7a1495cSBarry Smith 515a7a1495cSBarry Smith Input Parameters: 516316643e7SJed Brown + ts - the TS context 517a7a1495cSBarry Smith . t - current timestep 5180910c330SBarry Smith - U - input vector 519a7a1495cSBarry Smith 520a7a1495cSBarry Smith Output Parameters: 521a7a1495cSBarry Smith + A - Jacobian matrix 522a7a1495cSBarry Smith . B - optional preconditioning matrix 523a7a1495cSBarry Smith - flag - flag indicating matrix structure 524a7a1495cSBarry Smith 525a7a1495cSBarry Smith Notes: 526a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 527a7a1495cSBarry Smith is used internally within the nonlinear solvers. 528a7a1495cSBarry Smith 52994b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 530a7a1495cSBarry Smith flag parameter. 531a7a1495cSBarry Smith 532a7a1495cSBarry Smith Level: developer 533a7a1495cSBarry Smith 534a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 535a7a1495cSBarry Smith 53694b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 537a7a1495cSBarry Smith @*/ 538d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 539a7a1495cSBarry Smith { 540dfbe8321SBarry Smith PetscErrorCode ierr; 541270bf2e7SJed Brown PetscObjectState Ustate; 54224989b8cSPeter Brune DM dm; 543942e3340SBarry Smith DMTS tsdm; 54424989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 54524989b8cSPeter Brune void *ctx; 54624989b8cSPeter Brune TSIJacobian ijacobianfunc; 547b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 548a7a1495cSBarry Smith 549a7a1495cSBarry Smith PetscFunctionBegin; 5500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5510910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5520910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 55324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 554942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 55524989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 5560298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 557b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 55859e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 559b2df71adSDebojyoti Ghosh if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 5600e4ef248SJed Brown PetscFunctionReturn(0); 561f8ede8e7SJed Brown } 562d90be118SSean Farley 563ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 564d90be118SSean Farley 565e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 56694ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 56794ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 56894ab13aaSBarry Smith if (A != B) { 56994ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 57094ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 571e1244c69SJed Brown } 572e1244c69SJed Brown ts->rhsjacobian.shift = 0; 573e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 574e1244c69SJed Brown } 575e1244c69SJed Brown 57624989b8cSPeter Brune if (rhsjacobianfunc) { 5776cd88445SBarry Smith PetscBool missing; 57894ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 579a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 580d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 581a7a1495cSBarry Smith PetscStackPop; 58294ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 5836cd88445SBarry Smith if (A) { 5846cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 5856cd88445SBarry Smith if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 5866cd88445SBarry Smith } 5876cd88445SBarry Smith if (B && B != A) { 5886cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 5896cd88445SBarry Smith if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetRHSJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 5906cd88445SBarry Smith } 591ef66eb69SBarry Smith } else { 59294ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 59394ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 594ef66eb69SBarry Smith } 5950e4ef248SJed Brown ts->rhsjacobian.time = t; 5960910c330SBarry Smith ts->rhsjacobian.X = U; 59759e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 598a7a1495cSBarry Smith PetscFunctionReturn(0); 599a7a1495cSBarry Smith } 600a7a1495cSBarry Smith 601316643e7SJed Brown /*@ 602d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 603d763cef2SBarry Smith 604316643e7SJed Brown Collective on TS and Vec 605316643e7SJed Brown 606316643e7SJed Brown Input Parameters: 607316643e7SJed Brown + ts - the TS context 608316643e7SJed Brown . t - current time 6090910c330SBarry Smith - U - state vector 610316643e7SJed Brown 611316643e7SJed Brown Output Parameter: 612316643e7SJed Brown . y - right hand side 613316643e7SJed Brown 614316643e7SJed Brown Note: 615316643e7SJed Brown Most users should not need to explicitly call this routine, as it 616316643e7SJed Brown is used internally within the nonlinear solvers. 617316643e7SJed Brown 618316643e7SJed Brown Level: developer 619316643e7SJed Brown 620316643e7SJed Brown .keywords: TS, compute 621316643e7SJed Brown 622316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 623316643e7SJed Brown @*/ 6240910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 625d763cef2SBarry Smith { 626dfbe8321SBarry Smith PetscErrorCode ierr; 62724989b8cSPeter Brune TSRHSFunction rhsfunction; 62824989b8cSPeter Brune TSIFunction ifunction; 62924989b8cSPeter Brune void *ctx; 63024989b8cSPeter Brune DM dm; 63124989b8cSPeter Brune 632d763cef2SBarry Smith PetscFunctionBegin; 6330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6340910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6350700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 63624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 63724989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6380298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 639d763cef2SBarry Smith 640ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 641d763cef2SBarry Smith 6420910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 64324989b8cSPeter Brune if (rhsfunction) { 644d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6450910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 646d763cef2SBarry Smith PetscStackPop; 647214bc6a2SJed Brown } else { 648214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 649b2cd27e8SJed Brown } 65044a41b28SSean Farley 6510910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 652d763cef2SBarry Smith PetscFunctionReturn(0); 653d763cef2SBarry Smith } 654d763cef2SBarry Smith 655ef20d060SBarry Smith /*@ 656ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 657ef20d060SBarry Smith 658ef20d060SBarry Smith Collective on TS and Vec 659ef20d060SBarry Smith 660ef20d060SBarry Smith Input Parameters: 661ef20d060SBarry Smith + ts - the TS context 662ef20d060SBarry Smith - t - current time 663ef20d060SBarry Smith 664ef20d060SBarry Smith Output Parameter: 6650910c330SBarry Smith . U - the solution 666ef20d060SBarry Smith 667ef20d060SBarry Smith Note: 668ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 669ef20d060SBarry Smith is used internally within the nonlinear solvers. 670ef20d060SBarry Smith 671ef20d060SBarry Smith Level: developer 672ef20d060SBarry Smith 673ef20d060SBarry Smith .keywords: TS, compute 674ef20d060SBarry Smith 675abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 676ef20d060SBarry Smith @*/ 6770910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 678ef20d060SBarry Smith { 679ef20d060SBarry Smith PetscErrorCode ierr; 680ef20d060SBarry Smith TSSolutionFunction solutionfunction; 681ef20d060SBarry Smith void *ctx; 682ef20d060SBarry Smith DM dm; 683ef20d060SBarry Smith 684ef20d060SBarry Smith PetscFunctionBegin; 685ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6860910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 687ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 688ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 689ef20d060SBarry Smith 690ef20d060SBarry Smith if (solutionfunction) { 6919b7cd975SBarry Smith PetscStackPush("TS user solution function"); 6920910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 693ef20d060SBarry Smith PetscStackPop; 694ef20d060SBarry Smith } 695ef20d060SBarry Smith PetscFunctionReturn(0); 696ef20d060SBarry Smith } 6979b7cd975SBarry Smith /*@ 6989b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 6999b7cd975SBarry Smith 7009b7cd975SBarry Smith Collective on TS and Vec 7019b7cd975SBarry Smith 7029b7cd975SBarry Smith Input Parameters: 7039b7cd975SBarry Smith + ts - the TS context 7049b7cd975SBarry Smith - t - current time 7059b7cd975SBarry Smith 7069b7cd975SBarry Smith Output Parameter: 7079b7cd975SBarry Smith . U - the function value 7089b7cd975SBarry Smith 7099b7cd975SBarry Smith Note: 7109b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 7119b7cd975SBarry Smith is used internally within the nonlinear solvers. 7129b7cd975SBarry Smith 7139b7cd975SBarry Smith Level: developer 7149b7cd975SBarry Smith 7159b7cd975SBarry Smith .keywords: TS, compute 7169b7cd975SBarry Smith 7179b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 7189b7cd975SBarry Smith @*/ 7199b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 7209b7cd975SBarry Smith { 7219b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 7229b7cd975SBarry Smith void *ctx; 7239b7cd975SBarry Smith DM dm; 7249b7cd975SBarry Smith 7259b7cd975SBarry Smith PetscFunctionBegin; 7269b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7279b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7289b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7299b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7309b7cd975SBarry Smith 7319b7cd975SBarry Smith if (forcing) { 7329b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7339b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7349b7cd975SBarry Smith PetscStackPop; 7359b7cd975SBarry Smith } 7369b7cd975SBarry Smith PetscFunctionReturn(0); 7379b7cd975SBarry Smith } 738ef20d060SBarry Smith 739214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 740214bc6a2SJed Brown { 7412dd45cf8SJed Brown Vec F; 742214bc6a2SJed Brown PetscErrorCode ierr; 743214bc6a2SJed Brown 744214bc6a2SJed Brown PetscFunctionBegin; 7450298fd71SBarry Smith *Frhs = NULL; 7460298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 747214bc6a2SJed Brown if (!ts->Frhs) { 7482dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 749214bc6a2SJed Brown } 750214bc6a2SJed Brown *Frhs = ts->Frhs; 751214bc6a2SJed Brown PetscFunctionReturn(0); 752214bc6a2SJed Brown } 753214bc6a2SJed Brown 754214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 755214bc6a2SJed Brown { 756214bc6a2SJed Brown Mat A,B; 7572dd45cf8SJed Brown PetscErrorCode ierr; 758214bc6a2SJed Brown 759214bc6a2SJed Brown PetscFunctionBegin; 760c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 761c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 7620298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 763214bc6a2SJed Brown if (Arhs) { 764214bc6a2SJed Brown if (!ts->Arhs) { 765214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 766214bc6a2SJed Brown } 767214bc6a2SJed Brown *Arhs = ts->Arhs; 768214bc6a2SJed Brown } 769214bc6a2SJed Brown if (Brhs) { 770214bc6a2SJed Brown if (!ts->Brhs) { 771bdb70873SJed Brown if (A != B) { 772214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 773bdb70873SJed Brown } else { 774bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 77551699248SLisandro Dalcin ts->Brhs = ts->Arhs; 776bdb70873SJed Brown } 777214bc6a2SJed Brown } 778214bc6a2SJed Brown *Brhs = ts->Brhs; 779214bc6a2SJed Brown } 780214bc6a2SJed Brown PetscFunctionReturn(0); 781214bc6a2SJed Brown } 782214bc6a2SJed Brown 783316643e7SJed Brown /*@ 7840910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 785316643e7SJed Brown 786316643e7SJed Brown Collective on TS and Vec 787316643e7SJed Brown 788316643e7SJed Brown Input Parameters: 789316643e7SJed Brown + ts - the TS context 790316643e7SJed Brown . t - current time 7910910c330SBarry Smith . U - state vector 7920910c330SBarry Smith . Udot - time derivative of state vector 793214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 794316643e7SJed Brown 795316643e7SJed Brown Output Parameter: 796316643e7SJed Brown . Y - right hand side 797316643e7SJed Brown 798316643e7SJed Brown Note: 799316643e7SJed Brown Most users should not need to explicitly call this routine, as it 800316643e7SJed Brown is used internally within the nonlinear solvers. 801316643e7SJed Brown 802316643e7SJed Brown If the user did did not write their equations in implicit form, this 803316643e7SJed Brown function recasts them in implicit form. 804316643e7SJed Brown 805316643e7SJed Brown Level: developer 806316643e7SJed Brown 807316643e7SJed Brown .keywords: TS, compute 808316643e7SJed Brown 809316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 810316643e7SJed Brown @*/ 8110910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 812316643e7SJed Brown { 813316643e7SJed Brown PetscErrorCode ierr; 81424989b8cSPeter Brune TSIFunction ifunction; 81524989b8cSPeter Brune TSRHSFunction rhsfunction; 81624989b8cSPeter Brune void *ctx; 81724989b8cSPeter Brune DM dm; 818316643e7SJed Brown 819316643e7SJed Brown PetscFunctionBegin; 8200700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8210910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8220910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8230700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 824316643e7SJed Brown 82524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 82624989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8270298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 82824989b8cSPeter Brune 829ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 830d90be118SSean Farley 8310910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 83224989b8cSPeter Brune if (ifunction) { 833316643e7SJed Brown PetscStackPush("TS user implicit function"); 8340910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 835316643e7SJed Brown PetscStackPop; 836214bc6a2SJed Brown } 837214bc6a2SJed Brown if (imex) { 83824989b8cSPeter Brune if (!ifunction) { 8390910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8402dd45cf8SJed Brown } 84124989b8cSPeter Brune } else if (rhsfunction) { 84224989b8cSPeter Brune if (ifunction) { 843214bc6a2SJed Brown Vec Frhs; 844214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8450910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 846214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8472dd45cf8SJed Brown } else { 8480910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8490910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 850316643e7SJed Brown } 8514a6899ffSJed Brown } 8520910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 853316643e7SJed Brown PetscFunctionReturn(0); 854316643e7SJed Brown } 855316643e7SJed Brown 856316643e7SJed Brown /*@ 857316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 858316643e7SJed Brown 859316643e7SJed Brown Collective on TS and Vec 860316643e7SJed Brown 861316643e7SJed Brown Input 862316643e7SJed Brown Input Parameters: 863316643e7SJed Brown + ts - the TS context 864316643e7SJed Brown . t - current timestep 8650910c330SBarry Smith . U - state vector 8660910c330SBarry Smith . Udot - time derivative of state vector 867214bc6a2SJed Brown . shift - shift to apply, see note below 868214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 869316643e7SJed Brown 870316643e7SJed Brown Output Parameters: 871316643e7SJed Brown + A - Jacobian matrix 872316643e7SJed Brown . B - optional preconditioning matrix 873316643e7SJed Brown - flag - flag indicating matrix structure 874316643e7SJed Brown 875316643e7SJed Brown Notes: 8760910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 877316643e7SJed Brown 8780910c330SBarry Smith dF/dU + shift*dF/dUdot 879316643e7SJed Brown 880316643e7SJed Brown Most users should not need to explicitly call this routine, as it 881316643e7SJed Brown is used internally within the nonlinear solvers. 882316643e7SJed Brown 883316643e7SJed Brown Level: developer 884316643e7SJed Brown 885316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 886316643e7SJed Brown 887316643e7SJed Brown .seealso: TSSetIJacobian() 88863495f91SJed Brown @*/ 889d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 890316643e7SJed Brown { 891316643e7SJed Brown PetscErrorCode ierr; 89224989b8cSPeter Brune TSIJacobian ijacobian; 89324989b8cSPeter Brune TSRHSJacobian rhsjacobian; 89424989b8cSPeter Brune DM dm; 89524989b8cSPeter Brune void *ctx; 896316643e7SJed Brown 897316643e7SJed Brown PetscFunctionBegin; 8980700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8990910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9000910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 901316643e7SJed Brown PetscValidPointer(A,6); 90294ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 903316643e7SJed Brown PetscValidPointer(B,7); 90494ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 90524989b8cSPeter Brune 90624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 90724989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9080298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 90924989b8cSPeter Brune 910ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 911316643e7SJed Brown 91294ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 91324989b8cSPeter Brune if (ijacobian) { 9146cd88445SBarry Smith PetscBool missing; 915316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 916d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 917316643e7SJed Brown PetscStackPop; 9186cd88445SBarry Smith if (A) { 9196cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9206cd88445SBarry Smith if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Amat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 9216cd88445SBarry Smith } 9226cd88445SBarry Smith if (B && B != A) { 9236cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9246cd88445SBarry Smith if (missing) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Bmat passed to TSSetIJacobian() must have all diagonal entries set, if they are zero you must still set them with a zero value"); 9256cd88445SBarry Smith } 9264a6899ffSJed Brown } 927214bc6a2SJed Brown if (imex) { 928b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9294c26be97Sstefano_zampini PetscBool assembled; 93094ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9314c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9324c26be97Sstefano_zampini if (!assembled) { 9334c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9344c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9354c26be97Sstefano_zampini } 93694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 93794ab13aaSBarry Smith if (A != B) { 93894ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9394c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9404c26be97Sstefano_zampini if (!assembled) { 9414c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9424c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9434c26be97Sstefano_zampini } 94494ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 945214bc6a2SJed Brown } 946214bc6a2SJed Brown } 947214bc6a2SJed Brown } else { 948e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 949e1244c69SJed Brown if (rhsjacobian) { 950214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 951d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 952e1244c69SJed Brown } 95394ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 954e1244c69SJed Brown ts->rhsjacobian.scale = -1; 955e1244c69SJed Brown ts->rhsjacobian.shift = shift; 95694ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 95794ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 95894ab13aaSBarry Smith if (A != B) { 95994ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 96094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 961316643e7SJed Brown } 962e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 963e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 964e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 96594ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 96694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 96794ab13aaSBarry Smith if (A != B) { 96894ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 96994ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 970214bc6a2SJed Brown } 971316643e7SJed Brown } 97294ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 97394ab13aaSBarry Smith if (A != B) { 97494ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 975316643e7SJed Brown } 976316643e7SJed Brown } 977316643e7SJed Brown } 97894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 979316643e7SJed Brown PetscFunctionReturn(0); 980316643e7SJed Brown } 981316643e7SJed Brown 982d763cef2SBarry Smith /*@C 983d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 984b5abc632SBarry Smith where U_t = G(t,u). 985d763cef2SBarry Smith 9863f9fe445SBarry Smith Logically Collective on TS 987d763cef2SBarry Smith 988d763cef2SBarry Smith Input Parameters: 989d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 9900298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 991d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 992d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 9930298fd71SBarry Smith function evaluation routine (may be NULL) 994d763cef2SBarry Smith 995d763cef2SBarry Smith Calling sequence of func: 99687828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 997d763cef2SBarry Smith 998d763cef2SBarry Smith + t - current timestep 999d763cef2SBarry Smith . u - input vector 1000d763cef2SBarry Smith . F - function vector 1001d763cef2SBarry Smith - ctx - [optional] user-defined function context 1002d763cef2SBarry Smith 1003d763cef2SBarry Smith Level: beginner 1004d763cef2SBarry Smith 10052bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10062bbac0d3SBarry Smith 1007d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1008d763cef2SBarry Smith 1009ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1010d763cef2SBarry Smith @*/ 1011089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1012d763cef2SBarry Smith { 1013089b2837SJed Brown PetscErrorCode ierr; 1014089b2837SJed Brown SNES snes; 10150298fd71SBarry Smith Vec ralloc = NULL; 101624989b8cSPeter Brune DM dm; 1017d763cef2SBarry Smith 1018089b2837SJed Brown PetscFunctionBegin; 10190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1020ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 102124989b8cSPeter Brune 102224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 102324989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1024089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1025e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1026e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1027e856ceecSJed Brown r = ralloc; 1028e856ceecSJed Brown } 1029089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1030e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1031d763cef2SBarry Smith PetscFunctionReturn(0); 1032d763cef2SBarry Smith } 1033d763cef2SBarry Smith 1034ef20d060SBarry Smith /*@C 1035abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1036ef20d060SBarry Smith 1037ef20d060SBarry Smith Logically Collective on TS 1038ef20d060SBarry Smith 1039ef20d060SBarry Smith Input Parameters: 1040ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1041ef20d060SBarry Smith . f - routine for evaluating the solution 1042ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 10430298fd71SBarry Smith function evaluation routine (may be NULL) 1044ef20d060SBarry Smith 1045ef20d060SBarry Smith Calling sequence of func: 1046ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1047ef20d060SBarry Smith 1048ef20d060SBarry Smith + t - current timestep 1049ef20d060SBarry Smith . u - output vector 1050ef20d060SBarry Smith - ctx - [optional] user-defined function context 1051ef20d060SBarry Smith 1052abd5a294SJed Brown Notes: 1053abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1054abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1055abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1056abd5a294SJed Brown 10574f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1058abd5a294SJed Brown 1059ef20d060SBarry Smith Level: beginner 1060ef20d060SBarry Smith 1061ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1062ef20d060SBarry Smith 10639b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 1064ef20d060SBarry Smith @*/ 1065ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1066ef20d060SBarry Smith { 1067ef20d060SBarry Smith PetscErrorCode ierr; 1068ef20d060SBarry Smith DM dm; 1069ef20d060SBarry Smith 1070ef20d060SBarry Smith PetscFunctionBegin; 1071ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1072ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1073ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1074ef20d060SBarry Smith PetscFunctionReturn(0); 1075ef20d060SBarry Smith } 1076ef20d060SBarry Smith 10779b7cd975SBarry Smith /*@C 10789b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 10799b7cd975SBarry Smith 10809b7cd975SBarry Smith Logically Collective on TS 10819b7cd975SBarry Smith 10829b7cd975SBarry Smith Input Parameters: 10839b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1084e162b725SBarry Smith . func - routine for evaluating the forcing function 10859b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 10860298fd71SBarry Smith function evaluation routine (may be NULL) 10879b7cd975SBarry Smith 10889b7cd975SBarry Smith Calling sequence of func: 1089e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 10909b7cd975SBarry Smith 10919b7cd975SBarry Smith + t - current timestep 1092e162b725SBarry Smith . f - output vector 10939b7cd975SBarry Smith - ctx - [optional] user-defined function context 10949b7cd975SBarry Smith 10959b7cd975SBarry Smith Notes: 10969b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1097e162b725SBarry Smith create closed-form solutions with a non-physical forcing term. It allows you to use the Method of Manufactored Solution without directly editing the 1098e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1099e162b725SBarry Smith 1100e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1101e162b725SBarry Smith 1102e162b725SBarry Smith This forcing function does not depend on the solution to the equations, it can only depend on spatial location, time, and possibly parameters, the 1103e162b725SBarry Smith parameters can be passed in the ctx variable. 11049b7cd975SBarry Smith 11059b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11069b7cd975SBarry Smith 11079b7cd975SBarry Smith Level: beginner 11089b7cd975SBarry Smith 11099b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11109b7cd975SBarry Smith 11119b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11129b7cd975SBarry Smith @*/ 1113e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11149b7cd975SBarry Smith { 11159b7cd975SBarry Smith PetscErrorCode ierr; 11169b7cd975SBarry Smith DM dm; 11179b7cd975SBarry Smith 11189b7cd975SBarry Smith PetscFunctionBegin; 11199b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11209b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1121e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11229b7cd975SBarry Smith PetscFunctionReturn(0); 11239b7cd975SBarry Smith } 11249b7cd975SBarry Smith 1125d763cef2SBarry Smith /*@C 1126f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1127b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1128d763cef2SBarry Smith 11293f9fe445SBarry Smith Logically Collective on TS 1130d763cef2SBarry Smith 1131d763cef2SBarry Smith Input Parameters: 1132d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1133e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1134e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1135d763cef2SBarry Smith . f - the Jacobian evaluation routine 1136d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11370298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1138d763cef2SBarry Smith 1139f7ab8db6SBarry Smith Calling sequence of f: 1140ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1141d763cef2SBarry Smith 1142d763cef2SBarry Smith + t - current timestep 1143d763cef2SBarry Smith . u - input vector 1144e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1145e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1146d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1147d763cef2SBarry Smith 11486cd88445SBarry Smith Notes: 11496cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 11506cd88445SBarry Smith 11516cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1152ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1153d763cef2SBarry Smith 1154d763cef2SBarry Smith Level: beginner 1155d763cef2SBarry Smith 1156d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1157d763cef2SBarry Smith 1158ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1159d763cef2SBarry Smith 1160d763cef2SBarry Smith @*/ 1161e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1162d763cef2SBarry Smith { 1163277b19d0SLisandro Dalcin PetscErrorCode ierr; 1164089b2837SJed Brown SNES snes; 116524989b8cSPeter Brune DM dm; 116624989b8cSPeter Brune TSIJacobian ijacobian; 1167277b19d0SLisandro Dalcin 1168d763cef2SBarry Smith PetscFunctionBegin; 11690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1170e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1171e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1172e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1173e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1174d763cef2SBarry Smith 117524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 117624989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1177e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1178e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1179e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1180e1244c69SJed Brown } 11810298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1182089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11835f659677SPeter Brune if (!ijacobian) { 1184e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 11850e4ef248SJed Brown } 1186e5d3d808SBarry Smith if (Amat) { 1187e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 11880e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1189e5d3d808SBarry Smith ts->Arhs = Amat; 11900e4ef248SJed Brown } 1191e5d3d808SBarry Smith if (Pmat) { 1192e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 11930e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1194e5d3d808SBarry Smith ts->Brhs = Pmat; 11950e4ef248SJed Brown } 1196d763cef2SBarry Smith PetscFunctionReturn(0); 1197d763cef2SBarry Smith } 1198d763cef2SBarry Smith 1199316643e7SJed Brown 1200316643e7SJed Brown /*@C 1201b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1202316643e7SJed Brown 12033f9fe445SBarry Smith Logically Collective on TS 1204316643e7SJed Brown 1205316643e7SJed Brown Input Parameters: 1206316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12070298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1208316643e7SJed Brown . f - the function evaluation routine 12090298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1210316643e7SJed Brown 1211316643e7SJed Brown Calling sequence of f: 1212316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1213316643e7SJed Brown 1214316643e7SJed Brown + t - time at step/stage being solved 1215316643e7SJed Brown . u - state vector 1216316643e7SJed Brown . u_t - time derivative of state vector 1217316643e7SJed Brown . F - function vector 1218316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1219316643e7SJed Brown 1220316643e7SJed Brown Important: 12212bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1222316643e7SJed Brown 1223316643e7SJed Brown Level: beginner 1224316643e7SJed Brown 1225316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1226316643e7SJed Brown 1227d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1228316643e7SJed Brown @*/ 122951699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1230316643e7SJed Brown { 1231089b2837SJed Brown PetscErrorCode ierr; 1232089b2837SJed Brown SNES snes; 123351699248SLisandro Dalcin Vec ralloc = NULL; 123424989b8cSPeter Brune DM dm; 1235316643e7SJed Brown 1236316643e7SJed Brown PetscFunctionBegin; 12370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 123851699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 123924989b8cSPeter Brune 124024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 124124989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 124224989b8cSPeter Brune 1243089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 124451699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 124551699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 124651699248SLisandro Dalcin r = ralloc; 1247e856ceecSJed Brown } 124851699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 124951699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1250089b2837SJed Brown PetscFunctionReturn(0); 1251089b2837SJed Brown } 1252089b2837SJed Brown 1253089b2837SJed Brown /*@C 1254089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1255089b2837SJed Brown 1256089b2837SJed Brown Not Collective 1257089b2837SJed Brown 1258089b2837SJed Brown Input Parameter: 1259089b2837SJed Brown . ts - the TS context 1260089b2837SJed Brown 1261089b2837SJed Brown Output Parameter: 12620298fd71SBarry Smith + r - vector to hold residual (or NULL) 12630298fd71SBarry Smith . func - the function to compute residual (or NULL) 12640298fd71SBarry Smith - ctx - the function context (or NULL) 1265089b2837SJed Brown 1266089b2837SJed Brown Level: advanced 1267089b2837SJed Brown 1268089b2837SJed Brown .keywords: TS, nonlinear, get, function 1269089b2837SJed Brown 1270089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1271089b2837SJed Brown @*/ 1272089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1273089b2837SJed Brown { 1274089b2837SJed Brown PetscErrorCode ierr; 1275089b2837SJed Brown SNES snes; 127624989b8cSPeter Brune DM dm; 1277089b2837SJed Brown 1278089b2837SJed Brown PetscFunctionBegin; 1279089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1280089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12810298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 128224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 128324989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1284089b2837SJed Brown PetscFunctionReturn(0); 1285089b2837SJed Brown } 1286089b2837SJed Brown 1287089b2837SJed Brown /*@C 1288089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1289089b2837SJed Brown 1290089b2837SJed Brown Not Collective 1291089b2837SJed Brown 1292089b2837SJed Brown Input Parameter: 1293089b2837SJed Brown . ts - the TS context 1294089b2837SJed Brown 1295089b2837SJed Brown Output Parameter: 12960298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 12970298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 12980298fd71SBarry Smith - ctx - the function context (or NULL) 1299089b2837SJed Brown 1300089b2837SJed Brown Level: advanced 1301089b2837SJed Brown 1302089b2837SJed Brown .keywords: TS, nonlinear, get, function 1303089b2837SJed Brown 13042bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1305089b2837SJed Brown @*/ 1306089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1307089b2837SJed Brown { 1308089b2837SJed Brown PetscErrorCode ierr; 1309089b2837SJed Brown SNES snes; 131024989b8cSPeter Brune DM dm; 1311089b2837SJed Brown 1312089b2837SJed Brown PetscFunctionBegin; 1313089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1314089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13150298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 131624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 131724989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1318316643e7SJed Brown PetscFunctionReturn(0); 1319316643e7SJed Brown } 1320316643e7SJed Brown 1321316643e7SJed Brown /*@C 1322a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1323ae8867d6SBarry Smith provided with TSSetIFunction(). 1324316643e7SJed Brown 13253f9fe445SBarry Smith Logically Collective on TS 1326316643e7SJed Brown 1327316643e7SJed Brown Input Parameters: 1328316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1329e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1330e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1331316643e7SJed Brown . f - the Jacobian evaluation routine 13320298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1333316643e7SJed Brown 1334316643e7SJed Brown Calling sequence of f: 1335ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1336316643e7SJed Brown 1337316643e7SJed Brown + t - time at step/stage being solved 13381b4a444bSJed Brown . U - state vector 13391b4a444bSJed Brown . U_t - time derivative of state vector 1340316643e7SJed Brown . a - shift 1341e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1342e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1343316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1344316643e7SJed Brown 1345316643e7SJed Brown Notes: 1346e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1347316643e7SJed Brown 1348895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1349895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1350895c21f2SBarry Smith 1351a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1352b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1353a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1354a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1355a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1356a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1357a4f0a591SBarry Smith 13586cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 13596cd88445SBarry Smith 13606cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1361ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1362ca5f011dSBarry Smith 1363316643e7SJed Brown Level: beginner 1364316643e7SJed Brown 1365316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1366316643e7SJed Brown 1367ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1368316643e7SJed Brown 1369316643e7SJed Brown @*/ 1370e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1371316643e7SJed Brown { 1372316643e7SJed Brown PetscErrorCode ierr; 1373089b2837SJed Brown SNES snes; 137424989b8cSPeter Brune DM dm; 1375316643e7SJed Brown 1376316643e7SJed Brown PetscFunctionBegin; 13770700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1378e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1379e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1380e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1381e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 138224989b8cSPeter Brune 138324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 138424989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 138524989b8cSPeter Brune 1386089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1387e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1388316643e7SJed Brown PetscFunctionReturn(0); 1389316643e7SJed Brown } 1390316643e7SJed Brown 1391e1244c69SJed Brown /*@ 1392e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1393e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1394e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1395e1244c69SJed Brown not been changed by the TS. 1396e1244c69SJed Brown 1397e1244c69SJed Brown Logically Collective 1398e1244c69SJed Brown 1399e1244c69SJed Brown Input Arguments: 1400e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1401e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1402e1244c69SJed Brown 1403e1244c69SJed Brown Level: intermediate 1404e1244c69SJed Brown 1405e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1406e1244c69SJed Brown @*/ 1407e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1408e1244c69SJed Brown { 1409e1244c69SJed Brown PetscFunctionBegin; 1410e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1411e1244c69SJed Brown PetscFunctionReturn(0); 1412e1244c69SJed Brown } 1413e1244c69SJed Brown 1414efe9872eSLisandro Dalcin /*@C 1415efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1416efe9872eSLisandro Dalcin 1417efe9872eSLisandro Dalcin Logically Collective on TS 1418efe9872eSLisandro Dalcin 1419efe9872eSLisandro Dalcin Input Parameters: 1420efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1421efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1422efe9872eSLisandro Dalcin . fun - the function evaluation routine 1423efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1424efe9872eSLisandro Dalcin 1425efe9872eSLisandro Dalcin Calling sequence of fun: 1426efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1427efe9872eSLisandro Dalcin 1428efe9872eSLisandro Dalcin + t - time at step/stage being solved 1429efe9872eSLisandro Dalcin . U - state vector 1430efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1431efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1432efe9872eSLisandro Dalcin . F - function vector 1433efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1434efe9872eSLisandro Dalcin 1435efe9872eSLisandro Dalcin Level: beginner 1436efe9872eSLisandro Dalcin 1437efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1438efe9872eSLisandro Dalcin 1439efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1440efe9872eSLisandro Dalcin @*/ 1441efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1442efe9872eSLisandro Dalcin { 1443efe9872eSLisandro Dalcin DM dm; 1444efe9872eSLisandro Dalcin PetscErrorCode ierr; 1445efe9872eSLisandro Dalcin 1446efe9872eSLisandro Dalcin PetscFunctionBegin; 1447efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1448efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1449efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1450efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1451efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1452efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1453efe9872eSLisandro Dalcin } 1454efe9872eSLisandro Dalcin 1455efe9872eSLisandro Dalcin /*@C 1456efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1457efe9872eSLisandro Dalcin 1458efe9872eSLisandro Dalcin Not Collective 1459efe9872eSLisandro Dalcin 1460efe9872eSLisandro Dalcin Input Parameter: 1461efe9872eSLisandro Dalcin . ts - the TS context 1462efe9872eSLisandro Dalcin 1463efe9872eSLisandro Dalcin Output Parameter: 1464efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1465efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1466efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1467efe9872eSLisandro Dalcin 1468efe9872eSLisandro Dalcin Level: advanced 1469efe9872eSLisandro Dalcin 1470efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1471efe9872eSLisandro Dalcin 1472efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1473efe9872eSLisandro Dalcin @*/ 1474efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1475efe9872eSLisandro Dalcin { 1476efe9872eSLisandro Dalcin PetscErrorCode ierr; 1477efe9872eSLisandro Dalcin SNES snes; 1478efe9872eSLisandro Dalcin DM dm; 1479efe9872eSLisandro Dalcin 1480efe9872eSLisandro Dalcin PetscFunctionBegin; 1481efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1482efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1483efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1484efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1485efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1486efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1487efe9872eSLisandro Dalcin } 1488efe9872eSLisandro Dalcin 1489efe9872eSLisandro Dalcin /*@C 1490bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1491efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1492efe9872eSLisandro Dalcin 1493efe9872eSLisandro Dalcin Logically Collective on TS 1494efe9872eSLisandro Dalcin 1495efe9872eSLisandro Dalcin Input Parameters: 1496efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1497efe9872eSLisandro Dalcin . J - Jacobian matrix 1498efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1499efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1500efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1501efe9872eSLisandro Dalcin 1502efe9872eSLisandro Dalcin Calling sequence of jac: 1503bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1504efe9872eSLisandro Dalcin 1505efe9872eSLisandro Dalcin + t - time at step/stage being solved 1506efe9872eSLisandro Dalcin . U - state vector 1507efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1508efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1509efe9872eSLisandro Dalcin . v - shift for U_t 1510efe9872eSLisandro Dalcin . a - shift for U_tt 1511efe9872eSLisandro Dalcin . J - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt 1512efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1513efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1514efe9872eSLisandro Dalcin 1515efe9872eSLisandro Dalcin Notes: 1516efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1517efe9872eSLisandro Dalcin 1518efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1519efe9872eSLisandro Dalcin the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved. 1520efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1521bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1522efe9872eSLisandro Dalcin 1523efe9872eSLisandro Dalcin Level: beginner 1524efe9872eSLisandro Dalcin 1525efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1526efe9872eSLisandro Dalcin 1527efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1528efe9872eSLisandro Dalcin @*/ 1529efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1530efe9872eSLisandro Dalcin { 1531efe9872eSLisandro Dalcin DM dm; 1532efe9872eSLisandro Dalcin PetscErrorCode ierr; 1533efe9872eSLisandro Dalcin 1534efe9872eSLisandro Dalcin PetscFunctionBegin; 1535efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1536efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1537efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1538efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1539efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1540efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1541efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1542efe9872eSLisandro Dalcin } 1543efe9872eSLisandro Dalcin 1544efe9872eSLisandro Dalcin /*@C 1545efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1546efe9872eSLisandro Dalcin 1547efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1548efe9872eSLisandro Dalcin 1549efe9872eSLisandro Dalcin Input Parameter: 1550efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1551efe9872eSLisandro Dalcin 1552efe9872eSLisandro Dalcin Output Parameters: 1553efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1554efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1555efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1556efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1557efe9872eSLisandro Dalcin 1558efe9872eSLisandro Dalcin Notes: You can pass in NULL for any return argument you do not need. 1559efe9872eSLisandro Dalcin 1560efe9872eSLisandro Dalcin Level: advanced 1561efe9872eSLisandro Dalcin 1562efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 1563efe9872eSLisandro Dalcin 1564efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1565efe9872eSLisandro Dalcin @*/ 1566efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1567efe9872eSLisandro Dalcin { 1568efe9872eSLisandro Dalcin PetscErrorCode ierr; 1569efe9872eSLisandro Dalcin SNES snes; 1570efe9872eSLisandro Dalcin DM dm; 1571efe9872eSLisandro Dalcin 1572efe9872eSLisandro Dalcin PetscFunctionBegin; 1573efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1574efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1575efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1576efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1577efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1578efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1579efe9872eSLisandro Dalcin } 1580efe9872eSLisandro Dalcin 1581efe9872eSLisandro Dalcin /*@ 1582efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1583efe9872eSLisandro Dalcin 1584efe9872eSLisandro Dalcin Collective on TS and Vec 1585efe9872eSLisandro Dalcin 1586efe9872eSLisandro Dalcin Input Parameters: 1587efe9872eSLisandro Dalcin + ts - the TS context 1588efe9872eSLisandro Dalcin . t - current time 1589efe9872eSLisandro Dalcin . U - state vector 1590efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1591efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1592efe9872eSLisandro Dalcin 1593efe9872eSLisandro Dalcin Output Parameter: 1594efe9872eSLisandro Dalcin . F - the residual vector 1595efe9872eSLisandro Dalcin 1596efe9872eSLisandro Dalcin Note: 1597efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1598efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1599efe9872eSLisandro Dalcin 1600efe9872eSLisandro Dalcin Level: developer 1601efe9872eSLisandro Dalcin 1602efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1603efe9872eSLisandro Dalcin 1604efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1605efe9872eSLisandro Dalcin @*/ 1606efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1607efe9872eSLisandro Dalcin { 1608efe9872eSLisandro Dalcin DM dm; 1609efe9872eSLisandro Dalcin TSI2Function I2Function; 1610efe9872eSLisandro Dalcin void *ctx; 1611efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1612efe9872eSLisandro Dalcin PetscErrorCode ierr; 1613efe9872eSLisandro Dalcin 1614efe9872eSLisandro Dalcin PetscFunctionBegin; 1615efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1616efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1617efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1618efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1619efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1620efe9872eSLisandro Dalcin 1621efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1622efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1623efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1624efe9872eSLisandro Dalcin 1625efe9872eSLisandro Dalcin if (!I2Function) { 1626efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1627efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1628efe9872eSLisandro Dalcin } 1629efe9872eSLisandro Dalcin 1630efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1631efe9872eSLisandro Dalcin 1632efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1633efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1634efe9872eSLisandro Dalcin PetscStackPop; 1635efe9872eSLisandro Dalcin 1636efe9872eSLisandro Dalcin if (rhsfunction) { 1637efe9872eSLisandro Dalcin Vec Frhs; 1638efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1639efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1640efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1641efe9872eSLisandro Dalcin } 1642efe9872eSLisandro Dalcin 1643efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1644efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1645efe9872eSLisandro Dalcin } 1646efe9872eSLisandro Dalcin 1647efe9872eSLisandro Dalcin /*@ 1648efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1649efe9872eSLisandro Dalcin 1650efe9872eSLisandro Dalcin Collective on TS and Vec 1651efe9872eSLisandro Dalcin 1652efe9872eSLisandro Dalcin Input Parameters: 1653efe9872eSLisandro Dalcin + ts - the TS context 1654efe9872eSLisandro Dalcin . t - current timestep 1655efe9872eSLisandro Dalcin . U - state vector 1656efe9872eSLisandro Dalcin . V - time derivative of state vector 1657efe9872eSLisandro Dalcin . A - second time derivative of state vector 1658efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1659efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1660efe9872eSLisandro Dalcin 1661efe9872eSLisandro Dalcin Output Parameters: 1662efe9872eSLisandro Dalcin + J - Jacobian matrix 1663efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1664efe9872eSLisandro Dalcin 1665efe9872eSLisandro Dalcin Notes: 1666efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1667efe9872eSLisandro Dalcin 1668efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1669efe9872eSLisandro Dalcin 1670efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1671efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1672efe9872eSLisandro Dalcin 1673efe9872eSLisandro Dalcin Level: developer 1674efe9872eSLisandro Dalcin 1675efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1676efe9872eSLisandro Dalcin 1677efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1678efe9872eSLisandro Dalcin @*/ 1679efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1680efe9872eSLisandro Dalcin { 1681efe9872eSLisandro Dalcin DM dm; 1682efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1683efe9872eSLisandro Dalcin void *ctx; 1684efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1685efe9872eSLisandro Dalcin PetscErrorCode ierr; 1686efe9872eSLisandro Dalcin 1687efe9872eSLisandro Dalcin PetscFunctionBegin; 1688efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1689efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1690efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1691efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1692efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1693efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1694efe9872eSLisandro Dalcin 1695efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1696efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1697efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1698efe9872eSLisandro Dalcin 1699efe9872eSLisandro Dalcin if (!I2Jacobian) { 1700efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1701efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1702efe9872eSLisandro Dalcin } 1703efe9872eSLisandro Dalcin 1704efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1705efe9872eSLisandro Dalcin 1706efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1707efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1708efe9872eSLisandro Dalcin PetscStackPop; 1709efe9872eSLisandro Dalcin 1710efe9872eSLisandro Dalcin if (rhsjacobian) { 1711efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1712efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1713efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1714efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1715efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1716efe9872eSLisandro Dalcin } 1717efe9872eSLisandro Dalcin 1718efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1719efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1720efe9872eSLisandro Dalcin } 1721efe9872eSLisandro Dalcin 1722efe9872eSLisandro Dalcin /*@ 1723efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1724efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1725efe9872eSLisandro Dalcin 1726efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1727efe9872eSLisandro Dalcin 1728efe9872eSLisandro Dalcin Input Parameters: 1729efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1730efe9872eSLisandro Dalcin . u - the solution vector 1731efe9872eSLisandro Dalcin - v - the time derivative vector 1732efe9872eSLisandro Dalcin 1733efe9872eSLisandro Dalcin Level: beginner 1734efe9872eSLisandro Dalcin 1735efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1736efe9872eSLisandro Dalcin @*/ 1737efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1738efe9872eSLisandro Dalcin { 1739efe9872eSLisandro Dalcin PetscErrorCode ierr; 1740efe9872eSLisandro Dalcin 1741efe9872eSLisandro Dalcin PetscFunctionBegin; 1742efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1743efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1744efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1745efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1746efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1747efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1748efe9872eSLisandro Dalcin ts->vec_dot = v; 1749efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1750efe9872eSLisandro Dalcin } 1751efe9872eSLisandro Dalcin 1752efe9872eSLisandro Dalcin /*@ 1753efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1754efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1755efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1756efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1757efe9872eSLisandro Dalcin 1758efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1759efe9872eSLisandro Dalcin 1760efe9872eSLisandro Dalcin Input Parameter: 1761efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1762efe9872eSLisandro Dalcin 1763efe9872eSLisandro Dalcin Output Parameter: 1764efe9872eSLisandro Dalcin + u - the vector containing the solution 1765efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1766efe9872eSLisandro Dalcin 1767efe9872eSLisandro Dalcin Level: intermediate 1768efe9872eSLisandro Dalcin 1769efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1770efe9872eSLisandro Dalcin 1771efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1772efe9872eSLisandro Dalcin @*/ 1773efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1774efe9872eSLisandro Dalcin { 1775efe9872eSLisandro Dalcin PetscFunctionBegin; 1776efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1777efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1778efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1779efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1780efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1781efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1782efe9872eSLisandro Dalcin } 1783efe9872eSLisandro Dalcin 178455849f57SBarry Smith /*@C 178555849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 178655849f57SBarry Smith 178755849f57SBarry Smith Collective on PetscViewer 178855849f57SBarry Smith 178955849f57SBarry Smith Input Parameters: 179055849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 179155849f57SBarry Smith some related function before a call to TSLoad(). 179255849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 179355849f57SBarry Smith 179455849f57SBarry Smith Level: intermediate 179555849f57SBarry Smith 179655849f57SBarry Smith Notes: 179755849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 179855849f57SBarry Smith 179955849f57SBarry Smith Notes for advanced users: 180055849f57SBarry Smith Most users should not need to know the details of the binary storage 180155849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 180255849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 180355849f57SBarry Smith format is 180455849f57SBarry Smith .vb 180555849f57SBarry Smith has not yet been determined 180655849f57SBarry Smith .ve 180755849f57SBarry Smith 180855849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 180955849f57SBarry Smith @*/ 1810f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 181155849f57SBarry Smith { 181255849f57SBarry Smith PetscErrorCode ierr; 181355849f57SBarry Smith PetscBool isbinary; 181455849f57SBarry Smith PetscInt classid; 181555849f57SBarry Smith char type[256]; 18162d53ad75SBarry Smith DMTS sdm; 1817ad6bc421SBarry Smith DM dm; 181855849f57SBarry Smith 181955849f57SBarry Smith PetscFunctionBegin; 1820f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 182155849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 182255849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 182355849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 182455849f57SBarry Smith 1825060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1826ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1827060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1828f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1829f2c2a1b9SBarry Smith if (ts->ops->load) { 1830f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1831f2c2a1b9SBarry Smith } 1832ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1833ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1834ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1835f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1836f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 18372d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 18382d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 183955849f57SBarry Smith PetscFunctionReturn(0); 184055849f57SBarry Smith } 184155849f57SBarry Smith 18429804daf3SBarry Smith #include <petscdraw.h> 1843e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1844e04113cfSBarry Smith #include <petscviewersaws.h> 1845f05ece33SBarry Smith #endif 18467e2c5f70SBarry Smith /*@C 1847d763cef2SBarry Smith TSView - Prints the TS data structure. 1848d763cef2SBarry Smith 18494c49b128SBarry Smith Collective on TS 1850d763cef2SBarry Smith 1851d763cef2SBarry Smith Input Parameters: 1852d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1853d763cef2SBarry Smith - viewer - visualization context 1854d763cef2SBarry Smith 1855d763cef2SBarry Smith Options Database Key: 1856d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1857d763cef2SBarry Smith 1858d763cef2SBarry Smith Notes: 1859d763cef2SBarry Smith The available visualization contexts include 1860b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1861b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1862d763cef2SBarry Smith output where only the first processor opens 1863d763cef2SBarry Smith the file. All other processors send their 1864d763cef2SBarry Smith data to the first processor to print. 1865d763cef2SBarry Smith 1866d763cef2SBarry Smith The user can open an alternative visualization context with 1867b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1868d763cef2SBarry Smith 1869d763cef2SBarry Smith Level: beginner 1870d763cef2SBarry Smith 1871d763cef2SBarry Smith .keywords: TS, timestep, view 1872d763cef2SBarry Smith 1873b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1874d763cef2SBarry Smith @*/ 18757087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1876d763cef2SBarry Smith { 1877dfbe8321SBarry Smith PetscErrorCode ierr; 187819fd82e9SBarry Smith TSType type; 18792b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 18802d53ad75SBarry Smith DMTS sdm; 1881e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1882536b137fSBarry Smith PetscBool issaws; 1883f05ece33SBarry Smith #endif 1884d763cef2SBarry Smith 1885d763cef2SBarry Smith PetscFunctionBegin; 18860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 18873050cee2SBarry Smith if (!viewer) { 1888ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 18893050cee2SBarry Smith } 18900700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1891c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1892fd16b177SBarry Smith 1893251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1894251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 189555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 18962b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1897e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1898536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1899f05ece33SBarry Smith #endif 190032077d6dSBarry Smith if (iascii) { 1901dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 190277431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 19037c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1904d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19055ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1906c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1907d763cef2SBarry Smith } 19085ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1909193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1910a0af407cSBarry Smith if (ts->vrtol) { 1911a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1912a0af407cSBarry Smith } else { 1913a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1914a0af407cSBarry Smith } 1915a0af407cSBarry Smith if (ts->vatol) { 1916a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1917a0af407cSBarry Smith } else { 1918a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1919a0af407cSBarry Smith } 19202d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19212d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1922d52bd9f3SBarry Smith if (ts->ops->view) { 1923d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1924d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1925d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1926d52bd9f3SBarry Smith } 19270f5bd95cSBarry Smith } else if (isstring) { 1928a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1929b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 193055849f57SBarry Smith } else if (isbinary) { 193155849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 193255849f57SBarry Smith MPI_Comm comm; 193355849f57SBarry Smith PetscMPIInt rank; 193455849f57SBarry Smith char type[256]; 193555849f57SBarry Smith 193655849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 193755849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 193855849f57SBarry Smith if (!rank) { 193955849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 194055849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 194155849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 194255849f57SBarry Smith } 194355849f57SBarry Smith if (ts->ops->view) { 194455849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 194555849f57SBarry Smith } 1946f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1947f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 19482d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19492d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19502b0a91c0SBarry Smith } else if (isdraw) { 19512b0a91c0SBarry Smith PetscDraw draw; 19522b0a91c0SBarry Smith char str[36]; 195389fd9fafSBarry Smith PetscReal x,y,bottom,h; 19542b0a91c0SBarry Smith 19552b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 19562b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 19572b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 19582b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 195951fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 196089fd9fafSBarry Smith bottom = y - h; 19612b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 19622b0a91c0SBarry Smith if (ts->ops->view) { 19632b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 19642b0a91c0SBarry Smith } 19652b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1966e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1967536b137fSBarry Smith } else if (issaws) { 1968d45a07a7SBarry Smith PetscMPIInt rank; 19692657e9d9SBarry Smith const char *name; 19702657e9d9SBarry Smith 19712657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1972d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1973d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1974d45a07a7SBarry Smith char dir[1024]; 1975d45a07a7SBarry Smith 1976e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1977a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 19782657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 19792657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 19802657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1981d763cef2SBarry Smith } 19820acecf5bSBarry Smith if (ts->ops->view) { 19830acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 19840acecf5bSBarry Smith } 1985f05ece33SBarry Smith #endif 1986f05ece33SBarry Smith } 1987f05ece33SBarry Smith 1988b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1989251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 1990b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1991d763cef2SBarry Smith PetscFunctionReturn(0); 1992d763cef2SBarry Smith } 1993d763cef2SBarry Smith 1994d763cef2SBarry Smith 1995b07ff414SBarry Smith /*@ 1996d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 1997d763cef2SBarry Smith the timesteppers. 1998d763cef2SBarry Smith 19993f9fe445SBarry Smith Logically Collective on TS 2000d763cef2SBarry Smith 2001d763cef2SBarry Smith Input Parameters: 2002d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2003d763cef2SBarry Smith - usrP - optional user context 2004d763cef2SBarry Smith 2005daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2006daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2007daf670e6SBarry Smith 2008d763cef2SBarry Smith Level: intermediate 2009d763cef2SBarry Smith 2010d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2011d763cef2SBarry Smith 2012d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2013d763cef2SBarry Smith @*/ 20147087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2015d763cef2SBarry Smith { 2016d763cef2SBarry Smith PetscFunctionBegin; 20170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2018d763cef2SBarry Smith ts->user = usrP; 2019d763cef2SBarry Smith PetscFunctionReturn(0); 2020d763cef2SBarry Smith } 2021d763cef2SBarry Smith 2022b07ff414SBarry Smith /*@ 2023d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2024d763cef2SBarry Smith timestepper. 2025d763cef2SBarry Smith 2026d763cef2SBarry Smith Not Collective 2027d763cef2SBarry Smith 2028d763cef2SBarry Smith Input Parameter: 2029d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2030d763cef2SBarry Smith 2031d763cef2SBarry Smith Output Parameter: 2032d763cef2SBarry Smith . usrP - user context 2033d763cef2SBarry Smith 2034daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2035daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2036daf670e6SBarry Smith 2037d763cef2SBarry Smith Level: intermediate 2038d763cef2SBarry Smith 2039d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2040d763cef2SBarry Smith 2041d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2042d763cef2SBarry Smith @*/ 2043e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2044d763cef2SBarry Smith { 2045d763cef2SBarry Smith PetscFunctionBegin; 20460700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2047e71120c6SJed Brown *(void**)usrP = ts->user; 2048d763cef2SBarry Smith PetscFunctionReturn(0); 2049d763cef2SBarry Smith } 2050d763cef2SBarry Smith 2051d763cef2SBarry Smith /*@ 2052b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 2053d763cef2SBarry Smith 2054d763cef2SBarry Smith Not Collective 2055d763cef2SBarry Smith 2056d763cef2SBarry Smith Input Parameter: 2057d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2058d763cef2SBarry Smith 2059d763cef2SBarry Smith Output Parameter: 2060b8123daeSJed Brown . iter - number of steps completed so far 2061d763cef2SBarry Smith 2062d763cef2SBarry Smith Level: intermediate 2063d763cef2SBarry Smith 2064d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 20659be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2066d763cef2SBarry Smith @*/ 20677087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 2068d763cef2SBarry Smith { 2069d763cef2SBarry Smith PetscFunctionBegin; 20700700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20714482741eSBarry Smith PetscValidIntPointer(iter,2); 2072d763cef2SBarry Smith *iter = ts->steps; 2073d763cef2SBarry Smith PetscFunctionReturn(0); 2074d763cef2SBarry Smith } 2075d763cef2SBarry Smith 2076d763cef2SBarry Smith /*@ 2077d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 2078d763cef2SBarry Smith as well as the initial time. 2079d763cef2SBarry Smith 20803f9fe445SBarry Smith Logically Collective on TS 2081d763cef2SBarry Smith 2082d763cef2SBarry Smith Input Parameters: 2083d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2084d763cef2SBarry Smith . initial_time - the initial time 2085d763cef2SBarry Smith - time_step - the size of the timestep 2086d763cef2SBarry Smith 2087d763cef2SBarry Smith Level: intermediate 2088d763cef2SBarry Smith 2089d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 2090d763cef2SBarry Smith 2091d763cef2SBarry Smith .keywords: TS, set, initial, timestep 2092d763cef2SBarry Smith @*/ 20937087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2094d763cef2SBarry Smith { 2095e144a568SJed Brown PetscErrorCode ierr; 2096e144a568SJed Brown 2097d763cef2SBarry Smith PetscFunctionBegin; 20980700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2099e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2100d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2101d763cef2SBarry Smith PetscFunctionReturn(0); 2102d763cef2SBarry Smith } 2103d763cef2SBarry Smith 2104d763cef2SBarry Smith /*@ 2105d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2106d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2107d763cef2SBarry Smith 21083f9fe445SBarry Smith Logically Collective on TS 2109d763cef2SBarry Smith 2110d763cef2SBarry Smith Input Parameters: 2111d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2112d763cef2SBarry Smith - time_step - the size of the timestep 2113d763cef2SBarry Smith 2114d763cef2SBarry Smith Level: intermediate 2115d763cef2SBarry Smith 2116d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2117d763cef2SBarry Smith 2118d763cef2SBarry Smith .keywords: TS, set, timestep 2119d763cef2SBarry Smith @*/ 21207087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2121d763cef2SBarry Smith { 2122d763cef2SBarry Smith PetscFunctionBegin; 21230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2124c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2125d763cef2SBarry Smith ts->time_step = time_step; 2126d763cef2SBarry Smith PetscFunctionReturn(0); 2127d763cef2SBarry Smith } 2128d763cef2SBarry Smith 2129a43b19c4SJed Brown /*@ 213049354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 213149354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 213249354f04SShri Abhyankar or just return at the final time TS computed. 2133a43b19c4SJed Brown 2134a43b19c4SJed Brown Logically Collective on TS 2135a43b19c4SJed Brown 2136a43b19c4SJed Brown Input Parameter: 2137a43b19c4SJed Brown + ts - the time-step context 213849354f04SShri Abhyankar - eftopt - exact final time option 2139a43b19c4SJed Brown 2140feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2141feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2142feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2143feed9e9dSBarry Smith 2144feed9e9dSBarry Smith Options Database: 2145feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2146feed9e9dSBarry Smith 2147ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2148ee346746SBarry Smith then the final time you selected. 2149ee346746SBarry Smith 2150a43b19c4SJed Brown Level: beginner 2151a43b19c4SJed Brown 2152a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 2153a43b19c4SJed Brown @*/ 215449354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2155a43b19c4SJed Brown { 2156a43b19c4SJed Brown PetscFunctionBegin; 2157a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 215849354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 215949354f04SShri Abhyankar ts->exact_final_time = eftopt; 2160a43b19c4SJed Brown PetscFunctionReturn(0); 2161a43b19c4SJed Brown } 2162a43b19c4SJed Brown 2163d763cef2SBarry Smith /*@ 2164d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2165d763cef2SBarry Smith 2166d763cef2SBarry Smith Not Collective 2167d763cef2SBarry Smith 2168d763cef2SBarry Smith Input Parameter: 2169d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2170d763cef2SBarry Smith 2171d763cef2SBarry Smith Output Parameter: 2172d763cef2SBarry Smith . dt - the current timestep size 2173d763cef2SBarry Smith 2174d763cef2SBarry Smith Level: intermediate 2175d763cef2SBarry Smith 2176d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2177d763cef2SBarry Smith 2178d763cef2SBarry Smith .keywords: TS, get, timestep 2179d763cef2SBarry Smith @*/ 21807087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2181d763cef2SBarry Smith { 2182d763cef2SBarry Smith PetscFunctionBegin; 21830700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2184f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2185d763cef2SBarry Smith *dt = ts->time_step; 2186d763cef2SBarry Smith PetscFunctionReturn(0); 2187d763cef2SBarry Smith } 2188d763cef2SBarry Smith 2189d8e5e3e6SSatish Balay /*@ 2190d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2191d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2192d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2193d763cef2SBarry Smith the solution at the next timestep has been calculated. 2194d763cef2SBarry Smith 2195d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2196d763cef2SBarry Smith 2197d763cef2SBarry Smith Input Parameter: 2198d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2199d763cef2SBarry Smith 2200d763cef2SBarry Smith Output Parameter: 2201d763cef2SBarry Smith . v - the vector containing the solution 2202d763cef2SBarry Smith 220363e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 220463e21af5SBarry Smith final time. It returns the solution at the next timestep. 220563e21af5SBarry Smith 2206d763cef2SBarry Smith Level: intermediate 2207d763cef2SBarry Smith 2208b2bf4f3aSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents() 2209d763cef2SBarry Smith 2210d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2211d763cef2SBarry Smith @*/ 22127087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2213d763cef2SBarry Smith { 2214d763cef2SBarry Smith PetscFunctionBegin; 22150700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22164482741eSBarry Smith PetscValidPointer(v,2); 22178737fe31SLisandro Dalcin *v = ts->vec_sol; 2218d763cef2SBarry Smith PetscFunctionReturn(0); 2219d763cef2SBarry Smith } 2220d763cef2SBarry Smith 222103fe5f5eSDebojyoti Ghosh /*@ 2222b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 222303fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2224b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 222503fe5f5eSDebojyoti Ghosh structure as the solution vector. 222603fe5f5eSDebojyoti Ghosh 222703fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 222803fe5f5eSDebojyoti Ghosh 222903fe5f5eSDebojyoti Ghosh Parameters : 223003fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2231b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2232b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 223303fe5f5eSDebojyoti Ghosh returned in v. 2234b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 223503fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2236b2bf4f3aSDebojyoti Ghosh the number of solutions components). 223703fe5f5eSDebojyoti Ghosh 22384cdd57e5SDebojyoti Ghosh Level: advanced 223903fe5f5eSDebojyoti Ghosh 224003fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 224103fe5f5eSDebojyoti Ghosh 224203fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 224303fe5f5eSDebojyoti Ghosh @*/ 2244b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 224503fe5f5eSDebojyoti Ghosh { 224603fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 224703fe5f5eSDebojyoti Ghosh 224803fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 224903fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2250b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 225103fe5f5eSDebojyoti Ghosh else { 2252b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 225303fe5f5eSDebojyoti Ghosh } 225403fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 225503fe5f5eSDebojyoti Ghosh } 225603fe5f5eSDebojyoti Ghosh 22574cdd57e5SDebojyoti Ghosh /*@ 22584cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 22594cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 22604cdd57e5SDebojyoti Ghosh 22614cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 22624cdd57e5SDebojyoti Ghosh 22634cdd57e5SDebojyoti Ghosh Parameters : 22644cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 22654cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 22664cdd57e5SDebojyoti Ghosh 22674cdd57e5SDebojyoti Ghosh Level: intermediate 22684cdd57e5SDebojyoti Ghosh 22694cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 22704cdd57e5SDebojyoti Ghosh 22714cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 22724cdd57e5SDebojyoti Ghosh @*/ 22734cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 22744cdd57e5SDebojyoti Ghosh { 22754cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 22764cdd57e5SDebojyoti Ghosh 22774cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 22784cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2279f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 22804cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2281f6356ec7SDebojyoti Ghosh } else { 2282f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2283f6356ec7SDebojyoti Ghosh } 22844cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 22854cdd57e5SDebojyoti Ghosh } 22864cdd57e5SDebojyoti Ghosh 22874cdd57e5SDebojyoti Ghosh /*@ 22884cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 22894cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 22904cdd57e5SDebojyoti Ghosh 22914cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 22924cdd57e5SDebojyoti Ghosh 22939657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 22949657682dSDebojyoti Ghosh 22954cdd57e5SDebojyoti Ghosh Parameters : 22964cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2297657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 22984cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 22994cdd57e5SDebojyoti Ghosh 23004cdd57e5SDebojyoti Ghosh Level: intermediate 23014cdd57e5SDebojyoti Ghosh 230257df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 23034cdd57e5SDebojyoti Ghosh 23044cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 23054cdd57e5SDebojyoti Ghosh @*/ 23060a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 23074cdd57e5SDebojyoti Ghosh { 23084cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23094cdd57e5SDebojyoti Ghosh 23104cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23114cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2312f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 23130a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2314f6356ec7SDebojyoti Ghosh } else { 2315f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2316f6356ec7SDebojyoti Ghosh } 23174cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23184cdd57e5SDebojyoti Ghosh } 23194cdd57e5SDebojyoti Ghosh 232057df6a1bSDebojyoti Ghosh /*@ 232157df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 232257df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 232357df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 232457df6a1bSDebojyoti Ghosh 232557df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 232657df6a1bSDebojyoti Ghosh 232757df6a1bSDebojyoti Ghosh Parameters : 232857df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 232957df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 233057df6a1bSDebojyoti Ghosh 233157df6a1bSDebojyoti Ghosh Level: intermediate 233257df6a1bSDebojyoti Ghosh 233357df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 233457df6a1bSDebojyoti Ghosh 233557df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 233657df6a1bSDebojyoti Ghosh @*/ 233757df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 233857df6a1bSDebojyoti Ghosh { 233957df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 234057df6a1bSDebojyoti Ghosh 234157df6a1bSDebojyoti Ghosh PetscFunctionBegin; 234257df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23439657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 234457df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 234557df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 234657df6a1bSDebojyoti Ghosh } 234757df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 234857df6a1bSDebojyoti Ghosh } 234957df6a1bSDebojyoti Ghosh 2350c235aa8dSHong Zhang /*@ 2351dfb21088SHong Zhang TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2352c235aa8dSHong Zhang 2353c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 2354c235aa8dSHong Zhang 2355c235aa8dSHong Zhang Input Parameter: 2356c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 2357c235aa8dSHong Zhang 2358c235aa8dSHong Zhang Output Parameter: 2359abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2360abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2361c235aa8dSHong Zhang 2362c235aa8dSHong Zhang Level: intermediate 2363c235aa8dSHong Zhang 2364c235aa8dSHong Zhang .seealso: TSGetTimeStep() 2365c235aa8dSHong Zhang 2366c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 2367c235aa8dSHong Zhang @*/ 2368dfb21088SHong Zhang PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2369c235aa8dSHong Zhang { 2370c235aa8dSHong Zhang PetscFunctionBegin; 2371c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2372abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 2373abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 2374abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 2375c235aa8dSHong Zhang PetscFunctionReturn(0); 2376c235aa8dSHong Zhang } 2377c235aa8dSHong Zhang 2378bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2379d8e5e3e6SSatish Balay /*@ 2380bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2381d763cef2SBarry Smith 2382bdad233fSMatthew Knepley Not collective 2383d763cef2SBarry Smith 2384bdad233fSMatthew Knepley Input Parameters: 2385bdad233fSMatthew Knepley + ts - The TS 2386bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2387d763cef2SBarry Smith .vb 23880910c330SBarry Smith U_t - A U = 0 (linear) 23890910c330SBarry Smith U_t - A(t) U = 0 (linear) 23900910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2391d763cef2SBarry Smith .ve 2392d763cef2SBarry Smith 2393d763cef2SBarry Smith Level: beginner 2394d763cef2SBarry Smith 2395bdad233fSMatthew Knepley .keywords: TS, problem type 2396bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2397d763cef2SBarry Smith @*/ 23987087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2399a7cc72afSBarry Smith { 24009e2a6581SJed Brown PetscErrorCode ierr; 24019e2a6581SJed Brown 2402d763cef2SBarry Smith PetscFunctionBegin; 24030700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2404bdad233fSMatthew Knepley ts->problem_type = type; 24059e2a6581SJed Brown if (type == TS_LINEAR) { 24069e2a6581SJed Brown SNES snes; 24079e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 24089e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 24099e2a6581SJed Brown } 2410d763cef2SBarry Smith PetscFunctionReturn(0); 2411d763cef2SBarry Smith } 2412d763cef2SBarry Smith 2413bdad233fSMatthew Knepley /*@C 2414bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2415bdad233fSMatthew Knepley 2416bdad233fSMatthew Knepley Not collective 2417bdad233fSMatthew Knepley 2418bdad233fSMatthew Knepley Input Parameter: 2419bdad233fSMatthew Knepley . ts - The TS 2420bdad233fSMatthew Knepley 2421bdad233fSMatthew Knepley Output Parameter: 2422bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2423bdad233fSMatthew Knepley .vb 2424089b2837SJed Brown M U_t = A U 2425089b2837SJed Brown M(t) U_t = A(t) U 2426b5abc632SBarry Smith F(t,U,U_t) 2427bdad233fSMatthew Knepley .ve 2428bdad233fSMatthew Knepley 2429bdad233fSMatthew Knepley Level: beginner 2430bdad233fSMatthew Knepley 2431bdad233fSMatthew Knepley .keywords: TS, problem type 2432bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2433bdad233fSMatthew Knepley @*/ 24347087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2435a7cc72afSBarry Smith { 2436bdad233fSMatthew Knepley PetscFunctionBegin; 24370700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 24384482741eSBarry Smith PetscValidIntPointer(type,2); 2439bdad233fSMatthew Knepley *type = ts->problem_type; 2440bdad233fSMatthew Knepley PetscFunctionReturn(0); 2441bdad233fSMatthew Knepley } 2442d763cef2SBarry Smith 2443d763cef2SBarry Smith /*@ 2444d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2445d763cef2SBarry Smith of a timestepper. 2446d763cef2SBarry Smith 2447d763cef2SBarry Smith Collective on TS 2448d763cef2SBarry Smith 2449d763cef2SBarry Smith Input Parameter: 2450d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2451d763cef2SBarry Smith 2452d763cef2SBarry Smith Notes: 2453d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2454d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2455d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 2456d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2457d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 2458d763cef2SBarry Smith 2459d763cef2SBarry Smith Level: advanced 2460d763cef2SBarry Smith 2461d763cef2SBarry Smith .keywords: TS, timestep, setup 2462d763cef2SBarry Smith 2463d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 2464d763cef2SBarry Smith @*/ 24657087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2466d763cef2SBarry Smith { 2467dfbe8321SBarry Smith PetscErrorCode ierr; 24686c6b9e74SPeter Brune DM dm; 24696c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2470d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2471cd11d68dSLisandro Dalcin TSIFunction ifun; 24726c6b9e74SPeter Brune TSIJacobian ijac; 2473efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 24746c6b9e74SPeter Brune TSRHSJacobian rhsjac; 2475d763cef2SBarry Smith 2476d763cef2SBarry Smith PetscFunctionBegin; 24770700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2478277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2479277b19d0SLisandro Dalcin 24807adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2481cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2482cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2483d763cef2SBarry Smith } 2484277b19d0SLisandro Dalcin 2485277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2486277b19d0SLisandro Dalcin 2487e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 2488e1244c69SJed Brown Mat Amat,Pmat; 2489e1244c69SJed Brown SNES snes; 2490e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2491e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2492e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2493e1244c69SJed Brown * have displaced the RHS matrix */ 2494e1244c69SJed Brown if (Amat == ts->Arhs) { 2495e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2496e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2497e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2498e1244c69SJed Brown } 2499e1244c69SJed Brown if (Pmat == ts->Brhs) { 2500e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2501e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2502e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2503e1244c69SJed Brown } 2504e1244c69SJed Brown } 2505277b19d0SLisandro Dalcin if (ts->ops->setup) { 2506000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2507277b19d0SLisandro Dalcin } 2508277b19d0SLisandro Dalcin 2509a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 25106c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 25116c6b9e74SPeter Brune */ 25126c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 25130298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 25146c6b9e74SPeter Brune if (!func) { 25156c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 25166c6b9e74SPeter Brune } 2517a6772fa2SLisandro Dalcin /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 25186c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 25196c6b9e74SPeter Brune */ 25200298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 25210298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2522efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 25230298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2524efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 25256c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 25266c6b9e74SPeter Brune } 2527c0517034SDebojyoti Ghosh 2528c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2529c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2530c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2531c0517034SDebojyoti Ghosh } 2532c0517034SDebojyoti Ghosh 2533277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2534277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2535277b19d0SLisandro Dalcin } 2536277b19d0SLisandro Dalcin 2537f6a906c0SBarry Smith /*@ 2538f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 2539f6a906c0SBarry Smith of an adjoint solver 2540f6a906c0SBarry Smith 2541f6a906c0SBarry Smith Collective on TS 2542f6a906c0SBarry Smith 2543f6a906c0SBarry Smith Input Parameter: 2544f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 2545f6a906c0SBarry Smith 2546f6a906c0SBarry Smith Level: advanced 2547f6a906c0SBarry Smith 2548f6a906c0SBarry Smith .keywords: TS, timestep, setup 2549f6a906c0SBarry Smith 2550947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2551f6a906c0SBarry Smith @*/ 2552f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 2553f6a906c0SBarry Smith { 2554f6a906c0SBarry Smith PetscErrorCode ierr; 2555f6a906c0SBarry Smith 2556f6a906c0SBarry Smith PetscFunctionBegin; 2557f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2558f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 2559dfb21088SHong Zhang if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2560d8151eeaSBarry Smith 2561947abb85SHong Zhang if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 2562d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2563d8151eeaSBarry Smith if (ts->vecs_sensip){ 2564d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2565d8151eeaSBarry Smith } 2566947abb85SHong Zhang } 2567d8151eeaSBarry Smith 256842f2b339SBarry Smith if (ts->ops->adjointsetup) { 256942f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2570f6a906c0SBarry Smith } 2571f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 2572f6a906c0SBarry Smith PetscFunctionReturn(0); 2573f6a906c0SBarry Smith } 2574f6a906c0SBarry Smith 2575277b19d0SLisandro Dalcin /*@ 2576277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2577277b19d0SLisandro Dalcin 2578277b19d0SLisandro Dalcin Collective on TS 2579277b19d0SLisandro Dalcin 2580277b19d0SLisandro Dalcin Input Parameter: 2581277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2582277b19d0SLisandro Dalcin 2583277b19d0SLisandro Dalcin Level: beginner 2584277b19d0SLisandro Dalcin 2585277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2586277b19d0SLisandro Dalcin 2587277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2588277b19d0SLisandro Dalcin @*/ 2589277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2590277b19d0SLisandro Dalcin { 2591277b19d0SLisandro Dalcin PetscErrorCode ierr; 2592277b19d0SLisandro Dalcin 2593277b19d0SLisandro Dalcin PetscFunctionBegin; 2594277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2595b18ea86cSHong Zhang 2596277b19d0SLisandro Dalcin if (ts->ops->reset) { 2597277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2598277b19d0SLisandro Dalcin } 2599277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2600e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2601bbd56ea5SKarl Rupp 26024e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 26034e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2604214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 26056bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2606efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2607e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2608e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 260938637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2610bbd56ea5SKarl Rupp 2611947abb85SHong Zhang if (ts->vec_costintegral) { 2612d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2613d8151eeaSBarry Smith if (ts->vecs_drdp){ 2614d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2615d8151eeaSBarry Smith } 2616947abb85SHong Zhang } 2617d8151eeaSBarry Smith ts->vecs_sensi = NULL; 2618d8151eeaSBarry Smith ts->vecs_sensip = NULL; 2619ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 26202c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 262136eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2622277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2623d763cef2SBarry Smith PetscFunctionReturn(0); 2624d763cef2SBarry Smith } 2625d763cef2SBarry Smith 2626d8e5e3e6SSatish Balay /*@ 2627d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2628d763cef2SBarry Smith with TSCreate(). 2629d763cef2SBarry Smith 2630d763cef2SBarry Smith Collective on TS 2631d763cef2SBarry Smith 2632d763cef2SBarry Smith Input Parameter: 2633d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2634d763cef2SBarry Smith 2635d763cef2SBarry Smith Level: beginner 2636d763cef2SBarry Smith 2637d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2638d763cef2SBarry Smith 2639d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2640d763cef2SBarry Smith @*/ 26416bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2642d763cef2SBarry Smith { 26436849ba73SBarry Smith PetscErrorCode ierr; 2644d763cef2SBarry Smith 2645d763cef2SBarry Smith PetscFunctionBegin; 26466bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 26476bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 26486bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2649d763cef2SBarry Smith 26506bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2651277b19d0SLisandro Dalcin 2652e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2653e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 26546bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 26556d4c513bSLisandro Dalcin 2656bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2657bc952696SBarry Smith 265884df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 26596427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 26606427ac75SLisandro Dalcin 26616bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 26626bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 26636bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 26640dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 26656d4c513bSLisandro Dalcin 2666a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2667d763cef2SBarry Smith PetscFunctionReturn(0); 2668d763cef2SBarry Smith } 2669d763cef2SBarry Smith 2670d8e5e3e6SSatish Balay /*@ 2671d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2672d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2673d763cef2SBarry Smith 2674d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2675d763cef2SBarry Smith 2676d763cef2SBarry Smith Input Parameter: 2677d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2678d763cef2SBarry Smith 2679d763cef2SBarry Smith Output Parameter: 2680d763cef2SBarry Smith . snes - the nonlinear solver context 2681d763cef2SBarry Smith 2682d763cef2SBarry Smith Notes: 2683d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2684d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 268594b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2686d763cef2SBarry Smith 2687d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 26880298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2689d763cef2SBarry Smith 2690d763cef2SBarry Smith Level: beginner 2691d763cef2SBarry Smith 2692d763cef2SBarry Smith .keywords: timestep, get, SNES 2693d763cef2SBarry Smith @*/ 26947087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2695d763cef2SBarry Smith { 2696d372ba47SLisandro Dalcin PetscErrorCode ierr; 2697d372ba47SLisandro Dalcin 2698d763cef2SBarry Smith PetscFunctionBegin; 26990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27004482741eSBarry Smith PetscValidPointer(snes,2); 2701d372ba47SLisandro Dalcin if (!ts->snes) { 2702ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 27030298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27043bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2705d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2706496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 27079e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 27089e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 27099e2a6581SJed Brown } 2710d372ba47SLisandro Dalcin } 2711d763cef2SBarry Smith *snes = ts->snes; 2712d763cef2SBarry Smith PetscFunctionReturn(0); 2713d763cef2SBarry Smith } 2714d763cef2SBarry Smith 2715deb2cd25SJed Brown /*@ 2716deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2717deb2cd25SJed Brown 2718deb2cd25SJed Brown Collective 2719deb2cd25SJed Brown 2720deb2cd25SJed Brown Input Parameter: 2721deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2722deb2cd25SJed Brown - snes - the nonlinear solver context 2723deb2cd25SJed Brown 2724deb2cd25SJed Brown Notes: 2725deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2726deb2cd25SJed Brown 2727deb2cd25SJed Brown Level: developer 2728deb2cd25SJed Brown 2729deb2cd25SJed Brown .keywords: timestep, set, SNES 2730deb2cd25SJed Brown @*/ 2731deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2732deb2cd25SJed Brown { 2733deb2cd25SJed Brown PetscErrorCode ierr; 2734d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2735deb2cd25SJed Brown 2736deb2cd25SJed Brown PetscFunctionBegin; 2737deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2738deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2739deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2740deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2741bbd56ea5SKarl Rupp 2742deb2cd25SJed Brown ts->snes = snes; 2743bbd56ea5SKarl Rupp 27440298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27450298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2746740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 27470298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2748740132f1SEmil Constantinescu } 2749deb2cd25SJed Brown PetscFunctionReturn(0); 2750deb2cd25SJed Brown } 2751deb2cd25SJed Brown 2752d8e5e3e6SSatish Balay /*@ 275394b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2754d763cef2SBarry Smith a TS (timestepper) context. 2755d763cef2SBarry Smith 275694b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2757d763cef2SBarry Smith 2758d763cef2SBarry Smith Input Parameter: 2759d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2760d763cef2SBarry Smith 2761d763cef2SBarry Smith Output Parameter: 276294b7f48cSBarry Smith . ksp - the nonlinear solver context 2763d763cef2SBarry Smith 2764d763cef2SBarry Smith Notes: 276594b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2766d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2767d763cef2SBarry Smith KSP and PC contexts as well. 2768d763cef2SBarry Smith 276994b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 27700298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2771d763cef2SBarry Smith 2772d763cef2SBarry Smith Level: beginner 2773d763cef2SBarry Smith 277494b7f48cSBarry Smith .keywords: timestep, get, KSP 2775d763cef2SBarry Smith @*/ 27767087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2777d763cef2SBarry Smith { 2778d372ba47SLisandro Dalcin PetscErrorCode ierr; 2779089b2837SJed Brown SNES snes; 2780d372ba47SLisandro Dalcin 2781d763cef2SBarry Smith PetscFunctionBegin; 27820700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27834482741eSBarry Smith PetscValidPointer(ksp,2); 278417186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2785e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2786089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2787089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2788d763cef2SBarry Smith PetscFunctionReturn(0); 2789d763cef2SBarry Smith } 2790d763cef2SBarry Smith 2791d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2792d763cef2SBarry Smith 2793adb62b0dSMatthew Knepley /*@ 2794adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2795adb62b0dSMatthew Knepley maximum time for iteration. 2796adb62b0dSMatthew Knepley 27973f9fe445SBarry Smith Not Collective 2798adb62b0dSMatthew Knepley 2799adb62b0dSMatthew Knepley Input Parameters: 2800adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 28010298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 28020298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2803adb62b0dSMatthew Knepley 2804adb62b0dSMatthew Knepley Level: intermediate 2805adb62b0dSMatthew Knepley 2806adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2807adb62b0dSMatthew Knepley @*/ 28087087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2809adb62b0dSMatthew Knepley { 2810adb62b0dSMatthew Knepley PetscFunctionBegin; 28110700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2812abc0a331SBarry Smith if (maxsteps) { 28134482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2814adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2815adb62b0dSMatthew Knepley } 2816abc0a331SBarry Smith if (maxtime) { 28174482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2818adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2819adb62b0dSMatthew Knepley } 2820adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2821adb62b0dSMatthew Knepley } 2822adb62b0dSMatthew Knepley 2823d763cef2SBarry Smith /*@ 2824d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2825d763cef2SBarry Smith maximum time for iteration. 2826d763cef2SBarry Smith 28273f9fe445SBarry Smith Logically Collective on TS 2828d763cef2SBarry Smith 2829d763cef2SBarry Smith Input Parameters: 2830d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2831d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2832d763cef2SBarry Smith - maxtime - final time to iterate to 2833d763cef2SBarry Smith 2834d763cef2SBarry Smith Options Database Keys: 2835d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 28363bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2837d763cef2SBarry Smith 2838d763cef2SBarry Smith Notes: 2839d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2840d763cef2SBarry Smith 2841d763cef2SBarry Smith Level: intermediate 2842d763cef2SBarry Smith 2843d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2844a43b19c4SJed Brown 2845a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2846d763cef2SBarry Smith @*/ 28477087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2848d763cef2SBarry Smith { 2849d763cef2SBarry Smith PetscFunctionBegin; 28500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2851c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2852c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 285339b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 285439b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2855d763cef2SBarry Smith PetscFunctionReturn(0); 2856d763cef2SBarry Smith } 2857d763cef2SBarry Smith 2858d763cef2SBarry Smith /*@ 2859d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2860d763cef2SBarry Smith for use by the TS routines. 2861d763cef2SBarry Smith 28623f9fe445SBarry Smith Logically Collective on TS and Vec 2863d763cef2SBarry Smith 2864d763cef2SBarry Smith Input Parameters: 2865d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 28660910c330SBarry Smith - u - the solution vector 2867d763cef2SBarry Smith 2868d763cef2SBarry Smith Level: beginner 2869d763cef2SBarry Smith 2870d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2871d763cef2SBarry Smith @*/ 28720910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2873d763cef2SBarry Smith { 28748737fe31SLisandro Dalcin PetscErrorCode ierr; 2875496e6a7aSJed Brown DM dm; 28768737fe31SLisandro Dalcin 2877d763cef2SBarry Smith PetscFunctionBegin; 28780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28790910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 28800910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 28816bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 28820910c330SBarry Smith ts->vec_sol = u; 2883bbd56ea5SKarl Rupp 2884496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 28850910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2886d763cef2SBarry Smith PetscFunctionReturn(0); 2887d763cef2SBarry Smith } 2888d763cef2SBarry Smith 288973b18844SBarry Smith /*@ 289073b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 289173b18844SBarry Smith 289273b18844SBarry Smith Logically Collective on TS 289373b18844SBarry Smith 289473b18844SBarry Smith Input Parameters: 289573b18844SBarry Smith + ts - the TS context obtained from TSCreate() 289673b18844SBarry Smith . steps - number of steps to use 289773b18844SBarry Smith 289873b18844SBarry Smith Level: intermediate 289973b18844SBarry Smith 290073b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 290173b18844SBarry Smith so as to integrate back to less than the original timestep 290273b18844SBarry Smith 290373b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 290473b18844SBarry Smith 290573b18844SBarry Smith .seealso: TSSetExactFinalTime() 290673b18844SBarry Smith @*/ 290773b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 290873b18844SBarry Smith { 290973b18844SBarry Smith PetscFunctionBegin; 291073b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 291173b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 291273b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 291373b18844SBarry Smith if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps"); 291473b18844SBarry Smith ts->adjoint_max_steps = steps; 291573b18844SBarry Smith PetscFunctionReturn(0); 291673b18844SBarry Smith } 291773b18844SBarry Smith 2918c235aa8dSHong Zhang /*@ 2919dfb21088SHong Zhang TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters 29200cf82b59SBarry Smith for use by the TSAdjoint routines. 2921c235aa8dSHong Zhang 2922c235aa8dSHong Zhang Logically Collective on TS and Vec 2923c235aa8dSHong Zhang 2924c235aa8dSHong Zhang Input Parameters: 2925c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2926abc2977eSBarry Smith . lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector 2927abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2928c235aa8dSHong Zhang 2929c235aa8dSHong Zhang Level: beginner 2930c235aa8dSHong Zhang 2931abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 29320cf82b59SBarry Smith 2933c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2934c235aa8dSHong Zhang @*/ 2935dfb21088SHong Zhang PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2936c235aa8dSHong Zhang { 2937c235aa8dSHong Zhang PetscFunctionBegin; 2938c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2939abc2977eSBarry Smith PetscValidPointer(lambda,2); 2940abc2977eSBarry Smith ts->vecs_sensi = lambda; 2941abc2977eSBarry Smith ts->vecs_sensip = mu; 2942dfb21088SHong Zhang if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand"); 2943abc2977eSBarry Smith ts->numcost = numcost; 2944ad8e2604SHong Zhang PetscFunctionReturn(0); 2945ad8e2604SHong Zhang } 2946ad8e2604SHong Zhang 2947ad8e2604SHong Zhang /*@C 29480cf82b59SBarry Smith TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix. 2949ad8e2604SHong Zhang 2950ad8e2604SHong Zhang Logically Collective on TS 2951ad8e2604SHong Zhang 2952ad8e2604SHong Zhang Input Parameters: 2953ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2954ad8e2604SHong Zhang - func - The function 2955ad8e2604SHong Zhang 2956ad8e2604SHong Zhang Calling sequence of func: 29570cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 295805755b9cSHong Zhang + t - current timestep 29590cf82b59SBarry Smith . y - input vector (current ODE solution) 296005755b9cSHong Zhang . A - output matrix 296105755b9cSHong Zhang - ctx - [optional] user-defined function context 2962ad8e2604SHong Zhang 2963ad8e2604SHong Zhang Level: intermediate 2964ad8e2604SHong Zhang 29650cf82b59SBarry Smith Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p 29660cf82b59SBarry Smith 2967ad8e2604SHong Zhang .keywords: TS, sensitivity 2968ad8e2604SHong Zhang .seealso: 2969ad8e2604SHong Zhang @*/ 29705bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2971ad8e2604SHong Zhang { 2972ad8e2604SHong Zhang PetscErrorCode ierr; 2973ad8e2604SHong Zhang 2974ad8e2604SHong Zhang PetscFunctionBegin; 2975ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2976ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2977ad8e2604SHong Zhang 2978ad8e2604SHong Zhang ts->rhsjacobianp = func; 2979ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 2980ad8e2604SHong Zhang if(Amat) { 2981ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 2982ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2983ad8e2604SHong Zhang ts->Jacp = Amat; 2984ad8e2604SHong Zhang } 2985ad8e2604SHong Zhang PetscFunctionReturn(0); 2986ad8e2604SHong Zhang } 2987ad8e2604SHong Zhang 29880cf82b59SBarry Smith /*@C 29895bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 2990ad8e2604SHong Zhang 2991ad8e2604SHong Zhang Collective on TS 2992ad8e2604SHong Zhang 2993ad8e2604SHong Zhang Input Parameters: 2994ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 2995ad8e2604SHong Zhang 2996ad8e2604SHong Zhang Level: developer 2997ad8e2604SHong Zhang 2998ad8e2604SHong Zhang .keywords: TS, sensitivity 29995bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 3000ad8e2604SHong Zhang @*/ 30015bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 3002ad8e2604SHong Zhang { 3003ad8e2604SHong Zhang PetscErrorCode ierr; 3004ad8e2604SHong Zhang 3005ad8e2604SHong Zhang PetscFunctionBegin; 3006ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3007ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3008ad8e2604SHong Zhang PetscValidPointer(Amat,4); 3009ad8e2604SHong Zhang 3010ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 3011ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 3012ad8e2604SHong Zhang PetscStackPop; 3013c235aa8dSHong Zhang PetscFunctionReturn(0); 3014c235aa8dSHong Zhang } 3015c235aa8dSHong Zhang 30166fd0887fSHong Zhang /*@C 3017dfb21088SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 30186fd0887fSHong Zhang 30196fd0887fSHong Zhang Logically Collective on TS 30206fd0887fSHong Zhang 30216fd0887fSHong Zhang Input Parameters: 30226fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 3023abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 30240cf82b59SBarry Smith . rf - routine for evaluating the integrand function 3025b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 3026b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 3027feaa1ddbSSatish Balay . fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run 3028b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 30296fd0887fSHong Zhang 30300cf82b59SBarry Smith Calling sequence of rf: 30310cf82b59SBarry Smith $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 30326fd0887fSHong Zhang 30336fd0887fSHong Zhang + t - current timestep 30340cf82b59SBarry Smith . y - input vector 30350cf82b59SBarry Smith . f - function result; one vector entry for each cost function 30366fd0887fSHong Zhang - ctx - [optional] user-defined function context 30376fd0887fSHong Zhang 3038b612ec54SBarry Smith Calling sequence of drdyf: 30390cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 3040b612ec54SBarry Smith 3041b612ec54SBarry Smith Calling sequence of drdpf: 30420cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 3043b612ec54SBarry Smith 3044b612ec54SBarry Smith Level: intermediate 30456fd0887fSHong Zhang 3046abc2977eSBarry Smith Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 30470cf82b59SBarry Smith 30486fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 30496fd0887fSHong Zhang 3050dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 30516fd0887fSHong Zhang @*/ 3052dfb21088SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 3053d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 3054b1cb36f3SHong Zhang PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 3055b1cb36f3SHong Zhang PetscBool fwd,void *ctx) 30566fd0887fSHong Zhang { 30576fd0887fSHong Zhang PetscErrorCode ierr; 30586fd0887fSHong Zhang 30596fd0887fSHong Zhang PetscFunctionBegin; 30606fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3061dfb21088SHong Zhang if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()"); 3062c72ed514SHong Zhang if (!ts->numcost) ts->numcost=numcost; 30636fd0887fSHong Zhang 3064b1cb36f3SHong Zhang ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 3065abc2977eSBarry Smith ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 30662c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 30670cf82b59SBarry Smith ts->costintegrand = rf; 306805755b9cSHong Zhang ts->costintegrandctx = ctx; 3069b612ec54SBarry Smith ts->drdyfunction = drdyf; 3070b612ec54SBarry Smith ts->drdpfunction = drdpf; 30716fd0887fSHong Zhang PetscFunctionReturn(0); 30726fd0887fSHong Zhang } 30736fd0887fSHong Zhang 307436eaed60SHong Zhang /*@ 3075dfb21088SHong Zhang TSGetCostIntegral - Returns the values of the integral term in the cost functions. 307636eaed60SHong Zhang It is valid to call the routine after a backward run. 307736eaed60SHong Zhang 307836eaed60SHong Zhang Not Collective 307936eaed60SHong Zhang 308036eaed60SHong Zhang Input Parameter: 308136eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 308236eaed60SHong Zhang 308336eaed60SHong Zhang Output Parameter: 30842c39e106SBarry Smith . v - the vector containing the integrals for each cost function 308536eaed60SHong Zhang 308636eaed60SHong Zhang Level: intermediate 308736eaed60SHong Zhang 3088dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 308936eaed60SHong Zhang 309036eaed60SHong Zhang .keywords: TS, sensitivity analysis 309136eaed60SHong Zhang @*/ 3092dfb21088SHong Zhang PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 309336eaed60SHong Zhang { 309436eaed60SHong Zhang PetscFunctionBegin; 309536eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 309636eaed60SHong Zhang PetscValidPointer(v,2); 30972c39e106SBarry Smith *v = ts->vec_costintegral; 309836eaed60SHong Zhang PetscFunctionReturn(0); 309936eaed60SHong Zhang } 310036eaed60SHong Zhang 31016fd0887fSHong Zhang /*@ 31022c39e106SBarry Smith TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 31036fd0887fSHong Zhang 31046fd0887fSHong Zhang Input Parameters: 31056fd0887fSHong Zhang + ts - the TS context 31066fd0887fSHong Zhang . t - current time 31070cf82b59SBarry Smith - y - state vector, i.e. current solution 31086fd0887fSHong Zhang 31096fd0887fSHong Zhang Output Parameter: 3110abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 31116fd0887fSHong Zhang 31126fd0887fSHong Zhang Note: 31136fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 31146fd0887fSHong Zhang is used internally within the sensitivity analysis context. 31156fd0887fSHong Zhang 31166fd0887fSHong Zhang Level: developer 31176fd0887fSHong Zhang 31186fd0887fSHong Zhang .keywords: TS, compute 31196fd0887fSHong Zhang 3120dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 31216fd0887fSHong Zhang @*/ 31220cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 31236fd0887fSHong Zhang { 31246fd0887fSHong Zhang PetscErrorCode ierr; 31256fd0887fSHong Zhang 31266fd0887fSHong Zhang PetscFunctionBegin; 31276fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31280cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 31296fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 31306fd0887fSHong Zhang 31310cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3132e4680132SHong Zhang if (ts->costintegrand) { 3133e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 31340cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 31356fd0887fSHong Zhang PetscStackPop; 31366fd0887fSHong Zhang } else { 31376fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 31386fd0887fSHong Zhang } 31396fd0887fSHong Zhang 31400cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 31416fd0887fSHong Zhang PetscFunctionReturn(0); 31426fd0887fSHong Zhang } 31436fd0887fSHong Zhang 314405755b9cSHong Zhang /*@ 3145d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 314605755b9cSHong Zhang 314705755b9cSHong Zhang Collective on TS 314805755b9cSHong Zhang 314905755b9cSHong Zhang Input Parameters: 315005755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 315105755b9cSHong Zhang 315205755b9cSHong Zhang Notes: 3153d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 315405755b9cSHong Zhang so most users would not generally call this routine themselves. 315505755b9cSHong Zhang 315605755b9cSHong Zhang Level: developer 315705755b9cSHong Zhang 315805755b9cSHong Zhang .keywords: TS, sensitivity 3159d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 316005755b9cSHong Zhang @*/ 31610cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 316205755b9cSHong Zhang { 316305755b9cSHong Zhang PetscErrorCode ierr; 316405755b9cSHong Zhang 316505755b9cSHong Zhang PetscFunctionBegin; 316605755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31670cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 316805755b9cSHong Zhang 316905755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 31700cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 317105755b9cSHong Zhang PetscStackPop; 317205755b9cSHong Zhang PetscFunctionReturn(0); 317305755b9cSHong Zhang } 317405755b9cSHong Zhang 317505755b9cSHong Zhang /*@ 3176d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 317705755b9cSHong Zhang 317805755b9cSHong Zhang Collective on TS 317905755b9cSHong Zhang 318005755b9cSHong Zhang Input Parameters: 318105755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 318205755b9cSHong Zhang 318305755b9cSHong Zhang Notes: 318405755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 318505755b9cSHong Zhang so most users would not generally call this routine themselves. 318605755b9cSHong Zhang 318705755b9cSHong Zhang Level: developer 318805755b9cSHong Zhang 318905755b9cSHong Zhang .keywords: TS, sensitivity 3190d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 319105755b9cSHong Zhang @*/ 31920cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 319305755b9cSHong Zhang { 319405755b9cSHong Zhang PetscErrorCode ierr; 319505755b9cSHong Zhang 319605755b9cSHong Zhang PetscFunctionBegin; 319705755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31980cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 319905755b9cSHong Zhang 320005755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 32010cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 320205755b9cSHong Zhang PetscStackPop; 320305755b9cSHong Zhang PetscFunctionReturn(0); 320405755b9cSHong Zhang } 320505755b9cSHong Zhang 3206ac226902SBarry Smith /*@C 3207000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 32083f2090d5SJed Brown called once at the beginning of each time step. 3209000e7ae3SMatthew Knepley 32103f9fe445SBarry Smith Logically Collective on TS 3211000e7ae3SMatthew Knepley 3212000e7ae3SMatthew Knepley Input Parameters: 3213000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3214000e7ae3SMatthew Knepley - func - The function 3215000e7ae3SMatthew Knepley 3216000e7ae3SMatthew Knepley Calling sequence of func: 3217000e7ae3SMatthew Knepley . func (TS ts); 3218000e7ae3SMatthew Knepley 3219000e7ae3SMatthew Knepley Level: intermediate 3220000e7ae3SMatthew Knepley 3221000e7ae3SMatthew Knepley .keywords: TS, timestep 32229be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3223000e7ae3SMatthew Knepley @*/ 32247087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3225000e7ae3SMatthew Knepley { 3226000e7ae3SMatthew Knepley PetscFunctionBegin; 32270700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3228ae60f76fSBarry Smith ts->prestep = func; 3229000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3230000e7ae3SMatthew Knepley } 3231000e7ae3SMatthew Knepley 323209ee8438SJed Brown /*@ 32333f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 32343f2090d5SJed Brown 32353f2090d5SJed Brown Collective on TS 32363f2090d5SJed Brown 32373f2090d5SJed Brown Input Parameters: 32383f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 32393f2090d5SJed Brown 32403f2090d5SJed Brown Notes: 32413f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 32423f2090d5SJed Brown so most users would not generally call this routine themselves. 32433f2090d5SJed Brown 32443f2090d5SJed Brown Level: developer 32453f2090d5SJed Brown 32463f2090d5SJed Brown .keywords: TS, timestep 32479be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 32483f2090d5SJed Brown @*/ 32497087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 32503f2090d5SJed Brown { 32513f2090d5SJed Brown PetscErrorCode ierr; 32523f2090d5SJed Brown 32533f2090d5SJed Brown PetscFunctionBegin; 32540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3255ae60f76fSBarry Smith if (ts->prestep) { 3256ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 3257312ce896SJed Brown } 32583f2090d5SJed Brown PetscFunctionReturn(0); 32593f2090d5SJed Brown } 32603f2090d5SJed Brown 3261b8123daeSJed Brown /*@C 3262b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3263b8123daeSJed Brown called once at the beginning of each stage. 3264b8123daeSJed Brown 3265b8123daeSJed Brown Logically Collective on TS 3266b8123daeSJed Brown 3267b8123daeSJed Brown Input Parameters: 3268b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3269b8123daeSJed Brown - func - The function 3270b8123daeSJed Brown 3271b8123daeSJed Brown Calling sequence of func: 3272b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3273b8123daeSJed Brown 3274b8123daeSJed Brown Level: intermediate 3275b8123daeSJed Brown 3276b8123daeSJed Brown Note: 3277b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3278b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3279b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3280b8123daeSJed Brown 3281b8123daeSJed Brown .keywords: TS, timestep 32829be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3283b8123daeSJed Brown @*/ 3284b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3285b8123daeSJed Brown { 3286b8123daeSJed Brown PetscFunctionBegin; 3287b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3288ae60f76fSBarry Smith ts->prestage = func; 3289b8123daeSJed Brown PetscFunctionReturn(0); 3290b8123daeSJed Brown } 3291b8123daeSJed Brown 32929be3e283SDebojyoti Ghosh /*@C 32939be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 32949be3e283SDebojyoti Ghosh called once at the end of each stage. 32959be3e283SDebojyoti Ghosh 32969be3e283SDebojyoti Ghosh Logically Collective on TS 32979be3e283SDebojyoti Ghosh 32989be3e283SDebojyoti Ghosh Input Parameters: 32999be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 33009be3e283SDebojyoti Ghosh - func - The function 33019be3e283SDebojyoti Ghosh 33029be3e283SDebojyoti Ghosh Calling sequence of func: 33039be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 33049be3e283SDebojyoti Ghosh 33059be3e283SDebojyoti Ghosh Level: intermediate 33069be3e283SDebojyoti Ghosh 33079be3e283SDebojyoti Ghosh Note: 33089be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 33099be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 33109be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 33119be3e283SDebojyoti Ghosh 33129be3e283SDebojyoti Ghosh .keywords: TS, timestep 33139be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 33149be3e283SDebojyoti Ghosh @*/ 33159be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 33169be3e283SDebojyoti Ghosh { 33179be3e283SDebojyoti Ghosh PetscFunctionBegin; 33189be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 33199be3e283SDebojyoti Ghosh ts->poststage = func; 33209be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33219be3e283SDebojyoti Ghosh } 33229be3e283SDebojyoti Ghosh 3323c688d042SShri Abhyankar /*@C 3324c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3325c688d042SShri Abhyankar called once at the end of each step evaluation. 3326c688d042SShri Abhyankar 3327c688d042SShri Abhyankar Logically Collective on TS 3328c688d042SShri Abhyankar 3329c688d042SShri Abhyankar Input Parameters: 3330c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3331c688d042SShri Abhyankar - func - The function 3332c688d042SShri Abhyankar 3333c688d042SShri Abhyankar Calling sequence of func: 3334c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3335c688d042SShri Abhyankar 3336c688d042SShri Abhyankar Level: intermediate 3337c688d042SShri Abhyankar 3338c688d042SShri Abhyankar Note: 33391785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 33401785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3341e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3342e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3343e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3344c688d042SShri Abhyankar 3345c688d042SShri Abhyankar .keywords: TS, timestep 3346c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3347c688d042SShri Abhyankar @*/ 3348c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3349c688d042SShri Abhyankar { 3350c688d042SShri Abhyankar PetscFunctionBegin; 3351c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3352c688d042SShri Abhyankar ts->postevaluate = func; 3353c688d042SShri Abhyankar PetscFunctionReturn(0); 3354c688d042SShri Abhyankar } 3355c688d042SShri Abhyankar 3356b8123daeSJed Brown /*@ 3357b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3358b8123daeSJed Brown 3359b8123daeSJed Brown Collective on TS 3360b8123daeSJed Brown 3361b8123daeSJed Brown Input Parameters: 3362b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 33639be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3364b8123daeSJed Brown 3365b8123daeSJed Brown Notes: 3366b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3367b8123daeSJed Brown most users would not generally call this routine themselves. 3368b8123daeSJed Brown 3369b8123daeSJed Brown Level: developer 3370b8123daeSJed Brown 3371b8123daeSJed Brown .keywords: TS, timestep 33729be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3373b8123daeSJed Brown @*/ 3374b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3375b8123daeSJed Brown { 3376b8123daeSJed Brown PetscErrorCode ierr; 3377b8123daeSJed Brown 3378b8123daeSJed Brown PetscFunctionBegin; 3379b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3380ae60f76fSBarry Smith if (ts->prestage) { 3381ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3382b8123daeSJed Brown } 3383b8123daeSJed Brown PetscFunctionReturn(0); 3384b8123daeSJed Brown } 3385b8123daeSJed Brown 33869be3e283SDebojyoti Ghosh /*@ 33879be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 33889be3e283SDebojyoti Ghosh 33899be3e283SDebojyoti Ghosh Collective on TS 33909be3e283SDebojyoti Ghosh 33919be3e283SDebojyoti Ghosh Input Parameters: 33929be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 33939be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 33949be3e283SDebojyoti Ghosh stageindex - Stage number 33959be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 33969be3e283SDebojyoti Ghosh of stages) with the stage solutions 33979be3e283SDebojyoti Ghosh 33989be3e283SDebojyoti Ghosh Notes: 33999be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 34009be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 34019be3e283SDebojyoti Ghosh 34029be3e283SDebojyoti Ghosh Level: developer 34039be3e283SDebojyoti Ghosh 34049be3e283SDebojyoti Ghosh .keywords: TS, timestep 34059be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 34069be3e283SDebojyoti Ghosh @*/ 34079be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 34089be3e283SDebojyoti Ghosh { 34099be3e283SDebojyoti Ghosh PetscErrorCode ierr; 34109be3e283SDebojyoti Ghosh 34119be3e283SDebojyoti Ghosh PetscFunctionBegin; 34129be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34134beae5d8SLisandro Dalcin if (ts->poststage) { 34149be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 34159be3e283SDebojyoti Ghosh } 34169be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 34179be3e283SDebojyoti Ghosh } 34189be3e283SDebojyoti Ghosh 3419c688d042SShri Abhyankar /*@ 3420c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3421c688d042SShri Abhyankar 3422c688d042SShri Abhyankar Collective on TS 3423c688d042SShri Abhyankar 3424c688d042SShri Abhyankar Input Parameters: 3425c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3426c688d042SShri Abhyankar 3427c688d042SShri Abhyankar Notes: 3428c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3429c688d042SShri Abhyankar most users would not generally call this routine themselves. 3430c688d042SShri Abhyankar 3431c688d042SShri Abhyankar Level: developer 3432c688d042SShri Abhyankar 3433c688d042SShri Abhyankar .keywords: TS, timestep 3434c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3435c688d042SShri Abhyankar @*/ 3436c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3437c688d042SShri Abhyankar { 3438c688d042SShri Abhyankar PetscErrorCode ierr; 3439c688d042SShri Abhyankar 3440c688d042SShri Abhyankar PetscFunctionBegin; 3441c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3442c688d042SShri Abhyankar if (ts->postevaluate) { 3443c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3444c688d042SShri Abhyankar } 3445c688d042SShri Abhyankar PetscFunctionReturn(0); 3446c688d042SShri Abhyankar } 3447c688d042SShri Abhyankar 3448ac226902SBarry Smith /*@C 3449000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 34503f2090d5SJed Brown called once at the end of each time step. 3451000e7ae3SMatthew Knepley 34523f9fe445SBarry Smith Logically Collective on TS 3453000e7ae3SMatthew Knepley 3454000e7ae3SMatthew Knepley Input Parameters: 3455000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3456000e7ae3SMatthew Knepley - func - The function 3457000e7ae3SMatthew Knepley 3458000e7ae3SMatthew Knepley Calling sequence of func: 3459b8123daeSJed Brown $ func (TS ts); 3460000e7ae3SMatthew Knepley 34611785ff2aSShri Abhyankar Notes: 34621785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 34631785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 34641785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 34651785ff2aSShri Abhyankar 3466000e7ae3SMatthew Knepley Level: intermediate 3467000e7ae3SMatthew Knepley 3468000e7ae3SMatthew Knepley .keywords: TS, timestep 34691785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 3470000e7ae3SMatthew Knepley @*/ 34717087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3472000e7ae3SMatthew Knepley { 3473000e7ae3SMatthew Knepley PetscFunctionBegin; 34740700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3475ae60f76fSBarry Smith ts->poststep = func; 3476000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3477000e7ae3SMatthew Knepley } 3478000e7ae3SMatthew Knepley 347909ee8438SJed Brown /*@ 34803f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 34813f2090d5SJed Brown 34823f2090d5SJed Brown Collective on TS 34833f2090d5SJed Brown 34843f2090d5SJed Brown Input Parameters: 34853f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 34863f2090d5SJed Brown 34873f2090d5SJed Brown Notes: 34883f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 34893f2090d5SJed Brown so most users would not generally call this routine themselves. 34903f2090d5SJed Brown 34913f2090d5SJed Brown Level: developer 34923f2090d5SJed Brown 34933f2090d5SJed Brown .keywords: TS, timestep 34943f2090d5SJed Brown @*/ 34957087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 34963f2090d5SJed Brown { 34973f2090d5SJed Brown PetscErrorCode ierr; 34983f2090d5SJed Brown 34993f2090d5SJed Brown PetscFunctionBegin; 35000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3501ae60f76fSBarry Smith if (ts->poststep) { 3502ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 350372ac3e02SJed Brown } 35043f2090d5SJed Brown PetscFunctionReturn(0); 35053f2090d5SJed Brown } 35063f2090d5SJed Brown 3507d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3508d763cef2SBarry Smith 3509d763cef2SBarry Smith /*@C 3510a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3511d763cef2SBarry Smith timestep to display the iteration's progress. 3512d763cef2SBarry Smith 35133f9fe445SBarry Smith Logically Collective on TS 3514d763cef2SBarry Smith 3515d763cef2SBarry Smith Input Parameters: 3516d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3517e213d8f1SJed Brown . monitor - monitoring routine 3518329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 35190298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3520b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 35210298fd71SBarry Smith (may be NULL) 3522d763cef2SBarry Smith 3523e213d8f1SJed Brown Calling sequence of monitor: 35240910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3525d763cef2SBarry Smith 3526d763cef2SBarry Smith + ts - the TS context 352763e21af5SBarry Smith . steps - iteration number (after the final time step the monitor routine may be called with a step of -1, this indicates the solution has been interpolated to this time) 35281f06c33eSBarry Smith . time - current time 35290910c330SBarry Smith . u - current iterate 3530d763cef2SBarry Smith - mctx - [optional] monitoring context 3531d763cef2SBarry Smith 3532d763cef2SBarry Smith Notes: 3533d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3534d763cef2SBarry Smith already has been loaded. 3535d763cef2SBarry Smith 3536025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 3537025f1a04SBarry Smith 3538d763cef2SBarry Smith Level: intermediate 3539d763cef2SBarry Smith 3540d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3541d763cef2SBarry Smith 3542a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3543d763cef2SBarry Smith @*/ 3544c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3545d763cef2SBarry Smith { 354678064530SBarry Smith PetscErrorCode ierr; 354778064530SBarry Smith PetscInt i; 354878064530SBarry Smith PetscBool identical; 354978064530SBarry Smith 3550d763cef2SBarry Smith PetscFunctionBegin; 35510700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 355278064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 355378064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 355478064530SBarry Smith if (identical) PetscFunctionReturn(0); 355578064530SBarry Smith } 355617186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3557d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 35588704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3559d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3560d763cef2SBarry Smith PetscFunctionReturn(0); 3561d763cef2SBarry Smith } 3562d763cef2SBarry Smith 3563d763cef2SBarry Smith /*@C 3564a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3565d763cef2SBarry Smith 35663f9fe445SBarry Smith Logically Collective on TS 3567d763cef2SBarry Smith 3568d763cef2SBarry Smith Input Parameters: 3569d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3570d763cef2SBarry Smith 3571d763cef2SBarry Smith Notes: 3572d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3573d763cef2SBarry Smith 3574d763cef2SBarry Smith Level: intermediate 3575d763cef2SBarry Smith 3576d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3577d763cef2SBarry Smith 3578a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3579d763cef2SBarry Smith @*/ 35807087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3581d763cef2SBarry Smith { 3582d952e501SBarry Smith PetscErrorCode ierr; 3583d952e501SBarry Smith PetscInt i; 3584d952e501SBarry Smith 3585d763cef2SBarry Smith PetscFunctionBegin; 35860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3587d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 35888704b422SBarry Smith if (ts->monitordestroy[i]) { 35898704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3590d952e501SBarry Smith } 3591d952e501SBarry Smith } 3592d763cef2SBarry Smith ts->numbermonitors = 0; 3593d763cef2SBarry Smith PetscFunctionReturn(0); 3594d763cef2SBarry Smith } 3595d763cef2SBarry Smith 3596721cd6eeSBarry Smith /*@C 3597721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 35985516499fSSatish Balay 35995516499fSSatish Balay Level: intermediate 360041251cbbSSatish Balay 36015516499fSSatish Balay .keywords: TS, set, monitor 36025516499fSSatish Balay 360363e21af5SBarry Smith .seealso: TSMonitorSet() 360441251cbbSSatish Balay @*/ 3605721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3606d763cef2SBarry Smith { 3607dfbe8321SBarry Smith PetscErrorCode ierr; 3608721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 360941aca3d6SBarry Smith PetscBool iascii,ibinary; 3610d132466eSBarry Smith 3611d763cef2SBarry Smith PetscFunctionBegin; 36124d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 361341aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 361441aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3615721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 361641aca3d6SBarry Smith if (iascii) { 3617649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 361863e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 361963e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 362063e21af5SBarry Smith } else { 36218392e04aSShri Abhyankar ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 362263e21af5SBarry Smith } 3623649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 362441aca3d6SBarry Smith } else if (ibinary) { 362541aca3d6SBarry Smith PetscMPIInt rank; 362641aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 362741aca3d6SBarry Smith if (!rank) { 3628450a797fSBarry Smith PetscBool skipHeader; 3629450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3630450a797fSBarry Smith 3631450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3632450a797fSBarry Smith if (!skipHeader) { 3633450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3634450a797fSBarry Smith } 363541aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 363641aca3d6SBarry Smith } else { 363741aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 363841aca3d6SBarry Smith } 363941aca3d6SBarry Smith } 3640721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3641d763cef2SBarry Smith PetscFunctionReturn(0); 3642d763cef2SBarry Smith } 3643d763cef2SBarry Smith 36449110b2e7SHong Zhang /*@C 36459110b2e7SHong Zhang TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 36469110b2e7SHong Zhang timestep to display the iteration's progress. 36479110b2e7SHong Zhang 36489110b2e7SHong Zhang Logically Collective on TS 36499110b2e7SHong Zhang 36509110b2e7SHong Zhang Input Parameters: 36519110b2e7SHong Zhang + ts - the TS context obtained from TSCreate() 36529110b2e7SHong Zhang . adjointmonitor - monitoring routine 36539110b2e7SHong Zhang . adjointmctx - [optional] user-defined context for private data for the 36549110b2e7SHong Zhang monitor routine (use NULL if no context is desired) 36559110b2e7SHong Zhang - adjointmonitordestroy - [optional] routine that frees monitor context 36569110b2e7SHong Zhang (may be NULL) 36579110b2e7SHong Zhang 36589110b2e7SHong Zhang Calling sequence of monitor: 36599110b2e7SHong Zhang $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 36609110b2e7SHong Zhang 36619110b2e7SHong Zhang + ts - the TS context 36629110b2e7SHong Zhang . steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have 36639110b2e7SHong Zhang been interpolated to) 36649110b2e7SHong Zhang . time - current time 36659110b2e7SHong Zhang . u - current iterate 36669110b2e7SHong Zhang . numcost - number of cost functionos 36679110b2e7SHong Zhang . lambda - sensitivities to initial conditions 36689110b2e7SHong Zhang . mu - sensitivities to parameters 36699110b2e7SHong Zhang - adjointmctx - [optional] adjoint monitoring context 36709110b2e7SHong Zhang 36719110b2e7SHong Zhang Notes: 36729110b2e7SHong Zhang This routine adds an additional monitor to the list of monitors that 36739110b2e7SHong Zhang already has been loaded. 36749110b2e7SHong Zhang 36759110b2e7SHong Zhang Fortran notes: Only a single monitor function can be set for each TS object 36769110b2e7SHong Zhang 36779110b2e7SHong Zhang Level: intermediate 36789110b2e7SHong Zhang 36799110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 36809110b2e7SHong Zhang 36819110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel() 36829110b2e7SHong Zhang @*/ 36839110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 36849110b2e7SHong Zhang { 368578064530SBarry Smith PetscErrorCode ierr; 368678064530SBarry Smith PetscInt i; 368778064530SBarry Smith PetscBool identical; 368878064530SBarry Smith 36899110b2e7SHong Zhang PetscFunctionBegin; 36909110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 369178064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 369278064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 369378064530SBarry Smith if (identical) PetscFunctionReturn(0); 369478064530SBarry Smith } 36959110b2e7SHong Zhang if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 36969110b2e7SHong Zhang ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 36979110b2e7SHong Zhang ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 36989110b2e7SHong Zhang ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 36999110b2e7SHong Zhang PetscFunctionReturn(0); 37009110b2e7SHong Zhang } 37019110b2e7SHong Zhang 37029110b2e7SHong Zhang /*@C 37039110b2e7SHong Zhang TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 37049110b2e7SHong Zhang 37059110b2e7SHong Zhang Logically Collective on TS 37069110b2e7SHong Zhang 37079110b2e7SHong Zhang Input Parameters: 37089110b2e7SHong Zhang . ts - the TS context obtained from TSCreate() 37099110b2e7SHong Zhang 37109110b2e7SHong Zhang Notes: 37119110b2e7SHong Zhang There is no way to remove a single, specific monitor. 37129110b2e7SHong Zhang 37139110b2e7SHong Zhang Level: intermediate 37149110b2e7SHong Zhang 37159110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 37169110b2e7SHong Zhang 37179110b2e7SHong Zhang .seealso: TSAdjointMonitorSet() 37189110b2e7SHong Zhang @*/ 37199110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorCancel(TS ts) 37209110b2e7SHong Zhang { 37219110b2e7SHong Zhang PetscErrorCode ierr; 37229110b2e7SHong Zhang PetscInt i; 37239110b2e7SHong Zhang 37249110b2e7SHong Zhang PetscFunctionBegin; 37259110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37269110b2e7SHong Zhang for (i=0; i<ts->numberadjointmonitors; i++) { 37279110b2e7SHong Zhang if (ts->adjointmonitordestroy[i]) { 37289110b2e7SHong Zhang ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 37299110b2e7SHong Zhang } 37309110b2e7SHong Zhang } 37319110b2e7SHong Zhang ts->numberadjointmonitors = 0; 37329110b2e7SHong Zhang PetscFunctionReturn(0); 37339110b2e7SHong Zhang } 37349110b2e7SHong Zhang 3735721cd6eeSBarry Smith /*@C 3736721cd6eeSBarry Smith TSAdjointMonitorDefault - the default monitor of adjoint computations 3737110eb670SHong Zhang 3738110eb670SHong Zhang Level: intermediate 3739110eb670SHong Zhang 3740110eb670SHong Zhang .keywords: TS, set, monitor 3741110eb670SHong Zhang 3742110eb670SHong Zhang .seealso: TSAdjointMonitorSet() 3743110eb670SHong Zhang @*/ 3744721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3745110eb670SHong Zhang { 3746110eb670SHong Zhang PetscErrorCode ierr; 3747721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 3748110eb670SHong Zhang 3749110eb670SHong Zhang PetscFunctionBegin; 3750110eb670SHong Zhang PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3751721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3752110eb670SHong Zhang ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3753110eb670SHong Zhang ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr); 3754110eb670SHong Zhang ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3755721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3756110eb670SHong Zhang PetscFunctionReturn(0); 3757110eb670SHong Zhang } 3758110eb670SHong Zhang 3759cd652676SJed Brown /*@ 3760cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3761cd652676SJed Brown 3762cd652676SJed Brown Collective on TS 3763cd652676SJed Brown 3764cd652676SJed Brown Input Argument: 3765cd652676SJed Brown + ts - time stepping context 3766cd652676SJed Brown - t - time to interpolate to 3767cd652676SJed Brown 3768cd652676SJed Brown Output Argument: 37690910c330SBarry Smith . U - state at given time 3770cd652676SJed Brown 3771cd652676SJed Brown Level: intermediate 3772cd652676SJed Brown 3773cd652676SJed Brown Developer Notes: 3774cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3775cd652676SJed Brown 3776cd652676SJed Brown .keywords: TS, set 3777cd652676SJed Brown 3778874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3779cd652676SJed Brown @*/ 37800910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3781cd652676SJed Brown { 3782cd652676SJed Brown PetscErrorCode ierr; 3783cd652676SJed Brown 3784cd652676SJed Brown PetscFunctionBegin; 3785cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3786b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3787be5899b3SLisandro Dalcin if (t < ts->ptime_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_prev,(double)ts->ptime); 3788ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 37890910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3790cd652676SJed Brown PetscFunctionReturn(0); 3791cd652676SJed Brown } 3792cd652676SJed Brown 3793d763cef2SBarry Smith /*@ 37946d9e5789SSean Farley TSStep - Steps one time step 3795d763cef2SBarry Smith 3796d763cef2SBarry Smith Collective on TS 3797d763cef2SBarry Smith 3798d763cef2SBarry Smith Input Parameter: 3799d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3800d763cef2SBarry Smith 380127829d71SBarry Smith Level: developer 3802d763cef2SBarry Smith 3803b8123daeSJed Brown Notes: 380427829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 380527829d71SBarry Smith 3806b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3807b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3808b8123daeSJed Brown 380925cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 381025cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 381125cb2221SBarry Smith 3812d763cef2SBarry Smith .keywords: TS, timestep, solve 3813d763cef2SBarry Smith 38149be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3815d763cef2SBarry Smith @*/ 3816193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3817d763cef2SBarry Smith { 3818dfbe8321SBarry Smith PetscErrorCode ierr; 3819fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3820be5899b3SLisandro Dalcin PetscReal ptime; 3821d763cef2SBarry Smith 3822d763cef2SBarry Smith PetscFunctionBegin; 38230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3824fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3825fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3826fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3827fffbeea8SBarry Smith " type = {Preprint},\n" 3828fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3829fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3830302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3831fffbeea8SBarry Smith 3832d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 383368bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3834d405a339SMatthew Knepley 3835a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()"); 3836be5899b3SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3837a6772fa2SLisandro Dalcin 3838be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3839362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3840be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 3841e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3842d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3843193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3844d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3845be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 3846be5899b3SLisandro Dalcin ts->steps++; ts->total_steps++; 3847be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 384828d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3849362cd11cSLisandro Dalcin 3850362cd11cSLisandro Dalcin if (ts->reason < 0) { 3851cef5090cSJed Brown if (ts->errorifstepfailed) { 385208c7845fSBarry Smith if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 385308c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3854d2daff3dSHong Zhang } 385508c7845fSBarry Smith } else if (!ts->reason) { 385608c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 385708c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 385808c7845fSBarry Smith } 385908c7845fSBarry Smith PetscFunctionReturn(0); 386008c7845fSBarry Smith } 386108c7845fSBarry Smith 386208c7845fSBarry Smith /*@ 3863b957a604SHong Zhang TSAdjointStep - Steps one time step backward in the adjoint run 386408c7845fSBarry Smith 386508c7845fSBarry Smith Collective on TS 386608c7845fSBarry Smith 386708c7845fSBarry Smith Input Parameter: 386808c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 386908c7845fSBarry Smith 38706a4d4014SLisandro Dalcin Level: intermediate 38716a4d4014SLisandro Dalcin 3872b957a604SHong Zhang .keywords: TS, adjoint, step 38736a4d4014SLisandro Dalcin 3874b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve() 38756a4d4014SLisandro Dalcin @*/ 387608c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 38776a4d4014SLisandro Dalcin { 387808c7845fSBarry Smith DM dm; 38796a4d4014SLisandro Dalcin PetscErrorCode ierr; 38806a4d4014SLisandro Dalcin 38816a4d4014SLisandro Dalcin PetscFunctionBegin; 38824a2ae208SSatish Balay PetscValidHeaderSpecific(ts,TS_CLASSID,1); 388308c7845fSBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 388408c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3885d763cef2SBarry Smith 3886685405a1SBarry Smith ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 3887d763cef2SBarry Smith 3888be5899b3SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3889be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime; 389042f2b339SBarry Smith if (!ts->ops->adjointstep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name); 3891be5899b3SLisandro Dalcin ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 389242f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 38938d0ad7a8SHong Zhang ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3894be5899b3SLisandro Dalcin ts->steps++; ts->total_steps--; 3895362cd11cSLisandro Dalcin 3896362cd11cSLisandro Dalcin if (ts->reason < 0) { 3897cef5090cSJed Brown if (ts->errorifstepfailed) { 38986c4ed002SBarry Smith if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]); 38996c4ed002SBarry Smith else if (ts->reason == TS_DIVERGED_STEP_REJECTED) 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]); 39006c4ed002SBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3901cef5090cSJed Brown } 3902362cd11cSLisandro Dalcin } else if (!ts->reason) { 390373b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3904362cd11cSLisandro Dalcin } 3905d763cef2SBarry Smith PetscFunctionReturn(0); 3906d763cef2SBarry Smith } 3907d763cef2SBarry Smith 39087cbde773SLisandro Dalcin /*@ 39097cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 39107cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 39117cbde773SLisandro Dalcin 39127cbde773SLisandro Dalcin Collective on TS 39137cbde773SLisandro Dalcin 39147cbde773SLisandro Dalcin Input Arguments: 39157cbde773SLisandro Dalcin + ts - time stepping context 39167cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 39177cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 39187cbde773SLisandro Dalcin 39197cbde773SLisandro Dalcin Output Arguments: 39207cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 39217cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 39227cbde773SLisandro Dalcin 39237cbde773SLisandro Dalcin Level: advanced 39247cbde773SLisandro Dalcin 39257cbde773SLisandro Dalcin Notes: 39267cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 39277cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 39287cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 39297cbde773SLisandro Dalcin 39307cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 39317cbde773SLisandro Dalcin @*/ 39327cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 39337cbde773SLisandro Dalcin { 39347cbde773SLisandro Dalcin PetscErrorCode ierr; 39357cbde773SLisandro Dalcin 39367cbde773SLisandro Dalcin PetscFunctionBegin; 39377cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 39387cbde773SLisandro Dalcin PetscValidType(ts,1); 39397cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 39407cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 39417cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 39427cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 39437cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 39447cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 39457cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 39467cbde773SLisandro Dalcin PetscFunctionReturn(0); 39477cbde773SLisandro Dalcin } 39487cbde773SLisandro Dalcin 394905175c85SJed Brown /*@ 395005175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 395105175c85SJed Brown 39521c3436cfSJed Brown Collective on TS 395305175c85SJed Brown 395405175c85SJed Brown Input Arguments: 39551c3436cfSJed Brown + ts - time stepping context 39561c3436cfSJed Brown . order - desired order of accuracy 39570298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 395805175c85SJed Brown 395905175c85SJed Brown Output Arguments: 39600910c330SBarry Smith . U - state at the end of the current step 396105175c85SJed Brown 396205175c85SJed Brown Level: advanced 396305175c85SJed Brown 3964108c343cSJed Brown Notes: 3965108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3966108c343cSJed 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. 3967108c343cSJed Brown 39681c3436cfSJed Brown .seealso: TSStep(), TSAdapt 396905175c85SJed Brown @*/ 39700910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 397105175c85SJed Brown { 397205175c85SJed Brown PetscErrorCode ierr; 397305175c85SJed Brown 397405175c85SJed Brown PetscFunctionBegin; 397505175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 397605175c85SJed Brown PetscValidType(ts,1); 39770910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3978ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 39790910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 398005175c85SJed Brown PetscFunctionReturn(0); 398105175c85SJed Brown } 398205175c85SJed Brown 3983b1cb36f3SHong Zhang /*@ 3984b1cb36f3SHong Zhang TSForwardCostIntegral - Evaluate the cost integral in the forward run. 3985b1cb36f3SHong Zhang 3986b1cb36f3SHong Zhang Collective on TS 3987b1cb36f3SHong Zhang 3988b1cb36f3SHong Zhang Input Arguments: 3989b1cb36f3SHong Zhang . ts - time stepping context 3990b1cb36f3SHong Zhang 3991b1cb36f3SHong Zhang Level: advanced 3992b1cb36f3SHong Zhang 3993b1cb36f3SHong Zhang Notes: 3994b1cb36f3SHong Zhang This function cannot be called until TSStep() has been completed. 3995b1cb36f3SHong Zhang 3996b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral() 3997b1cb36f3SHong Zhang @*/ 3998b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts) 3999b1cb36f3SHong Zhang { 4000b1cb36f3SHong Zhang PetscErrorCode ierr; 4001b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4002b1cb36f3SHong Zhang if (!ts->ops->forwardintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the forward run",((PetscObject)ts)->type_name); 4003b1cb36f3SHong Zhang ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 4004b1cb36f3SHong Zhang PetscFunctionReturn(0); 4005b1cb36f3SHong Zhang } 4006d67e68b7SBarry Smith 4007d763cef2SBarry Smith /*@ 4008d763cef2SBarry Smith TSSolve - Steps the requested number of timesteps. 4009d763cef2SBarry Smith 4010d763cef2SBarry Smith Collective on TS 4011d763cef2SBarry Smith 4012d763cef2SBarry Smith Input Parameter: 4013d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 401463e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 401563e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 40165a3a76d0SJed Brown 4017d763cef2SBarry Smith Level: beginner 4018d763cef2SBarry Smith 40195a3a76d0SJed Brown Notes: 40205a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 40215a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 40225a3a76d0SJed Brown stepped over the final time. 40235a3a76d0SJed Brown 4024d763cef2SBarry Smith .keywords: TS, timestep, solve 4025d763cef2SBarry Smith 402663e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 4027d763cef2SBarry Smith @*/ 4028cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 4029d763cef2SBarry Smith { 4030b06615a5SLisandro Dalcin Vec solution; 4031d763cef2SBarry Smith PetscErrorCode ierr; 4032d763cef2SBarry Smith 4033d763cef2SBarry Smith PetscFunctionBegin; 4034d763cef2SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4035f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4036feed9e9dSBarry Smith 403749354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 4038b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 40390910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 4040b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4041b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4042b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 40435a3a76d0SJed Brown } 40440910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4045bbd56ea5SKarl Rupp } else if (u) { 40460910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 40475a3a76d0SJed Brown } 4048b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 404968bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4050a6772fa2SLisandro Dalcin 4051a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()"); 4052a6772fa2SLisandro Dalcin if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && !ts->adapt) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 4053a6772fa2SLisandro Dalcin 4054e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 4055e7069c78SShri restarts the step after an event. Resetting these counters in such a case causes 4056e7069c78SShri TSTrajectory to incorrectly save the output files 4057e7069c78SShri */ 4058938c94caSShri Abhyankar 4059193ac0bcSJed Brown ts->steps = 0; 40605ef26d82SJed Brown ts->ksp_its = 0; 40615ef26d82SJed Brown ts->snes_its = 0; 4062c610991cSLisandro Dalcin ts->num_snes_failures = 0; 4063c610991cSLisandro Dalcin ts->reject = 0; 4064193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 4065193ac0bcSJed Brown 4066ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4067f05ece33SBarry Smith 4068193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4069193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4070a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4071cc708dedSBarry Smith ts->solvetime = ts->ptime; 4072a6772fa2SLisandro Dalcin solution = ts->vec_sol; 4073be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 4074db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4075db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4076e7069c78SShri 4077938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 40786427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4079e7069c78SShri 408028d5b5d6SLisandro Dalcin ts->steprollback = PETSC_FALSE; 408128d5b5d6SLisandro Dalcin ts->steprestart = PETSC_TRUE; 40826427ac75SLisandro Dalcin 4083e1a7a14fSJed Brown while (!ts->reason) { 4084938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 40859687d888SLisandro Dalcin if (!ts->steprollback) { 40869687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 40879687d888SLisandro Dalcin } 4088193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 4089e783b05fSHong Zhang if (ts->vec_costintegral && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 4090b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 4091b1cb36f3SHong Zhang } 409210b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 4093e783b05fSHong Zhang ierr = TSEventHandler(ts);CHKERRQ(ierr); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */ 4094e783b05fSHong Zhang if (!ts->steprollback) { 4095938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 40961eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 4097aeb4809dSShri Abhyankar } 4098193ac0bcSJed Brown } 4099938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41006427ac75SLisandro Dalcin 410149354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 41020910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4103cc708dedSBarry Smith ts->solvetime = ts->max_time; 4104b06615a5SLisandro Dalcin solution = u; 410563e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 41060574a7fbSJed Brown } else { 4107ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4108cc708dedSBarry Smith ts->solvetime = ts->ptime; 4109b06615a5SLisandro Dalcin solution = ts->vec_sol; 41100574a7fbSJed Brown } 4111193ac0bcSJed Brown } 4112d2daff3dSHong Zhang 4113ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 411463e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 411556f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4116ef222394SBarry Smith if (ts->adjoint_solve) { 4117ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 41182b0a91c0SBarry Smith } 4119d763cef2SBarry Smith PetscFunctionReturn(0); 4120d763cef2SBarry Smith } 4121d763cef2SBarry Smith 4122b1cb36f3SHong Zhang /*@ 4123b1cb36f3SHong Zhang TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4124b1cb36f3SHong Zhang 4125b1cb36f3SHong Zhang Collective on TS 4126b1cb36f3SHong Zhang 4127b1cb36f3SHong Zhang Input Arguments: 4128b1cb36f3SHong Zhang . ts - time stepping context 4129b1cb36f3SHong Zhang 4130b1cb36f3SHong Zhang Level: advanced 4131b1cb36f3SHong Zhang 4132b1cb36f3SHong Zhang Notes: 4133b1cb36f3SHong Zhang This function cannot be called until TSAdjointStep() has been completed. 4134b1cb36f3SHong Zhang 4135b1cb36f3SHong Zhang .seealso: TSAdjointSolve(), TSAdjointStep 4136b1cb36f3SHong Zhang @*/ 4137b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts) 4138b1cb36f3SHong Zhang { 4139b1cb36f3SHong Zhang PetscErrorCode ierr; 4140b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4141b1cb36f3SHong Zhang if (!ts->ops->adjointintegral) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide integral evaluation in the adjoint run",((PetscObject)ts)->type_name); 4142b1cb36f3SHong Zhang ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4143b1cb36f3SHong Zhang PetscFunctionReturn(0); 4144b1cb36f3SHong Zhang } 4145b1cb36f3SHong Zhang 4146c88f2d44SBarry Smith /*@ 4147c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4148c88f2d44SBarry Smith 4149c88f2d44SBarry Smith Collective on TS 4150c88f2d44SBarry Smith 4151c88f2d44SBarry Smith Input Parameter: 41522c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 4153c88f2d44SBarry Smith 4154e87fd094SBarry Smith Options Database: 4155e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 4156e87fd094SBarry Smith 4157c88f2d44SBarry Smith Level: intermediate 4158c88f2d44SBarry Smith 4159c88f2d44SBarry Smith Notes: 4160c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 4161c88f2d44SBarry Smith 416273b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 416373b18844SBarry Smith 4164c88f2d44SBarry Smith .keywords: TS, timestep, solve 4165c88f2d44SBarry Smith 4166b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4167c88f2d44SBarry Smith @*/ 41682c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 4169c88f2d44SBarry Smith { 4170c88f2d44SBarry Smith PetscErrorCode ierr; 4171c88f2d44SBarry Smith 4172c88f2d44SBarry Smith PetscFunctionBegin; 4173c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4174c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 417568bece0bSHong Zhang 4176c88f2d44SBarry Smith /* reset time step and iteration counters */ 4177c88f2d44SBarry Smith ts->steps = 0; 4178c88f2d44SBarry Smith ts->ksp_its = 0; 4179c88f2d44SBarry Smith ts->snes_its = 0; 4180c88f2d44SBarry Smith ts->num_snes_failures = 0; 4181c88f2d44SBarry Smith ts->reject = 0; 4182c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 4183c88f2d44SBarry Smith 418473b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4185c88f2d44SBarry Smith 418673b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4187c88f2d44SBarry Smith while (!ts->reason) { 418855c52731SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 41899110b2e7SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 41906427ac75SLisandro Dalcin ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4191616946c1SHong Zhang ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4192b1cb36f3SHong Zhang if (ts->vec_costintegral && !ts->costintegralfwd) { 4193b1cb36f3SHong Zhang ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4194b1cb36f3SHong Zhang } 4195c88f2d44SBarry Smith } 419626656371SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 419726656371SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4198c88f2d44SBarry Smith ts->solvetime = ts->ptime; 4199e210cd0eSHong Zhang ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4200685405a1SBarry Smith ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4201c88f2d44SBarry Smith PetscFunctionReturn(0); 4202c88f2d44SBarry Smith } 4203c88f2d44SBarry Smith 42047db568b7SBarry Smith /*@C 4205228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4206228d79bcSJed Brown 4207228d79bcSJed Brown Collective on TS 4208228d79bcSJed Brown 4209228d79bcSJed Brown Input Parameters: 4210228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 4211228d79bcSJed Brown . step - step number that has just completed 4212228d79bcSJed Brown . ptime - model time of the state 42130910c330SBarry Smith - u - state at the current model time 4214228d79bcSJed Brown 4215228d79bcSJed Brown Notes: 42167db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 42177db568b7SBarry Smith Users would almost never call this routine directly. 4218228d79bcSJed Brown 421963e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 422063e21af5SBarry Smith 42217db568b7SBarry Smith Level: developer 4222228d79bcSJed Brown 4223228d79bcSJed Brown .keywords: TS, timestep 4224228d79bcSJed Brown @*/ 42250910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4226d763cef2SBarry Smith { 4227d6152f81SLisandro Dalcin DM dm; 4228a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 4229d6152f81SLisandro Dalcin PetscErrorCode ierr; 4230d763cef2SBarry Smith 4231d763cef2SBarry Smith PetscFunctionBegin; 4232b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4233b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4234d6152f81SLisandro Dalcin 4235d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4236d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4237d6152f81SLisandro Dalcin 42385edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 4239d763cef2SBarry Smith for (i=0; i<n; i++) { 42400910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4241d763cef2SBarry Smith } 42425edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 4243d763cef2SBarry Smith PetscFunctionReturn(0); 4244d763cef2SBarry Smith } 4245d763cef2SBarry Smith 42467db568b7SBarry Smith /*@C 42479110b2e7SHong Zhang TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 42489110b2e7SHong Zhang 42499110b2e7SHong Zhang Collective on TS 42509110b2e7SHong Zhang 42519110b2e7SHong Zhang Input Parameters: 42529110b2e7SHong Zhang + ts - time stepping context obtained from TSCreate() 42539110b2e7SHong Zhang . step - step number that has just completed 42549110b2e7SHong Zhang . ptime - model time of the state 42559110b2e7SHong Zhang . u - state at the current model time 42569110b2e7SHong Zhang . numcost - number of cost functions (dimension of lambda or mu) 42579110b2e7SHong Zhang . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 42589110b2e7SHong Zhang - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 42599110b2e7SHong Zhang 42609110b2e7SHong Zhang Notes: 42617db568b7SBarry Smith TSAdjointMonitor() is typically used automatically within the time stepping implementations. 42627db568b7SBarry Smith Users would almost never call this routine directly. 42639110b2e7SHong Zhang 42647db568b7SBarry Smith Level: developer 42659110b2e7SHong Zhang 42669110b2e7SHong Zhang .keywords: TS, timestep 42679110b2e7SHong Zhang @*/ 42689110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 42699110b2e7SHong Zhang { 42709110b2e7SHong Zhang PetscErrorCode ierr; 42719110b2e7SHong Zhang PetscInt i,n = ts->numberadjointmonitors; 42729110b2e7SHong Zhang 42739110b2e7SHong Zhang PetscFunctionBegin; 42749110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42759110b2e7SHong Zhang PetscValidHeaderSpecific(u,VEC_CLASSID,4); 42769110b2e7SHong Zhang ierr = VecLockPush(u);CHKERRQ(ierr); 42779110b2e7SHong Zhang for (i=0; i<n; i++) { 42789110b2e7SHong Zhang ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 42799110b2e7SHong Zhang } 42809110b2e7SHong Zhang ierr = VecLockPop(u);CHKERRQ(ierr); 42819110b2e7SHong Zhang PetscFunctionReturn(0); 42829110b2e7SHong Zhang } 42839110b2e7SHong Zhang 4284d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 4285d763cef2SBarry Smith /*@C 42867db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4287a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 4288d763cef2SBarry Smith 4289d763cef2SBarry Smith Collective on TS 4290d763cef2SBarry Smith 4291d763cef2SBarry Smith Input Parameters: 4292d763cef2SBarry Smith + host - the X display to open, or null for the local machine 4293d763cef2SBarry Smith . label - the title to put in the title bar 42947c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 4295a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 4296a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4297d763cef2SBarry Smith 4298d763cef2SBarry Smith Output Parameter: 42990b039ecaSBarry Smith . ctx - the context 4300d763cef2SBarry Smith 4301d763cef2SBarry Smith Options Database Key: 43024f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 43037db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 43047db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 43057db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 43067db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4307b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4308d763cef2SBarry Smith 4309d763cef2SBarry Smith Notes: 4310a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 4311d763cef2SBarry Smith 43127db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 43137db568b7SBarry Smith 43147db568b7SBarry Smith Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the 43157db568b7SBarry Smith first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object 43167db568b7SBarry Smith as the first argument. 43177db568b7SBarry Smith 43187db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 43197db568b7SBarry Smith 43207db568b7SBarry Smith 4321d763cef2SBarry Smith Level: intermediate 4322d763cef2SBarry Smith 43237db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 4324d763cef2SBarry Smith 43257db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 43267db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 43277db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 43287db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 43297db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 43307c922b88SBarry Smith 4331d763cef2SBarry Smith @*/ 4332a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4333d763cef2SBarry Smith { 43347f52daa2SLisandro Dalcin PetscDraw draw; 4335dfbe8321SBarry Smith PetscErrorCode ierr; 4336d763cef2SBarry Smith 4337d763cef2SBarry Smith PetscFunctionBegin; 4338b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 43397f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 43407f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 43417f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4342287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 43437f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4344a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4345d763cef2SBarry Smith PetscFunctionReturn(0); 4346d763cef2SBarry Smith } 4347d763cef2SBarry Smith 4348b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4349d763cef2SBarry Smith { 43500b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4351c32365f1SBarry Smith PetscReal x = ptime,y; 4352dfbe8321SBarry Smith PetscErrorCode ierr; 4353d763cef2SBarry Smith 4354d763cef2SBarry Smith PetscFunctionBegin; 435563e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4356b06615a5SLisandro Dalcin if (!step) { 4357a9f9c1f6SBarry Smith PetscDrawAxis axis; 4358a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 43596934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4360a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4361a9f9c1f6SBarry Smith } 4362c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 43630b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4364b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 43650b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 43666934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 43673923b477SBarry Smith } 4368d763cef2SBarry Smith PetscFunctionReturn(0); 4369d763cef2SBarry Smith } 4370d763cef2SBarry Smith 4371d763cef2SBarry Smith /*@C 4372a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4373a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4374d763cef2SBarry Smith 43750b039ecaSBarry Smith Collective on TSMonitorLGCtx 4376d763cef2SBarry Smith 4377d763cef2SBarry Smith Input Parameter: 43780b039ecaSBarry Smith . ctx - the monitor context 4379d763cef2SBarry Smith 4380d763cef2SBarry Smith Level: intermediate 4381d763cef2SBarry Smith 4382d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 4383d763cef2SBarry Smith 43844f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4385d763cef2SBarry Smith @*/ 4386a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4387d763cef2SBarry Smith { 4388dfbe8321SBarry Smith PetscErrorCode ierr; 4389d763cef2SBarry Smith 4390d763cef2SBarry Smith PetscFunctionBegin; 43917684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 43927684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 43937684fa3eSBarry Smith } 43940b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 439531152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4396387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4397387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4398387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 43990b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4400d763cef2SBarry Smith PetscFunctionReturn(0); 4401d763cef2SBarry Smith } 4402d763cef2SBarry Smith 4403d763cef2SBarry Smith /*@ 4404b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4405d763cef2SBarry Smith 4406d763cef2SBarry Smith Not Collective 4407d763cef2SBarry Smith 4408d763cef2SBarry Smith Input Parameter: 4409d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4410d763cef2SBarry Smith 4411d763cef2SBarry Smith Output Parameter: 441263e21af5SBarry Smith . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4413d763cef2SBarry Smith 4414d763cef2SBarry Smith Level: beginner 4415d763cef2SBarry Smith 4416b8123daeSJed Brown Note: 4417b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 44189be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4419b8123daeSJed Brown 442063e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4421d763cef2SBarry Smith 4422d763cef2SBarry Smith .keywords: TS, get, time 4423d763cef2SBarry Smith @*/ 44247087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4425d763cef2SBarry Smith { 4426d763cef2SBarry Smith PetscFunctionBegin; 44270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4428f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4429d763cef2SBarry Smith *t = ts->ptime; 4430d763cef2SBarry Smith PetscFunctionReturn(0); 4431d763cef2SBarry Smith } 4432d763cef2SBarry Smith 4433e5e524a1SHong Zhang /*@ 4434e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4435e5e524a1SHong Zhang 4436e5e524a1SHong Zhang Not Collective 4437e5e524a1SHong Zhang 4438e5e524a1SHong Zhang Input Parameter: 4439e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4440e5e524a1SHong Zhang 4441e5e524a1SHong Zhang Output Parameter: 4442e5e524a1SHong Zhang . t - the previous time 4443e5e524a1SHong Zhang 4444e5e524a1SHong Zhang Level: beginner 4445e5e524a1SHong Zhang 4446e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4447e5e524a1SHong Zhang 4448e5e524a1SHong Zhang .keywords: TS, get, time 4449e5e524a1SHong Zhang @*/ 4450e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4451e5e524a1SHong Zhang { 4452e5e524a1SHong Zhang PetscFunctionBegin; 4453e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4454e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4455e5e524a1SHong Zhang *t = ts->ptime_prev; 4456e5e524a1SHong Zhang PetscFunctionReturn(0); 4457e5e524a1SHong Zhang } 4458e5e524a1SHong Zhang 44596a4d4014SLisandro Dalcin /*@ 44606a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 44616a4d4014SLisandro Dalcin 44623f9fe445SBarry Smith Logically Collective on TS 44636a4d4014SLisandro Dalcin 44646a4d4014SLisandro Dalcin Input Parameters: 44656a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 44666a4d4014SLisandro Dalcin - time - the time 44676a4d4014SLisandro Dalcin 44686a4d4014SLisandro Dalcin Level: intermediate 44696a4d4014SLisandro Dalcin 44706a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 44716a4d4014SLisandro Dalcin 44726a4d4014SLisandro Dalcin .keywords: TS, set, time 44736a4d4014SLisandro Dalcin @*/ 44747087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 44756a4d4014SLisandro Dalcin { 44766a4d4014SLisandro Dalcin PetscFunctionBegin; 44770700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4478c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 44796a4d4014SLisandro Dalcin ts->ptime = t; 44806a4d4014SLisandro Dalcin PetscFunctionReturn(0); 44816a4d4014SLisandro Dalcin } 44826a4d4014SLisandro Dalcin 4483d763cef2SBarry Smith /*@C 4484d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4485d763cef2SBarry Smith TS options in the database. 4486d763cef2SBarry Smith 44873f9fe445SBarry Smith Logically Collective on TS 4488d763cef2SBarry Smith 4489d763cef2SBarry Smith Input Parameter: 4490d763cef2SBarry Smith + ts - The TS context 4491d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4492d763cef2SBarry Smith 4493d763cef2SBarry Smith Notes: 4494d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4495d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4496d763cef2SBarry Smith hyphen. 4497d763cef2SBarry Smith 4498d763cef2SBarry Smith Level: advanced 4499d763cef2SBarry Smith 4500d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4501d763cef2SBarry Smith 4502d763cef2SBarry Smith .seealso: TSSetFromOptions() 4503d763cef2SBarry Smith 4504d763cef2SBarry Smith @*/ 45057087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4506d763cef2SBarry Smith { 4507dfbe8321SBarry Smith PetscErrorCode ierr; 4508089b2837SJed Brown SNES snes; 4509d763cef2SBarry Smith 4510d763cef2SBarry Smith PetscFunctionBegin; 45110700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4512d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4513089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4514089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4515d763cef2SBarry Smith PetscFunctionReturn(0); 4516d763cef2SBarry Smith } 4517d763cef2SBarry Smith 4518d763cef2SBarry Smith 4519d763cef2SBarry Smith /*@C 4520d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4521d763cef2SBarry Smith TS options in the database. 4522d763cef2SBarry Smith 45233f9fe445SBarry Smith Logically Collective on TS 4524d763cef2SBarry Smith 4525d763cef2SBarry Smith Input Parameter: 4526d763cef2SBarry Smith + ts - The TS context 4527d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4528d763cef2SBarry Smith 4529d763cef2SBarry Smith Notes: 4530d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4531d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4532d763cef2SBarry Smith hyphen. 4533d763cef2SBarry Smith 4534d763cef2SBarry Smith Level: advanced 4535d763cef2SBarry Smith 4536d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4537d763cef2SBarry Smith 4538d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4539d763cef2SBarry Smith 4540d763cef2SBarry Smith @*/ 45417087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4542d763cef2SBarry Smith { 4543dfbe8321SBarry Smith PetscErrorCode ierr; 4544089b2837SJed Brown SNES snes; 4545d763cef2SBarry Smith 4546d763cef2SBarry Smith PetscFunctionBegin; 45470700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4548d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4549089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4550089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4551d763cef2SBarry Smith PetscFunctionReturn(0); 4552d763cef2SBarry Smith } 4553d763cef2SBarry Smith 4554d763cef2SBarry Smith /*@C 4555d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4556d763cef2SBarry Smith TS options in the database. 4557d763cef2SBarry Smith 4558d763cef2SBarry Smith Not Collective 4559d763cef2SBarry Smith 4560d763cef2SBarry Smith Input Parameter: 4561d763cef2SBarry Smith . ts - The TS context 4562d763cef2SBarry Smith 4563d763cef2SBarry Smith Output Parameter: 4564d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4565d763cef2SBarry Smith 4566d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 4567d763cef2SBarry Smith sufficient length to hold the prefix. 4568d763cef2SBarry Smith 4569d763cef2SBarry Smith Level: intermediate 4570d763cef2SBarry Smith 4571d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4572d763cef2SBarry Smith 4573d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4574d763cef2SBarry Smith @*/ 45757087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4576d763cef2SBarry Smith { 4577dfbe8321SBarry Smith PetscErrorCode ierr; 4578d763cef2SBarry Smith 4579d763cef2SBarry Smith PetscFunctionBegin; 45800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45814482741eSBarry Smith PetscValidPointer(prefix,2); 4582d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4583d763cef2SBarry Smith PetscFunctionReturn(0); 4584d763cef2SBarry Smith } 4585d763cef2SBarry Smith 4586d763cef2SBarry Smith /*@C 4587d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4588d763cef2SBarry Smith 4589d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4590d763cef2SBarry Smith 4591d763cef2SBarry Smith Input Parameter: 4592d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4593d763cef2SBarry Smith 4594d763cef2SBarry Smith Output Parameters: 4595e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4596e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4597e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4598e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4599d763cef2SBarry Smith 46000298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 4601d763cef2SBarry Smith 4602d763cef2SBarry Smith Level: intermediate 4603d763cef2SBarry Smith 460426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4605d763cef2SBarry Smith 4606d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4607d763cef2SBarry Smith @*/ 4608e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4609d763cef2SBarry Smith { 4610089b2837SJed Brown PetscErrorCode ierr; 461124989b8cSPeter Brune DM dm; 4612089b2837SJed Brown 4613d763cef2SBarry Smith PetscFunctionBegin; 461423a57915SBarry Smith if (Amat || Pmat) { 461523a57915SBarry Smith SNES snes; 4616089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 461723a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4618e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 461923a57915SBarry Smith } 462024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 462124989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4622d763cef2SBarry Smith PetscFunctionReturn(0); 4623d763cef2SBarry Smith } 4624d763cef2SBarry Smith 46252eca1d9cSJed Brown /*@C 46262eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 46272eca1d9cSJed Brown 46282eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 46292eca1d9cSJed Brown 46302eca1d9cSJed Brown Input Parameter: 46312eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 46322eca1d9cSJed Brown 46332eca1d9cSJed Brown Output Parameters: 4634e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4635e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 46362eca1d9cSJed Brown . f - The function to compute the matrices 46372eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 46382eca1d9cSJed Brown 46390298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 46402eca1d9cSJed Brown 46412eca1d9cSJed Brown Level: advanced 46422eca1d9cSJed Brown 46432eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 46442eca1d9cSJed Brown 46452eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 46462eca1d9cSJed Brown @*/ 4647e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 46482eca1d9cSJed Brown { 4649089b2837SJed Brown PetscErrorCode ierr; 465024989b8cSPeter Brune DM dm; 46510910c330SBarry Smith 46522eca1d9cSJed Brown PetscFunctionBegin; 4653c0aab802Sstefano_zampini if (Amat || Pmat) { 4654c0aab802Sstefano_zampini SNES snes; 4655089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4656f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4657e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4658c0aab802Sstefano_zampini } 465924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 466024989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 46612eca1d9cSJed Brown PetscFunctionReturn(0); 46622eca1d9cSJed Brown } 46632eca1d9cSJed Brown 46646083293cSBarry Smith 46651713a123SBarry Smith /*@C 466683a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 46671713a123SBarry Smith VecView() for the solution at each timestep 46681713a123SBarry Smith 46691713a123SBarry Smith Collective on TS 46701713a123SBarry Smith 46711713a123SBarry Smith Input Parameters: 46721713a123SBarry Smith + ts - the TS context 46731713a123SBarry Smith . step - current time-step 4674142b95e3SSatish Balay . ptime - current time 46750298fd71SBarry Smith - dummy - either a viewer or NULL 46761713a123SBarry Smith 467799fdda47SBarry Smith Options Database: 467899fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 467999fdda47SBarry Smith 4680387f4636SBarry Smith Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 468199fdda47SBarry Smith will look bad 468299fdda47SBarry Smith 46831713a123SBarry Smith Level: intermediate 46841713a123SBarry Smith 46851713a123SBarry Smith .keywords: TS, vector, monitor, view 46861713a123SBarry Smith 4687a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 46881713a123SBarry Smith @*/ 46890910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 46901713a123SBarry Smith { 4691dfbe8321SBarry Smith PetscErrorCode ierr; 469283a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4693473a3ab2SBarry Smith PetscDraw draw; 46941713a123SBarry Smith 46951713a123SBarry Smith PetscFunctionBegin; 46966083293cSBarry Smith if (!step && ictx->showinitial) { 46976083293cSBarry Smith if (!ictx->initialsolution) { 46980910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 46991713a123SBarry Smith } 47000910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 47016083293cSBarry Smith } 4702b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47030dcf80beSBarry Smith 47046083293cSBarry Smith if (ictx->showinitial) { 47056083293cSBarry Smith PetscReal pause; 47066083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 47076083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 47086083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 47096083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 47106083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 47116083293cSBarry Smith } 47120910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4713473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 471451fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4715473a3ab2SBarry Smith char time[32]; 4716473a3ab2SBarry Smith 4717473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 471885b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4719473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4720473a3ab2SBarry Smith h = yl + .95*(yr - yl); 472151fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4722473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4723473a3ab2SBarry Smith } 4724473a3ab2SBarry Smith 47256083293cSBarry Smith if (ictx->showinitial) { 47266083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 47276083293cSBarry Smith } 47281713a123SBarry Smith PetscFunctionReturn(0); 47291713a123SBarry Smith } 47301713a123SBarry Smith 47319110b2e7SHong Zhang /*@C 47329110b2e7SHong Zhang TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 47339110b2e7SHong Zhang VecView() for the sensitivities to initial states at each timestep 47349110b2e7SHong Zhang 47359110b2e7SHong Zhang Collective on TS 47369110b2e7SHong Zhang 47379110b2e7SHong Zhang Input Parameters: 47389110b2e7SHong Zhang + ts - the TS context 47399110b2e7SHong Zhang . step - current time-step 47409110b2e7SHong Zhang . ptime - current time 47419110b2e7SHong Zhang . u - current state 47429110b2e7SHong Zhang . numcost - number of cost functions 47439110b2e7SHong Zhang . lambda - sensitivities to initial conditions 47449110b2e7SHong Zhang . mu - sensitivities to parameters 47459110b2e7SHong Zhang - dummy - either a viewer or NULL 47469110b2e7SHong Zhang 47479110b2e7SHong Zhang Level: intermediate 47489110b2e7SHong Zhang 47499110b2e7SHong Zhang .keywords: TS, vector, adjoint, monitor, view 47509110b2e7SHong Zhang 47519110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 47529110b2e7SHong Zhang @*/ 47539110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 47549110b2e7SHong Zhang { 47559110b2e7SHong Zhang PetscErrorCode ierr; 47569110b2e7SHong Zhang TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 47579110b2e7SHong Zhang PetscDraw draw; 4758a0046e2cSSatish Balay PetscReal xl,yl,xr,yr,h; 4759a0046e2cSSatish Balay char time[32]; 47609110b2e7SHong Zhang 47619110b2e7SHong Zhang PetscFunctionBegin; 47629110b2e7SHong Zhang if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47639110b2e7SHong Zhang 47649110b2e7SHong Zhang ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 47659110b2e7SHong Zhang ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 47669110b2e7SHong Zhang ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 47679110b2e7SHong Zhang ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 47689110b2e7SHong Zhang h = yl + .95*(yr - yl); 47699110b2e7SHong Zhang ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 47709110b2e7SHong Zhang ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 47719110b2e7SHong Zhang PetscFunctionReturn(0); 47729110b2e7SHong Zhang } 47739110b2e7SHong Zhang 47742d5ee99bSBarry Smith /*@C 47752d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 47762d5ee99bSBarry Smith 47772d5ee99bSBarry Smith Collective on TS 47782d5ee99bSBarry Smith 47792d5ee99bSBarry Smith Input Parameters: 47802d5ee99bSBarry Smith + ts - the TS context 47812d5ee99bSBarry Smith . step - current time-step 47822d5ee99bSBarry Smith . ptime - current time 47832d5ee99bSBarry Smith - dummy - either a viewer or NULL 47842d5ee99bSBarry Smith 47852d5ee99bSBarry Smith Level: intermediate 47862d5ee99bSBarry Smith 47872d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 47882d5ee99bSBarry Smith 47892d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 47902d5ee99bSBarry Smith @*/ 47912d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 47922d5ee99bSBarry Smith { 47932d5ee99bSBarry Smith PetscErrorCode ierr; 47942d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 47952d5ee99bSBarry Smith PetscDraw draw; 47966934998bSLisandro Dalcin PetscDrawAxis axis; 47972d5ee99bSBarry Smith PetscInt n; 47982d5ee99bSBarry Smith PetscMPIInt size; 47996934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 48002d5ee99bSBarry Smith char time[32]; 48012d5ee99bSBarry Smith const PetscScalar *U; 48022d5ee99bSBarry Smith 48032d5ee99bSBarry Smith PetscFunctionBegin; 48046934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 48056934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 48062d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 48076934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 48082d5ee99bSBarry Smith 48092d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 48106934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 48116934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 48126934998bSLisandro Dalcin if (!step) { 48136934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 48146934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 48156934998bSLisandro Dalcin } 48162d5ee99bSBarry Smith 48172d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 48186934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 48196934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4820a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 48216934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 48222d5ee99bSBarry Smith 48236934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 48246934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 48252d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 48264b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 482785b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 48282d5ee99bSBarry Smith h = yl + .95*(yr - yl); 482951fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 48302d5ee99bSBarry Smith } 48316934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 48322d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 48336934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 48342d5ee99bSBarry Smith PetscFunctionReturn(0); 48352d5ee99bSBarry Smith } 48362d5ee99bSBarry Smith 48371713a123SBarry Smith 48386083293cSBarry Smith /*@C 483983a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 48406083293cSBarry Smith 48416083293cSBarry Smith Collective on TS 48426083293cSBarry Smith 48436083293cSBarry Smith Input Parameters: 48446083293cSBarry Smith . ctx - the monitor context 48456083293cSBarry Smith 48466083293cSBarry Smith Level: intermediate 48476083293cSBarry Smith 48486083293cSBarry Smith .keywords: TS, vector, monitor, view 48496083293cSBarry Smith 485083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 48516083293cSBarry Smith @*/ 485283a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 48536083293cSBarry Smith { 48546083293cSBarry Smith PetscErrorCode ierr; 48556083293cSBarry Smith 48566083293cSBarry Smith PetscFunctionBegin; 485783a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 485883a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 485983a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 48606083293cSBarry Smith PetscFunctionReturn(0); 48616083293cSBarry Smith } 48626083293cSBarry Smith 48636083293cSBarry Smith /*@C 486483a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 48656083293cSBarry Smith 48666083293cSBarry Smith Collective on TS 48676083293cSBarry Smith 48686083293cSBarry Smith Input Parameter: 48696083293cSBarry Smith . ts - time-step context 48706083293cSBarry Smith 48716083293cSBarry Smith Output Patameter: 48726083293cSBarry Smith . ctx - the monitor context 48736083293cSBarry Smith 487499fdda47SBarry Smith Options Database: 487599fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 487699fdda47SBarry Smith 48776083293cSBarry Smith Level: intermediate 48786083293cSBarry Smith 48796083293cSBarry Smith .keywords: TS, vector, monitor, view 48806083293cSBarry Smith 488183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 48826083293cSBarry Smith @*/ 488383a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 48846083293cSBarry Smith { 48856083293cSBarry Smith PetscErrorCode ierr; 48866083293cSBarry Smith 48876083293cSBarry Smith PetscFunctionBegin; 4888b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 488983a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4890e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4891bbd56ea5SKarl Rupp 489283a4ac43SBarry Smith (*ctx)->howoften = howoften; 4893473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4894c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4895473a3ab2SBarry Smith 4896473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4897c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 48986083293cSBarry Smith PetscFunctionReturn(0); 48996083293cSBarry Smith } 49006083293cSBarry Smith 49013a471f94SBarry Smith /*@C 490283a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 49033a471f94SBarry Smith VecView() for the error at each timestep 49043a471f94SBarry Smith 49053a471f94SBarry Smith Collective on TS 49063a471f94SBarry Smith 49073a471f94SBarry Smith Input Parameters: 49083a471f94SBarry Smith + ts - the TS context 49093a471f94SBarry Smith . step - current time-step 49103a471f94SBarry Smith . ptime - current time 49110298fd71SBarry Smith - dummy - either a viewer or NULL 49123a471f94SBarry Smith 49133a471f94SBarry Smith Level: intermediate 49143a471f94SBarry Smith 49153a471f94SBarry Smith .keywords: TS, vector, monitor, view 49163a471f94SBarry Smith 49173a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 49183a471f94SBarry Smith @*/ 49190910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 49203a471f94SBarry Smith { 49213a471f94SBarry Smith PetscErrorCode ierr; 492283a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 492383a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 49243a471f94SBarry Smith Vec work; 49253a471f94SBarry Smith 49263a471f94SBarry Smith PetscFunctionBegin; 4927b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 49280910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 49293a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 49300910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 49313a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 49323a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 49333a471f94SBarry Smith PetscFunctionReturn(0); 49343a471f94SBarry Smith } 49353a471f94SBarry Smith 4936af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 49376c699258SBarry Smith /*@ 49382a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 49396c699258SBarry Smith 49403f9fe445SBarry Smith Logically Collective on TS and DM 49416c699258SBarry Smith 49426c699258SBarry Smith Input Parameters: 49432a808120SBarry Smith + ts - the ODE integrator object 49442a808120SBarry Smith - dm - the dm, cannot be NULL 49456c699258SBarry Smith 49466c699258SBarry Smith Level: intermediate 49476c699258SBarry Smith 49486c699258SBarry Smith 49496c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 49506c699258SBarry Smith @*/ 49517087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 49526c699258SBarry Smith { 49536c699258SBarry Smith PetscErrorCode ierr; 4954089b2837SJed Brown SNES snes; 4955942e3340SBarry Smith DMTS tsdm; 49566c699258SBarry Smith 49576c699258SBarry Smith PetscFunctionBegin; 49580700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49592a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 496070663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4961942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 49622a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4963942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4964942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 496524989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 496624989b8cSPeter Brune tsdm->originaldm = dm; 496724989b8cSPeter Brune } 496824989b8cSPeter Brune } 49696bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 497024989b8cSPeter Brune } 49716c699258SBarry Smith ts->dm = dm; 4972bbd56ea5SKarl Rupp 4973089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4974089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 49756c699258SBarry Smith PetscFunctionReturn(0); 49766c699258SBarry Smith } 49776c699258SBarry Smith 49786c699258SBarry Smith /*@ 49796c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 49806c699258SBarry Smith 49813f9fe445SBarry Smith Not Collective 49826c699258SBarry Smith 49836c699258SBarry Smith Input Parameter: 49846c699258SBarry Smith . ts - the preconditioner context 49856c699258SBarry Smith 49866c699258SBarry Smith Output Parameter: 49876c699258SBarry Smith . dm - the dm 49886c699258SBarry Smith 49896c699258SBarry Smith Level: intermediate 49906c699258SBarry Smith 49916c699258SBarry Smith 49926c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 49936c699258SBarry Smith @*/ 49947087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 49956c699258SBarry Smith { 4996496e6a7aSJed Brown PetscErrorCode ierr; 4997496e6a7aSJed Brown 49986c699258SBarry Smith PetscFunctionBegin; 49990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5000496e6a7aSJed Brown if (!ts->dm) { 5001ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 5002496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 5003496e6a7aSJed Brown } 50046c699258SBarry Smith *dm = ts->dm; 50056c699258SBarry Smith PetscFunctionReturn(0); 50066c699258SBarry Smith } 50071713a123SBarry Smith 50080f5c6efeSJed Brown /*@ 50090f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 50100f5c6efeSJed Brown 50113f9fe445SBarry Smith Logically Collective on SNES 50120f5c6efeSJed Brown 50130f5c6efeSJed Brown Input Parameter: 5014d42a1c89SJed Brown + snes - nonlinear solver 50150910c330SBarry Smith . U - the current state at which to evaluate the residual 5016d42a1c89SJed Brown - ctx - user context, must be a TS 50170f5c6efeSJed Brown 50180f5c6efeSJed Brown Output Parameter: 50190f5c6efeSJed Brown . F - the nonlinear residual 50200f5c6efeSJed Brown 50210f5c6efeSJed Brown Notes: 50220f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50230f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 50240f5c6efeSJed Brown 50250f5c6efeSJed Brown Level: advanced 50260f5c6efeSJed Brown 50270f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 50280f5c6efeSJed Brown @*/ 50290910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 50300f5c6efeSJed Brown { 50310f5c6efeSJed Brown TS ts = (TS)ctx; 50320f5c6efeSJed Brown PetscErrorCode ierr; 50330f5c6efeSJed Brown 50340f5c6efeSJed Brown PetscFunctionBegin; 50350f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50360910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50370f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 50380f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 50390910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 50400f5c6efeSJed Brown PetscFunctionReturn(0); 50410f5c6efeSJed Brown } 50420f5c6efeSJed Brown 50430f5c6efeSJed Brown /*@ 50440f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 50450f5c6efeSJed Brown 50460f5c6efeSJed Brown Collective on SNES 50470f5c6efeSJed Brown 50480f5c6efeSJed Brown Input Parameter: 50490f5c6efeSJed Brown + snes - nonlinear solver 50500910c330SBarry Smith . U - the current state at which to evaluate the residual 50510f5c6efeSJed Brown - ctx - user context, must be a TS 50520f5c6efeSJed Brown 50530f5c6efeSJed Brown Output Parameter: 50540f5c6efeSJed Brown + A - the Jacobian 50550f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 50560f5c6efeSJed Brown - flag - indicates any structure change in the matrix 50570f5c6efeSJed Brown 50580f5c6efeSJed Brown Notes: 50590f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50600f5c6efeSJed Brown 50610f5c6efeSJed Brown Level: developer 50620f5c6efeSJed Brown 50630f5c6efeSJed Brown .seealso: SNESSetJacobian() 50640f5c6efeSJed Brown @*/ 5065d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 50660f5c6efeSJed Brown { 50670f5c6efeSJed Brown TS ts = (TS)ctx; 50680f5c6efeSJed Brown PetscErrorCode ierr; 50690f5c6efeSJed Brown 50700f5c6efeSJed Brown PetscFunctionBegin; 50710f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50720910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50730f5c6efeSJed Brown PetscValidPointer(A,3); 507494ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 50750f5c6efeSJed Brown PetscValidPointer(B,4); 507694ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 50770f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5078d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 50790f5c6efeSJed Brown PetscFunctionReturn(0); 50800f5c6efeSJed Brown } 5081325fc9f4SBarry Smith 50820e4ef248SJed Brown /*@C 50839ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 50840e4ef248SJed Brown 50850e4ef248SJed Brown Collective on TS 50860e4ef248SJed Brown 50870e4ef248SJed Brown Input Arguments: 50880e4ef248SJed Brown + ts - time stepping context 50890e4ef248SJed Brown . t - time at which to evaluate 50900910c330SBarry Smith . U - state at which to evaluate 50910e4ef248SJed Brown - ctx - context 50920e4ef248SJed Brown 50930e4ef248SJed Brown Output Arguments: 50940e4ef248SJed Brown . F - right hand side 50950e4ef248SJed Brown 50960e4ef248SJed Brown Level: intermediate 50970e4ef248SJed Brown 50980e4ef248SJed Brown Notes: 50990e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 51000e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 51010e4ef248SJed Brown 51020e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 51030e4ef248SJed Brown @*/ 51040910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 51050e4ef248SJed Brown { 51060e4ef248SJed Brown PetscErrorCode ierr; 51070e4ef248SJed Brown Mat Arhs,Brhs; 51080e4ef248SJed Brown 51090e4ef248SJed Brown PetscFunctionBegin; 51100e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5111d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 51120910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 51130e4ef248SJed Brown PetscFunctionReturn(0); 51140e4ef248SJed Brown } 51150e4ef248SJed Brown 51160e4ef248SJed Brown /*@C 51170e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 51180e4ef248SJed Brown 51190e4ef248SJed Brown Collective on TS 51200e4ef248SJed Brown 51210e4ef248SJed Brown Input Arguments: 51220e4ef248SJed Brown + ts - time stepping context 51230e4ef248SJed Brown . t - time at which to evaluate 51240910c330SBarry Smith . U - state at which to evaluate 51250e4ef248SJed Brown - ctx - context 51260e4ef248SJed Brown 51270e4ef248SJed Brown Output Arguments: 51280e4ef248SJed Brown + A - pointer to operator 51290e4ef248SJed Brown . B - pointer to preconditioning matrix 51300e4ef248SJed Brown - flg - matrix structure flag 51310e4ef248SJed Brown 51320e4ef248SJed Brown Level: intermediate 51330e4ef248SJed Brown 51340e4ef248SJed Brown Notes: 51350e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 51360e4ef248SJed Brown 51370e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 51380e4ef248SJed Brown @*/ 5139d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 51400e4ef248SJed Brown { 51410e4ef248SJed Brown PetscFunctionBegin; 51420e4ef248SJed Brown PetscFunctionReturn(0); 51430e4ef248SJed Brown } 51440e4ef248SJed Brown 51450026cea9SSean Farley /*@C 51460026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 51470026cea9SSean Farley 51480026cea9SSean Farley Collective on TS 51490026cea9SSean Farley 51500026cea9SSean Farley Input Arguments: 51510026cea9SSean Farley + ts - time stepping context 51520026cea9SSean Farley . t - time at which to evaluate 51530910c330SBarry Smith . U - state at which to evaluate 51540910c330SBarry Smith . Udot - time derivative of state vector 51550026cea9SSean Farley - ctx - context 51560026cea9SSean Farley 51570026cea9SSean Farley Output Arguments: 51580026cea9SSean Farley . F - left hand side 51590026cea9SSean Farley 51600026cea9SSean Farley Level: intermediate 51610026cea9SSean Farley 51620026cea9SSean Farley Notes: 51630910c330SBarry 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 51640026cea9SSean Farley user is required to write their own TSComputeIFunction. 51650026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 51660026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 51670026cea9SSean Farley 51689ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 51699ae8fd06SBarry Smith 51709ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 51710026cea9SSean Farley @*/ 51720910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 51730026cea9SSean Farley { 51740026cea9SSean Farley PetscErrorCode ierr; 51750026cea9SSean Farley Mat A,B; 51760026cea9SSean Farley 51770026cea9SSean Farley PetscFunctionBegin; 51780298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5179d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 51800910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 51810026cea9SSean Farley PetscFunctionReturn(0); 51820026cea9SSean Farley } 51830026cea9SSean Farley 51840026cea9SSean Farley /*@C 5185b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 51860026cea9SSean Farley 51870026cea9SSean Farley Collective on TS 51880026cea9SSean Farley 51890026cea9SSean Farley Input Arguments: 51900026cea9SSean Farley + ts - time stepping context 51910026cea9SSean Farley . t - time at which to evaluate 51920910c330SBarry Smith . U - state at which to evaluate 51930910c330SBarry Smith . Udot - time derivative of state vector 51940026cea9SSean Farley . shift - shift to apply 51950026cea9SSean Farley - ctx - context 51960026cea9SSean Farley 51970026cea9SSean Farley Output Arguments: 51980026cea9SSean Farley + A - pointer to operator 51990026cea9SSean Farley . B - pointer to preconditioning matrix 52000026cea9SSean Farley - flg - matrix structure flag 52010026cea9SSean Farley 5202b41af12eSJed Brown Level: advanced 52030026cea9SSean Farley 52040026cea9SSean Farley Notes: 52050026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 52060026cea9SSean Farley 5207b41af12eSJed Brown It is only appropriate for problems of the form 5208b41af12eSJed Brown 5209b41af12eSJed Brown $ M Udot = F(U,t) 5210b41af12eSJed Brown 5211b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5212b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5213b41af12eSJed Brown an implicit operator of the form 5214b41af12eSJed Brown 5215b41af12eSJed Brown $ shift*M + J 5216b41af12eSJed Brown 5217b41af12eSJed 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 5218b41af12eSJed Brown a copy of M or reassemble it when requested. 5219b41af12eSJed Brown 52200026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 52210026cea9SSean Farley @*/ 5222d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 52230026cea9SSean Farley { 5224b41af12eSJed Brown PetscErrorCode ierr; 5225b41af12eSJed Brown 52260026cea9SSean Farley PetscFunctionBegin; 522794ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5228b41af12eSJed Brown ts->ijacobian.shift = shift; 52290026cea9SSean Farley PetscFunctionReturn(0); 52300026cea9SSean Farley } 5231b41af12eSJed Brown 5232e817cc15SEmil Constantinescu /*@ 5233e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 5234e817cc15SEmil Constantinescu 5235e817cc15SEmil Constantinescu Not Collective 5236e817cc15SEmil Constantinescu 5237e817cc15SEmil Constantinescu Input Parameter: 5238e817cc15SEmil Constantinescu . ts - the TS context 5239e817cc15SEmil Constantinescu 5240e817cc15SEmil Constantinescu Output Parameter: 52414e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 5242e817cc15SEmil Constantinescu 5243e817cc15SEmil Constantinescu Level: beginner 5244e817cc15SEmil Constantinescu 5245e817cc15SEmil Constantinescu .keywords: TS, equation type 5246e817cc15SEmil Constantinescu 5247e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 5248e817cc15SEmil Constantinescu @*/ 5249e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5250e817cc15SEmil Constantinescu { 5251e817cc15SEmil Constantinescu PetscFunctionBegin; 5252e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5253e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 5254e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 5255e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5256e817cc15SEmil Constantinescu } 5257e817cc15SEmil Constantinescu 5258e817cc15SEmil Constantinescu /*@ 5259e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 5260e817cc15SEmil Constantinescu 5261e817cc15SEmil Constantinescu Not Collective 5262e817cc15SEmil Constantinescu 5263e817cc15SEmil Constantinescu Input Parameter: 5264e817cc15SEmil Constantinescu + ts - the TS context 52651297b224SEmil Constantinescu - equation_type - see TSEquationType 5266e817cc15SEmil Constantinescu 5267e817cc15SEmil Constantinescu Level: advanced 5268e817cc15SEmil Constantinescu 5269e817cc15SEmil Constantinescu .keywords: TS, equation type 5270e817cc15SEmil Constantinescu 5271e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 5272e817cc15SEmil Constantinescu @*/ 5273e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5274e817cc15SEmil Constantinescu { 5275e817cc15SEmil Constantinescu PetscFunctionBegin; 5276e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5277e817cc15SEmil Constantinescu ts->equation_type = equation_type; 5278e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5279e817cc15SEmil Constantinescu } 52800026cea9SSean Farley 52814af1b03aSJed Brown /*@ 52824af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 52834af1b03aSJed Brown 52844af1b03aSJed Brown Not Collective 52854af1b03aSJed Brown 52864af1b03aSJed Brown Input Parameter: 52874af1b03aSJed Brown . ts - the TS context 52884af1b03aSJed Brown 52894af1b03aSJed Brown Output Parameter: 52904af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 52914af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 52924af1b03aSJed Brown 5293487e0bb9SJed Brown Level: beginner 52944af1b03aSJed Brown 5295cd652676SJed Brown Notes: 5296cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 52974af1b03aSJed Brown 52984af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 52994af1b03aSJed Brown 53004af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 53014af1b03aSJed Brown @*/ 53024af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 53034af1b03aSJed Brown { 53044af1b03aSJed Brown PetscFunctionBegin; 53054af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53064af1b03aSJed Brown PetscValidPointer(reason,2); 53074af1b03aSJed Brown *reason = ts->reason; 53084af1b03aSJed Brown PetscFunctionReturn(0); 53094af1b03aSJed Brown } 53104af1b03aSJed Brown 5311d6ad946cSShri Abhyankar /*@ 5312d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5313d6ad946cSShri Abhyankar 5314d6ad946cSShri Abhyankar Not Collective 5315d6ad946cSShri Abhyankar 5316d6ad946cSShri Abhyankar Input Parameter: 5317d6ad946cSShri Abhyankar + ts - the TS context 5318d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5319d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5320d6ad946cSShri Abhyankar 5321f5abba47SShri Abhyankar Level: advanced 5322d6ad946cSShri Abhyankar 5323d6ad946cSShri Abhyankar Notes: 5324d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 5325d6ad946cSShri Abhyankar 5326d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 5327d6ad946cSShri Abhyankar 5328d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5329d6ad946cSShri Abhyankar @*/ 5330d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5331d6ad946cSShri Abhyankar { 5332d6ad946cSShri Abhyankar PetscFunctionBegin; 5333d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5334d6ad946cSShri Abhyankar ts->reason = reason; 5335d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5336d6ad946cSShri Abhyankar } 5337d6ad946cSShri Abhyankar 5338cc708dedSBarry Smith /*@ 5339cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5340cc708dedSBarry Smith 5341cc708dedSBarry Smith Not Collective 5342cc708dedSBarry Smith 5343cc708dedSBarry Smith Input Parameter: 5344cc708dedSBarry Smith . ts - the TS context 5345cc708dedSBarry Smith 5346cc708dedSBarry Smith Output Parameter: 534763e21af5SBarry Smith . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5348cc708dedSBarry Smith 5349487e0bb9SJed Brown Level: beginner 5350cc708dedSBarry Smith 5351cc708dedSBarry Smith Notes: 5352cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5353cc708dedSBarry Smith 5354cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 5355cc708dedSBarry Smith 5356cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5357cc708dedSBarry Smith @*/ 5358cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5359cc708dedSBarry Smith { 5360cc708dedSBarry Smith PetscFunctionBegin; 5361cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5362cc708dedSBarry Smith PetscValidPointer(ftime,2); 5363cc708dedSBarry Smith *ftime = ts->solvetime; 5364cc708dedSBarry Smith PetscFunctionReturn(0); 5365cc708dedSBarry Smith } 5366cc708dedSBarry Smith 53672c18e0fdSBarry Smith /*@ 53682c18e0fdSBarry Smith TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 53692c18e0fdSBarry Smith 53702c18e0fdSBarry Smith Not Collective 53712c18e0fdSBarry Smith 53722c18e0fdSBarry Smith Input Parameter: 53732c18e0fdSBarry Smith . ts - the TS context 53742c18e0fdSBarry Smith 53752c18e0fdSBarry Smith Output Parameter: 53762c18e0fdSBarry Smith . steps - the number of steps 53772c18e0fdSBarry Smith 53782c18e0fdSBarry Smith Level: beginner 53792c18e0fdSBarry Smith 53802c18e0fdSBarry Smith Notes: 53812c18e0fdSBarry Smith Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 53822c18e0fdSBarry Smith 53832c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test 53842c18e0fdSBarry Smith 53852c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 53862c18e0fdSBarry Smith @*/ 53872c18e0fdSBarry Smith PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 53882c18e0fdSBarry Smith { 53892c18e0fdSBarry Smith PetscFunctionBegin; 53902c18e0fdSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53912c18e0fdSBarry Smith PetscValidPointer(steps,2); 53922c18e0fdSBarry Smith *steps = ts->total_steps; 53932c18e0fdSBarry Smith PetscFunctionReturn(0); 53942c18e0fdSBarry Smith } 53952c18e0fdSBarry Smith 53969f67acb7SJed Brown /*@ 53975ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 53989f67acb7SJed Brown used by the time integrator. 53999f67acb7SJed Brown 54009f67acb7SJed Brown Not Collective 54019f67acb7SJed Brown 54029f67acb7SJed Brown Input Parameter: 54039f67acb7SJed Brown . ts - TS context 54049f67acb7SJed Brown 54059f67acb7SJed Brown Output Parameter: 54069f67acb7SJed Brown . nits - number of nonlinear iterations 54079f67acb7SJed Brown 54089f67acb7SJed Brown Notes: 54099f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54109f67acb7SJed Brown 54119f67acb7SJed Brown Level: intermediate 54129f67acb7SJed Brown 54139f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 54149f67acb7SJed Brown 54155ef26d82SJed Brown .seealso: TSGetKSPIterations() 54169f67acb7SJed Brown @*/ 54175ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 54189f67acb7SJed Brown { 54199f67acb7SJed Brown PetscFunctionBegin; 54209f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54219f67acb7SJed Brown PetscValidIntPointer(nits,2); 54225ef26d82SJed Brown *nits = ts->snes_its; 54239f67acb7SJed Brown PetscFunctionReturn(0); 54249f67acb7SJed Brown } 54259f67acb7SJed Brown 54269f67acb7SJed Brown /*@ 54275ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 54289f67acb7SJed Brown used by the time integrator. 54299f67acb7SJed Brown 54309f67acb7SJed Brown Not Collective 54319f67acb7SJed Brown 54329f67acb7SJed Brown Input Parameter: 54339f67acb7SJed Brown . ts - TS context 54349f67acb7SJed Brown 54359f67acb7SJed Brown Output Parameter: 54369f67acb7SJed Brown . lits - number of linear iterations 54379f67acb7SJed Brown 54389f67acb7SJed Brown Notes: 54399f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54409f67acb7SJed Brown 54419f67acb7SJed Brown Level: intermediate 54429f67acb7SJed Brown 54439f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 54449f67acb7SJed Brown 54455ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 54469f67acb7SJed Brown @*/ 54475ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 54489f67acb7SJed Brown { 54499f67acb7SJed Brown PetscFunctionBegin; 54509f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54519f67acb7SJed Brown PetscValidIntPointer(lits,2); 54525ef26d82SJed Brown *lits = ts->ksp_its; 54539f67acb7SJed Brown PetscFunctionReturn(0); 54549f67acb7SJed Brown } 54559f67acb7SJed Brown 5456cef5090cSJed Brown /*@ 5457cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5458cef5090cSJed Brown 5459cef5090cSJed Brown Not Collective 5460cef5090cSJed Brown 5461cef5090cSJed Brown Input Parameter: 5462cef5090cSJed Brown . ts - TS context 5463cef5090cSJed Brown 5464cef5090cSJed Brown Output Parameter: 5465cef5090cSJed Brown . rejects - number of steps rejected 5466cef5090cSJed Brown 5467cef5090cSJed Brown Notes: 5468cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5469cef5090cSJed Brown 5470cef5090cSJed Brown Level: intermediate 5471cef5090cSJed Brown 5472cef5090cSJed Brown .keywords: TS, get, number 5473cef5090cSJed Brown 54745ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5475cef5090cSJed Brown @*/ 5476cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5477cef5090cSJed Brown { 5478cef5090cSJed Brown PetscFunctionBegin; 5479cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5480cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5481cef5090cSJed Brown *rejects = ts->reject; 5482cef5090cSJed Brown PetscFunctionReturn(0); 5483cef5090cSJed Brown } 5484cef5090cSJed Brown 5485cef5090cSJed Brown /*@ 5486cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5487cef5090cSJed Brown 5488cef5090cSJed Brown Not Collective 5489cef5090cSJed Brown 5490cef5090cSJed Brown Input Parameter: 5491cef5090cSJed Brown . ts - TS context 5492cef5090cSJed Brown 5493cef5090cSJed Brown Output Parameter: 5494cef5090cSJed Brown . fails - number of failed nonlinear solves 5495cef5090cSJed Brown 5496cef5090cSJed Brown Notes: 5497cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5498cef5090cSJed Brown 5499cef5090cSJed Brown Level: intermediate 5500cef5090cSJed Brown 5501cef5090cSJed Brown .keywords: TS, get, number 5502cef5090cSJed Brown 55035ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5504cef5090cSJed Brown @*/ 5505cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5506cef5090cSJed Brown { 5507cef5090cSJed Brown PetscFunctionBegin; 5508cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5509cef5090cSJed Brown PetscValidIntPointer(fails,2); 5510cef5090cSJed Brown *fails = ts->num_snes_failures; 5511cef5090cSJed Brown PetscFunctionReturn(0); 5512cef5090cSJed Brown } 5513cef5090cSJed Brown 5514cef5090cSJed Brown /*@ 5515cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5516cef5090cSJed Brown 5517cef5090cSJed Brown Not Collective 5518cef5090cSJed Brown 5519cef5090cSJed Brown Input Parameter: 5520cef5090cSJed Brown + ts - TS context 5521cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5522cef5090cSJed Brown 5523cef5090cSJed Brown Notes: 5524cef5090cSJed Brown The counter is reset to zero for each step 5525cef5090cSJed Brown 5526cef5090cSJed Brown Options Database Key: 5527cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5528cef5090cSJed Brown 5529cef5090cSJed Brown Level: intermediate 5530cef5090cSJed Brown 5531cef5090cSJed Brown .keywords: TS, set, maximum, number 5532cef5090cSJed Brown 55335ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5534cef5090cSJed Brown @*/ 5535cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5536cef5090cSJed Brown { 5537cef5090cSJed Brown PetscFunctionBegin; 5538cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5539cef5090cSJed Brown ts->max_reject = rejects; 5540cef5090cSJed Brown PetscFunctionReturn(0); 5541cef5090cSJed Brown } 5542cef5090cSJed Brown 5543cef5090cSJed Brown /*@ 5544cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5545cef5090cSJed Brown 5546cef5090cSJed Brown Not Collective 5547cef5090cSJed Brown 5548cef5090cSJed Brown Input Parameter: 5549cef5090cSJed Brown + ts - TS context 5550cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5551cef5090cSJed Brown 5552cef5090cSJed Brown Notes: 5553cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5554cef5090cSJed Brown 5555cef5090cSJed Brown Options Database Key: 5556cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5557cef5090cSJed Brown 5558cef5090cSJed Brown Level: intermediate 5559cef5090cSJed Brown 5560cef5090cSJed Brown .keywords: TS, set, maximum, number 5561cef5090cSJed Brown 55625ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5563cef5090cSJed Brown @*/ 5564cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5565cef5090cSJed Brown { 5566cef5090cSJed Brown PetscFunctionBegin; 5567cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5568cef5090cSJed Brown ts->max_snes_failures = fails; 5569cef5090cSJed Brown PetscFunctionReturn(0); 5570cef5090cSJed Brown } 5571cef5090cSJed Brown 5572cef5090cSJed Brown /*@ 5573cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5574cef5090cSJed Brown 5575cef5090cSJed Brown Not Collective 5576cef5090cSJed Brown 5577cef5090cSJed Brown Input Parameter: 5578cef5090cSJed Brown + ts - TS context 5579cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5580cef5090cSJed Brown 5581cef5090cSJed Brown Options Database Key: 5582cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5583cef5090cSJed Brown 5584cef5090cSJed Brown Level: intermediate 5585cef5090cSJed Brown 5586cef5090cSJed Brown .keywords: TS, set, error 5587cef5090cSJed Brown 55885ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5589cef5090cSJed Brown @*/ 5590cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5591cef5090cSJed Brown { 5592cef5090cSJed Brown PetscFunctionBegin; 5593cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5594cef5090cSJed Brown ts->errorifstepfailed = err; 5595cef5090cSJed Brown PetscFunctionReturn(0); 5596cef5090cSJed Brown } 5597cef5090cSJed Brown 5598fb1732b5SBarry Smith /*@C 5599fde5950dSBarry Smith TSMonitorSolution - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file or a PetscDraw object 5600fb1732b5SBarry Smith 5601fb1732b5SBarry Smith Collective on TS 5602fb1732b5SBarry Smith 5603fb1732b5SBarry Smith Input Parameters: 5604fb1732b5SBarry Smith + ts - the TS context 5605fb1732b5SBarry Smith . step - current time-step 5606fb1732b5SBarry Smith . ptime - current time 56070910c330SBarry Smith . u - current state 5608721cd6eeSBarry Smith - vf - viewer and its format 5609fb1732b5SBarry Smith 5610fb1732b5SBarry Smith Level: intermediate 5611fb1732b5SBarry Smith 5612fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5613fb1732b5SBarry Smith 5614fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5615fb1732b5SBarry Smith @*/ 5616721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5617fb1732b5SBarry Smith { 5618fb1732b5SBarry Smith PetscErrorCode ierr; 5619fb1732b5SBarry Smith 5620fb1732b5SBarry Smith PetscFunctionBegin; 5621721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5622721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5623721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5624ed81e22dSJed Brown PetscFunctionReturn(0); 5625ed81e22dSJed Brown } 5626ed81e22dSJed Brown 5627ed81e22dSJed Brown /*@C 5628ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5629ed81e22dSJed Brown 5630ed81e22dSJed Brown Collective on TS 5631ed81e22dSJed Brown 5632ed81e22dSJed Brown Input Parameters: 5633ed81e22dSJed Brown + ts - the TS context 5634ed81e22dSJed Brown . step - current time-step 5635ed81e22dSJed Brown . ptime - current time 56360910c330SBarry Smith . u - current state 5637ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5638ed81e22dSJed Brown 5639ed81e22dSJed Brown Level: intermediate 5640ed81e22dSJed Brown 5641ed81e22dSJed Brown Notes: 5642ed81e22dSJed 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. 5643ed81e22dSJed Brown These are named according to the file name template. 5644ed81e22dSJed Brown 5645ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5646ed81e22dSJed Brown 5647ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5648ed81e22dSJed Brown 5649ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5650ed81e22dSJed Brown @*/ 56510910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5652ed81e22dSJed Brown { 5653ed81e22dSJed Brown PetscErrorCode ierr; 5654ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5655ed81e22dSJed Brown PetscViewer viewer; 5656ed81e22dSJed Brown 5657ed81e22dSJed Brown PetscFunctionBegin; 565863e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 56598caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5660ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 56610910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5662ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5663ed81e22dSJed Brown PetscFunctionReturn(0); 5664ed81e22dSJed Brown } 5665ed81e22dSJed Brown 5666ed81e22dSJed Brown /*@C 5667ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5668ed81e22dSJed Brown 5669ed81e22dSJed Brown Collective on TS 5670ed81e22dSJed Brown 5671ed81e22dSJed Brown Input Parameters: 5672ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5673ed81e22dSJed Brown 5674ed81e22dSJed Brown Level: intermediate 5675ed81e22dSJed Brown 5676ed81e22dSJed Brown Note: 5677ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5678ed81e22dSJed Brown 5679ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5680ed81e22dSJed Brown 5681ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5682ed81e22dSJed Brown @*/ 5683ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5684ed81e22dSJed Brown { 5685ed81e22dSJed Brown PetscErrorCode ierr; 5686ed81e22dSJed Brown 5687ed81e22dSJed Brown PetscFunctionBegin; 5688ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5689fb1732b5SBarry Smith PetscFunctionReturn(0); 5690fb1732b5SBarry Smith } 5691fb1732b5SBarry Smith 569284df9cb4SJed Brown /*@ 5693552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 569484df9cb4SJed Brown 5695ed81e22dSJed Brown Collective on TS if controller has not been created yet 569684df9cb4SJed Brown 569784df9cb4SJed Brown Input Arguments: 5698ed81e22dSJed Brown . ts - time stepping context 569984df9cb4SJed Brown 570084df9cb4SJed Brown Output Arguments: 5701ed81e22dSJed Brown . adapt - adaptive controller 570284df9cb4SJed Brown 570384df9cb4SJed Brown Level: intermediate 570484df9cb4SJed Brown 5705ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 570684df9cb4SJed Brown @*/ 5707552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 570884df9cb4SJed Brown { 570984df9cb4SJed Brown PetscErrorCode ierr; 571084df9cb4SJed Brown 571184df9cb4SJed Brown PetscFunctionBegin; 571284df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5713bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 571484df9cb4SJed Brown if (!ts->adapt) { 5715ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 57163bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 57171c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 571884df9cb4SJed Brown } 5719bec58848SLisandro Dalcin *adapt = ts->adapt; 572084df9cb4SJed Brown PetscFunctionReturn(0); 572184df9cb4SJed Brown } 5722d6ebe24aSShri Abhyankar 57231c3436cfSJed Brown /*@ 57241c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 57251c3436cfSJed Brown 57261c3436cfSJed Brown Logically Collective 57271c3436cfSJed Brown 57281c3436cfSJed Brown Input Arguments: 57291c3436cfSJed Brown + ts - time integration context 57301c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 57310298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 57321c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 57330298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 57341c3436cfSJed Brown 5735a3cdaa26SBarry Smith Options Database keys: 5736a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5737a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5738a3cdaa26SBarry Smith 57393ff766beSShri Abhyankar Notes: 57403ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 57413ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 57423ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 57433ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 57443ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 57453ff766beSShri Abhyankar differential variables. 57463ff766beSShri Abhyankar 57471c3436cfSJed Brown Level: beginner 57481c3436cfSJed Brown 5749c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 57501c3436cfSJed Brown @*/ 57511c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 57521c3436cfSJed Brown { 57531c3436cfSJed Brown PetscErrorCode ierr; 57541c3436cfSJed Brown 57551c3436cfSJed Brown PetscFunctionBegin; 5756c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 57571c3436cfSJed Brown if (vatol) { 57581c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 57591c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 57601c3436cfSJed Brown ts->vatol = vatol; 57611c3436cfSJed Brown } 5762c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 57631c3436cfSJed Brown if (vrtol) { 57641c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 57651c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 57661c3436cfSJed Brown ts->vrtol = vrtol; 57671c3436cfSJed Brown } 57681c3436cfSJed Brown PetscFunctionReturn(0); 57691c3436cfSJed Brown } 57701c3436cfSJed Brown 5771c5033834SJed Brown /*@ 5772c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5773c5033834SJed Brown 5774c5033834SJed Brown Logically Collective 5775c5033834SJed Brown 5776c5033834SJed Brown Input Arguments: 5777c5033834SJed Brown . ts - time integration context 5778c5033834SJed Brown 5779c5033834SJed Brown Output Arguments: 57800298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 57810298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 57820298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 57830298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5784c5033834SJed Brown 5785c5033834SJed Brown Level: beginner 5786c5033834SJed Brown 5787c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5788c5033834SJed Brown @*/ 5789c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5790c5033834SJed Brown { 5791c5033834SJed Brown PetscFunctionBegin; 5792c5033834SJed Brown if (atol) *atol = ts->atol; 5793c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5794c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5795c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5796c5033834SJed Brown PetscFunctionReturn(0); 5797c5033834SJed Brown } 5798c5033834SJed Brown 57999c6b16b5SShri Abhyankar /*@ 5800a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 58019c6b16b5SShri Abhyankar 58029c6b16b5SShri Abhyankar Collective on TS 58039c6b16b5SShri Abhyankar 58049c6b16b5SShri Abhyankar Input Arguments: 58059c6b16b5SShri Abhyankar + ts - time stepping context 5806a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5807a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 58089c6b16b5SShri Abhyankar 58099c6b16b5SShri Abhyankar Output Arguments: 58107453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58117453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 58127453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58139c6b16b5SShri Abhyankar 58149c6b16b5SShri Abhyankar Level: developer 58159c6b16b5SShri Abhyankar 5816deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 58179c6b16b5SShri Abhyankar @*/ 58187453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58199c6b16b5SShri Abhyankar { 58209c6b16b5SShri Abhyankar PetscErrorCode ierr; 58219c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 58227453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 58237453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 58249c6b16b5SShri Abhyankar const PetscScalar *u,*y; 58257453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 58267453f775SEmil Constantinescu PetscReal tol,tola,tolr; 58277453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 58289c6b16b5SShri Abhyankar 58299c6b16b5SShri Abhyankar PetscFunctionBegin; 58309c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5831a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5832a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5833a4868fbcSLisandro Dalcin PetscValidType(U,2); 5834a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5835a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5836a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 58378a175baeSEmil Constantinescu PetscValidPointer(norma,5); 58388a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5839a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 58409c6b16b5SShri Abhyankar 58419c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 58429c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 58439c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 58449c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 58459c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 58467453f775SEmil Constantinescu sum = 0.; n_loc = 0; 58477453f775SEmil Constantinescu suma = 0.; na_loc = 0; 58487453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 58499c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 58509c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 58519c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58529c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58539c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58547453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58557453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 58567453f775SEmil Constantinescu if(tola>0.){ 58577453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58587453f775SEmil Constantinescu na_loc++; 58597453f775SEmil Constantinescu } 58607453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58617453f775SEmil Constantinescu if(tolr>0.){ 58627453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58637453f775SEmil Constantinescu nr_loc++; 58647453f775SEmil Constantinescu } 58657453f775SEmil Constantinescu tol=tola+tolr; 58667453f775SEmil Constantinescu if(tol>0.){ 58677453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58687453f775SEmil Constantinescu n_loc++; 58697453f775SEmil Constantinescu } 58709c6b16b5SShri Abhyankar } 58719c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58729c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58739c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 58749c6b16b5SShri Abhyankar const PetscScalar *atol; 58759c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58769c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58777453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58787453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 58797453f775SEmil Constantinescu if(tola>0.){ 58807453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58817453f775SEmil Constantinescu na_loc++; 58827453f775SEmil Constantinescu } 58837453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58847453f775SEmil Constantinescu if(tolr>0.){ 58857453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58867453f775SEmil Constantinescu nr_loc++; 58877453f775SEmil Constantinescu } 58887453f775SEmil Constantinescu tol=tola+tolr; 58897453f775SEmil Constantinescu if(tol>0.){ 58907453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58917453f775SEmil Constantinescu n_loc++; 58927453f775SEmil Constantinescu } 58939c6b16b5SShri Abhyankar } 58949c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58959c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 58969c6b16b5SShri Abhyankar const PetscScalar *rtol; 58979c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58989c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58997453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59007453f775SEmil Constantinescu tola = ts->atol; 59017453f775SEmil Constantinescu if(tola>0.){ 59027453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59037453f775SEmil Constantinescu na_loc++; 59047453f775SEmil Constantinescu } 59057453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59067453f775SEmil Constantinescu if(tolr>0.){ 59077453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59087453f775SEmil Constantinescu nr_loc++; 59097453f775SEmil Constantinescu } 59107453f775SEmil Constantinescu tol=tola+tolr; 59117453f775SEmil Constantinescu if(tol>0.){ 59127453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59137453f775SEmil Constantinescu n_loc++; 59147453f775SEmil Constantinescu } 59159c6b16b5SShri Abhyankar } 59169c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59179c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 59189c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59197453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59207453f775SEmil Constantinescu tola = ts->atol; 59217453f775SEmil Constantinescu if(tola>0.){ 59227453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59237453f775SEmil Constantinescu na_loc++; 59247453f775SEmil Constantinescu } 59257453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59267453f775SEmil Constantinescu if(tolr>0.){ 59277453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59287453f775SEmil Constantinescu nr_loc++; 59297453f775SEmil Constantinescu } 59307453f775SEmil Constantinescu tol=tola+tolr; 59317453f775SEmil Constantinescu if(tol>0.){ 59327453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59337453f775SEmil Constantinescu n_loc++; 59347453f775SEmil Constantinescu } 59359c6b16b5SShri Abhyankar } 59369c6b16b5SShri Abhyankar } 59379c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 59389c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 59399c6b16b5SShri Abhyankar 59407453f775SEmil Constantinescu err_loc[0] = sum; 59417453f775SEmil Constantinescu err_loc[1] = suma; 59427453f775SEmil Constantinescu err_loc[2] = sumr; 59437453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 59447453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 59457453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 59467453f775SEmil Constantinescu 5947a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 59487453f775SEmil Constantinescu 59497453f775SEmil Constantinescu gsum = err_glb[0]; 59507453f775SEmil Constantinescu gsuma = err_glb[1]; 59517453f775SEmil Constantinescu gsumr = err_glb[2]; 59527453f775SEmil Constantinescu n_glb = err_glb[3]; 59537453f775SEmil Constantinescu na_glb = err_glb[4]; 59547453f775SEmil Constantinescu nr_glb = err_glb[5]; 59557453f775SEmil Constantinescu 5956b1316ef9SEmil Constantinescu *norm = 0.; 5957b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 5958b1316ef9SEmil Constantinescu *norma = 0.; 5959b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5960b1316ef9SEmil Constantinescu *normr = 0.; 5961b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 59629c6b16b5SShri Abhyankar 59639c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 59647453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 59657453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 59669c6b16b5SShri Abhyankar PetscFunctionReturn(0); 59679c6b16b5SShri Abhyankar } 59689c6b16b5SShri Abhyankar 59699c6b16b5SShri Abhyankar /*@ 5970a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 59719c6b16b5SShri Abhyankar 59729c6b16b5SShri Abhyankar Collective on TS 59739c6b16b5SShri Abhyankar 59749c6b16b5SShri Abhyankar Input Arguments: 59759c6b16b5SShri Abhyankar + ts - time stepping context 5976a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5977a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 59789c6b16b5SShri Abhyankar 59799c6b16b5SShri Abhyankar Output Arguments: 59807453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 59817453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 59827453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 59839c6b16b5SShri Abhyankar 59849c6b16b5SShri Abhyankar Level: developer 59859c6b16b5SShri Abhyankar 5986deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 59879c6b16b5SShri Abhyankar @*/ 59887453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 59899c6b16b5SShri Abhyankar { 59909c6b16b5SShri Abhyankar PetscErrorCode ierr; 59917453f775SEmil Constantinescu PetscInt i,n,N,rstart; 59929c6b16b5SShri Abhyankar const PetscScalar *u,*y; 59937453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 59947453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 59957453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 59969c6b16b5SShri Abhyankar 59979c6b16b5SShri Abhyankar PetscFunctionBegin; 59989c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5999a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 6000a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 6001a4868fbcSLisandro Dalcin PetscValidType(U,2); 6002a4868fbcSLisandro Dalcin PetscValidType(Y,3); 6003a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 6004a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 60058a175baeSEmil Constantinescu PetscValidPointer(norma,5); 60068a175baeSEmil Constantinescu PetscValidPointer(normr,6); 6007a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 60089c6b16b5SShri Abhyankar 60099c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 60109c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 60119c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 60129c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 60139c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 60147453f775SEmil Constantinescu 60157453f775SEmil Constantinescu max=0.; 60167453f775SEmil Constantinescu maxa=0.; 60177453f775SEmil Constantinescu maxr=0.; 60187453f775SEmil Constantinescu 60197453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 60209c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 60219c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60229c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60237453f775SEmil Constantinescu 60247453f775SEmil Constantinescu for (i=0; i<n; i++) { 60257453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60267453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60277453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60287453f775SEmil Constantinescu tol = tola+tolr; 60297453f775SEmil Constantinescu if(tola>0.){ 60307453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60317453f775SEmil Constantinescu } 60327453f775SEmil Constantinescu if(tolr>0.){ 60337453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60347453f775SEmil Constantinescu } 60357453f775SEmil Constantinescu if(tol>0.){ 60367453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60377453f775SEmil Constantinescu } 60389c6b16b5SShri Abhyankar } 60399c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60409c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60419c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 60429c6b16b5SShri Abhyankar const PetscScalar *atol; 60439c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60447453f775SEmil Constantinescu for (i=0; i<n; i++) { 60457453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60467453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60477453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60487453f775SEmil Constantinescu tol = tola+tolr; 60497453f775SEmil Constantinescu if(tola>0.){ 60507453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60517453f775SEmil Constantinescu } 60527453f775SEmil Constantinescu if(tolr>0.){ 60537453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60547453f775SEmil Constantinescu } 60557453f775SEmil Constantinescu if(tol>0.){ 60567453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60577453f775SEmil Constantinescu } 60589c6b16b5SShri Abhyankar } 60599c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60609c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 60619c6b16b5SShri Abhyankar const PetscScalar *rtol; 60629c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60637453f775SEmil Constantinescu 60647453f775SEmil Constantinescu for (i=0; i<n; i++) { 60657453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60667453f775SEmil Constantinescu tola = ts->atol; 60677453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60687453f775SEmil Constantinescu tol = tola+tolr; 60697453f775SEmil Constantinescu if(tola>0.){ 60707453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60717453f775SEmil Constantinescu } 60727453f775SEmil Constantinescu if(tolr>0.){ 60737453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60747453f775SEmil Constantinescu } 60757453f775SEmil Constantinescu if(tol>0.){ 60767453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60777453f775SEmil Constantinescu } 60789c6b16b5SShri Abhyankar } 60799c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60809c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 60817453f775SEmil Constantinescu 60827453f775SEmil Constantinescu for (i=0; i<n; i++) { 60837453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60847453f775SEmil Constantinescu tola = ts->atol; 60857453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60867453f775SEmil Constantinescu tol = tola+tolr; 60877453f775SEmil Constantinescu if(tola>0.){ 60887453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60897453f775SEmil Constantinescu } 60907453f775SEmil Constantinescu if(tolr>0.){ 60917453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60927453f775SEmil Constantinescu } 60937453f775SEmil Constantinescu if(tol>0.){ 60947453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60957453f775SEmil Constantinescu } 60969c6b16b5SShri Abhyankar } 60979c6b16b5SShri Abhyankar } 60989c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 60999c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 61007453f775SEmil Constantinescu err_loc[0] = max; 61017453f775SEmil Constantinescu err_loc[1] = maxa; 61027453f775SEmil Constantinescu err_loc[2] = maxr; 6103a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 61047453f775SEmil Constantinescu gmax = err_glb[0]; 61057453f775SEmil Constantinescu gmaxa = err_glb[1]; 61067453f775SEmil Constantinescu gmaxr = err_glb[2]; 61079c6b16b5SShri Abhyankar 61089c6b16b5SShri Abhyankar *norm = gmax; 61097453f775SEmil Constantinescu *norma = gmaxa; 61107453f775SEmil Constantinescu *normr = gmaxr; 61119c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 61127453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 61137453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 61149c6b16b5SShri Abhyankar PetscFunctionReturn(0); 61159c6b16b5SShri Abhyankar } 61169c6b16b5SShri Abhyankar 61171c3436cfSJed Brown /*@ 61188a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 61191c3436cfSJed Brown 61201c3436cfSJed Brown Collective on TS 61211c3436cfSJed Brown 61221c3436cfSJed Brown Input Arguments: 61231c3436cfSJed Brown + ts - time stepping context 6124a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6125a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 6126a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 61277619abb3SShri 61281c3436cfSJed Brown Output Arguments: 61298a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 61308a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 61318a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 6132a4868fbcSLisandro Dalcin 6133a4868fbcSLisandro Dalcin Options Database Keys: 6134a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6135a4868fbcSLisandro Dalcin 61361c3436cfSJed Brown Level: developer 61371c3436cfSJed Brown 61388a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 61391c3436cfSJed Brown @*/ 61407453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61411c3436cfSJed Brown { 61428beabaa1SBarry Smith PetscErrorCode ierr; 61431c3436cfSJed Brown 61441c3436cfSJed Brown PetscFunctionBegin; 6145a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 61467453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6147a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 61487453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6149a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 61501c3436cfSJed Brown PetscFunctionReturn(0); 61511c3436cfSJed Brown } 61521c3436cfSJed Brown 61538a175baeSEmil Constantinescu 61548a175baeSEmil Constantinescu /*@ 61558a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 61568a175baeSEmil Constantinescu 61578a175baeSEmil Constantinescu Collective on TS 61588a175baeSEmil Constantinescu 61598a175baeSEmil Constantinescu Input Arguments: 61608a175baeSEmil Constantinescu + ts - time stepping context 61618a175baeSEmil Constantinescu . E - error vector 61628a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 61638a175baeSEmil Constantinescu - Y - state vector, previous time step 61648a175baeSEmil Constantinescu 61658a175baeSEmil Constantinescu Output Arguments: 61668a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 61678a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 61688a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 61698a175baeSEmil Constantinescu 61708a175baeSEmil Constantinescu Level: developer 61718a175baeSEmil Constantinescu 61728a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 61738a175baeSEmil Constantinescu @*/ 61748a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61758a175baeSEmil Constantinescu { 61768a175baeSEmil Constantinescu PetscErrorCode ierr; 61778a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 61788a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 61798a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 61808a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 61818a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 61828a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 61838a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 61848a175baeSEmil Constantinescu 61858a175baeSEmil Constantinescu PetscFunctionBegin; 61868a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 61878a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 61888a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 61898a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 61908a175baeSEmil Constantinescu PetscValidType(E,2); 61918a175baeSEmil Constantinescu PetscValidType(U,3); 61928a175baeSEmil Constantinescu PetscValidType(Y,4); 61938a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 61948a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 61958a175baeSEmil Constantinescu PetscValidPointer(norm,5); 61968a175baeSEmil Constantinescu PetscValidPointer(norma,6); 61978a175baeSEmil Constantinescu PetscValidPointer(normr,7); 61988a175baeSEmil Constantinescu 61998a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 62008a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 62018a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 62028a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 62038a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 62048a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 62058a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 62068a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 62078a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 62088a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 62098a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 62108a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62118a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62128a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62138a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62148a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62158a175baeSEmil Constantinescu if(tola>0.){ 62168a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62178a175baeSEmil Constantinescu na_loc++; 62188a175baeSEmil Constantinescu } 62198a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62208a175baeSEmil Constantinescu if(tolr>0.){ 62218a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62228a175baeSEmil Constantinescu nr_loc++; 62238a175baeSEmil Constantinescu } 62248a175baeSEmil Constantinescu tol=tola+tolr; 62258a175baeSEmil Constantinescu if(tol>0.){ 62268a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62278a175baeSEmil Constantinescu n_loc++; 62288a175baeSEmil Constantinescu } 62298a175baeSEmil Constantinescu } 62308a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62318a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62328a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 62338a175baeSEmil Constantinescu const PetscScalar *atol; 62348a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62358a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62368a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62378a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62388a175baeSEmil Constantinescu if(tola>0.){ 62398a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62408a175baeSEmil Constantinescu na_loc++; 62418a175baeSEmil Constantinescu } 62428a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62438a175baeSEmil Constantinescu if(tolr>0.){ 62448a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62458a175baeSEmil Constantinescu nr_loc++; 62468a175baeSEmil Constantinescu } 62478a175baeSEmil Constantinescu tol=tola+tolr; 62488a175baeSEmil Constantinescu if(tol>0.){ 62498a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62508a175baeSEmil Constantinescu n_loc++; 62518a175baeSEmil Constantinescu } 62528a175baeSEmil Constantinescu } 62538a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62548a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 62558a175baeSEmil Constantinescu const PetscScalar *rtol; 62568a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62578a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62588a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62598a175baeSEmil Constantinescu tola = ts->atol; 62608a175baeSEmil Constantinescu if(tola>0.){ 62618a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62628a175baeSEmil Constantinescu na_loc++; 62638a175baeSEmil Constantinescu } 62648a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62658a175baeSEmil Constantinescu if(tolr>0.){ 62668a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62678a175baeSEmil Constantinescu nr_loc++; 62688a175baeSEmil Constantinescu } 62698a175baeSEmil Constantinescu tol=tola+tolr; 62708a175baeSEmil Constantinescu if(tol>0.){ 62718a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62728a175baeSEmil Constantinescu n_loc++; 62738a175baeSEmil Constantinescu } 62748a175baeSEmil Constantinescu } 62758a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62768a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 62778a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62788a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62798a175baeSEmil Constantinescu tola = ts->atol; 62808a175baeSEmil Constantinescu if(tola>0.){ 62818a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62828a175baeSEmil Constantinescu na_loc++; 62838a175baeSEmil Constantinescu } 62848a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62858a175baeSEmil Constantinescu if(tolr>0.){ 62868a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62878a175baeSEmil Constantinescu nr_loc++; 62888a175baeSEmil Constantinescu } 62898a175baeSEmil Constantinescu tol=tola+tolr; 62908a175baeSEmil Constantinescu if(tol>0.){ 62918a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62928a175baeSEmil Constantinescu n_loc++; 62938a175baeSEmil Constantinescu } 62948a175baeSEmil Constantinescu } 62958a175baeSEmil Constantinescu } 62968a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 62978a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 62988a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 62998a175baeSEmil Constantinescu 63008a175baeSEmil Constantinescu err_loc[0] = sum; 63018a175baeSEmil Constantinescu err_loc[1] = suma; 63028a175baeSEmil Constantinescu err_loc[2] = sumr; 63038a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 63048a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 63058a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 63068a175baeSEmil Constantinescu 6307a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 63088a175baeSEmil Constantinescu 63098a175baeSEmil Constantinescu gsum = err_glb[0]; 63108a175baeSEmil Constantinescu gsuma = err_glb[1]; 63118a175baeSEmil Constantinescu gsumr = err_glb[2]; 63128a175baeSEmil Constantinescu n_glb = err_glb[3]; 63138a175baeSEmil Constantinescu na_glb = err_glb[4]; 63148a175baeSEmil Constantinescu nr_glb = err_glb[5]; 63158a175baeSEmil Constantinescu 63168a175baeSEmil Constantinescu *norm = 0.; 63178a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 63188a175baeSEmil Constantinescu *norma = 0.; 63198a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 63208a175baeSEmil Constantinescu *normr = 0.; 63218a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 63228a175baeSEmil Constantinescu 63238a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 63248a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 63258a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 63268a175baeSEmil Constantinescu PetscFunctionReturn(0); 63278a175baeSEmil Constantinescu } 63288a175baeSEmil Constantinescu 63298a175baeSEmil Constantinescu /*@ 63308a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 63318a175baeSEmil Constantinescu Collective on TS 63328a175baeSEmil Constantinescu 63338a175baeSEmil Constantinescu Input Arguments: 63348a175baeSEmil Constantinescu + ts - time stepping context 63358a175baeSEmil Constantinescu . E - error vector 63368a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 63378a175baeSEmil Constantinescu - Y - state vector, previous time step 63388a175baeSEmil Constantinescu 63398a175baeSEmil Constantinescu Output Arguments: 63408a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 63418a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 63428a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 63438a175baeSEmil Constantinescu 63448a175baeSEmil Constantinescu Level: developer 63458a175baeSEmil Constantinescu 63468a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 63478a175baeSEmil Constantinescu @*/ 63488a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 63498a175baeSEmil Constantinescu { 63508a175baeSEmil Constantinescu PetscErrorCode ierr; 63518a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 63528a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 63538a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 63548a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 63558a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 63568a175baeSEmil Constantinescu 63578a175baeSEmil Constantinescu PetscFunctionBegin; 63588a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 63598a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 63608a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 63618a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 63628a175baeSEmil Constantinescu PetscValidType(E,2); 63638a175baeSEmil Constantinescu PetscValidType(U,3); 63648a175baeSEmil Constantinescu PetscValidType(Y,4); 63658a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 63668a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 63678a175baeSEmil Constantinescu PetscValidPointer(norm,5); 63688a175baeSEmil Constantinescu PetscValidPointer(norma,6); 63698a175baeSEmil Constantinescu PetscValidPointer(normr,7); 63708a175baeSEmil Constantinescu 63718a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 63728a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 63738a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 63748a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 63758a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 63768a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 63778a175baeSEmil Constantinescu 63788a175baeSEmil Constantinescu max=0.; 63798a175baeSEmil Constantinescu maxa=0.; 63808a175baeSEmil Constantinescu maxr=0.; 63818a175baeSEmil Constantinescu 63828a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 63838a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 63848a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 63858a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 63868a175baeSEmil Constantinescu 63878a175baeSEmil Constantinescu for (i=0; i<n; i++) { 63888a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63898a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 63908a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63918a175baeSEmil Constantinescu tol = tola+tolr; 63928a175baeSEmil Constantinescu if(tola>0.){ 63938a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 63948a175baeSEmil Constantinescu } 63958a175baeSEmil Constantinescu if(tolr>0.){ 63968a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 63978a175baeSEmil Constantinescu } 63988a175baeSEmil Constantinescu if(tol>0.){ 63998a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64008a175baeSEmil Constantinescu } 64018a175baeSEmil Constantinescu } 64028a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64038a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64048a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 64058a175baeSEmil Constantinescu const PetscScalar *atol; 64068a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64078a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64088a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64098a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64108a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64118a175baeSEmil Constantinescu tol = tola+tolr; 64128a175baeSEmil Constantinescu if(tola>0.){ 64138a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64148a175baeSEmil Constantinescu } 64158a175baeSEmil Constantinescu if(tolr>0.){ 64168a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64178a175baeSEmil Constantinescu } 64188a175baeSEmil Constantinescu if(tol>0.){ 64198a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64208a175baeSEmil Constantinescu } 64218a175baeSEmil Constantinescu } 64228a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64238a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 64248a175baeSEmil Constantinescu const PetscScalar *rtol; 64258a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64268a175baeSEmil Constantinescu 64278a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64288a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64298a175baeSEmil Constantinescu tola = ts->atol; 64308a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64318a175baeSEmil Constantinescu tol = tola+tolr; 64328a175baeSEmil Constantinescu if(tola>0.){ 64338a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64348a175baeSEmil Constantinescu } 64358a175baeSEmil Constantinescu if(tolr>0.){ 64368a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64378a175baeSEmil Constantinescu } 64388a175baeSEmil Constantinescu if(tol>0.){ 64398a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64408a175baeSEmil Constantinescu } 64418a175baeSEmil Constantinescu } 64428a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64438a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 64448a175baeSEmil Constantinescu 64458a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64468a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64478a175baeSEmil Constantinescu tola = ts->atol; 64488a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64498a175baeSEmil Constantinescu tol = tola+tolr; 64508a175baeSEmil Constantinescu if(tola>0.){ 64518a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64528a175baeSEmil Constantinescu } 64538a175baeSEmil Constantinescu if(tolr>0.){ 64548a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64558a175baeSEmil Constantinescu } 64568a175baeSEmil Constantinescu if(tol>0.){ 64578a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64588a175baeSEmil Constantinescu } 64598a175baeSEmil Constantinescu } 64608a175baeSEmil Constantinescu } 64618a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 64628a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 64638a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 64648a175baeSEmil Constantinescu err_loc[0] = max; 64658a175baeSEmil Constantinescu err_loc[1] = maxa; 64668a175baeSEmil Constantinescu err_loc[2] = maxr; 6467a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 64688a175baeSEmil Constantinescu gmax = err_glb[0]; 64698a175baeSEmil Constantinescu gmaxa = err_glb[1]; 64708a175baeSEmil Constantinescu gmaxr = err_glb[2]; 64718a175baeSEmil Constantinescu 64728a175baeSEmil Constantinescu *norm = gmax; 64738a175baeSEmil Constantinescu *norma = gmaxa; 64748a175baeSEmil Constantinescu *normr = gmaxr; 64758a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 64768a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 64778a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 64788a175baeSEmil Constantinescu PetscFunctionReturn(0); 64798a175baeSEmil Constantinescu } 64808a175baeSEmil Constantinescu 64818a175baeSEmil Constantinescu /*@ 64828a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 64838a175baeSEmil Constantinescu 64848a175baeSEmil Constantinescu Collective on TS 64858a175baeSEmil Constantinescu 64868a175baeSEmil Constantinescu Input Arguments: 64878a175baeSEmil Constantinescu + ts - time stepping context 64888a175baeSEmil Constantinescu . E - error vector 64898a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 64908a175baeSEmil Constantinescu . Y - state vector, previous time step 64918a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 64928a175baeSEmil Constantinescu 64938a175baeSEmil Constantinescu Output Arguments: 64948a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 64958a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 64968a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 64978a175baeSEmil Constantinescu 64988a175baeSEmil Constantinescu Options Database Keys: 64998a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 65008a175baeSEmil Constantinescu 65018a175baeSEmil Constantinescu Level: developer 65028a175baeSEmil Constantinescu 65038a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 65048a175baeSEmil Constantinescu @*/ 65058a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 65068a175baeSEmil Constantinescu { 65078a175baeSEmil Constantinescu PetscErrorCode ierr; 65088a175baeSEmil Constantinescu 65098a175baeSEmil Constantinescu PetscFunctionBegin; 65108a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 65118a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65128a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 65138a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65148a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 65158a175baeSEmil Constantinescu PetscFunctionReturn(0); 65168a175baeSEmil Constantinescu } 65178a175baeSEmil Constantinescu 65188a175baeSEmil Constantinescu 65198d59e960SJed Brown /*@ 65208d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 65218d59e960SJed Brown 65228d59e960SJed Brown Logically Collective on TS 65238d59e960SJed Brown 65248d59e960SJed Brown Input Arguments: 65258d59e960SJed Brown + ts - time stepping context 65268d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 65278d59e960SJed Brown 65288d59e960SJed Brown Note: 65298d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 65308d59e960SJed Brown 65318d59e960SJed Brown Level: intermediate 65328d59e960SJed Brown 65338d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 65348d59e960SJed Brown @*/ 65358d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 65368d59e960SJed Brown { 65378d59e960SJed Brown PetscFunctionBegin; 65388d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 65398d59e960SJed Brown ts->cfltime_local = cfltime; 65408d59e960SJed Brown ts->cfltime = -1.; 65418d59e960SJed Brown PetscFunctionReturn(0); 65428d59e960SJed Brown } 65438d59e960SJed Brown 65448d59e960SJed Brown /*@ 65458d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 65468d59e960SJed Brown 65478d59e960SJed Brown Collective on TS 65488d59e960SJed Brown 65498d59e960SJed Brown Input Arguments: 65508d59e960SJed Brown . ts - time stepping context 65518d59e960SJed Brown 65528d59e960SJed Brown Output Arguments: 65538d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 65548d59e960SJed Brown 65558d59e960SJed Brown Level: advanced 65568d59e960SJed Brown 65578d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 65588d59e960SJed Brown @*/ 65598d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 65608d59e960SJed Brown { 65618d59e960SJed Brown PetscErrorCode ierr; 65628d59e960SJed Brown 65638d59e960SJed Brown PetscFunctionBegin; 65648d59e960SJed Brown if (ts->cfltime < 0) { 6565b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 65668d59e960SJed Brown } 65678d59e960SJed Brown *cfltime = ts->cfltime; 65688d59e960SJed Brown PetscFunctionReturn(0); 65698d59e960SJed Brown } 65708d59e960SJed Brown 6571d6ebe24aSShri Abhyankar /*@ 6572d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6573d6ebe24aSShri Abhyankar 6574d6ebe24aSShri Abhyankar Input Parameters: 6575d6ebe24aSShri Abhyankar . ts - the TS context. 6576d6ebe24aSShri Abhyankar . xl - lower bound. 6577d6ebe24aSShri Abhyankar . xu - upper bound. 6578d6ebe24aSShri Abhyankar 6579d6ebe24aSShri Abhyankar Notes: 6580d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6581e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6582d6ebe24aSShri Abhyankar 65832bd2b0e6SSatish Balay Level: advanced 65842bd2b0e6SSatish Balay 6585d6ebe24aSShri Abhyankar @*/ 6586d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6587d6ebe24aSShri Abhyankar { 6588d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6589d6ebe24aSShri Abhyankar SNES snes; 6590d6ebe24aSShri Abhyankar 6591d6ebe24aSShri Abhyankar PetscFunctionBegin; 6592d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6593d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6594d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6595d6ebe24aSShri Abhyankar } 6596d6ebe24aSShri Abhyankar 6597325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6598c6db04a5SJed Brown #include <mex.h> 6599325fc9f4SBarry Smith 6600325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6601325fc9f4SBarry Smith 6602325fc9f4SBarry Smith /* 6603325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6604325fc9f4SBarry Smith TSSetFunctionMatlab(). 6605325fc9f4SBarry Smith 6606325fc9f4SBarry Smith Collective on TS 6607325fc9f4SBarry Smith 6608325fc9f4SBarry Smith Input Parameters: 6609325fc9f4SBarry Smith + snes - the TS context 66100910c330SBarry Smith - u - input vector 6611325fc9f4SBarry Smith 6612325fc9f4SBarry Smith Output Parameter: 6613325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6614325fc9f4SBarry Smith 6615325fc9f4SBarry Smith Notes: 6616325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6617325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6618325fc9f4SBarry Smith themselves. 6619325fc9f4SBarry Smith 6620325fc9f4SBarry Smith Level: developer 6621325fc9f4SBarry Smith 6622325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6623325fc9f4SBarry Smith 6624325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6625325fc9f4SBarry Smith */ 66260910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6627325fc9f4SBarry Smith { 6628325fc9f4SBarry Smith PetscErrorCode ierr; 6629325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6630325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6631325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6632325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6633325fc9f4SBarry Smith 6634325fc9f4SBarry Smith PetscFunctionBegin; 6635325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 66360910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 66370910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6638325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 66390910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6640325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6641325fc9f4SBarry Smith 6642325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 66430910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 66440910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 66450910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6646bbd56ea5SKarl Rupp 6647325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6648325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6649325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6650325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6651325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6652325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6653325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6654325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6655325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6656325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6657325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6658325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6659325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6660325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6661325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6662325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6663325fc9f4SBarry Smith PetscFunctionReturn(0); 6664325fc9f4SBarry Smith } 6665325fc9f4SBarry Smith 6666325fc9f4SBarry Smith 6667325fc9f4SBarry Smith /* 6668325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6669325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6670e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6671325fc9f4SBarry Smith 6672325fc9f4SBarry Smith Logically Collective on TS 6673325fc9f4SBarry Smith 6674325fc9f4SBarry Smith Input Parameters: 6675325fc9f4SBarry Smith + ts - the TS context 6676325fc9f4SBarry Smith - func - function evaluation routine 6677325fc9f4SBarry Smith 6678325fc9f4SBarry Smith Calling sequence of func: 66790910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6680325fc9f4SBarry Smith 6681325fc9f4SBarry Smith Level: beginner 6682325fc9f4SBarry Smith 6683325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6684325fc9f4SBarry Smith 6685325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6686325fc9f4SBarry Smith */ 6687cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6688325fc9f4SBarry Smith { 6689325fc9f4SBarry Smith PetscErrorCode ierr; 6690325fc9f4SBarry Smith TSMatlabContext *sctx; 6691325fc9f4SBarry Smith 6692325fc9f4SBarry Smith PetscFunctionBegin; 6693325fc9f4SBarry Smith /* currently sctx is memory bleed */ 669495dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6695325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6696325fc9f4SBarry Smith /* 6697325fc9f4SBarry Smith This should work, but it doesn't 6698325fc9f4SBarry Smith sctx->ctx = ctx; 6699325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6700325fc9f4SBarry Smith */ 6701325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6702bbd56ea5SKarl Rupp 67030298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6704325fc9f4SBarry Smith PetscFunctionReturn(0); 6705325fc9f4SBarry Smith } 6706325fc9f4SBarry Smith 6707325fc9f4SBarry Smith /* 6708325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6709325fc9f4SBarry Smith TSSetJacobianMatlab(). 6710325fc9f4SBarry Smith 6711325fc9f4SBarry Smith Collective on TS 6712325fc9f4SBarry Smith 6713325fc9f4SBarry Smith Input Parameters: 6714cdcf91faSSean Farley + ts - the TS context 67150910c330SBarry Smith . u - input vector 6716325fc9f4SBarry Smith . A, B - the matrices 6717325fc9f4SBarry Smith - ctx - user context 6718325fc9f4SBarry Smith 6719325fc9f4SBarry Smith Level: developer 6720325fc9f4SBarry Smith 6721325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6722325fc9f4SBarry Smith 6723325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6724325fc9f4SBarry Smith @*/ 6725f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6726325fc9f4SBarry Smith { 6727325fc9f4SBarry Smith PetscErrorCode ierr; 6728325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6729325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6730325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6731325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6732325fc9f4SBarry Smith 6733325fc9f4SBarry Smith PetscFunctionBegin; 6734cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 67350910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6736325fc9f4SBarry Smith 67370910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6738325fc9f4SBarry Smith 6739cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 67400910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 67410910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 67420910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 67430910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6744bbd56ea5SKarl Rupp 6745325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6746325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6747325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6748325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6749325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6750325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6751325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6752325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6753325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6754325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6755325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6756325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6757325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6758325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6759325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6760325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6761325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6762325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6763325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6764325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6765325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6766325fc9f4SBarry Smith PetscFunctionReturn(0); 6767325fc9f4SBarry Smith } 6768325fc9f4SBarry Smith 6769325fc9f4SBarry Smith 6770325fc9f4SBarry Smith /* 6771325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6772e3c5b3baSBarry 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 6773325fc9f4SBarry Smith 6774325fc9f4SBarry Smith Logically Collective on TS 6775325fc9f4SBarry Smith 6776325fc9f4SBarry Smith Input Parameters: 6777cdcf91faSSean Farley + ts - the TS context 6778325fc9f4SBarry Smith . A,B - Jacobian matrices 6779325fc9f4SBarry Smith . func - function evaluation routine 6780325fc9f4SBarry Smith - ctx - user context 6781325fc9f4SBarry Smith 6782325fc9f4SBarry Smith Calling sequence of func: 67830910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6784325fc9f4SBarry Smith 6785325fc9f4SBarry Smith 6786325fc9f4SBarry Smith Level: developer 6787325fc9f4SBarry Smith 6788325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6789325fc9f4SBarry Smith 6790325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6791325fc9f4SBarry Smith */ 6792cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6793325fc9f4SBarry Smith { 6794325fc9f4SBarry Smith PetscErrorCode ierr; 6795325fc9f4SBarry Smith TSMatlabContext *sctx; 6796325fc9f4SBarry Smith 6797325fc9f4SBarry Smith PetscFunctionBegin; 6798325fc9f4SBarry Smith /* currently sctx is memory bleed */ 679995dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6800325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6801325fc9f4SBarry Smith /* 6802325fc9f4SBarry Smith This should work, but it doesn't 6803325fc9f4SBarry Smith sctx->ctx = ctx; 6804325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6805325fc9f4SBarry Smith */ 6806325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6807bbd56ea5SKarl Rupp 6808cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6809325fc9f4SBarry Smith PetscFunctionReturn(0); 6810325fc9f4SBarry Smith } 6811325fc9f4SBarry Smith 6812b5b1a830SBarry Smith /* 6813b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6814b5b1a830SBarry Smith 6815b5b1a830SBarry Smith Collective on TS 6816b5b1a830SBarry Smith 6817b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6818b5b1a830SBarry Smith @*/ 68190910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6820b5b1a830SBarry Smith { 6821b5b1a830SBarry Smith PetscErrorCode ierr; 6822b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6823a530c242SBarry Smith int nlhs = 1,nrhs = 6; 6824b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 6825b5b1a830SBarry Smith long long int lx = 0,ls = 0; 6826b5b1a830SBarry Smith 6827b5b1a830SBarry Smith PetscFunctionBegin; 6828cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 68290910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6830b5b1a830SBarry Smith 6831cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 68320910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6833bbd56ea5SKarl Rupp 6834b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6835b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 6836b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 6837b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 6838b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 6839b5b1a830SBarry Smith prhs[5] = sctx->ctx; 6840b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6841b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6842b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 6843b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 6844b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 6845b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 6846b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 6847b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 6848b5b1a830SBarry Smith PetscFunctionReturn(0); 6849b5b1a830SBarry Smith } 6850b5b1a830SBarry Smith 6851b5b1a830SBarry Smith 6852b5b1a830SBarry Smith /* 6853b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 6854b5b1a830SBarry Smith 6855b5b1a830SBarry Smith Level: developer 6856b5b1a830SBarry Smith 6857b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 6858b5b1a830SBarry Smith 6859b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6860b5b1a830SBarry Smith */ 6861cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6862b5b1a830SBarry Smith { 6863b5b1a830SBarry Smith PetscErrorCode ierr; 6864b5b1a830SBarry Smith TSMatlabContext *sctx; 6865b5b1a830SBarry Smith 6866b5b1a830SBarry Smith PetscFunctionBegin; 6867b5b1a830SBarry Smith /* currently sctx is memory bleed */ 686895dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6869b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6870b5b1a830SBarry Smith /* 6871b5b1a830SBarry Smith This should work, but it doesn't 6872b5b1a830SBarry Smith sctx->ctx = ctx; 6873b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6874b5b1a830SBarry Smith */ 6875b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6876bbd56ea5SKarl Rupp 68770298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6878b5b1a830SBarry Smith PetscFunctionReturn(0); 6879b5b1a830SBarry Smith } 6880325fc9f4SBarry Smith #endif 6881b3603a34SBarry Smith 6882b3603a34SBarry Smith /*@C 68834f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6884b3603a34SBarry Smith in a time based line graph 6885b3603a34SBarry Smith 6886b3603a34SBarry Smith Collective on TS 6887b3603a34SBarry Smith 6888b3603a34SBarry Smith Input Parameters: 6889b3603a34SBarry Smith + ts - the TS context 6890b3603a34SBarry Smith . step - current time-step 6891b3603a34SBarry Smith . ptime - current time 68927db568b7SBarry Smith . u - current solution 68937db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6894b3603a34SBarry Smith 6895b3d3934dSBarry Smith Options Database: 68969ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6897b3d3934dSBarry Smith 6898b3603a34SBarry Smith Level: intermediate 6899b3603a34SBarry Smith 69006934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component solutions in a separate window 6901b3603a34SBarry Smith 6902b3603a34SBarry Smith .keywords: TS, vector, monitor, view 6903b3603a34SBarry Smith 69047db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 69057db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 69067db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 69077db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6908b3603a34SBarry Smith @*/ 69097db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6910b3603a34SBarry Smith { 6911b3603a34SBarry Smith PetscErrorCode ierr; 69127db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6913b3603a34SBarry Smith const PetscScalar *yy; 691480666b62SBarry Smith Vec v; 6915b3603a34SBarry Smith 6916b3603a34SBarry Smith PetscFunctionBegin; 691763e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 691858ff32f7SBarry Smith if (!step) { 6919a9f9c1f6SBarry Smith PetscDrawAxis axis; 69206934998bSLisandro Dalcin PetscInt dim; 6921a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6922a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6923bab0a581SBarry Smith if (!ctx->names) { 6924bab0a581SBarry Smith PetscBool flg; 6925bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6926bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6927bab0a581SBarry Smith if (flg) { 6928bab0a581SBarry Smith PetscInt i,n; 6929bab0a581SBarry Smith char **names; 6930bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6931bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6932bab0a581SBarry Smith for (i=0; i<n; i++) { 6933bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6934bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6935bab0a581SBarry Smith } 6936bab0a581SBarry Smith names[n] = NULL; 6937bab0a581SBarry Smith ctx->names = names; 6938bab0a581SBarry Smith } 6939bab0a581SBarry Smith } 6940387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6941387f4636SBarry Smith char **displaynames; 6942387f4636SBarry Smith PetscBool flg; 6943387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 694495dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6945387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6946c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6947387f4636SBarry Smith if (flg) { 6948a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6949387f4636SBarry Smith } 6950387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6951387f4636SBarry Smith } 6952387f4636SBarry Smith if (ctx->displaynames) { 6953387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6954387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6955387f4636SBarry Smith } else if (ctx->names) { 69560910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 69570b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6958387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6959b0bc92c6SBarry Smith } else { 6960b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6961b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6962387f4636SBarry Smith } 69630b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 696458ff32f7SBarry Smith } 69656934998bSLisandro Dalcin 69666934998bSLisandro Dalcin if (!ctx->transform) v = u; 69676934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 696880666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 69696934998bSLisandro Dalcin if (ctx->displaynames) { 69706934998bSLisandro Dalcin PetscInt i; 69716934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 69726934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 69736934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 69746934998bSLisandro Dalcin } else { 6975e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6976e3efe391SJed Brown PetscInt i,n; 69776934998bSLisandro Dalcin PetscReal *yreal; 697880666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6979785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6980e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 69810b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6982e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6983e3efe391SJed Brown #else 69840b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6985e3efe391SJed Brown #endif 698680666b62SBarry Smith } 69876934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 69886934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 69896934998bSLisandro Dalcin 6990b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 69910b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 69926934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 69933923b477SBarry Smith } 6994b3603a34SBarry Smith PetscFunctionReturn(0); 6995b3603a34SBarry Smith } 6996b3603a34SBarry Smith 6997387f4636SBarry Smith 6998b037adc7SBarry Smith /*@C 699931152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7000b037adc7SBarry Smith 7001b037adc7SBarry Smith Collective on TS 7002b037adc7SBarry Smith 7003b037adc7SBarry Smith Input Parameters: 7004b037adc7SBarry Smith + ts - the TS context 7005b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 7006b037adc7SBarry Smith 7007b037adc7SBarry Smith Level: intermediate 7008b037adc7SBarry Smith 70097db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70107db568b7SBarry Smith 7011b037adc7SBarry Smith .keywords: TS, vector, monitor, view 7012b037adc7SBarry Smith 7013a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 7014b037adc7SBarry Smith @*/ 701531152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 7016b037adc7SBarry Smith { 7017b037adc7SBarry Smith PetscErrorCode ierr; 7018b037adc7SBarry Smith PetscInt i; 7019b037adc7SBarry Smith 7020b037adc7SBarry Smith PetscFunctionBegin; 7021b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7022b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 70235537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 7024b3d3934dSBarry Smith break; 7025b3d3934dSBarry Smith } 7026b3d3934dSBarry Smith } 7027b3d3934dSBarry Smith PetscFunctionReturn(0); 7028b3d3934dSBarry Smith } 7029b3d3934dSBarry Smith 7030e673d494SBarry Smith /*@C 7031e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7032e673d494SBarry Smith 7033e673d494SBarry Smith Collective on TS 7034e673d494SBarry Smith 7035e673d494SBarry Smith Input Parameters: 7036e673d494SBarry Smith + ts - the TS context 7037e673d494SBarry Smith - names - the names of the components, final string must be NULL 7038e673d494SBarry Smith 7039e673d494SBarry Smith Level: intermediate 7040e673d494SBarry Smith 7041e673d494SBarry Smith .keywords: TS, vector, monitor, view 7042e673d494SBarry Smith 7043a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 7044e673d494SBarry Smith @*/ 7045e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 7046e673d494SBarry Smith { 7047e673d494SBarry Smith PetscErrorCode ierr; 7048e673d494SBarry Smith 7049e673d494SBarry Smith PetscFunctionBegin; 7050e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 7051e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 7052e673d494SBarry Smith PetscFunctionReturn(0); 7053e673d494SBarry Smith } 7054e673d494SBarry Smith 7055b3d3934dSBarry Smith /*@C 7056b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 7057b3d3934dSBarry Smith 7058b3d3934dSBarry Smith Collective on TS 7059b3d3934dSBarry Smith 7060b3d3934dSBarry Smith Input Parameter: 7061b3d3934dSBarry Smith . ts - the TS context 7062b3d3934dSBarry Smith 7063b3d3934dSBarry Smith Output Parameter: 7064b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 7065b3d3934dSBarry Smith 7066b3d3934dSBarry Smith Level: intermediate 7067b3d3934dSBarry Smith 70687db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70697db568b7SBarry Smith 7070b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7071b3d3934dSBarry Smith 7072b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7073b3d3934dSBarry Smith @*/ 7074b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 7075b3d3934dSBarry Smith { 7076b3d3934dSBarry Smith PetscInt i; 7077b3d3934dSBarry Smith 7078b3d3934dSBarry Smith PetscFunctionBegin; 7079b3d3934dSBarry Smith *names = NULL; 7080b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7081b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 70825537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 7083b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 7084b3d3934dSBarry Smith break; 7085387f4636SBarry Smith } 7086387f4636SBarry Smith } 7087387f4636SBarry Smith PetscFunctionReturn(0); 7088387f4636SBarry Smith } 7089387f4636SBarry Smith 7090a66092f1SBarry Smith /*@C 7091a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 7092a66092f1SBarry Smith 7093a66092f1SBarry Smith Collective on TS 7094a66092f1SBarry Smith 7095a66092f1SBarry Smith Input Parameters: 7096a66092f1SBarry Smith + ctx - the TSMonitorLG context 7097a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 7098a66092f1SBarry Smith 7099a66092f1SBarry Smith Level: intermediate 7100a66092f1SBarry Smith 7101a66092f1SBarry Smith .keywords: TS, vector, monitor, view 7102a66092f1SBarry Smith 7103a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7104a66092f1SBarry Smith @*/ 7105a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 7106a66092f1SBarry Smith { 7107a66092f1SBarry Smith PetscInt j = 0,k; 7108a66092f1SBarry Smith PetscErrorCode ierr; 7109a66092f1SBarry Smith 7110a66092f1SBarry Smith PetscFunctionBegin; 7111a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 7112a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 7113a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 7114a66092f1SBarry Smith while (displaynames[j]) j++; 7115a66092f1SBarry Smith ctx->ndisplayvariables = j; 7116a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 7117a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 7118a66092f1SBarry Smith j = 0; 7119a66092f1SBarry Smith while (displaynames[j]) { 7120a66092f1SBarry Smith k = 0; 7121a66092f1SBarry Smith while (ctx->names[k]) { 7122a66092f1SBarry Smith PetscBool flg; 7123a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 7124a66092f1SBarry Smith if (flg) { 7125a66092f1SBarry Smith ctx->displayvariables[j] = k; 7126a66092f1SBarry Smith break; 7127a66092f1SBarry Smith } 7128a66092f1SBarry Smith k++; 7129a66092f1SBarry Smith } 7130a66092f1SBarry Smith j++; 7131a66092f1SBarry Smith } 7132a66092f1SBarry Smith PetscFunctionReturn(0); 7133a66092f1SBarry Smith } 7134a66092f1SBarry Smith 7135a66092f1SBarry Smith 7136387f4636SBarry Smith /*@C 7137387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 7138387f4636SBarry Smith 7139387f4636SBarry Smith Collective on TS 7140387f4636SBarry Smith 7141387f4636SBarry Smith Input Parameters: 7142387f4636SBarry Smith + ts - the TS context 7143387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 7144387f4636SBarry Smith 71457db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 71467db568b7SBarry Smith 7147387f4636SBarry Smith Level: intermediate 7148387f4636SBarry Smith 7149387f4636SBarry Smith .keywords: TS, vector, monitor, view 7150387f4636SBarry Smith 7151387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7152387f4636SBarry Smith @*/ 7153387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 7154387f4636SBarry Smith { 7155a66092f1SBarry Smith PetscInt i; 7156387f4636SBarry Smith PetscErrorCode ierr; 7157387f4636SBarry Smith 7158387f4636SBarry Smith PetscFunctionBegin; 7159387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7160387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71615537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 7162b3d3934dSBarry Smith break; 7163b037adc7SBarry Smith } 7164b037adc7SBarry Smith } 7165b037adc7SBarry Smith PetscFunctionReturn(0); 7166b037adc7SBarry Smith } 7167b037adc7SBarry Smith 716880666b62SBarry Smith /*@C 716980666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 717080666b62SBarry Smith 717180666b62SBarry Smith Collective on TS 717280666b62SBarry Smith 717380666b62SBarry Smith Input Parameters: 717480666b62SBarry Smith + ts - the TS context 717580666b62SBarry Smith . transform - the transform function 71767684fa3eSBarry Smith . destroy - function to destroy the optional context 717780666b62SBarry Smith - ctx - optional context used by transform function 717880666b62SBarry Smith 71797db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 71807db568b7SBarry Smith 718180666b62SBarry Smith Level: intermediate 718280666b62SBarry Smith 718380666b62SBarry Smith .keywords: TS, vector, monitor, view 718480666b62SBarry Smith 7185a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 718680666b62SBarry Smith @*/ 71877684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 718880666b62SBarry Smith { 718980666b62SBarry Smith PetscInt i; 7190a66092f1SBarry Smith PetscErrorCode ierr; 719180666b62SBarry Smith 719280666b62SBarry Smith PetscFunctionBegin; 719380666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 719480666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71955537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 719680666b62SBarry Smith } 719780666b62SBarry Smith } 719880666b62SBarry Smith PetscFunctionReturn(0); 719980666b62SBarry Smith } 720080666b62SBarry Smith 7201e673d494SBarry Smith /*@C 7202e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 7203e673d494SBarry Smith 7204e673d494SBarry Smith Collective on TSLGCtx 7205e673d494SBarry Smith 7206e673d494SBarry Smith Input Parameters: 7207e673d494SBarry Smith + ts - the TS context 7208e673d494SBarry Smith . transform - the transform function 72097684fa3eSBarry Smith . destroy - function to destroy the optional context 7210e673d494SBarry Smith - ctx - optional context used by transform function 7211e673d494SBarry Smith 7212e673d494SBarry Smith Level: intermediate 7213e673d494SBarry Smith 7214e673d494SBarry Smith .keywords: TS, vector, monitor, view 7215e673d494SBarry Smith 7216a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 7217e673d494SBarry Smith @*/ 72187684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 7219e673d494SBarry Smith { 7220e673d494SBarry Smith PetscFunctionBegin; 7221e673d494SBarry Smith ctx->transform = transform; 72227684fa3eSBarry Smith ctx->transformdestroy = destroy; 7223e673d494SBarry Smith ctx->transformctx = tctx; 7224e673d494SBarry Smith PetscFunctionReturn(0); 7225e673d494SBarry Smith } 7226e673d494SBarry Smith 7227ef20d060SBarry Smith /*@C 72284f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 7229ef20d060SBarry Smith in a time based line graph 7230ef20d060SBarry Smith 7231ef20d060SBarry Smith Collective on TS 7232ef20d060SBarry Smith 7233ef20d060SBarry Smith Input Parameters: 7234ef20d060SBarry Smith + ts - the TS context 7235ef20d060SBarry Smith . step - current time-step 7236ef20d060SBarry Smith . ptime - current time 72377db568b7SBarry Smith . u - current solution 72387db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 7239ef20d060SBarry Smith 7240ef20d060SBarry Smith Level: intermediate 7241ef20d060SBarry Smith 72426934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component errors in a separate window 7243abd5a294SJed Brown 7244abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 7245abd5a294SJed Brown 7246abd5a294SJed Brown Options Database Keys: 72474f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 7248ef20d060SBarry Smith 7249ef20d060SBarry Smith .keywords: TS, vector, monitor, view 7250ef20d060SBarry Smith 7251abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 7252ef20d060SBarry Smith @*/ 72530910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 7254ef20d060SBarry Smith { 7255ef20d060SBarry Smith PetscErrorCode ierr; 72560b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 7257ef20d060SBarry Smith const PetscScalar *yy; 7258ef20d060SBarry Smith Vec y; 7259ef20d060SBarry Smith 7260ef20d060SBarry Smith PetscFunctionBegin; 7261a9f9c1f6SBarry Smith if (!step) { 7262a9f9c1f6SBarry Smith PetscDrawAxis axis; 72636934998bSLisandro Dalcin PetscInt dim; 7264a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 72651ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 72660910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 7267a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7268a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7269a9f9c1f6SBarry Smith } 72700910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 7271ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 72720910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7273ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 7274e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7275e3efe391SJed Brown { 7276e3efe391SJed Brown PetscReal *yreal; 7277e3efe391SJed Brown PetscInt i,n; 7278e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 7279785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7280e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 72810b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7282e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7283e3efe391SJed Brown } 7284e3efe391SJed Brown #else 72850b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7286e3efe391SJed Brown #endif 7287ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 7288ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 7289b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 72900b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 72916934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 72923923b477SBarry Smith } 7293ef20d060SBarry Smith PetscFunctionReturn(0); 7294ef20d060SBarry Smith } 7295ef20d060SBarry Smith 7296201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7297201da799SBarry Smith { 7298201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7299201da799SBarry Smith PetscReal x = ptime,y; 7300201da799SBarry Smith PetscErrorCode ierr; 7301201da799SBarry Smith PetscInt its; 7302201da799SBarry Smith 7303201da799SBarry Smith PetscFunctionBegin; 730463e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7305201da799SBarry Smith if (!n) { 7306201da799SBarry Smith PetscDrawAxis axis; 7307201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7308201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7309201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7310201da799SBarry Smith ctx->snes_its = 0; 7311201da799SBarry Smith } 7312201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7313201da799SBarry Smith y = its - ctx->snes_its; 7314201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 73153fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7316201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73176934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7318201da799SBarry Smith } 7319201da799SBarry Smith ctx->snes_its = its; 7320201da799SBarry Smith PetscFunctionReturn(0); 7321201da799SBarry Smith } 7322201da799SBarry Smith 7323201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7324201da799SBarry Smith { 7325201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7326201da799SBarry Smith PetscReal x = ptime,y; 7327201da799SBarry Smith PetscErrorCode ierr; 7328201da799SBarry Smith PetscInt its; 7329201da799SBarry Smith 7330201da799SBarry Smith PetscFunctionBegin; 733163e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7332201da799SBarry Smith if (!n) { 7333201da799SBarry Smith PetscDrawAxis axis; 7334201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7335201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7336201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7337201da799SBarry Smith ctx->ksp_its = 0; 7338201da799SBarry Smith } 7339201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7340201da799SBarry Smith y = its - ctx->ksp_its; 7341201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 734299fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7343201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73446934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7345201da799SBarry Smith } 7346201da799SBarry Smith ctx->ksp_its = its; 7347201da799SBarry Smith PetscFunctionReturn(0); 7348201da799SBarry Smith } 7349f9c1d6abSBarry Smith 7350f9c1d6abSBarry Smith /*@ 7351f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7352f9c1d6abSBarry Smith 7353f9c1d6abSBarry Smith Collective on TS and Vec 7354f9c1d6abSBarry Smith 7355f9c1d6abSBarry Smith Input Parameters: 7356f9c1d6abSBarry Smith + ts - the TS context 7357f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7358f9c1d6abSBarry Smith 7359f9c1d6abSBarry Smith Output Parameters: 7360f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7361f9c1d6abSBarry Smith 7362f9c1d6abSBarry Smith Level: developer 7363f9c1d6abSBarry Smith 7364f9c1d6abSBarry Smith .keywords: TS, compute 7365f9c1d6abSBarry Smith 7366f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7367f9c1d6abSBarry Smith @*/ 7368f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7369f9c1d6abSBarry Smith { 7370f9c1d6abSBarry Smith PetscErrorCode ierr; 7371f9c1d6abSBarry Smith 7372f9c1d6abSBarry Smith PetscFunctionBegin; 7373f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7374ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7375f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7376f9c1d6abSBarry Smith PetscFunctionReturn(0); 7377f9c1d6abSBarry Smith } 737824655328SShri 7379b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7380b3d3934dSBarry Smith /*@C 7381b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7382b3d3934dSBarry Smith 7383b3d3934dSBarry Smith Collective on TS 7384b3d3934dSBarry Smith 7385b3d3934dSBarry Smith Input Parameters: 7386b3d3934dSBarry Smith . ts - the ODE solver object 7387b3d3934dSBarry Smith 7388b3d3934dSBarry Smith Output Parameter: 7389b3d3934dSBarry Smith . ctx - the context 7390b3d3934dSBarry Smith 7391b3d3934dSBarry Smith Level: intermediate 7392b3d3934dSBarry Smith 7393b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 7394b3d3934dSBarry Smith 7395b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7396b3d3934dSBarry Smith 7397b3d3934dSBarry Smith @*/ 7398b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7399b3d3934dSBarry Smith { 7400b3d3934dSBarry Smith PetscErrorCode ierr; 7401b3d3934dSBarry Smith 7402b3d3934dSBarry Smith PetscFunctionBegin; 7403a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7404b3d3934dSBarry Smith PetscFunctionReturn(0); 7405b3d3934dSBarry Smith } 7406b3d3934dSBarry Smith 7407b3d3934dSBarry Smith /*@C 7408b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7409b3d3934dSBarry Smith 7410b3d3934dSBarry Smith Collective on TS 7411b3d3934dSBarry Smith 7412b3d3934dSBarry Smith Input Parameters: 7413b3d3934dSBarry Smith + ts - the TS context 7414b3d3934dSBarry Smith . step - current time-step 7415b3d3934dSBarry Smith . ptime - current time 74167db568b7SBarry Smith . u - current solution 74177db568b7SBarry Smith - dctx - the envelope context 7418b3d3934dSBarry Smith 7419b3d3934dSBarry Smith Options Database: 7420b3d3934dSBarry Smith . -ts_monitor_envelope 7421b3d3934dSBarry Smith 7422b3d3934dSBarry Smith Level: intermediate 7423b3d3934dSBarry Smith 7424b3d3934dSBarry Smith Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7425b3d3934dSBarry Smith 7426b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7427b3d3934dSBarry Smith 74287db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7429b3d3934dSBarry Smith @*/ 74307db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7431b3d3934dSBarry Smith { 7432b3d3934dSBarry Smith PetscErrorCode ierr; 74337db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7434b3d3934dSBarry Smith 7435b3d3934dSBarry Smith PetscFunctionBegin; 7436b3d3934dSBarry Smith if (!ctx->max) { 7437b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7438b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7439b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7440b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7441b3d3934dSBarry Smith } else { 7442b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7443b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7444b3d3934dSBarry Smith } 7445b3d3934dSBarry Smith PetscFunctionReturn(0); 7446b3d3934dSBarry Smith } 7447b3d3934dSBarry Smith 7448b3d3934dSBarry Smith 7449b3d3934dSBarry Smith /*@C 7450b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7451b3d3934dSBarry Smith 7452b3d3934dSBarry Smith Collective on TS 7453b3d3934dSBarry Smith 7454b3d3934dSBarry Smith Input Parameter: 7455b3d3934dSBarry Smith . ts - the TS context 7456b3d3934dSBarry Smith 7457b3d3934dSBarry Smith Output Parameter: 7458b3d3934dSBarry Smith + max - the maximum values 7459b3d3934dSBarry Smith - min - the minimum values 7460b3d3934dSBarry Smith 74617db568b7SBarry Smith Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 74627db568b7SBarry Smith 7463b3d3934dSBarry Smith Level: intermediate 7464b3d3934dSBarry Smith 7465b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7466b3d3934dSBarry Smith 7467b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7468b3d3934dSBarry Smith @*/ 7469b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7470b3d3934dSBarry Smith { 7471b3d3934dSBarry Smith PetscInt i; 7472b3d3934dSBarry Smith 7473b3d3934dSBarry Smith PetscFunctionBegin; 7474b3d3934dSBarry Smith if (max) *max = NULL; 7475b3d3934dSBarry Smith if (min) *min = NULL; 7476b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7477b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 74785537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7479b3d3934dSBarry Smith if (max) *max = ctx->max; 7480b3d3934dSBarry Smith if (min) *min = ctx->min; 7481b3d3934dSBarry Smith break; 7482b3d3934dSBarry Smith } 7483b3d3934dSBarry Smith } 7484b3d3934dSBarry Smith PetscFunctionReturn(0); 7485b3d3934dSBarry Smith } 7486b3d3934dSBarry Smith 7487b3d3934dSBarry Smith /*@C 7488b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7489b3d3934dSBarry Smith 7490b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7491b3d3934dSBarry Smith 7492b3d3934dSBarry Smith Input Parameter: 7493b3d3934dSBarry Smith . ctx - the monitor context 7494b3d3934dSBarry Smith 7495b3d3934dSBarry Smith Level: intermediate 7496b3d3934dSBarry Smith 7497b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7498b3d3934dSBarry Smith 74997db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7500b3d3934dSBarry Smith @*/ 7501b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7502b3d3934dSBarry Smith { 7503b3d3934dSBarry Smith PetscErrorCode ierr; 7504b3d3934dSBarry Smith 7505b3d3934dSBarry Smith PetscFunctionBegin; 7506b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7507b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7508b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7509b3d3934dSBarry Smith PetscFunctionReturn(0); 7510b3d3934dSBarry Smith } 7511f2dee214SBarry Smith 751224655328SShri /*@ 751324655328SShri TSRollBack - Rolls back one time step 751424655328SShri 751524655328SShri Collective on TS 751624655328SShri 751724655328SShri Input Parameter: 751824655328SShri . ts - the TS context obtained from TSCreate() 751924655328SShri 752024655328SShri Level: advanced 752124655328SShri 752224655328SShri .keywords: TS, timestep, rollback 752324655328SShri 752424655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 752524655328SShri @*/ 752624655328SShri PetscErrorCode TSRollBack(TS ts) 752724655328SShri { 752824655328SShri PetscErrorCode ierr; 752924655328SShri 753024655328SShri PetscFunctionBegin; 753124655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7532b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 753324655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 753424655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 753524655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 753624655328SShri ts->ptime = ts->ptime_prev; 7537be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 7538be5899b3SLisandro Dalcin ts->steps--; ts->total_steps--; 753910b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 7540b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 754124655328SShri PetscFunctionReturn(0); 754224655328SShri } 7543aeb4809dSShri Abhyankar 7544ff22ae23SHong Zhang /*@ 7545ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7546ff22ae23SHong Zhang 7547ff22ae23SHong Zhang Input Parameter: 7548ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7549ff22ae23SHong Zhang 7550ff22ae23SHong Zhang Level: advanced 7551ff22ae23SHong Zhang 7552ff22ae23SHong Zhang .keywords: TS, getstages 7553ff22ae23SHong Zhang 7554ff22ae23SHong Zhang .seealso: TSCreate() 7555ff22ae23SHong Zhang @*/ 7556ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7557ff22ae23SHong Zhang { 7558ff22ae23SHong Zhang PetscErrorCode ierr; 7559ff22ae23SHong Zhang 7560ff22ae23SHong Zhang PetscFunctionBegin; 7561ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7562ff22ae23SHong Zhang PetscValidPointer(ns,2); 7563ff22ae23SHong Zhang 7564ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 7565ff22ae23SHong Zhang else { 7566ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7567ff22ae23SHong Zhang } 7568ff22ae23SHong Zhang PetscFunctionReturn(0); 7569ff22ae23SHong Zhang } 7570ff22ae23SHong Zhang 7571847ff0e1SMatthew G. Knepley /*@C 7572847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7573847ff0e1SMatthew G. Knepley 7574847ff0e1SMatthew G. Knepley Collective on SNES 7575847ff0e1SMatthew G. Knepley 7576847ff0e1SMatthew G. Knepley Input Parameters: 7577847ff0e1SMatthew G. Knepley + ts - the TS context 7578847ff0e1SMatthew G. Knepley . t - current timestep 7579847ff0e1SMatthew G. Knepley . U - state vector 7580847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7581847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7582847ff0e1SMatthew G. Knepley - ctx - an optional user context 7583847ff0e1SMatthew G. Knepley 7584847ff0e1SMatthew G. Knepley Output Parameters: 7585847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7586847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7587847ff0e1SMatthew G. Knepley 7588847ff0e1SMatthew G. Knepley Level: intermediate 7589847ff0e1SMatthew G. Knepley 7590847ff0e1SMatthew G. Knepley Notes: 7591847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7592847ff0e1SMatthew G. Knepley 7593847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7594847ff0e1SMatthew G. Knepley 7595847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7596847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7597847ff0e1SMatthew G. Knepley 7598847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7599847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7600847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7601847ff0e1SMatthew G. Knepley 7602847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7603847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7604847ff0e1SMatthew G. Knepley @*/ 7605847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7606847ff0e1SMatthew G. Knepley { 7607847ff0e1SMatthew G. Knepley SNES snes; 7608847ff0e1SMatthew G. Knepley MatFDColoring color; 7609847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7610847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7611847ff0e1SMatthew G. Knepley 7612847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7613c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7614847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7615847ff0e1SMatthew G. Knepley if (!color) { 7616847ff0e1SMatthew G. Knepley DM dm; 7617847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7618847ff0e1SMatthew G. Knepley 7619847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7620847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7621847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7622847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7623847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7624847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7625847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7626847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7627847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7628847ff0e1SMatthew G. Knepley } else { 7629847ff0e1SMatthew G. Knepley MatColoring mc; 7630847ff0e1SMatthew G. Knepley 7631847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7632847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7633847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7634847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7635847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7636847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7637847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7638847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7639847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7640847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7641847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7642847ff0e1SMatthew G. Knepley } 7643847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7644847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7645847ff0e1SMatthew G. Knepley } 7646847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7647847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7648847ff0e1SMatthew G. Knepley if (J != B) { 7649847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7650847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7651847ff0e1SMatthew G. Knepley } 7652847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7653847ff0e1SMatthew G. Knepley } 765493b34091SDebojyoti Ghosh 7655cb9d8021SPierre Barbier de Reuille /*@ 7656cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7657cb9d8021SPierre Barbier de Reuille 7658cb9d8021SPierre Barbier de Reuille Input Parameters: 7659cb9d8021SPierre Barbier de Reuille ts - the TS context 7660cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7661cb9d8021SPierre Barbier de Reuille 7662cb9d8021SPierre Barbier de Reuille Level: intermediate 7663cb9d8021SPierre Barbier de Reuille 7664cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7665cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7666cb9d8021SPierre Barbier de Reuille @*/ 7667cb9d8021SPierre Barbier de Reuille 7668d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7669cb9d8021SPierre Barbier de Reuille { 7670cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7671cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7672cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7673cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7674cb9d8021SPierre Barbier de Reuille } 7675cb9d8021SPierre Barbier de Reuille 7676cb9d8021SPierre Barbier de Reuille /*@ 7677cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7678cb9d8021SPierre Barbier de Reuille 7679cb9d8021SPierre Barbier de Reuille Input Parameters: 7680cb9d8021SPierre Barbier de Reuille ts - the TS context 7681cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7682d183316bSPierre Barbier de Reuille Y - state vector to check. 7683cb9d8021SPierre Barbier de Reuille 7684cb9d8021SPierre Barbier de Reuille Output Parameter: 7685cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7686cb9d8021SPierre Barbier de Reuille 7687cb9d8021SPierre Barbier de Reuille Note: 7688cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7689cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 769096a0c994SBarry Smith 769196a0c994SBarry Smith Level: advanced 7692cb9d8021SPierre Barbier de Reuille @*/ 7693d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7694cb9d8021SPierre Barbier de Reuille { 7695cb9d8021SPierre Barbier de Reuille PetscErrorCode ierr; 7696cb9d8021SPierre Barbier de Reuille 7697cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7698cb9d8021SPierre Barbier de Reuille 7699cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7700cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7701cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7702d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7703cb9d8021SPierre Barbier de Reuille } 7704cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7705cb9d8021SPierre Barbier de Reuille } 77061ceb14c0SBarry Smith 770793b34091SDebojyoti Ghosh /*@C 7708e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 770993b34091SDebojyoti Ghosh 771093b34091SDebojyoti Ghosh Collective on MPI_Comm 771193b34091SDebojyoti Ghosh 771293b34091SDebojyoti Ghosh Input Parameter: 771393b34091SDebojyoti Ghosh . tsin - The input TS 771493b34091SDebojyoti Ghosh 771593b34091SDebojyoti Ghosh Output Parameter: 7716e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 771793b34091SDebojyoti Ghosh 77185eca1a21SEmil Constantinescu Notes: 77195eca1a21SEmil Constantinescu This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly. 77205eca1a21SEmil Constantinescu 7721baa10174SEmil Constantinescu When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup); 77225eca1a21SEmil Constantinescu 77235eca1a21SEmil Constantinescu Level: developer 772493b34091SDebojyoti Ghosh 7725e5168f73SEmil Constantinescu .keywords: TS, clone 7726e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 772793b34091SDebojyoti Ghosh @*/ 7728baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 772993b34091SDebojyoti Ghosh { 773093b34091SDebojyoti Ghosh TS t; 773193b34091SDebojyoti Ghosh PetscErrorCode ierr; 7732dc846ba4SSatish Balay SNES snes_start; 7733dc846ba4SSatish Balay DM dm; 7734dc846ba4SSatish Balay TSType type; 773593b34091SDebojyoti Ghosh 773693b34091SDebojyoti Ghosh PetscFunctionBegin; 773793b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 773893b34091SDebojyoti Ghosh *tsout = NULL; 773993b34091SDebojyoti Ghosh 77407a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 774193b34091SDebojyoti Ghosh 774293b34091SDebojyoti Ghosh /* General TS description */ 774393b34091SDebojyoti Ghosh t->numbermonitors = 0; 774493b34091SDebojyoti Ghosh t->setupcalled = 0; 774593b34091SDebojyoti Ghosh t->ksp_its = 0; 774693b34091SDebojyoti Ghosh t->snes_its = 0; 774793b34091SDebojyoti Ghosh t->nwork = 0; 774893b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 774993b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 775093b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 775193b34091SDebojyoti Ghosh 775234561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 775334561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7754d15a3a53SEmil Constantinescu 775593b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 775693b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 775793b34091SDebojyoti Ghosh 775893b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 775951699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 776093b34091SDebojyoti Ghosh 7761e7069c78SShri t->trajectory = tsin->trajectory; 7762e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7763e7069c78SShri 7764e7069c78SShri t->event = tsin->event; 77656b10a48eSSatish Balay if (t->event) t->event->refct++; 7766e7069c78SShri 776793b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 776893b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7769e7069c78SShri t->ptime_prev = tsin->ptime_prev; 777093b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 777193b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 777293b34091SDebojyoti Ghosh t->steps = tsin->steps; 7773e7069c78SShri t->total_steps = tsin->total_steps; 777493b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 777593b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 777693b34091SDebojyoti Ghosh t->atol = tsin->atol; 777793b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 777893b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 777993b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 778093b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 778193b34091SDebojyoti Ghosh 778293b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 778393b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 778493b34091SDebojyoti Ghosh 778593b34091SDebojyoti Ghosh t->vec_sol = NULL; 778693b34091SDebojyoti Ghosh 778793b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 778893b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 778993b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 779093b34091SDebojyoti Ghosh 779193b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 779293b34091SDebojyoti Ghosh 77930d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 77940d4fed19SBarry Smith PetscInt i; 77950d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 77960d4fed19SBarry Smith for (i=0; i<10; i++) { 77970d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 77980d4fed19SBarry Smith } 77990d4fed19SBarry Smith } 780093b34091SDebojyoti Ghosh *tsout = t; 780193b34091SDebojyoti Ghosh PetscFunctionReturn(0); 780293b34091SDebojyoti Ghosh } 7803