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 /*@ 44778fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 44878fbdcc8SBarry Smith 44978fbdcc8SBarry Smith Collective on TS 45078fbdcc8SBarry Smith 45178fbdcc8SBarry Smith Input Parameters: 45278fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 45378fbdcc8SBarry Smith 45478fbdcc8SBarry Smith Output Parameters; 45578fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 45678fbdcc8SBarry Smith 45778fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 45878fbdcc8SBarry Smith 45978fbdcc8SBarry Smith Level: advanced 46078fbdcc8SBarry Smith 46178fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 46278fbdcc8SBarry Smith 46378fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 46478fbdcc8SBarry Smith @*/ 46578fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 46678fbdcc8SBarry Smith { 46778fbdcc8SBarry Smith PetscFunctionBegin; 46878fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46978fbdcc8SBarry Smith *tr = ts->trajectory; 47078fbdcc8SBarry Smith PetscFunctionReturn(0); 47178fbdcc8SBarry Smith } 47278fbdcc8SBarry Smith 47378fbdcc8SBarry 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 48178fbdcc8SBarry Smith Options Database: 48278fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 48378fbdcc8SBarry Smith - -ts_trajectory_type type 48478fbdcc8SBarry Smith 48568bece0bSHong Zhang Note: This routine should be called after all TS options have been set 486d2daff3dSHong Zhang 48778fbdcc8SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and 48878fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 48978fbdcc8SBarry Smith 490d2daff3dSHong Zhang Level: intermediate 491d2daff3dSHong Zhang 49278fbdcc8SBarry 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; 758ecb5c246SBarry Smith TSIJacobian ijacobian; 759214bc6a2SJed Brown 760214bc6a2SJed Brown PetscFunctionBegin; 761c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 762c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 763ecb5c246SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 764214bc6a2SJed Brown if (Arhs) { 765214bc6a2SJed Brown if (!ts->Arhs) { 766ecb5c246SBarry Smith if (ijacobian) { 767214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 768ecb5c246SBarry Smith } else { 769ecb5c246SBarry Smith ts->Arhs = A; 770ecb5c246SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 771ecb5c246SBarry Smith } 772*3565c898SBarry Smith } else { 773*3565c898SBarry Smith PetscBool flg; 774*3565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 775*3565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 776*3565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 777*3565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 778*3565c898SBarry Smith ts->Arhs = A; 779*3565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 780*3565c898SBarry Smith } 781214bc6a2SJed Brown } 782214bc6a2SJed Brown *Arhs = ts->Arhs; 783214bc6a2SJed Brown } 784214bc6a2SJed Brown if (Brhs) { 785214bc6a2SJed Brown if (!ts->Brhs) { 786bdb70873SJed Brown if (A != B) { 787ecb5c246SBarry Smith if (ijacobian) { 788214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 789bdb70873SJed Brown } else { 790ecb5c246SBarry Smith ts->Brhs = B; 791ecb5c246SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 792ecb5c246SBarry Smith } 793ecb5c246SBarry Smith } else { 794bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 79551699248SLisandro Dalcin ts->Brhs = ts->Arhs; 796bdb70873SJed Brown } 797214bc6a2SJed Brown } 798214bc6a2SJed Brown *Brhs = ts->Brhs; 799214bc6a2SJed Brown } 800214bc6a2SJed Brown PetscFunctionReturn(0); 801214bc6a2SJed Brown } 802214bc6a2SJed Brown 803316643e7SJed Brown /*@ 8040910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 805316643e7SJed Brown 806316643e7SJed Brown Collective on TS and Vec 807316643e7SJed Brown 808316643e7SJed Brown Input Parameters: 809316643e7SJed Brown + ts - the TS context 810316643e7SJed Brown . t - current time 8110910c330SBarry Smith . U - state vector 8120910c330SBarry Smith . Udot - time derivative of state vector 813214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 814316643e7SJed Brown 815316643e7SJed Brown Output Parameter: 816316643e7SJed Brown . Y - right hand side 817316643e7SJed Brown 818316643e7SJed Brown Note: 819316643e7SJed Brown Most users should not need to explicitly call this routine, as it 820316643e7SJed Brown is used internally within the nonlinear solvers. 821316643e7SJed Brown 822316643e7SJed Brown If the user did did not write their equations in implicit form, this 823316643e7SJed Brown function recasts them in implicit form. 824316643e7SJed Brown 825316643e7SJed Brown Level: developer 826316643e7SJed Brown 827316643e7SJed Brown .keywords: TS, compute 828316643e7SJed Brown 829316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 830316643e7SJed Brown @*/ 8310910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 832316643e7SJed Brown { 833316643e7SJed Brown PetscErrorCode ierr; 83424989b8cSPeter Brune TSIFunction ifunction; 83524989b8cSPeter Brune TSRHSFunction rhsfunction; 83624989b8cSPeter Brune void *ctx; 83724989b8cSPeter Brune DM dm; 838316643e7SJed Brown 839316643e7SJed Brown PetscFunctionBegin; 8400700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8410910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8420910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8430700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 844316643e7SJed Brown 84524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 84624989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8470298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 84824989b8cSPeter Brune 849ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 850d90be118SSean Farley 8510910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 85224989b8cSPeter Brune if (ifunction) { 853316643e7SJed Brown PetscStackPush("TS user implicit function"); 8540910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 855316643e7SJed Brown PetscStackPop; 856214bc6a2SJed Brown } 857214bc6a2SJed Brown if (imex) { 85824989b8cSPeter Brune if (!ifunction) { 8590910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8602dd45cf8SJed Brown } 86124989b8cSPeter Brune } else if (rhsfunction) { 86224989b8cSPeter Brune if (ifunction) { 863214bc6a2SJed Brown Vec Frhs; 864214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8650910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 866214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8672dd45cf8SJed Brown } else { 8680910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8690910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 870316643e7SJed Brown } 8714a6899ffSJed Brown } 8720910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 873316643e7SJed Brown PetscFunctionReturn(0); 874316643e7SJed Brown } 875316643e7SJed Brown 876316643e7SJed Brown /*@ 877316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 878316643e7SJed Brown 879316643e7SJed Brown Collective on TS and Vec 880316643e7SJed Brown 881316643e7SJed Brown Input 882316643e7SJed Brown Input Parameters: 883316643e7SJed Brown + ts - the TS context 884316643e7SJed Brown . t - current timestep 8850910c330SBarry Smith . U - state vector 8860910c330SBarry Smith . Udot - time derivative of state vector 887214bc6a2SJed Brown . shift - shift to apply, see note below 888214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 889316643e7SJed Brown 890316643e7SJed Brown Output Parameters: 891316643e7SJed Brown + A - Jacobian matrix 892*3565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 893316643e7SJed Brown 894316643e7SJed Brown Notes: 8950910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 896316643e7SJed Brown 8970910c330SBarry Smith dF/dU + shift*dF/dUdot 898316643e7SJed Brown 899316643e7SJed Brown Most users should not need to explicitly call this routine, as it 900316643e7SJed Brown is used internally within the nonlinear solvers. 901316643e7SJed Brown 902316643e7SJed Brown Level: developer 903316643e7SJed Brown 904316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 905316643e7SJed Brown 906316643e7SJed Brown .seealso: TSSetIJacobian() 90763495f91SJed Brown @*/ 908d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 909316643e7SJed Brown { 910316643e7SJed Brown PetscErrorCode ierr; 91124989b8cSPeter Brune TSIJacobian ijacobian; 91224989b8cSPeter Brune TSRHSJacobian rhsjacobian; 91324989b8cSPeter Brune DM dm; 91424989b8cSPeter Brune void *ctx; 915316643e7SJed Brown 916316643e7SJed Brown PetscFunctionBegin; 9170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9180910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9190910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 920316643e7SJed Brown PetscValidPointer(A,6); 92194ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 922316643e7SJed Brown PetscValidPointer(B,7); 92394ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 92424989b8cSPeter Brune 92524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 92624989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9270298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 92824989b8cSPeter Brune 929ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 930316643e7SJed Brown 93194ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 93224989b8cSPeter Brune if (ijacobian) { 9336cd88445SBarry Smith PetscBool missing; 934316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 935d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 936316643e7SJed Brown PetscStackPop; 9376cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9386cd88445SBarry 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"); 939*3565c898SBarry Smith if (B != A) { 9406cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9416cd88445SBarry 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"); 9426cd88445SBarry Smith } 9434a6899ffSJed Brown } 944214bc6a2SJed Brown if (imex) { 945b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9464c26be97Sstefano_zampini PetscBool assembled; 94794ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9484c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9494c26be97Sstefano_zampini if (!assembled) { 9504c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9514c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9524c26be97Sstefano_zampini } 95394ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 95494ab13aaSBarry Smith if (A != B) { 95594ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9564c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9574c26be97Sstefano_zampini if (!assembled) { 9584c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9594c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9604c26be97Sstefano_zampini } 96194ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 962214bc6a2SJed Brown } 963214bc6a2SJed Brown } 964214bc6a2SJed Brown } else { 965e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 966e1244c69SJed Brown if (rhsjacobian) { 967214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 968d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 969e1244c69SJed Brown } 97094ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 971*3565c898SBarry Smith PetscBool flg; 972e1244c69SJed Brown ts->rhsjacobian.scale = -1; 973e1244c69SJed Brown ts->rhsjacobian.shift = shift; 974*3565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 975*3565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 976*3565c898SBarry Smith if (!flg) { 97794ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 97894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 979*3565c898SBarry Smith } 98094ab13aaSBarry Smith if (A != B) { 98194ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 98294ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 983316643e7SJed Brown } 984e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 985e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 986e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 98794ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 98894ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 98994ab13aaSBarry Smith if (A != B) { 99094ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 99194ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 992214bc6a2SJed Brown } 993316643e7SJed Brown } 99494ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 99594ab13aaSBarry Smith if (A != B) { 99694ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 997316643e7SJed Brown } 998316643e7SJed Brown } 999316643e7SJed Brown } 100094ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 1001316643e7SJed Brown PetscFunctionReturn(0); 1002316643e7SJed Brown } 1003316643e7SJed Brown 1004d763cef2SBarry Smith /*@C 1005d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1006b5abc632SBarry Smith where U_t = G(t,u). 1007d763cef2SBarry Smith 10083f9fe445SBarry Smith Logically Collective on TS 1009d763cef2SBarry Smith 1010d763cef2SBarry Smith Input Parameters: 1011d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10120298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1013d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1014d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10150298fd71SBarry Smith function evaluation routine (may be NULL) 1016d763cef2SBarry Smith 1017d763cef2SBarry Smith Calling sequence of func: 101887828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1019d763cef2SBarry Smith 1020d763cef2SBarry Smith + t - current timestep 1021d763cef2SBarry Smith . u - input vector 1022d763cef2SBarry Smith . F - function vector 1023d763cef2SBarry Smith - ctx - [optional] user-defined function context 1024d763cef2SBarry Smith 1025d763cef2SBarry Smith Level: beginner 1026d763cef2SBarry Smith 10272bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10282bbac0d3SBarry Smith 1029d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1030d763cef2SBarry Smith 1031ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1032d763cef2SBarry Smith @*/ 1033089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1034d763cef2SBarry Smith { 1035089b2837SJed Brown PetscErrorCode ierr; 1036089b2837SJed Brown SNES snes; 10370298fd71SBarry Smith Vec ralloc = NULL; 103824989b8cSPeter Brune DM dm; 1039d763cef2SBarry Smith 1040089b2837SJed Brown PetscFunctionBegin; 10410700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1042ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 104324989b8cSPeter Brune 104424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 104524989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1046089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1047e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1048e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1049e856ceecSJed Brown r = ralloc; 1050e856ceecSJed Brown } 1051089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1052e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1053d763cef2SBarry Smith PetscFunctionReturn(0); 1054d763cef2SBarry Smith } 1055d763cef2SBarry Smith 1056ef20d060SBarry Smith /*@C 1057abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1058ef20d060SBarry Smith 1059ef20d060SBarry Smith Logically Collective on TS 1060ef20d060SBarry Smith 1061ef20d060SBarry Smith Input Parameters: 1062ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1063ef20d060SBarry Smith . f - routine for evaluating the solution 1064ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 10650298fd71SBarry Smith function evaluation routine (may be NULL) 1066ef20d060SBarry Smith 1067ef20d060SBarry Smith Calling sequence of func: 1068ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1069ef20d060SBarry Smith 1070ef20d060SBarry Smith + t - current timestep 1071ef20d060SBarry Smith . u - output vector 1072ef20d060SBarry Smith - ctx - [optional] user-defined function context 1073ef20d060SBarry Smith 1074abd5a294SJed Brown Notes: 1075abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1076abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1077abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1078abd5a294SJed Brown 10794f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1080abd5a294SJed Brown 1081ef20d060SBarry Smith Level: beginner 1082ef20d060SBarry Smith 1083ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1084ef20d060SBarry Smith 10859b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 1086ef20d060SBarry Smith @*/ 1087ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1088ef20d060SBarry Smith { 1089ef20d060SBarry Smith PetscErrorCode ierr; 1090ef20d060SBarry Smith DM dm; 1091ef20d060SBarry Smith 1092ef20d060SBarry Smith PetscFunctionBegin; 1093ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1094ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1095ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1096ef20d060SBarry Smith PetscFunctionReturn(0); 1097ef20d060SBarry Smith } 1098ef20d060SBarry Smith 10999b7cd975SBarry Smith /*@C 11009b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 11019b7cd975SBarry Smith 11029b7cd975SBarry Smith Logically Collective on TS 11039b7cd975SBarry Smith 11049b7cd975SBarry Smith Input Parameters: 11059b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1106e162b725SBarry Smith . func - routine for evaluating the forcing function 11079b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11080298fd71SBarry Smith function evaluation routine (may be NULL) 11099b7cd975SBarry Smith 11109b7cd975SBarry Smith Calling sequence of func: 1111e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 11129b7cd975SBarry Smith 11139b7cd975SBarry Smith + t - current timestep 1114e162b725SBarry Smith . f - output vector 11159b7cd975SBarry Smith - ctx - [optional] user-defined function context 11169b7cd975SBarry Smith 11179b7cd975SBarry Smith Notes: 11189b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1119e162b725SBarry 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 1120e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1121e162b725SBarry Smith 1122e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1123e162b725SBarry Smith 1124e162b725SBarry 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 1125e162b725SBarry Smith parameters can be passed in the ctx variable. 11269b7cd975SBarry Smith 11279b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11289b7cd975SBarry Smith 11299b7cd975SBarry Smith Level: beginner 11309b7cd975SBarry Smith 11319b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11329b7cd975SBarry Smith 11339b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11349b7cd975SBarry Smith @*/ 1135e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11369b7cd975SBarry Smith { 11379b7cd975SBarry Smith PetscErrorCode ierr; 11389b7cd975SBarry Smith DM dm; 11399b7cd975SBarry Smith 11409b7cd975SBarry Smith PetscFunctionBegin; 11419b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11429b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1143e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11449b7cd975SBarry Smith PetscFunctionReturn(0); 11459b7cd975SBarry Smith } 11469b7cd975SBarry Smith 1147d763cef2SBarry Smith /*@C 1148f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1149b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1150d763cef2SBarry Smith 11513f9fe445SBarry Smith Logically Collective on TS 1152d763cef2SBarry Smith 1153d763cef2SBarry Smith Input Parameters: 1154d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1155e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1156e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1157d763cef2SBarry Smith . f - the Jacobian evaluation routine 1158d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11590298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1160d763cef2SBarry Smith 1161f7ab8db6SBarry Smith Calling sequence of f: 1162ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1163d763cef2SBarry Smith 1164d763cef2SBarry Smith + t - current timestep 1165d763cef2SBarry Smith . u - input vector 1166e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1167e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1168d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1169d763cef2SBarry Smith 11706cd88445SBarry Smith Notes: 11716cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 11726cd88445SBarry Smith 11736cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1174ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1175d763cef2SBarry Smith 1176d763cef2SBarry Smith Level: beginner 1177d763cef2SBarry Smith 1178d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1179d763cef2SBarry Smith 1180ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1181d763cef2SBarry Smith 1182d763cef2SBarry Smith @*/ 1183e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1184d763cef2SBarry Smith { 1185277b19d0SLisandro Dalcin PetscErrorCode ierr; 1186089b2837SJed Brown SNES snes; 118724989b8cSPeter Brune DM dm; 118824989b8cSPeter Brune TSIJacobian ijacobian; 1189277b19d0SLisandro Dalcin 1190d763cef2SBarry Smith PetscFunctionBegin; 11910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1192e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1193e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1194e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1195e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1196d763cef2SBarry Smith 119724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 119824989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1199e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1200e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1201e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1202e1244c69SJed Brown } 12030298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1204089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12055f659677SPeter Brune if (!ijacobian) { 1206e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12070e4ef248SJed Brown } 1208e5d3d808SBarry Smith if (Amat) { 1209e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12100e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1211e5d3d808SBarry Smith ts->Arhs = Amat; 12120e4ef248SJed Brown } 1213e5d3d808SBarry Smith if (Pmat) { 1214e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12150e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1216e5d3d808SBarry Smith ts->Brhs = Pmat; 12170e4ef248SJed Brown } 1218d763cef2SBarry Smith PetscFunctionReturn(0); 1219d763cef2SBarry Smith } 1220d763cef2SBarry Smith 1221316643e7SJed Brown 1222316643e7SJed Brown /*@C 1223b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1224316643e7SJed Brown 12253f9fe445SBarry Smith Logically Collective on TS 1226316643e7SJed Brown 1227316643e7SJed Brown Input Parameters: 1228316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12290298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1230316643e7SJed Brown . f - the function evaluation routine 12310298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1232316643e7SJed Brown 1233316643e7SJed Brown Calling sequence of f: 1234316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1235316643e7SJed Brown 1236316643e7SJed Brown + t - time at step/stage being solved 1237316643e7SJed Brown . u - state vector 1238316643e7SJed Brown . u_t - time derivative of state vector 1239316643e7SJed Brown . F - function vector 1240316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1241316643e7SJed Brown 1242316643e7SJed Brown Important: 12432bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1244316643e7SJed Brown 1245316643e7SJed Brown Level: beginner 1246316643e7SJed Brown 1247316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1248316643e7SJed Brown 1249d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1250316643e7SJed Brown @*/ 125151699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1252316643e7SJed Brown { 1253089b2837SJed Brown PetscErrorCode ierr; 1254089b2837SJed Brown SNES snes; 125551699248SLisandro Dalcin Vec ralloc = NULL; 125624989b8cSPeter Brune DM dm; 1257316643e7SJed Brown 1258316643e7SJed Brown PetscFunctionBegin; 12590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 126051699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 126124989b8cSPeter Brune 126224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 126324989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 126424989b8cSPeter Brune 1265089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 126651699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 126751699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 126851699248SLisandro Dalcin r = ralloc; 1269e856ceecSJed Brown } 127051699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 127151699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1272089b2837SJed Brown PetscFunctionReturn(0); 1273089b2837SJed Brown } 1274089b2837SJed Brown 1275089b2837SJed Brown /*@C 1276089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1277089b2837SJed Brown 1278089b2837SJed Brown Not Collective 1279089b2837SJed Brown 1280089b2837SJed Brown Input Parameter: 1281089b2837SJed Brown . ts - the TS context 1282089b2837SJed Brown 1283089b2837SJed Brown Output Parameter: 12840298fd71SBarry Smith + r - vector to hold residual (or NULL) 12850298fd71SBarry Smith . func - the function to compute residual (or NULL) 12860298fd71SBarry Smith - ctx - the function context (or NULL) 1287089b2837SJed Brown 1288089b2837SJed Brown Level: advanced 1289089b2837SJed Brown 1290089b2837SJed Brown .keywords: TS, nonlinear, get, function 1291089b2837SJed Brown 1292089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1293089b2837SJed Brown @*/ 1294089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1295089b2837SJed Brown { 1296089b2837SJed Brown PetscErrorCode ierr; 1297089b2837SJed Brown SNES snes; 129824989b8cSPeter Brune DM dm; 1299089b2837SJed Brown 1300089b2837SJed Brown PetscFunctionBegin; 1301089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1302089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13030298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 130424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 130524989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1306089b2837SJed Brown PetscFunctionReturn(0); 1307089b2837SJed Brown } 1308089b2837SJed Brown 1309089b2837SJed Brown /*@C 1310089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1311089b2837SJed Brown 1312089b2837SJed Brown Not Collective 1313089b2837SJed Brown 1314089b2837SJed Brown Input Parameter: 1315089b2837SJed Brown . ts - the TS context 1316089b2837SJed Brown 1317089b2837SJed Brown Output Parameter: 13180298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13190298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13200298fd71SBarry Smith - ctx - the function context (or NULL) 1321089b2837SJed Brown 1322089b2837SJed Brown Level: advanced 1323089b2837SJed Brown 1324089b2837SJed Brown .keywords: TS, nonlinear, get, function 1325089b2837SJed Brown 13262bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1327089b2837SJed Brown @*/ 1328089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1329089b2837SJed Brown { 1330089b2837SJed Brown PetscErrorCode ierr; 1331089b2837SJed Brown SNES snes; 133224989b8cSPeter Brune DM dm; 1333089b2837SJed Brown 1334089b2837SJed Brown PetscFunctionBegin; 1335089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1336089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13370298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 133824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 133924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1340316643e7SJed Brown PetscFunctionReturn(0); 1341316643e7SJed Brown } 1342316643e7SJed Brown 1343316643e7SJed Brown /*@C 1344a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1345ae8867d6SBarry Smith provided with TSSetIFunction(). 1346316643e7SJed Brown 13473f9fe445SBarry Smith Logically Collective on TS 1348316643e7SJed Brown 1349316643e7SJed Brown Input Parameters: 1350316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1351e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1352e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1353316643e7SJed Brown . f - the Jacobian evaluation routine 13540298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1355316643e7SJed Brown 1356316643e7SJed Brown Calling sequence of f: 1357ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1358316643e7SJed Brown 1359316643e7SJed Brown + t - time at step/stage being solved 13601b4a444bSJed Brown . U - state vector 13611b4a444bSJed Brown . U_t - time derivative of state vector 1362316643e7SJed Brown . a - shift 1363e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1364e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1365316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1366316643e7SJed Brown 1367316643e7SJed Brown Notes: 1368e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1369316643e7SJed Brown 1370895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1371895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1372895c21f2SBarry Smith 1373a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1374b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1375a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1376a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1377a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1378a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1379a4f0a591SBarry Smith 13806cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 13816cd88445SBarry Smith 13826cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1383ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1384ca5f011dSBarry Smith 1385316643e7SJed Brown Level: beginner 1386316643e7SJed Brown 1387316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1388316643e7SJed Brown 1389ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1390316643e7SJed Brown 1391316643e7SJed Brown @*/ 1392e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1393316643e7SJed Brown { 1394316643e7SJed Brown PetscErrorCode ierr; 1395089b2837SJed Brown SNES snes; 139624989b8cSPeter Brune DM dm; 1397316643e7SJed Brown 1398316643e7SJed Brown PetscFunctionBegin; 13990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1400e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1401e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1402e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1403e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 140424989b8cSPeter Brune 140524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 140624989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 140724989b8cSPeter Brune 1408089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1409e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1410316643e7SJed Brown PetscFunctionReturn(0); 1411316643e7SJed Brown } 1412316643e7SJed Brown 1413e1244c69SJed Brown /*@ 1414e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1415e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1416e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1417e1244c69SJed Brown not been changed by the TS. 1418e1244c69SJed Brown 1419e1244c69SJed Brown Logically Collective 1420e1244c69SJed Brown 1421e1244c69SJed Brown Input Arguments: 1422e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1423e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1424e1244c69SJed Brown 1425e1244c69SJed Brown Level: intermediate 1426e1244c69SJed Brown 1427e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1428e1244c69SJed Brown @*/ 1429e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1430e1244c69SJed Brown { 1431e1244c69SJed Brown PetscFunctionBegin; 1432e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1433e1244c69SJed Brown PetscFunctionReturn(0); 1434e1244c69SJed Brown } 1435e1244c69SJed Brown 1436efe9872eSLisandro Dalcin /*@C 1437efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1438efe9872eSLisandro Dalcin 1439efe9872eSLisandro Dalcin Logically Collective on TS 1440efe9872eSLisandro Dalcin 1441efe9872eSLisandro Dalcin Input Parameters: 1442efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1443efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1444efe9872eSLisandro Dalcin . fun - the function evaluation routine 1445efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1446efe9872eSLisandro Dalcin 1447efe9872eSLisandro Dalcin Calling sequence of fun: 1448efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1449efe9872eSLisandro Dalcin 1450efe9872eSLisandro Dalcin + t - time at step/stage being solved 1451efe9872eSLisandro Dalcin . U - state vector 1452efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1453efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1454efe9872eSLisandro Dalcin . F - function vector 1455efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1456efe9872eSLisandro Dalcin 1457efe9872eSLisandro Dalcin Level: beginner 1458efe9872eSLisandro Dalcin 1459efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1460efe9872eSLisandro Dalcin 1461efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1462efe9872eSLisandro Dalcin @*/ 1463efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1464efe9872eSLisandro Dalcin { 1465efe9872eSLisandro Dalcin DM dm; 1466efe9872eSLisandro Dalcin PetscErrorCode ierr; 1467efe9872eSLisandro Dalcin 1468efe9872eSLisandro Dalcin PetscFunctionBegin; 1469efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1470efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1471efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1472efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1473efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1474efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1475efe9872eSLisandro Dalcin } 1476efe9872eSLisandro Dalcin 1477efe9872eSLisandro Dalcin /*@C 1478efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1479efe9872eSLisandro Dalcin 1480efe9872eSLisandro Dalcin Not Collective 1481efe9872eSLisandro Dalcin 1482efe9872eSLisandro Dalcin Input Parameter: 1483efe9872eSLisandro Dalcin . ts - the TS context 1484efe9872eSLisandro Dalcin 1485efe9872eSLisandro Dalcin Output Parameter: 1486efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1487efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1488efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1489efe9872eSLisandro Dalcin 1490efe9872eSLisandro Dalcin Level: advanced 1491efe9872eSLisandro Dalcin 1492efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1493efe9872eSLisandro Dalcin 1494efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1495efe9872eSLisandro Dalcin @*/ 1496efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1497efe9872eSLisandro Dalcin { 1498efe9872eSLisandro Dalcin PetscErrorCode ierr; 1499efe9872eSLisandro Dalcin SNES snes; 1500efe9872eSLisandro Dalcin DM dm; 1501efe9872eSLisandro Dalcin 1502efe9872eSLisandro Dalcin PetscFunctionBegin; 1503efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1504efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1505efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1506efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1507efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1508efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1509efe9872eSLisandro Dalcin } 1510efe9872eSLisandro Dalcin 1511efe9872eSLisandro Dalcin /*@C 1512bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1513efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1514efe9872eSLisandro Dalcin 1515efe9872eSLisandro Dalcin Logically Collective on TS 1516efe9872eSLisandro Dalcin 1517efe9872eSLisandro Dalcin Input Parameters: 1518efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1519efe9872eSLisandro Dalcin . J - Jacobian matrix 1520efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1521efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1522efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1523efe9872eSLisandro Dalcin 1524efe9872eSLisandro Dalcin Calling sequence of jac: 1525bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1526efe9872eSLisandro Dalcin 1527efe9872eSLisandro Dalcin + t - time at step/stage being solved 1528efe9872eSLisandro Dalcin . U - state vector 1529efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1530efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1531efe9872eSLisandro Dalcin . v - shift for U_t 1532efe9872eSLisandro Dalcin . a - shift for U_tt 1533efe9872eSLisandro 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 1534efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1535efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1536efe9872eSLisandro Dalcin 1537efe9872eSLisandro Dalcin Notes: 1538efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1539efe9872eSLisandro Dalcin 1540efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1541efe9872eSLisandro 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. 1542efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1543bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1544efe9872eSLisandro Dalcin 1545efe9872eSLisandro Dalcin Level: beginner 1546efe9872eSLisandro Dalcin 1547efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1548efe9872eSLisandro Dalcin 1549efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1550efe9872eSLisandro Dalcin @*/ 1551efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1552efe9872eSLisandro Dalcin { 1553efe9872eSLisandro Dalcin DM dm; 1554efe9872eSLisandro Dalcin PetscErrorCode ierr; 1555efe9872eSLisandro Dalcin 1556efe9872eSLisandro Dalcin PetscFunctionBegin; 1557efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1558efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1559efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1560efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1561efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1562efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1563efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1564efe9872eSLisandro Dalcin } 1565efe9872eSLisandro Dalcin 1566efe9872eSLisandro Dalcin /*@C 1567efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1568efe9872eSLisandro Dalcin 1569efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1570efe9872eSLisandro Dalcin 1571efe9872eSLisandro Dalcin Input Parameter: 1572efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1573efe9872eSLisandro Dalcin 1574efe9872eSLisandro Dalcin Output Parameters: 1575efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1576efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1577efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1578efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1579efe9872eSLisandro Dalcin 1580efe9872eSLisandro Dalcin Notes: You can pass in NULL for any return argument you do not need. 1581efe9872eSLisandro Dalcin 1582efe9872eSLisandro Dalcin Level: advanced 1583efe9872eSLisandro Dalcin 1584efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 1585efe9872eSLisandro Dalcin 1586efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1587efe9872eSLisandro Dalcin @*/ 1588efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1589efe9872eSLisandro Dalcin { 1590efe9872eSLisandro Dalcin PetscErrorCode ierr; 1591efe9872eSLisandro Dalcin SNES snes; 1592efe9872eSLisandro Dalcin DM dm; 1593efe9872eSLisandro Dalcin 1594efe9872eSLisandro Dalcin PetscFunctionBegin; 1595efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1596efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1597efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1598efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1599efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1600efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1601efe9872eSLisandro Dalcin } 1602efe9872eSLisandro Dalcin 1603efe9872eSLisandro Dalcin /*@ 1604efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1605efe9872eSLisandro Dalcin 1606efe9872eSLisandro Dalcin Collective on TS and Vec 1607efe9872eSLisandro Dalcin 1608efe9872eSLisandro Dalcin Input Parameters: 1609efe9872eSLisandro Dalcin + ts - the TS context 1610efe9872eSLisandro Dalcin . t - current time 1611efe9872eSLisandro Dalcin . U - state vector 1612efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1613efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1614efe9872eSLisandro Dalcin 1615efe9872eSLisandro Dalcin Output Parameter: 1616efe9872eSLisandro Dalcin . F - the residual vector 1617efe9872eSLisandro Dalcin 1618efe9872eSLisandro Dalcin Note: 1619efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1620efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1621efe9872eSLisandro Dalcin 1622efe9872eSLisandro Dalcin Level: developer 1623efe9872eSLisandro Dalcin 1624efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1625efe9872eSLisandro Dalcin 1626efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1627efe9872eSLisandro Dalcin @*/ 1628efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1629efe9872eSLisandro Dalcin { 1630efe9872eSLisandro Dalcin DM dm; 1631efe9872eSLisandro Dalcin TSI2Function I2Function; 1632efe9872eSLisandro Dalcin void *ctx; 1633efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1634efe9872eSLisandro Dalcin PetscErrorCode ierr; 1635efe9872eSLisandro Dalcin 1636efe9872eSLisandro Dalcin PetscFunctionBegin; 1637efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1638efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1639efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1640efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1641efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1642efe9872eSLisandro Dalcin 1643efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1644efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1645efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1646efe9872eSLisandro Dalcin 1647efe9872eSLisandro Dalcin if (!I2Function) { 1648efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1649efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1650efe9872eSLisandro Dalcin } 1651efe9872eSLisandro Dalcin 1652efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1653efe9872eSLisandro Dalcin 1654efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1655efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1656efe9872eSLisandro Dalcin PetscStackPop; 1657efe9872eSLisandro Dalcin 1658efe9872eSLisandro Dalcin if (rhsfunction) { 1659efe9872eSLisandro Dalcin Vec Frhs; 1660efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1661efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1662efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1663efe9872eSLisandro Dalcin } 1664efe9872eSLisandro Dalcin 1665efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1666efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1667efe9872eSLisandro Dalcin } 1668efe9872eSLisandro Dalcin 1669efe9872eSLisandro Dalcin /*@ 1670efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1671efe9872eSLisandro Dalcin 1672efe9872eSLisandro Dalcin Collective on TS and Vec 1673efe9872eSLisandro Dalcin 1674efe9872eSLisandro Dalcin Input Parameters: 1675efe9872eSLisandro Dalcin + ts - the TS context 1676efe9872eSLisandro Dalcin . t - current timestep 1677efe9872eSLisandro Dalcin . U - state vector 1678efe9872eSLisandro Dalcin . V - time derivative of state vector 1679efe9872eSLisandro Dalcin . A - second time derivative of state vector 1680efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1681efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1682efe9872eSLisandro Dalcin 1683efe9872eSLisandro Dalcin Output Parameters: 1684efe9872eSLisandro Dalcin + J - Jacobian matrix 1685efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1686efe9872eSLisandro Dalcin 1687efe9872eSLisandro Dalcin Notes: 1688efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1689efe9872eSLisandro Dalcin 1690efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1691efe9872eSLisandro Dalcin 1692efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1693efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1694efe9872eSLisandro Dalcin 1695efe9872eSLisandro Dalcin Level: developer 1696efe9872eSLisandro Dalcin 1697efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1698efe9872eSLisandro Dalcin 1699efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1700efe9872eSLisandro Dalcin @*/ 1701efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1702efe9872eSLisandro Dalcin { 1703efe9872eSLisandro Dalcin DM dm; 1704efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1705efe9872eSLisandro Dalcin void *ctx; 1706efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1707efe9872eSLisandro Dalcin PetscErrorCode ierr; 1708efe9872eSLisandro Dalcin 1709efe9872eSLisandro Dalcin PetscFunctionBegin; 1710efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1711efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1712efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1713efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1714efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1715efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1716efe9872eSLisandro Dalcin 1717efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1718efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1719efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1720efe9872eSLisandro Dalcin 1721efe9872eSLisandro Dalcin if (!I2Jacobian) { 1722efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1723efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1724efe9872eSLisandro Dalcin } 1725efe9872eSLisandro Dalcin 1726efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1727efe9872eSLisandro Dalcin 1728efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1729efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1730efe9872eSLisandro Dalcin PetscStackPop; 1731efe9872eSLisandro Dalcin 1732efe9872eSLisandro Dalcin if (rhsjacobian) { 1733efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1734efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1735efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1736efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1737efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1738efe9872eSLisandro Dalcin } 1739efe9872eSLisandro Dalcin 1740efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1741efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1742efe9872eSLisandro Dalcin } 1743efe9872eSLisandro Dalcin 1744efe9872eSLisandro Dalcin /*@ 1745efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1746efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1747efe9872eSLisandro Dalcin 1748efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1749efe9872eSLisandro Dalcin 1750efe9872eSLisandro Dalcin Input Parameters: 1751efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1752efe9872eSLisandro Dalcin . u - the solution vector 1753efe9872eSLisandro Dalcin - v - the time derivative vector 1754efe9872eSLisandro Dalcin 1755efe9872eSLisandro Dalcin Level: beginner 1756efe9872eSLisandro Dalcin 1757efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1758efe9872eSLisandro Dalcin @*/ 1759efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1760efe9872eSLisandro Dalcin { 1761efe9872eSLisandro Dalcin PetscErrorCode ierr; 1762efe9872eSLisandro Dalcin 1763efe9872eSLisandro Dalcin PetscFunctionBegin; 1764efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1765efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1766efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1767efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1768efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1769efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1770efe9872eSLisandro Dalcin ts->vec_dot = v; 1771efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1772efe9872eSLisandro Dalcin } 1773efe9872eSLisandro Dalcin 1774efe9872eSLisandro Dalcin /*@ 1775efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1776efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1777efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1778efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1779efe9872eSLisandro Dalcin 1780efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1781efe9872eSLisandro Dalcin 1782efe9872eSLisandro Dalcin Input Parameter: 1783efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1784efe9872eSLisandro Dalcin 1785efe9872eSLisandro Dalcin Output Parameter: 1786efe9872eSLisandro Dalcin + u - the vector containing the solution 1787efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1788efe9872eSLisandro Dalcin 1789efe9872eSLisandro Dalcin Level: intermediate 1790efe9872eSLisandro Dalcin 1791efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1792efe9872eSLisandro Dalcin 1793efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1794efe9872eSLisandro Dalcin @*/ 1795efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1796efe9872eSLisandro Dalcin { 1797efe9872eSLisandro Dalcin PetscFunctionBegin; 1798efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1799efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1800efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1801efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1802efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1803efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1804efe9872eSLisandro Dalcin } 1805efe9872eSLisandro Dalcin 180655849f57SBarry Smith /*@C 180755849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 180855849f57SBarry Smith 180955849f57SBarry Smith Collective on PetscViewer 181055849f57SBarry Smith 181155849f57SBarry Smith Input Parameters: 181255849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 181355849f57SBarry Smith some related function before a call to TSLoad(). 181455849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 181555849f57SBarry Smith 181655849f57SBarry Smith Level: intermediate 181755849f57SBarry Smith 181855849f57SBarry Smith Notes: 181955849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 182055849f57SBarry Smith 182155849f57SBarry Smith Notes for advanced users: 182255849f57SBarry Smith Most users should not need to know the details of the binary storage 182355849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 182455849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 182555849f57SBarry Smith format is 182655849f57SBarry Smith .vb 182755849f57SBarry Smith has not yet been determined 182855849f57SBarry Smith .ve 182955849f57SBarry Smith 183055849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 183155849f57SBarry Smith @*/ 1832f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 183355849f57SBarry Smith { 183455849f57SBarry Smith PetscErrorCode ierr; 183555849f57SBarry Smith PetscBool isbinary; 183655849f57SBarry Smith PetscInt classid; 183755849f57SBarry Smith char type[256]; 18382d53ad75SBarry Smith DMTS sdm; 1839ad6bc421SBarry Smith DM dm; 184055849f57SBarry Smith 184155849f57SBarry Smith PetscFunctionBegin; 1842f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 184355849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 184455849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 184555849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 184655849f57SBarry Smith 1847060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1848ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1849060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1850f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1851f2c2a1b9SBarry Smith if (ts->ops->load) { 1852f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1853f2c2a1b9SBarry Smith } 1854ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1855ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1856ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1857f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1858f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 18592d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 18602d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 186155849f57SBarry Smith PetscFunctionReturn(0); 186255849f57SBarry Smith } 186355849f57SBarry Smith 18649804daf3SBarry Smith #include <petscdraw.h> 1865e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1866e04113cfSBarry Smith #include <petscviewersaws.h> 1867f05ece33SBarry Smith #endif 18687e2c5f70SBarry Smith /*@C 1869d763cef2SBarry Smith TSView - Prints the TS data structure. 1870d763cef2SBarry Smith 18714c49b128SBarry Smith Collective on TS 1872d763cef2SBarry Smith 1873d763cef2SBarry Smith Input Parameters: 1874d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1875d763cef2SBarry Smith - viewer - visualization context 1876d763cef2SBarry Smith 1877d763cef2SBarry Smith Options Database Key: 1878d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1879d763cef2SBarry Smith 1880d763cef2SBarry Smith Notes: 1881d763cef2SBarry Smith The available visualization contexts include 1882b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1883b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1884d763cef2SBarry Smith output where only the first processor opens 1885d763cef2SBarry Smith the file. All other processors send their 1886d763cef2SBarry Smith data to the first processor to print. 1887d763cef2SBarry Smith 1888d763cef2SBarry Smith The user can open an alternative visualization context with 1889b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1890d763cef2SBarry Smith 1891d763cef2SBarry Smith Level: beginner 1892d763cef2SBarry Smith 1893d763cef2SBarry Smith .keywords: TS, timestep, view 1894d763cef2SBarry Smith 1895b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1896d763cef2SBarry Smith @*/ 18977087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1898d763cef2SBarry Smith { 1899dfbe8321SBarry Smith PetscErrorCode ierr; 190019fd82e9SBarry Smith TSType type; 19012b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 19022d53ad75SBarry Smith DMTS sdm; 1903e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1904536b137fSBarry Smith PetscBool issaws; 1905f05ece33SBarry Smith #endif 1906d763cef2SBarry Smith 1907d763cef2SBarry Smith PetscFunctionBegin; 19080700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19093050cee2SBarry Smith if (!viewer) { 1910ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 19113050cee2SBarry Smith } 19120700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1913c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1914fd16b177SBarry Smith 1915251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1916251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 191755849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 19182b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1919e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1920536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1921f05ece33SBarry Smith #endif 192232077d6dSBarry Smith if (iascii) { 1923dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 192477431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 19257c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1926d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19275ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1928c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1929d763cef2SBarry Smith } 19305ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1931193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1932a0af407cSBarry Smith if (ts->vrtol) { 1933a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1934a0af407cSBarry Smith } else { 1935a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1936a0af407cSBarry Smith } 1937a0af407cSBarry Smith if (ts->vatol) { 1938a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1939a0af407cSBarry Smith } else { 1940a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1941a0af407cSBarry Smith } 19422d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19432d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1944d52bd9f3SBarry Smith if (ts->ops->view) { 1945d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1946d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1947d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1948d52bd9f3SBarry Smith } 19490f5bd95cSBarry Smith } else if (isstring) { 1950a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1951b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 195255849f57SBarry Smith } else if (isbinary) { 195355849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 195455849f57SBarry Smith MPI_Comm comm; 195555849f57SBarry Smith PetscMPIInt rank; 195655849f57SBarry Smith char type[256]; 195755849f57SBarry Smith 195855849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 195955849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 196055849f57SBarry Smith if (!rank) { 196155849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 196255849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 196355849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 196455849f57SBarry Smith } 196555849f57SBarry Smith if (ts->ops->view) { 196655849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 196755849f57SBarry Smith } 1968f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1969f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 19702d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19712d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19722b0a91c0SBarry Smith } else if (isdraw) { 19732b0a91c0SBarry Smith PetscDraw draw; 19742b0a91c0SBarry Smith char str[36]; 197589fd9fafSBarry Smith PetscReal x,y,bottom,h; 19762b0a91c0SBarry Smith 19772b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 19782b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 19792b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 19802b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 198151fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 198289fd9fafSBarry Smith bottom = y - h; 19832b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 19842b0a91c0SBarry Smith if (ts->ops->view) { 19852b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 19862b0a91c0SBarry Smith } 19872b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1988e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1989536b137fSBarry Smith } else if (issaws) { 1990d45a07a7SBarry Smith PetscMPIInt rank; 19912657e9d9SBarry Smith const char *name; 19922657e9d9SBarry Smith 19932657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1994d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1995d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1996d45a07a7SBarry Smith char dir[1024]; 1997d45a07a7SBarry Smith 1998e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1999a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 20002657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 20012657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 20022657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2003d763cef2SBarry Smith } 20040acecf5bSBarry Smith if (ts->ops->view) { 20050acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20060acecf5bSBarry Smith } 2007f05ece33SBarry Smith #endif 2008f05ece33SBarry Smith } 2009f05ece33SBarry Smith 2010b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2011251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2012b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2013d763cef2SBarry Smith PetscFunctionReturn(0); 2014d763cef2SBarry Smith } 2015d763cef2SBarry Smith 2016d763cef2SBarry Smith 2017b07ff414SBarry Smith /*@ 2018d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2019d763cef2SBarry Smith the timesteppers. 2020d763cef2SBarry Smith 20213f9fe445SBarry Smith Logically Collective on TS 2022d763cef2SBarry Smith 2023d763cef2SBarry Smith Input Parameters: 2024d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2025d763cef2SBarry Smith - usrP - optional user context 2026d763cef2SBarry Smith 2027daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2028daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2029daf670e6SBarry Smith 2030d763cef2SBarry Smith Level: intermediate 2031d763cef2SBarry Smith 2032d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2033d763cef2SBarry Smith 2034d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2035d763cef2SBarry Smith @*/ 20367087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2037d763cef2SBarry Smith { 2038d763cef2SBarry Smith PetscFunctionBegin; 20390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2040d763cef2SBarry Smith ts->user = usrP; 2041d763cef2SBarry Smith PetscFunctionReturn(0); 2042d763cef2SBarry Smith } 2043d763cef2SBarry Smith 2044b07ff414SBarry Smith /*@ 2045d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2046d763cef2SBarry Smith timestepper. 2047d763cef2SBarry Smith 2048d763cef2SBarry Smith Not Collective 2049d763cef2SBarry Smith 2050d763cef2SBarry Smith Input Parameter: 2051d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2052d763cef2SBarry Smith 2053d763cef2SBarry Smith Output Parameter: 2054d763cef2SBarry Smith . usrP - user context 2055d763cef2SBarry Smith 2056daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2057daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2058daf670e6SBarry Smith 2059d763cef2SBarry Smith Level: intermediate 2060d763cef2SBarry Smith 2061d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2062d763cef2SBarry Smith 2063d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2064d763cef2SBarry Smith @*/ 2065e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2066d763cef2SBarry Smith { 2067d763cef2SBarry Smith PetscFunctionBegin; 20680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2069e71120c6SJed Brown *(void**)usrP = ts->user; 2070d763cef2SBarry Smith PetscFunctionReturn(0); 2071d763cef2SBarry Smith } 2072d763cef2SBarry Smith 2073d763cef2SBarry Smith /*@ 2074b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 2075d763cef2SBarry Smith 2076d763cef2SBarry Smith Not Collective 2077d763cef2SBarry Smith 2078d763cef2SBarry Smith Input Parameter: 2079d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2080d763cef2SBarry Smith 2081d763cef2SBarry Smith Output Parameter: 2082b8123daeSJed Brown . iter - number of steps completed so far 2083d763cef2SBarry Smith 2084d763cef2SBarry Smith Level: intermediate 2085d763cef2SBarry Smith 2086d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 20879be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2088d763cef2SBarry Smith @*/ 20897087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 2090d763cef2SBarry Smith { 2091d763cef2SBarry Smith PetscFunctionBegin; 20920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20934482741eSBarry Smith PetscValidIntPointer(iter,2); 2094d763cef2SBarry Smith *iter = ts->steps; 2095d763cef2SBarry Smith PetscFunctionReturn(0); 2096d763cef2SBarry Smith } 2097d763cef2SBarry Smith 2098d763cef2SBarry Smith /*@ 2099d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 2100d763cef2SBarry Smith as well as the initial time. 2101d763cef2SBarry Smith 21023f9fe445SBarry Smith Logically Collective on TS 2103d763cef2SBarry Smith 2104d763cef2SBarry Smith Input Parameters: 2105d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2106d763cef2SBarry Smith . initial_time - the initial time 2107d763cef2SBarry Smith - time_step - the size of the timestep 2108d763cef2SBarry Smith 2109d763cef2SBarry Smith Level: intermediate 2110d763cef2SBarry Smith 2111d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 2112d763cef2SBarry Smith 2113d763cef2SBarry Smith .keywords: TS, set, initial, timestep 2114d763cef2SBarry Smith @*/ 21157087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2116d763cef2SBarry Smith { 2117e144a568SJed Brown PetscErrorCode ierr; 2118e144a568SJed Brown 2119d763cef2SBarry Smith PetscFunctionBegin; 21200700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2121e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2122d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2123d763cef2SBarry Smith PetscFunctionReturn(0); 2124d763cef2SBarry Smith } 2125d763cef2SBarry Smith 2126d763cef2SBarry Smith /*@ 2127d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2128d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2129d763cef2SBarry Smith 21303f9fe445SBarry Smith Logically Collective on TS 2131d763cef2SBarry Smith 2132d763cef2SBarry Smith Input Parameters: 2133d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2134d763cef2SBarry Smith - time_step - the size of the timestep 2135d763cef2SBarry Smith 2136d763cef2SBarry Smith Level: intermediate 2137d763cef2SBarry Smith 2138d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2139d763cef2SBarry Smith 2140d763cef2SBarry Smith .keywords: TS, set, timestep 2141d763cef2SBarry Smith @*/ 21427087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2143d763cef2SBarry Smith { 2144d763cef2SBarry Smith PetscFunctionBegin; 21450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2146c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2147d763cef2SBarry Smith ts->time_step = time_step; 2148d763cef2SBarry Smith PetscFunctionReturn(0); 2149d763cef2SBarry Smith } 2150d763cef2SBarry Smith 2151a43b19c4SJed Brown /*@ 215249354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 215349354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 215449354f04SShri Abhyankar or just return at the final time TS computed. 2155a43b19c4SJed Brown 2156a43b19c4SJed Brown Logically Collective on TS 2157a43b19c4SJed Brown 2158a43b19c4SJed Brown Input Parameter: 2159a43b19c4SJed Brown + ts - the time-step context 216049354f04SShri Abhyankar - eftopt - exact final time option 2161a43b19c4SJed Brown 2162feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2163feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2164feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2165feed9e9dSBarry Smith 2166feed9e9dSBarry Smith Options Database: 2167feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2168feed9e9dSBarry Smith 2169ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2170ee346746SBarry Smith then the final time you selected. 2171ee346746SBarry Smith 2172a43b19c4SJed Brown Level: beginner 2173a43b19c4SJed Brown 2174a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 2175a43b19c4SJed Brown @*/ 217649354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2177a43b19c4SJed Brown { 2178a43b19c4SJed Brown PetscFunctionBegin; 2179a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 218049354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 218149354f04SShri Abhyankar ts->exact_final_time = eftopt; 2182a43b19c4SJed Brown PetscFunctionReturn(0); 2183a43b19c4SJed Brown } 2184a43b19c4SJed Brown 2185d763cef2SBarry Smith /*@ 2186d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2187d763cef2SBarry Smith 2188d763cef2SBarry Smith Not Collective 2189d763cef2SBarry Smith 2190d763cef2SBarry Smith Input Parameter: 2191d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2192d763cef2SBarry Smith 2193d763cef2SBarry Smith Output Parameter: 2194d763cef2SBarry Smith . dt - the current timestep size 2195d763cef2SBarry Smith 2196d763cef2SBarry Smith Level: intermediate 2197d763cef2SBarry Smith 2198d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2199d763cef2SBarry Smith 2200d763cef2SBarry Smith .keywords: TS, get, timestep 2201d763cef2SBarry Smith @*/ 22027087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2203d763cef2SBarry Smith { 2204d763cef2SBarry Smith PetscFunctionBegin; 22050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2206f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2207d763cef2SBarry Smith *dt = ts->time_step; 2208d763cef2SBarry Smith PetscFunctionReturn(0); 2209d763cef2SBarry Smith } 2210d763cef2SBarry Smith 2211d8e5e3e6SSatish Balay /*@ 2212d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2213d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2214d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2215d763cef2SBarry Smith the solution at the next timestep has been calculated. 2216d763cef2SBarry Smith 2217d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2218d763cef2SBarry Smith 2219d763cef2SBarry Smith Input Parameter: 2220d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2221d763cef2SBarry Smith 2222d763cef2SBarry Smith Output Parameter: 2223d763cef2SBarry Smith . v - the vector containing the solution 2224d763cef2SBarry Smith 222563e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 222663e21af5SBarry Smith final time. It returns the solution at the next timestep. 222763e21af5SBarry Smith 2228d763cef2SBarry Smith Level: intermediate 2229d763cef2SBarry Smith 2230b2bf4f3aSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents() 2231d763cef2SBarry Smith 2232d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2233d763cef2SBarry Smith @*/ 22347087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2235d763cef2SBarry Smith { 2236d763cef2SBarry Smith PetscFunctionBegin; 22370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22384482741eSBarry Smith PetscValidPointer(v,2); 22398737fe31SLisandro Dalcin *v = ts->vec_sol; 2240d763cef2SBarry Smith PetscFunctionReturn(0); 2241d763cef2SBarry Smith } 2242d763cef2SBarry Smith 224303fe5f5eSDebojyoti Ghosh /*@ 2244b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 224503fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2246b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 224703fe5f5eSDebojyoti Ghosh structure as the solution vector. 224803fe5f5eSDebojyoti Ghosh 224903fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 225003fe5f5eSDebojyoti Ghosh 225103fe5f5eSDebojyoti Ghosh Parameters : 225203fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2253b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2254b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 225503fe5f5eSDebojyoti Ghosh returned in v. 2256b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 225703fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2258b2bf4f3aSDebojyoti Ghosh the number of solutions components). 225903fe5f5eSDebojyoti Ghosh 22604cdd57e5SDebojyoti Ghosh Level: advanced 226103fe5f5eSDebojyoti Ghosh 226203fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 226303fe5f5eSDebojyoti Ghosh 226403fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 226503fe5f5eSDebojyoti Ghosh @*/ 2266b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 226703fe5f5eSDebojyoti Ghosh { 226803fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 226903fe5f5eSDebojyoti Ghosh 227003fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 227103fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2272b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 227303fe5f5eSDebojyoti Ghosh else { 2274b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 227503fe5f5eSDebojyoti Ghosh } 227603fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 227703fe5f5eSDebojyoti Ghosh } 227803fe5f5eSDebojyoti Ghosh 22794cdd57e5SDebojyoti Ghosh /*@ 22804cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 22814cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 22824cdd57e5SDebojyoti Ghosh 22834cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 22844cdd57e5SDebojyoti Ghosh 22854cdd57e5SDebojyoti Ghosh Parameters : 22864cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 22874cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 22884cdd57e5SDebojyoti Ghosh 22894cdd57e5SDebojyoti Ghosh Level: intermediate 22904cdd57e5SDebojyoti Ghosh 22914cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 22924cdd57e5SDebojyoti Ghosh 22934cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 22944cdd57e5SDebojyoti Ghosh @*/ 22954cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 22964cdd57e5SDebojyoti Ghosh { 22974cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 22984cdd57e5SDebojyoti Ghosh 22994cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23004cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2301f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 23024cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2303f6356ec7SDebojyoti Ghosh } else { 2304f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2305f6356ec7SDebojyoti Ghosh } 23064cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23074cdd57e5SDebojyoti Ghosh } 23084cdd57e5SDebojyoti Ghosh 23094cdd57e5SDebojyoti Ghosh /*@ 23104cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 23114cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 23124cdd57e5SDebojyoti Ghosh 23134cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23144cdd57e5SDebojyoti Ghosh 23159657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 23169657682dSDebojyoti Ghosh 23174cdd57e5SDebojyoti Ghosh Parameters : 23184cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2319657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 23204cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 23214cdd57e5SDebojyoti Ghosh 23224cdd57e5SDebojyoti Ghosh Level: intermediate 23234cdd57e5SDebojyoti Ghosh 232457df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 23254cdd57e5SDebojyoti Ghosh 23264cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 23274cdd57e5SDebojyoti Ghosh @*/ 23280a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 23294cdd57e5SDebojyoti Ghosh { 23304cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23314cdd57e5SDebojyoti Ghosh 23324cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23334cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2334f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 23350a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2336f6356ec7SDebojyoti Ghosh } else { 2337f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2338f6356ec7SDebojyoti Ghosh } 23394cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23404cdd57e5SDebojyoti Ghosh } 23414cdd57e5SDebojyoti Ghosh 234257df6a1bSDebojyoti Ghosh /*@ 234357df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 234457df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 234557df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 234657df6a1bSDebojyoti Ghosh 234757df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 234857df6a1bSDebojyoti Ghosh 234957df6a1bSDebojyoti Ghosh Parameters : 235057df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 235157df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 235257df6a1bSDebojyoti Ghosh 235357df6a1bSDebojyoti Ghosh Level: intermediate 235457df6a1bSDebojyoti Ghosh 235557df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 235657df6a1bSDebojyoti Ghosh 235757df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 235857df6a1bSDebojyoti Ghosh @*/ 235957df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 236057df6a1bSDebojyoti Ghosh { 236157df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 236257df6a1bSDebojyoti Ghosh 236357df6a1bSDebojyoti Ghosh PetscFunctionBegin; 236457df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23659657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 236657df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 236757df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 236857df6a1bSDebojyoti Ghosh } 236957df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 237057df6a1bSDebojyoti Ghosh } 237157df6a1bSDebojyoti Ghosh 2372c235aa8dSHong Zhang /*@ 2373dfb21088SHong Zhang TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2374c235aa8dSHong Zhang 2375c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 2376c235aa8dSHong Zhang 2377c235aa8dSHong Zhang Input Parameter: 2378c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 2379c235aa8dSHong Zhang 2380c235aa8dSHong Zhang Output Parameter: 2381abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2382abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2383c235aa8dSHong Zhang 2384c235aa8dSHong Zhang Level: intermediate 2385c235aa8dSHong Zhang 2386c235aa8dSHong Zhang .seealso: TSGetTimeStep() 2387c235aa8dSHong Zhang 2388c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 2389c235aa8dSHong Zhang @*/ 2390dfb21088SHong Zhang PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2391c235aa8dSHong Zhang { 2392c235aa8dSHong Zhang PetscFunctionBegin; 2393c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2394abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 2395abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 2396abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 2397c235aa8dSHong Zhang PetscFunctionReturn(0); 2398c235aa8dSHong Zhang } 2399c235aa8dSHong Zhang 2400bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2401d8e5e3e6SSatish Balay /*@ 2402bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2403d763cef2SBarry Smith 2404bdad233fSMatthew Knepley Not collective 2405d763cef2SBarry Smith 2406bdad233fSMatthew Knepley Input Parameters: 2407bdad233fSMatthew Knepley + ts - The TS 2408bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2409d763cef2SBarry Smith .vb 24100910c330SBarry Smith U_t - A U = 0 (linear) 24110910c330SBarry Smith U_t - A(t) U = 0 (linear) 24120910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2413d763cef2SBarry Smith .ve 2414d763cef2SBarry Smith 2415d763cef2SBarry Smith Level: beginner 2416d763cef2SBarry Smith 2417bdad233fSMatthew Knepley .keywords: TS, problem type 2418bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2419d763cef2SBarry Smith @*/ 24207087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2421a7cc72afSBarry Smith { 24229e2a6581SJed Brown PetscErrorCode ierr; 24239e2a6581SJed Brown 2424d763cef2SBarry Smith PetscFunctionBegin; 24250700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2426bdad233fSMatthew Knepley ts->problem_type = type; 24279e2a6581SJed Brown if (type == TS_LINEAR) { 24289e2a6581SJed Brown SNES snes; 24299e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 24309e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 24319e2a6581SJed Brown } 2432d763cef2SBarry Smith PetscFunctionReturn(0); 2433d763cef2SBarry Smith } 2434d763cef2SBarry Smith 2435bdad233fSMatthew Knepley /*@C 2436bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2437bdad233fSMatthew Knepley 2438bdad233fSMatthew Knepley Not collective 2439bdad233fSMatthew Knepley 2440bdad233fSMatthew Knepley Input Parameter: 2441bdad233fSMatthew Knepley . ts - The TS 2442bdad233fSMatthew Knepley 2443bdad233fSMatthew Knepley Output Parameter: 2444bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2445bdad233fSMatthew Knepley .vb 2446089b2837SJed Brown M U_t = A U 2447089b2837SJed Brown M(t) U_t = A(t) U 2448b5abc632SBarry Smith F(t,U,U_t) 2449bdad233fSMatthew Knepley .ve 2450bdad233fSMatthew Knepley 2451bdad233fSMatthew Knepley Level: beginner 2452bdad233fSMatthew Knepley 2453bdad233fSMatthew Knepley .keywords: TS, problem type 2454bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2455bdad233fSMatthew Knepley @*/ 24567087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2457a7cc72afSBarry Smith { 2458bdad233fSMatthew Knepley PetscFunctionBegin; 24590700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 24604482741eSBarry Smith PetscValidIntPointer(type,2); 2461bdad233fSMatthew Knepley *type = ts->problem_type; 2462bdad233fSMatthew Knepley PetscFunctionReturn(0); 2463bdad233fSMatthew Knepley } 2464d763cef2SBarry Smith 2465d763cef2SBarry Smith /*@ 2466d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2467d763cef2SBarry Smith of a timestepper. 2468d763cef2SBarry Smith 2469d763cef2SBarry Smith Collective on TS 2470d763cef2SBarry Smith 2471d763cef2SBarry Smith Input Parameter: 2472d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2473d763cef2SBarry Smith 2474d763cef2SBarry Smith Notes: 2475d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2476d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2477d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 2478d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2479d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 2480d763cef2SBarry Smith 2481d763cef2SBarry Smith Level: advanced 2482d763cef2SBarry Smith 2483d763cef2SBarry Smith .keywords: TS, timestep, setup 2484d763cef2SBarry Smith 2485d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 2486d763cef2SBarry Smith @*/ 24877087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2488d763cef2SBarry Smith { 2489dfbe8321SBarry Smith PetscErrorCode ierr; 24906c6b9e74SPeter Brune DM dm; 24916c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2492d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2493cd11d68dSLisandro Dalcin TSIFunction ifun; 24946c6b9e74SPeter Brune TSIJacobian ijac; 2495efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 24966c6b9e74SPeter Brune TSRHSJacobian rhsjac; 2497d763cef2SBarry Smith 2498d763cef2SBarry Smith PetscFunctionBegin; 24990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2500277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2501277b19d0SLisandro Dalcin 25027adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2503cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2504cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2505d763cef2SBarry Smith } 2506277b19d0SLisandro Dalcin 2507277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2508277b19d0SLisandro Dalcin 2509e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 2510e1244c69SJed Brown Mat Amat,Pmat; 2511e1244c69SJed Brown SNES snes; 2512e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2513e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2514e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2515e1244c69SJed Brown * have displaced the RHS matrix */ 2516e1244c69SJed Brown if (Amat == ts->Arhs) { 2517e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2518e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2519e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2520e1244c69SJed Brown } 2521e1244c69SJed Brown if (Pmat == ts->Brhs) { 2522e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2523e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2524e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2525e1244c69SJed Brown } 2526e1244c69SJed Brown } 2527277b19d0SLisandro Dalcin if (ts->ops->setup) { 2528000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2529277b19d0SLisandro Dalcin } 2530277b19d0SLisandro Dalcin 2531a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 25326c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 25336c6b9e74SPeter Brune */ 25346c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 25350298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 25366c6b9e74SPeter Brune if (!func) { 25376c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 25386c6b9e74SPeter Brune } 2539a6772fa2SLisandro 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. 25406c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 25416c6b9e74SPeter Brune */ 25420298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 25430298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2544efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 25450298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2546efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 25476c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 25486c6b9e74SPeter Brune } 2549c0517034SDebojyoti Ghosh 2550c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2551c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2552c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2553c0517034SDebojyoti Ghosh } 2554c0517034SDebojyoti Ghosh 2555277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2556277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2557277b19d0SLisandro Dalcin } 2558277b19d0SLisandro Dalcin 2559f6a906c0SBarry Smith /*@ 2560f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 2561f6a906c0SBarry Smith of an adjoint solver 2562f6a906c0SBarry Smith 2563f6a906c0SBarry Smith Collective on TS 2564f6a906c0SBarry Smith 2565f6a906c0SBarry Smith Input Parameter: 2566f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 2567f6a906c0SBarry Smith 2568f6a906c0SBarry Smith Level: advanced 2569f6a906c0SBarry Smith 2570f6a906c0SBarry Smith .keywords: TS, timestep, setup 2571f6a906c0SBarry Smith 2572947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2573f6a906c0SBarry Smith @*/ 2574f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 2575f6a906c0SBarry Smith { 2576f6a906c0SBarry Smith PetscErrorCode ierr; 2577f6a906c0SBarry Smith 2578f6a906c0SBarry Smith PetscFunctionBegin; 2579f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2580f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 2581dfb21088SHong Zhang if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2582d8151eeaSBarry Smith 2583947abb85SHong Zhang if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 2584d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2585d8151eeaSBarry Smith if (ts->vecs_sensip){ 2586d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2587d8151eeaSBarry Smith } 2588947abb85SHong Zhang } 2589d8151eeaSBarry Smith 259042f2b339SBarry Smith if (ts->ops->adjointsetup) { 259142f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2592f6a906c0SBarry Smith } 2593f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 2594f6a906c0SBarry Smith PetscFunctionReturn(0); 2595f6a906c0SBarry Smith } 2596f6a906c0SBarry Smith 2597277b19d0SLisandro Dalcin /*@ 2598277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2599277b19d0SLisandro Dalcin 2600277b19d0SLisandro Dalcin Collective on TS 2601277b19d0SLisandro Dalcin 2602277b19d0SLisandro Dalcin Input Parameter: 2603277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2604277b19d0SLisandro Dalcin 2605277b19d0SLisandro Dalcin Level: beginner 2606277b19d0SLisandro Dalcin 2607277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2608277b19d0SLisandro Dalcin 2609277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2610277b19d0SLisandro Dalcin @*/ 2611277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2612277b19d0SLisandro Dalcin { 2613277b19d0SLisandro Dalcin PetscErrorCode ierr; 2614277b19d0SLisandro Dalcin 2615277b19d0SLisandro Dalcin PetscFunctionBegin; 2616277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2617b18ea86cSHong Zhang 2618277b19d0SLisandro Dalcin if (ts->ops->reset) { 2619277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2620277b19d0SLisandro Dalcin } 2621277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2622e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2623bbd56ea5SKarl Rupp 26244e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 26254e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2626214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 26276bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2628efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2629e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2630e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 263138637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2632bbd56ea5SKarl Rupp 2633947abb85SHong Zhang if (ts->vec_costintegral) { 2634d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2635d8151eeaSBarry Smith if (ts->vecs_drdp){ 2636d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2637d8151eeaSBarry Smith } 2638947abb85SHong Zhang } 2639d8151eeaSBarry Smith ts->vecs_sensi = NULL; 2640d8151eeaSBarry Smith ts->vecs_sensip = NULL; 2641ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 26422c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 264336eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2644277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2645d763cef2SBarry Smith PetscFunctionReturn(0); 2646d763cef2SBarry Smith } 2647d763cef2SBarry Smith 2648d8e5e3e6SSatish Balay /*@ 2649d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2650d763cef2SBarry Smith with TSCreate(). 2651d763cef2SBarry Smith 2652d763cef2SBarry Smith Collective on TS 2653d763cef2SBarry Smith 2654d763cef2SBarry Smith Input Parameter: 2655d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2656d763cef2SBarry Smith 2657d763cef2SBarry Smith Level: beginner 2658d763cef2SBarry Smith 2659d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2660d763cef2SBarry Smith 2661d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2662d763cef2SBarry Smith @*/ 26636bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2664d763cef2SBarry Smith { 26656849ba73SBarry Smith PetscErrorCode ierr; 2666d763cef2SBarry Smith 2667d763cef2SBarry Smith PetscFunctionBegin; 26686bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 26696bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 26706bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2671d763cef2SBarry Smith 26726bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2673277b19d0SLisandro Dalcin 2674e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2675e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 26766bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 26776d4c513bSLisandro Dalcin 2678bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2679bc952696SBarry Smith 268084df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 26816427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 26826427ac75SLisandro Dalcin 26836bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 26846bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 26856bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 26860dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 26876d4c513bSLisandro Dalcin 2688a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2689d763cef2SBarry Smith PetscFunctionReturn(0); 2690d763cef2SBarry Smith } 2691d763cef2SBarry Smith 2692d8e5e3e6SSatish Balay /*@ 2693d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2694d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2695d763cef2SBarry Smith 2696d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2697d763cef2SBarry Smith 2698d763cef2SBarry Smith Input Parameter: 2699d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2700d763cef2SBarry Smith 2701d763cef2SBarry Smith Output Parameter: 2702d763cef2SBarry Smith . snes - the nonlinear solver context 2703d763cef2SBarry Smith 2704d763cef2SBarry Smith Notes: 2705d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2706d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 270794b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2708d763cef2SBarry Smith 2709d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 27100298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2711d763cef2SBarry Smith 2712d763cef2SBarry Smith Level: beginner 2713d763cef2SBarry Smith 2714d763cef2SBarry Smith .keywords: timestep, get, SNES 2715d763cef2SBarry Smith @*/ 27167087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2717d763cef2SBarry Smith { 2718d372ba47SLisandro Dalcin PetscErrorCode ierr; 2719d372ba47SLisandro Dalcin 2720d763cef2SBarry Smith PetscFunctionBegin; 27210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27224482741eSBarry Smith PetscValidPointer(snes,2); 2723d372ba47SLisandro Dalcin if (!ts->snes) { 2724ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 27250298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27263bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2727d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2728496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 27299e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 27309e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 27319e2a6581SJed Brown } 2732d372ba47SLisandro Dalcin } 2733d763cef2SBarry Smith *snes = ts->snes; 2734d763cef2SBarry Smith PetscFunctionReturn(0); 2735d763cef2SBarry Smith } 2736d763cef2SBarry Smith 2737deb2cd25SJed Brown /*@ 2738deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2739deb2cd25SJed Brown 2740deb2cd25SJed Brown Collective 2741deb2cd25SJed Brown 2742deb2cd25SJed Brown Input Parameter: 2743deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2744deb2cd25SJed Brown - snes - the nonlinear solver context 2745deb2cd25SJed Brown 2746deb2cd25SJed Brown Notes: 2747deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2748deb2cd25SJed Brown 2749deb2cd25SJed Brown Level: developer 2750deb2cd25SJed Brown 2751deb2cd25SJed Brown .keywords: timestep, set, SNES 2752deb2cd25SJed Brown @*/ 2753deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2754deb2cd25SJed Brown { 2755deb2cd25SJed Brown PetscErrorCode ierr; 2756d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2757deb2cd25SJed Brown 2758deb2cd25SJed Brown PetscFunctionBegin; 2759deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2760deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2761deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2762deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2763bbd56ea5SKarl Rupp 2764deb2cd25SJed Brown ts->snes = snes; 2765bbd56ea5SKarl Rupp 27660298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27670298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2768740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 27690298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2770740132f1SEmil Constantinescu } 2771deb2cd25SJed Brown PetscFunctionReturn(0); 2772deb2cd25SJed Brown } 2773deb2cd25SJed Brown 2774d8e5e3e6SSatish Balay /*@ 277594b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2776d763cef2SBarry Smith a TS (timestepper) context. 2777d763cef2SBarry Smith 277894b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2779d763cef2SBarry Smith 2780d763cef2SBarry Smith Input Parameter: 2781d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2782d763cef2SBarry Smith 2783d763cef2SBarry Smith Output Parameter: 278494b7f48cSBarry Smith . ksp - the nonlinear solver context 2785d763cef2SBarry Smith 2786d763cef2SBarry Smith Notes: 278794b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2788d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2789d763cef2SBarry Smith KSP and PC contexts as well. 2790d763cef2SBarry Smith 279194b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 27920298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2793d763cef2SBarry Smith 2794d763cef2SBarry Smith Level: beginner 2795d763cef2SBarry Smith 279694b7f48cSBarry Smith .keywords: timestep, get, KSP 2797d763cef2SBarry Smith @*/ 27987087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2799d763cef2SBarry Smith { 2800d372ba47SLisandro Dalcin PetscErrorCode ierr; 2801089b2837SJed Brown SNES snes; 2802d372ba47SLisandro Dalcin 2803d763cef2SBarry Smith PetscFunctionBegin; 28040700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28054482741eSBarry Smith PetscValidPointer(ksp,2); 280617186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2807e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2808089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2809089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2810d763cef2SBarry Smith PetscFunctionReturn(0); 2811d763cef2SBarry Smith } 2812d763cef2SBarry Smith 2813d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2814d763cef2SBarry Smith 2815adb62b0dSMatthew Knepley /*@ 2816adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2817adb62b0dSMatthew Knepley maximum time for iteration. 2818adb62b0dSMatthew Knepley 28193f9fe445SBarry Smith Not Collective 2820adb62b0dSMatthew Knepley 2821adb62b0dSMatthew Knepley Input Parameters: 2822adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 28230298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 28240298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2825adb62b0dSMatthew Knepley 2826adb62b0dSMatthew Knepley Level: intermediate 2827adb62b0dSMatthew Knepley 2828adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2829adb62b0dSMatthew Knepley @*/ 28307087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2831adb62b0dSMatthew Knepley { 2832adb62b0dSMatthew Knepley PetscFunctionBegin; 28330700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2834abc0a331SBarry Smith if (maxsteps) { 28354482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2836adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2837adb62b0dSMatthew Knepley } 2838abc0a331SBarry Smith if (maxtime) { 28394482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2840adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2841adb62b0dSMatthew Knepley } 2842adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2843adb62b0dSMatthew Knepley } 2844adb62b0dSMatthew Knepley 2845d763cef2SBarry Smith /*@ 2846d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2847d763cef2SBarry Smith maximum time for iteration. 2848d763cef2SBarry Smith 28493f9fe445SBarry Smith Logically Collective on TS 2850d763cef2SBarry Smith 2851d763cef2SBarry Smith Input Parameters: 2852d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2853d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2854d763cef2SBarry Smith - maxtime - final time to iterate to 2855d763cef2SBarry Smith 2856d763cef2SBarry Smith Options Database Keys: 2857d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 28583bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2859d763cef2SBarry Smith 2860d763cef2SBarry Smith Notes: 2861d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2862d763cef2SBarry Smith 2863d763cef2SBarry Smith Level: intermediate 2864d763cef2SBarry Smith 2865d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2866a43b19c4SJed Brown 2867a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2868d763cef2SBarry Smith @*/ 28697087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2870d763cef2SBarry Smith { 2871d763cef2SBarry Smith PetscFunctionBegin; 28720700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2873c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2874c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 287539b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 287639b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2877d763cef2SBarry Smith PetscFunctionReturn(0); 2878d763cef2SBarry Smith } 2879d763cef2SBarry Smith 2880d763cef2SBarry Smith /*@ 2881d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2882d763cef2SBarry Smith for use by the TS routines. 2883d763cef2SBarry Smith 28843f9fe445SBarry Smith Logically Collective on TS and Vec 2885d763cef2SBarry Smith 2886d763cef2SBarry Smith Input Parameters: 2887d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 28880910c330SBarry Smith - u - the solution vector 2889d763cef2SBarry Smith 2890d763cef2SBarry Smith Level: beginner 2891d763cef2SBarry Smith 2892d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2893d763cef2SBarry Smith @*/ 28940910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2895d763cef2SBarry Smith { 28968737fe31SLisandro Dalcin PetscErrorCode ierr; 2897496e6a7aSJed Brown DM dm; 28988737fe31SLisandro Dalcin 2899d763cef2SBarry Smith PetscFunctionBegin; 29000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 29010910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 29020910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 29036bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 29040910c330SBarry Smith ts->vec_sol = u; 2905bbd56ea5SKarl Rupp 2906496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 29070910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2908d763cef2SBarry Smith PetscFunctionReturn(0); 2909d763cef2SBarry Smith } 2910d763cef2SBarry Smith 291173b18844SBarry Smith /*@ 291273b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 291373b18844SBarry Smith 291473b18844SBarry Smith Logically Collective on TS 291573b18844SBarry Smith 291673b18844SBarry Smith Input Parameters: 291773b18844SBarry Smith + ts - the TS context obtained from TSCreate() 291873b18844SBarry Smith . steps - number of steps to use 291973b18844SBarry Smith 292073b18844SBarry Smith Level: intermediate 292173b18844SBarry Smith 292273b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 292373b18844SBarry Smith so as to integrate back to less than the original timestep 292473b18844SBarry Smith 292573b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 292673b18844SBarry Smith 292773b18844SBarry Smith .seealso: TSSetExactFinalTime() 292873b18844SBarry Smith @*/ 292973b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 293073b18844SBarry Smith { 293173b18844SBarry Smith PetscFunctionBegin; 293273b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 293373b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 293473b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 293573b18844SBarry 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"); 293673b18844SBarry Smith ts->adjoint_max_steps = steps; 293773b18844SBarry Smith PetscFunctionReturn(0); 293873b18844SBarry Smith } 293973b18844SBarry Smith 2940c235aa8dSHong Zhang /*@ 2941dfb21088SHong 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 29420cf82b59SBarry Smith for use by the TSAdjoint routines. 2943c235aa8dSHong Zhang 2944c235aa8dSHong Zhang Logically Collective on TS and Vec 2945c235aa8dSHong Zhang 2946c235aa8dSHong Zhang Input Parameters: 2947c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2948abc2977eSBarry 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 2949abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2950c235aa8dSHong Zhang 2951c235aa8dSHong Zhang Level: beginner 2952c235aa8dSHong Zhang 2953abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 29540cf82b59SBarry Smith 2955c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2956c235aa8dSHong Zhang @*/ 2957dfb21088SHong Zhang PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2958c235aa8dSHong Zhang { 2959c235aa8dSHong Zhang PetscFunctionBegin; 2960c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2961abc2977eSBarry Smith PetscValidPointer(lambda,2); 2962abc2977eSBarry Smith ts->vecs_sensi = lambda; 2963abc2977eSBarry Smith ts->vecs_sensip = mu; 2964dfb21088SHong 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"); 2965abc2977eSBarry Smith ts->numcost = numcost; 2966ad8e2604SHong Zhang PetscFunctionReturn(0); 2967ad8e2604SHong Zhang } 2968ad8e2604SHong Zhang 2969ad8e2604SHong Zhang /*@C 29700cf82b59SBarry 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. 2971ad8e2604SHong Zhang 2972ad8e2604SHong Zhang Logically Collective on TS 2973ad8e2604SHong Zhang 2974ad8e2604SHong Zhang Input Parameters: 2975ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2976ad8e2604SHong Zhang - func - The function 2977ad8e2604SHong Zhang 2978ad8e2604SHong Zhang Calling sequence of func: 29790cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 298005755b9cSHong Zhang + t - current timestep 29810cf82b59SBarry Smith . y - input vector (current ODE solution) 298205755b9cSHong Zhang . A - output matrix 298305755b9cSHong Zhang - ctx - [optional] user-defined function context 2984ad8e2604SHong Zhang 2985ad8e2604SHong Zhang Level: intermediate 2986ad8e2604SHong Zhang 29870cf82b59SBarry 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 29880cf82b59SBarry Smith 2989ad8e2604SHong Zhang .keywords: TS, sensitivity 2990ad8e2604SHong Zhang .seealso: 2991ad8e2604SHong Zhang @*/ 29925bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2993ad8e2604SHong Zhang { 2994ad8e2604SHong Zhang PetscErrorCode ierr; 2995ad8e2604SHong Zhang 2996ad8e2604SHong Zhang PetscFunctionBegin; 2997ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2998ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 2999ad8e2604SHong Zhang 3000ad8e2604SHong Zhang ts->rhsjacobianp = func; 3001ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 3002ad8e2604SHong Zhang if(Amat) { 3003ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 3004ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 3005ad8e2604SHong Zhang ts->Jacp = Amat; 3006ad8e2604SHong Zhang } 3007ad8e2604SHong Zhang PetscFunctionReturn(0); 3008ad8e2604SHong Zhang } 3009ad8e2604SHong Zhang 30100cf82b59SBarry Smith /*@C 30115bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 3012ad8e2604SHong Zhang 3013ad8e2604SHong Zhang Collective on TS 3014ad8e2604SHong Zhang 3015ad8e2604SHong Zhang Input Parameters: 3016ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 3017ad8e2604SHong Zhang 3018ad8e2604SHong Zhang Level: developer 3019ad8e2604SHong Zhang 3020ad8e2604SHong Zhang .keywords: TS, sensitivity 30215bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 3022ad8e2604SHong Zhang @*/ 30235bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 3024ad8e2604SHong Zhang { 3025ad8e2604SHong Zhang PetscErrorCode ierr; 3026ad8e2604SHong Zhang 3027ad8e2604SHong Zhang PetscFunctionBegin; 3028ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3029ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3030ad8e2604SHong Zhang PetscValidPointer(Amat,4); 3031ad8e2604SHong Zhang 3032ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 3033ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 3034ad8e2604SHong Zhang PetscStackPop; 3035c235aa8dSHong Zhang PetscFunctionReturn(0); 3036c235aa8dSHong Zhang } 3037c235aa8dSHong Zhang 30386fd0887fSHong Zhang /*@C 3039dfb21088SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 30406fd0887fSHong Zhang 30416fd0887fSHong Zhang Logically Collective on TS 30426fd0887fSHong Zhang 30436fd0887fSHong Zhang Input Parameters: 30446fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 3045abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 30460cf82b59SBarry Smith . rf - routine for evaluating the integrand function 3047b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 3048b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 3049feaa1ddbSSatish Balay . fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run 3050b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 30516fd0887fSHong Zhang 30520cf82b59SBarry Smith Calling sequence of rf: 30530cf82b59SBarry Smith $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 30546fd0887fSHong Zhang 30556fd0887fSHong Zhang + t - current timestep 30560cf82b59SBarry Smith . y - input vector 30570cf82b59SBarry Smith . f - function result; one vector entry for each cost function 30586fd0887fSHong Zhang - ctx - [optional] user-defined function context 30596fd0887fSHong Zhang 3060b612ec54SBarry Smith Calling sequence of drdyf: 30610cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 3062b612ec54SBarry Smith 3063b612ec54SBarry Smith Calling sequence of drdpf: 30640cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 3065b612ec54SBarry Smith 3066b612ec54SBarry Smith Level: intermediate 30676fd0887fSHong Zhang 3068abc2977eSBarry Smith Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 30690cf82b59SBarry Smith 30706fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 30716fd0887fSHong Zhang 3072dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 30736fd0887fSHong Zhang @*/ 3074dfb21088SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 3075d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 3076b1cb36f3SHong Zhang PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 3077b1cb36f3SHong Zhang PetscBool fwd,void *ctx) 30786fd0887fSHong Zhang { 30796fd0887fSHong Zhang PetscErrorCode ierr; 30806fd0887fSHong Zhang 30816fd0887fSHong Zhang PetscFunctionBegin; 30826fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3083dfb21088SHong 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()"); 3084c72ed514SHong Zhang if (!ts->numcost) ts->numcost=numcost; 30856fd0887fSHong Zhang 3086b1cb36f3SHong Zhang ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 3087abc2977eSBarry Smith ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 30882c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 30890cf82b59SBarry Smith ts->costintegrand = rf; 309005755b9cSHong Zhang ts->costintegrandctx = ctx; 3091b612ec54SBarry Smith ts->drdyfunction = drdyf; 3092b612ec54SBarry Smith ts->drdpfunction = drdpf; 30936fd0887fSHong Zhang PetscFunctionReturn(0); 30946fd0887fSHong Zhang } 30956fd0887fSHong Zhang 309636eaed60SHong Zhang /*@ 3097dfb21088SHong Zhang TSGetCostIntegral - Returns the values of the integral term in the cost functions. 309836eaed60SHong Zhang It is valid to call the routine after a backward run. 309936eaed60SHong Zhang 310036eaed60SHong Zhang Not Collective 310136eaed60SHong Zhang 310236eaed60SHong Zhang Input Parameter: 310336eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 310436eaed60SHong Zhang 310536eaed60SHong Zhang Output Parameter: 31062c39e106SBarry Smith . v - the vector containing the integrals for each cost function 310736eaed60SHong Zhang 310836eaed60SHong Zhang Level: intermediate 310936eaed60SHong Zhang 3110dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 311136eaed60SHong Zhang 311236eaed60SHong Zhang .keywords: TS, sensitivity analysis 311336eaed60SHong Zhang @*/ 3114dfb21088SHong Zhang PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 311536eaed60SHong Zhang { 311636eaed60SHong Zhang PetscFunctionBegin; 311736eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 311836eaed60SHong Zhang PetscValidPointer(v,2); 31192c39e106SBarry Smith *v = ts->vec_costintegral; 312036eaed60SHong Zhang PetscFunctionReturn(0); 312136eaed60SHong Zhang } 312236eaed60SHong Zhang 31236fd0887fSHong Zhang /*@ 31242c39e106SBarry Smith TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 31256fd0887fSHong Zhang 31266fd0887fSHong Zhang Input Parameters: 31276fd0887fSHong Zhang + ts - the TS context 31286fd0887fSHong Zhang . t - current time 31290cf82b59SBarry Smith - y - state vector, i.e. current solution 31306fd0887fSHong Zhang 31316fd0887fSHong Zhang Output Parameter: 3132abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 31336fd0887fSHong Zhang 31346fd0887fSHong Zhang Note: 31356fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 31366fd0887fSHong Zhang is used internally within the sensitivity analysis context. 31376fd0887fSHong Zhang 31386fd0887fSHong Zhang Level: developer 31396fd0887fSHong Zhang 31406fd0887fSHong Zhang .keywords: TS, compute 31416fd0887fSHong Zhang 3142dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 31436fd0887fSHong Zhang @*/ 31440cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 31456fd0887fSHong Zhang { 31466fd0887fSHong Zhang PetscErrorCode ierr; 31476fd0887fSHong Zhang 31486fd0887fSHong Zhang PetscFunctionBegin; 31496fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31500cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 31516fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 31526fd0887fSHong Zhang 31530cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3154e4680132SHong Zhang if (ts->costintegrand) { 3155e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 31560cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 31576fd0887fSHong Zhang PetscStackPop; 31586fd0887fSHong Zhang } else { 31596fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 31606fd0887fSHong Zhang } 31616fd0887fSHong Zhang 31620cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 31636fd0887fSHong Zhang PetscFunctionReturn(0); 31646fd0887fSHong Zhang } 31656fd0887fSHong Zhang 316605755b9cSHong Zhang /*@ 3167d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 316805755b9cSHong Zhang 316905755b9cSHong Zhang Collective on TS 317005755b9cSHong Zhang 317105755b9cSHong Zhang Input Parameters: 317205755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 317305755b9cSHong Zhang 317405755b9cSHong Zhang Notes: 3175d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 317605755b9cSHong Zhang so most users would not generally call this routine themselves. 317705755b9cSHong Zhang 317805755b9cSHong Zhang Level: developer 317905755b9cSHong Zhang 318005755b9cSHong Zhang .keywords: TS, sensitivity 3181d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 318205755b9cSHong Zhang @*/ 31830cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 318405755b9cSHong Zhang { 318505755b9cSHong Zhang PetscErrorCode ierr; 318605755b9cSHong Zhang 318705755b9cSHong Zhang PetscFunctionBegin; 318805755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31890cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 319005755b9cSHong Zhang 319105755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 31920cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 319305755b9cSHong Zhang PetscStackPop; 319405755b9cSHong Zhang PetscFunctionReturn(0); 319505755b9cSHong Zhang } 319605755b9cSHong Zhang 319705755b9cSHong Zhang /*@ 3198d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 319905755b9cSHong Zhang 320005755b9cSHong Zhang Collective on TS 320105755b9cSHong Zhang 320205755b9cSHong Zhang Input Parameters: 320305755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 320405755b9cSHong Zhang 320505755b9cSHong Zhang Notes: 320605755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 320705755b9cSHong Zhang so most users would not generally call this routine themselves. 320805755b9cSHong Zhang 320905755b9cSHong Zhang Level: developer 321005755b9cSHong Zhang 321105755b9cSHong Zhang .keywords: TS, sensitivity 3212d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 321305755b9cSHong Zhang @*/ 32140cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 321505755b9cSHong Zhang { 321605755b9cSHong Zhang PetscErrorCode ierr; 321705755b9cSHong Zhang 321805755b9cSHong Zhang PetscFunctionBegin; 321905755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 32200cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 322105755b9cSHong Zhang 322205755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 32230cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 322405755b9cSHong Zhang PetscStackPop; 322505755b9cSHong Zhang PetscFunctionReturn(0); 322605755b9cSHong Zhang } 322705755b9cSHong Zhang 3228ac226902SBarry Smith /*@C 3229000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 32303f2090d5SJed Brown called once at the beginning of each time step. 3231000e7ae3SMatthew Knepley 32323f9fe445SBarry Smith Logically Collective on TS 3233000e7ae3SMatthew Knepley 3234000e7ae3SMatthew Knepley Input Parameters: 3235000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3236000e7ae3SMatthew Knepley - func - The function 3237000e7ae3SMatthew Knepley 3238000e7ae3SMatthew Knepley Calling sequence of func: 3239000e7ae3SMatthew Knepley . func (TS ts); 3240000e7ae3SMatthew Knepley 3241000e7ae3SMatthew Knepley Level: intermediate 3242000e7ae3SMatthew Knepley 3243000e7ae3SMatthew Knepley .keywords: TS, timestep 32449be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3245000e7ae3SMatthew Knepley @*/ 32467087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3247000e7ae3SMatthew Knepley { 3248000e7ae3SMatthew Knepley PetscFunctionBegin; 32490700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3250ae60f76fSBarry Smith ts->prestep = func; 3251000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3252000e7ae3SMatthew Knepley } 3253000e7ae3SMatthew Knepley 325409ee8438SJed Brown /*@ 32553f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 32563f2090d5SJed Brown 32573f2090d5SJed Brown Collective on TS 32583f2090d5SJed Brown 32593f2090d5SJed Brown Input Parameters: 32603f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 32613f2090d5SJed Brown 32623f2090d5SJed Brown Notes: 32633f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 32643f2090d5SJed Brown so most users would not generally call this routine themselves. 32653f2090d5SJed Brown 32663f2090d5SJed Brown Level: developer 32673f2090d5SJed Brown 32683f2090d5SJed Brown .keywords: TS, timestep 32699be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 32703f2090d5SJed Brown @*/ 32717087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 32723f2090d5SJed Brown { 32733f2090d5SJed Brown PetscErrorCode ierr; 32743f2090d5SJed Brown 32753f2090d5SJed Brown PetscFunctionBegin; 32760700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3277ae60f76fSBarry Smith if (ts->prestep) { 3278ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 3279312ce896SJed Brown } 32803f2090d5SJed Brown PetscFunctionReturn(0); 32813f2090d5SJed Brown } 32823f2090d5SJed Brown 3283b8123daeSJed Brown /*@C 3284b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3285b8123daeSJed Brown called once at the beginning of each stage. 3286b8123daeSJed Brown 3287b8123daeSJed Brown Logically Collective on TS 3288b8123daeSJed Brown 3289b8123daeSJed Brown Input Parameters: 3290b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3291b8123daeSJed Brown - func - The function 3292b8123daeSJed Brown 3293b8123daeSJed Brown Calling sequence of func: 3294b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3295b8123daeSJed Brown 3296b8123daeSJed Brown Level: intermediate 3297b8123daeSJed Brown 3298b8123daeSJed Brown Note: 3299b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3300b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3301b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3302b8123daeSJed Brown 3303b8123daeSJed Brown .keywords: TS, timestep 33049be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3305b8123daeSJed Brown @*/ 3306b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3307b8123daeSJed Brown { 3308b8123daeSJed Brown PetscFunctionBegin; 3309b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3310ae60f76fSBarry Smith ts->prestage = func; 3311b8123daeSJed Brown PetscFunctionReturn(0); 3312b8123daeSJed Brown } 3313b8123daeSJed Brown 33149be3e283SDebojyoti Ghosh /*@C 33159be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 33169be3e283SDebojyoti Ghosh called once at the end of each stage. 33179be3e283SDebojyoti Ghosh 33189be3e283SDebojyoti Ghosh Logically Collective on TS 33199be3e283SDebojyoti Ghosh 33209be3e283SDebojyoti Ghosh Input Parameters: 33219be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 33229be3e283SDebojyoti Ghosh - func - The function 33239be3e283SDebojyoti Ghosh 33249be3e283SDebojyoti Ghosh Calling sequence of func: 33259be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 33269be3e283SDebojyoti Ghosh 33279be3e283SDebojyoti Ghosh Level: intermediate 33289be3e283SDebojyoti Ghosh 33299be3e283SDebojyoti Ghosh Note: 33309be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 33319be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 33329be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 33339be3e283SDebojyoti Ghosh 33349be3e283SDebojyoti Ghosh .keywords: TS, timestep 33359be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 33369be3e283SDebojyoti Ghosh @*/ 33379be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 33389be3e283SDebojyoti Ghosh { 33399be3e283SDebojyoti Ghosh PetscFunctionBegin; 33409be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 33419be3e283SDebojyoti Ghosh ts->poststage = func; 33429be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33439be3e283SDebojyoti Ghosh } 33449be3e283SDebojyoti Ghosh 3345c688d042SShri Abhyankar /*@C 3346c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3347c688d042SShri Abhyankar called once at the end of each step evaluation. 3348c688d042SShri Abhyankar 3349c688d042SShri Abhyankar Logically Collective on TS 3350c688d042SShri Abhyankar 3351c688d042SShri Abhyankar Input Parameters: 3352c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3353c688d042SShri Abhyankar - func - The function 3354c688d042SShri Abhyankar 3355c688d042SShri Abhyankar Calling sequence of func: 3356c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3357c688d042SShri Abhyankar 3358c688d042SShri Abhyankar Level: intermediate 3359c688d042SShri Abhyankar 3360c688d042SShri Abhyankar Note: 33611785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 33621785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3363e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3364e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3365e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3366c688d042SShri Abhyankar 3367c688d042SShri Abhyankar .keywords: TS, timestep 3368c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3369c688d042SShri Abhyankar @*/ 3370c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3371c688d042SShri Abhyankar { 3372c688d042SShri Abhyankar PetscFunctionBegin; 3373c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3374c688d042SShri Abhyankar ts->postevaluate = func; 3375c688d042SShri Abhyankar PetscFunctionReturn(0); 3376c688d042SShri Abhyankar } 3377c688d042SShri Abhyankar 3378b8123daeSJed Brown /*@ 3379b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3380b8123daeSJed Brown 3381b8123daeSJed Brown Collective on TS 3382b8123daeSJed Brown 3383b8123daeSJed Brown Input Parameters: 3384b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 33859be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3386b8123daeSJed Brown 3387b8123daeSJed Brown Notes: 3388b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3389b8123daeSJed Brown most users would not generally call this routine themselves. 3390b8123daeSJed Brown 3391b8123daeSJed Brown Level: developer 3392b8123daeSJed Brown 3393b8123daeSJed Brown .keywords: TS, timestep 33949be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3395b8123daeSJed Brown @*/ 3396b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3397b8123daeSJed Brown { 3398b8123daeSJed Brown PetscErrorCode ierr; 3399b8123daeSJed Brown 3400b8123daeSJed Brown PetscFunctionBegin; 3401b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3402ae60f76fSBarry Smith if (ts->prestage) { 3403ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3404b8123daeSJed Brown } 3405b8123daeSJed Brown PetscFunctionReturn(0); 3406b8123daeSJed Brown } 3407b8123daeSJed Brown 34089be3e283SDebojyoti Ghosh /*@ 34099be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 34109be3e283SDebojyoti Ghosh 34119be3e283SDebojyoti Ghosh Collective on TS 34129be3e283SDebojyoti Ghosh 34139be3e283SDebojyoti Ghosh Input Parameters: 34149be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 34159be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 34169be3e283SDebojyoti Ghosh stageindex - Stage number 34179be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 34189be3e283SDebojyoti Ghosh of stages) with the stage solutions 34199be3e283SDebojyoti Ghosh 34209be3e283SDebojyoti Ghosh Notes: 34219be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 34229be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 34239be3e283SDebojyoti Ghosh 34249be3e283SDebojyoti Ghosh Level: developer 34259be3e283SDebojyoti Ghosh 34269be3e283SDebojyoti Ghosh .keywords: TS, timestep 34279be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 34289be3e283SDebojyoti Ghosh @*/ 34299be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 34309be3e283SDebojyoti Ghosh { 34319be3e283SDebojyoti Ghosh PetscErrorCode ierr; 34329be3e283SDebojyoti Ghosh 34339be3e283SDebojyoti Ghosh PetscFunctionBegin; 34349be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34354beae5d8SLisandro Dalcin if (ts->poststage) { 34369be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 34379be3e283SDebojyoti Ghosh } 34389be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 34399be3e283SDebojyoti Ghosh } 34409be3e283SDebojyoti Ghosh 3441c688d042SShri Abhyankar /*@ 3442c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3443c688d042SShri Abhyankar 3444c688d042SShri Abhyankar Collective on TS 3445c688d042SShri Abhyankar 3446c688d042SShri Abhyankar Input Parameters: 3447c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3448c688d042SShri Abhyankar 3449c688d042SShri Abhyankar Notes: 3450c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3451c688d042SShri Abhyankar most users would not generally call this routine themselves. 3452c688d042SShri Abhyankar 3453c688d042SShri Abhyankar Level: developer 3454c688d042SShri Abhyankar 3455c688d042SShri Abhyankar .keywords: TS, timestep 3456c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3457c688d042SShri Abhyankar @*/ 3458c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3459c688d042SShri Abhyankar { 3460c688d042SShri Abhyankar PetscErrorCode ierr; 3461c688d042SShri Abhyankar 3462c688d042SShri Abhyankar PetscFunctionBegin; 3463c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3464c688d042SShri Abhyankar if (ts->postevaluate) { 3465c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3466c688d042SShri Abhyankar } 3467c688d042SShri Abhyankar PetscFunctionReturn(0); 3468c688d042SShri Abhyankar } 3469c688d042SShri Abhyankar 3470ac226902SBarry Smith /*@C 3471000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 34723f2090d5SJed Brown called once at the end of each time step. 3473000e7ae3SMatthew Knepley 34743f9fe445SBarry Smith Logically Collective on TS 3475000e7ae3SMatthew Knepley 3476000e7ae3SMatthew Knepley Input Parameters: 3477000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3478000e7ae3SMatthew Knepley - func - The function 3479000e7ae3SMatthew Knepley 3480000e7ae3SMatthew Knepley Calling sequence of func: 3481b8123daeSJed Brown $ func (TS ts); 3482000e7ae3SMatthew Knepley 34831785ff2aSShri Abhyankar Notes: 34841785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 34851785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 34861785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 34871785ff2aSShri Abhyankar 3488000e7ae3SMatthew Knepley Level: intermediate 3489000e7ae3SMatthew Knepley 3490000e7ae3SMatthew Knepley .keywords: TS, timestep 34911785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 3492000e7ae3SMatthew Knepley @*/ 34937087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3494000e7ae3SMatthew Knepley { 3495000e7ae3SMatthew Knepley PetscFunctionBegin; 34960700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3497ae60f76fSBarry Smith ts->poststep = func; 3498000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3499000e7ae3SMatthew Knepley } 3500000e7ae3SMatthew Knepley 350109ee8438SJed Brown /*@ 35023f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 35033f2090d5SJed Brown 35043f2090d5SJed Brown Collective on TS 35053f2090d5SJed Brown 35063f2090d5SJed Brown Input Parameters: 35073f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 35083f2090d5SJed Brown 35093f2090d5SJed Brown Notes: 35103f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 35113f2090d5SJed Brown so most users would not generally call this routine themselves. 35123f2090d5SJed Brown 35133f2090d5SJed Brown Level: developer 35143f2090d5SJed Brown 35153f2090d5SJed Brown .keywords: TS, timestep 35163f2090d5SJed Brown @*/ 35177087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 35183f2090d5SJed Brown { 35193f2090d5SJed Brown PetscErrorCode ierr; 35203f2090d5SJed Brown 35213f2090d5SJed Brown PetscFunctionBegin; 35220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3523ae60f76fSBarry Smith if (ts->poststep) { 3524ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 352572ac3e02SJed Brown } 35263f2090d5SJed Brown PetscFunctionReturn(0); 35273f2090d5SJed Brown } 35283f2090d5SJed Brown 3529d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3530d763cef2SBarry Smith 3531d763cef2SBarry Smith /*@C 3532a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3533d763cef2SBarry Smith timestep to display the iteration's progress. 3534d763cef2SBarry Smith 35353f9fe445SBarry Smith Logically Collective on TS 3536d763cef2SBarry Smith 3537d763cef2SBarry Smith Input Parameters: 3538d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3539e213d8f1SJed Brown . monitor - monitoring routine 3540329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 35410298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3542b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 35430298fd71SBarry Smith (may be NULL) 3544d763cef2SBarry Smith 3545e213d8f1SJed Brown Calling sequence of monitor: 35460910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3547d763cef2SBarry Smith 3548d763cef2SBarry Smith + ts - the TS context 354963e21af5SBarry 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) 35501f06c33eSBarry Smith . time - current time 35510910c330SBarry Smith . u - current iterate 3552d763cef2SBarry Smith - mctx - [optional] monitoring context 3553d763cef2SBarry Smith 3554d763cef2SBarry Smith Notes: 3555d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3556d763cef2SBarry Smith already has been loaded. 3557d763cef2SBarry Smith 3558025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 3559025f1a04SBarry Smith 3560d763cef2SBarry Smith Level: intermediate 3561d763cef2SBarry Smith 3562d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3563d763cef2SBarry Smith 3564a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3565d763cef2SBarry Smith @*/ 3566c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3567d763cef2SBarry Smith { 356878064530SBarry Smith PetscErrorCode ierr; 356978064530SBarry Smith PetscInt i; 357078064530SBarry Smith PetscBool identical; 357178064530SBarry Smith 3572d763cef2SBarry Smith PetscFunctionBegin; 35730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 357478064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 357578064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 357678064530SBarry Smith if (identical) PetscFunctionReturn(0); 357778064530SBarry Smith } 357817186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3579d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 35808704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3581d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3582d763cef2SBarry Smith PetscFunctionReturn(0); 3583d763cef2SBarry Smith } 3584d763cef2SBarry Smith 3585d763cef2SBarry Smith /*@C 3586a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3587d763cef2SBarry Smith 35883f9fe445SBarry Smith Logically Collective on TS 3589d763cef2SBarry Smith 3590d763cef2SBarry Smith Input Parameters: 3591d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3592d763cef2SBarry Smith 3593d763cef2SBarry Smith Notes: 3594d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3595d763cef2SBarry Smith 3596d763cef2SBarry Smith Level: intermediate 3597d763cef2SBarry Smith 3598d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3599d763cef2SBarry Smith 3600a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3601d763cef2SBarry Smith @*/ 36027087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3603d763cef2SBarry Smith { 3604d952e501SBarry Smith PetscErrorCode ierr; 3605d952e501SBarry Smith PetscInt i; 3606d952e501SBarry Smith 3607d763cef2SBarry Smith PetscFunctionBegin; 36080700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3609d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 36108704b422SBarry Smith if (ts->monitordestroy[i]) { 36118704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3612d952e501SBarry Smith } 3613d952e501SBarry Smith } 3614d763cef2SBarry Smith ts->numbermonitors = 0; 3615d763cef2SBarry Smith PetscFunctionReturn(0); 3616d763cef2SBarry Smith } 3617d763cef2SBarry Smith 3618721cd6eeSBarry Smith /*@C 3619721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 36205516499fSSatish Balay 36215516499fSSatish Balay Level: intermediate 362241251cbbSSatish Balay 36235516499fSSatish Balay .keywords: TS, set, monitor 36245516499fSSatish Balay 362563e21af5SBarry Smith .seealso: TSMonitorSet() 362641251cbbSSatish Balay @*/ 3627721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3628d763cef2SBarry Smith { 3629dfbe8321SBarry Smith PetscErrorCode ierr; 3630721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 363141aca3d6SBarry Smith PetscBool iascii,ibinary; 3632d132466eSBarry Smith 3633d763cef2SBarry Smith PetscFunctionBegin; 36344d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 363541aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 363641aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3637721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 363841aca3d6SBarry Smith if (iascii) { 3639649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 364063e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 364163e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 364263e21af5SBarry Smith } else { 36438392e04aSShri 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); 364463e21af5SBarry Smith } 3645649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 364641aca3d6SBarry Smith } else if (ibinary) { 364741aca3d6SBarry Smith PetscMPIInt rank; 364841aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 364941aca3d6SBarry Smith if (!rank) { 3650450a797fSBarry Smith PetscBool skipHeader; 3651450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3652450a797fSBarry Smith 3653450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3654450a797fSBarry Smith if (!skipHeader) { 3655450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3656450a797fSBarry Smith } 365741aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 365841aca3d6SBarry Smith } else { 365941aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 366041aca3d6SBarry Smith } 366141aca3d6SBarry Smith } 3662721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3663d763cef2SBarry Smith PetscFunctionReturn(0); 3664d763cef2SBarry Smith } 3665d763cef2SBarry Smith 36669110b2e7SHong Zhang /*@C 36679110b2e7SHong Zhang TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 36689110b2e7SHong Zhang timestep to display the iteration's progress. 36699110b2e7SHong Zhang 36709110b2e7SHong Zhang Logically Collective on TS 36719110b2e7SHong Zhang 36729110b2e7SHong Zhang Input Parameters: 36739110b2e7SHong Zhang + ts - the TS context obtained from TSCreate() 36749110b2e7SHong Zhang . adjointmonitor - monitoring routine 36759110b2e7SHong Zhang . adjointmctx - [optional] user-defined context for private data for the 36769110b2e7SHong Zhang monitor routine (use NULL if no context is desired) 36779110b2e7SHong Zhang - adjointmonitordestroy - [optional] routine that frees monitor context 36789110b2e7SHong Zhang (may be NULL) 36799110b2e7SHong Zhang 36809110b2e7SHong Zhang Calling sequence of monitor: 36819110b2e7SHong Zhang $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 36829110b2e7SHong Zhang 36839110b2e7SHong Zhang + ts - the TS context 36849110b2e7SHong 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 36859110b2e7SHong Zhang been interpolated to) 36869110b2e7SHong Zhang . time - current time 36879110b2e7SHong Zhang . u - current iterate 36889110b2e7SHong Zhang . numcost - number of cost functionos 36899110b2e7SHong Zhang . lambda - sensitivities to initial conditions 36909110b2e7SHong Zhang . mu - sensitivities to parameters 36919110b2e7SHong Zhang - adjointmctx - [optional] adjoint monitoring context 36929110b2e7SHong Zhang 36939110b2e7SHong Zhang Notes: 36949110b2e7SHong Zhang This routine adds an additional monitor to the list of monitors that 36959110b2e7SHong Zhang already has been loaded. 36969110b2e7SHong Zhang 36979110b2e7SHong Zhang Fortran notes: Only a single monitor function can be set for each TS object 36989110b2e7SHong Zhang 36999110b2e7SHong Zhang Level: intermediate 37009110b2e7SHong Zhang 37019110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 37029110b2e7SHong Zhang 37039110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel() 37049110b2e7SHong Zhang @*/ 37059110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 37069110b2e7SHong Zhang { 370778064530SBarry Smith PetscErrorCode ierr; 370878064530SBarry Smith PetscInt i; 370978064530SBarry Smith PetscBool identical; 371078064530SBarry Smith 37119110b2e7SHong Zhang PetscFunctionBegin; 37129110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 371378064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 371478064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 371578064530SBarry Smith if (identical) PetscFunctionReturn(0); 371678064530SBarry Smith } 37179110b2e7SHong Zhang if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 37189110b2e7SHong Zhang ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 37199110b2e7SHong Zhang ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 37209110b2e7SHong Zhang ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 37219110b2e7SHong Zhang PetscFunctionReturn(0); 37229110b2e7SHong Zhang } 37239110b2e7SHong Zhang 37249110b2e7SHong Zhang /*@C 37259110b2e7SHong Zhang TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 37269110b2e7SHong Zhang 37279110b2e7SHong Zhang Logically Collective on TS 37289110b2e7SHong Zhang 37299110b2e7SHong Zhang Input Parameters: 37309110b2e7SHong Zhang . ts - the TS context obtained from TSCreate() 37319110b2e7SHong Zhang 37329110b2e7SHong Zhang Notes: 37339110b2e7SHong Zhang There is no way to remove a single, specific monitor. 37349110b2e7SHong Zhang 37359110b2e7SHong Zhang Level: intermediate 37369110b2e7SHong Zhang 37379110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 37389110b2e7SHong Zhang 37399110b2e7SHong Zhang .seealso: TSAdjointMonitorSet() 37409110b2e7SHong Zhang @*/ 37419110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorCancel(TS ts) 37429110b2e7SHong Zhang { 37439110b2e7SHong Zhang PetscErrorCode ierr; 37449110b2e7SHong Zhang PetscInt i; 37459110b2e7SHong Zhang 37469110b2e7SHong Zhang PetscFunctionBegin; 37479110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37489110b2e7SHong Zhang for (i=0; i<ts->numberadjointmonitors; i++) { 37499110b2e7SHong Zhang if (ts->adjointmonitordestroy[i]) { 37509110b2e7SHong Zhang ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 37519110b2e7SHong Zhang } 37529110b2e7SHong Zhang } 37539110b2e7SHong Zhang ts->numberadjointmonitors = 0; 37549110b2e7SHong Zhang PetscFunctionReturn(0); 37559110b2e7SHong Zhang } 37569110b2e7SHong Zhang 3757721cd6eeSBarry Smith /*@C 3758721cd6eeSBarry Smith TSAdjointMonitorDefault - the default monitor of adjoint computations 3759110eb670SHong Zhang 3760110eb670SHong Zhang Level: intermediate 3761110eb670SHong Zhang 3762110eb670SHong Zhang .keywords: TS, set, monitor 3763110eb670SHong Zhang 3764110eb670SHong Zhang .seealso: TSAdjointMonitorSet() 3765110eb670SHong Zhang @*/ 3766721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3767110eb670SHong Zhang { 3768110eb670SHong Zhang PetscErrorCode ierr; 3769721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 3770110eb670SHong Zhang 3771110eb670SHong Zhang PetscFunctionBegin; 3772110eb670SHong Zhang PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3773721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3774110eb670SHong Zhang ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3775110eb670SHong 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); 3776110eb670SHong Zhang ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3777721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3778110eb670SHong Zhang PetscFunctionReturn(0); 3779110eb670SHong Zhang } 3780110eb670SHong Zhang 3781cd652676SJed Brown /*@ 3782cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3783cd652676SJed Brown 3784cd652676SJed Brown Collective on TS 3785cd652676SJed Brown 3786cd652676SJed Brown Input Argument: 3787cd652676SJed Brown + ts - time stepping context 3788cd652676SJed Brown - t - time to interpolate to 3789cd652676SJed Brown 3790cd652676SJed Brown Output Argument: 37910910c330SBarry Smith . U - state at given time 3792cd652676SJed Brown 3793cd652676SJed Brown Level: intermediate 3794cd652676SJed Brown 3795cd652676SJed Brown Developer Notes: 3796cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3797cd652676SJed Brown 3798cd652676SJed Brown .keywords: TS, set 3799cd652676SJed Brown 3800874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3801cd652676SJed Brown @*/ 38020910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3803cd652676SJed Brown { 3804cd652676SJed Brown PetscErrorCode ierr; 3805cd652676SJed Brown 3806cd652676SJed Brown PetscFunctionBegin; 3807cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3808b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3809be5899b3SLisandro 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); 3810ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 38110910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3812cd652676SJed Brown PetscFunctionReturn(0); 3813cd652676SJed Brown } 3814cd652676SJed Brown 3815d763cef2SBarry Smith /*@ 38166d9e5789SSean Farley TSStep - Steps one time step 3817d763cef2SBarry Smith 3818d763cef2SBarry Smith Collective on TS 3819d763cef2SBarry Smith 3820d763cef2SBarry Smith Input Parameter: 3821d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3822d763cef2SBarry Smith 382327829d71SBarry Smith Level: developer 3824d763cef2SBarry Smith 3825b8123daeSJed Brown Notes: 382627829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 382727829d71SBarry Smith 3828b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3829b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3830b8123daeSJed Brown 383125cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 383225cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 383325cb2221SBarry Smith 3834d763cef2SBarry Smith .keywords: TS, timestep, solve 3835d763cef2SBarry Smith 38369be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3837d763cef2SBarry Smith @*/ 3838193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3839d763cef2SBarry Smith { 3840dfbe8321SBarry Smith PetscErrorCode ierr; 3841fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3842be5899b3SLisandro Dalcin PetscReal ptime; 3843d763cef2SBarry Smith 3844d763cef2SBarry Smith PetscFunctionBegin; 38450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3846fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3847fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3848fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3849fffbeea8SBarry Smith " type = {Preprint},\n" 3850fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3851fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3852302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3853fffbeea8SBarry Smith 3854d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 385568bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3856d405a339SMatthew Knepley 3857a6772fa2SLisandro 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()"); 3858be5899b3SLisandro 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"); 3859a6772fa2SLisandro Dalcin 3860be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3861362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3862be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 3863e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3864d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3865193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3866d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3867be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 3868be5899b3SLisandro Dalcin ts->steps++; ts->total_steps++; 3869be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 387028d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3871362cd11cSLisandro Dalcin 3872362cd11cSLisandro Dalcin if (ts->reason < 0) { 3873cef5090cSJed Brown if (ts->errorifstepfailed) { 387408c7845fSBarry 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]); 387508c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3876d2daff3dSHong Zhang } 387708c7845fSBarry Smith } else if (!ts->reason) { 387808c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 387908c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 388008c7845fSBarry Smith } 388108c7845fSBarry Smith PetscFunctionReturn(0); 388208c7845fSBarry Smith } 388308c7845fSBarry Smith 388408c7845fSBarry Smith /*@ 3885b957a604SHong Zhang TSAdjointStep - Steps one time step backward in the adjoint run 388608c7845fSBarry Smith 388708c7845fSBarry Smith Collective on TS 388808c7845fSBarry Smith 388908c7845fSBarry Smith Input Parameter: 389008c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 389108c7845fSBarry Smith 38926a4d4014SLisandro Dalcin Level: intermediate 38936a4d4014SLisandro Dalcin 3894b957a604SHong Zhang .keywords: TS, adjoint, step 38956a4d4014SLisandro Dalcin 3896b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve() 38976a4d4014SLisandro Dalcin @*/ 389808c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 38996a4d4014SLisandro Dalcin { 390008c7845fSBarry Smith DM dm; 39016a4d4014SLisandro Dalcin PetscErrorCode ierr; 39026a4d4014SLisandro Dalcin 39036a4d4014SLisandro Dalcin PetscFunctionBegin; 39044a2ae208SSatish Balay PetscValidHeaderSpecific(ts,TS_CLASSID,1); 390508c7845fSBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 390608c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3907d763cef2SBarry Smith 3908685405a1SBarry Smith ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 3909d763cef2SBarry Smith 3910be5899b3SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3911be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime; 391242f2b339SBarry 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); 3913be5899b3SLisandro Dalcin ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 391442f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 39158d0ad7a8SHong Zhang ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3916be5899b3SLisandro Dalcin ts->steps++; ts->total_steps--; 3917362cd11cSLisandro Dalcin 3918362cd11cSLisandro Dalcin if (ts->reason < 0) { 3919cef5090cSJed Brown if (ts->errorifstepfailed) { 39206c4ed002SBarry 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]); 39216c4ed002SBarry 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]); 39226c4ed002SBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3923cef5090cSJed Brown } 3924362cd11cSLisandro Dalcin } else if (!ts->reason) { 392573b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3926362cd11cSLisandro Dalcin } 3927d763cef2SBarry Smith PetscFunctionReturn(0); 3928d763cef2SBarry Smith } 3929d763cef2SBarry Smith 39307cbde773SLisandro Dalcin /*@ 39317cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 39327cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 39337cbde773SLisandro Dalcin 39347cbde773SLisandro Dalcin Collective on TS 39357cbde773SLisandro Dalcin 39367cbde773SLisandro Dalcin Input Arguments: 39377cbde773SLisandro Dalcin + ts - time stepping context 39387cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 39397cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 39407cbde773SLisandro Dalcin 39417cbde773SLisandro Dalcin Output Arguments: 39427cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 39437cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 39447cbde773SLisandro Dalcin 39457cbde773SLisandro Dalcin Level: advanced 39467cbde773SLisandro Dalcin 39477cbde773SLisandro Dalcin Notes: 39487cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 39497cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 39507cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 39517cbde773SLisandro Dalcin 39527cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 39537cbde773SLisandro Dalcin @*/ 39547cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 39557cbde773SLisandro Dalcin { 39567cbde773SLisandro Dalcin PetscErrorCode ierr; 39577cbde773SLisandro Dalcin 39587cbde773SLisandro Dalcin PetscFunctionBegin; 39597cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 39607cbde773SLisandro Dalcin PetscValidType(ts,1); 39617cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 39627cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 39637cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 39647cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 39657cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 39667cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 39677cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 39687cbde773SLisandro Dalcin PetscFunctionReturn(0); 39697cbde773SLisandro Dalcin } 39707cbde773SLisandro Dalcin 397105175c85SJed Brown /*@ 397205175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 397305175c85SJed Brown 39741c3436cfSJed Brown Collective on TS 397505175c85SJed Brown 397605175c85SJed Brown Input Arguments: 39771c3436cfSJed Brown + ts - time stepping context 39781c3436cfSJed Brown . order - desired order of accuracy 39790298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 398005175c85SJed Brown 398105175c85SJed Brown Output Arguments: 39820910c330SBarry Smith . U - state at the end of the current step 398305175c85SJed Brown 398405175c85SJed Brown Level: advanced 398505175c85SJed Brown 3986108c343cSJed Brown Notes: 3987108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3988108c343cSJed 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. 3989108c343cSJed Brown 39901c3436cfSJed Brown .seealso: TSStep(), TSAdapt 399105175c85SJed Brown @*/ 39920910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 399305175c85SJed Brown { 399405175c85SJed Brown PetscErrorCode ierr; 399505175c85SJed Brown 399605175c85SJed Brown PetscFunctionBegin; 399705175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 399805175c85SJed Brown PetscValidType(ts,1); 39990910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4000ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 40010910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 400205175c85SJed Brown PetscFunctionReturn(0); 400305175c85SJed Brown } 400405175c85SJed Brown 4005b1cb36f3SHong Zhang /*@ 4006b1cb36f3SHong Zhang TSForwardCostIntegral - Evaluate the cost integral in the forward run. 4007b1cb36f3SHong Zhang 4008b1cb36f3SHong Zhang Collective on TS 4009b1cb36f3SHong Zhang 4010b1cb36f3SHong Zhang Input Arguments: 4011b1cb36f3SHong Zhang . ts - time stepping context 4012b1cb36f3SHong Zhang 4013b1cb36f3SHong Zhang Level: advanced 4014b1cb36f3SHong Zhang 4015b1cb36f3SHong Zhang Notes: 4016b1cb36f3SHong Zhang This function cannot be called until TSStep() has been completed. 4017b1cb36f3SHong Zhang 4018b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral() 4019b1cb36f3SHong Zhang @*/ 4020b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts) 4021b1cb36f3SHong Zhang { 4022b1cb36f3SHong Zhang PetscErrorCode ierr; 4023b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4024b1cb36f3SHong 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); 4025b1cb36f3SHong Zhang ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 4026b1cb36f3SHong Zhang PetscFunctionReturn(0); 4027b1cb36f3SHong Zhang } 4028d67e68b7SBarry Smith 4029d763cef2SBarry Smith /*@ 4030d763cef2SBarry Smith TSSolve - Steps the requested number of timesteps. 4031d763cef2SBarry Smith 4032d763cef2SBarry Smith Collective on TS 4033d763cef2SBarry Smith 4034d763cef2SBarry Smith Input Parameter: 4035d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 403663e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 403763e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 40385a3a76d0SJed Brown 4039d763cef2SBarry Smith Level: beginner 4040d763cef2SBarry Smith 40415a3a76d0SJed Brown Notes: 40425a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 40435a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 40445a3a76d0SJed Brown stepped over the final time. 40455a3a76d0SJed Brown 4046d763cef2SBarry Smith .keywords: TS, timestep, solve 4047d763cef2SBarry Smith 404863e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 4049d763cef2SBarry Smith @*/ 4050cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 4051d763cef2SBarry Smith { 4052b06615a5SLisandro Dalcin Vec solution; 4053d763cef2SBarry Smith PetscErrorCode ierr; 4054d763cef2SBarry Smith 4055d763cef2SBarry Smith PetscFunctionBegin; 4056d763cef2SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4057f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4058feed9e9dSBarry Smith 405949354f04SShri 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 */ 4060b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 40610910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 4062b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4063b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4064b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 40655a3a76d0SJed Brown } 40660910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4067bbd56ea5SKarl Rupp } else if (u) { 40680910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 40695a3a76d0SJed Brown } 4070b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 407168bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4072a6772fa2SLisandro Dalcin 4073a6772fa2SLisandro 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()"); 4074a6772fa2SLisandro 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"); 4075a6772fa2SLisandro Dalcin 4076e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 4077e7069c78SShri restarts the step after an event. Resetting these counters in such a case causes 4078e7069c78SShri TSTrajectory to incorrectly save the output files 4079e7069c78SShri */ 4080938c94caSShri Abhyankar 4081193ac0bcSJed Brown ts->steps = 0; 40825ef26d82SJed Brown ts->ksp_its = 0; 40835ef26d82SJed Brown ts->snes_its = 0; 4084c610991cSLisandro Dalcin ts->num_snes_failures = 0; 4085c610991cSLisandro Dalcin ts->reject = 0; 4086193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 4087193ac0bcSJed Brown 4088ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4089f05ece33SBarry Smith 4090193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4091193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4092a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4093cc708dedSBarry Smith ts->solvetime = ts->ptime; 4094a6772fa2SLisandro Dalcin solution = ts->vec_sol; 4095be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 4096db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4097db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4098e7069c78SShri 4099938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41006427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4101e7069c78SShri 410228d5b5d6SLisandro Dalcin ts->steprollback = PETSC_FALSE; 410328d5b5d6SLisandro Dalcin ts->steprestart = PETSC_TRUE; 41046427ac75SLisandro Dalcin 4105e1a7a14fSJed Brown while (!ts->reason) { 4106938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41079687d888SLisandro Dalcin if (!ts->steprollback) { 41089687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 41099687d888SLisandro Dalcin } 4110193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 4111e783b05fSHong 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. */ 4112b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 4113b1cb36f3SHong Zhang } 411410b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 4115e783b05fSHong 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. */ 4116e783b05fSHong Zhang if (!ts->steprollback) { 4117938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41181eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 4119aeb4809dSShri Abhyankar } 4120193ac0bcSJed Brown } 4121938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41226427ac75SLisandro Dalcin 412349354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 41240910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4125cc708dedSBarry Smith ts->solvetime = ts->max_time; 4126b06615a5SLisandro Dalcin solution = u; 412763e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 41280574a7fbSJed Brown } else { 4129ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4130cc708dedSBarry Smith ts->solvetime = ts->ptime; 4131b06615a5SLisandro Dalcin solution = ts->vec_sol; 41320574a7fbSJed Brown } 4133193ac0bcSJed Brown } 4134d2daff3dSHong Zhang 4135ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 413663e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 413756f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4138ef222394SBarry Smith if (ts->adjoint_solve) { 4139ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 41402b0a91c0SBarry Smith } 4141d763cef2SBarry Smith PetscFunctionReturn(0); 4142d763cef2SBarry Smith } 4143d763cef2SBarry Smith 4144b1cb36f3SHong Zhang /*@ 4145b1cb36f3SHong Zhang TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4146b1cb36f3SHong Zhang 4147b1cb36f3SHong Zhang Collective on TS 4148b1cb36f3SHong Zhang 4149b1cb36f3SHong Zhang Input Arguments: 4150b1cb36f3SHong Zhang . ts - time stepping context 4151b1cb36f3SHong Zhang 4152b1cb36f3SHong Zhang Level: advanced 4153b1cb36f3SHong Zhang 4154b1cb36f3SHong Zhang Notes: 4155b1cb36f3SHong Zhang This function cannot be called until TSAdjointStep() has been completed. 4156b1cb36f3SHong Zhang 4157b1cb36f3SHong Zhang .seealso: TSAdjointSolve(), TSAdjointStep 4158b1cb36f3SHong Zhang @*/ 4159b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts) 4160b1cb36f3SHong Zhang { 4161b1cb36f3SHong Zhang PetscErrorCode ierr; 4162b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4163b1cb36f3SHong 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); 4164b1cb36f3SHong Zhang ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4165b1cb36f3SHong Zhang PetscFunctionReturn(0); 4166b1cb36f3SHong Zhang } 4167b1cb36f3SHong Zhang 4168c88f2d44SBarry Smith /*@ 4169c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4170c88f2d44SBarry Smith 4171c88f2d44SBarry Smith Collective on TS 4172c88f2d44SBarry Smith 4173c88f2d44SBarry Smith Input Parameter: 41742c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 4175c88f2d44SBarry Smith 4176e87fd094SBarry Smith Options Database: 4177e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 4178e87fd094SBarry Smith 4179c88f2d44SBarry Smith Level: intermediate 4180c88f2d44SBarry Smith 4181c88f2d44SBarry Smith Notes: 4182c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 4183c88f2d44SBarry Smith 418473b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 418573b18844SBarry Smith 4186c88f2d44SBarry Smith .keywords: TS, timestep, solve 4187c88f2d44SBarry Smith 4188b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4189c88f2d44SBarry Smith @*/ 41902c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 4191c88f2d44SBarry Smith { 4192c88f2d44SBarry Smith PetscErrorCode ierr; 4193c88f2d44SBarry Smith 4194c88f2d44SBarry Smith PetscFunctionBegin; 4195c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4196c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 419768bece0bSHong Zhang 4198c88f2d44SBarry Smith /* reset time step and iteration counters */ 4199c88f2d44SBarry Smith ts->steps = 0; 4200c88f2d44SBarry Smith ts->ksp_its = 0; 4201c88f2d44SBarry Smith ts->snes_its = 0; 4202c88f2d44SBarry Smith ts->num_snes_failures = 0; 4203c88f2d44SBarry Smith ts->reject = 0; 4204c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 4205c88f2d44SBarry Smith 420673b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4207c88f2d44SBarry Smith 420873b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4209c88f2d44SBarry Smith while (!ts->reason) { 421055c52731SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 42119110b2e7SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 42126427ac75SLisandro Dalcin ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4213616946c1SHong Zhang ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4214b1cb36f3SHong Zhang if (ts->vec_costintegral && !ts->costintegralfwd) { 4215b1cb36f3SHong Zhang ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4216b1cb36f3SHong Zhang } 4217c88f2d44SBarry Smith } 421826656371SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 421926656371SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4220c88f2d44SBarry Smith ts->solvetime = ts->ptime; 4221e210cd0eSHong Zhang ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4222685405a1SBarry Smith ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4223c88f2d44SBarry Smith PetscFunctionReturn(0); 4224c88f2d44SBarry Smith } 4225c88f2d44SBarry Smith 42267db568b7SBarry Smith /*@C 4227228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4228228d79bcSJed Brown 4229228d79bcSJed Brown Collective on TS 4230228d79bcSJed Brown 4231228d79bcSJed Brown Input Parameters: 4232228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 4233228d79bcSJed Brown . step - step number that has just completed 4234228d79bcSJed Brown . ptime - model time of the state 42350910c330SBarry Smith - u - state at the current model time 4236228d79bcSJed Brown 4237228d79bcSJed Brown Notes: 42387db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 42397db568b7SBarry Smith Users would almost never call this routine directly. 4240228d79bcSJed Brown 424163e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 424263e21af5SBarry Smith 42437db568b7SBarry Smith Level: developer 4244228d79bcSJed Brown 4245228d79bcSJed Brown .keywords: TS, timestep 4246228d79bcSJed Brown @*/ 42470910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4248d763cef2SBarry Smith { 4249d6152f81SLisandro Dalcin DM dm; 4250a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 4251d6152f81SLisandro Dalcin PetscErrorCode ierr; 4252d763cef2SBarry Smith 4253d763cef2SBarry Smith PetscFunctionBegin; 4254b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4255b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4256d6152f81SLisandro Dalcin 4257d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4258d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4259d6152f81SLisandro Dalcin 42605edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 4261d763cef2SBarry Smith for (i=0; i<n; i++) { 42620910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4263d763cef2SBarry Smith } 42645edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 4265d763cef2SBarry Smith PetscFunctionReturn(0); 4266d763cef2SBarry Smith } 4267d763cef2SBarry Smith 42687db568b7SBarry Smith /*@C 42699110b2e7SHong Zhang TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 42709110b2e7SHong Zhang 42719110b2e7SHong Zhang Collective on TS 42729110b2e7SHong Zhang 42739110b2e7SHong Zhang Input Parameters: 42749110b2e7SHong Zhang + ts - time stepping context obtained from TSCreate() 42759110b2e7SHong Zhang . step - step number that has just completed 42769110b2e7SHong Zhang . ptime - model time of the state 42779110b2e7SHong Zhang . u - state at the current model time 42789110b2e7SHong Zhang . numcost - number of cost functions (dimension of lambda or mu) 42799110b2e7SHong Zhang . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 42809110b2e7SHong Zhang - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 42819110b2e7SHong Zhang 42829110b2e7SHong Zhang Notes: 42837db568b7SBarry Smith TSAdjointMonitor() is typically used automatically within the time stepping implementations. 42847db568b7SBarry Smith Users would almost never call this routine directly. 42859110b2e7SHong Zhang 42867db568b7SBarry Smith Level: developer 42879110b2e7SHong Zhang 42889110b2e7SHong Zhang .keywords: TS, timestep 42899110b2e7SHong Zhang @*/ 42909110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 42919110b2e7SHong Zhang { 42929110b2e7SHong Zhang PetscErrorCode ierr; 42939110b2e7SHong Zhang PetscInt i,n = ts->numberadjointmonitors; 42949110b2e7SHong Zhang 42959110b2e7SHong Zhang PetscFunctionBegin; 42969110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42979110b2e7SHong Zhang PetscValidHeaderSpecific(u,VEC_CLASSID,4); 42989110b2e7SHong Zhang ierr = VecLockPush(u);CHKERRQ(ierr); 42999110b2e7SHong Zhang for (i=0; i<n; i++) { 43009110b2e7SHong Zhang ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 43019110b2e7SHong Zhang } 43029110b2e7SHong Zhang ierr = VecLockPop(u);CHKERRQ(ierr); 43039110b2e7SHong Zhang PetscFunctionReturn(0); 43049110b2e7SHong Zhang } 43059110b2e7SHong Zhang 4306d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 4307d763cef2SBarry Smith /*@C 43087db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4309a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 4310d763cef2SBarry Smith 4311d763cef2SBarry Smith Collective on TS 4312d763cef2SBarry Smith 4313d763cef2SBarry Smith Input Parameters: 4314d763cef2SBarry Smith + host - the X display to open, or null for the local machine 4315d763cef2SBarry Smith . label - the title to put in the title bar 43167c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 4317a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 4318a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4319d763cef2SBarry Smith 4320d763cef2SBarry Smith Output Parameter: 43210b039ecaSBarry Smith . ctx - the context 4322d763cef2SBarry Smith 4323d763cef2SBarry Smith Options Database Key: 43244f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 43257db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 43267db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 43277db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 43287db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4329b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4330d763cef2SBarry Smith 4331d763cef2SBarry Smith Notes: 4332a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 4333d763cef2SBarry Smith 43347db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 43357db568b7SBarry Smith 43367db568b7SBarry 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 43377db568b7SBarry 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 43387db568b7SBarry Smith as the first argument. 43397db568b7SBarry Smith 43407db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 43417db568b7SBarry Smith 43427db568b7SBarry Smith 4343d763cef2SBarry Smith Level: intermediate 4344d763cef2SBarry Smith 43457db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 4346d763cef2SBarry Smith 43477db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 43487db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 43497db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 43507db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 43517db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 43527c922b88SBarry Smith 4353d763cef2SBarry Smith @*/ 4354a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4355d763cef2SBarry Smith { 43567f52daa2SLisandro Dalcin PetscDraw draw; 4357dfbe8321SBarry Smith PetscErrorCode ierr; 4358d763cef2SBarry Smith 4359d763cef2SBarry Smith PetscFunctionBegin; 4360b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 43617f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 43627f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 43637f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4364287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 43657f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4366a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4367d763cef2SBarry Smith PetscFunctionReturn(0); 4368d763cef2SBarry Smith } 4369d763cef2SBarry Smith 4370b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4371d763cef2SBarry Smith { 43720b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4373c32365f1SBarry Smith PetscReal x = ptime,y; 4374dfbe8321SBarry Smith PetscErrorCode ierr; 4375d763cef2SBarry Smith 4376d763cef2SBarry Smith PetscFunctionBegin; 437763e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4378b06615a5SLisandro Dalcin if (!step) { 4379a9f9c1f6SBarry Smith PetscDrawAxis axis; 4380a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 43816934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4382a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4383a9f9c1f6SBarry Smith } 4384c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 43850b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4386b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 43870b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 43886934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 43893923b477SBarry Smith } 4390d763cef2SBarry Smith PetscFunctionReturn(0); 4391d763cef2SBarry Smith } 4392d763cef2SBarry Smith 4393d763cef2SBarry Smith /*@C 4394a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4395a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4396d763cef2SBarry Smith 43970b039ecaSBarry Smith Collective on TSMonitorLGCtx 4398d763cef2SBarry Smith 4399d763cef2SBarry Smith Input Parameter: 44000b039ecaSBarry Smith . ctx - the monitor context 4401d763cef2SBarry Smith 4402d763cef2SBarry Smith Level: intermediate 4403d763cef2SBarry Smith 4404d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 4405d763cef2SBarry Smith 44064f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4407d763cef2SBarry Smith @*/ 4408a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4409d763cef2SBarry Smith { 4410dfbe8321SBarry Smith PetscErrorCode ierr; 4411d763cef2SBarry Smith 4412d763cef2SBarry Smith PetscFunctionBegin; 44137684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 44147684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 44157684fa3eSBarry Smith } 44160b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 441731152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4418387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4419387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4420387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 44210b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4422d763cef2SBarry Smith PetscFunctionReturn(0); 4423d763cef2SBarry Smith } 4424d763cef2SBarry Smith 4425d763cef2SBarry Smith /*@ 4426b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4427d763cef2SBarry Smith 4428d763cef2SBarry Smith Not Collective 4429d763cef2SBarry Smith 4430d763cef2SBarry Smith Input Parameter: 4431d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4432d763cef2SBarry Smith 4433d763cef2SBarry Smith Output Parameter: 443463e21af5SBarry Smith . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4435d763cef2SBarry Smith 4436d763cef2SBarry Smith Level: beginner 4437d763cef2SBarry Smith 4438b8123daeSJed Brown Note: 4439b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 44409be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4441b8123daeSJed Brown 444263e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4443d763cef2SBarry Smith 4444d763cef2SBarry Smith .keywords: TS, get, time 4445d763cef2SBarry Smith @*/ 44467087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4447d763cef2SBarry Smith { 4448d763cef2SBarry Smith PetscFunctionBegin; 44490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4450f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4451d763cef2SBarry Smith *t = ts->ptime; 4452d763cef2SBarry Smith PetscFunctionReturn(0); 4453d763cef2SBarry Smith } 4454d763cef2SBarry Smith 4455e5e524a1SHong Zhang /*@ 4456e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4457e5e524a1SHong Zhang 4458e5e524a1SHong Zhang Not Collective 4459e5e524a1SHong Zhang 4460e5e524a1SHong Zhang Input Parameter: 4461e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4462e5e524a1SHong Zhang 4463e5e524a1SHong Zhang Output Parameter: 4464e5e524a1SHong Zhang . t - the previous time 4465e5e524a1SHong Zhang 4466e5e524a1SHong Zhang Level: beginner 4467e5e524a1SHong Zhang 4468e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4469e5e524a1SHong Zhang 4470e5e524a1SHong Zhang .keywords: TS, get, time 4471e5e524a1SHong Zhang @*/ 4472e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4473e5e524a1SHong Zhang { 4474e5e524a1SHong Zhang PetscFunctionBegin; 4475e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4476e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4477e5e524a1SHong Zhang *t = ts->ptime_prev; 4478e5e524a1SHong Zhang PetscFunctionReturn(0); 4479e5e524a1SHong Zhang } 4480e5e524a1SHong Zhang 44816a4d4014SLisandro Dalcin /*@ 44826a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 44836a4d4014SLisandro Dalcin 44843f9fe445SBarry Smith Logically Collective on TS 44856a4d4014SLisandro Dalcin 44866a4d4014SLisandro Dalcin Input Parameters: 44876a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 44886a4d4014SLisandro Dalcin - time - the time 44896a4d4014SLisandro Dalcin 44906a4d4014SLisandro Dalcin Level: intermediate 44916a4d4014SLisandro Dalcin 44926a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 44936a4d4014SLisandro Dalcin 44946a4d4014SLisandro Dalcin .keywords: TS, set, time 44956a4d4014SLisandro Dalcin @*/ 44967087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 44976a4d4014SLisandro Dalcin { 44986a4d4014SLisandro Dalcin PetscFunctionBegin; 44990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4500c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 45016a4d4014SLisandro Dalcin ts->ptime = t; 45026a4d4014SLisandro Dalcin PetscFunctionReturn(0); 45036a4d4014SLisandro Dalcin } 45046a4d4014SLisandro Dalcin 4505d763cef2SBarry Smith /*@C 4506d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4507d763cef2SBarry Smith TS options in the database. 4508d763cef2SBarry Smith 45093f9fe445SBarry Smith Logically Collective on TS 4510d763cef2SBarry Smith 4511d763cef2SBarry Smith Input Parameter: 4512d763cef2SBarry Smith + ts - The TS context 4513d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4514d763cef2SBarry Smith 4515d763cef2SBarry Smith Notes: 4516d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4517d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4518d763cef2SBarry Smith hyphen. 4519d763cef2SBarry Smith 4520d763cef2SBarry Smith Level: advanced 4521d763cef2SBarry Smith 4522d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4523d763cef2SBarry Smith 4524d763cef2SBarry Smith .seealso: TSSetFromOptions() 4525d763cef2SBarry Smith 4526d763cef2SBarry Smith @*/ 45277087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4528d763cef2SBarry Smith { 4529dfbe8321SBarry Smith PetscErrorCode ierr; 4530089b2837SJed Brown SNES snes; 4531d763cef2SBarry Smith 4532d763cef2SBarry Smith PetscFunctionBegin; 45330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4534d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4535089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4536089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4537d763cef2SBarry Smith PetscFunctionReturn(0); 4538d763cef2SBarry Smith } 4539d763cef2SBarry Smith 4540d763cef2SBarry Smith 4541d763cef2SBarry Smith /*@C 4542d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4543d763cef2SBarry Smith TS options in the database. 4544d763cef2SBarry Smith 45453f9fe445SBarry Smith Logically Collective on TS 4546d763cef2SBarry Smith 4547d763cef2SBarry Smith Input Parameter: 4548d763cef2SBarry Smith + ts - The TS context 4549d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4550d763cef2SBarry Smith 4551d763cef2SBarry Smith Notes: 4552d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4553d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4554d763cef2SBarry Smith hyphen. 4555d763cef2SBarry Smith 4556d763cef2SBarry Smith Level: advanced 4557d763cef2SBarry Smith 4558d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4559d763cef2SBarry Smith 4560d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4561d763cef2SBarry Smith 4562d763cef2SBarry Smith @*/ 45637087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4564d763cef2SBarry Smith { 4565dfbe8321SBarry Smith PetscErrorCode ierr; 4566089b2837SJed Brown SNES snes; 4567d763cef2SBarry Smith 4568d763cef2SBarry Smith PetscFunctionBegin; 45690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4570d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4571089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4572089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4573d763cef2SBarry Smith PetscFunctionReturn(0); 4574d763cef2SBarry Smith } 4575d763cef2SBarry Smith 4576d763cef2SBarry Smith /*@C 4577d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4578d763cef2SBarry Smith TS options in the database. 4579d763cef2SBarry Smith 4580d763cef2SBarry Smith Not Collective 4581d763cef2SBarry Smith 4582d763cef2SBarry Smith Input Parameter: 4583d763cef2SBarry Smith . ts - The TS context 4584d763cef2SBarry Smith 4585d763cef2SBarry Smith Output Parameter: 4586d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4587d763cef2SBarry Smith 4588d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 4589d763cef2SBarry Smith sufficient length to hold the prefix. 4590d763cef2SBarry Smith 4591d763cef2SBarry Smith Level: intermediate 4592d763cef2SBarry Smith 4593d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4594d763cef2SBarry Smith 4595d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4596d763cef2SBarry Smith @*/ 45977087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4598d763cef2SBarry Smith { 4599dfbe8321SBarry Smith PetscErrorCode ierr; 4600d763cef2SBarry Smith 4601d763cef2SBarry Smith PetscFunctionBegin; 46020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46034482741eSBarry Smith PetscValidPointer(prefix,2); 4604d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4605d763cef2SBarry Smith PetscFunctionReturn(0); 4606d763cef2SBarry Smith } 4607d763cef2SBarry Smith 4608d763cef2SBarry Smith /*@C 4609d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4610d763cef2SBarry Smith 4611d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4612d763cef2SBarry Smith 4613d763cef2SBarry Smith Input Parameter: 4614d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4615d763cef2SBarry Smith 4616d763cef2SBarry Smith Output Parameters: 4617e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4618e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4619e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4620e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4621d763cef2SBarry Smith 46220298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 4623d763cef2SBarry Smith 4624d763cef2SBarry Smith Level: intermediate 4625d763cef2SBarry Smith 462626d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4627d763cef2SBarry Smith 4628d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4629d763cef2SBarry Smith @*/ 4630e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4631d763cef2SBarry Smith { 4632089b2837SJed Brown PetscErrorCode ierr; 463324989b8cSPeter Brune DM dm; 4634089b2837SJed Brown 4635d763cef2SBarry Smith PetscFunctionBegin; 463623a57915SBarry Smith if (Amat || Pmat) { 463723a57915SBarry Smith SNES snes; 4638089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 463923a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4640e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 464123a57915SBarry Smith } 464224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 464324989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4644d763cef2SBarry Smith PetscFunctionReturn(0); 4645d763cef2SBarry Smith } 4646d763cef2SBarry Smith 46472eca1d9cSJed Brown /*@C 46482eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 46492eca1d9cSJed Brown 46502eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 46512eca1d9cSJed Brown 46522eca1d9cSJed Brown Input Parameter: 46532eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 46542eca1d9cSJed Brown 46552eca1d9cSJed Brown Output Parameters: 4656e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4657e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 46582eca1d9cSJed Brown . f - The function to compute the matrices 46592eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 46602eca1d9cSJed Brown 46610298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 46622eca1d9cSJed Brown 46632eca1d9cSJed Brown Level: advanced 46642eca1d9cSJed Brown 46652eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 46662eca1d9cSJed Brown 46672eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 46682eca1d9cSJed Brown @*/ 4669e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 46702eca1d9cSJed Brown { 4671089b2837SJed Brown PetscErrorCode ierr; 467224989b8cSPeter Brune DM dm; 46730910c330SBarry Smith 46742eca1d9cSJed Brown PetscFunctionBegin; 4675c0aab802Sstefano_zampini if (Amat || Pmat) { 4676c0aab802Sstefano_zampini SNES snes; 4677089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4678f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4679e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4680c0aab802Sstefano_zampini } 468124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 468224989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 46832eca1d9cSJed Brown PetscFunctionReturn(0); 46842eca1d9cSJed Brown } 46852eca1d9cSJed Brown 46866083293cSBarry Smith 46871713a123SBarry Smith /*@C 468883a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 46891713a123SBarry Smith VecView() for the solution at each timestep 46901713a123SBarry Smith 46911713a123SBarry Smith Collective on TS 46921713a123SBarry Smith 46931713a123SBarry Smith Input Parameters: 46941713a123SBarry Smith + ts - the TS context 46951713a123SBarry Smith . step - current time-step 4696142b95e3SSatish Balay . ptime - current time 46970298fd71SBarry Smith - dummy - either a viewer or NULL 46981713a123SBarry Smith 469999fdda47SBarry Smith Options Database: 470099fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 470199fdda47SBarry Smith 4702387f4636SBarry 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 470399fdda47SBarry Smith will look bad 470499fdda47SBarry Smith 47051713a123SBarry Smith Level: intermediate 47061713a123SBarry Smith 47071713a123SBarry Smith .keywords: TS, vector, monitor, view 47081713a123SBarry Smith 4709a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 47101713a123SBarry Smith @*/ 47110910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 47121713a123SBarry Smith { 4713dfbe8321SBarry Smith PetscErrorCode ierr; 471483a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4715473a3ab2SBarry Smith PetscDraw draw; 47161713a123SBarry Smith 47171713a123SBarry Smith PetscFunctionBegin; 47186083293cSBarry Smith if (!step && ictx->showinitial) { 47196083293cSBarry Smith if (!ictx->initialsolution) { 47200910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 47211713a123SBarry Smith } 47220910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 47236083293cSBarry Smith } 4724b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47250dcf80beSBarry Smith 47266083293cSBarry Smith if (ictx->showinitial) { 47276083293cSBarry Smith PetscReal pause; 47286083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 47296083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 47306083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 47316083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 47326083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 47336083293cSBarry Smith } 47340910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4735473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 473651fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4737473a3ab2SBarry Smith char time[32]; 4738473a3ab2SBarry Smith 4739473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 474085b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4741473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4742473a3ab2SBarry Smith h = yl + .95*(yr - yl); 474351fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4744473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4745473a3ab2SBarry Smith } 4746473a3ab2SBarry Smith 47476083293cSBarry Smith if (ictx->showinitial) { 47486083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 47496083293cSBarry Smith } 47501713a123SBarry Smith PetscFunctionReturn(0); 47511713a123SBarry Smith } 47521713a123SBarry Smith 47539110b2e7SHong Zhang /*@C 47549110b2e7SHong Zhang TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 47559110b2e7SHong Zhang VecView() for the sensitivities to initial states at each timestep 47569110b2e7SHong Zhang 47579110b2e7SHong Zhang Collective on TS 47589110b2e7SHong Zhang 47599110b2e7SHong Zhang Input Parameters: 47609110b2e7SHong Zhang + ts - the TS context 47619110b2e7SHong Zhang . step - current time-step 47629110b2e7SHong Zhang . ptime - current time 47639110b2e7SHong Zhang . u - current state 47649110b2e7SHong Zhang . numcost - number of cost functions 47659110b2e7SHong Zhang . lambda - sensitivities to initial conditions 47669110b2e7SHong Zhang . mu - sensitivities to parameters 47679110b2e7SHong Zhang - dummy - either a viewer or NULL 47689110b2e7SHong Zhang 47699110b2e7SHong Zhang Level: intermediate 47709110b2e7SHong Zhang 47719110b2e7SHong Zhang .keywords: TS, vector, adjoint, monitor, view 47729110b2e7SHong Zhang 47739110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 47749110b2e7SHong Zhang @*/ 47759110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 47769110b2e7SHong Zhang { 47779110b2e7SHong Zhang PetscErrorCode ierr; 47789110b2e7SHong Zhang TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 47799110b2e7SHong Zhang PetscDraw draw; 4780a0046e2cSSatish Balay PetscReal xl,yl,xr,yr,h; 4781a0046e2cSSatish Balay char time[32]; 47829110b2e7SHong Zhang 47839110b2e7SHong Zhang PetscFunctionBegin; 47849110b2e7SHong Zhang if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47859110b2e7SHong Zhang 47869110b2e7SHong Zhang ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 47879110b2e7SHong Zhang ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 47889110b2e7SHong Zhang ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 47899110b2e7SHong Zhang ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 47909110b2e7SHong Zhang h = yl + .95*(yr - yl); 47919110b2e7SHong Zhang ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 47929110b2e7SHong Zhang ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 47939110b2e7SHong Zhang PetscFunctionReturn(0); 47949110b2e7SHong Zhang } 47959110b2e7SHong Zhang 47962d5ee99bSBarry Smith /*@C 47972d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 47982d5ee99bSBarry Smith 47992d5ee99bSBarry Smith Collective on TS 48002d5ee99bSBarry Smith 48012d5ee99bSBarry Smith Input Parameters: 48022d5ee99bSBarry Smith + ts - the TS context 48032d5ee99bSBarry Smith . step - current time-step 48042d5ee99bSBarry Smith . ptime - current time 48052d5ee99bSBarry Smith - dummy - either a viewer or NULL 48062d5ee99bSBarry Smith 48072d5ee99bSBarry Smith Level: intermediate 48082d5ee99bSBarry Smith 48092d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 48102d5ee99bSBarry Smith 48112d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 48122d5ee99bSBarry Smith @*/ 48132d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 48142d5ee99bSBarry Smith { 48152d5ee99bSBarry Smith PetscErrorCode ierr; 48162d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 48172d5ee99bSBarry Smith PetscDraw draw; 48186934998bSLisandro Dalcin PetscDrawAxis axis; 48192d5ee99bSBarry Smith PetscInt n; 48202d5ee99bSBarry Smith PetscMPIInt size; 48216934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 48222d5ee99bSBarry Smith char time[32]; 48232d5ee99bSBarry Smith const PetscScalar *U; 48242d5ee99bSBarry Smith 48252d5ee99bSBarry Smith PetscFunctionBegin; 48266934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 48276934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 48282d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 48296934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 48302d5ee99bSBarry Smith 48312d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 48326934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 48336934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 48346934998bSLisandro Dalcin if (!step) { 48356934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 48366934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 48376934998bSLisandro Dalcin } 48382d5ee99bSBarry Smith 48392d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 48406934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 48416934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4842a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 48436934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 48442d5ee99bSBarry Smith 48456934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 48466934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 48472d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 48484b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 484985b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 48502d5ee99bSBarry Smith h = yl + .95*(yr - yl); 485151fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 48522d5ee99bSBarry Smith } 48536934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 48542d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 48556934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 48562d5ee99bSBarry Smith PetscFunctionReturn(0); 48572d5ee99bSBarry Smith } 48582d5ee99bSBarry Smith 48591713a123SBarry Smith 48606083293cSBarry Smith /*@C 486183a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 48626083293cSBarry Smith 48636083293cSBarry Smith Collective on TS 48646083293cSBarry Smith 48656083293cSBarry Smith Input Parameters: 48666083293cSBarry Smith . ctx - the monitor context 48676083293cSBarry Smith 48686083293cSBarry Smith Level: intermediate 48696083293cSBarry Smith 48706083293cSBarry Smith .keywords: TS, vector, monitor, view 48716083293cSBarry Smith 487283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 48736083293cSBarry Smith @*/ 487483a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 48756083293cSBarry Smith { 48766083293cSBarry Smith PetscErrorCode ierr; 48776083293cSBarry Smith 48786083293cSBarry Smith PetscFunctionBegin; 487983a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 488083a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 488183a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 48826083293cSBarry Smith PetscFunctionReturn(0); 48836083293cSBarry Smith } 48846083293cSBarry Smith 48856083293cSBarry Smith /*@C 488683a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 48876083293cSBarry Smith 48886083293cSBarry Smith Collective on TS 48896083293cSBarry Smith 48906083293cSBarry Smith Input Parameter: 48916083293cSBarry Smith . ts - time-step context 48926083293cSBarry Smith 48936083293cSBarry Smith Output Patameter: 48946083293cSBarry Smith . ctx - the monitor context 48956083293cSBarry Smith 489699fdda47SBarry Smith Options Database: 489799fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 489899fdda47SBarry Smith 48996083293cSBarry Smith Level: intermediate 49006083293cSBarry Smith 49016083293cSBarry Smith .keywords: TS, vector, monitor, view 49026083293cSBarry Smith 490383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 49046083293cSBarry Smith @*/ 490583a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 49066083293cSBarry Smith { 49076083293cSBarry Smith PetscErrorCode ierr; 49086083293cSBarry Smith 49096083293cSBarry Smith PetscFunctionBegin; 4910b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 491183a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4912e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4913bbd56ea5SKarl Rupp 491483a4ac43SBarry Smith (*ctx)->howoften = howoften; 4915473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4916c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4917473a3ab2SBarry Smith 4918473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4919c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 49206083293cSBarry Smith PetscFunctionReturn(0); 49216083293cSBarry Smith } 49226083293cSBarry Smith 49233a471f94SBarry Smith /*@C 492483a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 49253a471f94SBarry Smith VecView() for the error at each timestep 49263a471f94SBarry Smith 49273a471f94SBarry Smith Collective on TS 49283a471f94SBarry Smith 49293a471f94SBarry Smith Input Parameters: 49303a471f94SBarry Smith + ts - the TS context 49313a471f94SBarry Smith . step - current time-step 49323a471f94SBarry Smith . ptime - current time 49330298fd71SBarry Smith - dummy - either a viewer or NULL 49343a471f94SBarry Smith 49353a471f94SBarry Smith Level: intermediate 49363a471f94SBarry Smith 49373a471f94SBarry Smith .keywords: TS, vector, monitor, view 49383a471f94SBarry Smith 49393a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 49403a471f94SBarry Smith @*/ 49410910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 49423a471f94SBarry Smith { 49433a471f94SBarry Smith PetscErrorCode ierr; 494483a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 494583a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 49463a471f94SBarry Smith Vec work; 49473a471f94SBarry Smith 49483a471f94SBarry Smith PetscFunctionBegin; 4949b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 49500910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 49513a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 49520910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 49533a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 49543a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 49553a471f94SBarry Smith PetscFunctionReturn(0); 49563a471f94SBarry Smith } 49573a471f94SBarry Smith 4958af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 49596c699258SBarry Smith /*@ 49602a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 49616c699258SBarry Smith 49623f9fe445SBarry Smith Logically Collective on TS and DM 49636c699258SBarry Smith 49646c699258SBarry Smith Input Parameters: 49652a808120SBarry Smith + ts - the ODE integrator object 49662a808120SBarry Smith - dm - the dm, cannot be NULL 49676c699258SBarry Smith 49686c699258SBarry Smith Level: intermediate 49696c699258SBarry Smith 49706c699258SBarry Smith 49716c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 49726c699258SBarry Smith @*/ 49737087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 49746c699258SBarry Smith { 49756c699258SBarry Smith PetscErrorCode ierr; 4976089b2837SJed Brown SNES snes; 4977942e3340SBarry Smith DMTS tsdm; 49786c699258SBarry Smith 49796c699258SBarry Smith PetscFunctionBegin; 49800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49812a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 498270663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4983942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 49842a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4985942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4986942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 498724989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 498824989b8cSPeter Brune tsdm->originaldm = dm; 498924989b8cSPeter Brune } 499024989b8cSPeter Brune } 49916bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 499224989b8cSPeter Brune } 49936c699258SBarry Smith ts->dm = dm; 4994bbd56ea5SKarl Rupp 4995089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4996089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 49976c699258SBarry Smith PetscFunctionReturn(0); 49986c699258SBarry Smith } 49996c699258SBarry Smith 50006c699258SBarry Smith /*@ 50016c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 50026c699258SBarry Smith 50033f9fe445SBarry Smith Not Collective 50046c699258SBarry Smith 50056c699258SBarry Smith Input Parameter: 50066c699258SBarry Smith . ts - the preconditioner context 50076c699258SBarry Smith 50086c699258SBarry Smith Output Parameter: 50096c699258SBarry Smith . dm - the dm 50106c699258SBarry Smith 50116c699258SBarry Smith Level: intermediate 50126c699258SBarry Smith 50136c699258SBarry Smith 50146c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 50156c699258SBarry Smith @*/ 50167087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 50176c699258SBarry Smith { 5018496e6a7aSJed Brown PetscErrorCode ierr; 5019496e6a7aSJed Brown 50206c699258SBarry Smith PetscFunctionBegin; 50210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5022496e6a7aSJed Brown if (!ts->dm) { 5023ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 5024496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 5025496e6a7aSJed Brown } 50266c699258SBarry Smith *dm = ts->dm; 50276c699258SBarry Smith PetscFunctionReturn(0); 50286c699258SBarry Smith } 50291713a123SBarry Smith 50300f5c6efeSJed Brown /*@ 50310f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 50320f5c6efeSJed Brown 50333f9fe445SBarry Smith Logically Collective on SNES 50340f5c6efeSJed Brown 50350f5c6efeSJed Brown Input Parameter: 5036d42a1c89SJed Brown + snes - nonlinear solver 50370910c330SBarry Smith . U - the current state at which to evaluate the residual 5038d42a1c89SJed Brown - ctx - user context, must be a TS 50390f5c6efeSJed Brown 50400f5c6efeSJed Brown Output Parameter: 50410f5c6efeSJed Brown . F - the nonlinear residual 50420f5c6efeSJed Brown 50430f5c6efeSJed Brown Notes: 50440f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50450f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 50460f5c6efeSJed Brown 50470f5c6efeSJed Brown Level: advanced 50480f5c6efeSJed Brown 50490f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 50500f5c6efeSJed Brown @*/ 50510910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 50520f5c6efeSJed Brown { 50530f5c6efeSJed Brown TS ts = (TS)ctx; 50540f5c6efeSJed Brown PetscErrorCode ierr; 50550f5c6efeSJed Brown 50560f5c6efeSJed Brown PetscFunctionBegin; 50570f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50580910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50590f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 50600f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 50610910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 50620f5c6efeSJed Brown PetscFunctionReturn(0); 50630f5c6efeSJed Brown } 50640f5c6efeSJed Brown 50650f5c6efeSJed Brown /*@ 50660f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 50670f5c6efeSJed Brown 50680f5c6efeSJed Brown Collective on SNES 50690f5c6efeSJed Brown 50700f5c6efeSJed Brown Input Parameter: 50710f5c6efeSJed Brown + snes - nonlinear solver 50720910c330SBarry Smith . U - the current state at which to evaluate the residual 50730f5c6efeSJed Brown - ctx - user context, must be a TS 50740f5c6efeSJed Brown 50750f5c6efeSJed Brown Output Parameter: 50760f5c6efeSJed Brown + A - the Jacobian 50770f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 50780f5c6efeSJed Brown - flag - indicates any structure change in the matrix 50790f5c6efeSJed Brown 50800f5c6efeSJed Brown Notes: 50810f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50820f5c6efeSJed Brown 50830f5c6efeSJed Brown Level: developer 50840f5c6efeSJed Brown 50850f5c6efeSJed Brown .seealso: SNESSetJacobian() 50860f5c6efeSJed Brown @*/ 5087d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 50880f5c6efeSJed Brown { 50890f5c6efeSJed Brown TS ts = (TS)ctx; 50900f5c6efeSJed Brown PetscErrorCode ierr; 50910f5c6efeSJed Brown 50920f5c6efeSJed Brown PetscFunctionBegin; 50930f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50940910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50950f5c6efeSJed Brown PetscValidPointer(A,3); 509694ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 50970f5c6efeSJed Brown PetscValidPointer(B,4); 509894ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 50990f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5100d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 51010f5c6efeSJed Brown PetscFunctionReturn(0); 51020f5c6efeSJed Brown } 5103325fc9f4SBarry Smith 51040e4ef248SJed Brown /*@C 51059ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 51060e4ef248SJed Brown 51070e4ef248SJed Brown Collective on TS 51080e4ef248SJed Brown 51090e4ef248SJed Brown Input Arguments: 51100e4ef248SJed Brown + ts - time stepping context 51110e4ef248SJed Brown . t - time at which to evaluate 51120910c330SBarry Smith . U - state at which to evaluate 51130e4ef248SJed Brown - ctx - context 51140e4ef248SJed Brown 51150e4ef248SJed Brown Output Arguments: 51160e4ef248SJed Brown . F - right hand side 51170e4ef248SJed Brown 51180e4ef248SJed Brown Level: intermediate 51190e4ef248SJed Brown 51200e4ef248SJed Brown Notes: 51210e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 51220e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 51230e4ef248SJed Brown 51240e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 51250e4ef248SJed Brown @*/ 51260910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 51270e4ef248SJed Brown { 51280e4ef248SJed Brown PetscErrorCode ierr; 51290e4ef248SJed Brown Mat Arhs,Brhs; 51300e4ef248SJed Brown 51310e4ef248SJed Brown PetscFunctionBegin; 51320e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5133d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 51340910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 51350e4ef248SJed Brown PetscFunctionReturn(0); 51360e4ef248SJed Brown } 51370e4ef248SJed Brown 51380e4ef248SJed Brown /*@C 51390e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 51400e4ef248SJed Brown 51410e4ef248SJed Brown Collective on TS 51420e4ef248SJed Brown 51430e4ef248SJed Brown Input Arguments: 51440e4ef248SJed Brown + ts - time stepping context 51450e4ef248SJed Brown . t - time at which to evaluate 51460910c330SBarry Smith . U - state at which to evaluate 51470e4ef248SJed Brown - ctx - context 51480e4ef248SJed Brown 51490e4ef248SJed Brown Output Arguments: 51500e4ef248SJed Brown + A - pointer to operator 51510e4ef248SJed Brown . B - pointer to preconditioning matrix 51520e4ef248SJed Brown - flg - matrix structure flag 51530e4ef248SJed Brown 51540e4ef248SJed Brown Level: intermediate 51550e4ef248SJed Brown 51560e4ef248SJed Brown Notes: 51570e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 51580e4ef248SJed Brown 51590e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 51600e4ef248SJed Brown @*/ 5161d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 51620e4ef248SJed Brown { 51630e4ef248SJed Brown PetscFunctionBegin; 51640e4ef248SJed Brown PetscFunctionReturn(0); 51650e4ef248SJed Brown } 51660e4ef248SJed Brown 51670026cea9SSean Farley /*@C 51680026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 51690026cea9SSean Farley 51700026cea9SSean Farley Collective on TS 51710026cea9SSean Farley 51720026cea9SSean Farley Input Arguments: 51730026cea9SSean Farley + ts - time stepping context 51740026cea9SSean Farley . t - time at which to evaluate 51750910c330SBarry Smith . U - state at which to evaluate 51760910c330SBarry Smith . Udot - time derivative of state vector 51770026cea9SSean Farley - ctx - context 51780026cea9SSean Farley 51790026cea9SSean Farley Output Arguments: 51800026cea9SSean Farley . F - left hand side 51810026cea9SSean Farley 51820026cea9SSean Farley Level: intermediate 51830026cea9SSean Farley 51840026cea9SSean Farley Notes: 51850910c330SBarry 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 51860026cea9SSean Farley user is required to write their own TSComputeIFunction. 51870026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 51880026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 51890026cea9SSean Farley 51909ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 51919ae8fd06SBarry Smith 51929ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 51930026cea9SSean Farley @*/ 51940910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 51950026cea9SSean Farley { 51960026cea9SSean Farley PetscErrorCode ierr; 51970026cea9SSean Farley Mat A,B; 51980026cea9SSean Farley 51990026cea9SSean Farley PetscFunctionBegin; 52000298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5201d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 52020910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 52030026cea9SSean Farley PetscFunctionReturn(0); 52040026cea9SSean Farley } 52050026cea9SSean Farley 52060026cea9SSean Farley /*@C 5207b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 52080026cea9SSean Farley 52090026cea9SSean Farley Collective on TS 52100026cea9SSean Farley 52110026cea9SSean Farley Input Arguments: 52120026cea9SSean Farley + ts - time stepping context 52130026cea9SSean Farley . t - time at which to evaluate 52140910c330SBarry Smith . U - state at which to evaluate 52150910c330SBarry Smith . Udot - time derivative of state vector 52160026cea9SSean Farley . shift - shift to apply 52170026cea9SSean Farley - ctx - context 52180026cea9SSean Farley 52190026cea9SSean Farley Output Arguments: 52200026cea9SSean Farley + A - pointer to operator 52210026cea9SSean Farley . B - pointer to preconditioning matrix 52220026cea9SSean Farley - flg - matrix structure flag 52230026cea9SSean Farley 5224b41af12eSJed Brown Level: advanced 52250026cea9SSean Farley 52260026cea9SSean Farley Notes: 52270026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 52280026cea9SSean Farley 5229b41af12eSJed Brown It is only appropriate for problems of the form 5230b41af12eSJed Brown 5231b41af12eSJed Brown $ M Udot = F(U,t) 5232b41af12eSJed Brown 5233b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5234b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5235b41af12eSJed Brown an implicit operator of the form 5236b41af12eSJed Brown 5237b41af12eSJed Brown $ shift*M + J 5238b41af12eSJed Brown 5239b41af12eSJed 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 5240b41af12eSJed Brown a copy of M or reassemble it when requested. 5241b41af12eSJed Brown 52420026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 52430026cea9SSean Farley @*/ 5244d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 52450026cea9SSean Farley { 5246b41af12eSJed Brown PetscErrorCode ierr; 5247b41af12eSJed Brown 52480026cea9SSean Farley PetscFunctionBegin; 524994ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5250b41af12eSJed Brown ts->ijacobian.shift = shift; 52510026cea9SSean Farley PetscFunctionReturn(0); 52520026cea9SSean Farley } 5253b41af12eSJed Brown 5254e817cc15SEmil Constantinescu /*@ 5255e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 5256e817cc15SEmil Constantinescu 5257e817cc15SEmil Constantinescu Not Collective 5258e817cc15SEmil Constantinescu 5259e817cc15SEmil Constantinescu Input Parameter: 5260e817cc15SEmil Constantinescu . ts - the TS context 5261e817cc15SEmil Constantinescu 5262e817cc15SEmil Constantinescu Output Parameter: 52634e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 5264e817cc15SEmil Constantinescu 5265e817cc15SEmil Constantinescu Level: beginner 5266e817cc15SEmil Constantinescu 5267e817cc15SEmil Constantinescu .keywords: TS, equation type 5268e817cc15SEmil Constantinescu 5269e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 5270e817cc15SEmil Constantinescu @*/ 5271e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5272e817cc15SEmil Constantinescu { 5273e817cc15SEmil Constantinescu PetscFunctionBegin; 5274e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5275e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 5276e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 5277e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5278e817cc15SEmil Constantinescu } 5279e817cc15SEmil Constantinescu 5280e817cc15SEmil Constantinescu /*@ 5281e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 5282e817cc15SEmil Constantinescu 5283e817cc15SEmil Constantinescu Not Collective 5284e817cc15SEmil Constantinescu 5285e817cc15SEmil Constantinescu Input Parameter: 5286e817cc15SEmil Constantinescu + ts - the TS context 52871297b224SEmil Constantinescu - equation_type - see TSEquationType 5288e817cc15SEmil Constantinescu 5289e817cc15SEmil Constantinescu Level: advanced 5290e817cc15SEmil Constantinescu 5291e817cc15SEmil Constantinescu .keywords: TS, equation type 5292e817cc15SEmil Constantinescu 5293e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 5294e817cc15SEmil Constantinescu @*/ 5295e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5296e817cc15SEmil Constantinescu { 5297e817cc15SEmil Constantinescu PetscFunctionBegin; 5298e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5299e817cc15SEmil Constantinescu ts->equation_type = equation_type; 5300e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5301e817cc15SEmil Constantinescu } 53020026cea9SSean Farley 53034af1b03aSJed Brown /*@ 53044af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 53054af1b03aSJed Brown 53064af1b03aSJed Brown Not Collective 53074af1b03aSJed Brown 53084af1b03aSJed Brown Input Parameter: 53094af1b03aSJed Brown . ts - the TS context 53104af1b03aSJed Brown 53114af1b03aSJed Brown Output Parameter: 53124af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 53134af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 53144af1b03aSJed Brown 5315487e0bb9SJed Brown Level: beginner 53164af1b03aSJed Brown 5317cd652676SJed Brown Notes: 5318cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 53194af1b03aSJed Brown 53204af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 53214af1b03aSJed Brown 53224af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 53234af1b03aSJed Brown @*/ 53244af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 53254af1b03aSJed Brown { 53264af1b03aSJed Brown PetscFunctionBegin; 53274af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53284af1b03aSJed Brown PetscValidPointer(reason,2); 53294af1b03aSJed Brown *reason = ts->reason; 53304af1b03aSJed Brown PetscFunctionReturn(0); 53314af1b03aSJed Brown } 53324af1b03aSJed Brown 5333d6ad946cSShri Abhyankar /*@ 5334d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5335d6ad946cSShri Abhyankar 5336d6ad946cSShri Abhyankar Not Collective 5337d6ad946cSShri Abhyankar 5338d6ad946cSShri Abhyankar Input Parameter: 5339d6ad946cSShri Abhyankar + ts - the TS context 5340d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5341d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5342d6ad946cSShri Abhyankar 5343f5abba47SShri Abhyankar Level: advanced 5344d6ad946cSShri Abhyankar 5345d6ad946cSShri Abhyankar Notes: 5346d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 5347d6ad946cSShri Abhyankar 5348d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 5349d6ad946cSShri Abhyankar 5350d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5351d6ad946cSShri Abhyankar @*/ 5352d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5353d6ad946cSShri Abhyankar { 5354d6ad946cSShri Abhyankar PetscFunctionBegin; 5355d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5356d6ad946cSShri Abhyankar ts->reason = reason; 5357d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5358d6ad946cSShri Abhyankar } 5359d6ad946cSShri Abhyankar 5360cc708dedSBarry Smith /*@ 5361cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5362cc708dedSBarry Smith 5363cc708dedSBarry Smith Not Collective 5364cc708dedSBarry Smith 5365cc708dedSBarry Smith Input Parameter: 5366cc708dedSBarry Smith . ts - the TS context 5367cc708dedSBarry Smith 5368cc708dedSBarry Smith Output Parameter: 536963e21af5SBarry Smith . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5370cc708dedSBarry Smith 5371487e0bb9SJed Brown Level: beginner 5372cc708dedSBarry Smith 5373cc708dedSBarry Smith Notes: 5374cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5375cc708dedSBarry Smith 5376cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 5377cc708dedSBarry Smith 5378cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5379cc708dedSBarry Smith @*/ 5380cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5381cc708dedSBarry Smith { 5382cc708dedSBarry Smith PetscFunctionBegin; 5383cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5384cc708dedSBarry Smith PetscValidPointer(ftime,2); 5385cc708dedSBarry Smith *ftime = ts->solvetime; 5386cc708dedSBarry Smith PetscFunctionReturn(0); 5387cc708dedSBarry Smith } 5388cc708dedSBarry Smith 53892c18e0fdSBarry Smith /*@ 53902c18e0fdSBarry Smith TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 53912c18e0fdSBarry Smith 53922c18e0fdSBarry Smith Not Collective 53932c18e0fdSBarry Smith 53942c18e0fdSBarry Smith Input Parameter: 53952c18e0fdSBarry Smith . ts - the TS context 53962c18e0fdSBarry Smith 53972c18e0fdSBarry Smith Output Parameter: 53982c18e0fdSBarry Smith . steps - the number of steps 53992c18e0fdSBarry Smith 54002c18e0fdSBarry Smith Level: beginner 54012c18e0fdSBarry Smith 54022c18e0fdSBarry Smith Notes: 54032c18e0fdSBarry Smith Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 54042c18e0fdSBarry Smith 54052c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test 54062c18e0fdSBarry Smith 54072c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 54082c18e0fdSBarry Smith @*/ 54092c18e0fdSBarry Smith PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 54102c18e0fdSBarry Smith { 54112c18e0fdSBarry Smith PetscFunctionBegin; 54122c18e0fdSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54132c18e0fdSBarry Smith PetscValidPointer(steps,2); 54142c18e0fdSBarry Smith *steps = ts->total_steps; 54152c18e0fdSBarry Smith PetscFunctionReturn(0); 54162c18e0fdSBarry Smith } 54172c18e0fdSBarry Smith 54189f67acb7SJed Brown /*@ 54195ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 54209f67acb7SJed Brown used by the time integrator. 54219f67acb7SJed Brown 54229f67acb7SJed Brown Not Collective 54239f67acb7SJed Brown 54249f67acb7SJed Brown Input Parameter: 54259f67acb7SJed Brown . ts - TS context 54269f67acb7SJed Brown 54279f67acb7SJed Brown Output Parameter: 54289f67acb7SJed Brown . nits - number of nonlinear iterations 54299f67acb7SJed Brown 54309f67acb7SJed Brown Notes: 54319f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54329f67acb7SJed Brown 54339f67acb7SJed Brown Level: intermediate 54349f67acb7SJed Brown 54359f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 54369f67acb7SJed Brown 54375ef26d82SJed Brown .seealso: TSGetKSPIterations() 54389f67acb7SJed Brown @*/ 54395ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 54409f67acb7SJed Brown { 54419f67acb7SJed Brown PetscFunctionBegin; 54429f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54439f67acb7SJed Brown PetscValidIntPointer(nits,2); 54445ef26d82SJed Brown *nits = ts->snes_its; 54459f67acb7SJed Brown PetscFunctionReturn(0); 54469f67acb7SJed Brown } 54479f67acb7SJed Brown 54489f67acb7SJed Brown /*@ 54495ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 54509f67acb7SJed Brown used by the time integrator. 54519f67acb7SJed Brown 54529f67acb7SJed Brown Not Collective 54539f67acb7SJed Brown 54549f67acb7SJed Brown Input Parameter: 54559f67acb7SJed Brown . ts - TS context 54569f67acb7SJed Brown 54579f67acb7SJed Brown Output Parameter: 54589f67acb7SJed Brown . lits - number of linear iterations 54599f67acb7SJed Brown 54609f67acb7SJed Brown Notes: 54619f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54629f67acb7SJed Brown 54639f67acb7SJed Brown Level: intermediate 54649f67acb7SJed Brown 54659f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 54669f67acb7SJed Brown 54675ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 54689f67acb7SJed Brown @*/ 54695ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 54709f67acb7SJed Brown { 54719f67acb7SJed Brown PetscFunctionBegin; 54729f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54739f67acb7SJed Brown PetscValidIntPointer(lits,2); 54745ef26d82SJed Brown *lits = ts->ksp_its; 54759f67acb7SJed Brown PetscFunctionReturn(0); 54769f67acb7SJed Brown } 54779f67acb7SJed Brown 5478cef5090cSJed Brown /*@ 5479cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5480cef5090cSJed Brown 5481cef5090cSJed Brown Not Collective 5482cef5090cSJed Brown 5483cef5090cSJed Brown Input Parameter: 5484cef5090cSJed Brown . ts - TS context 5485cef5090cSJed Brown 5486cef5090cSJed Brown Output Parameter: 5487cef5090cSJed Brown . rejects - number of steps rejected 5488cef5090cSJed Brown 5489cef5090cSJed Brown Notes: 5490cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5491cef5090cSJed Brown 5492cef5090cSJed Brown Level: intermediate 5493cef5090cSJed Brown 5494cef5090cSJed Brown .keywords: TS, get, number 5495cef5090cSJed Brown 54965ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5497cef5090cSJed Brown @*/ 5498cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5499cef5090cSJed Brown { 5500cef5090cSJed Brown PetscFunctionBegin; 5501cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5502cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5503cef5090cSJed Brown *rejects = ts->reject; 5504cef5090cSJed Brown PetscFunctionReturn(0); 5505cef5090cSJed Brown } 5506cef5090cSJed Brown 5507cef5090cSJed Brown /*@ 5508cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5509cef5090cSJed Brown 5510cef5090cSJed Brown Not Collective 5511cef5090cSJed Brown 5512cef5090cSJed Brown Input Parameter: 5513cef5090cSJed Brown . ts - TS context 5514cef5090cSJed Brown 5515cef5090cSJed Brown Output Parameter: 5516cef5090cSJed Brown . fails - number of failed nonlinear solves 5517cef5090cSJed Brown 5518cef5090cSJed Brown Notes: 5519cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5520cef5090cSJed Brown 5521cef5090cSJed Brown Level: intermediate 5522cef5090cSJed Brown 5523cef5090cSJed Brown .keywords: TS, get, number 5524cef5090cSJed Brown 55255ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5526cef5090cSJed Brown @*/ 5527cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5528cef5090cSJed Brown { 5529cef5090cSJed Brown PetscFunctionBegin; 5530cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5531cef5090cSJed Brown PetscValidIntPointer(fails,2); 5532cef5090cSJed Brown *fails = ts->num_snes_failures; 5533cef5090cSJed Brown PetscFunctionReturn(0); 5534cef5090cSJed Brown } 5535cef5090cSJed Brown 5536cef5090cSJed Brown /*@ 5537cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5538cef5090cSJed Brown 5539cef5090cSJed Brown Not Collective 5540cef5090cSJed Brown 5541cef5090cSJed Brown Input Parameter: 5542cef5090cSJed Brown + ts - TS context 5543cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5544cef5090cSJed Brown 5545cef5090cSJed Brown Notes: 5546cef5090cSJed Brown The counter is reset to zero for each step 5547cef5090cSJed Brown 5548cef5090cSJed Brown Options Database Key: 5549cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5550cef5090cSJed Brown 5551cef5090cSJed Brown Level: intermediate 5552cef5090cSJed Brown 5553cef5090cSJed Brown .keywords: TS, set, maximum, number 5554cef5090cSJed Brown 55555ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5556cef5090cSJed Brown @*/ 5557cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5558cef5090cSJed Brown { 5559cef5090cSJed Brown PetscFunctionBegin; 5560cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5561cef5090cSJed Brown ts->max_reject = rejects; 5562cef5090cSJed Brown PetscFunctionReturn(0); 5563cef5090cSJed Brown } 5564cef5090cSJed Brown 5565cef5090cSJed Brown /*@ 5566cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5567cef5090cSJed Brown 5568cef5090cSJed Brown Not Collective 5569cef5090cSJed Brown 5570cef5090cSJed Brown Input Parameter: 5571cef5090cSJed Brown + ts - TS context 5572cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5573cef5090cSJed Brown 5574cef5090cSJed Brown Notes: 5575cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5576cef5090cSJed Brown 5577cef5090cSJed Brown Options Database Key: 5578cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5579cef5090cSJed Brown 5580cef5090cSJed Brown Level: intermediate 5581cef5090cSJed Brown 5582cef5090cSJed Brown .keywords: TS, set, maximum, number 5583cef5090cSJed Brown 55845ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5585cef5090cSJed Brown @*/ 5586cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5587cef5090cSJed Brown { 5588cef5090cSJed Brown PetscFunctionBegin; 5589cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5590cef5090cSJed Brown ts->max_snes_failures = fails; 5591cef5090cSJed Brown PetscFunctionReturn(0); 5592cef5090cSJed Brown } 5593cef5090cSJed Brown 5594cef5090cSJed Brown /*@ 5595cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5596cef5090cSJed Brown 5597cef5090cSJed Brown Not Collective 5598cef5090cSJed Brown 5599cef5090cSJed Brown Input Parameter: 5600cef5090cSJed Brown + ts - TS context 5601cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5602cef5090cSJed Brown 5603cef5090cSJed Brown Options Database Key: 5604cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5605cef5090cSJed Brown 5606cef5090cSJed Brown Level: intermediate 5607cef5090cSJed Brown 5608cef5090cSJed Brown .keywords: TS, set, error 5609cef5090cSJed Brown 56105ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5611cef5090cSJed Brown @*/ 5612cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5613cef5090cSJed Brown { 5614cef5090cSJed Brown PetscFunctionBegin; 5615cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5616cef5090cSJed Brown ts->errorifstepfailed = err; 5617cef5090cSJed Brown PetscFunctionReturn(0); 5618cef5090cSJed Brown } 5619cef5090cSJed Brown 5620fb1732b5SBarry Smith /*@C 5621fde5950dSBarry 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 5622fb1732b5SBarry Smith 5623fb1732b5SBarry Smith Collective on TS 5624fb1732b5SBarry Smith 5625fb1732b5SBarry Smith Input Parameters: 5626fb1732b5SBarry Smith + ts - the TS context 5627fb1732b5SBarry Smith . step - current time-step 5628fb1732b5SBarry Smith . ptime - current time 56290910c330SBarry Smith . u - current state 5630721cd6eeSBarry Smith - vf - viewer and its format 5631fb1732b5SBarry Smith 5632fb1732b5SBarry Smith Level: intermediate 5633fb1732b5SBarry Smith 5634fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5635fb1732b5SBarry Smith 5636fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5637fb1732b5SBarry Smith @*/ 5638721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5639fb1732b5SBarry Smith { 5640fb1732b5SBarry Smith PetscErrorCode ierr; 5641fb1732b5SBarry Smith 5642fb1732b5SBarry Smith PetscFunctionBegin; 5643721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5644721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5645721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5646ed81e22dSJed Brown PetscFunctionReturn(0); 5647ed81e22dSJed Brown } 5648ed81e22dSJed Brown 5649ed81e22dSJed Brown /*@C 5650ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5651ed81e22dSJed Brown 5652ed81e22dSJed Brown Collective on TS 5653ed81e22dSJed Brown 5654ed81e22dSJed Brown Input Parameters: 5655ed81e22dSJed Brown + ts - the TS context 5656ed81e22dSJed Brown . step - current time-step 5657ed81e22dSJed Brown . ptime - current time 56580910c330SBarry Smith . u - current state 5659ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5660ed81e22dSJed Brown 5661ed81e22dSJed Brown Level: intermediate 5662ed81e22dSJed Brown 5663ed81e22dSJed Brown Notes: 5664ed81e22dSJed 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. 5665ed81e22dSJed Brown These are named according to the file name template. 5666ed81e22dSJed Brown 5667ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5668ed81e22dSJed Brown 5669ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5670ed81e22dSJed Brown 5671ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5672ed81e22dSJed Brown @*/ 56730910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5674ed81e22dSJed Brown { 5675ed81e22dSJed Brown PetscErrorCode ierr; 5676ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5677ed81e22dSJed Brown PetscViewer viewer; 5678ed81e22dSJed Brown 5679ed81e22dSJed Brown PetscFunctionBegin; 568063e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 56818caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5682ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 56830910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5684ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5685ed81e22dSJed Brown PetscFunctionReturn(0); 5686ed81e22dSJed Brown } 5687ed81e22dSJed Brown 5688ed81e22dSJed Brown /*@C 5689ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5690ed81e22dSJed Brown 5691ed81e22dSJed Brown Collective on TS 5692ed81e22dSJed Brown 5693ed81e22dSJed Brown Input Parameters: 5694ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5695ed81e22dSJed Brown 5696ed81e22dSJed Brown Level: intermediate 5697ed81e22dSJed Brown 5698ed81e22dSJed Brown Note: 5699ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5700ed81e22dSJed Brown 5701ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5702ed81e22dSJed Brown 5703ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5704ed81e22dSJed Brown @*/ 5705ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5706ed81e22dSJed Brown { 5707ed81e22dSJed Brown PetscErrorCode ierr; 5708ed81e22dSJed Brown 5709ed81e22dSJed Brown PetscFunctionBegin; 5710ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5711fb1732b5SBarry Smith PetscFunctionReturn(0); 5712fb1732b5SBarry Smith } 5713fb1732b5SBarry Smith 571484df9cb4SJed Brown /*@ 5715552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 571684df9cb4SJed Brown 5717ed81e22dSJed Brown Collective on TS if controller has not been created yet 571884df9cb4SJed Brown 571984df9cb4SJed Brown Input Arguments: 5720ed81e22dSJed Brown . ts - time stepping context 572184df9cb4SJed Brown 572284df9cb4SJed Brown Output Arguments: 5723ed81e22dSJed Brown . adapt - adaptive controller 572484df9cb4SJed Brown 572584df9cb4SJed Brown Level: intermediate 572684df9cb4SJed Brown 5727ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 572884df9cb4SJed Brown @*/ 5729552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 573084df9cb4SJed Brown { 573184df9cb4SJed Brown PetscErrorCode ierr; 573284df9cb4SJed Brown 573384df9cb4SJed Brown PetscFunctionBegin; 573484df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5735bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 573684df9cb4SJed Brown if (!ts->adapt) { 5737ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 57383bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 57391c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 574084df9cb4SJed Brown } 5741bec58848SLisandro Dalcin *adapt = ts->adapt; 574284df9cb4SJed Brown PetscFunctionReturn(0); 574384df9cb4SJed Brown } 5744d6ebe24aSShri Abhyankar 57451c3436cfSJed Brown /*@ 57461c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 57471c3436cfSJed Brown 57481c3436cfSJed Brown Logically Collective 57491c3436cfSJed Brown 57501c3436cfSJed Brown Input Arguments: 57511c3436cfSJed Brown + ts - time integration context 57521c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 57530298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 57541c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 57550298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 57561c3436cfSJed Brown 5757a3cdaa26SBarry Smith Options Database keys: 5758a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5759a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5760a3cdaa26SBarry Smith 57613ff766beSShri Abhyankar Notes: 57623ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 57633ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 57643ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 57653ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 57663ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 57673ff766beSShri Abhyankar differential variables. 57683ff766beSShri Abhyankar 57691c3436cfSJed Brown Level: beginner 57701c3436cfSJed Brown 5771c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 57721c3436cfSJed Brown @*/ 57731c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 57741c3436cfSJed Brown { 57751c3436cfSJed Brown PetscErrorCode ierr; 57761c3436cfSJed Brown 57771c3436cfSJed Brown PetscFunctionBegin; 5778c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 57791c3436cfSJed Brown if (vatol) { 57801c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 57811c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 57821c3436cfSJed Brown ts->vatol = vatol; 57831c3436cfSJed Brown } 5784c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 57851c3436cfSJed Brown if (vrtol) { 57861c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 57871c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 57881c3436cfSJed Brown ts->vrtol = vrtol; 57891c3436cfSJed Brown } 57901c3436cfSJed Brown PetscFunctionReturn(0); 57911c3436cfSJed Brown } 57921c3436cfSJed Brown 5793c5033834SJed Brown /*@ 5794c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5795c5033834SJed Brown 5796c5033834SJed Brown Logically Collective 5797c5033834SJed Brown 5798c5033834SJed Brown Input Arguments: 5799c5033834SJed Brown . ts - time integration context 5800c5033834SJed Brown 5801c5033834SJed Brown Output Arguments: 58020298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 58030298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 58040298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 58050298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5806c5033834SJed Brown 5807c5033834SJed Brown Level: beginner 5808c5033834SJed Brown 5809c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5810c5033834SJed Brown @*/ 5811c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5812c5033834SJed Brown { 5813c5033834SJed Brown PetscFunctionBegin; 5814c5033834SJed Brown if (atol) *atol = ts->atol; 5815c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5816c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5817c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5818c5033834SJed Brown PetscFunctionReturn(0); 5819c5033834SJed Brown } 5820c5033834SJed Brown 58219c6b16b5SShri Abhyankar /*@ 5822a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 58239c6b16b5SShri Abhyankar 58249c6b16b5SShri Abhyankar Collective on TS 58259c6b16b5SShri Abhyankar 58269c6b16b5SShri Abhyankar Input Arguments: 58279c6b16b5SShri Abhyankar + ts - time stepping context 5828a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5829a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 58309c6b16b5SShri Abhyankar 58319c6b16b5SShri Abhyankar Output Arguments: 58327453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58337453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 58347453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58359c6b16b5SShri Abhyankar 58369c6b16b5SShri Abhyankar Level: developer 58379c6b16b5SShri Abhyankar 5838deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 58399c6b16b5SShri Abhyankar @*/ 58407453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58419c6b16b5SShri Abhyankar { 58429c6b16b5SShri Abhyankar PetscErrorCode ierr; 58439c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 58447453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 58457453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 58469c6b16b5SShri Abhyankar const PetscScalar *u,*y; 58477453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 58487453f775SEmil Constantinescu PetscReal tol,tola,tolr; 58497453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 58509c6b16b5SShri Abhyankar 58519c6b16b5SShri Abhyankar PetscFunctionBegin; 58529c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5853a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5854a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5855a4868fbcSLisandro Dalcin PetscValidType(U,2); 5856a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5857a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5858a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 58598a175baeSEmil Constantinescu PetscValidPointer(norma,5); 58608a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5861a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 58629c6b16b5SShri Abhyankar 58639c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 58649c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 58659c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 58669c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 58679c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 58687453f775SEmil Constantinescu sum = 0.; n_loc = 0; 58697453f775SEmil Constantinescu suma = 0.; na_loc = 0; 58707453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 58719c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 58729c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 58739c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58749c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58759c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58767453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58777453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 58787453f775SEmil Constantinescu if(tola>0.){ 58797453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58807453f775SEmil Constantinescu na_loc++; 58817453f775SEmil Constantinescu } 58827453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58837453f775SEmil Constantinescu if(tolr>0.){ 58847453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58857453f775SEmil Constantinescu nr_loc++; 58867453f775SEmil Constantinescu } 58877453f775SEmil Constantinescu tol=tola+tolr; 58887453f775SEmil Constantinescu if(tol>0.){ 58897453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58907453f775SEmil Constantinescu n_loc++; 58917453f775SEmil Constantinescu } 58929c6b16b5SShri Abhyankar } 58939c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58949c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58959c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 58969c6b16b5SShri Abhyankar const PetscScalar *atol; 58979c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58989c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58997453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59007453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 59017453f775SEmil Constantinescu if(tola>0.){ 59027453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59037453f775SEmil Constantinescu na_loc++; 59047453f775SEmil Constantinescu } 59057453f775SEmil Constantinescu tolr = ts->rtol * 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->vatol,&atol);CHKERRQ(ierr); 59179c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 59189c6b16b5SShri Abhyankar const PetscScalar *rtol; 59199c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59209c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59217453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59227453f775SEmil Constantinescu tola = ts->atol; 59237453f775SEmil Constantinescu if(tola>0.){ 59247453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59257453f775SEmil Constantinescu na_loc++; 59267453f775SEmil Constantinescu } 59277453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59287453f775SEmil Constantinescu if(tolr>0.){ 59297453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59307453f775SEmil Constantinescu nr_loc++; 59317453f775SEmil Constantinescu } 59327453f775SEmil Constantinescu tol=tola+tolr; 59337453f775SEmil Constantinescu if(tol>0.){ 59347453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59357453f775SEmil Constantinescu n_loc++; 59367453f775SEmil Constantinescu } 59379c6b16b5SShri Abhyankar } 59389c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59399c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 59409c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59417453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59427453f775SEmil Constantinescu tola = ts->atol; 59437453f775SEmil Constantinescu if(tola>0.){ 59447453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59457453f775SEmil Constantinescu na_loc++; 59467453f775SEmil Constantinescu } 59477453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59487453f775SEmil Constantinescu if(tolr>0.){ 59497453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59507453f775SEmil Constantinescu nr_loc++; 59517453f775SEmil Constantinescu } 59527453f775SEmil Constantinescu tol=tola+tolr; 59537453f775SEmil Constantinescu if(tol>0.){ 59547453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59557453f775SEmil Constantinescu n_loc++; 59567453f775SEmil Constantinescu } 59579c6b16b5SShri Abhyankar } 59589c6b16b5SShri Abhyankar } 59599c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 59609c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 59619c6b16b5SShri Abhyankar 59627453f775SEmil Constantinescu err_loc[0] = sum; 59637453f775SEmil Constantinescu err_loc[1] = suma; 59647453f775SEmil Constantinescu err_loc[2] = sumr; 59657453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 59667453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 59677453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 59687453f775SEmil Constantinescu 5969a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 59707453f775SEmil Constantinescu 59717453f775SEmil Constantinescu gsum = err_glb[0]; 59727453f775SEmil Constantinescu gsuma = err_glb[1]; 59737453f775SEmil Constantinescu gsumr = err_glb[2]; 59747453f775SEmil Constantinescu n_glb = err_glb[3]; 59757453f775SEmil Constantinescu na_glb = err_glb[4]; 59767453f775SEmil Constantinescu nr_glb = err_glb[5]; 59777453f775SEmil Constantinescu 5978b1316ef9SEmil Constantinescu *norm = 0.; 5979b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 5980b1316ef9SEmil Constantinescu *norma = 0.; 5981b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5982b1316ef9SEmil Constantinescu *normr = 0.; 5983b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 59849c6b16b5SShri Abhyankar 59859c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 59867453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 59877453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 59889c6b16b5SShri Abhyankar PetscFunctionReturn(0); 59899c6b16b5SShri Abhyankar } 59909c6b16b5SShri Abhyankar 59919c6b16b5SShri Abhyankar /*@ 5992a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 59939c6b16b5SShri Abhyankar 59949c6b16b5SShri Abhyankar Collective on TS 59959c6b16b5SShri Abhyankar 59969c6b16b5SShri Abhyankar Input Arguments: 59979c6b16b5SShri Abhyankar + ts - time stepping context 5998a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5999a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 60009c6b16b5SShri Abhyankar 60019c6b16b5SShri Abhyankar Output Arguments: 60027453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 60037453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 60047453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 60059c6b16b5SShri Abhyankar 60069c6b16b5SShri Abhyankar Level: developer 60079c6b16b5SShri Abhyankar 6008deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 60099c6b16b5SShri Abhyankar @*/ 60107453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60119c6b16b5SShri Abhyankar { 60129c6b16b5SShri Abhyankar PetscErrorCode ierr; 60137453f775SEmil Constantinescu PetscInt i,n,N,rstart; 60149c6b16b5SShri Abhyankar const PetscScalar *u,*y; 60157453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 60167453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 60177453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 60189c6b16b5SShri Abhyankar 60199c6b16b5SShri Abhyankar PetscFunctionBegin; 60209c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6021a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 6022a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 6023a4868fbcSLisandro Dalcin PetscValidType(U,2); 6024a4868fbcSLisandro Dalcin PetscValidType(Y,3); 6025a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 6026a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 60278a175baeSEmil Constantinescu PetscValidPointer(norma,5); 60288a175baeSEmil Constantinescu PetscValidPointer(normr,6); 6029a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 60309c6b16b5SShri Abhyankar 60319c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 60329c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 60339c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 60349c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 60359c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 60367453f775SEmil Constantinescu 60377453f775SEmil Constantinescu max=0.; 60387453f775SEmil Constantinescu maxa=0.; 60397453f775SEmil Constantinescu maxr=0.; 60407453f775SEmil Constantinescu 60417453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 60429c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 60439c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60449c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60457453f775SEmil Constantinescu 60467453f775SEmil Constantinescu for (i=0; i<n; i++) { 60477453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60487453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60497453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60507453f775SEmil Constantinescu tol = tola+tolr; 60517453f775SEmil Constantinescu if(tola>0.){ 60527453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60537453f775SEmil Constantinescu } 60547453f775SEmil Constantinescu if(tolr>0.){ 60557453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60567453f775SEmil Constantinescu } 60577453f775SEmil Constantinescu if(tol>0.){ 60587453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60597453f775SEmil Constantinescu } 60609c6b16b5SShri Abhyankar } 60619c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60629c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60639c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 60649c6b16b5SShri Abhyankar const PetscScalar *atol; 60659c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60667453f775SEmil Constantinescu for (i=0; i<n; i++) { 60677453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60687453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60697453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60707453f775SEmil Constantinescu tol = tola+tolr; 60717453f775SEmil Constantinescu if(tola>0.){ 60727453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60737453f775SEmil Constantinescu } 60747453f775SEmil Constantinescu if(tolr>0.){ 60757453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60767453f775SEmil Constantinescu } 60777453f775SEmil Constantinescu if(tol>0.){ 60787453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60797453f775SEmil Constantinescu } 60809c6b16b5SShri Abhyankar } 60819c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60829c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 60839c6b16b5SShri Abhyankar const PetscScalar *rtol; 60849c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60857453f775SEmil Constantinescu 60867453f775SEmil Constantinescu for (i=0; i<n; i++) { 60877453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60887453f775SEmil Constantinescu tola = ts->atol; 60897453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60907453f775SEmil Constantinescu tol = tola+tolr; 60917453f775SEmil Constantinescu if(tola>0.){ 60927453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60937453f775SEmil Constantinescu } 60947453f775SEmil Constantinescu if(tolr>0.){ 60957453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60967453f775SEmil Constantinescu } 60977453f775SEmil Constantinescu if(tol>0.){ 60987453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60997453f775SEmil Constantinescu } 61009c6b16b5SShri Abhyankar } 61019c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61029c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 61037453f775SEmil Constantinescu 61047453f775SEmil Constantinescu for (i=0; i<n; i++) { 61057453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 61067453f775SEmil Constantinescu tola = ts->atol; 61077453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61087453f775SEmil Constantinescu tol = tola+tolr; 61097453f775SEmil Constantinescu if(tola>0.){ 61107453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 61117453f775SEmil Constantinescu } 61127453f775SEmil Constantinescu if(tolr>0.){ 61137453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 61147453f775SEmil Constantinescu } 61157453f775SEmil Constantinescu if(tol>0.){ 61167453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 61177453f775SEmil Constantinescu } 61189c6b16b5SShri Abhyankar } 61199c6b16b5SShri Abhyankar } 61209c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 61219c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 61227453f775SEmil Constantinescu err_loc[0] = max; 61237453f775SEmil Constantinescu err_loc[1] = maxa; 61247453f775SEmil Constantinescu err_loc[2] = maxr; 6125a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 61267453f775SEmil Constantinescu gmax = err_glb[0]; 61277453f775SEmil Constantinescu gmaxa = err_glb[1]; 61287453f775SEmil Constantinescu gmaxr = err_glb[2]; 61299c6b16b5SShri Abhyankar 61309c6b16b5SShri Abhyankar *norm = gmax; 61317453f775SEmil Constantinescu *norma = gmaxa; 61327453f775SEmil Constantinescu *normr = gmaxr; 61339c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 61347453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 61357453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 61369c6b16b5SShri Abhyankar PetscFunctionReturn(0); 61379c6b16b5SShri Abhyankar } 61389c6b16b5SShri Abhyankar 61391c3436cfSJed Brown /*@ 61408a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 61411c3436cfSJed Brown 61421c3436cfSJed Brown Collective on TS 61431c3436cfSJed Brown 61441c3436cfSJed Brown Input Arguments: 61451c3436cfSJed Brown + ts - time stepping context 6146a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6147a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 6148a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 61497619abb3SShri 61501c3436cfSJed Brown Output Arguments: 61518a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 61528a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 61538a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 6154a4868fbcSLisandro Dalcin 6155a4868fbcSLisandro Dalcin Options Database Keys: 6156a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6157a4868fbcSLisandro Dalcin 61581c3436cfSJed Brown Level: developer 61591c3436cfSJed Brown 61608a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 61611c3436cfSJed Brown @*/ 61627453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61631c3436cfSJed Brown { 61648beabaa1SBarry Smith PetscErrorCode ierr; 61651c3436cfSJed Brown 61661c3436cfSJed Brown PetscFunctionBegin; 6167a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 61687453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6169a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 61707453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6171a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 61721c3436cfSJed Brown PetscFunctionReturn(0); 61731c3436cfSJed Brown } 61741c3436cfSJed Brown 61758a175baeSEmil Constantinescu 61768a175baeSEmil Constantinescu /*@ 61778a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 61788a175baeSEmil Constantinescu 61798a175baeSEmil Constantinescu Collective on TS 61808a175baeSEmil Constantinescu 61818a175baeSEmil Constantinescu Input Arguments: 61828a175baeSEmil Constantinescu + ts - time stepping context 61838a175baeSEmil Constantinescu . E - error vector 61848a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 61858a175baeSEmil Constantinescu - Y - state vector, previous time step 61868a175baeSEmil Constantinescu 61878a175baeSEmil Constantinescu Output Arguments: 61888a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 61898a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 61908a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 61918a175baeSEmil Constantinescu 61928a175baeSEmil Constantinescu Level: developer 61938a175baeSEmil Constantinescu 61948a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 61958a175baeSEmil Constantinescu @*/ 61968a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61978a175baeSEmil Constantinescu { 61988a175baeSEmil Constantinescu PetscErrorCode ierr; 61998a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 62008a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 62018a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 62028a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 62038a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 62048a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 62058a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 62068a175baeSEmil Constantinescu 62078a175baeSEmil Constantinescu PetscFunctionBegin; 62088a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62098a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 62108a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 62118a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 62128a175baeSEmil Constantinescu PetscValidType(E,2); 62138a175baeSEmil Constantinescu PetscValidType(U,3); 62148a175baeSEmil Constantinescu PetscValidType(Y,4); 62158a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 62168a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 62178a175baeSEmil Constantinescu PetscValidPointer(norm,5); 62188a175baeSEmil Constantinescu PetscValidPointer(norma,6); 62198a175baeSEmil Constantinescu PetscValidPointer(normr,7); 62208a175baeSEmil Constantinescu 62218a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 62228a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 62238a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 62248a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 62258a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 62268a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 62278a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 62288a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 62298a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 62308a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 62318a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 62328a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62338a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62348a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62358a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62368a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62378a175baeSEmil Constantinescu if(tola>0.){ 62388a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62398a175baeSEmil Constantinescu na_loc++; 62408a175baeSEmil Constantinescu } 62418a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62428a175baeSEmil Constantinescu if(tolr>0.){ 62438a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62448a175baeSEmil Constantinescu nr_loc++; 62458a175baeSEmil Constantinescu } 62468a175baeSEmil Constantinescu tol=tola+tolr; 62478a175baeSEmil Constantinescu if(tol>0.){ 62488a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62498a175baeSEmil Constantinescu n_loc++; 62508a175baeSEmil Constantinescu } 62518a175baeSEmil Constantinescu } 62528a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62538a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62548a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 62558a175baeSEmil Constantinescu const PetscScalar *atol; 62568a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62578a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62588a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62598a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62608a175baeSEmil Constantinescu if(tola>0.){ 62618a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62628a175baeSEmil Constantinescu na_loc++; 62638a175baeSEmil Constantinescu } 62648a175baeSEmil Constantinescu tolr = ts->rtol * 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->vatol,&atol);CHKERRQ(ierr); 62768a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 62778a175baeSEmil Constantinescu const PetscScalar *rtol; 62788a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62798a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62808a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62818a175baeSEmil Constantinescu tola = ts->atol; 62828a175baeSEmil Constantinescu if(tola>0.){ 62838a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62848a175baeSEmil Constantinescu na_loc++; 62858a175baeSEmil Constantinescu } 62868a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62878a175baeSEmil Constantinescu if(tolr>0.){ 62888a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62898a175baeSEmil Constantinescu nr_loc++; 62908a175baeSEmil Constantinescu } 62918a175baeSEmil Constantinescu tol=tola+tolr; 62928a175baeSEmil Constantinescu if(tol>0.){ 62938a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62948a175baeSEmil Constantinescu n_loc++; 62958a175baeSEmil Constantinescu } 62968a175baeSEmil Constantinescu } 62978a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62988a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 62998a175baeSEmil Constantinescu for (i=0; i<n; i++) { 63008a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63018a175baeSEmil Constantinescu tola = ts->atol; 63028a175baeSEmil Constantinescu if(tola>0.){ 63038a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 63048a175baeSEmil Constantinescu na_loc++; 63058a175baeSEmil Constantinescu } 63068a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63078a175baeSEmil Constantinescu if(tolr>0.){ 63088a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 63098a175baeSEmil Constantinescu nr_loc++; 63108a175baeSEmil Constantinescu } 63118a175baeSEmil Constantinescu tol=tola+tolr; 63128a175baeSEmil Constantinescu if(tol>0.){ 63138a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 63148a175baeSEmil Constantinescu n_loc++; 63158a175baeSEmil Constantinescu } 63168a175baeSEmil Constantinescu } 63178a175baeSEmil Constantinescu } 63188a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 63198a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 63208a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 63218a175baeSEmil Constantinescu 63228a175baeSEmil Constantinescu err_loc[0] = sum; 63238a175baeSEmil Constantinescu err_loc[1] = suma; 63248a175baeSEmil Constantinescu err_loc[2] = sumr; 63258a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 63268a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 63278a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 63288a175baeSEmil Constantinescu 6329a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 63308a175baeSEmil Constantinescu 63318a175baeSEmil Constantinescu gsum = err_glb[0]; 63328a175baeSEmil Constantinescu gsuma = err_glb[1]; 63338a175baeSEmil Constantinescu gsumr = err_glb[2]; 63348a175baeSEmil Constantinescu n_glb = err_glb[3]; 63358a175baeSEmil Constantinescu na_glb = err_glb[4]; 63368a175baeSEmil Constantinescu nr_glb = err_glb[5]; 63378a175baeSEmil Constantinescu 63388a175baeSEmil Constantinescu *norm = 0.; 63398a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 63408a175baeSEmil Constantinescu *norma = 0.; 63418a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 63428a175baeSEmil Constantinescu *normr = 0.; 63438a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 63448a175baeSEmil Constantinescu 63458a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 63468a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 63478a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 63488a175baeSEmil Constantinescu PetscFunctionReturn(0); 63498a175baeSEmil Constantinescu } 63508a175baeSEmil Constantinescu 63518a175baeSEmil Constantinescu /*@ 63528a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 63538a175baeSEmil Constantinescu Collective on TS 63548a175baeSEmil Constantinescu 63558a175baeSEmil Constantinescu Input Arguments: 63568a175baeSEmil Constantinescu + ts - time stepping context 63578a175baeSEmil Constantinescu . E - error vector 63588a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 63598a175baeSEmil Constantinescu - Y - state vector, previous time step 63608a175baeSEmil Constantinescu 63618a175baeSEmil Constantinescu Output Arguments: 63628a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 63638a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 63648a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 63658a175baeSEmil Constantinescu 63668a175baeSEmil Constantinescu Level: developer 63678a175baeSEmil Constantinescu 63688a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 63698a175baeSEmil Constantinescu @*/ 63708a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 63718a175baeSEmil Constantinescu { 63728a175baeSEmil Constantinescu PetscErrorCode ierr; 63738a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 63748a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 63758a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 63768a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 63778a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 63788a175baeSEmil Constantinescu 63798a175baeSEmil Constantinescu PetscFunctionBegin; 63808a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 63818a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 63828a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 63838a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 63848a175baeSEmil Constantinescu PetscValidType(E,2); 63858a175baeSEmil Constantinescu PetscValidType(U,3); 63868a175baeSEmil Constantinescu PetscValidType(Y,4); 63878a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 63888a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 63898a175baeSEmil Constantinescu PetscValidPointer(norm,5); 63908a175baeSEmil Constantinescu PetscValidPointer(norma,6); 63918a175baeSEmil Constantinescu PetscValidPointer(normr,7); 63928a175baeSEmil Constantinescu 63938a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 63948a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 63958a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 63968a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 63978a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 63988a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 63998a175baeSEmil Constantinescu 64008a175baeSEmil Constantinescu max=0.; 64018a175baeSEmil Constantinescu maxa=0.; 64028a175baeSEmil Constantinescu maxr=0.; 64038a175baeSEmil Constantinescu 64048a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 64058a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 64068a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64078a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64088a175baeSEmil Constantinescu 64098a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64108a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64118a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64128a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64138a175baeSEmil Constantinescu tol = tola+tolr; 64148a175baeSEmil Constantinescu if(tola>0.){ 64158a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64168a175baeSEmil Constantinescu } 64178a175baeSEmil Constantinescu if(tolr>0.){ 64188a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64198a175baeSEmil Constantinescu } 64208a175baeSEmil Constantinescu if(tol>0.){ 64218a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64228a175baeSEmil Constantinescu } 64238a175baeSEmil Constantinescu } 64248a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64258a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64268a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 64278a175baeSEmil Constantinescu const PetscScalar *atol; 64288a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64298a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64308a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64318a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64328a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64338a175baeSEmil Constantinescu tol = tola+tolr; 64348a175baeSEmil Constantinescu if(tola>0.){ 64358a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64368a175baeSEmil Constantinescu } 64378a175baeSEmil Constantinescu if(tolr>0.){ 64388a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64398a175baeSEmil Constantinescu } 64408a175baeSEmil Constantinescu if(tol>0.){ 64418a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64428a175baeSEmil Constantinescu } 64438a175baeSEmil Constantinescu } 64448a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64458a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 64468a175baeSEmil Constantinescu const PetscScalar *rtol; 64478a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64488a175baeSEmil Constantinescu 64498a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64508a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64518a175baeSEmil Constantinescu tola = ts->atol; 64528a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64538a175baeSEmil Constantinescu tol = tola+tolr; 64548a175baeSEmil Constantinescu if(tola>0.){ 64558a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64568a175baeSEmil Constantinescu } 64578a175baeSEmil Constantinescu if(tolr>0.){ 64588a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64598a175baeSEmil Constantinescu } 64608a175baeSEmil Constantinescu if(tol>0.){ 64618a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64628a175baeSEmil Constantinescu } 64638a175baeSEmil Constantinescu } 64648a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64658a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 64668a175baeSEmil Constantinescu 64678a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64688a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64698a175baeSEmil Constantinescu tola = ts->atol; 64708a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64718a175baeSEmil Constantinescu tol = tola+tolr; 64728a175baeSEmil Constantinescu if(tola>0.){ 64738a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64748a175baeSEmil Constantinescu } 64758a175baeSEmil Constantinescu if(tolr>0.){ 64768a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64778a175baeSEmil Constantinescu } 64788a175baeSEmil Constantinescu if(tol>0.){ 64798a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64808a175baeSEmil Constantinescu } 64818a175baeSEmil Constantinescu } 64828a175baeSEmil Constantinescu } 64838a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 64848a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 64858a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 64868a175baeSEmil Constantinescu err_loc[0] = max; 64878a175baeSEmil Constantinescu err_loc[1] = maxa; 64888a175baeSEmil Constantinescu err_loc[2] = maxr; 6489a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 64908a175baeSEmil Constantinescu gmax = err_glb[0]; 64918a175baeSEmil Constantinescu gmaxa = err_glb[1]; 64928a175baeSEmil Constantinescu gmaxr = err_glb[2]; 64938a175baeSEmil Constantinescu 64948a175baeSEmil Constantinescu *norm = gmax; 64958a175baeSEmil Constantinescu *norma = gmaxa; 64968a175baeSEmil Constantinescu *normr = gmaxr; 64978a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 64988a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 64998a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 65008a175baeSEmil Constantinescu PetscFunctionReturn(0); 65018a175baeSEmil Constantinescu } 65028a175baeSEmil Constantinescu 65038a175baeSEmil Constantinescu /*@ 65048a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 65058a175baeSEmil Constantinescu 65068a175baeSEmil Constantinescu Collective on TS 65078a175baeSEmil Constantinescu 65088a175baeSEmil Constantinescu Input Arguments: 65098a175baeSEmil Constantinescu + ts - time stepping context 65108a175baeSEmil Constantinescu . E - error vector 65118a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 65128a175baeSEmil Constantinescu . Y - state vector, previous time step 65138a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 65148a175baeSEmil Constantinescu 65158a175baeSEmil Constantinescu Output Arguments: 65168a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 65178a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 65188a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 65198a175baeSEmil Constantinescu 65208a175baeSEmil Constantinescu Options Database Keys: 65218a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 65228a175baeSEmil Constantinescu 65238a175baeSEmil Constantinescu Level: developer 65248a175baeSEmil Constantinescu 65258a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 65268a175baeSEmil Constantinescu @*/ 65278a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 65288a175baeSEmil Constantinescu { 65298a175baeSEmil Constantinescu PetscErrorCode ierr; 65308a175baeSEmil Constantinescu 65318a175baeSEmil Constantinescu PetscFunctionBegin; 65328a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 65338a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65348a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 65358a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65368a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 65378a175baeSEmil Constantinescu PetscFunctionReturn(0); 65388a175baeSEmil Constantinescu } 65398a175baeSEmil Constantinescu 65408a175baeSEmil Constantinescu 65418d59e960SJed Brown /*@ 65428d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 65438d59e960SJed Brown 65448d59e960SJed Brown Logically Collective on TS 65458d59e960SJed Brown 65468d59e960SJed Brown Input Arguments: 65478d59e960SJed Brown + ts - time stepping context 65488d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 65498d59e960SJed Brown 65508d59e960SJed Brown Note: 65518d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 65528d59e960SJed Brown 65538d59e960SJed Brown Level: intermediate 65548d59e960SJed Brown 65558d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 65568d59e960SJed Brown @*/ 65578d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 65588d59e960SJed Brown { 65598d59e960SJed Brown PetscFunctionBegin; 65608d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 65618d59e960SJed Brown ts->cfltime_local = cfltime; 65628d59e960SJed Brown ts->cfltime = -1.; 65638d59e960SJed Brown PetscFunctionReturn(0); 65648d59e960SJed Brown } 65658d59e960SJed Brown 65668d59e960SJed Brown /*@ 65678d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 65688d59e960SJed Brown 65698d59e960SJed Brown Collective on TS 65708d59e960SJed Brown 65718d59e960SJed Brown Input Arguments: 65728d59e960SJed Brown . ts - time stepping context 65738d59e960SJed Brown 65748d59e960SJed Brown Output Arguments: 65758d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 65768d59e960SJed Brown 65778d59e960SJed Brown Level: advanced 65788d59e960SJed Brown 65798d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 65808d59e960SJed Brown @*/ 65818d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 65828d59e960SJed Brown { 65838d59e960SJed Brown PetscErrorCode ierr; 65848d59e960SJed Brown 65858d59e960SJed Brown PetscFunctionBegin; 65868d59e960SJed Brown if (ts->cfltime < 0) { 6587b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 65888d59e960SJed Brown } 65898d59e960SJed Brown *cfltime = ts->cfltime; 65908d59e960SJed Brown PetscFunctionReturn(0); 65918d59e960SJed Brown } 65928d59e960SJed Brown 6593d6ebe24aSShri Abhyankar /*@ 6594d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6595d6ebe24aSShri Abhyankar 6596d6ebe24aSShri Abhyankar Input Parameters: 6597d6ebe24aSShri Abhyankar . ts - the TS context. 6598d6ebe24aSShri Abhyankar . xl - lower bound. 6599d6ebe24aSShri Abhyankar . xu - upper bound. 6600d6ebe24aSShri Abhyankar 6601d6ebe24aSShri Abhyankar Notes: 6602d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6603e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6604d6ebe24aSShri Abhyankar 66052bd2b0e6SSatish Balay Level: advanced 66062bd2b0e6SSatish Balay 6607d6ebe24aSShri Abhyankar @*/ 6608d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6609d6ebe24aSShri Abhyankar { 6610d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6611d6ebe24aSShri Abhyankar SNES snes; 6612d6ebe24aSShri Abhyankar 6613d6ebe24aSShri Abhyankar PetscFunctionBegin; 6614d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6615d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6616d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6617d6ebe24aSShri Abhyankar } 6618d6ebe24aSShri Abhyankar 6619325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6620c6db04a5SJed Brown #include <mex.h> 6621325fc9f4SBarry Smith 6622325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6623325fc9f4SBarry Smith 6624325fc9f4SBarry Smith /* 6625325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6626325fc9f4SBarry Smith TSSetFunctionMatlab(). 6627325fc9f4SBarry Smith 6628325fc9f4SBarry Smith Collective on TS 6629325fc9f4SBarry Smith 6630325fc9f4SBarry Smith Input Parameters: 6631325fc9f4SBarry Smith + snes - the TS context 66320910c330SBarry Smith - u - input vector 6633325fc9f4SBarry Smith 6634325fc9f4SBarry Smith Output Parameter: 6635325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6636325fc9f4SBarry Smith 6637325fc9f4SBarry Smith Notes: 6638325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6639325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6640325fc9f4SBarry Smith themselves. 6641325fc9f4SBarry Smith 6642325fc9f4SBarry Smith Level: developer 6643325fc9f4SBarry Smith 6644325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6645325fc9f4SBarry Smith 6646325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6647325fc9f4SBarry Smith */ 66480910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6649325fc9f4SBarry Smith { 6650325fc9f4SBarry Smith PetscErrorCode ierr; 6651325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6652325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6653325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6654325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6655325fc9f4SBarry Smith 6656325fc9f4SBarry Smith PetscFunctionBegin; 6657325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 66580910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 66590910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6660325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 66610910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6662325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6663325fc9f4SBarry Smith 6664325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 66650910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 66660910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 66670910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6668bbd56ea5SKarl Rupp 6669325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6670325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6671325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6672325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6673325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6674325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6675325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6676325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6677325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6678325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6679325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6680325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6681325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6682325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6683325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6684325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6685325fc9f4SBarry Smith PetscFunctionReturn(0); 6686325fc9f4SBarry Smith } 6687325fc9f4SBarry Smith 6688325fc9f4SBarry Smith 6689325fc9f4SBarry Smith /* 6690325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6691325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6692e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6693325fc9f4SBarry Smith 6694325fc9f4SBarry Smith Logically Collective on TS 6695325fc9f4SBarry Smith 6696325fc9f4SBarry Smith Input Parameters: 6697325fc9f4SBarry Smith + ts - the TS context 6698325fc9f4SBarry Smith - func - function evaluation routine 6699325fc9f4SBarry Smith 6700325fc9f4SBarry Smith Calling sequence of func: 67010910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6702325fc9f4SBarry Smith 6703325fc9f4SBarry Smith Level: beginner 6704325fc9f4SBarry Smith 6705325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6706325fc9f4SBarry Smith 6707325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6708325fc9f4SBarry Smith */ 6709cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6710325fc9f4SBarry Smith { 6711325fc9f4SBarry Smith PetscErrorCode ierr; 6712325fc9f4SBarry Smith TSMatlabContext *sctx; 6713325fc9f4SBarry Smith 6714325fc9f4SBarry Smith PetscFunctionBegin; 6715325fc9f4SBarry Smith /* currently sctx is memory bleed */ 671695dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6717325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6718325fc9f4SBarry Smith /* 6719325fc9f4SBarry Smith This should work, but it doesn't 6720325fc9f4SBarry Smith sctx->ctx = ctx; 6721325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6722325fc9f4SBarry Smith */ 6723325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6724bbd56ea5SKarl Rupp 67250298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6726325fc9f4SBarry Smith PetscFunctionReturn(0); 6727325fc9f4SBarry Smith } 6728325fc9f4SBarry Smith 6729325fc9f4SBarry Smith /* 6730325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6731325fc9f4SBarry Smith TSSetJacobianMatlab(). 6732325fc9f4SBarry Smith 6733325fc9f4SBarry Smith Collective on TS 6734325fc9f4SBarry Smith 6735325fc9f4SBarry Smith Input Parameters: 6736cdcf91faSSean Farley + ts - the TS context 67370910c330SBarry Smith . u - input vector 6738325fc9f4SBarry Smith . A, B - the matrices 6739325fc9f4SBarry Smith - ctx - user context 6740325fc9f4SBarry Smith 6741325fc9f4SBarry Smith Level: developer 6742325fc9f4SBarry Smith 6743325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6744325fc9f4SBarry Smith 6745325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6746325fc9f4SBarry Smith @*/ 6747f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6748325fc9f4SBarry Smith { 6749325fc9f4SBarry Smith PetscErrorCode ierr; 6750325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6751325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6752325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6753325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6754325fc9f4SBarry Smith 6755325fc9f4SBarry Smith PetscFunctionBegin; 6756cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 67570910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6758325fc9f4SBarry Smith 67590910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6760325fc9f4SBarry Smith 6761cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 67620910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 67630910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 67640910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 67650910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6766bbd56ea5SKarl Rupp 6767325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6768325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6769325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6770325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6771325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6772325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6773325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6774325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6775325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6776325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6777325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6778325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6779325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6780325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6781325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6782325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6783325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6784325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6785325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6786325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6787325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6788325fc9f4SBarry Smith PetscFunctionReturn(0); 6789325fc9f4SBarry Smith } 6790325fc9f4SBarry Smith 6791325fc9f4SBarry Smith 6792325fc9f4SBarry Smith /* 6793325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6794e3c5b3baSBarry 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 6795325fc9f4SBarry Smith 6796325fc9f4SBarry Smith Logically Collective on TS 6797325fc9f4SBarry Smith 6798325fc9f4SBarry Smith Input Parameters: 6799cdcf91faSSean Farley + ts - the TS context 6800325fc9f4SBarry Smith . A,B - Jacobian matrices 6801325fc9f4SBarry Smith . func - function evaluation routine 6802325fc9f4SBarry Smith - ctx - user context 6803325fc9f4SBarry Smith 6804325fc9f4SBarry Smith Calling sequence of func: 68050910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6806325fc9f4SBarry Smith 6807325fc9f4SBarry Smith 6808325fc9f4SBarry Smith Level: developer 6809325fc9f4SBarry Smith 6810325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6811325fc9f4SBarry Smith 6812325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6813325fc9f4SBarry Smith */ 6814cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6815325fc9f4SBarry Smith { 6816325fc9f4SBarry Smith PetscErrorCode ierr; 6817325fc9f4SBarry Smith TSMatlabContext *sctx; 6818325fc9f4SBarry Smith 6819325fc9f4SBarry Smith PetscFunctionBegin; 6820325fc9f4SBarry Smith /* currently sctx is memory bleed */ 682195dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6822325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6823325fc9f4SBarry Smith /* 6824325fc9f4SBarry Smith This should work, but it doesn't 6825325fc9f4SBarry Smith sctx->ctx = ctx; 6826325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6827325fc9f4SBarry Smith */ 6828325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6829bbd56ea5SKarl Rupp 6830cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6831325fc9f4SBarry Smith PetscFunctionReturn(0); 6832325fc9f4SBarry Smith } 6833325fc9f4SBarry Smith 6834b5b1a830SBarry Smith /* 6835b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6836b5b1a830SBarry Smith 6837b5b1a830SBarry Smith Collective on TS 6838b5b1a830SBarry Smith 6839b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6840b5b1a830SBarry Smith @*/ 68410910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6842b5b1a830SBarry Smith { 6843b5b1a830SBarry Smith PetscErrorCode ierr; 6844b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6845a530c242SBarry Smith int nlhs = 1,nrhs = 6; 6846b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 6847b5b1a830SBarry Smith long long int lx = 0,ls = 0; 6848b5b1a830SBarry Smith 6849b5b1a830SBarry Smith PetscFunctionBegin; 6850cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 68510910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6852b5b1a830SBarry Smith 6853cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 68540910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6855bbd56ea5SKarl Rupp 6856b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6857b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 6858b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 6859b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 6860b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 6861b5b1a830SBarry Smith prhs[5] = sctx->ctx; 6862b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6863b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6864b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 6865b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 6866b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 6867b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 6868b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 6869b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 6870b5b1a830SBarry Smith PetscFunctionReturn(0); 6871b5b1a830SBarry Smith } 6872b5b1a830SBarry Smith 6873b5b1a830SBarry Smith 6874b5b1a830SBarry Smith /* 6875b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 6876b5b1a830SBarry Smith 6877b5b1a830SBarry Smith Level: developer 6878b5b1a830SBarry Smith 6879b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 6880b5b1a830SBarry Smith 6881b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6882b5b1a830SBarry Smith */ 6883cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6884b5b1a830SBarry Smith { 6885b5b1a830SBarry Smith PetscErrorCode ierr; 6886b5b1a830SBarry Smith TSMatlabContext *sctx; 6887b5b1a830SBarry Smith 6888b5b1a830SBarry Smith PetscFunctionBegin; 6889b5b1a830SBarry Smith /* currently sctx is memory bleed */ 689095dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6891b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6892b5b1a830SBarry Smith /* 6893b5b1a830SBarry Smith This should work, but it doesn't 6894b5b1a830SBarry Smith sctx->ctx = ctx; 6895b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6896b5b1a830SBarry Smith */ 6897b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6898bbd56ea5SKarl Rupp 68990298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6900b5b1a830SBarry Smith PetscFunctionReturn(0); 6901b5b1a830SBarry Smith } 6902325fc9f4SBarry Smith #endif 6903b3603a34SBarry Smith 6904b3603a34SBarry Smith /*@C 69054f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6906b3603a34SBarry Smith in a time based line graph 6907b3603a34SBarry Smith 6908b3603a34SBarry Smith Collective on TS 6909b3603a34SBarry Smith 6910b3603a34SBarry Smith Input Parameters: 6911b3603a34SBarry Smith + ts - the TS context 6912b3603a34SBarry Smith . step - current time-step 6913b3603a34SBarry Smith . ptime - current time 69147db568b7SBarry Smith . u - current solution 69157db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6916b3603a34SBarry Smith 6917b3d3934dSBarry Smith Options Database: 69189ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6919b3d3934dSBarry Smith 6920b3603a34SBarry Smith Level: intermediate 6921b3603a34SBarry Smith 69226934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component solutions in a separate window 6923b3603a34SBarry Smith 6924b3603a34SBarry Smith .keywords: TS, vector, monitor, view 6925b3603a34SBarry Smith 69267db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 69277db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 69287db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 69297db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6930b3603a34SBarry Smith @*/ 69317db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6932b3603a34SBarry Smith { 6933b3603a34SBarry Smith PetscErrorCode ierr; 69347db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6935b3603a34SBarry Smith const PetscScalar *yy; 693680666b62SBarry Smith Vec v; 6937b3603a34SBarry Smith 6938b3603a34SBarry Smith PetscFunctionBegin; 693963e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 694058ff32f7SBarry Smith if (!step) { 6941a9f9c1f6SBarry Smith PetscDrawAxis axis; 69426934998bSLisandro Dalcin PetscInt dim; 6943a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6944a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6945bab0a581SBarry Smith if (!ctx->names) { 6946bab0a581SBarry Smith PetscBool flg; 6947bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6948bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6949bab0a581SBarry Smith if (flg) { 6950bab0a581SBarry Smith PetscInt i,n; 6951bab0a581SBarry Smith char **names; 6952bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6953bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6954bab0a581SBarry Smith for (i=0; i<n; i++) { 6955bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6956bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6957bab0a581SBarry Smith } 6958bab0a581SBarry Smith names[n] = NULL; 6959bab0a581SBarry Smith ctx->names = names; 6960bab0a581SBarry Smith } 6961bab0a581SBarry Smith } 6962387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6963387f4636SBarry Smith char **displaynames; 6964387f4636SBarry Smith PetscBool flg; 6965387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 696695dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6967387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6968c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6969387f4636SBarry Smith if (flg) { 6970a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6971387f4636SBarry Smith } 6972387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6973387f4636SBarry Smith } 6974387f4636SBarry Smith if (ctx->displaynames) { 6975387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6976387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6977387f4636SBarry Smith } else if (ctx->names) { 69780910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 69790b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6980387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6981b0bc92c6SBarry Smith } else { 6982b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6983b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6984387f4636SBarry Smith } 69850b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 698658ff32f7SBarry Smith } 69876934998bSLisandro Dalcin 69886934998bSLisandro Dalcin if (!ctx->transform) v = u; 69896934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 699080666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 69916934998bSLisandro Dalcin if (ctx->displaynames) { 69926934998bSLisandro Dalcin PetscInt i; 69936934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 69946934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 69956934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 69966934998bSLisandro Dalcin } else { 6997e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6998e3efe391SJed Brown PetscInt i,n; 69996934998bSLisandro Dalcin PetscReal *yreal; 700080666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 7001785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7002e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 70030b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7004e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7005e3efe391SJed Brown #else 70060b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7007e3efe391SJed Brown #endif 700880666b62SBarry Smith } 70096934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 70106934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 70116934998bSLisandro Dalcin 7012b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 70130b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 70146934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 70153923b477SBarry Smith } 7016b3603a34SBarry Smith PetscFunctionReturn(0); 7017b3603a34SBarry Smith } 7018b3603a34SBarry Smith 7019387f4636SBarry Smith 7020b037adc7SBarry Smith /*@C 702131152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7022b037adc7SBarry Smith 7023b037adc7SBarry Smith Collective on TS 7024b037adc7SBarry Smith 7025b037adc7SBarry Smith Input Parameters: 7026b037adc7SBarry Smith + ts - the TS context 7027b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 7028b037adc7SBarry Smith 7029b037adc7SBarry Smith Level: intermediate 7030b037adc7SBarry Smith 70317db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70327db568b7SBarry Smith 7033b037adc7SBarry Smith .keywords: TS, vector, monitor, view 7034b037adc7SBarry Smith 7035a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 7036b037adc7SBarry Smith @*/ 703731152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 7038b037adc7SBarry Smith { 7039b037adc7SBarry Smith PetscErrorCode ierr; 7040b037adc7SBarry Smith PetscInt i; 7041b037adc7SBarry Smith 7042b037adc7SBarry Smith PetscFunctionBegin; 7043b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7044b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 70455537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 7046b3d3934dSBarry Smith break; 7047b3d3934dSBarry Smith } 7048b3d3934dSBarry Smith } 7049b3d3934dSBarry Smith PetscFunctionReturn(0); 7050b3d3934dSBarry Smith } 7051b3d3934dSBarry Smith 7052e673d494SBarry Smith /*@C 7053e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7054e673d494SBarry Smith 7055e673d494SBarry Smith Collective on TS 7056e673d494SBarry Smith 7057e673d494SBarry Smith Input Parameters: 7058e673d494SBarry Smith + ts - the TS context 7059e673d494SBarry Smith - names - the names of the components, final string must be NULL 7060e673d494SBarry Smith 7061e673d494SBarry Smith Level: intermediate 7062e673d494SBarry Smith 7063e673d494SBarry Smith .keywords: TS, vector, monitor, view 7064e673d494SBarry Smith 7065a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 7066e673d494SBarry Smith @*/ 7067e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 7068e673d494SBarry Smith { 7069e673d494SBarry Smith PetscErrorCode ierr; 7070e673d494SBarry Smith 7071e673d494SBarry Smith PetscFunctionBegin; 7072e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 7073e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 7074e673d494SBarry Smith PetscFunctionReturn(0); 7075e673d494SBarry Smith } 7076e673d494SBarry Smith 7077b3d3934dSBarry Smith /*@C 7078b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 7079b3d3934dSBarry Smith 7080b3d3934dSBarry Smith Collective on TS 7081b3d3934dSBarry Smith 7082b3d3934dSBarry Smith Input Parameter: 7083b3d3934dSBarry Smith . ts - the TS context 7084b3d3934dSBarry Smith 7085b3d3934dSBarry Smith Output Parameter: 7086b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 7087b3d3934dSBarry Smith 7088b3d3934dSBarry Smith Level: intermediate 7089b3d3934dSBarry Smith 70907db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70917db568b7SBarry Smith 7092b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7093b3d3934dSBarry Smith 7094b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7095b3d3934dSBarry Smith @*/ 7096b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 7097b3d3934dSBarry Smith { 7098b3d3934dSBarry Smith PetscInt i; 7099b3d3934dSBarry Smith 7100b3d3934dSBarry Smith PetscFunctionBegin; 7101b3d3934dSBarry Smith *names = NULL; 7102b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7103b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71045537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 7105b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 7106b3d3934dSBarry Smith break; 7107387f4636SBarry Smith } 7108387f4636SBarry Smith } 7109387f4636SBarry Smith PetscFunctionReturn(0); 7110387f4636SBarry Smith } 7111387f4636SBarry Smith 7112a66092f1SBarry Smith /*@C 7113a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 7114a66092f1SBarry Smith 7115a66092f1SBarry Smith Collective on TS 7116a66092f1SBarry Smith 7117a66092f1SBarry Smith Input Parameters: 7118a66092f1SBarry Smith + ctx - the TSMonitorLG context 7119a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 7120a66092f1SBarry Smith 7121a66092f1SBarry Smith Level: intermediate 7122a66092f1SBarry Smith 7123a66092f1SBarry Smith .keywords: TS, vector, monitor, view 7124a66092f1SBarry Smith 7125a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7126a66092f1SBarry Smith @*/ 7127a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 7128a66092f1SBarry Smith { 7129a66092f1SBarry Smith PetscInt j = 0,k; 7130a66092f1SBarry Smith PetscErrorCode ierr; 7131a66092f1SBarry Smith 7132a66092f1SBarry Smith PetscFunctionBegin; 7133a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 7134a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 7135a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 7136a66092f1SBarry Smith while (displaynames[j]) j++; 7137a66092f1SBarry Smith ctx->ndisplayvariables = j; 7138a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 7139a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 7140a66092f1SBarry Smith j = 0; 7141a66092f1SBarry Smith while (displaynames[j]) { 7142a66092f1SBarry Smith k = 0; 7143a66092f1SBarry Smith while (ctx->names[k]) { 7144a66092f1SBarry Smith PetscBool flg; 7145a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 7146a66092f1SBarry Smith if (flg) { 7147a66092f1SBarry Smith ctx->displayvariables[j] = k; 7148a66092f1SBarry Smith break; 7149a66092f1SBarry Smith } 7150a66092f1SBarry Smith k++; 7151a66092f1SBarry Smith } 7152a66092f1SBarry Smith j++; 7153a66092f1SBarry Smith } 7154a66092f1SBarry Smith PetscFunctionReturn(0); 7155a66092f1SBarry Smith } 7156a66092f1SBarry Smith 7157a66092f1SBarry Smith 7158387f4636SBarry Smith /*@C 7159387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 7160387f4636SBarry Smith 7161387f4636SBarry Smith Collective on TS 7162387f4636SBarry Smith 7163387f4636SBarry Smith Input Parameters: 7164387f4636SBarry Smith + ts - the TS context 7165387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 7166387f4636SBarry Smith 71677db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 71687db568b7SBarry Smith 7169387f4636SBarry Smith Level: intermediate 7170387f4636SBarry Smith 7171387f4636SBarry Smith .keywords: TS, vector, monitor, view 7172387f4636SBarry Smith 7173387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7174387f4636SBarry Smith @*/ 7175387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 7176387f4636SBarry Smith { 7177a66092f1SBarry Smith PetscInt i; 7178387f4636SBarry Smith PetscErrorCode ierr; 7179387f4636SBarry Smith 7180387f4636SBarry Smith PetscFunctionBegin; 7181387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7182387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71835537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 7184b3d3934dSBarry Smith break; 7185b037adc7SBarry Smith } 7186b037adc7SBarry Smith } 7187b037adc7SBarry Smith PetscFunctionReturn(0); 7188b037adc7SBarry Smith } 7189b037adc7SBarry Smith 719080666b62SBarry Smith /*@C 719180666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 719280666b62SBarry Smith 719380666b62SBarry Smith Collective on TS 719480666b62SBarry Smith 719580666b62SBarry Smith Input Parameters: 719680666b62SBarry Smith + ts - the TS context 719780666b62SBarry Smith . transform - the transform function 71987684fa3eSBarry Smith . destroy - function to destroy the optional context 719980666b62SBarry Smith - ctx - optional context used by transform function 720080666b62SBarry Smith 72017db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 72027db568b7SBarry Smith 720380666b62SBarry Smith Level: intermediate 720480666b62SBarry Smith 720580666b62SBarry Smith .keywords: TS, vector, monitor, view 720680666b62SBarry Smith 7207a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 720880666b62SBarry Smith @*/ 72097684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 721080666b62SBarry Smith { 721180666b62SBarry Smith PetscInt i; 7212a66092f1SBarry Smith PetscErrorCode ierr; 721380666b62SBarry Smith 721480666b62SBarry Smith PetscFunctionBegin; 721580666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 721680666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 72175537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 721880666b62SBarry Smith } 721980666b62SBarry Smith } 722080666b62SBarry Smith PetscFunctionReturn(0); 722180666b62SBarry Smith } 722280666b62SBarry Smith 7223e673d494SBarry Smith /*@C 7224e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 7225e673d494SBarry Smith 7226e673d494SBarry Smith Collective on TSLGCtx 7227e673d494SBarry Smith 7228e673d494SBarry Smith Input Parameters: 7229e673d494SBarry Smith + ts - the TS context 7230e673d494SBarry Smith . transform - the transform function 72317684fa3eSBarry Smith . destroy - function to destroy the optional context 7232e673d494SBarry Smith - ctx - optional context used by transform function 7233e673d494SBarry Smith 7234e673d494SBarry Smith Level: intermediate 7235e673d494SBarry Smith 7236e673d494SBarry Smith .keywords: TS, vector, monitor, view 7237e673d494SBarry Smith 7238a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 7239e673d494SBarry Smith @*/ 72407684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 7241e673d494SBarry Smith { 7242e673d494SBarry Smith PetscFunctionBegin; 7243e673d494SBarry Smith ctx->transform = transform; 72447684fa3eSBarry Smith ctx->transformdestroy = destroy; 7245e673d494SBarry Smith ctx->transformctx = tctx; 7246e673d494SBarry Smith PetscFunctionReturn(0); 7247e673d494SBarry Smith } 7248e673d494SBarry Smith 7249ef20d060SBarry Smith /*@C 72504f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 7251ef20d060SBarry Smith in a time based line graph 7252ef20d060SBarry Smith 7253ef20d060SBarry Smith Collective on TS 7254ef20d060SBarry Smith 7255ef20d060SBarry Smith Input Parameters: 7256ef20d060SBarry Smith + ts - the TS context 7257ef20d060SBarry Smith . step - current time-step 7258ef20d060SBarry Smith . ptime - current time 72597db568b7SBarry Smith . u - current solution 72607db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 7261ef20d060SBarry Smith 7262ef20d060SBarry Smith Level: intermediate 7263ef20d060SBarry Smith 72646934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component errors in a separate window 7265abd5a294SJed Brown 7266abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 7267abd5a294SJed Brown 7268abd5a294SJed Brown Options Database Keys: 72694f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 7270ef20d060SBarry Smith 7271ef20d060SBarry Smith .keywords: TS, vector, monitor, view 7272ef20d060SBarry Smith 7273abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 7274ef20d060SBarry Smith @*/ 72750910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 7276ef20d060SBarry Smith { 7277ef20d060SBarry Smith PetscErrorCode ierr; 72780b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 7279ef20d060SBarry Smith const PetscScalar *yy; 7280ef20d060SBarry Smith Vec y; 7281ef20d060SBarry Smith 7282ef20d060SBarry Smith PetscFunctionBegin; 7283a9f9c1f6SBarry Smith if (!step) { 7284a9f9c1f6SBarry Smith PetscDrawAxis axis; 72856934998bSLisandro Dalcin PetscInt dim; 7286a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 72871ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 72880910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 7289a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7290a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7291a9f9c1f6SBarry Smith } 72920910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 7293ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 72940910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7295ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 7296e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7297e3efe391SJed Brown { 7298e3efe391SJed Brown PetscReal *yreal; 7299e3efe391SJed Brown PetscInt i,n; 7300e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 7301785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7302e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 73030b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7304e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7305e3efe391SJed Brown } 7306e3efe391SJed Brown #else 73070b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7308e3efe391SJed Brown #endif 7309ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 7310ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 7311b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 73120b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73136934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 73143923b477SBarry Smith } 7315ef20d060SBarry Smith PetscFunctionReturn(0); 7316ef20d060SBarry Smith } 7317ef20d060SBarry Smith 7318201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7319201da799SBarry Smith { 7320201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7321201da799SBarry Smith PetscReal x = ptime,y; 7322201da799SBarry Smith PetscErrorCode ierr; 7323201da799SBarry Smith PetscInt its; 7324201da799SBarry Smith 7325201da799SBarry Smith PetscFunctionBegin; 732663e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7327201da799SBarry Smith if (!n) { 7328201da799SBarry Smith PetscDrawAxis axis; 7329201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7330201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7331201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7332201da799SBarry Smith ctx->snes_its = 0; 7333201da799SBarry Smith } 7334201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7335201da799SBarry Smith y = its - ctx->snes_its; 7336201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 73373fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7338201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73396934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7340201da799SBarry Smith } 7341201da799SBarry Smith ctx->snes_its = its; 7342201da799SBarry Smith PetscFunctionReturn(0); 7343201da799SBarry Smith } 7344201da799SBarry Smith 7345201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7346201da799SBarry Smith { 7347201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7348201da799SBarry Smith PetscReal x = ptime,y; 7349201da799SBarry Smith PetscErrorCode ierr; 7350201da799SBarry Smith PetscInt its; 7351201da799SBarry Smith 7352201da799SBarry Smith PetscFunctionBegin; 735363e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7354201da799SBarry Smith if (!n) { 7355201da799SBarry Smith PetscDrawAxis axis; 7356201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7357201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7358201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7359201da799SBarry Smith ctx->ksp_its = 0; 7360201da799SBarry Smith } 7361201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7362201da799SBarry Smith y = its - ctx->ksp_its; 7363201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 736499fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7365201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73666934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7367201da799SBarry Smith } 7368201da799SBarry Smith ctx->ksp_its = its; 7369201da799SBarry Smith PetscFunctionReturn(0); 7370201da799SBarry Smith } 7371f9c1d6abSBarry Smith 7372f9c1d6abSBarry Smith /*@ 7373f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7374f9c1d6abSBarry Smith 7375f9c1d6abSBarry Smith Collective on TS and Vec 7376f9c1d6abSBarry Smith 7377f9c1d6abSBarry Smith Input Parameters: 7378f9c1d6abSBarry Smith + ts - the TS context 7379f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7380f9c1d6abSBarry Smith 7381f9c1d6abSBarry Smith Output Parameters: 7382f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7383f9c1d6abSBarry Smith 7384f9c1d6abSBarry Smith Level: developer 7385f9c1d6abSBarry Smith 7386f9c1d6abSBarry Smith .keywords: TS, compute 7387f9c1d6abSBarry Smith 7388f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7389f9c1d6abSBarry Smith @*/ 7390f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7391f9c1d6abSBarry Smith { 7392f9c1d6abSBarry Smith PetscErrorCode ierr; 7393f9c1d6abSBarry Smith 7394f9c1d6abSBarry Smith PetscFunctionBegin; 7395f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7396ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7397f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7398f9c1d6abSBarry Smith PetscFunctionReturn(0); 7399f9c1d6abSBarry Smith } 740024655328SShri 7401b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7402b3d3934dSBarry Smith /*@C 7403b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7404b3d3934dSBarry Smith 7405b3d3934dSBarry Smith Collective on TS 7406b3d3934dSBarry Smith 7407b3d3934dSBarry Smith Input Parameters: 7408b3d3934dSBarry Smith . ts - the ODE solver object 7409b3d3934dSBarry Smith 7410b3d3934dSBarry Smith Output Parameter: 7411b3d3934dSBarry Smith . ctx - the context 7412b3d3934dSBarry Smith 7413b3d3934dSBarry Smith Level: intermediate 7414b3d3934dSBarry Smith 7415b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 7416b3d3934dSBarry Smith 7417b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7418b3d3934dSBarry Smith 7419b3d3934dSBarry Smith @*/ 7420b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7421b3d3934dSBarry Smith { 7422b3d3934dSBarry Smith PetscErrorCode ierr; 7423b3d3934dSBarry Smith 7424b3d3934dSBarry Smith PetscFunctionBegin; 7425a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7426b3d3934dSBarry Smith PetscFunctionReturn(0); 7427b3d3934dSBarry Smith } 7428b3d3934dSBarry Smith 7429b3d3934dSBarry Smith /*@C 7430b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7431b3d3934dSBarry Smith 7432b3d3934dSBarry Smith Collective on TS 7433b3d3934dSBarry Smith 7434b3d3934dSBarry Smith Input Parameters: 7435b3d3934dSBarry Smith + ts - the TS context 7436b3d3934dSBarry Smith . step - current time-step 7437b3d3934dSBarry Smith . ptime - current time 74387db568b7SBarry Smith . u - current solution 74397db568b7SBarry Smith - dctx - the envelope context 7440b3d3934dSBarry Smith 7441b3d3934dSBarry Smith Options Database: 7442b3d3934dSBarry Smith . -ts_monitor_envelope 7443b3d3934dSBarry Smith 7444b3d3934dSBarry Smith Level: intermediate 7445b3d3934dSBarry Smith 7446b3d3934dSBarry Smith Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7447b3d3934dSBarry Smith 7448b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7449b3d3934dSBarry Smith 74507db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7451b3d3934dSBarry Smith @*/ 74527db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7453b3d3934dSBarry Smith { 7454b3d3934dSBarry Smith PetscErrorCode ierr; 74557db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7456b3d3934dSBarry Smith 7457b3d3934dSBarry Smith PetscFunctionBegin; 7458b3d3934dSBarry Smith if (!ctx->max) { 7459b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7460b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7461b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7462b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7463b3d3934dSBarry Smith } else { 7464b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7465b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7466b3d3934dSBarry Smith } 7467b3d3934dSBarry Smith PetscFunctionReturn(0); 7468b3d3934dSBarry Smith } 7469b3d3934dSBarry Smith 7470b3d3934dSBarry Smith 7471b3d3934dSBarry Smith /*@C 7472b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7473b3d3934dSBarry Smith 7474b3d3934dSBarry Smith Collective on TS 7475b3d3934dSBarry Smith 7476b3d3934dSBarry Smith Input Parameter: 7477b3d3934dSBarry Smith . ts - the TS context 7478b3d3934dSBarry Smith 7479b3d3934dSBarry Smith Output Parameter: 7480b3d3934dSBarry Smith + max - the maximum values 7481b3d3934dSBarry Smith - min - the minimum values 7482b3d3934dSBarry Smith 74837db568b7SBarry Smith Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 74847db568b7SBarry Smith 7485b3d3934dSBarry Smith Level: intermediate 7486b3d3934dSBarry Smith 7487b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7488b3d3934dSBarry Smith 7489b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7490b3d3934dSBarry Smith @*/ 7491b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7492b3d3934dSBarry Smith { 7493b3d3934dSBarry Smith PetscInt i; 7494b3d3934dSBarry Smith 7495b3d3934dSBarry Smith PetscFunctionBegin; 7496b3d3934dSBarry Smith if (max) *max = NULL; 7497b3d3934dSBarry Smith if (min) *min = NULL; 7498b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7499b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 75005537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7501b3d3934dSBarry Smith if (max) *max = ctx->max; 7502b3d3934dSBarry Smith if (min) *min = ctx->min; 7503b3d3934dSBarry Smith break; 7504b3d3934dSBarry Smith } 7505b3d3934dSBarry Smith } 7506b3d3934dSBarry Smith PetscFunctionReturn(0); 7507b3d3934dSBarry Smith } 7508b3d3934dSBarry Smith 7509b3d3934dSBarry Smith /*@C 7510b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7511b3d3934dSBarry Smith 7512b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7513b3d3934dSBarry Smith 7514b3d3934dSBarry Smith Input Parameter: 7515b3d3934dSBarry Smith . ctx - the monitor context 7516b3d3934dSBarry Smith 7517b3d3934dSBarry Smith Level: intermediate 7518b3d3934dSBarry Smith 7519b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7520b3d3934dSBarry Smith 75217db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7522b3d3934dSBarry Smith @*/ 7523b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7524b3d3934dSBarry Smith { 7525b3d3934dSBarry Smith PetscErrorCode ierr; 7526b3d3934dSBarry Smith 7527b3d3934dSBarry Smith PetscFunctionBegin; 7528b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7529b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7530b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7531b3d3934dSBarry Smith PetscFunctionReturn(0); 7532b3d3934dSBarry Smith } 7533f2dee214SBarry Smith 753424655328SShri /*@ 753524655328SShri TSRollBack - Rolls back one time step 753624655328SShri 753724655328SShri Collective on TS 753824655328SShri 753924655328SShri Input Parameter: 754024655328SShri . ts - the TS context obtained from TSCreate() 754124655328SShri 754224655328SShri Level: advanced 754324655328SShri 754424655328SShri .keywords: TS, timestep, rollback 754524655328SShri 754624655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 754724655328SShri @*/ 754824655328SShri PetscErrorCode TSRollBack(TS ts) 754924655328SShri { 755024655328SShri PetscErrorCode ierr; 755124655328SShri 755224655328SShri PetscFunctionBegin; 755324655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7554b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 755524655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 755624655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 755724655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 755824655328SShri ts->ptime = ts->ptime_prev; 7559be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 7560be5899b3SLisandro Dalcin ts->steps--; ts->total_steps--; 756110b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 7562b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 756324655328SShri PetscFunctionReturn(0); 756424655328SShri } 7565aeb4809dSShri Abhyankar 7566ff22ae23SHong Zhang /*@ 7567ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7568ff22ae23SHong Zhang 7569ff22ae23SHong Zhang Input Parameter: 7570ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7571ff22ae23SHong Zhang 7572ff22ae23SHong Zhang Level: advanced 7573ff22ae23SHong Zhang 7574ff22ae23SHong Zhang .keywords: TS, getstages 7575ff22ae23SHong Zhang 7576ff22ae23SHong Zhang .seealso: TSCreate() 7577ff22ae23SHong Zhang @*/ 7578ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7579ff22ae23SHong Zhang { 7580ff22ae23SHong Zhang PetscErrorCode ierr; 7581ff22ae23SHong Zhang 7582ff22ae23SHong Zhang PetscFunctionBegin; 7583ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7584ff22ae23SHong Zhang PetscValidPointer(ns,2); 7585ff22ae23SHong Zhang 7586ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 7587ff22ae23SHong Zhang else { 7588ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7589ff22ae23SHong Zhang } 7590ff22ae23SHong Zhang PetscFunctionReturn(0); 7591ff22ae23SHong Zhang } 7592ff22ae23SHong Zhang 7593847ff0e1SMatthew G. Knepley /*@C 7594847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7595847ff0e1SMatthew G. Knepley 7596847ff0e1SMatthew G. Knepley Collective on SNES 7597847ff0e1SMatthew G. Knepley 7598847ff0e1SMatthew G. Knepley Input Parameters: 7599847ff0e1SMatthew G. Knepley + ts - the TS context 7600847ff0e1SMatthew G. Knepley . t - current timestep 7601847ff0e1SMatthew G. Knepley . U - state vector 7602847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7603847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7604847ff0e1SMatthew G. Knepley - ctx - an optional user context 7605847ff0e1SMatthew G. Knepley 7606847ff0e1SMatthew G. Knepley Output Parameters: 7607847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7608847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7609847ff0e1SMatthew G. Knepley 7610847ff0e1SMatthew G. Knepley Level: intermediate 7611847ff0e1SMatthew G. Knepley 7612847ff0e1SMatthew G. Knepley Notes: 7613847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7614847ff0e1SMatthew G. Knepley 7615847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7616847ff0e1SMatthew G. Knepley 7617847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7618847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7619847ff0e1SMatthew G. Knepley 7620847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7621847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7622847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7623847ff0e1SMatthew G. Knepley 7624847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7625847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7626847ff0e1SMatthew G. Knepley @*/ 7627847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7628847ff0e1SMatthew G. Knepley { 7629847ff0e1SMatthew G. Knepley SNES snes; 7630847ff0e1SMatthew G. Knepley MatFDColoring color; 7631847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7632847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7633847ff0e1SMatthew G. Knepley 7634847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7635c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7636847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7637847ff0e1SMatthew G. Knepley if (!color) { 7638847ff0e1SMatthew G. Knepley DM dm; 7639847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7640847ff0e1SMatthew G. Knepley 7641847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7642847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7643847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7644847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7645847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7646847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7647847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7648847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7649847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7650847ff0e1SMatthew G. Knepley } else { 7651847ff0e1SMatthew G. Knepley MatColoring mc; 7652847ff0e1SMatthew G. Knepley 7653847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7654847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7655847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7656847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7657847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7658847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7659847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7660847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7661847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7662847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7663847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7664847ff0e1SMatthew G. Knepley } 7665847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7666847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7667847ff0e1SMatthew G. Knepley } 7668847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7669847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7670847ff0e1SMatthew G. Knepley if (J != B) { 7671847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7672847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7673847ff0e1SMatthew G. Knepley } 7674847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7675847ff0e1SMatthew G. Knepley } 767693b34091SDebojyoti Ghosh 7677cb9d8021SPierre Barbier de Reuille /*@ 7678cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7679cb9d8021SPierre Barbier de Reuille 7680cb9d8021SPierre Barbier de Reuille Input Parameters: 7681cb9d8021SPierre Barbier de Reuille ts - the TS context 7682cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7683cb9d8021SPierre Barbier de Reuille 7684cb9d8021SPierre Barbier de Reuille Level: intermediate 7685cb9d8021SPierre Barbier de Reuille 7686cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7687cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7688cb9d8021SPierre Barbier de Reuille @*/ 7689cb9d8021SPierre Barbier de Reuille 7690d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7691cb9d8021SPierre Barbier de Reuille { 7692cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7693cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7694cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7695cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7696cb9d8021SPierre Barbier de Reuille } 7697cb9d8021SPierre Barbier de Reuille 7698cb9d8021SPierre Barbier de Reuille /*@ 7699cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7700cb9d8021SPierre Barbier de Reuille 7701cb9d8021SPierre Barbier de Reuille Input Parameters: 7702cb9d8021SPierre Barbier de Reuille ts - the TS context 7703cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7704d183316bSPierre Barbier de Reuille Y - state vector to check. 7705cb9d8021SPierre Barbier de Reuille 7706cb9d8021SPierre Barbier de Reuille Output Parameter: 7707cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7708cb9d8021SPierre Barbier de Reuille 7709cb9d8021SPierre Barbier de Reuille Note: 7710cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7711cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 771296a0c994SBarry Smith 771396a0c994SBarry Smith Level: advanced 7714cb9d8021SPierre Barbier de Reuille @*/ 7715d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7716cb9d8021SPierre Barbier de Reuille { 7717cb9d8021SPierre Barbier de Reuille PetscErrorCode ierr; 7718cb9d8021SPierre Barbier de Reuille 7719cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7720cb9d8021SPierre Barbier de Reuille 7721cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7722cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7723cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7724d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7725cb9d8021SPierre Barbier de Reuille } 7726cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7727cb9d8021SPierre Barbier de Reuille } 77281ceb14c0SBarry Smith 772993b34091SDebojyoti Ghosh /*@C 7730e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 773193b34091SDebojyoti Ghosh 773293b34091SDebojyoti Ghosh Collective on MPI_Comm 773393b34091SDebojyoti Ghosh 773493b34091SDebojyoti Ghosh Input Parameter: 773593b34091SDebojyoti Ghosh . tsin - The input TS 773693b34091SDebojyoti Ghosh 773793b34091SDebojyoti Ghosh Output Parameter: 7738e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 773993b34091SDebojyoti Ghosh 77405eca1a21SEmil Constantinescu Notes: 77415eca1a21SEmil 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. 77425eca1a21SEmil Constantinescu 7743baa10174SEmil 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); 77445eca1a21SEmil Constantinescu 77455eca1a21SEmil Constantinescu Level: developer 774693b34091SDebojyoti Ghosh 7747e5168f73SEmil Constantinescu .keywords: TS, clone 7748e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 774993b34091SDebojyoti Ghosh @*/ 7750baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 775193b34091SDebojyoti Ghosh { 775293b34091SDebojyoti Ghosh TS t; 775393b34091SDebojyoti Ghosh PetscErrorCode ierr; 7754dc846ba4SSatish Balay SNES snes_start; 7755dc846ba4SSatish Balay DM dm; 7756dc846ba4SSatish Balay TSType type; 775793b34091SDebojyoti Ghosh 775893b34091SDebojyoti Ghosh PetscFunctionBegin; 775993b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 776093b34091SDebojyoti Ghosh *tsout = NULL; 776193b34091SDebojyoti Ghosh 77627a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 776393b34091SDebojyoti Ghosh 776493b34091SDebojyoti Ghosh /* General TS description */ 776593b34091SDebojyoti Ghosh t->numbermonitors = 0; 776693b34091SDebojyoti Ghosh t->setupcalled = 0; 776793b34091SDebojyoti Ghosh t->ksp_its = 0; 776893b34091SDebojyoti Ghosh t->snes_its = 0; 776993b34091SDebojyoti Ghosh t->nwork = 0; 777093b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 777193b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 777293b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 777393b34091SDebojyoti Ghosh 777434561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 777534561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7776d15a3a53SEmil Constantinescu 777793b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 777893b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 777993b34091SDebojyoti Ghosh 778093b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 778151699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 778293b34091SDebojyoti Ghosh 7783e7069c78SShri t->trajectory = tsin->trajectory; 7784e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7785e7069c78SShri 7786e7069c78SShri t->event = tsin->event; 77876b10a48eSSatish Balay if (t->event) t->event->refct++; 7788e7069c78SShri 778993b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 779093b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7791e7069c78SShri t->ptime_prev = tsin->ptime_prev; 779293b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 779393b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 779493b34091SDebojyoti Ghosh t->steps = tsin->steps; 7795e7069c78SShri t->total_steps = tsin->total_steps; 779693b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 779793b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 779893b34091SDebojyoti Ghosh t->atol = tsin->atol; 779993b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 780093b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 780193b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 780293b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 780393b34091SDebojyoti Ghosh 780493b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 780593b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 780693b34091SDebojyoti Ghosh 780793b34091SDebojyoti Ghosh t->vec_sol = NULL; 780893b34091SDebojyoti Ghosh 780993b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 781093b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 781193b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 781293b34091SDebojyoti Ghosh 781393b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 781493b34091SDebojyoti Ghosh 78150d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 78160d4fed19SBarry Smith PetscInt i; 78170d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 78180d4fed19SBarry Smith for (i=0; i<10; i++) { 78190d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 78200d4fed19SBarry Smith } 78210d4fed19SBarry Smith } 782293b34091SDebojyoti Ghosh *tsout = t; 782393b34091SDebojyoti Ghosh PetscFunctionReturn(0); 782493b34091SDebojyoti Ghosh } 7825