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 1102ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type) 1112ffb9264SLisandro Dalcin { 1122ffb9264SLisandro Dalcin PetscErrorCode ierr; 1132ffb9264SLisandro Dalcin 1142ffb9264SLisandro Dalcin PetscFunctionBegin; 115b92453a8SLisandro Dalcin PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 116b92453a8SLisandro Dalcin PetscValidCharPointer(default_type,2); 1172ffb9264SLisandro Dalcin if (!((PetscObject)adapt)->type_name) { 1182ffb9264SLisandro Dalcin ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr); 1192ffb9264SLisandro Dalcin } 1202ffb9264SLisandro Dalcin PetscFunctionReturn(0); 1212ffb9264SLisandro Dalcin } 1222ffb9264SLisandro Dalcin 123bdad233fSMatthew Knepley /*@ 124bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 125bdad233fSMatthew Knepley 126bdad233fSMatthew Knepley Collective on TS 127bdad233fSMatthew Knepley 128bdad233fSMatthew Knepley Input Parameter: 129bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 130bdad233fSMatthew Knepley 131bdad233fSMatthew Knepley Options Database Keys: 132b6a60446SDebojyoti Ghosh + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE 133ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 1343e4cdcaaSBarry Smith . -ts_max_steps <maxsteps> - maximum number of time-steps to take 1353e4cdcaaSBarry Smith . -ts_final_time <time> - maximum time to compute to 1363e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 137a3cdaa26SBarry 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 138a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 139a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 140a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 141a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 142a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 143ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 144847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 145bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 146de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 147de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 1486934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 149de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 150de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 151de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 152de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 1533e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 1543e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 155fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 156e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 157110eb670SHong Zhang . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 158110eb670SHong Zhang . -ts_adjoint_monitor - print information at each adjoint time step 15953ea634cSHong Zhang - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically 16053ea634cSHong Zhang 16191b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 162bdad233fSMatthew Knepley 163bdad233fSMatthew Knepley Level: beginner 164bdad233fSMatthew Knepley 165bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 166bdad233fSMatthew Knepley 167a313700dSBarry Smith .seealso: TSGetType() 168bdad233fSMatthew Knepley @*/ 1697087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 170bdad233fSMatthew Knepley { 171bc952696SBarry Smith PetscBool opt,flg,tflg; 172dfbe8321SBarry Smith PetscErrorCode ierr; 173eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 17431748224SBarry Smith PetscReal time_step; 17549354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 176d1212d36SBarry Smith char dir[16]; 177cd11d68dSLisandro Dalcin TSIFunction ifun; 1786991f827SBarry Smith const char *defaultType; 1796991f827SBarry Smith char typeName[256]; 180bdad233fSMatthew Knepley 181bdad233fSMatthew Knepley PetscFunctionBegin; 1820700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1836991f827SBarry Smith 1846991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 185cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 186cd11d68dSLisandro Dalcin 187cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 188cd11d68dSLisandro Dalcin if (((PetscObject)ts)->type_name) 189cd11d68dSLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 190cd11d68dSLisandro Dalcin else 191cd11d68dSLisandro Dalcin defaultType = ifun ? TSBEULER : TSEULER; 1926991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1936991f827SBarry Smith if (opt) { 1946991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1956991f827SBarry Smith } else { 1966991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1976991f827SBarry Smith } 198bdad233fSMatthew Knepley 199bdad233fSMatthew Knepley /* Handle generic TS options */ 2000298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 2010298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 2020298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 20331748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 204cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 20549354f04SShri 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); 20649354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 2070298fd71SBarry 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); 2080298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 2090298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 2100298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 2110298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 212bdad233fSMatthew Knepley 21356f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 21456f85f32SBarry Smith { 21556f85f32SBarry Smith PetscBool set; 21656f85f32SBarry Smith flg = PETSC_FALSE; 21756f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 21856f85f32SBarry Smith if (set) { 21956f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 22056f85f32SBarry Smith } 22156f85f32SBarry Smith } 22256f85f32SBarry Smith #endif 22356f85f32SBarry Smith 224bdad233fSMatthew Knepley /* Monitor options */ 225cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 226fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 227fde5950dSBarry Smith ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr); 228fde5950dSBarry Smith 2295180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 2305180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 2315180491cSLisandro Dalcin 2324f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 233b3603a34SBarry Smith if (opt) { 2340b039ecaSBarry Smith TSMonitorLGCtx ctx; 2353923b477SBarry Smith PetscInt howoften = 1; 236b3603a34SBarry Smith 2370298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2386ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2394f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 240bdad233fSMatthew Knepley } 2416ba87a44SLisandro Dalcin 2424f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 243ef20d060SBarry Smith if (opt) { 2440b039ecaSBarry Smith TSMonitorLGCtx ctx; 2453923b477SBarry Smith PetscInt howoften = 1; 246ef20d060SBarry Smith 2470298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 2486ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2494f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 250ef20d060SBarry Smith } 2516934998bSLisandro Dalcin 2526934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2536934998bSLisandro Dalcin if (opt) { 2546934998bSLisandro Dalcin TSMonitorLGCtx ctx; 2556934998bSLisandro Dalcin PetscInt howoften = 1; 2566934998bSLisandro Dalcin 2576934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2586ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2596934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2606934998bSLisandro Dalcin } 261201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 262201da799SBarry Smith if (opt) { 263201da799SBarry Smith TSMonitorLGCtx ctx; 264201da799SBarry Smith PetscInt howoften = 1; 265201da799SBarry Smith 2660298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2676ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 268201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 269201da799SBarry Smith } 270201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 271201da799SBarry Smith if (opt) { 272201da799SBarry Smith TSMonitorLGCtx ctx; 273201da799SBarry Smith PetscInt howoften = 1; 274201da799SBarry Smith 2750298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2766ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 277201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 278201da799SBarry Smith } 2798189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2808189c53fSBarry Smith if (opt) { 2818189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2828189c53fSBarry Smith PetscInt howoften = 1; 2838189c53fSBarry Smith 2840298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 2856934998bSLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2868189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2878189c53fSBarry Smith } 288ef20d060SBarry Smith opt = PETSC_FALSE; 2890dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 290a7cc72afSBarry Smith if (opt) { 29183a4ac43SBarry Smith TSMonitorDrawCtx ctx; 29283a4ac43SBarry Smith PetscInt howoften = 1; 293a80ad3e0SBarry Smith 2940298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2956934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 29683a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 297bdad233fSMatthew Knepley } 298fb1732b5SBarry Smith opt = PETSC_FALSE; 2999110b2e7SHong Zhang ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr); 3009110b2e7SHong Zhang if (opt) { 3019110b2e7SHong Zhang TSMonitorDrawCtx ctx; 3029110b2e7SHong Zhang PetscInt howoften = 1; 3039110b2e7SHong Zhang 3049110b2e7SHong Zhang ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr); 3056934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 3069110b2e7SHong Zhang ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3079110b2e7SHong Zhang } 3089110b2e7SHong Zhang opt = PETSC_FALSE; 3092d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 3102d5ee99bSBarry Smith if (opt) { 3112d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 3122d5ee99bSBarry Smith PetscReal bounds[4]; 3132d5ee99bSBarry Smith PetscInt n = 4; 3142d5ee99bSBarry Smith PetscDraw draw; 3156934998bSLisandro Dalcin PetscDrawAxis axis; 3162d5ee99bSBarry Smith 3172d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 3182d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 3196934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 3202d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 3216934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 3226934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 3236934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 3242d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3252d5ee99bSBarry Smith } 3262d5ee99bSBarry Smith opt = PETSC_FALSE; 3270dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 3283a471f94SBarry Smith if (opt) { 32983a4ac43SBarry Smith TSMonitorDrawCtx ctx; 33083a4ac43SBarry Smith PetscInt howoften = 1; 3313a471f94SBarry Smith 3320298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 3336934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 33483a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3353a471f94SBarry Smith } 336fde5950dSBarry Smith 337ed81e22dSJed Brown opt = PETSC_FALSE; 33891b97e58SBarry 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); 339ed81e22dSJed Brown if (flg) { 340ed81e22dSJed Brown const char *ptr,*ptr2; 341ed81e22dSJed Brown char *filetemplate; 342ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 343ed81e22dSJed Brown /* Do some cursory validation of the input. */ 344ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 345ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 346ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 347ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 348ce94432eSBarry 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"); 349ed81e22dSJed Brown if (ptr2) break; 350ed81e22dSJed Brown } 351ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 352ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 353ed81e22dSJed Brown } 354bdad233fSMatthew Knepley 355d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 356d1212d36SBarry Smith if (flg) { 357d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 358d1212d36SBarry Smith int ray = 0; 359d1212d36SBarry Smith DMDADirection ddir; 360d1212d36SBarry Smith DM da; 361d1212d36SBarry Smith PetscMPIInt rank; 362d1212d36SBarry Smith 363ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 364d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 365d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 366ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 367d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 368d1212d36SBarry Smith 369d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 370b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 371d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 372d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 373ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 374d1212d36SBarry Smith if (!rank) { 375d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 376d1212d36SBarry Smith } 37751b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 378d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 379d1212d36SBarry Smith } 38051b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 38151b4a12fSMatthew G. Knepley if (flg) { 38251b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 38351b4a12fSMatthew G. Knepley int ray = 0; 38451b4a12fSMatthew G. Knepley DMDADirection ddir; 38551b4a12fSMatthew G. Knepley DM da; 38651b4a12fSMatthew G. Knepley PetscInt howoften = 1; 387d1212d36SBarry Smith 38851b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 38951b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 39051b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 39151b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 39251b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3931c3436cfSJed Brown 39451b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 395b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 39651b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 39751b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 39851b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 39951b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 40051b4a12fSMatthew G. Knepley } 401a7a1495cSBarry Smith 402b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 403b3d3934dSBarry Smith if (opt) { 404b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 405b3d3934dSBarry Smith 406b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 407b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 408b3d3934dSBarry Smith } 409b3d3934dSBarry Smith 410847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 411847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 412847ff0e1SMatthew G. Knepley if (flg) { 413847ff0e1SMatthew G. Knepley DM dm; 414847ff0e1SMatthew G. Knepley DMTS tdm; 415847ff0e1SMatthew G. Knepley 416847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 417847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 418847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 419847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 420847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 421847ff0e1SMatthew G. Knepley } 422847ff0e1SMatthew G. Knepley 4232ffb9264SLisandro Dalcin /* Handle TSAdapt options */ 4242ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 4252ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 426ee346746SBarry Smith ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 427d763cef2SBarry Smith 428d763cef2SBarry Smith /* Handle specific TS options */ 429d763cef2SBarry Smith if (ts->ops->setfromoptions) { 4306991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 431d763cef2SBarry Smith } 432fbc52257SHong Zhang 43368bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 4344f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 43568bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 43668bece0bSHong Zhang if (tflg) { 43768bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 43868bece0bSHong Zhang } 4394f122a70SLisandro Dalcin tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE; 44068bece0bSHong Zhang ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr); 44168bece0bSHong Zhang if (flg) { 44268bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 44368bece0bSHong Zhang ts->adjoint_solve = tflg; 44468bece0bSHong Zhang } 445d763cef2SBarry Smith 446d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4470633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 448fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 449d763cef2SBarry Smith 4504f122a70SLisandro Dalcin if (ts->trajectory) { 4514f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 452d763cef2SBarry Smith } 45368bece0bSHong Zhang 4544f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4554f122a70SLisandro Dalcin if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);} 4564f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 457d763cef2SBarry Smith PetscFunctionReturn(0); 458d763cef2SBarry Smith } 459d763cef2SBarry Smith 460d2daff3dSHong Zhang /*@ 46178fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 46278fbdcc8SBarry Smith 46378fbdcc8SBarry Smith Collective on TS 46478fbdcc8SBarry Smith 46578fbdcc8SBarry Smith Input Parameters: 46678fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 46778fbdcc8SBarry Smith 46878fbdcc8SBarry Smith Output Parameters; 46978fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 47078fbdcc8SBarry Smith 47178fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 47278fbdcc8SBarry Smith 47378fbdcc8SBarry Smith Level: advanced 47478fbdcc8SBarry Smith 47578fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 47678fbdcc8SBarry Smith 47778fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 47878fbdcc8SBarry Smith @*/ 47978fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 48078fbdcc8SBarry Smith { 48178fbdcc8SBarry Smith PetscFunctionBegin; 48278fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 48378fbdcc8SBarry Smith *tr = ts->trajectory; 48478fbdcc8SBarry Smith PetscFunctionReturn(0); 48578fbdcc8SBarry Smith } 48678fbdcc8SBarry Smith 48778fbdcc8SBarry Smith /*@ 488bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 489d2daff3dSHong Zhang 490d2daff3dSHong Zhang Collective on TS 491d2daff3dSHong Zhang 492d2daff3dSHong Zhang Input Parameters: 493bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 494bc952696SBarry Smith 49578fbdcc8SBarry Smith Options Database: 49678fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 49778fbdcc8SBarry Smith - -ts_trajectory_type type 49878fbdcc8SBarry Smith 49968bece0bSHong Zhang Note: This routine should be called after all TS options have been set 500d2daff3dSHong Zhang 50178fbdcc8SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and 50278fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 50378fbdcc8SBarry Smith 504d2daff3dSHong Zhang Level: intermediate 505d2daff3dSHong Zhang 50678fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType() 507d2daff3dSHong Zhang 508bc952696SBarry Smith .keywords: TS, set, checkpoint, 509d2daff3dSHong Zhang @*/ 510bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 511d2daff3dSHong Zhang { 512bc952696SBarry Smith PetscErrorCode ierr; 513bc952696SBarry Smith 514d2daff3dSHong Zhang PetscFunctionBegin; 515d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 516bc952696SBarry Smith if (!ts->trajectory) { 517bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 518972caf09SHong Zhang ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 519bc952696SBarry Smith } 520d2daff3dSHong Zhang PetscFunctionReturn(0); 521d2daff3dSHong Zhang } 522d2daff3dSHong Zhang 523a7a1495cSBarry Smith /*@ 524a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 525a7a1495cSBarry Smith set with TSSetRHSJacobian(). 526a7a1495cSBarry Smith 527a7a1495cSBarry Smith Collective on TS and Vec 528a7a1495cSBarry Smith 529a7a1495cSBarry Smith Input Parameters: 530316643e7SJed Brown + ts - the TS context 531a7a1495cSBarry Smith . t - current timestep 5320910c330SBarry Smith - U - input vector 533a7a1495cSBarry Smith 534a7a1495cSBarry Smith Output Parameters: 535a7a1495cSBarry Smith + A - Jacobian matrix 536a7a1495cSBarry Smith . B - optional preconditioning matrix 537a7a1495cSBarry Smith - flag - flag indicating matrix structure 538a7a1495cSBarry Smith 539a7a1495cSBarry Smith Notes: 540a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 541a7a1495cSBarry Smith is used internally within the nonlinear solvers. 542a7a1495cSBarry Smith 54394b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 544a7a1495cSBarry Smith flag parameter. 545a7a1495cSBarry Smith 546a7a1495cSBarry Smith Level: developer 547a7a1495cSBarry Smith 548a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 549a7a1495cSBarry Smith 55094b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 551a7a1495cSBarry Smith @*/ 552d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 553a7a1495cSBarry Smith { 554dfbe8321SBarry Smith PetscErrorCode ierr; 555270bf2e7SJed Brown PetscObjectState Ustate; 556*6c1e1eecSBarry Smith PetscObjectId Uid; 55724989b8cSPeter Brune DM dm; 558942e3340SBarry Smith DMTS tsdm; 55924989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 56024989b8cSPeter Brune void *ctx; 56124989b8cSPeter Brune TSIJacobian ijacobianfunc; 562b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 563a7a1495cSBarry Smith 564a7a1495cSBarry Smith PetscFunctionBegin; 5650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5660910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5670910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 56824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 569942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 57024989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 5710298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 572b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 57359e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 574*6c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 575*6c1e1eecSBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 5760e4ef248SJed Brown PetscFunctionReturn(0); 577f8ede8e7SJed Brown } 578d90be118SSean Farley 579ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 580d90be118SSean Farley 581e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 58294ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 58394ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 58494ab13aaSBarry Smith if (A != B) { 58594ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 58694ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 587e1244c69SJed Brown } 588e1244c69SJed Brown ts->rhsjacobian.shift = 0; 589e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 590e1244c69SJed Brown } 591e1244c69SJed Brown 59224989b8cSPeter Brune if (rhsjacobianfunc) { 5936cd88445SBarry Smith PetscBool missing; 59494ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 595a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 596d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 597a7a1495cSBarry Smith PetscStackPop; 59894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 5996cd88445SBarry Smith if (A) { 6006cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 6016cd88445SBarry 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"); 6026cd88445SBarry Smith } 6036cd88445SBarry Smith if (B && B != A) { 6046cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 6056cd88445SBarry 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"); 6066cd88445SBarry Smith } 607ef66eb69SBarry Smith } else { 60894ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 60994ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 610ef66eb69SBarry Smith } 6110e4ef248SJed Brown ts->rhsjacobian.time = t; 612*6c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid); 61359e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 614a7a1495cSBarry Smith PetscFunctionReturn(0); 615a7a1495cSBarry Smith } 616a7a1495cSBarry Smith 617316643e7SJed Brown /*@ 618d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 619d763cef2SBarry Smith 620316643e7SJed Brown Collective on TS and Vec 621316643e7SJed Brown 622316643e7SJed Brown Input Parameters: 623316643e7SJed Brown + ts - the TS context 624316643e7SJed Brown . t - current time 6250910c330SBarry Smith - U - state vector 626316643e7SJed Brown 627316643e7SJed Brown Output Parameter: 628316643e7SJed Brown . y - right hand side 629316643e7SJed Brown 630316643e7SJed Brown Note: 631316643e7SJed Brown Most users should not need to explicitly call this routine, as it 632316643e7SJed Brown is used internally within the nonlinear solvers. 633316643e7SJed Brown 634316643e7SJed Brown Level: developer 635316643e7SJed Brown 636316643e7SJed Brown .keywords: TS, compute 637316643e7SJed Brown 638316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 639316643e7SJed Brown @*/ 6400910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 641d763cef2SBarry Smith { 642dfbe8321SBarry Smith PetscErrorCode ierr; 64324989b8cSPeter Brune TSRHSFunction rhsfunction; 64424989b8cSPeter Brune TSIFunction ifunction; 64524989b8cSPeter Brune void *ctx; 64624989b8cSPeter Brune DM dm; 64724989b8cSPeter Brune 648d763cef2SBarry Smith PetscFunctionBegin; 6490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6500910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6510700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 65224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 65324989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6540298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 655d763cef2SBarry Smith 656ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 657d763cef2SBarry Smith 6580910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 65924989b8cSPeter Brune if (rhsfunction) { 660d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6610910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 662d763cef2SBarry Smith PetscStackPop; 663214bc6a2SJed Brown } else { 664214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 665b2cd27e8SJed Brown } 66644a41b28SSean Farley 6670910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 668d763cef2SBarry Smith PetscFunctionReturn(0); 669d763cef2SBarry Smith } 670d763cef2SBarry Smith 671ef20d060SBarry Smith /*@ 672ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 673ef20d060SBarry Smith 674ef20d060SBarry Smith Collective on TS and Vec 675ef20d060SBarry Smith 676ef20d060SBarry Smith Input Parameters: 677ef20d060SBarry Smith + ts - the TS context 678ef20d060SBarry Smith - t - current time 679ef20d060SBarry Smith 680ef20d060SBarry Smith Output Parameter: 6810910c330SBarry Smith . U - the solution 682ef20d060SBarry Smith 683ef20d060SBarry Smith Note: 684ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 685ef20d060SBarry Smith is used internally within the nonlinear solvers. 686ef20d060SBarry Smith 687ef20d060SBarry Smith Level: developer 688ef20d060SBarry Smith 689ef20d060SBarry Smith .keywords: TS, compute 690ef20d060SBarry Smith 691abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 692ef20d060SBarry Smith @*/ 6930910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 694ef20d060SBarry Smith { 695ef20d060SBarry Smith PetscErrorCode ierr; 696ef20d060SBarry Smith TSSolutionFunction solutionfunction; 697ef20d060SBarry Smith void *ctx; 698ef20d060SBarry Smith DM dm; 699ef20d060SBarry Smith 700ef20d060SBarry Smith PetscFunctionBegin; 701ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7020910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 703ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 704ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 705ef20d060SBarry Smith 706ef20d060SBarry Smith if (solutionfunction) { 7079b7cd975SBarry Smith PetscStackPush("TS user solution function"); 7080910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 709ef20d060SBarry Smith PetscStackPop; 710ef20d060SBarry Smith } 711ef20d060SBarry Smith PetscFunctionReturn(0); 712ef20d060SBarry Smith } 7139b7cd975SBarry Smith /*@ 7149b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 7159b7cd975SBarry Smith 7169b7cd975SBarry Smith Collective on TS and Vec 7179b7cd975SBarry Smith 7189b7cd975SBarry Smith Input Parameters: 7199b7cd975SBarry Smith + ts - the TS context 7209b7cd975SBarry Smith - t - current time 7219b7cd975SBarry Smith 7229b7cd975SBarry Smith Output Parameter: 7239b7cd975SBarry Smith . U - the function value 7249b7cd975SBarry Smith 7259b7cd975SBarry Smith Note: 7269b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 7279b7cd975SBarry Smith is used internally within the nonlinear solvers. 7289b7cd975SBarry Smith 7299b7cd975SBarry Smith Level: developer 7309b7cd975SBarry Smith 7319b7cd975SBarry Smith .keywords: TS, compute 7329b7cd975SBarry Smith 7339b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 7349b7cd975SBarry Smith @*/ 7359b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 7369b7cd975SBarry Smith { 7379b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 7389b7cd975SBarry Smith void *ctx; 7399b7cd975SBarry Smith DM dm; 7409b7cd975SBarry Smith 7419b7cd975SBarry Smith PetscFunctionBegin; 7429b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7439b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7449b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7459b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7469b7cd975SBarry Smith 7479b7cd975SBarry Smith if (forcing) { 7489b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7499b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7509b7cd975SBarry Smith PetscStackPop; 7519b7cd975SBarry Smith } 7529b7cd975SBarry Smith PetscFunctionReturn(0); 7539b7cd975SBarry Smith } 754ef20d060SBarry Smith 755214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 756214bc6a2SJed Brown { 7572dd45cf8SJed Brown Vec F; 758214bc6a2SJed Brown PetscErrorCode ierr; 759214bc6a2SJed Brown 760214bc6a2SJed Brown PetscFunctionBegin; 7610298fd71SBarry Smith *Frhs = NULL; 7620298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 763214bc6a2SJed Brown if (!ts->Frhs) { 7642dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 765214bc6a2SJed Brown } 766214bc6a2SJed Brown *Frhs = ts->Frhs; 767214bc6a2SJed Brown PetscFunctionReturn(0); 768214bc6a2SJed Brown } 769214bc6a2SJed Brown 770214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 771214bc6a2SJed Brown { 772214bc6a2SJed Brown Mat A,B; 7732dd45cf8SJed Brown PetscErrorCode ierr; 774214bc6a2SJed Brown 775214bc6a2SJed Brown PetscFunctionBegin; 776c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 777c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 7780298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 779214bc6a2SJed Brown if (Arhs) { 780214bc6a2SJed Brown if (!ts->Arhs) { 781214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 782214bc6a2SJed Brown } 783214bc6a2SJed Brown *Arhs = ts->Arhs; 784214bc6a2SJed Brown } 785214bc6a2SJed Brown if (Brhs) { 786214bc6a2SJed Brown if (!ts->Brhs) { 787bdb70873SJed Brown if (A != B) { 788214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 789bdb70873SJed Brown } else { 790bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 79151699248SLisandro Dalcin ts->Brhs = ts->Arhs; 792bdb70873SJed Brown } 793214bc6a2SJed Brown } 794214bc6a2SJed Brown *Brhs = ts->Brhs; 795214bc6a2SJed Brown } 796214bc6a2SJed Brown PetscFunctionReturn(0); 797214bc6a2SJed Brown } 798214bc6a2SJed Brown 799316643e7SJed Brown /*@ 8000910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 801316643e7SJed Brown 802316643e7SJed Brown Collective on TS and Vec 803316643e7SJed Brown 804316643e7SJed Brown Input Parameters: 805316643e7SJed Brown + ts - the TS context 806316643e7SJed Brown . t - current time 8070910c330SBarry Smith . U - state vector 8080910c330SBarry Smith . Udot - time derivative of state vector 809214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 810316643e7SJed Brown 811316643e7SJed Brown Output Parameter: 812316643e7SJed Brown . Y - right hand side 813316643e7SJed Brown 814316643e7SJed Brown Note: 815316643e7SJed Brown Most users should not need to explicitly call this routine, as it 816316643e7SJed Brown is used internally within the nonlinear solvers. 817316643e7SJed Brown 818316643e7SJed Brown If the user did did not write their equations in implicit form, this 819316643e7SJed Brown function recasts them in implicit form. 820316643e7SJed Brown 821316643e7SJed Brown Level: developer 822316643e7SJed Brown 823316643e7SJed Brown .keywords: TS, compute 824316643e7SJed Brown 825316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 826316643e7SJed Brown @*/ 8270910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 828316643e7SJed Brown { 829316643e7SJed Brown PetscErrorCode ierr; 83024989b8cSPeter Brune TSIFunction ifunction; 83124989b8cSPeter Brune TSRHSFunction rhsfunction; 83224989b8cSPeter Brune void *ctx; 83324989b8cSPeter Brune DM dm; 834316643e7SJed Brown 835316643e7SJed Brown PetscFunctionBegin; 8360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8370910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8380910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8390700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 840316643e7SJed Brown 84124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 84224989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8430298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 84424989b8cSPeter Brune 845ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 846d90be118SSean Farley 8470910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 84824989b8cSPeter Brune if (ifunction) { 849316643e7SJed Brown PetscStackPush("TS user implicit function"); 8500910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 851316643e7SJed Brown PetscStackPop; 852214bc6a2SJed Brown } 853214bc6a2SJed Brown if (imex) { 85424989b8cSPeter Brune if (!ifunction) { 8550910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8562dd45cf8SJed Brown } 85724989b8cSPeter Brune } else if (rhsfunction) { 85824989b8cSPeter Brune if (ifunction) { 859214bc6a2SJed Brown Vec Frhs; 860214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8610910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 862214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8632dd45cf8SJed Brown } else { 8640910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8650910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 866316643e7SJed Brown } 8674a6899ffSJed Brown } 8680910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 869316643e7SJed Brown PetscFunctionReturn(0); 870316643e7SJed Brown } 871316643e7SJed Brown 872316643e7SJed Brown /*@ 873316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 874316643e7SJed Brown 875316643e7SJed Brown Collective on TS and Vec 876316643e7SJed Brown 877316643e7SJed Brown Input 878316643e7SJed Brown Input Parameters: 879316643e7SJed Brown + ts - the TS context 880316643e7SJed Brown . t - current timestep 8810910c330SBarry Smith . U - state vector 8820910c330SBarry Smith . Udot - time derivative of state vector 883214bc6a2SJed Brown . shift - shift to apply, see note below 884214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 885316643e7SJed Brown 886316643e7SJed Brown Output Parameters: 887316643e7SJed Brown + A - Jacobian matrix 888316643e7SJed Brown . B - optional preconditioning matrix 889316643e7SJed Brown - flag - flag indicating matrix structure 890316643e7SJed Brown 891316643e7SJed Brown Notes: 8920910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 893316643e7SJed Brown 8940910c330SBarry Smith dF/dU + shift*dF/dUdot 895316643e7SJed Brown 896316643e7SJed Brown Most users should not need to explicitly call this routine, as it 897316643e7SJed Brown is used internally within the nonlinear solvers. 898316643e7SJed Brown 899316643e7SJed Brown Level: developer 900316643e7SJed Brown 901316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 902316643e7SJed Brown 903316643e7SJed Brown .seealso: TSSetIJacobian() 90463495f91SJed Brown @*/ 905d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 906316643e7SJed Brown { 907316643e7SJed Brown PetscErrorCode ierr; 90824989b8cSPeter Brune TSIJacobian ijacobian; 90924989b8cSPeter Brune TSRHSJacobian rhsjacobian; 91024989b8cSPeter Brune DM dm; 91124989b8cSPeter Brune void *ctx; 912316643e7SJed Brown 913316643e7SJed Brown PetscFunctionBegin; 9140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9150910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9160910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 917316643e7SJed Brown PetscValidPointer(A,6); 91894ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 919316643e7SJed Brown PetscValidPointer(B,7); 92094ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 92124989b8cSPeter Brune 92224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 92324989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9240298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 92524989b8cSPeter Brune 926ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 927316643e7SJed Brown 92894ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 92924989b8cSPeter Brune if (ijacobian) { 9306cd88445SBarry Smith PetscBool missing; 931316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 932d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 933316643e7SJed Brown PetscStackPop; 9346cd88445SBarry Smith if (A) { 9356cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9366cd88445SBarry 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"); 9376cd88445SBarry Smith } 9386cd88445SBarry Smith if (B && B != A) { 9396cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9406cd88445SBarry 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"); 9416cd88445SBarry Smith } 9424a6899ffSJed Brown } 943214bc6a2SJed Brown if (imex) { 944b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9454c26be97Sstefano_zampini PetscBool assembled; 94694ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9474c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9484c26be97Sstefano_zampini if (!assembled) { 9494c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9504c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9514c26be97Sstefano_zampini } 95294ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 95394ab13aaSBarry Smith if (A != B) { 95494ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9554c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9564c26be97Sstefano_zampini if (!assembled) { 9574c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9584c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9594c26be97Sstefano_zampini } 96094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 961214bc6a2SJed Brown } 962214bc6a2SJed Brown } 963214bc6a2SJed Brown } else { 964e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 965e1244c69SJed Brown if (rhsjacobian) { 966214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 967d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 968e1244c69SJed Brown } 96994ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 970e1244c69SJed Brown ts->rhsjacobian.scale = -1; 971e1244c69SJed Brown ts->rhsjacobian.shift = shift; 97294ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 97394ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 97494ab13aaSBarry Smith if (A != B) { 97594ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 97694ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 977316643e7SJed Brown } 978e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 979e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 980e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 98194ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 98294ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 98394ab13aaSBarry Smith if (A != B) { 98494ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 98594ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 986214bc6a2SJed Brown } 987316643e7SJed Brown } 98894ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 98994ab13aaSBarry Smith if (A != B) { 99094ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 991316643e7SJed Brown } 992316643e7SJed Brown } 993316643e7SJed Brown } 99494ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 995316643e7SJed Brown PetscFunctionReturn(0); 996316643e7SJed Brown } 997316643e7SJed Brown 998d763cef2SBarry Smith /*@C 999d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1000b5abc632SBarry Smith where U_t = G(t,u). 1001d763cef2SBarry Smith 10023f9fe445SBarry Smith Logically Collective on TS 1003d763cef2SBarry Smith 1004d763cef2SBarry Smith Input Parameters: 1005d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10060298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1007d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1008d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10090298fd71SBarry Smith function evaluation routine (may be NULL) 1010d763cef2SBarry Smith 1011d763cef2SBarry Smith Calling sequence of func: 101287828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1013d763cef2SBarry Smith 1014d763cef2SBarry Smith + t - current timestep 1015d763cef2SBarry Smith . u - input vector 1016d763cef2SBarry Smith . F - function vector 1017d763cef2SBarry Smith - ctx - [optional] user-defined function context 1018d763cef2SBarry Smith 1019d763cef2SBarry Smith Level: beginner 1020d763cef2SBarry Smith 10212bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10222bbac0d3SBarry Smith 1023d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1024d763cef2SBarry Smith 1025ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1026d763cef2SBarry Smith @*/ 1027089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1028d763cef2SBarry Smith { 1029089b2837SJed Brown PetscErrorCode ierr; 1030089b2837SJed Brown SNES snes; 10310298fd71SBarry Smith Vec ralloc = NULL; 103224989b8cSPeter Brune DM dm; 1033d763cef2SBarry Smith 1034089b2837SJed Brown PetscFunctionBegin; 10350700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1036ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 103724989b8cSPeter Brune 103824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 103924989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1040089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1041e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1042e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1043e856ceecSJed Brown r = ralloc; 1044e856ceecSJed Brown } 1045089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1046e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1047d763cef2SBarry Smith PetscFunctionReturn(0); 1048d763cef2SBarry Smith } 1049d763cef2SBarry Smith 1050ef20d060SBarry Smith /*@C 1051abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1052ef20d060SBarry Smith 1053ef20d060SBarry Smith Logically Collective on TS 1054ef20d060SBarry Smith 1055ef20d060SBarry Smith Input Parameters: 1056ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1057ef20d060SBarry Smith . f - routine for evaluating the solution 1058ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 10590298fd71SBarry Smith function evaluation routine (may be NULL) 1060ef20d060SBarry Smith 1061ef20d060SBarry Smith Calling sequence of func: 1062ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1063ef20d060SBarry Smith 1064ef20d060SBarry Smith + t - current timestep 1065ef20d060SBarry Smith . u - output vector 1066ef20d060SBarry Smith - ctx - [optional] user-defined function context 1067ef20d060SBarry Smith 1068abd5a294SJed Brown Notes: 1069abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1070abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1071abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1072abd5a294SJed Brown 10734f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1074abd5a294SJed Brown 1075ef20d060SBarry Smith Level: beginner 1076ef20d060SBarry Smith 1077ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1078ef20d060SBarry Smith 10799b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 1080ef20d060SBarry Smith @*/ 1081ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1082ef20d060SBarry Smith { 1083ef20d060SBarry Smith PetscErrorCode ierr; 1084ef20d060SBarry Smith DM dm; 1085ef20d060SBarry Smith 1086ef20d060SBarry Smith PetscFunctionBegin; 1087ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1088ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1089ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1090ef20d060SBarry Smith PetscFunctionReturn(0); 1091ef20d060SBarry Smith } 1092ef20d060SBarry Smith 10939b7cd975SBarry Smith /*@C 10949b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 10959b7cd975SBarry Smith 10969b7cd975SBarry Smith Logically Collective on TS 10979b7cd975SBarry Smith 10989b7cd975SBarry Smith Input Parameters: 10999b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1100e162b725SBarry Smith . func - routine for evaluating the forcing function 11019b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11020298fd71SBarry Smith function evaluation routine (may be NULL) 11039b7cd975SBarry Smith 11049b7cd975SBarry Smith Calling sequence of func: 1105e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 11069b7cd975SBarry Smith 11079b7cd975SBarry Smith + t - current timestep 1108e162b725SBarry Smith . f - output vector 11099b7cd975SBarry Smith - ctx - [optional] user-defined function context 11109b7cd975SBarry Smith 11119b7cd975SBarry Smith Notes: 11129b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1113e162b725SBarry 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 1114e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1115e162b725SBarry Smith 1116e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1117e162b725SBarry Smith 1118e162b725SBarry 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 1119e162b725SBarry Smith parameters can be passed in the ctx variable. 11209b7cd975SBarry Smith 11219b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11229b7cd975SBarry Smith 11239b7cd975SBarry Smith Level: beginner 11249b7cd975SBarry Smith 11259b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11269b7cd975SBarry Smith 11279b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11289b7cd975SBarry Smith @*/ 1129e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11309b7cd975SBarry Smith { 11319b7cd975SBarry Smith PetscErrorCode ierr; 11329b7cd975SBarry Smith DM dm; 11339b7cd975SBarry Smith 11349b7cd975SBarry Smith PetscFunctionBegin; 11359b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11369b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1137e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11389b7cd975SBarry Smith PetscFunctionReturn(0); 11399b7cd975SBarry Smith } 11409b7cd975SBarry Smith 1141d763cef2SBarry Smith /*@C 1142f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1143b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1144d763cef2SBarry Smith 11453f9fe445SBarry Smith Logically Collective on TS 1146d763cef2SBarry Smith 1147d763cef2SBarry Smith Input Parameters: 1148d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1149e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1150e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1151d763cef2SBarry Smith . f - the Jacobian evaluation routine 1152d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11530298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1154d763cef2SBarry Smith 1155f7ab8db6SBarry Smith Calling sequence of f: 1156ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1157d763cef2SBarry Smith 1158d763cef2SBarry Smith + t - current timestep 1159d763cef2SBarry Smith . u - input vector 1160e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1161e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1162d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1163d763cef2SBarry Smith 11646cd88445SBarry Smith Notes: 11656cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 11666cd88445SBarry Smith 11676cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1168ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1169d763cef2SBarry Smith 1170d763cef2SBarry Smith Level: beginner 1171d763cef2SBarry Smith 1172d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1173d763cef2SBarry Smith 1174ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1175d763cef2SBarry Smith 1176d763cef2SBarry Smith @*/ 1177e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1178d763cef2SBarry Smith { 1179277b19d0SLisandro Dalcin PetscErrorCode ierr; 1180089b2837SJed Brown SNES snes; 118124989b8cSPeter Brune DM dm; 118224989b8cSPeter Brune TSIJacobian ijacobian; 1183277b19d0SLisandro Dalcin 1184d763cef2SBarry Smith PetscFunctionBegin; 11850700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1186e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1187e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1188e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1189e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1190d763cef2SBarry Smith 119124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 119224989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1193e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1194e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1195e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1196e1244c69SJed Brown } 11970298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1198089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11995f659677SPeter Brune if (!ijacobian) { 1200e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12010e4ef248SJed Brown } 1202e5d3d808SBarry Smith if (Amat) { 1203e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12040e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1205e5d3d808SBarry Smith ts->Arhs = Amat; 12060e4ef248SJed Brown } 1207e5d3d808SBarry Smith if (Pmat) { 1208e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12090e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1210e5d3d808SBarry Smith ts->Brhs = Pmat; 12110e4ef248SJed Brown } 1212d763cef2SBarry Smith PetscFunctionReturn(0); 1213d763cef2SBarry Smith } 1214d763cef2SBarry Smith 1215316643e7SJed Brown 1216316643e7SJed Brown /*@C 1217b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1218316643e7SJed Brown 12193f9fe445SBarry Smith Logically Collective on TS 1220316643e7SJed Brown 1221316643e7SJed Brown Input Parameters: 1222316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12230298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1224316643e7SJed Brown . f - the function evaluation routine 12250298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1226316643e7SJed Brown 1227316643e7SJed Brown Calling sequence of f: 1228316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1229316643e7SJed Brown 1230316643e7SJed Brown + t - time at step/stage being solved 1231316643e7SJed Brown . u - state vector 1232316643e7SJed Brown . u_t - time derivative of state vector 1233316643e7SJed Brown . F - function vector 1234316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1235316643e7SJed Brown 1236316643e7SJed Brown Important: 12372bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1238316643e7SJed Brown 1239316643e7SJed Brown Level: beginner 1240316643e7SJed Brown 1241316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1242316643e7SJed Brown 1243d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1244316643e7SJed Brown @*/ 124551699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1246316643e7SJed Brown { 1247089b2837SJed Brown PetscErrorCode ierr; 1248089b2837SJed Brown SNES snes; 124951699248SLisandro Dalcin Vec ralloc = NULL; 125024989b8cSPeter Brune DM dm; 1251316643e7SJed Brown 1252316643e7SJed Brown PetscFunctionBegin; 12530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 125451699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 125524989b8cSPeter Brune 125624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 125724989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 125824989b8cSPeter Brune 1259089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 126051699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 126151699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 126251699248SLisandro Dalcin r = ralloc; 1263e856ceecSJed Brown } 126451699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 126551699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1266089b2837SJed Brown PetscFunctionReturn(0); 1267089b2837SJed Brown } 1268089b2837SJed Brown 1269089b2837SJed Brown /*@C 1270089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1271089b2837SJed Brown 1272089b2837SJed Brown Not Collective 1273089b2837SJed Brown 1274089b2837SJed Brown Input Parameter: 1275089b2837SJed Brown . ts - the TS context 1276089b2837SJed Brown 1277089b2837SJed Brown Output Parameter: 12780298fd71SBarry Smith + r - vector to hold residual (or NULL) 12790298fd71SBarry Smith . func - the function to compute residual (or NULL) 12800298fd71SBarry Smith - ctx - the function context (or NULL) 1281089b2837SJed Brown 1282089b2837SJed Brown Level: advanced 1283089b2837SJed Brown 1284089b2837SJed Brown .keywords: TS, nonlinear, get, function 1285089b2837SJed Brown 1286089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1287089b2837SJed Brown @*/ 1288089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1289089b2837SJed Brown { 1290089b2837SJed Brown PetscErrorCode ierr; 1291089b2837SJed Brown SNES snes; 129224989b8cSPeter Brune DM dm; 1293089b2837SJed Brown 1294089b2837SJed Brown PetscFunctionBegin; 1295089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1296089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12970298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 129824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 129924989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1300089b2837SJed Brown PetscFunctionReturn(0); 1301089b2837SJed Brown } 1302089b2837SJed Brown 1303089b2837SJed Brown /*@C 1304089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1305089b2837SJed Brown 1306089b2837SJed Brown Not Collective 1307089b2837SJed Brown 1308089b2837SJed Brown Input Parameter: 1309089b2837SJed Brown . ts - the TS context 1310089b2837SJed Brown 1311089b2837SJed Brown Output Parameter: 13120298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13130298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13140298fd71SBarry Smith - ctx - the function context (or NULL) 1315089b2837SJed Brown 1316089b2837SJed Brown Level: advanced 1317089b2837SJed Brown 1318089b2837SJed Brown .keywords: TS, nonlinear, get, function 1319089b2837SJed Brown 13202bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1321089b2837SJed Brown @*/ 1322089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1323089b2837SJed Brown { 1324089b2837SJed Brown PetscErrorCode ierr; 1325089b2837SJed Brown SNES snes; 132624989b8cSPeter Brune DM dm; 1327089b2837SJed Brown 1328089b2837SJed Brown PetscFunctionBegin; 1329089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1330089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13310298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 133224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 133324989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1334316643e7SJed Brown PetscFunctionReturn(0); 1335316643e7SJed Brown } 1336316643e7SJed Brown 1337316643e7SJed Brown /*@C 1338a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1339ae8867d6SBarry Smith provided with TSSetIFunction(). 1340316643e7SJed Brown 13413f9fe445SBarry Smith Logically Collective on TS 1342316643e7SJed Brown 1343316643e7SJed Brown Input Parameters: 1344316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1345e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1346e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1347316643e7SJed Brown . f - the Jacobian evaluation routine 13480298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1349316643e7SJed Brown 1350316643e7SJed Brown Calling sequence of f: 1351ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1352316643e7SJed Brown 1353316643e7SJed Brown + t - time at step/stage being solved 13541b4a444bSJed Brown . U - state vector 13551b4a444bSJed Brown . U_t - time derivative of state vector 1356316643e7SJed Brown . a - shift 1357e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1358e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1359316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1360316643e7SJed Brown 1361316643e7SJed Brown Notes: 1362e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1363316643e7SJed Brown 1364895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1365895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1366895c21f2SBarry Smith 1367a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1368b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1369a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1370a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1371a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1372a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1373a4f0a591SBarry Smith 13746cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 13756cd88445SBarry Smith 13766cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1377ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1378ca5f011dSBarry Smith 1379316643e7SJed Brown Level: beginner 1380316643e7SJed Brown 1381316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1382316643e7SJed Brown 1383ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1384316643e7SJed Brown 1385316643e7SJed Brown @*/ 1386e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1387316643e7SJed Brown { 1388316643e7SJed Brown PetscErrorCode ierr; 1389089b2837SJed Brown SNES snes; 139024989b8cSPeter Brune DM dm; 1391316643e7SJed Brown 1392316643e7SJed Brown PetscFunctionBegin; 13930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1394e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1395e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1396e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1397e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 139824989b8cSPeter Brune 139924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 140024989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 140124989b8cSPeter Brune 1402089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1403e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1404316643e7SJed Brown PetscFunctionReturn(0); 1405316643e7SJed Brown } 1406316643e7SJed Brown 1407e1244c69SJed Brown /*@ 1408e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1409e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1410e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1411e1244c69SJed Brown not been changed by the TS. 1412e1244c69SJed Brown 1413e1244c69SJed Brown Logically Collective 1414e1244c69SJed Brown 1415e1244c69SJed Brown Input Arguments: 1416e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1417e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1418e1244c69SJed Brown 1419e1244c69SJed Brown Level: intermediate 1420e1244c69SJed Brown 1421e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1422e1244c69SJed Brown @*/ 1423e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1424e1244c69SJed Brown { 1425e1244c69SJed Brown PetscFunctionBegin; 1426e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1427e1244c69SJed Brown PetscFunctionReturn(0); 1428e1244c69SJed Brown } 1429e1244c69SJed Brown 1430efe9872eSLisandro Dalcin /*@C 1431efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1432efe9872eSLisandro Dalcin 1433efe9872eSLisandro Dalcin Logically Collective on TS 1434efe9872eSLisandro Dalcin 1435efe9872eSLisandro Dalcin Input Parameters: 1436efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1437efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1438efe9872eSLisandro Dalcin . fun - the function evaluation routine 1439efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1440efe9872eSLisandro Dalcin 1441efe9872eSLisandro Dalcin Calling sequence of fun: 1442efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1443efe9872eSLisandro Dalcin 1444efe9872eSLisandro Dalcin + t - time at step/stage being solved 1445efe9872eSLisandro Dalcin . U - state vector 1446efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1447efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1448efe9872eSLisandro Dalcin . F - function vector 1449efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1450efe9872eSLisandro Dalcin 1451efe9872eSLisandro Dalcin Level: beginner 1452efe9872eSLisandro Dalcin 1453efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1454efe9872eSLisandro Dalcin 1455efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1456efe9872eSLisandro Dalcin @*/ 1457efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1458efe9872eSLisandro Dalcin { 1459efe9872eSLisandro Dalcin DM dm; 1460efe9872eSLisandro Dalcin PetscErrorCode ierr; 1461efe9872eSLisandro Dalcin 1462efe9872eSLisandro Dalcin PetscFunctionBegin; 1463efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1464efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1465efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1466efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1467efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1468efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1469efe9872eSLisandro Dalcin } 1470efe9872eSLisandro Dalcin 1471efe9872eSLisandro Dalcin /*@C 1472efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1473efe9872eSLisandro Dalcin 1474efe9872eSLisandro Dalcin Not Collective 1475efe9872eSLisandro Dalcin 1476efe9872eSLisandro Dalcin Input Parameter: 1477efe9872eSLisandro Dalcin . ts - the TS context 1478efe9872eSLisandro Dalcin 1479efe9872eSLisandro Dalcin Output Parameter: 1480efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1481efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1482efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1483efe9872eSLisandro Dalcin 1484efe9872eSLisandro Dalcin Level: advanced 1485efe9872eSLisandro Dalcin 1486efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1487efe9872eSLisandro Dalcin 1488efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1489efe9872eSLisandro Dalcin @*/ 1490efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1491efe9872eSLisandro Dalcin { 1492efe9872eSLisandro Dalcin PetscErrorCode ierr; 1493efe9872eSLisandro Dalcin SNES snes; 1494efe9872eSLisandro Dalcin DM dm; 1495efe9872eSLisandro Dalcin 1496efe9872eSLisandro Dalcin PetscFunctionBegin; 1497efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1498efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1499efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1500efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1501efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1502efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1503efe9872eSLisandro Dalcin } 1504efe9872eSLisandro Dalcin 1505efe9872eSLisandro Dalcin /*@C 1506bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1507efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1508efe9872eSLisandro Dalcin 1509efe9872eSLisandro Dalcin Logically Collective on TS 1510efe9872eSLisandro Dalcin 1511efe9872eSLisandro Dalcin Input Parameters: 1512efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1513efe9872eSLisandro Dalcin . J - Jacobian matrix 1514efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1515efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1516efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1517efe9872eSLisandro Dalcin 1518efe9872eSLisandro Dalcin Calling sequence of jac: 1519bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1520efe9872eSLisandro Dalcin 1521efe9872eSLisandro Dalcin + t - time at step/stage being solved 1522efe9872eSLisandro Dalcin . U - state vector 1523efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1524efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1525efe9872eSLisandro Dalcin . v - shift for U_t 1526efe9872eSLisandro Dalcin . a - shift for U_tt 1527efe9872eSLisandro 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 1528efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1529efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1530efe9872eSLisandro Dalcin 1531efe9872eSLisandro Dalcin Notes: 1532efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1533efe9872eSLisandro Dalcin 1534efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1535efe9872eSLisandro 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. 1536efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1537bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1538efe9872eSLisandro Dalcin 1539efe9872eSLisandro Dalcin Level: beginner 1540efe9872eSLisandro Dalcin 1541efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1542efe9872eSLisandro Dalcin 1543efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1544efe9872eSLisandro Dalcin @*/ 1545efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1546efe9872eSLisandro Dalcin { 1547efe9872eSLisandro Dalcin DM dm; 1548efe9872eSLisandro Dalcin PetscErrorCode ierr; 1549efe9872eSLisandro Dalcin 1550efe9872eSLisandro Dalcin PetscFunctionBegin; 1551efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1552efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1553efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1554efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1555efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1556efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1557efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1558efe9872eSLisandro Dalcin } 1559efe9872eSLisandro Dalcin 1560efe9872eSLisandro Dalcin /*@C 1561efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1562efe9872eSLisandro Dalcin 1563efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1564efe9872eSLisandro Dalcin 1565efe9872eSLisandro Dalcin Input Parameter: 1566efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1567efe9872eSLisandro Dalcin 1568efe9872eSLisandro Dalcin Output Parameters: 1569efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1570efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1571efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1572efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1573efe9872eSLisandro Dalcin 1574efe9872eSLisandro Dalcin Notes: You can pass in NULL for any return argument you do not need. 1575efe9872eSLisandro Dalcin 1576efe9872eSLisandro Dalcin Level: advanced 1577efe9872eSLisandro Dalcin 1578efe9872eSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 1579efe9872eSLisandro Dalcin 1580efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1581efe9872eSLisandro Dalcin @*/ 1582efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1583efe9872eSLisandro Dalcin { 1584efe9872eSLisandro Dalcin PetscErrorCode ierr; 1585efe9872eSLisandro Dalcin SNES snes; 1586efe9872eSLisandro Dalcin DM dm; 1587efe9872eSLisandro Dalcin 1588efe9872eSLisandro Dalcin PetscFunctionBegin; 1589efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1590efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1591efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1592efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1593efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1594efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1595efe9872eSLisandro Dalcin } 1596efe9872eSLisandro Dalcin 1597efe9872eSLisandro Dalcin /*@ 1598efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1599efe9872eSLisandro Dalcin 1600efe9872eSLisandro Dalcin Collective on TS and Vec 1601efe9872eSLisandro Dalcin 1602efe9872eSLisandro Dalcin Input Parameters: 1603efe9872eSLisandro Dalcin + ts - the TS context 1604efe9872eSLisandro Dalcin . t - current time 1605efe9872eSLisandro Dalcin . U - state vector 1606efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1607efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1608efe9872eSLisandro Dalcin 1609efe9872eSLisandro Dalcin Output Parameter: 1610efe9872eSLisandro Dalcin . F - the residual vector 1611efe9872eSLisandro Dalcin 1612efe9872eSLisandro Dalcin Note: 1613efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1614efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1615efe9872eSLisandro Dalcin 1616efe9872eSLisandro Dalcin Level: developer 1617efe9872eSLisandro Dalcin 1618efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1619efe9872eSLisandro Dalcin 1620efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1621efe9872eSLisandro Dalcin @*/ 1622efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1623efe9872eSLisandro Dalcin { 1624efe9872eSLisandro Dalcin DM dm; 1625efe9872eSLisandro Dalcin TSI2Function I2Function; 1626efe9872eSLisandro Dalcin void *ctx; 1627efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1628efe9872eSLisandro Dalcin PetscErrorCode ierr; 1629efe9872eSLisandro Dalcin 1630efe9872eSLisandro Dalcin PetscFunctionBegin; 1631efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1632efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1633efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1634efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1635efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1636efe9872eSLisandro Dalcin 1637efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1638efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1639efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1640efe9872eSLisandro Dalcin 1641efe9872eSLisandro Dalcin if (!I2Function) { 1642efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1643efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1644efe9872eSLisandro Dalcin } 1645efe9872eSLisandro Dalcin 1646efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1647efe9872eSLisandro Dalcin 1648efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1649efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1650efe9872eSLisandro Dalcin PetscStackPop; 1651efe9872eSLisandro Dalcin 1652efe9872eSLisandro Dalcin if (rhsfunction) { 1653efe9872eSLisandro Dalcin Vec Frhs; 1654efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1655efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1656efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1657efe9872eSLisandro Dalcin } 1658efe9872eSLisandro Dalcin 1659efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1660efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1661efe9872eSLisandro Dalcin } 1662efe9872eSLisandro Dalcin 1663efe9872eSLisandro Dalcin /*@ 1664efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1665efe9872eSLisandro Dalcin 1666efe9872eSLisandro Dalcin Collective on TS and Vec 1667efe9872eSLisandro Dalcin 1668efe9872eSLisandro Dalcin Input Parameters: 1669efe9872eSLisandro Dalcin + ts - the TS context 1670efe9872eSLisandro Dalcin . t - current timestep 1671efe9872eSLisandro Dalcin . U - state vector 1672efe9872eSLisandro Dalcin . V - time derivative of state vector 1673efe9872eSLisandro Dalcin . A - second time derivative of state vector 1674efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1675efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1676efe9872eSLisandro Dalcin 1677efe9872eSLisandro Dalcin Output Parameters: 1678efe9872eSLisandro Dalcin + J - Jacobian matrix 1679efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1680efe9872eSLisandro Dalcin 1681efe9872eSLisandro Dalcin Notes: 1682efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1683efe9872eSLisandro Dalcin 1684efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1685efe9872eSLisandro Dalcin 1686efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1687efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1688efe9872eSLisandro Dalcin 1689efe9872eSLisandro Dalcin Level: developer 1690efe9872eSLisandro Dalcin 1691efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1692efe9872eSLisandro Dalcin 1693efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1694efe9872eSLisandro Dalcin @*/ 1695efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1696efe9872eSLisandro Dalcin { 1697efe9872eSLisandro Dalcin DM dm; 1698efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1699efe9872eSLisandro Dalcin void *ctx; 1700efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1701efe9872eSLisandro Dalcin PetscErrorCode ierr; 1702efe9872eSLisandro Dalcin 1703efe9872eSLisandro Dalcin PetscFunctionBegin; 1704efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1705efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1706efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1707efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1708efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1709efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1710efe9872eSLisandro Dalcin 1711efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1712efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1713efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1714efe9872eSLisandro Dalcin 1715efe9872eSLisandro Dalcin if (!I2Jacobian) { 1716efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1717efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1718efe9872eSLisandro Dalcin } 1719efe9872eSLisandro Dalcin 1720efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1721efe9872eSLisandro Dalcin 1722efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1723efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1724efe9872eSLisandro Dalcin PetscStackPop; 1725efe9872eSLisandro Dalcin 1726efe9872eSLisandro Dalcin if (rhsjacobian) { 1727efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1728efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1729efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1730efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1731efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1732efe9872eSLisandro Dalcin } 1733efe9872eSLisandro Dalcin 1734efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1735efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1736efe9872eSLisandro Dalcin } 1737efe9872eSLisandro Dalcin 1738efe9872eSLisandro Dalcin /*@ 1739efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1740efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1741efe9872eSLisandro Dalcin 1742efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1743efe9872eSLisandro Dalcin 1744efe9872eSLisandro Dalcin Input Parameters: 1745efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1746efe9872eSLisandro Dalcin . u - the solution vector 1747efe9872eSLisandro Dalcin - v - the time derivative vector 1748efe9872eSLisandro Dalcin 1749efe9872eSLisandro Dalcin Level: beginner 1750efe9872eSLisandro Dalcin 1751efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1752efe9872eSLisandro Dalcin @*/ 1753efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1754efe9872eSLisandro Dalcin { 1755efe9872eSLisandro Dalcin PetscErrorCode ierr; 1756efe9872eSLisandro Dalcin 1757efe9872eSLisandro Dalcin PetscFunctionBegin; 1758efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1759efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1760efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1761efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1762efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1763efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1764efe9872eSLisandro Dalcin ts->vec_dot = v; 1765efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1766efe9872eSLisandro Dalcin } 1767efe9872eSLisandro Dalcin 1768efe9872eSLisandro Dalcin /*@ 1769efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1770efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1771efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1772efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1773efe9872eSLisandro Dalcin 1774efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1775efe9872eSLisandro Dalcin 1776efe9872eSLisandro Dalcin Input Parameter: 1777efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1778efe9872eSLisandro Dalcin 1779efe9872eSLisandro Dalcin Output Parameter: 1780efe9872eSLisandro Dalcin + u - the vector containing the solution 1781efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1782efe9872eSLisandro Dalcin 1783efe9872eSLisandro Dalcin Level: intermediate 1784efe9872eSLisandro Dalcin 1785efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1786efe9872eSLisandro Dalcin 1787efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1788efe9872eSLisandro Dalcin @*/ 1789efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1790efe9872eSLisandro Dalcin { 1791efe9872eSLisandro Dalcin PetscFunctionBegin; 1792efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1793efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1794efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1795efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1796efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1797efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1798efe9872eSLisandro Dalcin } 1799efe9872eSLisandro Dalcin 180055849f57SBarry Smith /*@C 180155849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 180255849f57SBarry Smith 180355849f57SBarry Smith Collective on PetscViewer 180455849f57SBarry Smith 180555849f57SBarry Smith Input Parameters: 180655849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 180755849f57SBarry Smith some related function before a call to TSLoad(). 180855849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 180955849f57SBarry Smith 181055849f57SBarry Smith Level: intermediate 181155849f57SBarry Smith 181255849f57SBarry Smith Notes: 181355849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 181455849f57SBarry Smith 181555849f57SBarry Smith Notes for advanced users: 181655849f57SBarry Smith Most users should not need to know the details of the binary storage 181755849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 181855849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 181955849f57SBarry Smith format is 182055849f57SBarry Smith .vb 182155849f57SBarry Smith has not yet been determined 182255849f57SBarry Smith .ve 182355849f57SBarry Smith 182455849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 182555849f57SBarry Smith @*/ 1826f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 182755849f57SBarry Smith { 182855849f57SBarry Smith PetscErrorCode ierr; 182955849f57SBarry Smith PetscBool isbinary; 183055849f57SBarry Smith PetscInt classid; 183155849f57SBarry Smith char type[256]; 18322d53ad75SBarry Smith DMTS sdm; 1833ad6bc421SBarry Smith DM dm; 183455849f57SBarry Smith 183555849f57SBarry Smith PetscFunctionBegin; 1836f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 183755849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 183855849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 183955849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 184055849f57SBarry Smith 1841060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1842ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1843060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1844f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1845f2c2a1b9SBarry Smith if (ts->ops->load) { 1846f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1847f2c2a1b9SBarry Smith } 1848ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1849ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1850ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1851f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1852f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 18532d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 18542d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 185555849f57SBarry Smith PetscFunctionReturn(0); 185655849f57SBarry Smith } 185755849f57SBarry Smith 18589804daf3SBarry Smith #include <petscdraw.h> 1859e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1860e04113cfSBarry Smith #include <petscviewersaws.h> 1861f05ece33SBarry Smith #endif 18627e2c5f70SBarry Smith /*@C 1863d763cef2SBarry Smith TSView - Prints the TS data structure. 1864d763cef2SBarry Smith 18654c49b128SBarry Smith Collective on TS 1866d763cef2SBarry Smith 1867d763cef2SBarry Smith Input Parameters: 1868d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1869d763cef2SBarry Smith - viewer - visualization context 1870d763cef2SBarry Smith 1871d763cef2SBarry Smith Options Database Key: 1872d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1873d763cef2SBarry Smith 1874d763cef2SBarry Smith Notes: 1875d763cef2SBarry Smith The available visualization contexts include 1876b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1877b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1878d763cef2SBarry Smith output where only the first processor opens 1879d763cef2SBarry Smith the file. All other processors send their 1880d763cef2SBarry Smith data to the first processor to print. 1881d763cef2SBarry Smith 1882d763cef2SBarry Smith The user can open an alternative visualization context with 1883b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1884d763cef2SBarry Smith 1885d763cef2SBarry Smith Level: beginner 1886d763cef2SBarry Smith 1887d763cef2SBarry Smith .keywords: TS, timestep, view 1888d763cef2SBarry Smith 1889b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1890d763cef2SBarry Smith @*/ 18917087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1892d763cef2SBarry Smith { 1893dfbe8321SBarry Smith PetscErrorCode ierr; 189419fd82e9SBarry Smith TSType type; 18952b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 18962d53ad75SBarry Smith DMTS sdm; 1897e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1898536b137fSBarry Smith PetscBool issaws; 1899f05ece33SBarry Smith #endif 1900d763cef2SBarry Smith 1901d763cef2SBarry Smith PetscFunctionBegin; 19020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19033050cee2SBarry Smith if (!viewer) { 1904ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 19053050cee2SBarry Smith } 19060700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1907c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1908fd16b177SBarry Smith 1909251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1910251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 191155849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 19122b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1913e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1914536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1915f05ece33SBarry Smith #endif 191632077d6dSBarry Smith if (iascii) { 1917dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 191877431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 19197c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1920d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19215ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1922c610991cSLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr); 1923d763cef2SBarry Smith } 19245ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1925193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1926a0af407cSBarry Smith if (ts->vrtol) { 1927a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1928a0af407cSBarry Smith } else { 1929a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1930a0af407cSBarry Smith } 1931a0af407cSBarry Smith if (ts->vatol) { 1932a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1933a0af407cSBarry Smith } else { 1934a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1935a0af407cSBarry Smith } 19362d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19372d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 1938d52bd9f3SBarry Smith if (ts->ops->view) { 1939d52bd9f3SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1940d52bd9f3SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1941d52bd9f3SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1942d52bd9f3SBarry Smith } 19430f5bd95cSBarry Smith } else if (isstring) { 1944a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1945b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 194655849f57SBarry Smith } else if (isbinary) { 194755849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 194855849f57SBarry Smith MPI_Comm comm; 194955849f57SBarry Smith PetscMPIInt rank; 195055849f57SBarry Smith char type[256]; 195155849f57SBarry Smith 195255849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 195355849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 195455849f57SBarry Smith if (!rank) { 195555849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 195655849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 195755849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 195855849f57SBarry Smith } 195955849f57SBarry Smith if (ts->ops->view) { 196055849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 196155849f57SBarry Smith } 1962f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1963f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 19642d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19652d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19662b0a91c0SBarry Smith } else if (isdraw) { 19672b0a91c0SBarry Smith PetscDraw draw; 19682b0a91c0SBarry Smith char str[36]; 196989fd9fafSBarry Smith PetscReal x,y,bottom,h; 19702b0a91c0SBarry Smith 19712b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 19722b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 19732b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 19742b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 197551fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 197689fd9fafSBarry Smith bottom = y - h; 19772b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 19782b0a91c0SBarry Smith if (ts->ops->view) { 19792b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 19802b0a91c0SBarry Smith } 19812b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1982e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1983536b137fSBarry Smith } else if (issaws) { 1984d45a07a7SBarry Smith PetscMPIInt rank; 19852657e9d9SBarry Smith const char *name; 19862657e9d9SBarry Smith 19872657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1988d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1989d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1990d45a07a7SBarry Smith char dir[1024]; 1991d45a07a7SBarry Smith 1992e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1993a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 19942657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 19952657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 19962657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 1997d763cef2SBarry Smith } 19980acecf5bSBarry Smith if (ts->ops->view) { 19990acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20000acecf5bSBarry Smith } 2001f05ece33SBarry Smith #endif 2002f05ece33SBarry Smith } 2003f05ece33SBarry Smith 2004b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2005251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2006b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2007d763cef2SBarry Smith PetscFunctionReturn(0); 2008d763cef2SBarry Smith } 2009d763cef2SBarry Smith 2010d763cef2SBarry Smith 2011b07ff414SBarry Smith /*@ 2012d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2013d763cef2SBarry Smith the timesteppers. 2014d763cef2SBarry Smith 20153f9fe445SBarry Smith Logically Collective on TS 2016d763cef2SBarry Smith 2017d763cef2SBarry Smith Input Parameters: 2018d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2019d763cef2SBarry Smith - usrP - optional user context 2020d763cef2SBarry Smith 2021daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2022daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2023daf670e6SBarry Smith 2024d763cef2SBarry Smith Level: intermediate 2025d763cef2SBarry Smith 2026d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2027d763cef2SBarry Smith 2028d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2029d763cef2SBarry Smith @*/ 20307087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2031d763cef2SBarry Smith { 2032d763cef2SBarry Smith PetscFunctionBegin; 20330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2034d763cef2SBarry Smith ts->user = usrP; 2035d763cef2SBarry Smith PetscFunctionReturn(0); 2036d763cef2SBarry Smith } 2037d763cef2SBarry Smith 2038b07ff414SBarry Smith /*@ 2039d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2040d763cef2SBarry Smith timestepper. 2041d763cef2SBarry Smith 2042d763cef2SBarry Smith Not Collective 2043d763cef2SBarry Smith 2044d763cef2SBarry Smith Input Parameter: 2045d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2046d763cef2SBarry Smith 2047d763cef2SBarry Smith Output Parameter: 2048d763cef2SBarry Smith . usrP - user context 2049d763cef2SBarry Smith 2050daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2051daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2052daf670e6SBarry Smith 2053d763cef2SBarry Smith Level: intermediate 2054d763cef2SBarry Smith 2055d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2056d763cef2SBarry Smith 2057d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2058d763cef2SBarry Smith @*/ 2059e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2060d763cef2SBarry Smith { 2061d763cef2SBarry Smith PetscFunctionBegin; 20620700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2063e71120c6SJed Brown *(void**)usrP = ts->user; 2064d763cef2SBarry Smith PetscFunctionReturn(0); 2065d763cef2SBarry Smith } 2066d763cef2SBarry Smith 2067d763cef2SBarry Smith /*@ 2068b8123daeSJed Brown TSGetTimeStepNumber - Gets the number of time steps completed. 2069d763cef2SBarry Smith 2070d763cef2SBarry Smith Not Collective 2071d763cef2SBarry Smith 2072d763cef2SBarry Smith Input Parameter: 2073d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2074d763cef2SBarry Smith 2075d763cef2SBarry Smith Output Parameter: 2076b8123daeSJed Brown . iter - number of steps completed so far 2077d763cef2SBarry Smith 2078d763cef2SBarry Smith Level: intermediate 2079d763cef2SBarry Smith 2080d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 20819be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2082d763cef2SBarry Smith @*/ 20837087cfbeSBarry Smith PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *iter) 2084d763cef2SBarry Smith { 2085d763cef2SBarry Smith PetscFunctionBegin; 20860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20874482741eSBarry Smith PetscValidIntPointer(iter,2); 2088d763cef2SBarry Smith *iter = ts->steps; 2089d763cef2SBarry Smith PetscFunctionReturn(0); 2090d763cef2SBarry Smith } 2091d763cef2SBarry Smith 2092d763cef2SBarry Smith /*@ 2093d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 2094d763cef2SBarry Smith as well as the initial time. 2095d763cef2SBarry Smith 20963f9fe445SBarry Smith Logically Collective on TS 2097d763cef2SBarry Smith 2098d763cef2SBarry Smith Input Parameters: 2099d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2100d763cef2SBarry Smith . initial_time - the initial time 2101d763cef2SBarry Smith - time_step - the size of the timestep 2102d763cef2SBarry Smith 2103d763cef2SBarry Smith Level: intermediate 2104d763cef2SBarry Smith 2105d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 2106d763cef2SBarry Smith 2107d763cef2SBarry Smith .keywords: TS, set, initial, timestep 2108d763cef2SBarry Smith @*/ 21097087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2110d763cef2SBarry Smith { 2111e144a568SJed Brown PetscErrorCode ierr; 2112e144a568SJed Brown 2113d763cef2SBarry Smith PetscFunctionBegin; 21140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2115e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2116d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2117d763cef2SBarry Smith PetscFunctionReturn(0); 2118d763cef2SBarry Smith } 2119d763cef2SBarry Smith 2120d763cef2SBarry Smith /*@ 2121d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2122d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2123d763cef2SBarry Smith 21243f9fe445SBarry Smith Logically Collective on TS 2125d763cef2SBarry Smith 2126d763cef2SBarry Smith Input Parameters: 2127d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2128d763cef2SBarry Smith - time_step - the size of the timestep 2129d763cef2SBarry Smith 2130d763cef2SBarry Smith Level: intermediate 2131d763cef2SBarry Smith 2132d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2133d763cef2SBarry Smith 2134d763cef2SBarry Smith .keywords: TS, set, timestep 2135d763cef2SBarry Smith @*/ 21367087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2137d763cef2SBarry Smith { 2138d763cef2SBarry Smith PetscFunctionBegin; 21390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2140c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2141d763cef2SBarry Smith ts->time_step = time_step; 2142d763cef2SBarry Smith PetscFunctionReturn(0); 2143d763cef2SBarry Smith } 2144d763cef2SBarry Smith 2145a43b19c4SJed Brown /*@ 214649354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 214749354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 214849354f04SShri Abhyankar or just return at the final time TS computed. 2149a43b19c4SJed Brown 2150a43b19c4SJed Brown Logically Collective on TS 2151a43b19c4SJed Brown 2152a43b19c4SJed Brown Input Parameter: 2153a43b19c4SJed Brown + ts - the time-step context 215449354f04SShri Abhyankar - eftopt - exact final time option 2155a43b19c4SJed Brown 2156feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2157feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2158feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2159feed9e9dSBarry Smith 2160feed9e9dSBarry Smith Options Database: 2161feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2162feed9e9dSBarry Smith 2163ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2164ee346746SBarry Smith then the final time you selected. 2165ee346746SBarry Smith 2166a43b19c4SJed Brown Level: beginner 2167a43b19c4SJed Brown 2168a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 2169a43b19c4SJed Brown @*/ 217049354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2171a43b19c4SJed Brown { 2172a43b19c4SJed Brown PetscFunctionBegin; 2173a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 217449354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 217549354f04SShri Abhyankar ts->exact_final_time = eftopt; 2176a43b19c4SJed Brown PetscFunctionReturn(0); 2177a43b19c4SJed Brown } 2178a43b19c4SJed Brown 2179d763cef2SBarry Smith /*@ 2180d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2181d763cef2SBarry Smith 2182d763cef2SBarry Smith Not Collective 2183d763cef2SBarry Smith 2184d763cef2SBarry Smith Input Parameter: 2185d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2186d763cef2SBarry Smith 2187d763cef2SBarry Smith Output Parameter: 2188d763cef2SBarry Smith . dt - the current timestep size 2189d763cef2SBarry Smith 2190d763cef2SBarry Smith Level: intermediate 2191d763cef2SBarry Smith 2192d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2193d763cef2SBarry Smith 2194d763cef2SBarry Smith .keywords: TS, get, timestep 2195d763cef2SBarry Smith @*/ 21967087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2197d763cef2SBarry Smith { 2198d763cef2SBarry Smith PetscFunctionBegin; 21990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2200f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2201d763cef2SBarry Smith *dt = ts->time_step; 2202d763cef2SBarry Smith PetscFunctionReturn(0); 2203d763cef2SBarry Smith } 2204d763cef2SBarry Smith 2205d8e5e3e6SSatish Balay /*@ 2206d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2207d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2208d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2209d763cef2SBarry Smith the solution at the next timestep has been calculated. 2210d763cef2SBarry Smith 2211d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2212d763cef2SBarry Smith 2213d763cef2SBarry Smith Input Parameter: 2214d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2215d763cef2SBarry Smith 2216d763cef2SBarry Smith Output Parameter: 2217d763cef2SBarry Smith . v - the vector containing the solution 2218d763cef2SBarry Smith 221963e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 222063e21af5SBarry Smith final time. It returns the solution at the next timestep. 222163e21af5SBarry Smith 2222d763cef2SBarry Smith Level: intermediate 2223d763cef2SBarry Smith 2224b2bf4f3aSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents() 2225d763cef2SBarry Smith 2226d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2227d763cef2SBarry Smith @*/ 22287087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2229d763cef2SBarry Smith { 2230d763cef2SBarry Smith PetscFunctionBegin; 22310700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22324482741eSBarry Smith PetscValidPointer(v,2); 22338737fe31SLisandro Dalcin *v = ts->vec_sol; 2234d763cef2SBarry Smith PetscFunctionReturn(0); 2235d763cef2SBarry Smith } 2236d763cef2SBarry Smith 223703fe5f5eSDebojyoti Ghosh /*@ 2238b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 223903fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2240b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 224103fe5f5eSDebojyoti Ghosh structure as the solution vector. 224203fe5f5eSDebojyoti Ghosh 224303fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 224403fe5f5eSDebojyoti Ghosh 224503fe5f5eSDebojyoti Ghosh Parameters : 224603fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2247b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2248b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 224903fe5f5eSDebojyoti Ghosh returned in v. 2250b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 225103fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2252b2bf4f3aSDebojyoti Ghosh the number of solutions components). 225303fe5f5eSDebojyoti Ghosh 22544cdd57e5SDebojyoti Ghosh Level: advanced 225503fe5f5eSDebojyoti Ghosh 225603fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 225703fe5f5eSDebojyoti Ghosh 225803fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 225903fe5f5eSDebojyoti Ghosh @*/ 2260b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 226103fe5f5eSDebojyoti Ghosh { 226203fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 226303fe5f5eSDebojyoti Ghosh 226403fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 226503fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2266b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 226703fe5f5eSDebojyoti Ghosh else { 2268b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 226903fe5f5eSDebojyoti Ghosh } 227003fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 227103fe5f5eSDebojyoti Ghosh } 227203fe5f5eSDebojyoti Ghosh 22734cdd57e5SDebojyoti Ghosh /*@ 22744cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 22754cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 22764cdd57e5SDebojyoti Ghosh 22774cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 22784cdd57e5SDebojyoti Ghosh 22794cdd57e5SDebojyoti Ghosh Parameters : 22804cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 22814cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 22824cdd57e5SDebojyoti Ghosh 22834cdd57e5SDebojyoti Ghosh Level: intermediate 22844cdd57e5SDebojyoti Ghosh 22854cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 22864cdd57e5SDebojyoti Ghosh 22874cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 22884cdd57e5SDebojyoti Ghosh @*/ 22894cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 22904cdd57e5SDebojyoti Ghosh { 22914cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 22924cdd57e5SDebojyoti Ghosh 22934cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 22944cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2295f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 22964cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2297f6356ec7SDebojyoti Ghosh } else { 2298f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2299f6356ec7SDebojyoti Ghosh } 23004cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23014cdd57e5SDebojyoti Ghosh } 23024cdd57e5SDebojyoti Ghosh 23034cdd57e5SDebojyoti Ghosh /*@ 23044cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 23054cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 23064cdd57e5SDebojyoti Ghosh 23074cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23084cdd57e5SDebojyoti Ghosh 23099657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 23109657682dSDebojyoti Ghosh 23114cdd57e5SDebojyoti Ghosh Parameters : 23124cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2313657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 23144cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 23154cdd57e5SDebojyoti Ghosh 23164cdd57e5SDebojyoti Ghosh Level: intermediate 23174cdd57e5SDebojyoti Ghosh 231857df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 23194cdd57e5SDebojyoti Ghosh 23204cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 23214cdd57e5SDebojyoti Ghosh @*/ 23220a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 23234cdd57e5SDebojyoti Ghosh { 23244cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23254cdd57e5SDebojyoti Ghosh 23264cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23274cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2328f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 23290a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2330f6356ec7SDebojyoti Ghosh } else { 2331f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2332f6356ec7SDebojyoti Ghosh } 23334cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23344cdd57e5SDebojyoti Ghosh } 23354cdd57e5SDebojyoti Ghosh 233657df6a1bSDebojyoti Ghosh /*@ 233757df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 233857df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 233957df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 234057df6a1bSDebojyoti Ghosh 234157df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 234257df6a1bSDebojyoti Ghosh 234357df6a1bSDebojyoti Ghosh Parameters : 234457df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 234557df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 234657df6a1bSDebojyoti Ghosh 234757df6a1bSDebojyoti Ghosh Level: intermediate 234857df6a1bSDebojyoti Ghosh 234957df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 235057df6a1bSDebojyoti Ghosh 235157df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 235257df6a1bSDebojyoti Ghosh @*/ 235357df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 235457df6a1bSDebojyoti Ghosh { 235557df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 235657df6a1bSDebojyoti Ghosh 235757df6a1bSDebojyoti Ghosh PetscFunctionBegin; 235857df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23599657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 236057df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 236157df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 236257df6a1bSDebojyoti Ghosh } 236357df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 236457df6a1bSDebojyoti Ghosh } 236557df6a1bSDebojyoti Ghosh 2366c235aa8dSHong Zhang /*@ 2367dfb21088SHong Zhang TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2368c235aa8dSHong Zhang 2369c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 2370c235aa8dSHong Zhang 2371c235aa8dSHong Zhang Input Parameter: 2372c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 2373c235aa8dSHong Zhang 2374c235aa8dSHong Zhang Output Parameter: 2375abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2376abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2377c235aa8dSHong Zhang 2378c235aa8dSHong Zhang Level: intermediate 2379c235aa8dSHong Zhang 2380c235aa8dSHong Zhang .seealso: TSGetTimeStep() 2381c235aa8dSHong Zhang 2382c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 2383c235aa8dSHong Zhang @*/ 2384dfb21088SHong Zhang PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2385c235aa8dSHong Zhang { 2386c235aa8dSHong Zhang PetscFunctionBegin; 2387c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2388abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 2389abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 2390abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 2391c235aa8dSHong Zhang PetscFunctionReturn(0); 2392c235aa8dSHong Zhang } 2393c235aa8dSHong Zhang 2394bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2395d8e5e3e6SSatish Balay /*@ 2396bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2397d763cef2SBarry Smith 2398bdad233fSMatthew Knepley Not collective 2399d763cef2SBarry Smith 2400bdad233fSMatthew Knepley Input Parameters: 2401bdad233fSMatthew Knepley + ts - The TS 2402bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2403d763cef2SBarry Smith .vb 24040910c330SBarry Smith U_t - A U = 0 (linear) 24050910c330SBarry Smith U_t - A(t) U = 0 (linear) 24060910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2407d763cef2SBarry Smith .ve 2408d763cef2SBarry Smith 2409d763cef2SBarry Smith Level: beginner 2410d763cef2SBarry Smith 2411bdad233fSMatthew Knepley .keywords: TS, problem type 2412bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2413d763cef2SBarry Smith @*/ 24147087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2415a7cc72afSBarry Smith { 24169e2a6581SJed Brown PetscErrorCode ierr; 24179e2a6581SJed Brown 2418d763cef2SBarry Smith PetscFunctionBegin; 24190700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2420bdad233fSMatthew Knepley ts->problem_type = type; 24219e2a6581SJed Brown if (type == TS_LINEAR) { 24229e2a6581SJed Brown SNES snes; 24239e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 24249e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 24259e2a6581SJed Brown } 2426d763cef2SBarry Smith PetscFunctionReturn(0); 2427d763cef2SBarry Smith } 2428d763cef2SBarry Smith 2429bdad233fSMatthew Knepley /*@C 2430bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2431bdad233fSMatthew Knepley 2432bdad233fSMatthew Knepley Not collective 2433bdad233fSMatthew Knepley 2434bdad233fSMatthew Knepley Input Parameter: 2435bdad233fSMatthew Knepley . ts - The TS 2436bdad233fSMatthew Knepley 2437bdad233fSMatthew Knepley Output Parameter: 2438bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2439bdad233fSMatthew Knepley .vb 2440089b2837SJed Brown M U_t = A U 2441089b2837SJed Brown M(t) U_t = A(t) U 2442b5abc632SBarry Smith F(t,U,U_t) 2443bdad233fSMatthew Knepley .ve 2444bdad233fSMatthew Knepley 2445bdad233fSMatthew Knepley Level: beginner 2446bdad233fSMatthew Knepley 2447bdad233fSMatthew Knepley .keywords: TS, problem type 2448bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2449bdad233fSMatthew Knepley @*/ 24507087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2451a7cc72afSBarry Smith { 2452bdad233fSMatthew Knepley PetscFunctionBegin; 24530700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 24544482741eSBarry Smith PetscValidIntPointer(type,2); 2455bdad233fSMatthew Knepley *type = ts->problem_type; 2456bdad233fSMatthew Knepley PetscFunctionReturn(0); 2457bdad233fSMatthew Knepley } 2458d763cef2SBarry Smith 2459d763cef2SBarry Smith /*@ 2460d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2461d763cef2SBarry Smith of a timestepper. 2462d763cef2SBarry Smith 2463d763cef2SBarry Smith Collective on TS 2464d763cef2SBarry Smith 2465d763cef2SBarry Smith Input Parameter: 2466d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2467d763cef2SBarry Smith 2468d763cef2SBarry Smith Notes: 2469d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2470d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2471d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 2472d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2473d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 2474d763cef2SBarry Smith 2475d763cef2SBarry Smith Level: advanced 2476d763cef2SBarry Smith 2477d763cef2SBarry Smith .keywords: TS, timestep, setup 2478d763cef2SBarry Smith 2479d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 2480d763cef2SBarry Smith @*/ 24817087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2482d763cef2SBarry Smith { 2483dfbe8321SBarry Smith PetscErrorCode ierr; 24846c6b9e74SPeter Brune DM dm; 24856c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2486d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2487cd11d68dSLisandro Dalcin TSIFunction ifun; 24886c6b9e74SPeter Brune TSIJacobian ijac; 2489efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 24906c6b9e74SPeter Brune TSRHSJacobian rhsjac; 24912ffb9264SLisandro Dalcin PetscBool isnone; 2492d763cef2SBarry Smith 2493d763cef2SBarry Smith PetscFunctionBegin; 24940700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2495277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2496277b19d0SLisandro Dalcin 24977adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2498cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2499cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2500d763cef2SBarry Smith } 2501277b19d0SLisandro Dalcin 2502277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2503277b19d0SLisandro Dalcin 2504e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 2505e1244c69SJed Brown Mat Amat,Pmat; 2506e1244c69SJed Brown SNES snes; 2507e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2508e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2509e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2510e1244c69SJed Brown * have displaced the RHS matrix */ 2511e1244c69SJed Brown if (Amat == ts->Arhs) { 2512e1244c69SJed Brown ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2513e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2514e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2515e1244c69SJed Brown } 2516e1244c69SJed Brown if (Pmat == ts->Brhs) { 2517e1244c69SJed Brown ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2518e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2519e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2520e1244c69SJed Brown } 2521e1244c69SJed Brown } 25222ffb9264SLisandro Dalcin 25232ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 25242ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 25252ffb9264SLisandro Dalcin 2526277b19d0SLisandro Dalcin if (ts->ops->setup) { 2527000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2528277b19d0SLisandro Dalcin } 2529277b19d0SLisandro Dalcin 25302ffb9264SLisandro Dalcin /* Attempt to check/preset a default value for the exact final time option */ 25312ffb9264SLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 25322ffb9264SLisandro Dalcin if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) 25332ffb9264SLisandro Dalcin ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 25342ffb9264SLisandro Dalcin 2535a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 25366c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 25376c6b9e74SPeter Brune */ 25386c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 25390298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 25406c6b9e74SPeter Brune if (!func) { 25416c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 25426c6b9e74SPeter Brune } 2543a6772fa2SLisandro 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. 25446c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 25456c6b9e74SPeter Brune */ 25460298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 25470298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2548efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 25490298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2550efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 25516c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 25526c6b9e74SPeter Brune } 2553c0517034SDebojyoti Ghosh 2554c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2555c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2556c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2557c0517034SDebojyoti Ghosh } 2558c0517034SDebojyoti Ghosh 2559277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2560277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2561277b19d0SLisandro Dalcin } 2562277b19d0SLisandro Dalcin 2563f6a906c0SBarry Smith /*@ 2564f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 2565f6a906c0SBarry Smith of an adjoint solver 2566f6a906c0SBarry Smith 2567f6a906c0SBarry Smith Collective on TS 2568f6a906c0SBarry Smith 2569f6a906c0SBarry Smith Input Parameter: 2570f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 2571f6a906c0SBarry Smith 2572f6a906c0SBarry Smith Level: advanced 2573f6a906c0SBarry Smith 2574f6a906c0SBarry Smith .keywords: TS, timestep, setup 2575f6a906c0SBarry Smith 2576947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2577f6a906c0SBarry Smith @*/ 2578f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 2579f6a906c0SBarry Smith { 2580f6a906c0SBarry Smith PetscErrorCode ierr; 2581f6a906c0SBarry Smith 2582f6a906c0SBarry Smith PetscFunctionBegin; 2583f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2584f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 2585dfb21088SHong Zhang if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2586d8151eeaSBarry Smith 2587947abb85SHong Zhang if (ts->vec_costintegral) { /* if there is integral in the cost function*/ 2588d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2589d8151eeaSBarry Smith if (ts->vecs_sensip){ 2590d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2591d8151eeaSBarry Smith } 2592947abb85SHong Zhang } 2593d8151eeaSBarry Smith 259442f2b339SBarry Smith if (ts->ops->adjointsetup) { 259542f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2596f6a906c0SBarry Smith } 2597f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 2598f6a906c0SBarry Smith PetscFunctionReturn(0); 2599f6a906c0SBarry Smith } 2600f6a906c0SBarry Smith 2601277b19d0SLisandro Dalcin /*@ 2602277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2603277b19d0SLisandro Dalcin 2604277b19d0SLisandro Dalcin Collective on TS 2605277b19d0SLisandro Dalcin 2606277b19d0SLisandro Dalcin Input Parameter: 2607277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2608277b19d0SLisandro Dalcin 2609277b19d0SLisandro Dalcin Level: beginner 2610277b19d0SLisandro Dalcin 2611277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2612277b19d0SLisandro Dalcin 2613277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2614277b19d0SLisandro Dalcin @*/ 2615277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2616277b19d0SLisandro Dalcin { 2617277b19d0SLisandro Dalcin PetscErrorCode ierr; 2618277b19d0SLisandro Dalcin 2619277b19d0SLisandro Dalcin PetscFunctionBegin; 2620277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2621b18ea86cSHong Zhang 2622277b19d0SLisandro Dalcin if (ts->ops->reset) { 2623277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2624277b19d0SLisandro Dalcin } 2625277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2626e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2627bbd56ea5SKarl Rupp 26284e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 26294e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2630214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 26316bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2632efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2633e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2634e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 263538637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2636bbd56ea5SKarl Rupp 2637947abb85SHong Zhang if (ts->vec_costintegral) { 2638d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2639d8151eeaSBarry Smith if (ts->vecs_drdp){ 2640d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2641d8151eeaSBarry Smith } 2642947abb85SHong Zhang } 2643d8151eeaSBarry Smith ts->vecs_sensi = NULL; 2644d8151eeaSBarry Smith ts->vecs_sensip = NULL; 2645ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 26462c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 264736eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2648277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2649d763cef2SBarry Smith PetscFunctionReturn(0); 2650d763cef2SBarry Smith } 2651d763cef2SBarry Smith 2652d8e5e3e6SSatish Balay /*@ 2653d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2654d763cef2SBarry Smith with TSCreate(). 2655d763cef2SBarry Smith 2656d763cef2SBarry Smith Collective on TS 2657d763cef2SBarry Smith 2658d763cef2SBarry Smith Input Parameter: 2659d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2660d763cef2SBarry Smith 2661d763cef2SBarry Smith Level: beginner 2662d763cef2SBarry Smith 2663d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2664d763cef2SBarry Smith 2665d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2666d763cef2SBarry Smith @*/ 26676bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2668d763cef2SBarry Smith { 26696849ba73SBarry Smith PetscErrorCode ierr; 2670d763cef2SBarry Smith 2671d763cef2SBarry Smith PetscFunctionBegin; 26726bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 26736bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 26746bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2675d763cef2SBarry Smith 26766bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2677277b19d0SLisandro Dalcin 2678e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2679e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 26806bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 26816d4c513bSLisandro Dalcin 2682bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2683bc952696SBarry Smith 268484df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 26856427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 26866427ac75SLisandro Dalcin 26876bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 26886bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 26896bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 26900dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 26916d4c513bSLisandro Dalcin 2692a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2693d763cef2SBarry Smith PetscFunctionReturn(0); 2694d763cef2SBarry Smith } 2695d763cef2SBarry Smith 2696d8e5e3e6SSatish Balay /*@ 2697d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2698d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2699d763cef2SBarry Smith 2700d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2701d763cef2SBarry Smith 2702d763cef2SBarry Smith Input Parameter: 2703d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2704d763cef2SBarry Smith 2705d763cef2SBarry Smith Output Parameter: 2706d763cef2SBarry Smith . snes - the nonlinear solver context 2707d763cef2SBarry Smith 2708d763cef2SBarry Smith Notes: 2709d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2710d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 271194b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2712d763cef2SBarry Smith 2713d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 27140298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2715d763cef2SBarry Smith 2716d763cef2SBarry Smith Level: beginner 2717d763cef2SBarry Smith 2718d763cef2SBarry Smith .keywords: timestep, get, SNES 2719d763cef2SBarry Smith @*/ 27207087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2721d763cef2SBarry Smith { 2722d372ba47SLisandro Dalcin PetscErrorCode ierr; 2723d372ba47SLisandro Dalcin 2724d763cef2SBarry Smith PetscFunctionBegin; 27250700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27264482741eSBarry Smith PetscValidPointer(snes,2); 2727d372ba47SLisandro Dalcin if (!ts->snes) { 2728ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 27290298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27303bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2731d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2732496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 27339e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 27349e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 27359e2a6581SJed Brown } 2736d372ba47SLisandro Dalcin } 2737d763cef2SBarry Smith *snes = ts->snes; 2738d763cef2SBarry Smith PetscFunctionReturn(0); 2739d763cef2SBarry Smith } 2740d763cef2SBarry Smith 2741deb2cd25SJed Brown /*@ 2742deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2743deb2cd25SJed Brown 2744deb2cd25SJed Brown Collective 2745deb2cd25SJed Brown 2746deb2cd25SJed Brown Input Parameter: 2747deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2748deb2cd25SJed Brown - snes - the nonlinear solver context 2749deb2cd25SJed Brown 2750deb2cd25SJed Brown Notes: 2751deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2752deb2cd25SJed Brown 2753deb2cd25SJed Brown Level: developer 2754deb2cd25SJed Brown 2755deb2cd25SJed Brown .keywords: timestep, set, SNES 2756deb2cd25SJed Brown @*/ 2757deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2758deb2cd25SJed Brown { 2759deb2cd25SJed Brown PetscErrorCode ierr; 2760d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2761deb2cd25SJed Brown 2762deb2cd25SJed Brown PetscFunctionBegin; 2763deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2764deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2765deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2766deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2767bbd56ea5SKarl Rupp 2768deb2cd25SJed Brown ts->snes = snes; 2769bbd56ea5SKarl Rupp 27700298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27710298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2772740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 27730298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2774740132f1SEmil Constantinescu } 2775deb2cd25SJed Brown PetscFunctionReturn(0); 2776deb2cd25SJed Brown } 2777deb2cd25SJed Brown 2778d8e5e3e6SSatish Balay /*@ 277994b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2780d763cef2SBarry Smith a TS (timestepper) context. 2781d763cef2SBarry Smith 278294b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2783d763cef2SBarry Smith 2784d763cef2SBarry Smith Input Parameter: 2785d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2786d763cef2SBarry Smith 2787d763cef2SBarry Smith Output Parameter: 278894b7f48cSBarry Smith . ksp - the nonlinear solver context 2789d763cef2SBarry Smith 2790d763cef2SBarry Smith Notes: 279194b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2792d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2793d763cef2SBarry Smith KSP and PC contexts as well. 2794d763cef2SBarry Smith 279594b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 27960298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2797d763cef2SBarry Smith 2798d763cef2SBarry Smith Level: beginner 2799d763cef2SBarry Smith 280094b7f48cSBarry Smith .keywords: timestep, get, KSP 2801d763cef2SBarry Smith @*/ 28027087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2803d763cef2SBarry Smith { 2804d372ba47SLisandro Dalcin PetscErrorCode ierr; 2805089b2837SJed Brown SNES snes; 2806d372ba47SLisandro Dalcin 2807d763cef2SBarry Smith PetscFunctionBegin; 28080700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28094482741eSBarry Smith PetscValidPointer(ksp,2); 281017186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2811e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2812089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2813089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2814d763cef2SBarry Smith PetscFunctionReturn(0); 2815d763cef2SBarry Smith } 2816d763cef2SBarry Smith 2817d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2818d763cef2SBarry Smith 2819adb62b0dSMatthew Knepley /*@ 2820adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 2821adb62b0dSMatthew Knepley maximum time for iteration. 2822adb62b0dSMatthew Knepley 28233f9fe445SBarry Smith Not Collective 2824adb62b0dSMatthew Knepley 2825adb62b0dSMatthew Knepley Input Parameters: 2826adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 28270298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 28280298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 2829adb62b0dSMatthew Knepley 2830adb62b0dSMatthew Knepley Level: intermediate 2831adb62b0dSMatthew Knepley 2832adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 2833adb62b0dSMatthew Knepley @*/ 28347087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2835adb62b0dSMatthew Knepley { 2836adb62b0dSMatthew Knepley PetscFunctionBegin; 28370700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2838abc0a331SBarry Smith if (maxsteps) { 28394482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2840adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2841adb62b0dSMatthew Knepley } 2842abc0a331SBarry Smith if (maxtime) { 28434482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2844adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2845adb62b0dSMatthew Knepley } 2846adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2847adb62b0dSMatthew Knepley } 2848adb62b0dSMatthew Knepley 2849d763cef2SBarry Smith /*@ 2850d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 2851d763cef2SBarry Smith maximum time for iteration. 2852d763cef2SBarry Smith 28533f9fe445SBarry Smith Logically Collective on TS 2854d763cef2SBarry Smith 2855d763cef2SBarry Smith Input Parameters: 2856d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2857d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 2858d763cef2SBarry Smith - maxtime - final time to iterate to 2859d763cef2SBarry Smith 2860d763cef2SBarry Smith Options Database Keys: 2861d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 28623bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 2863d763cef2SBarry Smith 2864d763cef2SBarry Smith Notes: 2865d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 2866d763cef2SBarry Smith 2867d763cef2SBarry Smith Level: intermediate 2868d763cef2SBarry Smith 2869d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 2870a43b19c4SJed Brown 2871a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 2872d763cef2SBarry Smith @*/ 28737087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2874d763cef2SBarry Smith { 2875d763cef2SBarry Smith PetscFunctionBegin; 28760700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2877c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2878c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 287939b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 288039b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2881d763cef2SBarry Smith PetscFunctionReturn(0); 2882d763cef2SBarry Smith } 2883d763cef2SBarry Smith 2884d763cef2SBarry Smith /*@ 2885d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2886d763cef2SBarry Smith for use by the TS routines. 2887d763cef2SBarry Smith 28883f9fe445SBarry Smith Logically Collective on TS and Vec 2889d763cef2SBarry Smith 2890d763cef2SBarry Smith Input Parameters: 2891d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 28920910c330SBarry Smith - u - the solution vector 2893d763cef2SBarry Smith 2894d763cef2SBarry Smith Level: beginner 2895d763cef2SBarry Smith 2896d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions 2897d763cef2SBarry Smith @*/ 28980910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2899d763cef2SBarry Smith { 29008737fe31SLisandro Dalcin PetscErrorCode ierr; 2901496e6a7aSJed Brown DM dm; 29028737fe31SLisandro Dalcin 2903d763cef2SBarry Smith PetscFunctionBegin; 29040700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 29050910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 29060910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 29076bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 29080910c330SBarry Smith ts->vec_sol = u; 2909bbd56ea5SKarl Rupp 2910496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 29110910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 2912d763cef2SBarry Smith PetscFunctionReturn(0); 2913d763cef2SBarry Smith } 2914d763cef2SBarry Smith 291573b18844SBarry Smith /*@ 291673b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 291773b18844SBarry Smith 291873b18844SBarry Smith Logically Collective on TS 291973b18844SBarry Smith 292073b18844SBarry Smith Input Parameters: 292173b18844SBarry Smith + ts - the TS context obtained from TSCreate() 292273b18844SBarry Smith . steps - number of steps to use 292373b18844SBarry Smith 292473b18844SBarry Smith Level: intermediate 292573b18844SBarry Smith 292673b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 292773b18844SBarry Smith so as to integrate back to less than the original timestep 292873b18844SBarry Smith 292973b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 293073b18844SBarry Smith 293173b18844SBarry Smith .seealso: TSSetExactFinalTime() 293273b18844SBarry Smith @*/ 293373b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 293473b18844SBarry Smith { 293573b18844SBarry Smith PetscFunctionBegin; 293673b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 293773b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 293873b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 293973b18844SBarry 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"); 294073b18844SBarry Smith ts->adjoint_max_steps = steps; 294173b18844SBarry Smith PetscFunctionReturn(0); 294273b18844SBarry Smith } 294373b18844SBarry Smith 2944c235aa8dSHong Zhang /*@ 2945dfb21088SHong 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 29460cf82b59SBarry Smith for use by the TSAdjoint routines. 2947c235aa8dSHong Zhang 2948c235aa8dSHong Zhang Logically Collective on TS and Vec 2949c235aa8dSHong Zhang 2950c235aa8dSHong Zhang Input Parameters: 2951c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 2952abc2977eSBarry 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 2953abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 2954c235aa8dSHong Zhang 2955c235aa8dSHong Zhang Level: beginner 2956c235aa8dSHong Zhang 2957abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 29580cf82b59SBarry Smith 2959c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions 2960c235aa8dSHong Zhang @*/ 2961dfb21088SHong Zhang PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 2962c235aa8dSHong Zhang { 2963c235aa8dSHong Zhang PetscFunctionBegin; 2964c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2965abc2977eSBarry Smith PetscValidPointer(lambda,2); 2966abc2977eSBarry Smith ts->vecs_sensi = lambda; 2967abc2977eSBarry Smith ts->vecs_sensip = mu; 2968dfb21088SHong 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"); 2969abc2977eSBarry Smith ts->numcost = numcost; 2970ad8e2604SHong Zhang PetscFunctionReturn(0); 2971ad8e2604SHong Zhang } 2972ad8e2604SHong Zhang 2973ad8e2604SHong Zhang /*@C 29740cf82b59SBarry 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. 2975ad8e2604SHong Zhang 2976ad8e2604SHong Zhang Logically Collective on TS 2977ad8e2604SHong Zhang 2978ad8e2604SHong Zhang Input Parameters: 2979ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 2980ad8e2604SHong Zhang - func - The function 2981ad8e2604SHong Zhang 2982ad8e2604SHong Zhang Calling sequence of func: 29830cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 298405755b9cSHong Zhang + t - current timestep 29850cf82b59SBarry Smith . y - input vector (current ODE solution) 298605755b9cSHong Zhang . A - output matrix 298705755b9cSHong Zhang - ctx - [optional] user-defined function context 2988ad8e2604SHong Zhang 2989ad8e2604SHong Zhang Level: intermediate 2990ad8e2604SHong Zhang 29910cf82b59SBarry 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 29920cf82b59SBarry Smith 2993ad8e2604SHong Zhang .keywords: TS, sensitivity 2994ad8e2604SHong Zhang .seealso: 2995ad8e2604SHong Zhang @*/ 29965bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 2997ad8e2604SHong Zhang { 2998ad8e2604SHong Zhang PetscErrorCode ierr; 2999ad8e2604SHong Zhang 3000ad8e2604SHong Zhang PetscFunctionBegin; 3001ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3002ad8e2604SHong Zhang if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 3003ad8e2604SHong Zhang 3004ad8e2604SHong Zhang ts->rhsjacobianp = func; 3005ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 3006ad8e2604SHong Zhang if(Amat) { 3007ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 3008ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 3009ad8e2604SHong Zhang ts->Jacp = Amat; 3010ad8e2604SHong Zhang } 3011ad8e2604SHong Zhang PetscFunctionReturn(0); 3012ad8e2604SHong Zhang } 3013ad8e2604SHong Zhang 30140cf82b59SBarry Smith /*@C 30155bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 3016ad8e2604SHong Zhang 3017ad8e2604SHong Zhang Collective on TS 3018ad8e2604SHong Zhang 3019ad8e2604SHong Zhang Input Parameters: 3020ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 3021ad8e2604SHong Zhang 3022ad8e2604SHong Zhang Level: developer 3023ad8e2604SHong Zhang 3024ad8e2604SHong Zhang .keywords: TS, sensitivity 30255bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 3026ad8e2604SHong Zhang @*/ 30275bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 3028ad8e2604SHong Zhang { 3029ad8e2604SHong Zhang PetscErrorCode ierr; 3030ad8e2604SHong Zhang 3031ad8e2604SHong Zhang PetscFunctionBegin; 3032ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3033ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3034ad8e2604SHong Zhang PetscValidPointer(Amat,4); 3035ad8e2604SHong Zhang 3036ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 3037ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 3038ad8e2604SHong Zhang PetscStackPop; 3039c235aa8dSHong Zhang PetscFunctionReturn(0); 3040c235aa8dSHong Zhang } 3041c235aa8dSHong Zhang 30426fd0887fSHong Zhang /*@C 3043dfb21088SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 30446fd0887fSHong Zhang 30456fd0887fSHong Zhang Logically Collective on TS 30466fd0887fSHong Zhang 30476fd0887fSHong Zhang Input Parameters: 30486fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 3049abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 30500cf82b59SBarry Smith . rf - routine for evaluating the integrand function 3051b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 3052b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 3053feaa1ddbSSatish Balay . fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run 3054b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 30556fd0887fSHong Zhang 30560cf82b59SBarry Smith Calling sequence of rf: 30570cf82b59SBarry Smith $ rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx); 30586fd0887fSHong Zhang 30596fd0887fSHong Zhang + t - current timestep 30600cf82b59SBarry Smith . y - input vector 30610cf82b59SBarry Smith . f - function result; one vector entry for each cost function 30626fd0887fSHong Zhang - ctx - [optional] user-defined function context 30636fd0887fSHong Zhang 3064b612ec54SBarry Smith Calling sequence of drdyf: 30650cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 3066b612ec54SBarry Smith 3067b612ec54SBarry Smith Calling sequence of drdpf: 30680cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 3069b612ec54SBarry Smith 3070b612ec54SBarry Smith Level: intermediate 30716fd0887fSHong Zhang 3072abc2977eSBarry Smith Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions 30730cf82b59SBarry Smith 30746fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 30756fd0887fSHong Zhang 3076dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 30776fd0887fSHong Zhang @*/ 3078dfb21088SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 3079d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 3080b1cb36f3SHong Zhang PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 3081b1cb36f3SHong Zhang PetscBool fwd,void *ctx) 30826fd0887fSHong Zhang { 30836fd0887fSHong Zhang PetscErrorCode ierr; 30846fd0887fSHong Zhang 30856fd0887fSHong Zhang PetscFunctionBegin; 30866fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3087dfb21088SHong 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()"); 3088c72ed514SHong Zhang if (!ts->numcost) ts->numcost=numcost; 30896fd0887fSHong Zhang 3090b1cb36f3SHong Zhang ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 3091abc2977eSBarry Smith ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 30922c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 30930cf82b59SBarry Smith ts->costintegrand = rf; 309405755b9cSHong Zhang ts->costintegrandctx = ctx; 3095b612ec54SBarry Smith ts->drdyfunction = drdyf; 3096b612ec54SBarry Smith ts->drdpfunction = drdpf; 30976fd0887fSHong Zhang PetscFunctionReturn(0); 30986fd0887fSHong Zhang } 30996fd0887fSHong Zhang 310036eaed60SHong Zhang /*@ 3101dfb21088SHong Zhang TSGetCostIntegral - Returns the values of the integral term in the cost functions. 310236eaed60SHong Zhang It is valid to call the routine after a backward run. 310336eaed60SHong Zhang 310436eaed60SHong Zhang Not Collective 310536eaed60SHong Zhang 310636eaed60SHong Zhang Input Parameter: 310736eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 310836eaed60SHong Zhang 310936eaed60SHong Zhang Output Parameter: 31102c39e106SBarry Smith . v - the vector containing the integrals for each cost function 311136eaed60SHong Zhang 311236eaed60SHong Zhang Level: intermediate 311336eaed60SHong Zhang 3114dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 311536eaed60SHong Zhang 311636eaed60SHong Zhang .keywords: TS, sensitivity analysis 311736eaed60SHong Zhang @*/ 3118dfb21088SHong Zhang PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 311936eaed60SHong Zhang { 312036eaed60SHong Zhang PetscFunctionBegin; 312136eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 312236eaed60SHong Zhang PetscValidPointer(v,2); 31232c39e106SBarry Smith *v = ts->vec_costintegral; 312436eaed60SHong Zhang PetscFunctionReturn(0); 312536eaed60SHong Zhang } 312636eaed60SHong Zhang 31276fd0887fSHong Zhang /*@ 31282c39e106SBarry Smith TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions. 31296fd0887fSHong Zhang 31306fd0887fSHong Zhang Input Parameters: 31316fd0887fSHong Zhang + ts - the TS context 31326fd0887fSHong Zhang . t - current time 31330cf82b59SBarry Smith - y - state vector, i.e. current solution 31346fd0887fSHong Zhang 31356fd0887fSHong Zhang Output Parameter: 3136abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 31376fd0887fSHong Zhang 31386fd0887fSHong Zhang Note: 31396fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 31406fd0887fSHong Zhang is used internally within the sensitivity analysis context. 31416fd0887fSHong Zhang 31426fd0887fSHong Zhang Level: developer 31436fd0887fSHong Zhang 31446fd0887fSHong Zhang .keywords: TS, compute 31456fd0887fSHong Zhang 3146dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 31476fd0887fSHong Zhang @*/ 31480cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 31496fd0887fSHong Zhang { 31506fd0887fSHong Zhang PetscErrorCode ierr; 31516fd0887fSHong Zhang 31526fd0887fSHong Zhang PetscFunctionBegin; 31536fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31540cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 31556fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 31566fd0887fSHong Zhang 31570cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3158e4680132SHong Zhang if (ts->costintegrand) { 3159e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 31600cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 31616fd0887fSHong Zhang PetscStackPop; 31626fd0887fSHong Zhang } else { 31636fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 31646fd0887fSHong Zhang } 31656fd0887fSHong Zhang 31660cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 31676fd0887fSHong Zhang PetscFunctionReturn(0); 31686fd0887fSHong Zhang } 31696fd0887fSHong Zhang 317005755b9cSHong Zhang /*@ 3171d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 317205755b9cSHong Zhang 317305755b9cSHong Zhang Collective on TS 317405755b9cSHong Zhang 317505755b9cSHong Zhang Input Parameters: 317605755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 317705755b9cSHong Zhang 317805755b9cSHong Zhang Notes: 3179d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 318005755b9cSHong Zhang so most users would not generally call this routine themselves. 318105755b9cSHong Zhang 318205755b9cSHong Zhang Level: developer 318305755b9cSHong Zhang 318405755b9cSHong Zhang .keywords: TS, sensitivity 3185d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 318605755b9cSHong Zhang @*/ 31870cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 318805755b9cSHong Zhang { 318905755b9cSHong Zhang PetscErrorCode ierr; 319005755b9cSHong Zhang 319105755b9cSHong Zhang PetscFunctionBegin; 319205755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31930cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 319405755b9cSHong Zhang 319505755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 31960cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 319705755b9cSHong Zhang PetscStackPop; 319805755b9cSHong Zhang PetscFunctionReturn(0); 319905755b9cSHong Zhang } 320005755b9cSHong Zhang 320105755b9cSHong Zhang /*@ 3202d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 320305755b9cSHong Zhang 320405755b9cSHong Zhang Collective on TS 320505755b9cSHong Zhang 320605755b9cSHong Zhang Input Parameters: 320705755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 320805755b9cSHong Zhang 320905755b9cSHong Zhang Notes: 321005755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 321105755b9cSHong Zhang so most users would not generally call this routine themselves. 321205755b9cSHong Zhang 321305755b9cSHong Zhang Level: developer 321405755b9cSHong Zhang 321505755b9cSHong Zhang .keywords: TS, sensitivity 3216d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 321705755b9cSHong Zhang @*/ 32180cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 321905755b9cSHong Zhang { 322005755b9cSHong Zhang PetscErrorCode ierr; 322105755b9cSHong Zhang 322205755b9cSHong Zhang PetscFunctionBegin; 322305755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 32240cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 322505755b9cSHong Zhang 322605755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 32270cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 322805755b9cSHong Zhang PetscStackPop; 322905755b9cSHong Zhang PetscFunctionReturn(0); 323005755b9cSHong Zhang } 323105755b9cSHong Zhang 3232ac226902SBarry Smith /*@C 3233000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 32343f2090d5SJed Brown called once at the beginning of each time step. 3235000e7ae3SMatthew Knepley 32363f9fe445SBarry Smith Logically Collective on TS 3237000e7ae3SMatthew Knepley 3238000e7ae3SMatthew Knepley Input Parameters: 3239000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3240000e7ae3SMatthew Knepley - func - The function 3241000e7ae3SMatthew Knepley 3242000e7ae3SMatthew Knepley Calling sequence of func: 3243000e7ae3SMatthew Knepley . func (TS ts); 3244000e7ae3SMatthew Knepley 3245000e7ae3SMatthew Knepley Level: intermediate 3246000e7ae3SMatthew Knepley 3247000e7ae3SMatthew Knepley .keywords: TS, timestep 32489be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3249000e7ae3SMatthew Knepley @*/ 32507087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3251000e7ae3SMatthew Knepley { 3252000e7ae3SMatthew Knepley PetscFunctionBegin; 32530700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3254ae60f76fSBarry Smith ts->prestep = func; 3255000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3256000e7ae3SMatthew Knepley } 3257000e7ae3SMatthew Knepley 325809ee8438SJed Brown /*@ 32593f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 32603f2090d5SJed Brown 32613f2090d5SJed Brown Collective on TS 32623f2090d5SJed Brown 32633f2090d5SJed Brown Input Parameters: 32643f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 32653f2090d5SJed Brown 32663f2090d5SJed Brown Notes: 32673f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 32683f2090d5SJed Brown so most users would not generally call this routine themselves. 32693f2090d5SJed Brown 32703f2090d5SJed Brown Level: developer 32713f2090d5SJed Brown 32723f2090d5SJed Brown .keywords: TS, timestep 32739be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 32743f2090d5SJed Brown @*/ 32757087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 32763f2090d5SJed Brown { 32773f2090d5SJed Brown PetscErrorCode ierr; 32783f2090d5SJed Brown 32793f2090d5SJed Brown PetscFunctionBegin; 32800700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3281ae60f76fSBarry Smith if (ts->prestep) { 3282ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 3283312ce896SJed Brown } 32843f2090d5SJed Brown PetscFunctionReturn(0); 32853f2090d5SJed Brown } 32863f2090d5SJed Brown 3287b8123daeSJed Brown /*@C 3288b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3289b8123daeSJed Brown called once at the beginning of each stage. 3290b8123daeSJed Brown 3291b8123daeSJed Brown Logically Collective on TS 3292b8123daeSJed Brown 3293b8123daeSJed Brown Input Parameters: 3294b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3295b8123daeSJed Brown - func - The function 3296b8123daeSJed Brown 3297b8123daeSJed Brown Calling sequence of func: 3298b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3299b8123daeSJed Brown 3300b8123daeSJed Brown Level: intermediate 3301b8123daeSJed Brown 3302b8123daeSJed Brown Note: 3303b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3304b8123daeSJed Brown The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 3305b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3306b8123daeSJed Brown 3307b8123daeSJed Brown .keywords: TS, timestep 33089be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3309b8123daeSJed Brown @*/ 3310b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3311b8123daeSJed Brown { 3312b8123daeSJed Brown PetscFunctionBegin; 3313b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3314ae60f76fSBarry Smith ts->prestage = func; 3315b8123daeSJed Brown PetscFunctionReturn(0); 3316b8123daeSJed Brown } 3317b8123daeSJed Brown 33189be3e283SDebojyoti Ghosh /*@C 33199be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 33209be3e283SDebojyoti Ghosh called once at the end of each stage. 33219be3e283SDebojyoti Ghosh 33229be3e283SDebojyoti Ghosh Logically Collective on TS 33239be3e283SDebojyoti Ghosh 33249be3e283SDebojyoti Ghosh Input Parameters: 33259be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 33269be3e283SDebojyoti Ghosh - func - The function 33279be3e283SDebojyoti Ghosh 33289be3e283SDebojyoti Ghosh Calling sequence of func: 33299be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 33309be3e283SDebojyoti Ghosh 33319be3e283SDebojyoti Ghosh Level: intermediate 33329be3e283SDebojyoti Ghosh 33339be3e283SDebojyoti Ghosh Note: 33349be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 33359be3e283SDebojyoti Ghosh The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being 33369be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 33379be3e283SDebojyoti Ghosh 33389be3e283SDebojyoti Ghosh .keywords: TS, timestep 33399be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 33409be3e283SDebojyoti Ghosh @*/ 33419be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 33429be3e283SDebojyoti Ghosh { 33439be3e283SDebojyoti Ghosh PetscFunctionBegin; 33449be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 33459be3e283SDebojyoti Ghosh ts->poststage = func; 33469be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33479be3e283SDebojyoti Ghosh } 33489be3e283SDebojyoti Ghosh 3349c688d042SShri Abhyankar /*@C 3350c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3351c688d042SShri Abhyankar called once at the end of each step evaluation. 3352c688d042SShri Abhyankar 3353c688d042SShri Abhyankar Logically Collective on TS 3354c688d042SShri Abhyankar 3355c688d042SShri Abhyankar Input Parameters: 3356c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3357c688d042SShri Abhyankar - func - The function 3358c688d042SShri Abhyankar 3359c688d042SShri Abhyankar Calling sequence of func: 3360c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3361c688d042SShri Abhyankar 3362c688d042SShri Abhyankar Level: intermediate 3363c688d042SShri Abhyankar 3364c688d042SShri Abhyankar Note: 33651785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 33661785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3367e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3368e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3369e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3370c688d042SShri Abhyankar 3371c688d042SShri Abhyankar .keywords: TS, timestep 3372c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3373c688d042SShri Abhyankar @*/ 3374c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3375c688d042SShri Abhyankar { 3376c688d042SShri Abhyankar PetscFunctionBegin; 3377c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3378c688d042SShri Abhyankar ts->postevaluate = func; 3379c688d042SShri Abhyankar PetscFunctionReturn(0); 3380c688d042SShri Abhyankar } 3381c688d042SShri Abhyankar 3382b8123daeSJed Brown /*@ 3383b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3384b8123daeSJed Brown 3385b8123daeSJed Brown Collective on TS 3386b8123daeSJed Brown 3387b8123daeSJed Brown Input Parameters: 3388b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 33899be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3390b8123daeSJed Brown 3391b8123daeSJed Brown Notes: 3392b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3393b8123daeSJed Brown most users would not generally call this routine themselves. 3394b8123daeSJed Brown 3395b8123daeSJed Brown Level: developer 3396b8123daeSJed Brown 3397b8123daeSJed Brown .keywords: TS, timestep 33989be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3399b8123daeSJed Brown @*/ 3400b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3401b8123daeSJed Brown { 3402b8123daeSJed Brown PetscErrorCode ierr; 3403b8123daeSJed Brown 3404b8123daeSJed Brown PetscFunctionBegin; 3405b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3406ae60f76fSBarry Smith if (ts->prestage) { 3407ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3408b8123daeSJed Brown } 3409b8123daeSJed Brown PetscFunctionReturn(0); 3410b8123daeSJed Brown } 3411b8123daeSJed Brown 34129be3e283SDebojyoti Ghosh /*@ 34139be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 34149be3e283SDebojyoti Ghosh 34159be3e283SDebojyoti Ghosh Collective on TS 34169be3e283SDebojyoti Ghosh 34179be3e283SDebojyoti Ghosh Input Parameters: 34189be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 34199be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 34209be3e283SDebojyoti Ghosh stageindex - Stage number 34219be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 34229be3e283SDebojyoti Ghosh of stages) with the stage solutions 34239be3e283SDebojyoti Ghosh 34249be3e283SDebojyoti Ghosh Notes: 34259be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 34269be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 34279be3e283SDebojyoti Ghosh 34289be3e283SDebojyoti Ghosh Level: developer 34299be3e283SDebojyoti Ghosh 34309be3e283SDebojyoti Ghosh .keywords: TS, timestep 34319be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 34329be3e283SDebojyoti Ghosh @*/ 34339be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 34349be3e283SDebojyoti Ghosh { 34359be3e283SDebojyoti Ghosh PetscErrorCode ierr; 34369be3e283SDebojyoti Ghosh 34379be3e283SDebojyoti Ghosh PetscFunctionBegin; 34389be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34394beae5d8SLisandro Dalcin if (ts->poststage) { 34409be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 34419be3e283SDebojyoti Ghosh } 34429be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 34439be3e283SDebojyoti Ghosh } 34449be3e283SDebojyoti Ghosh 3445c688d042SShri Abhyankar /*@ 3446c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3447c688d042SShri Abhyankar 3448c688d042SShri Abhyankar Collective on TS 3449c688d042SShri Abhyankar 3450c688d042SShri Abhyankar Input Parameters: 3451c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3452c688d042SShri Abhyankar 3453c688d042SShri Abhyankar Notes: 3454c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3455c688d042SShri Abhyankar most users would not generally call this routine themselves. 3456c688d042SShri Abhyankar 3457c688d042SShri Abhyankar Level: developer 3458c688d042SShri Abhyankar 3459c688d042SShri Abhyankar .keywords: TS, timestep 3460c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3461c688d042SShri Abhyankar @*/ 3462c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3463c688d042SShri Abhyankar { 3464c688d042SShri Abhyankar PetscErrorCode ierr; 3465c688d042SShri Abhyankar 3466c688d042SShri Abhyankar PetscFunctionBegin; 3467c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3468c688d042SShri Abhyankar if (ts->postevaluate) { 3469c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3470c688d042SShri Abhyankar } 3471c688d042SShri Abhyankar PetscFunctionReturn(0); 3472c688d042SShri Abhyankar } 3473c688d042SShri Abhyankar 3474ac226902SBarry Smith /*@C 3475000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 34763f2090d5SJed Brown called once at the end of each time step. 3477000e7ae3SMatthew Knepley 34783f9fe445SBarry Smith Logically Collective on TS 3479000e7ae3SMatthew Knepley 3480000e7ae3SMatthew Knepley Input Parameters: 3481000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3482000e7ae3SMatthew Knepley - func - The function 3483000e7ae3SMatthew Knepley 3484000e7ae3SMatthew Knepley Calling sequence of func: 3485b8123daeSJed Brown $ func (TS ts); 3486000e7ae3SMatthew Knepley 34871785ff2aSShri Abhyankar Notes: 34881785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 34891785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 34901785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 34911785ff2aSShri Abhyankar 3492000e7ae3SMatthew Knepley Level: intermediate 3493000e7ae3SMatthew Knepley 3494000e7ae3SMatthew Knepley .keywords: TS, timestep 34951785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime() 3496000e7ae3SMatthew Knepley @*/ 34977087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3498000e7ae3SMatthew Knepley { 3499000e7ae3SMatthew Knepley PetscFunctionBegin; 35000700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3501ae60f76fSBarry Smith ts->poststep = func; 3502000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3503000e7ae3SMatthew Knepley } 3504000e7ae3SMatthew Knepley 350509ee8438SJed Brown /*@ 35063f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 35073f2090d5SJed Brown 35083f2090d5SJed Brown Collective on TS 35093f2090d5SJed Brown 35103f2090d5SJed Brown Input Parameters: 35113f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 35123f2090d5SJed Brown 35133f2090d5SJed Brown Notes: 35143f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 35153f2090d5SJed Brown so most users would not generally call this routine themselves. 35163f2090d5SJed Brown 35173f2090d5SJed Brown Level: developer 35183f2090d5SJed Brown 35193f2090d5SJed Brown .keywords: TS, timestep 35203f2090d5SJed Brown @*/ 35217087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 35223f2090d5SJed Brown { 35233f2090d5SJed Brown PetscErrorCode ierr; 35243f2090d5SJed Brown 35253f2090d5SJed Brown PetscFunctionBegin; 35260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3527ae60f76fSBarry Smith if (ts->poststep) { 3528ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 352972ac3e02SJed Brown } 35303f2090d5SJed Brown PetscFunctionReturn(0); 35313f2090d5SJed Brown } 35323f2090d5SJed Brown 3533d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3534d763cef2SBarry Smith 3535d763cef2SBarry Smith /*@C 3536a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3537d763cef2SBarry Smith timestep to display the iteration's progress. 3538d763cef2SBarry Smith 35393f9fe445SBarry Smith Logically Collective on TS 3540d763cef2SBarry Smith 3541d763cef2SBarry Smith Input Parameters: 3542d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3543e213d8f1SJed Brown . monitor - monitoring routine 3544329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 35450298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3546b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 35470298fd71SBarry Smith (may be NULL) 3548d763cef2SBarry Smith 3549e213d8f1SJed Brown Calling sequence of monitor: 35500910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3551d763cef2SBarry Smith 3552d763cef2SBarry Smith + ts - the TS context 355363e21af5SBarry 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) 35541f06c33eSBarry Smith . time - current time 35550910c330SBarry Smith . u - current iterate 3556d763cef2SBarry Smith - mctx - [optional] monitoring context 3557d763cef2SBarry Smith 3558d763cef2SBarry Smith Notes: 3559d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3560d763cef2SBarry Smith already has been loaded. 3561d763cef2SBarry Smith 3562025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 3563025f1a04SBarry Smith 3564d763cef2SBarry Smith Level: intermediate 3565d763cef2SBarry Smith 3566d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3567d763cef2SBarry Smith 3568a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3569d763cef2SBarry Smith @*/ 3570c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3571d763cef2SBarry Smith { 357278064530SBarry Smith PetscErrorCode ierr; 357378064530SBarry Smith PetscInt i; 357478064530SBarry Smith PetscBool identical; 357578064530SBarry Smith 3576d763cef2SBarry Smith PetscFunctionBegin; 35770700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 357878064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 357978064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 358078064530SBarry Smith if (identical) PetscFunctionReturn(0); 358178064530SBarry Smith } 358217186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3583d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 35848704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3585d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3586d763cef2SBarry Smith PetscFunctionReturn(0); 3587d763cef2SBarry Smith } 3588d763cef2SBarry Smith 3589d763cef2SBarry Smith /*@C 3590a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3591d763cef2SBarry Smith 35923f9fe445SBarry Smith Logically Collective on TS 3593d763cef2SBarry Smith 3594d763cef2SBarry Smith Input Parameters: 3595d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3596d763cef2SBarry Smith 3597d763cef2SBarry Smith Notes: 3598d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3599d763cef2SBarry Smith 3600d763cef2SBarry Smith Level: intermediate 3601d763cef2SBarry Smith 3602d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3603d763cef2SBarry Smith 3604a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3605d763cef2SBarry Smith @*/ 36067087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3607d763cef2SBarry Smith { 3608d952e501SBarry Smith PetscErrorCode ierr; 3609d952e501SBarry Smith PetscInt i; 3610d952e501SBarry Smith 3611d763cef2SBarry Smith PetscFunctionBegin; 36120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3613d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 36148704b422SBarry Smith if (ts->monitordestroy[i]) { 36158704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3616d952e501SBarry Smith } 3617d952e501SBarry Smith } 3618d763cef2SBarry Smith ts->numbermonitors = 0; 3619d763cef2SBarry Smith PetscFunctionReturn(0); 3620d763cef2SBarry Smith } 3621d763cef2SBarry Smith 3622721cd6eeSBarry Smith /*@C 3623721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 36245516499fSSatish Balay 36255516499fSSatish Balay Level: intermediate 362641251cbbSSatish Balay 36275516499fSSatish Balay .keywords: TS, set, monitor 36285516499fSSatish Balay 362963e21af5SBarry Smith .seealso: TSMonitorSet() 363041251cbbSSatish Balay @*/ 3631721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3632d763cef2SBarry Smith { 3633dfbe8321SBarry Smith PetscErrorCode ierr; 3634721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 363541aca3d6SBarry Smith PetscBool iascii,ibinary; 3636d132466eSBarry Smith 3637d763cef2SBarry Smith PetscFunctionBegin; 36384d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 363941aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 364041aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3641721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 364241aca3d6SBarry Smith if (iascii) { 3643649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 364463e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 364563e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 364663e21af5SBarry Smith } else { 36478392e04aSShri 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); 364863e21af5SBarry Smith } 3649649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 365041aca3d6SBarry Smith } else if (ibinary) { 365141aca3d6SBarry Smith PetscMPIInt rank; 365241aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 365341aca3d6SBarry Smith if (!rank) { 3654450a797fSBarry Smith PetscBool skipHeader; 3655450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3656450a797fSBarry Smith 3657450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3658450a797fSBarry Smith if (!skipHeader) { 3659450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3660450a797fSBarry Smith } 366141aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 366241aca3d6SBarry Smith } else { 366341aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 366441aca3d6SBarry Smith } 366541aca3d6SBarry Smith } 3666721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3667d763cef2SBarry Smith PetscFunctionReturn(0); 3668d763cef2SBarry Smith } 3669d763cef2SBarry Smith 36709110b2e7SHong Zhang /*@C 36719110b2e7SHong Zhang TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 36729110b2e7SHong Zhang timestep to display the iteration's progress. 36739110b2e7SHong Zhang 36749110b2e7SHong Zhang Logically Collective on TS 36759110b2e7SHong Zhang 36769110b2e7SHong Zhang Input Parameters: 36779110b2e7SHong Zhang + ts - the TS context obtained from TSCreate() 36789110b2e7SHong Zhang . adjointmonitor - monitoring routine 36799110b2e7SHong Zhang . adjointmctx - [optional] user-defined context for private data for the 36809110b2e7SHong Zhang monitor routine (use NULL if no context is desired) 36819110b2e7SHong Zhang - adjointmonitordestroy - [optional] routine that frees monitor context 36829110b2e7SHong Zhang (may be NULL) 36839110b2e7SHong Zhang 36849110b2e7SHong Zhang Calling sequence of monitor: 36859110b2e7SHong Zhang $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 36869110b2e7SHong Zhang 36879110b2e7SHong Zhang + ts - the TS context 36889110b2e7SHong 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 36899110b2e7SHong Zhang been interpolated to) 36909110b2e7SHong Zhang . time - current time 36919110b2e7SHong Zhang . u - current iterate 36929110b2e7SHong Zhang . numcost - number of cost functionos 36939110b2e7SHong Zhang . lambda - sensitivities to initial conditions 36949110b2e7SHong Zhang . mu - sensitivities to parameters 36959110b2e7SHong Zhang - adjointmctx - [optional] adjoint monitoring context 36969110b2e7SHong Zhang 36979110b2e7SHong Zhang Notes: 36989110b2e7SHong Zhang This routine adds an additional monitor to the list of monitors that 36999110b2e7SHong Zhang already has been loaded. 37009110b2e7SHong Zhang 37019110b2e7SHong Zhang Fortran notes: Only a single monitor function can be set for each TS object 37029110b2e7SHong Zhang 37039110b2e7SHong Zhang Level: intermediate 37049110b2e7SHong Zhang 37059110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 37069110b2e7SHong Zhang 37079110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel() 37089110b2e7SHong Zhang @*/ 37099110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 37109110b2e7SHong Zhang { 371178064530SBarry Smith PetscErrorCode ierr; 371278064530SBarry Smith PetscInt i; 371378064530SBarry Smith PetscBool identical; 371478064530SBarry Smith 37159110b2e7SHong Zhang PetscFunctionBegin; 37169110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 371778064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 371878064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 371978064530SBarry Smith if (identical) PetscFunctionReturn(0); 372078064530SBarry Smith } 37219110b2e7SHong Zhang if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 37229110b2e7SHong Zhang ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 37239110b2e7SHong Zhang ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 37249110b2e7SHong Zhang ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 37259110b2e7SHong Zhang PetscFunctionReturn(0); 37269110b2e7SHong Zhang } 37279110b2e7SHong Zhang 37289110b2e7SHong Zhang /*@C 37299110b2e7SHong Zhang TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 37309110b2e7SHong Zhang 37319110b2e7SHong Zhang Logically Collective on TS 37329110b2e7SHong Zhang 37339110b2e7SHong Zhang Input Parameters: 37349110b2e7SHong Zhang . ts - the TS context obtained from TSCreate() 37359110b2e7SHong Zhang 37369110b2e7SHong Zhang Notes: 37379110b2e7SHong Zhang There is no way to remove a single, specific monitor. 37389110b2e7SHong Zhang 37399110b2e7SHong Zhang Level: intermediate 37409110b2e7SHong Zhang 37419110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 37429110b2e7SHong Zhang 37439110b2e7SHong Zhang .seealso: TSAdjointMonitorSet() 37449110b2e7SHong Zhang @*/ 37459110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorCancel(TS ts) 37469110b2e7SHong Zhang { 37479110b2e7SHong Zhang PetscErrorCode ierr; 37489110b2e7SHong Zhang PetscInt i; 37499110b2e7SHong Zhang 37509110b2e7SHong Zhang PetscFunctionBegin; 37519110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37529110b2e7SHong Zhang for (i=0; i<ts->numberadjointmonitors; i++) { 37539110b2e7SHong Zhang if (ts->adjointmonitordestroy[i]) { 37549110b2e7SHong Zhang ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 37559110b2e7SHong Zhang } 37569110b2e7SHong Zhang } 37579110b2e7SHong Zhang ts->numberadjointmonitors = 0; 37589110b2e7SHong Zhang PetscFunctionReturn(0); 37599110b2e7SHong Zhang } 37609110b2e7SHong Zhang 3761721cd6eeSBarry Smith /*@C 3762721cd6eeSBarry Smith TSAdjointMonitorDefault - the default monitor of adjoint computations 3763110eb670SHong Zhang 3764110eb670SHong Zhang Level: intermediate 3765110eb670SHong Zhang 3766110eb670SHong Zhang .keywords: TS, set, monitor 3767110eb670SHong Zhang 3768110eb670SHong Zhang .seealso: TSAdjointMonitorSet() 3769110eb670SHong Zhang @*/ 3770721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3771110eb670SHong Zhang { 3772110eb670SHong Zhang PetscErrorCode ierr; 3773721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 3774110eb670SHong Zhang 3775110eb670SHong Zhang PetscFunctionBegin; 3776110eb670SHong Zhang PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3777721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3778110eb670SHong Zhang ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3779110eb670SHong 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); 3780110eb670SHong Zhang ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3781721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3782110eb670SHong Zhang PetscFunctionReturn(0); 3783110eb670SHong Zhang } 3784110eb670SHong Zhang 3785cd652676SJed Brown /*@ 3786cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3787cd652676SJed Brown 3788cd652676SJed Brown Collective on TS 3789cd652676SJed Brown 3790cd652676SJed Brown Input Argument: 3791cd652676SJed Brown + ts - time stepping context 3792cd652676SJed Brown - t - time to interpolate to 3793cd652676SJed Brown 3794cd652676SJed Brown Output Argument: 37950910c330SBarry Smith . U - state at given time 3796cd652676SJed Brown 3797cd652676SJed Brown Level: intermediate 3798cd652676SJed Brown 3799cd652676SJed Brown Developer Notes: 3800cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3801cd652676SJed Brown 3802cd652676SJed Brown .keywords: TS, set 3803cd652676SJed Brown 3804874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3805cd652676SJed Brown @*/ 38060910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3807cd652676SJed Brown { 3808cd652676SJed Brown PetscErrorCode ierr; 3809cd652676SJed Brown 3810cd652676SJed Brown PetscFunctionBegin; 3811cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3812b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3813be5899b3SLisandro 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); 3814ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 38150910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3816cd652676SJed Brown PetscFunctionReturn(0); 3817cd652676SJed Brown } 3818cd652676SJed Brown 3819d763cef2SBarry Smith /*@ 38206d9e5789SSean Farley TSStep - Steps one time step 3821d763cef2SBarry Smith 3822d763cef2SBarry Smith Collective on TS 3823d763cef2SBarry Smith 3824d763cef2SBarry Smith Input Parameter: 3825d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3826d763cef2SBarry Smith 382727829d71SBarry Smith Level: developer 3828d763cef2SBarry Smith 3829b8123daeSJed Brown Notes: 383027829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 383127829d71SBarry Smith 3832b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3833b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3834b8123daeSJed Brown 383525cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 383625cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 383725cb2221SBarry Smith 3838d763cef2SBarry Smith .keywords: TS, timestep, solve 3839d763cef2SBarry Smith 38409be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3841d763cef2SBarry Smith @*/ 3842193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3843d763cef2SBarry Smith { 3844dfbe8321SBarry Smith PetscErrorCode ierr; 3845fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3846be5899b3SLisandro Dalcin PetscReal ptime; 3847d763cef2SBarry Smith 3848d763cef2SBarry Smith PetscFunctionBegin; 38490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3850fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3851fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3852fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3853fffbeea8SBarry Smith " type = {Preprint},\n" 3854fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3855fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3856302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3857fffbeea8SBarry Smith 3858d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 385968bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3860d405a339SMatthew Knepley 3861a6772fa2SLisandro 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()"); 3862be5899b3SLisandro 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"); 3863a6772fa2SLisandro Dalcin 3864be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3865362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3866be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 3867e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3868d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3869193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3870d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3871be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 3872be5899b3SLisandro Dalcin ts->steps++; ts->total_steps++; 3873be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 387428d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3875362cd11cSLisandro Dalcin 3876362cd11cSLisandro Dalcin if (ts->reason < 0) { 3877cef5090cSJed Brown if (ts->errorifstepfailed) { 387808c7845fSBarry 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]); 387908c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3880d2daff3dSHong Zhang } 388108c7845fSBarry Smith } else if (!ts->reason) { 388208c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 388308c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 388408c7845fSBarry Smith } 388508c7845fSBarry Smith PetscFunctionReturn(0); 388608c7845fSBarry Smith } 388708c7845fSBarry Smith 388808c7845fSBarry Smith /*@ 3889b957a604SHong Zhang TSAdjointStep - Steps one time step backward in the adjoint run 389008c7845fSBarry Smith 389108c7845fSBarry Smith Collective on TS 389208c7845fSBarry Smith 389308c7845fSBarry Smith Input Parameter: 389408c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 389508c7845fSBarry Smith 38966a4d4014SLisandro Dalcin Level: intermediate 38976a4d4014SLisandro Dalcin 3898b957a604SHong Zhang .keywords: TS, adjoint, step 38996a4d4014SLisandro Dalcin 3900b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve() 39016a4d4014SLisandro Dalcin @*/ 390208c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 39036a4d4014SLisandro Dalcin { 390408c7845fSBarry Smith DM dm; 39056a4d4014SLisandro Dalcin PetscErrorCode ierr; 39066a4d4014SLisandro Dalcin 39076a4d4014SLisandro Dalcin PetscFunctionBegin; 39084a2ae208SSatish Balay PetscValidHeaderSpecific(ts,TS_CLASSID,1); 390908c7845fSBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 391008c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 3911d763cef2SBarry Smith 3912685405a1SBarry Smith ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 3913d763cef2SBarry Smith 3914be5899b3SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3915be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime; 391642f2b339SBarry 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); 3917be5899b3SLisandro Dalcin ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 391842f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 39198d0ad7a8SHong Zhang ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 3920be5899b3SLisandro Dalcin ts->steps++; ts->total_steps--; 3921362cd11cSLisandro Dalcin 3922362cd11cSLisandro Dalcin if (ts->reason < 0) { 3923cef5090cSJed Brown if (ts->errorifstepfailed) { 39246c4ed002SBarry 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]); 39256c4ed002SBarry 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]); 39266c4ed002SBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3927cef5090cSJed Brown } 3928362cd11cSLisandro Dalcin } else if (!ts->reason) { 392973b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 3930362cd11cSLisandro Dalcin } 3931d763cef2SBarry Smith PetscFunctionReturn(0); 3932d763cef2SBarry Smith } 3933d763cef2SBarry Smith 39347cbde773SLisandro Dalcin /*@ 39357cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 39367cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 39377cbde773SLisandro Dalcin 39387cbde773SLisandro Dalcin Collective on TS 39397cbde773SLisandro Dalcin 39407cbde773SLisandro Dalcin Input Arguments: 39417cbde773SLisandro Dalcin + ts - time stepping context 39427cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 39437cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 39447cbde773SLisandro Dalcin 39457cbde773SLisandro Dalcin Output Arguments: 39467cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 39477cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 39487cbde773SLisandro Dalcin 39497cbde773SLisandro Dalcin Level: advanced 39507cbde773SLisandro Dalcin 39517cbde773SLisandro Dalcin Notes: 39527cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 39537cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 39547cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 39557cbde773SLisandro Dalcin 39567cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 39577cbde773SLisandro Dalcin @*/ 39587cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 39597cbde773SLisandro Dalcin { 39607cbde773SLisandro Dalcin PetscErrorCode ierr; 39617cbde773SLisandro Dalcin 39627cbde773SLisandro Dalcin PetscFunctionBegin; 39637cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 39647cbde773SLisandro Dalcin PetscValidType(ts,1); 39657cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 39667cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 39677cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 39687cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 39697cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 39707cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 39717cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 39727cbde773SLisandro Dalcin PetscFunctionReturn(0); 39737cbde773SLisandro Dalcin } 39747cbde773SLisandro Dalcin 397505175c85SJed Brown /*@ 397605175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 397705175c85SJed Brown 39781c3436cfSJed Brown Collective on TS 397905175c85SJed Brown 398005175c85SJed Brown Input Arguments: 39811c3436cfSJed Brown + ts - time stepping context 39821c3436cfSJed Brown . order - desired order of accuracy 39830298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 398405175c85SJed Brown 398505175c85SJed Brown Output Arguments: 39860910c330SBarry Smith . U - state at the end of the current step 398705175c85SJed Brown 398805175c85SJed Brown Level: advanced 398905175c85SJed Brown 3990108c343cSJed Brown Notes: 3991108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3992108c343cSJed 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. 3993108c343cSJed Brown 39941c3436cfSJed Brown .seealso: TSStep(), TSAdapt 399505175c85SJed Brown @*/ 39960910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 399705175c85SJed Brown { 399805175c85SJed Brown PetscErrorCode ierr; 399905175c85SJed Brown 400005175c85SJed Brown PetscFunctionBegin; 400105175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 400205175c85SJed Brown PetscValidType(ts,1); 40030910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4004ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 40050910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 400605175c85SJed Brown PetscFunctionReturn(0); 400705175c85SJed Brown } 400805175c85SJed Brown 4009b1cb36f3SHong Zhang /*@ 4010b1cb36f3SHong Zhang TSForwardCostIntegral - Evaluate the cost integral in the forward run. 4011b1cb36f3SHong Zhang 4012b1cb36f3SHong Zhang Collective on TS 4013b1cb36f3SHong Zhang 4014b1cb36f3SHong Zhang Input Arguments: 4015b1cb36f3SHong Zhang . ts - time stepping context 4016b1cb36f3SHong Zhang 4017b1cb36f3SHong Zhang Level: advanced 4018b1cb36f3SHong Zhang 4019b1cb36f3SHong Zhang Notes: 4020b1cb36f3SHong Zhang This function cannot be called until TSStep() has been completed. 4021b1cb36f3SHong Zhang 4022b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral() 4023b1cb36f3SHong Zhang @*/ 4024b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts) 4025b1cb36f3SHong Zhang { 4026b1cb36f3SHong Zhang PetscErrorCode ierr; 4027b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4028b1cb36f3SHong 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); 4029b1cb36f3SHong Zhang ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 4030b1cb36f3SHong Zhang PetscFunctionReturn(0); 4031b1cb36f3SHong Zhang } 4032d67e68b7SBarry Smith 4033d763cef2SBarry Smith /*@ 4034d763cef2SBarry Smith TSSolve - Steps the requested number of timesteps. 4035d763cef2SBarry Smith 4036d763cef2SBarry Smith Collective on TS 4037d763cef2SBarry Smith 4038d763cef2SBarry Smith Input Parameter: 4039d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 404063e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 404163e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 40425a3a76d0SJed Brown 4043d763cef2SBarry Smith Level: beginner 4044d763cef2SBarry Smith 40455a3a76d0SJed Brown Notes: 40465a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 40475a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 40485a3a76d0SJed Brown stepped over the final time. 40495a3a76d0SJed Brown 4050d763cef2SBarry Smith .keywords: TS, timestep, solve 4051d763cef2SBarry Smith 405263e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 4053d763cef2SBarry Smith @*/ 4054cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 4055d763cef2SBarry Smith { 4056b06615a5SLisandro Dalcin Vec solution; 4057d763cef2SBarry Smith PetscErrorCode ierr; 4058d763cef2SBarry Smith 4059d763cef2SBarry Smith PetscFunctionBegin; 4060d763cef2SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4061f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4062feed9e9dSBarry Smith 406349354f04SShri 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 */ 4064b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 40650910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 4066b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4067b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4068b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 40695a3a76d0SJed Brown } 40700910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4071bbd56ea5SKarl Rupp } else if (u) { 40720910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 40735a3a76d0SJed Brown } 4074b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 407568bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4076a6772fa2SLisandro Dalcin 4077a6772fa2SLisandro 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()"); 4078a6772fa2SLisandro 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"); 4079a6772fa2SLisandro Dalcin 4080e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 4081e7069c78SShri restarts the step after an event. Resetting these counters in such a case causes 4082e7069c78SShri TSTrajectory to incorrectly save the output files 4083e7069c78SShri */ 4084938c94caSShri Abhyankar 4085193ac0bcSJed Brown ts->steps = 0; 40865ef26d82SJed Brown ts->ksp_its = 0; 40875ef26d82SJed Brown ts->snes_its = 0; 4088c610991cSLisandro Dalcin ts->num_snes_failures = 0; 4089c610991cSLisandro Dalcin ts->reject = 0; 4090193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 4091193ac0bcSJed Brown 4092ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4093f05ece33SBarry Smith 4094193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4095193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4096a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4097cc708dedSBarry Smith ts->solvetime = ts->ptime; 4098a6772fa2SLisandro Dalcin solution = ts->vec_sol; 4099be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 4100db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4101db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4102e7069c78SShri 4103938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41046427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4105e7069c78SShri 410628d5b5d6SLisandro Dalcin ts->steprollback = PETSC_FALSE; 410728d5b5d6SLisandro Dalcin ts->steprestart = PETSC_TRUE; 41086427ac75SLisandro Dalcin 4109e1a7a14fSJed Brown while (!ts->reason) { 4110938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41119687d888SLisandro Dalcin if (!ts->steprollback) { 41129687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 41139687d888SLisandro Dalcin } 4114193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 4115e783b05fSHong 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. */ 4116b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 4117b1cb36f3SHong Zhang } 411810b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 4119e783b05fSHong 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. */ 4120e783b05fSHong Zhang if (!ts->steprollback) { 4121938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41221eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 4123aeb4809dSShri Abhyankar } 4124193ac0bcSJed Brown } 4125938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41266427ac75SLisandro Dalcin 412749354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 41280910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4129cc708dedSBarry Smith ts->solvetime = ts->max_time; 4130b06615a5SLisandro Dalcin solution = u; 413163e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 41320574a7fbSJed Brown } else { 4133ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4134cc708dedSBarry Smith ts->solvetime = ts->ptime; 4135b06615a5SLisandro Dalcin solution = ts->vec_sol; 41360574a7fbSJed Brown } 4137193ac0bcSJed Brown } 4138d2daff3dSHong Zhang 4139ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 414063e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 414156f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4142ef222394SBarry Smith if (ts->adjoint_solve) { 4143ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 41442b0a91c0SBarry Smith } 4145d763cef2SBarry Smith PetscFunctionReturn(0); 4146d763cef2SBarry Smith } 4147d763cef2SBarry Smith 4148b1cb36f3SHong Zhang /*@ 4149b1cb36f3SHong Zhang TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4150b1cb36f3SHong Zhang 4151b1cb36f3SHong Zhang Collective on TS 4152b1cb36f3SHong Zhang 4153b1cb36f3SHong Zhang Input Arguments: 4154b1cb36f3SHong Zhang . ts - time stepping context 4155b1cb36f3SHong Zhang 4156b1cb36f3SHong Zhang Level: advanced 4157b1cb36f3SHong Zhang 4158b1cb36f3SHong Zhang Notes: 4159b1cb36f3SHong Zhang This function cannot be called until TSAdjointStep() has been completed. 4160b1cb36f3SHong Zhang 4161b1cb36f3SHong Zhang .seealso: TSAdjointSolve(), TSAdjointStep 4162b1cb36f3SHong Zhang @*/ 4163b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts) 4164b1cb36f3SHong Zhang { 4165b1cb36f3SHong Zhang PetscErrorCode ierr; 4166b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4167b1cb36f3SHong 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); 4168b1cb36f3SHong Zhang ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4169b1cb36f3SHong Zhang PetscFunctionReturn(0); 4170b1cb36f3SHong Zhang } 4171b1cb36f3SHong Zhang 4172c88f2d44SBarry Smith /*@ 4173c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4174c88f2d44SBarry Smith 4175c88f2d44SBarry Smith Collective on TS 4176c88f2d44SBarry Smith 4177c88f2d44SBarry Smith Input Parameter: 41782c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 4179c88f2d44SBarry Smith 4180e87fd094SBarry Smith Options Database: 4181e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions 4182e87fd094SBarry Smith 4183c88f2d44SBarry Smith Level: intermediate 4184c88f2d44SBarry Smith 4185c88f2d44SBarry Smith Notes: 4186c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 4187c88f2d44SBarry Smith 418873b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 418973b18844SBarry Smith 4190c88f2d44SBarry Smith .keywords: TS, timestep, solve 4191c88f2d44SBarry Smith 4192b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4193c88f2d44SBarry Smith @*/ 41942c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 4195c88f2d44SBarry Smith { 4196c88f2d44SBarry Smith PetscErrorCode ierr; 4197c88f2d44SBarry Smith 4198c88f2d44SBarry Smith PetscFunctionBegin; 4199c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4200c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 420168bece0bSHong Zhang 4202c88f2d44SBarry Smith /* reset time step and iteration counters */ 4203c88f2d44SBarry Smith ts->steps = 0; 4204c88f2d44SBarry Smith ts->ksp_its = 0; 4205c88f2d44SBarry Smith ts->snes_its = 0; 4206c88f2d44SBarry Smith ts->num_snes_failures = 0; 4207c88f2d44SBarry Smith ts->reject = 0; 4208c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 4209c88f2d44SBarry Smith 421073b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4211c88f2d44SBarry Smith 421273b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4213c88f2d44SBarry Smith while (!ts->reason) { 421455c52731SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 42159110b2e7SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 42166427ac75SLisandro Dalcin ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4217616946c1SHong Zhang ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4218b1cb36f3SHong Zhang if (ts->vec_costintegral && !ts->costintegralfwd) { 4219b1cb36f3SHong Zhang ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4220b1cb36f3SHong Zhang } 4221c88f2d44SBarry Smith } 422226656371SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 422326656371SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4224c88f2d44SBarry Smith ts->solvetime = ts->ptime; 4225e210cd0eSHong Zhang ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4226685405a1SBarry Smith ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4227c88f2d44SBarry Smith PetscFunctionReturn(0); 4228c88f2d44SBarry Smith } 4229c88f2d44SBarry Smith 42307db568b7SBarry Smith /*@C 4231228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4232228d79bcSJed Brown 4233228d79bcSJed Brown Collective on TS 4234228d79bcSJed Brown 4235228d79bcSJed Brown Input Parameters: 4236228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 4237228d79bcSJed Brown . step - step number that has just completed 4238228d79bcSJed Brown . ptime - model time of the state 42390910c330SBarry Smith - u - state at the current model time 4240228d79bcSJed Brown 4241228d79bcSJed Brown Notes: 42427db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 42437db568b7SBarry Smith Users would almost never call this routine directly. 4244228d79bcSJed Brown 424563e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 424663e21af5SBarry Smith 42477db568b7SBarry Smith Level: developer 4248228d79bcSJed Brown 4249228d79bcSJed Brown .keywords: TS, timestep 4250228d79bcSJed Brown @*/ 42510910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4252d763cef2SBarry Smith { 4253d6152f81SLisandro Dalcin DM dm; 4254a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 4255d6152f81SLisandro Dalcin PetscErrorCode ierr; 4256d763cef2SBarry Smith 4257d763cef2SBarry Smith PetscFunctionBegin; 4258b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4259b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4260d6152f81SLisandro Dalcin 4261d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4262d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4263d6152f81SLisandro Dalcin 42645edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 4265d763cef2SBarry Smith for (i=0; i<n; i++) { 42660910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4267d763cef2SBarry Smith } 42685edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 4269d763cef2SBarry Smith PetscFunctionReturn(0); 4270d763cef2SBarry Smith } 4271d763cef2SBarry Smith 42727db568b7SBarry Smith /*@C 42739110b2e7SHong Zhang TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 42749110b2e7SHong Zhang 42759110b2e7SHong Zhang Collective on TS 42769110b2e7SHong Zhang 42779110b2e7SHong Zhang Input Parameters: 42789110b2e7SHong Zhang + ts - time stepping context obtained from TSCreate() 42799110b2e7SHong Zhang . step - step number that has just completed 42809110b2e7SHong Zhang . ptime - model time of the state 42819110b2e7SHong Zhang . u - state at the current model time 42829110b2e7SHong Zhang . numcost - number of cost functions (dimension of lambda or mu) 42839110b2e7SHong Zhang . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 42849110b2e7SHong Zhang - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 42859110b2e7SHong Zhang 42869110b2e7SHong Zhang Notes: 42877db568b7SBarry Smith TSAdjointMonitor() is typically used automatically within the time stepping implementations. 42887db568b7SBarry Smith Users would almost never call this routine directly. 42899110b2e7SHong Zhang 42907db568b7SBarry Smith Level: developer 42919110b2e7SHong Zhang 42929110b2e7SHong Zhang .keywords: TS, timestep 42939110b2e7SHong Zhang @*/ 42949110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 42959110b2e7SHong Zhang { 42969110b2e7SHong Zhang PetscErrorCode ierr; 42979110b2e7SHong Zhang PetscInt i,n = ts->numberadjointmonitors; 42989110b2e7SHong Zhang 42999110b2e7SHong Zhang PetscFunctionBegin; 43009110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 43019110b2e7SHong Zhang PetscValidHeaderSpecific(u,VEC_CLASSID,4); 43029110b2e7SHong Zhang ierr = VecLockPush(u);CHKERRQ(ierr); 43039110b2e7SHong Zhang for (i=0; i<n; i++) { 43049110b2e7SHong Zhang ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 43059110b2e7SHong Zhang } 43069110b2e7SHong Zhang ierr = VecLockPop(u);CHKERRQ(ierr); 43079110b2e7SHong Zhang PetscFunctionReturn(0); 43089110b2e7SHong Zhang } 43099110b2e7SHong Zhang 4310d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 4311d763cef2SBarry Smith /*@C 43127db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4313a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 4314d763cef2SBarry Smith 4315d763cef2SBarry Smith Collective on TS 4316d763cef2SBarry Smith 4317d763cef2SBarry Smith Input Parameters: 4318d763cef2SBarry Smith + host - the X display to open, or null for the local machine 4319d763cef2SBarry Smith . label - the title to put in the title bar 43207c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 4321a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 4322a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4323d763cef2SBarry Smith 4324d763cef2SBarry Smith Output Parameter: 43250b039ecaSBarry Smith . ctx - the context 4326d763cef2SBarry Smith 4327d763cef2SBarry Smith Options Database Key: 43284f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 43297db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 43307db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 43317db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 43327db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4333b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4334d763cef2SBarry Smith 4335d763cef2SBarry Smith Notes: 4336a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 4337d763cef2SBarry Smith 43387db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 43397db568b7SBarry Smith 43407db568b7SBarry 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 43417db568b7SBarry 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 43427db568b7SBarry Smith as the first argument. 43437db568b7SBarry Smith 43447db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 43457db568b7SBarry Smith 43467db568b7SBarry Smith 4347d763cef2SBarry Smith Level: intermediate 4348d763cef2SBarry Smith 43497db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 4350d763cef2SBarry Smith 43517db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 43527db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 43537db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 43547db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 43557db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 43567c922b88SBarry Smith 4357d763cef2SBarry Smith @*/ 4358a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4359d763cef2SBarry Smith { 43607f52daa2SLisandro Dalcin PetscDraw draw; 4361dfbe8321SBarry Smith PetscErrorCode ierr; 4362d763cef2SBarry Smith 4363d763cef2SBarry Smith PetscFunctionBegin; 4364b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 43657f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 43667f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 43677f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4368287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 43697f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4370a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4371d763cef2SBarry Smith PetscFunctionReturn(0); 4372d763cef2SBarry Smith } 4373d763cef2SBarry Smith 4374b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4375d763cef2SBarry Smith { 43760b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4377c32365f1SBarry Smith PetscReal x = ptime,y; 4378dfbe8321SBarry Smith PetscErrorCode ierr; 4379d763cef2SBarry Smith 4380d763cef2SBarry Smith PetscFunctionBegin; 438163e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4382b06615a5SLisandro Dalcin if (!step) { 4383a9f9c1f6SBarry Smith PetscDrawAxis axis; 4384a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 43856934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4386a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4387a9f9c1f6SBarry Smith } 4388c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 43890b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4390b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 43910b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 43926934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 43933923b477SBarry Smith } 4394d763cef2SBarry Smith PetscFunctionReturn(0); 4395d763cef2SBarry Smith } 4396d763cef2SBarry Smith 4397d763cef2SBarry Smith /*@C 4398a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4399a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4400d763cef2SBarry Smith 44010b039ecaSBarry Smith Collective on TSMonitorLGCtx 4402d763cef2SBarry Smith 4403d763cef2SBarry Smith Input Parameter: 44040b039ecaSBarry Smith . ctx - the monitor context 4405d763cef2SBarry Smith 4406d763cef2SBarry Smith Level: intermediate 4407d763cef2SBarry Smith 4408d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 4409d763cef2SBarry Smith 44104f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4411d763cef2SBarry Smith @*/ 4412a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4413d763cef2SBarry Smith { 4414dfbe8321SBarry Smith PetscErrorCode ierr; 4415d763cef2SBarry Smith 4416d763cef2SBarry Smith PetscFunctionBegin; 44177684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 44187684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 44197684fa3eSBarry Smith } 44200b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 442131152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4422387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4423387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4424387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 44250b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4426d763cef2SBarry Smith PetscFunctionReturn(0); 4427d763cef2SBarry Smith } 4428d763cef2SBarry Smith 4429d763cef2SBarry Smith /*@ 4430b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4431d763cef2SBarry Smith 4432d763cef2SBarry Smith Not Collective 4433d763cef2SBarry Smith 4434d763cef2SBarry Smith Input Parameter: 4435d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4436d763cef2SBarry Smith 4437d763cef2SBarry Smith Output Parameter: 443863e21af5SBarry Smith . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4439d763cef2SBarry Smith 4440d763cef2SBarry Smith Level: beginner 4441d763cef2SBarry Smith 4442b8123daeSJed Brown Note: 4443b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 44449be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4445b8123daeSJed Brown 444663e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4447d763cef2SBarry Smith 4448d763cef2SBarry Smith .keywords: TS, get, time 4449d763cef2SBarry Smith @*/ 44507087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4451d763cef2SBarry Smith { 4452d763cef2SBarry Smith PetscFunctionBegin; 44530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4454f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4455d763cef2SBarry Smith *t = ts->ptime; 4456d763cef2SBarry Smith PetscFunctionReturn(0); 4457d763cef2SBarry Smith } 4458d763cef2SBarry Smith 4459e5e524a1SHong Zhang /*@ 4460e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4461e5e524a1SHong Zhang 4462e5e524a1SHong Zhang Not Collective 4463e5e524a1SHong Zhang 4464e5e524a1SHong Zhang Input Parameter: 4465e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4466e5e524a1SHong Zhang 4467e5e524a1SHong Zhang Output Parameter: 4468e5e524a1SHong Zhang . t - the previous time 4469e5e524a1SHong Zhang 4470e5e524a1SHong Zhang Level: beginner 4471e5e524a1SHong Zhang 4472e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4473e5e524a1SHong Zhang 4474e5e524a1SHong Zhang .keywords: TS, get, time 4475e5e524a1SHong Zhang @*/ 4476e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4477e5e524a1SHong Zhang { 4478e5e524a1SHong Zhang PetscFunctionBegin; 4479e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4480e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4481e5e524a1SHong Zhang *t = ts->ptime_prev; 4482e5e524a1SHong Zhang PetscFunctionReturn(0); 4483e5e524a1SHong Zhang } 4484e5e524a1SHong Zhang 44856a4d4014SLisandro Dalcin /*@ 44866a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 44876a4d4014SLisandro Dalcin 44883f9fe445SBarry Smith Logically Collective on TS 44896a4d4014SLisandro Dalcin 44906a4d4014SLisandro Dalcin Input Parameters: 44916a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 44926a4d4014SLisandro Dalcin - time - the time 44936a4d4014SLisandro Dalcin 44946a4d4014SLisandro Dalcin Level: intermediate 44956a4d4014SLisandro Dalcin 44966a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 44976a4d4014SLisandro Dalcin 44986a4d4014SLisandro Dalcin .keywords: TS, set, time 44996a4d4014SLisandro Dalcin @*/ 45007087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 45016a4d4014SLisandro Dalcin { 45026a4d4014SLisandro Dalcin PetscFunctionBegin; 45030700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4504c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 45056a4d4014SLisandro Dalcin ts->ptime = t; 45066a4d4014SLisandro Dalcin PetscFunctionReturn(0); 45076a4d4014SLisandro Dalcin } 45086a4d4014SLisandro Dalcin 4509d763cef2SBarry Smith /*@C 4510d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4511d763cef2SBarry Smith TS options in the database. 4512d763cef2SBarry Smith 45133f9fe445SBarry Smith Logically Collective on TS 4514d763cef2SBarry Smith 4515d763cef2SBarry Smith Input Parameter: 4516d763cef2SBarry Smith + ts - The TS context 4517d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4518d763cef2SBarry Smith 4519d763cef2SBarry Smith Notes: 4520d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4521d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4522d763cef2SBarry Smith hyphen. 4523d763cef2SBarry Smith 4524d763cef2SBarry Smith Level: advanced 4525d763cef2SBarry Smith 4526d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4527d763cef2SBarry Smith 4528d763cef2SBarry Smith .seealso: TSSetFromOptions() 4529d763cef2SBarry Smith 4530d763cef2SBarry Smith @*/ 45317087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4532d763cef2SBarry Smith { 4533dfbe8321SBarry Smith PetscErrorCode ierr; 4534089b2837SJed Brown SNES snes; 4535d763cef2SBarry Smith 4536d763cef2SBarry Smith PetscFunctionBegin; 45370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4538d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4539089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4540089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4541d763cef2SBarry Smith PetscFunctionReturn(0); 4542d763cef2SBarry Smith } 4543d763cef2SBarry Smith 4544d763cef2SBarry Smith 4545d763cef2SBarry Smith /*@C 4546d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4547d763cef2SBarry Smith TS options in the database. 4548d763cef2SBarry Smith 45493f9fe445SBarry Smith Logically Collective on TS 4550d763cef2SBarry Smith 4551d763cef2SBarry Smith Input Parameter: 4552d763cef2SBarry Smith + ts - The TS context 4553d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4554d763cef2SBarry Smith 4555d763cef2SBarry Smith Notes: 4556d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4557d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4558d763cef2SBarry Smith hyphen. 4559d763cef2SBarry Smith 4560d763cef2SBarry Smith Level: advanced 4561d763cef2SBarry Smith 4562d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4563d763cef2SBarry Smith 4564d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4565d763cef2SBarry Smith 4566d763cef2SBarry Smith @*/ 45677087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4568d763cef2SBarry Smith { 4569dfbe8321SBarry Smith PetscErrorCode ierr; 4570089b2837SJed Brown SNES snes; 4571d763cef2SBarry Smith 4572d763cef2SBarry Smith PetscFunctionBegin; 45730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4574d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4575089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4576089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4577d763cef2SBarry Smith PetscFunctionReturn(0); 4578d763cef2SBarry Smith } 4579d763cef2SBarry Smith 4580d763cef2SBarry Smith /*@C 4581d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4582d763cef2SBarry Smith TS options in the database. 4583d763cef2SBarry Smith 4584d763cef2SBarry Smith Not Collective 4585d763cef2SBarry Smith 4586d763cef2SBarry Smith Input Parameter: 4587d763cef2SBarry Smith . ts - The TS context 4588d763cef2SBarry Smith 4589d763cef2SBarry Smith Output Parameter: 4590d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4591d763cef2SBarry Smith 4592d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 4593d763cef2SBarry Smith sufficient length to hold the prefix. 4594d763cef2SBarry Smith 4595d763cef2SBarry Smith Level: intermediate 4596d763cef2SBarry Smith 4597d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4598d763cef2SBarry Smith 4599d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4600d763cef2SBarry Smith @*/ 46017087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4602d763cef2SBarry Smith { 4603dfbe8321SBarry Smith PetscErrorCode ierr; 4604d763cef2SBarry Smith 4605d763cef2SBarry Smith PetscFunctionBegin; 46060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46074482741eSBarry Smith PetscValidPointer(prefix,2); 4608d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4609d763cef2SBarry Smith PetscFunctionReturn(0); 4610d763cef2SBarry Smith } 4611d763cef2SBarry Smith 4612d763cef2SBarry Smith /*@C 4613d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4614d763cef2SBarry Smith 4615d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4616d763cef2SBarry Smith 4617d763cef2SBarry Smith Input Parameter: 4618d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4619d763cef2SBarry Smith 4620d763cef2SBarry Smith Output Parameters: 4621e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4622e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4623e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4624e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4625d763cef2SBarry Smith 46260298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 4627d763cef2SBarry Smith 4628d763cef2SBarry Smith Level: intermediate 4629d763cef2SBarry Smith 463026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 4631d763cef2SBarry Smith 4632d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4633d763cef2SBarry Smith @*/ 4634e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4635d763cef2SBarry Smith { 4636089b2837SJed Brown PetscErrorCode ierr; 463724989b8cSPeter Brune DM dm; 4638089b2837SJed Brown 4639d763cef2SBarry Smith PetscFunctionBegin; 464023a57915SBarry Smith if (Amat || Pmat) { 464123a57915SBarry Smith SNES snes; 4642089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 464323a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4644e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 464523a57915SBarry Smith } 464624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 464724989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4648d763cef2SBarry Smith PetscFunctionReturn(0); 4649d763cef2SBarry Smith } 4650d763cef2SBarry Smith 46512eca1d9cSJed Brown /*@C 46522eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 46532eca1d9cSJed Brown 46542eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 46552eca1d9cSJed Brown 46562eca1d9cSJed Brown Input Parameter: 46572eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 46582eca1d9cSJed Brown 46592eca1d9cSJed Brown Output Parameters: 4660e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4661e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 46622eca1d9cSJed Brown . f - The function to compute the matrices 46632eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 46642eca1d9cSJed Brown 46650298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 46662eca1d9cSJed Brown 46672eca1d9cSJed Brown Level: advanced 46682eca1d9cSJed Brown 46692eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber() 46702eca1d9cSJed Brown 46712eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 46722eca1d9cSJed Brown @*/ 4673e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 46742eca1d9cSJed Brown { 4675089b2837SJed Brown PetscErrorCode ierr; 467624989b8cSPeter Brune DM dm; 46770910c330SBarry Smith 46782eca1d9cSJed Brown PetscFunctionBegin; 4679c0aab802Sstefano_zampini if (Amat || Pmat) { 4680c0aab802Sstefano_zampini SNES snes; 4681089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4682f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4683e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4684c0aab802Sstefano_zampini } 468524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 468624989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 46872eca1d9cSJed Brown PetscFunctionReturn(0); 46882eca1d9cSJed Brown } 46892eca1d9cSJed Brown 46906083293cSBarry Smith 46911713a123SBarry Smith /*@C 469283a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 46931713a123SBarry Smith VecView() for the solution at each timestep 46941713a123SBarry Smith 46951713a123SBarry Smith Collective on TS 46961713a123SBarry Smith 46971713a123SBarry Smith Input Parameters: 46981713a123SBarry Smith + ts - the TS context 46991713a123SBarry Smith . step - current time-step 4700142b95e3SSatish Balay . ptime - current time 47010298fd71SBarry Smith - dummy - either a viewer or NULL 47021713a123SBarry Smith 470399fdda47SBarry Smith Options Database: 470499fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 470599fdda47SBarry Smith 4706387f4636SBarry 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 470799fdda47SBarry Smith will look bad 470899fdda47SBarry Smith 47091713a123SBarry Smith Level: intermediate 47101713a123SBarry Smith 47111713a123SBarry Smith .keywords: TS, vector, monitor, view 47121713a123SBarry Smith 4713a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 47141713a123SBarry Smith @*/ 47150910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 47161713a123SBarry Smith { 4717dfbe8321SBarry Smith PetscErrorCode ierr; 471883a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4719473a3ab2SBarry Smith PetscDraw draw; 47201713a123SBarry Smith 47211713a123SBarry Smith PetscFunctionBegin; 47226083293cSBarry Smith if (!step && ictx->showinitial) { 47236083293cSBarry Smith if (!ictx->initialsolution) { 47240910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 47251713a123SBarry Smith } 47260910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 47276083293cSBarry Smith } 4728b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47290dcf80beSBarry Smith 47306083293cSBarry Smith if (ictx->showinitial) { 47316083293cSBarry Smith PetscReal pause; 47326083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 47336083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 47346083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 47356083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 47366083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 47376083293cSBarry Smith } 47380910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4739473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 474051fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4741473a3ab2SBarry Smith char time[32]; 4742473a3ab2SBarry Smith 4743473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 474485b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4745473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4746473a3ab2SBarry Smith h = yl + .95*(yr - yl); 474751fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4748473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4749473a3ab2SBarry Smith } 4750473a3ab2SBarry Smith 47516083293cSBarry Smith if (ictx->showinitial) { 47526083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 47536083293cSBarry Smith } 47541713a123SBarry Smith PetscFunctionReturn(0); 47551713a123SBarry Smith } 47561713a123SBarry Smith 47579110b2e7SHong Zhang /*@C 47589110b2e7SHong Zhang TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 47599110b2e7SHong Zhang VecView() for the sensitivities to initial states at each timestep 47609110b2e7SHong Zhang 47619110b2e7SHong Zhang Collective on TS 47629110b2e7SHong Zhang 47639110b2e7SHong Zhang Input Parameters: 47649110b2e7SHong Zhang + ts - the TS context 47659110b2e7SHong Zhang . step - current time-step 47669110b2e7SHong Zhang . ptime - current time 47679110b2e7SHong Zhang . u - current state 47689110b2e7SHong Zhang . numcost - number of cost functions 47699110b2e7SHong Zhang . lambda - sensitivities to initial conditions 47709110b2e7SHong Zhang . mu - sensitivities to parameters 47719110b2e7SHong Zhang - dummy - either a viewer or NULL 47729110b2e7SHong Zhang 47739110b2e7SHong Zhang Level: intermediate 47749110b2e7SHong Zhang 47759110b2e7SHong Zhang .keywords: TS, vector, adjoint, monitor, view 47769110b2e7SHong Zhang 47779110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 47789110b2e7SHong Zhang @*/ 47799110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 47809110b2e7SHong Zhang { 47819110b2e7SHong Zhang PetscErrorCode ierr; 47829110b2e7SHong Zhang TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 47839110b2e7SHong Zhang PetscDraw draw; 4784a0046e2cSSatish Balay PetscReal xl,yl,xr,yr,h; 4785a0046e2cSSatish Balay char time[32]; 47869110b2e7SHong Zhang 47879110b2e7SHong Zhang PetscFunctionBegin; 47889110b2e7SHong Zhang if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 47899110b2e7SHong Zhang 47909110b2e7SHong Zhang ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 47919110b2e7SHong Zhang ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 47929110b2e7SHong Zhang ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 47939110b2e7SHong Zhang ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 47949110b2e7SHong Zhang h = yl + .95*(yr - yl); 47959110b2e7SHong Zhang ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 47969110b2e7SHong Zhang ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 47979110b2e7SHong Zhang PetscFunctionReturn(0); 47989110b2e7SHong Zhang } 47999110b2e7SHong Zhang 48002d5ee99bSBarry Smith /*@C 48012d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 48022d5ee99bSBarry Smith 48032d5ee99bSBarry Smith Collective on TS 48042d5ee99bSBarry Smith 48052d5ee99bSBarry Smith Input Parameters: 48062d5ee99bSBarry Smith + ts - the TS context 48072d5ee99bSBarry Smith . step - current time-step 48082d5ee99bSBarry Smith . ptime - current time 48092d5ee99bSBarry Smith - dummy - either a viewer or NULL 48102d5ee99bSBarry Smith 48112d5ee99bSBarry Smith Level: intermediate 48122d5ee99bSBarry Smith 48132d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 48142d5ee99bSBarry Smith 48152d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 48162d5ee99bSBarry Smith @*/ 48172d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 48182d5ee99bSBarry Smith { 48192d5ee99bSBarry Smith PetscErrorCode ierr; 48202d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 48212d5ee99bSBarry Smith PetscDraw draw; 48226934998bSLisandro Dalcin PetscDrawAxis axis; 48232d5ee99bSBarry Smith PetscInt n; 48242d5ee99bSBarry Smith PetscMPIInt size; 48256934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 48262d5ee99bSBarry Smith char time[32]; 48272d5ee99bSBarry Smith const PetscScalar *U; 48282d5ee99bSBarry Smith 48292d5ee99bSBarry Smith PetscFunctionBegin; 48306934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 48316934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 48322d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 48336934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 48342d5ee99bSBarry Smith 48352d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 48366934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 48376934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 48386934998bSLisandro Dalcin if (!step) { 48396934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 48406934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 48416934998bSLisandro Dalcin } 48422d5ee99bSBarry Smith 48432d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 48446934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 48456934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4846a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 48476934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 48482d5ee99bSBarry Smith 48496934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 48506934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 48512d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 48524b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 485385b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 48542d5ee99bSBarry Smith h = yl + .95*(yr - yl); 485551fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 48562d5ee99bSBarry Smith } 48576934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 48582d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 48596934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 48602d5ee99bSBarry Smith PetscFunctionReturn(0); 48612d5ee99bSBarry Smith } 48622d5ee99bSBarry Smith 48631713a123SBarry Smith 48646083293cSBarry Smith /*@C 486583a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 48666083293cSBarry Smith 48676083293cSBarry Smith Collective on TS 48686083293cSBarry Smith 48696083293cSBarry Smith Input Parameters: 48706083293cSBarry Smith . ctx - the monitor context 48716083293cSBarry Smith 48726083293cSBarry Smith Level: intermediate 48736083293cSBarry Smith 48746083293cSBarry Smith .keywords: TS, vector, monitor, view 48756083293cSBarry Smith 487683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 48776083293cSBarry Smith @*/ 487883a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 48796083293cSBarry Smith { 48806083293cSBarry Smith PetscErrorCode ierr; 48816083293cSBarry Smith 48826083293cSBarry Smith PetscFunctionBegin; 488383a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 488483a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 488583a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 48866083293cSBarry Smith PetscFunctionReturn(0); 48876083293cSBarry Smith } 48886083293cSBarry Smith 48896083293cSBarry Smith /*@C 489083a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 48916083293cSBarry Smith 48926083293cSBarry Smith Collective on TS 48936083293cSBarry Smith 48946083293cSBarry Smith Input Parameter: 48956083293cSBarry Smith . ts - time-step context 48966083293cSBarry Smith 48976083293cSBarry Smith Output Patameter: 48986083293cSBarry Smith . ctx - the monitor context 48996083293cSBarry Smith 490099fdda47SBarry Smith Options Database: 490199fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 490299fdda47SBarry Smith 49036083293cSBarry Smith Level: intermediate 49046083293cSBarry Smith 49056083293cSBarry Smith .keywords: TS, vector, monitor, view 49066083293cSBarry Smith 490783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 49086083293cSBarry Smith @*/ 490983a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 49106083293cSBarry Smith { 49116083293cSBarry Smith PetscErrorCode ierr; 49126083293cSBarry Smith 49136083293cSBarry Smith PetscFunctionBegin; 4914b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 491583a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4916e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4917bbd56ea5SKarl Rupp 491883a4ac43SBarry Smith (*ctx)->howoften = howoften; 4919473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4920c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4921473a3ab2SBarry Smith 4922473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4923c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 49246083293cSBarry Smith PetscFunctionReturn(0); 49256083293cSBarry Smith } 49266083293cSBarry Smith 49273a471f94SBarry Smith /*@C 492883a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 49293a471f94SBarry Smith VecView() for the error at each timestep 49303a471f94SBarry Smith 49313a471f94SBarry Smith Collective on TS 49323a471f94SBarry Smith 49333a471f94SBarry Smith Input Parameters: 49343a471f94SBarry Smith + ts - the TS context 49353a471f94SBarry Smith . step - current time-step 49363a471f94SBarry Smith . ptime - current time 49370298fd71SBarry Smith - dummy - either a viewer or NULL 49383a471f94SBarry Smith 49393a471f94SBarry Smith Level: intermediate 49403a471f94SBarry Smith 49413a471f94SBarry Smith .keywords: TS, vector, monitor, view 49423a471f94SBarry Smith 49433a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 49443a471f94SBarry Smith @*/ 49450910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 49463a471f94SBarry Smith { 49473a471f94SBarry Smith PetscErrorCode ierr; 494883a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 494983a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 49503a471f94SBarry Smith Vec work; 49513a471f94SBarry Smith 49523a471f94SBarry Smith PetscFunctionBegin; 4953b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 49540910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 49553a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 49560910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 49573a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 49583a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 49593a471f94SBarry Smith PetscFunctionReturn(0); 49603a471f94SBarry Smith } 49613a471f94SBarry Smith 4962af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 49636c699258SBarry Smith /*@ 49642a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 49656c699258SBarry Smith 49663f9fe445SBarry Smith Logically Collective on TS and DM 49676c699258SBarry Smith 49686c699258SBarry Smith Input Parameters: 49692a808120SBarry Smith + ts - the ODE integrator object 49702a808120SBarry Smith - dm - the dm, cannot be NULL 49716c699258SBarry Smith 49726c699258SBarry Smith Level: intermediate 49736c699258SBarry Smith 49746c699258SBarry Smith 49756c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 49766c699258SBarry Smith @*/ 49777087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 49786c699258SBarry Smith { 49796c699258SBarry Smith PetscErrorCode ierr; 4980089b2837SJed Brown SNES snes; 4981942e3340SBarry Smith DMTS tsdm; 49826c699258SBarry Smith 49836c699258SBarry Smith PetscFunctionBegin; 49840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49852a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 498670663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4987942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 49882a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4989942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4990942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 499124989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 499224989b8cSPeter Brune tsdm->originaldm = dm; 499324989b8cSPeter Brune } 499424989b8cSPeter Brune } 49956bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 499624989b8cSPeter Brune } 49976c699258SBarry Smith ts->dm = dm; 4998bbd56ea5SKarl Rupp 4999089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 5000089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 50016c699258SBarry Smith PetscFunctionReturn(0); 50026c699258SBarry Smith } 50036c699258SBarry Smith 50046c699258SBarry Smith /*@ 50056c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 50066c699258SBarry Smith 50073f9fe445SBarry Smith Not Collective 50086c699258SBarry Smith 50096c699258SBarry Smith Input Parameter: 50106c699258SBarry Smith . ts - the preconditioner context 50116c699258SBarry Smith 50126c699258SBarry Smith Output Parameter: 50136c699258SBarry Smith . dm - the dm 50146c699258SBarry Smith 50156c699258SBarry Smith Level: intermediate 50166c699258SBarry Smith 50176c699258SBarry Smith 50186c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 50196c699258SBarry Smith @*/ 50207087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 50216c699258SBarry Smith { 5022496e6a7aSJed Brown PetscErrorCode ierr; 5023496e6a7aSJed Brown 50246c699258SBarry Smith PetscFunctionBegin; 50250700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5026496e6a7aSJed Brown if (!ts->dm) { 5027ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 5028496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 5029496e6a7aSJed Brown } 50306c699258SBarry Smith *dm = ts->dm; 50316c699258SBarry Smith PetscFunctionReturn(0); 50326c699258SBarry Smith } 50331713a123SBarry Smith 50340f5c6efeSJed Brown /*@ 50350f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 50360f5c6efeSJed Brown 50373f9fe445SBarry Smith Logically Collective on SNES 50380f5c6efeSJed Brown 50390f5c6efeSJed Brown Input Parameter: 5040d42a1c89SJed Brown + snes - nonlinear solver 50410910c330SBarry Smith . U - the current state at which to evaluate the residual 5042d42a1c89SJed Brown - ctx - user context, must be a TS 50430f5c6efeSJed Brown 50440f5c6efeSJed Brown Output Parameter: 50450f5c6efeSJed Brown . F - the nonlinear residual 50460f5c6efeSJed Brown 50470f5c6efeSJed Brown Notes: 50480f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50490f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 50500f5c6efeSJed Brown 50510f5c6efeSJed Brown Level: advanced 50520f5c6efeSJed Brown 50530f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 50540f5c6efeSJed Brown @*/ 50550910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 50560f5c6efeSJed Brown { 50570f5c6efeSJed Brown TS ts = (TS)ctx; 50580f5c6efeSJed Brown PetscErrorCode ierr; 50590f5c6efeSJed Brown 50600f5c6efeSJed Brown PetscFunctionBegin; 50610f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50620910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50630f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 50640f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 50650910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 50660f5c6efeSJed Brown PetscFunctionReturn(0); 50670f5c6efeSJed Brown } 50680f5c6efeSJed Brown 50690f5c6efeSJed Brown /*@ 50700f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 50710f5c6efeSJed Brown 50720f5c6efeSJed Brown Collective on SNES 50730f5c6efeSJed Brown 50740f5c6efeSJed Brown Input Parameter: 50750f5c6efeSJed Brown + snes - nonlinear solver 50760910c330SBarry Smith . U - the current state at which to evaluate the residual 50770f5c6efeSJed Brown - ctx - user context, must be a TS 50780f5c6efeSJed Brown 50790f5c6efeSJed Brown Output Parameter: 50800f5c6efeSJed Brown + A - the Jacobian 50810f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 50820f5c6efeSJed Brown - flag - indicates any structure change in the matrix 50830f5c6efeSJed Brown 50840f5c6efeSJed Brown Notes: 50850f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50860f5c6efeSJed Brown 50870f5c6efeSJed Brown Level: developer 50880f5c6efeSJed Brown 50890f5c6efeSJed Brown .seealso: SNESSetJacobian() 50900f5c6efeSJed Brown @*/ 5091d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 50920f5c6efeSJed Brown { 50930f5c6efeSJed Brown TS ts = (TS)ctx; 50940f5c6efeSJed Brown PetscErrorCode ierr; 50950f5c6efeSJed Brown 50960f5c6efeSJed Brown PetscFunctionBegin; 50970f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50980910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50990f5c6efeSJed Brown PetscValidPointer(A,3); 510094ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 51010f5c6efeSJed Brown PetscValidPointer(B,4); 510294ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 51030f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5104d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 51050f5c6efeSJed Brown PetscFunctionReturn(0); 51060f5c6efeSJed Brown } 5107325fc9f4SBarry Smith 51080e4ef248SJed Brown /*@C 51099ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 51100e4ef248SJed Brown 51110e4ef248SJed Brown Collective on TS 51120e4ef248SJed Brown 51130e4ef248SJed Brown Input Arguments: 51140e4ef248SJed Brown + ts - time stepping context 51150e4ef248SJed Brown . t - time at which to evaluate 51160910c330SBarry Smith . U - state at which to evaluate 51170e4ef248SJed Brown - ctx - context 51180e4ef248SJed Brown 51190e4ef248SJed Brown Output Arguments: 51200e4ef248SJed Brown . F - right hand side 51210e4ef248SJed Brown 51220e4ef248SJed Brown Level: intermediate 51230e4ef248SJed Brown 51240e4ef248SJed Brown Notes: 51250e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 51260e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 51270e4ef248SJed Brown 51280e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 51290e4ef248SJed Brown @*/ 51300910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 51310e4ef248SJed Brown { 51320e4ef248SJed Brown PetscErrorCode ierr; 51330e4ef248SJed Brown Mat Arhs,Brhs; 51340e4ef248SJed Brown 51350e4ef248SJed Brown PetscFunctionBegin; 51360e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5137d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 51380910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 51390e4ef248SJed Brown PetscFunctionReturn(0); 51400e4ef248SJed Brown } 51410e4ef248SJed Brown 51420e4ef248SJed Brown /*@C 51430e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 51440e4ef248SJed Brown 51450e4ef248SJed Brown Collective on TS 51460e4ef248SJed Brown 51470e4ef248SJed Brown Input Arguments: 51480e4ef248SJed Brown + ts - time stepping context 51490e4ef248SJed Brown . t - time at which to evaluate 51500910c330SBarry Smith . U - state at which to evaluate 51510e4ef248SJed Brown - ctx - context 51520e4ef248SJed Brown 51530e4ef248SJed Brown Output Arguments: 51540e4ef248SJed Brown + A - pointer to operator 51550e4ef248SJed Brown . B - pointer to preconditioning matrix 51560e4ef248SJed Brown - flg - matrix structure flag 51570e4ef248SJed Brown 51580e4ef248SJed Brown Level: intermediate 51590e4ef248SJed Brown 51600e4ef248SJed Brown Notes: 51610e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 51620e4ef248SJed Brown 51630e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 51640e4ef248SJed Brown @*/ 5165d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 51660e4ef248SJed Brown { 51670e4ef248SJed Brown PetscFunctionBegin; 51680e4ef248SJed Brown PetscFunctionReturn(0); 51690e4ef248SJed Brown } 51700e4ef248SJed Brown 51710026cea9SSean Farley /*@C 51720026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 51730026cea9SSean Farley 51740026cea9SSean Farley Collective on TS 51750026cea9SSean Farley 51760026cea9SSean Farley Input Arguments: 51770026cea9SSean Farley + ts - time stepping context 51780026cea9SSean Farley . t - time at which to evaluate 51790910c330SBarry Smith . U - state at which to evaluate 51800910c330SBarry Smith . Udot - time derivative of state vector 51810026cea9SSean Farley - ctx - context 51820026cea9SSean Farley 51830026cea9SSean Farley Output Arguments: 51840026cea9SSean Farley . F - left hand side 51850026cea9SSean Farley 51860026cea9SSean Farley Level: intermediate 51870026cea9SSean Farley 51880026cea9SSean Farley Notes: 51890910c330SBarry 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 51900026cea9SSean Farley user is required to write their own TSComputeIFunction. 51910026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 51920026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 51930026cea9SSean Farley 51949ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 51959ae8fd06SBarry Smith 51969ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 51970026cea9SSean Farley @*/ 51980910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 51990026cea9SSean Farley { 52000026cea9SSean Farley PetscErrorCode ierr; 52010026cea9SSean Farley Mat A,B; 52020026cea9SSean Farley 52030026cea9SSean Farley PetscFunctionBegin; 52040298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5205d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 52060910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 52070026cea9SSean Farley PetscFunctionReturn(0); 52080026cea9SSean Farley } 52090026cea9SSean Farley 52100026cea9SSean Farley /*@C 5211b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 52120026cea9SSean Farley 52130026cea9SSean Farley Collective on TS 52140026cea9SSean Farley 52150026cea9SSean Farley Input Arguments: 52160026cea9SSean Farley + ts - time stepping context 52170026cea9SSean Farley . t - time at which to evaluate 52180910c330SBarry Smith . U - state at which to evaluate 52190910c330SBarry Smith . Udot - time derivative of state vector 52200026cea9SSean Farley . shift - shift to apply 52210026cea9SSean Farley - ctx - context 52220026cea9SSean Farley 52230026cea9SSean Farley Output Arguments: 52240026cea9SSean Farley + A - pointer to operator 52250026cea9SSean Farley . B - pointer to preconditioning matrix 52260026cea9SSean Farley - flg - matrix structure flag 52270026cea9SSean Farley 5228b41af12eSJed Brown Level: advanced 52290026cea9SSean Farley 52300026cea9SSean Farley Notes: 52310026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 52320026cea9SSean Farley 5233b41af12eSJed Brown It is only appropriate for problems of the form 5234b41af12eSJed Brown 5235b41af12eSJed Brown $ M Udot = F(U,t) 5236b41af12eSJed Brown 5237b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5238b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5239b41af12eSJed Brown an implicit operator of the form 5240b41af12eSJed Brown 5241b41af12eSJed Brown $ shift*M + J 5242b41af12eSJed Brown 5243b41af12eSJed 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 5244b41af12eSJed Brown a copy of M or reassemble it when requested. 5245b41af12eSJed Brown 52460026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 52470026cea9SSean Farley @*/ 5248d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 52490026cea9SSean Farley { 5250b41af12eSJed Brown PetscErrorCode ierr; 5251b41af12eSJed Brown 52520026cea9SSean Farley PetscFunctionBegin; 525394ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5254b41af12eSJed Brown ts->ijacobian.shift = shift; 52550026cea9SSean Farley PetscFunctionReturn(0); 52560026cea9SSean Farley } 5257b41af12eSJed Brown 5258e817cc15SEmil Constantinescu /*@ 5259e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 5260e817cc15SEmil Constantinescu 5261e817cc15SEmil Constantinescu Not Collective 5262e817cc15SEmil Constantinescu 5263e817cc15SEmil Constantinescu Input Parameter: 5264e817cc15SEmil Constantinescu . ts - the TS context 5265e817cc15SEmil Constantinescu 5266e817cc15SEmil Constantinescu Output Parameter: 52674e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 5268e817cc15SEmil Constantinescu 5269e817cc15SEmil Constantinescu Level: beginner 5270e817cc15SEmil Constantinescu 5271e817cc15SEmil Constantinescu .keywords: TS, equation type 5272e817cc15SEmil Constantinescu 5273e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 5274e817cc15SEmil Constantinescu @*/ 5275e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5276e817cc15SEmil Constantinescu { 5277e817cc15SEmil Constantinescu PetscFunctionBegin; 5278e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5279e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 5280e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 5281e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5282e817cc15SEmil Constantinescu } 5283e817cc15SEmil Constantinescu 5284e817cc15SEmil Constantinescu /*@ 5285e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 5286e817cc15SEmil Constantinescu 5287e817cc15SEmil Constantinescu Not Collective 5288e817cc15SEmil Constantinescu 5289e817cc15SEmil Constantinescu Input Parameter: 5290e817cc15SEmil Constantinescu + ts - the TS context 52911297b224SEmil Constantinescu - equation_type - see TSEquationType 5292e817cc15SEmil Constantinescu 5293e817cc15SEmil Constantinescu Level: advanced 5294e817cc15SEmil Constantinescu 5295e817cc15SEmil Constantinescu .keywords: TS, equation type 5296e817cc15SEmil Constantinescu 5297e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 5298e817cc15SEmil Constantinescu @*/ 5299e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5300e817cc15SEmil Constantinescu { 5301e817cc15SEmil Constantinescu PetscFunctionBegin; 5302e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5303e817cc15SEmil Constantinescu ts->equation_type = equation_type; 5304e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5305e817cc15SEmil Constantinescu } 53060026cea9SSean Farley 53074af1b03aSJed Brown /*@ 53084af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 53094af1b03aSJed Brown 53104af1b03aSJed Brown Not Collective 53114af1b03aSJed Brown 53124af1b03aSJed Brown Input Parameter: 53134af1b03aSJed Brown . ts - the TS context 53144af1b03aSJed Brown 53154af1b03aSJed Brown Output Parameter: 53164af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 53174af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 53184af1b03aSJed Brown 5319487e0bb9SJed Brown Level: beginner 53204af1b03aSJed Brown 5321cd652676SJed Brown Notes: 5322cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 53234af1b03aSJed Brown 53244af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 53254af1b03aSJed Brown 53264af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 53274af1b03aSJed Brown @*/ 53284af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 53294af1b03aSJed Brown { 53304af1b03aSJed Brown PetscFunctionBegin; 53314af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53324af1b03aSJed Brown PetscValidPointer(reason,2); 53334af1b03aSJed Brown *reason = ts->reason; 53344af1b03aSJed Brown PetscFunctionReturn(0); 53354af1b03aSJed Brown } 53364af1b03aSJed Brown 5337d6ad946cSShri Abhyankar /*@ 5338d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5339d6ad946cSShri Abhyankar 5340d6ad946cSShri Abhyankar Not Collective 5341d6ad946cSShri Abhyankar 5342d6ad946cSShri Abhyankar Input Parameter: 5343d6ad946cSShri Abhyankar + ts - the TS context 5344d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5345d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5346d6ad946cSShri Abhyankar 5347f5abba47SShri Abhyankar Level: advanced 5348d6ad946cSShri Abhyankar 5349d6ad946cSShri Abhyankar Notes: 5350d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 5351d6ad946cSShri Abhyankar 5352d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 5353d6ad946cSShri Abhyankar 5354d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5355d6ad946cSShri Abhyankar @*/ 5356d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5357d6ad946cSShri Abhyankar { 5358d6ad946cSShri Abhyankar PetscFunctionBegin; 5359d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5360d6ad946cSShri Abhyankar ts->reason = reason; 5361d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5362d6ad946cSShri Abhyankar } 5363d6ad946cSShri Abhyankar 5364cc708dedSBarry Smith /*@ 5365cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5366cc708dedSBarry Smith 5367cc708dedSBarry Smith Not Collective 5368cc708dedSBarry Smith 5369cc708dedSBarry Smith Input Parameter: 5370cc708dedSBarry Smith . ts - the TS context 5371cc708dedSBarry Smith 5372cc708dedSBarry Smith Output Parameter: 537363e21af5SBarry Smith . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5374cc708dedSBarry Smith 5375487e0bb9SJed Brown Level: beginner 5376cc708dedSBarry Smith 5377cc708dedSBarry Smith Notes: 5378cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5379cc708dedSBarry Smith 5380cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 5381cc708dedSBarry Smith 5382cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5383cc708dedSBarry Smith @*/ 5384cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5385cc708dedSBarry Smith { 5386cc708dedSBarry Smith PetscFunctionBegin; 5387cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5388cc708dedSBarry Smith PetscValidPointer(ftime,2); 5389cc708dedSBarry Smith *ftime = ts->solvetime; 5390cc708dedSBarry Smith PetscFunctionReturn(0); 5391cc708dedSBarry Smith } 5392cc708dedSBarry Smith 53932c18e0fdSBarry Smith /*@ 53942c18e0fdSBarry Smith TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate() 53952c18e0fdSBarry Smith 53962c18e0fdSBarry Smith Not Collective 53972c18e0fdSBarry Smith 53982c18e0fdSBarry Smith Input Parameter: 53992c18e0fdSBarry Smith . ts - the TS context 54002c18e0fdSBarry Smith 54012c18e0fdSBarry Smith Output Parameter: 54022c18e0fdSBarry Smith . steps - the number of steps 54032c18e0fdSBarry Smith 54042c18e0fdSBarry Smith Level: beginner 54052c18e0fdSBarry Smith 54062c18e0fdSBarry Smith Notes: 54072c18e0fdSBarry Smith Includes the number of steps for all calls to TSSolve() since TSSetUp() was called 54082c18e0fdSBarry Smith 54092c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test 54102c18e0fdSBarry Smith 54112c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 54122c18e0fdSBarry Smith @*/ 54132c18e0fdSBarry Smith PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) 54142c18e0fdSBarry Smith { 54152c18e0fdSBarry Smith PetscFunctionBegin; 54162c18e0fdSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54172c18e0fdSBarry Smith PetscValidPointer(steps,2); 54182c18e0fdSBarry Smith *steps = ts->total_steps; 54192c18e0fdSBarry Smith PetscFunctionReturn(0); 54202c18e0fdSBarry Smith } 54212c18e0fdSBarry Smith 54229f67acb7SJed Brown /*@ 54235ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 54249f67acb7SJed Brown used by the time integrator. 54259f67acb7SJed Brown 54269f67acb7SJed Brown Not Collective 54279f67acb7SJed Brown 54289f67acb7SJed Brown Input Parameter: 54299f67acb7SJed Brown . ts - TS context 54309f67acb7SJed Brown 54319f67acb7SJed Brown Output Parameter: 54329f67acb7SJed Brown . nits - number of nonlinear iterations 54339f67acb7SJed Brown 54349f67acb7SJed Brown Notes: 54359f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54369f67acb7SJed Brown 54379f67acb7SJed Brown Level: intermediate 54389f67acb7SJed Brown 54399f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 54409f67acb7SJed Brown 54415ef26d82SJed Brown .seealso: TSGetKSPIterations() 54429f67acb7SJed Brown @*/ 54435ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 54449f67acb7SJed Brown { 54459f67acb7SJed Brown PetscFunctionBegin; 54469f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54479f67acb7SJed Brown PetscValidIntPointer(nits,2); 54485ef26d82SJed Brown *nits = ts->snes_its; 54499f67acb7SJed Brown PetscFunctionReturn(0); 54509f67acb7SJed Brown } 54519f67acb7SJed Brown 54529f67acb7SJed Brown /*@ 54535ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 54549f67acb7SJed Brown used by the time integrator. 54559f67acb7SJed Brown 54569f67acb7SJed Brown Not Collective 54579f67acb7SJed Brown 54589f67acb7SJed Brown Input Parameter: 54599f67acb7SJed Brown . ts - TS context 54609f67acb7SJed Brown 54619f67acb7SJed Brown Output Parameter: 54629f67acb7SJed Brown . lits - number of linear iterations 54639f67acb7SJed Brown 54649f67acb7SJed Brown Notes: 54659f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 54669f67acb7SJed Brown 54679f67acb7SJed Brown Level: intermediate 54689f67acb7SJed Brown 54699f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 54709f67acb7SJed Brown 54715ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 54729f67acb7SJed Brown @*/ 54735ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 54749f67acb7SJed Brown { 54759f67acb7SJed Brown PetscFunctionBegin; 54769f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 54779f67acb7SJed Brown PetscValidIntPointer(lits,2); 54785ef26d82SJed Brown *lits = ts->ksp_its; 54799f67acb7SJed Brown PetscFunctionReturn(0); 54809f67acb7SJed Brown } 54819f67acb7SJed Brown 5482cef5090cSJed Brown /*@ 5483cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5484cef5090cSJed Brown 5485cef5090cSJed Brown Not Collective 5486cef5090cSJed Brown 5487cef5090cSJed Brown Input Parameter: 5488cef5090cSJed Brown . ts - TS context 5489cef5090cSJed Brown 5490cef5090cSJed Brown Output Parameter: 5491cef5090cSJed Brown . rejects - number of steps rejected 5492cef5090cSJed Brown 5493cef5090cSJed Brown Notes: 5494cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5495cef5090cSJed Brown 5496cef5090cSJed Brown Level: intermediate 5497cef5090cSJed Brown 5498cef5090cSJed Brown .keywords: TS, get, number 5499cef5090cSJed Brown 55005ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5501cef5090cSJed Brown @*/ 5502cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5503cef5090cSJed Brown { 5504cef5090cSJed Brown PetscFunctionBegin; 5505cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5506cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5507cef5090cSJed Brown *rejects = ts->reject; 5508cef5090cSJed Brown PetscFunctionReturn(0); 5509cef5090cSJed Brown } 5510cef5090cSJed Brown 5511cef5090cSJed Brown /*@ 5512cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5513cef5090cSJed Brown 5514cef5090cSJed Brown Not Collective 5515cef5090cSJed Brown 5516cef5090cSJed Brown Input Parameter: 5517cef5090cSJed Brown . ts - TS context 5518cef5090cSJed Brown 5519cef5090cSJed Brown Output Parameter: 5520cef5090cSJed Brown . fails - number of failed nonlinear solves 5521cef5090cSJed Brown 5522cef5090cSJed Brown Notes: 5523cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5524cef5090cSJed Brown 5525cef5090cSJed Brown Level: intermediate 5526cef5090cSJed Brown 5527cef5090cSJed Brown .keywords: TS, get, number 5528cef5090cSJed Brown 55295ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5530cef5090cSJed Brown @*/ 5531cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5532cef5090cSJed Brown { 5533cef5090cSJed Brown PetscFunctionBegin; 5534cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5535cef5090cSJed Brown PetscValidIntPointer(fails,2); 5536cef5090cSJed Brown *fails = ts->num_snes_failures; 5537cef5090cSJed Brown PetscFunctionReturn(0); 5538cef5090cSJed Brown } 5539cef5090cSJed Brown 5540cef5090cSJed Brown /*@ 5541cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5542cef5090cSJed Brown 5543cef5090cSJed Brown Not Collective 5544cef5090cSJed Brown 5545cef5090cSJed Brown Input Parameter: 5546cef5090cSJed Brown + ts - TS context 5547cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5548cef5090cSJed Brown 5549cef5090cSJed Brown Notes: 5550cef5090cSJed Brown The counter is reset to zero for each step 5551cef5090cSJed Brown 5552cef5090cSJed Brown Options Database Key: 5553cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5554cef5090cSJed Brown 5555cef5090cSJed Brown Level: intermediate 5556cef5090cSJed Brown 5557cef5090cSJed Brown .keywords: TS, set, maximum, number 5558cef5090cSJed Brown 55595ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5560cef5090cSJed Brown @*/ 5561cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5562cef5090cSJed Brown { 5563cef5090cSJed Brown PetscFunctionBegin; 5564cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5565cef5090cSJed Brown ts->max_reject = rejects; 5566cef5090cSJed Brown PetscFunctionReturn(0); 5567cef5090cSJed Brown } 5568cef5090cSJed Brown 5569cef5090cSJed Brown /*@ 5570cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5571cef5090cSJed Brown 5572cef5090cSJed Brown Not Collective 5573cef5090cSJed Brown 5574cef5090cSJed Brown Input Parameter: 5575cef5090cSJed Brown + ts - TS context 5576cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5577cef5090cSJed Brown 5578cef5090cSJed Brown Notes: 5579cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5580cef5090cSJed Brown 5581cef5090cSJed Brown Options Database Key: 5582cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5583cef5090cSJed Brown 5584cef5090cSJed Brown Level: intermediate 5585cef5090cSJed Brown 5586cef5090cSJed Brown .keywords: TS, set, maximum, number 5587cef5090cSJed Brown 55885ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5589cef5090cSJed Brown @*/ 5590cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5591cef5090cSJed Brown { 5592cef5090cSJed Brown PetscFunctionBegin; 5593cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5594cef5090cSJed Brown ts->max_snes_failures = fails; 5595cef5090cSJed Brown PetscFunctionReturn(0); 5596cef5090cSJed Brown } 5597cef5090cSJed Brown 5598cef5090cSJed Brown /*@ 5599cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5600cef5090cSJed Brown 5601cef5090cSJed Brown Not Collective 5602cef5090cSJed Brown 5603cef5090cSJed Brown Input Parameter: 5604cef5090cSJed Brown + ts - TS context 5605cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5606cef5090cSJed Brown 5607cef5090cSJed Brown Options Database Key: 5608cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5609cef5090cSJed Brown 5610cef5090cSJed Brown Level: intermediate 5611cef5090cSJed Brown 5612cef5090cSJed Brown .keywords: TS, set, error 5613cef5090cSJed Brown 56145ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5615cef5090cSJed Brown @*/ 5616cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5617cef5090cSJed Brown { 5618cef5090cSJed Brown PetscFunctionBegin; 5619cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5620cef5090cSJed Brown ts->errorifstepfailed = err; 5621cef5090cSJed Brown PetscFunctionReturn(0); 5622cef5090cSJed Brown } 5623cef5090cSJed Brown 5624fb1732b5SBarry Smith /*@C 5625fde5950dSBarry 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 5626fb1732b5SBarry Smith 5627fb1732b5SBarry Smith Collective on TS 5628fb1732b5SBarry Smith 5629fb1732b5SBarry Smith Input Parameters: 5630fb1732b5SBarry Smith + ts - the TS context 5631fb1732b5SBarry Smith . step - current time-step 5632fb1732b5SBarry Smith . ptime - current time 56330910c330SBarry Smith . u - current state 5634721cd6eeSBarry Smith - vf - viewer and its format 5635fb1732b5SBarry Smith 5636fb1732b5SBarry Smith Level: intermediate 5637fb1732b5SBarry Smith 5638fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5639fb1732b5SBarry Smith 5640fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5641fb1732b5SBarry Smith @*/ 5642721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5643fb1732b5SBarry Smith { 5644fb1732b5SBarry Smith PetscErrorCode ierr; 5645fb1732b5SBarry Smith 5646fb1732b5SBarry Smith PetscFunctionBegin; 5647721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5648721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5649721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5650ed81e22dSJed Brown PetscFunctionReturn(0); 5651ed81e22dSJed Brown } 5652ed81e22dSJed Brown 5653ed81e22dSJed Brown /*@C 5654ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5655ed81e22dSJed Brown 5656ed81e22dSJed Brown Collective on TS 5657ed81e22dSJed Brown 5658ed81e22dSJed Brown Input Parameters: 5659ed81e22dSJed Brown + ts - the TS context 5660ed81e22dSJed Brown . step - current time-step 5661ed81e22dSJed Brown . ptime - current time 56620910c330SBarry Smith . u - current state 5663ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5664ed81e22dSJed Brown 5665ed81e22dSJed Brown Level: intermediate 5666ed81e22dSJed Brown 5667ed81e22dSJed Brown Notes: 5668ed81e22dSJed 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. 5669ed81e22dSJed Brown These are named according to the file name template. 5670ed81e22dSJed Brown 5671ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5672ed81e22dSJed Brown 5673ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5674ed81e22dSJed Brown 5675ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5676ed81e22dSJed Brown @*/ 56770910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5678ed81e22dSJed Brown { 5679ed81e22dSJed Brown PetscErrorCode ierr; 5680ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5681ed81e22dSJed Brown PetscViewer viewer; 5682ed81e22dSJed Brown 5683ed81e22dSJed Brown PetscFunctionBegin; 568463e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 56858caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5686ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 56870910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5688ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5689ed81e22dSJed Brown PetscFunctionReturn(0); 5690ed81e22dSJed Brown } 5691ed81e22dSJed Brown 5692ed81e22dSJed Brown /*@C 5693ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5694ed81e22dSJed Brown 5695ed81e22dSJed Brown Collective on TS 5696ed81e22dSJed Brown 5697ed81e22dSJed Brown Input Parameters: 5698ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5699ed81e22dSJed Brown 5700ed81e22dSJed Brown Level: intermediate 5701ed81e22dSJed Brown 5702ed81e22dSJed Brown Note: 5703ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5704ed81e22dSJed Brown 5705ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5706ed81e22dSJed Brown 5707ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5708ed81e22dSJed Brown @*/ 5709ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5710ed81e22dSJed Brown { 5711ed81e22dSJed Brown PetscErrorCode ierr; 5712ed81e22dSJed Brown 5713ed81e22dSJed Brown PetscFunctionBegin; 5714ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5715fb1732b5SBarry Smith PetscFunctionReturn(0); 5716fb1732b5SBarry Smith } 5717fb1732b5SBarry Smith 571884df9cb4SJed Brown /*@ 5719552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 572084df9cb4SJed Brown 5721ed81e22dSJed Brown Collective on TS if controller has not been created yet 572284df9cb4SJed Brown 572384df9cb4SJed Brown Input Arguments: 5724ed81e22dSJed Brown . ts - time stepping context 572584df9cb4SJed Brown 572684df9cb4SJed Brown Output Arguments: 5727ed81e22dSJed Brown . adapt - adaptive controller 572884df9cb4SJed Brown 572984df9cb4SJed Brown Level: intermediate 573084df9cb4SJed Brown 5731ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 573284df9cb4SJed Brown @*/ 5733552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 573484df9cb4SJed Brown { 573584df9cb4SJed Brown PetscErrorCode ierr; 573684df9cb4SJed Brown 573784df9cb4SJed Brown PetscFunctionBegin; 573884df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5739bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 574084df9cb4SJed Brown if (!ts->adapt) { 5741ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 57423bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 57431c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 574484df9cb4SJed Brown } 5745bec58848SLisandro Dalcin *adapt = ts->adapt; 574684df9cb4SJed Brown PetscFunctionReturn(0); 574784df9cb4SJed Brown } 5748d6ebe24aSShri Abhyankar 57491c3436cfSJed Brown /*@ 57501c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 57511c3436cfSJed Brown 57521c3436cfSJed Brown Logically Collective 57531c3436cfSJed Brown 57541c3436cfSJed Brown Input Arguments: 57551c3436cfSJed Brown + ts - time integration context 57561c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 57570298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 57581c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 57590298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 57601c3436cfSJed Brown 5761a3cdaa26SBarry Smith Options Database keys: 5762a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5763a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5764a3cdaa26SBarry Smith 57653ff766beSShri Abhyankar Notes: 57663ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 57673ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 57683ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 57693ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 57703ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 57713ff766beSShri Abhyankar differential variables. 57723ff766beSShri Abhyankar 57731c3436cfSJed Brown Level: beginner 57741c3436cfSJed Brown 5775c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 57761c3436cfSJed Brown @*/ 57771c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 57781c3436cfSJed Brown { 57791c3436cfSJed Brown PetscErrorCode ierr; 57801c3436cfSJed Brown 57811c3436cfSJed Brown PetscFunctionBegin; 5782c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 57831c3436cfSJed Brown if (vatol) { 57841c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 57851c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 57861c3436cfSJed Brown ts->vatol = vatol; 57871c3436cfSJed Brown } 5788c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 57891c3436cfSJed Brown if (vrtol) { 57901c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 57911c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 57921c3436cfSJed Brown ts->vrtol = vrtol; 57931c3436cfSJed Brown } 57941c3436cfSJed Brown PetscFunctionReturn(0); 57951c3436cfSJed Brown } 57961c3436cfSJed Brown 5797c5033834SJed Brown /*@ 5798c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5799c5033834SJed Brown 5800c5033834SJed Brown Logically Collective 5801c5033834SJed Brown 5802c5033834SJed Brown Input Arguments: 5803c5033834SJed Brown . ts - time integration context 5804c5033834SJed Brown 5805c5033834SJed Brown Output Arguments: 58060298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 58070298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 58080298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 58090298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5810c5033834SJed Brown 5811c5033834SJed Brown Level: beginner 5812c5033834SJed Brown 5813c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5814c5033834SJed Brown @*/ 5815c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5816c5033834SJed Brown { 5817c5033834SJed Brown PetscFunctionBegin; 5818c5033834SJed Brown if (atol) *atol = ts->atol; 5819c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5820c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5821c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5822c5033834SJed Brown PetscFunctionReturn(0); 5823c5033834SJed Brown } 5824c5033834SJed Brown 58259c6b16b5SShri Abhyankar /*@ 5826a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 58279c6b16b5SShri Abhyankar 58289c6b16b5SShri Abhyankar Collective on TS 58299c6b16b5SShri Abhyankar 58309c6b16b5SShri Abhyankar Input Arguments: 58319c6b16b5SShri Abhyankar + ts - time stepping context 5832a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5833a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 58349c6b16b5SShri Abhyankar 58359c6b16b5SShri Abhyankar Output Arguments: 58367453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58377453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 58387453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58399c6b16b5SShri Abhyankar 58409c6b16b5SShri Abhyankar Level: developer 58419c6b16b5SShri Abhyankar 5842deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 58439c6b16b5SShri Abhyankar @*/ 58447453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58459c6b16b5SShri Abhyankar { 58469c6b16b5SShri Abhyankar PetscErrorCode ierr; 58479c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 58487453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 58497453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 58509c6b16b5SShri Abhyankar const PetscScalar *u,*y; 58517453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 58527453f775SEmil Constantinescu PetscReal tol,tola,tolr; 58537453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 58549c6b16b5SShri Abhyankar 58559c6b16b5SShri Abhyankar PetscFunctionBegin; 58569c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5857a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5858a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5859a4868fbcSLisandro Dalcin PetscValidType(U,2); 5860a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5861a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5862a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 58638a175baeSEmil Constantinescu PetscValidPointer(norma,5); 58648a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5865a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 58669c6b16b5SShri Abhyankar 58679c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 58689c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 58699c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 58709c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 58719c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 58727453f775SEmil Constantinescu sum = 0.; n_loc = 0; 58737453f775SEmil Constantinescu suma = 0.; na_loc = 0; 58747453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 58759c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 58769c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 58779c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58789c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58799c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 58807453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58817453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 58827453f775SEmil Constantinescu if(tola>0.){ 58837453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58847453f775SEmil Constantinescu na_loc++; 58857453f775SEmil Constantinescu } 58867453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58877453f775SEmil Constantinescu if(tolr>0.){ 58887453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58897453f775SEmil Constantinescu nr_loc++; 58907453f775SEmil Constantinescu } 58917453f775SEmil Constantinescu tol=tola+tolr; 58927453f775SEmil Constantinescu if(tol>0.){ 58937453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58947453f775SEmil Constantinescu n_loc++; 58957453f775SEmil Constantinescu } 58969c6b16b5SShri Abhyankar } 58979c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58989c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58999c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 59009c6b16b5SShri Abhyankar const PetscScalar *atol; 59019c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59029c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59037453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59047453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 59057453f775SEmil Constantinescu if(tola>0.){ 59067453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59077453f775SEmil Constantinescu na_loc++; 59087453f775SEmil Constantinescu } 59097453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59107453f775SEmil Constantinescu if(tolr>0.){ 59117453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59127453f775SEmil Constantinescu nr_loc++; 59137453f775SEmil Constantinescu } 59147453f775SEmil Constantinescu tol=tola+tolr; 59157453f775SEmil Constantinescu if(tol>0.){ 59167453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59177453f775SEmil Constantinescu n_loc++; 59187453f775SEmil Constantinescu } 59199c6b16b5SShri Abhyankar } 59209c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59219c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 59229c6b16b5SShri Abhyankar const PetscScalar *rtol; 59239c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59249c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59257453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59267453f775SEmil Constantinescu tola = ts->atol; 59277453f775SEmil Constantinescu if(tola>0.){ 59287453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59297453f775SEmil Constantinescu na_loc++; 59307453f775SEmil Constantinescu } 59317453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59327453f775SEmil Constantinescu if(tolr>0.){ 59337453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59347453f775SEmil Constantinescu nr_loc++; 59357453f775SEmil Constantinescu } 59367453f775SEmil Constantinescu tol=tola+tolr; 59377453f775SEmil Constantinescu if(tol>0.){ 59387453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59397453f775SEmil Constantinescu n_loc++; 59407453f775SEmil Constantinescu } 59419c6b16b5SShri Abhyankar } 59429c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59439c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 59449c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 59457453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59467453f775SEmil Constantinescu tola = ts->atol; 59477453f775SEmil Constantinescu if(tola>0.){ 59487453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 59497453f775SEmil Constantinescu na_loc++; 59507453f775SEmil Constantinescu } 59517453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59527453f775SEmil Constantinescu if(tolr>0.){ 59537453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 59547453f775SEmil Constantinescu nr_loc++; 59557453f775SEmil Constantinescu } 59567453f775SEmil Constantinescu tol=tola+tolr; 59577453f775SEmil Constantinescu if(tol>0.){ 59587453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 59597453f775SEmil Constantinescu n_loc++; 59607453f775SEmil Constantinescu } 59619c6b16b5SShri Abhyankar } 59629c6b16b5SShri Abhyankar } 59639c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 59649c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 59659c6b16b5SShri Abhyankar 59667453f775SEmil Constantinescu err_loc[0] = sum; 59677453f775SEmil Constantinescu err_loc[1] = suma; 59687453f775SEmil Constantinescu err_loc[2] = sumr; 59697453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 59707453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 59717453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 59727453f775SEmil Constantinescu 5973a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 59747453f775SEmil Constantinescu 59757453f775SEmil Constantinescu gsum = err_glb[0]; 59767453f775SEmil Constantinescu gsuma = err_glb[1]; 59777453f775SEmil Constantinescu gsumr = err_glb[2]; 59787453f775SEmil Constantinescu n_glb = err_glb[3]; 59797453f775SEmil Constantinescu na_glb = err_glb[4]; 59807453f775SEmil Constantinescu nr_glb = err_glb[5]; 59817453f775SEmil Constantinescu 5982b1316ef9SEmil Constantinescu *norm = 0.; 5983b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 5984b1316ef9SEmil Constantinescu *norma = 0.; 5985b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5986b1316ef9SEmil Constantinescu *normr = 0.; 5987b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 59889c6b16b5SShri Abhyankar 59899c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 59907453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 59917453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 59929c6b16b5SShri Abhyankar PetscFunctionReturn(0); 59939c6b16b5SShri Abhyankar } 59949c6b16b5SShri Abhyankar 59959c6b16b5SShri Abhyankar /*@ 5996a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 59979c6b16b5SShri Abhyankar 59989c6b16b5SShri Abhyankar Collective on TS 59999c6b16b5SShri Abhyankar 60009c6b16b5SShri Abhyankar Input Arguments: 60019c6b16b5SShri Abhyankar + ts - time stepping context 6002a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6003a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 60049c6b16b5SShri Abhyankar 60059c6b16b5SShri Abhyankar Output Arguments: 60067453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 60077453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 60087453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 60099c6b16b5SShri Abhyankar 60109c6b16b5SShri Abhyankar Level: developer 60119c6b16b5SShri Abhyankar 6012deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 60139c6b16b5SShri Abhyankar @*/ 60147453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60159c6b16b5SShri Abhyankar { 60169c6b16b5SShri Abhyankar PetscErrorCode ierr; 60177453f775SEmil Constantinescu PetscInt i,n,N,rstart; 60189c6b16b5SShri Abhyankar const PetscScalar *u,*y; 60197453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 60207453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 60217453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 60229c6b16b5SShri Abhyankar 60239c6b16b5SShri Abhyankar PetscFunctionBegin; 60249c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6025a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 6026a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 6027a4868fbcSLisandro Dalcin PetscValidType(U,2); 6028a4868fbcSLisandro Dalcin PetscValidType(Y,3); 6029a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 6030a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 60318a175baeSEmil Constantinescu PetscValidPointer(norma,5); 60328a175baeSEmil Constantinescu PetscValidPointer(normr,6); 6033a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 60349c6b16b5SShri Abhyankar 60359c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 60369c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 60379c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 60389c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 60399c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 60407453f775SEmil Constantinescu 60417453f775SEmil Constantinescu max=0.; 60427453f775SEmil Constantinescu maxa=0.; 60437453f775SEmil Constantinescu maxr=0.; 60447453f775SEmil Constantinescu 60457453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 60469c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 60479c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60489c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60497453f775SEmil Constantinescu 60507453f775SEmil Constantinescu for (i=0; i<n; i++) { 60517453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60527453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60537453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60547453f775SEmil Constantinescu tol = tola+tolr; 60557453f775SEmil Constantinescu if(tola>0.){ 60567453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60577453f775SEmil Constantinescu } 60587453f775SEmil Constantinescu if(tolr>0.){ 60597453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60607453f775SEmil Constantinescu } 60617453f775SEmil Constantinescu if(tol>0.){ 60627453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60637453f775SEmil Constantinescu } 60649c6b16b5SShri Abhyankar } 60659c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60669c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60679c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 60689c6b16b5SShri Abhyankar const PetscScalar *atol; 60699c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60707453f775SEmil Constantinescu for (i=0; i<n; i++) { 60717453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60727453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60737453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60747453f775SEmil Constantinescu tol = tola+tolr; 60757453f775SEmil Constantinescu if(tola>0.){ 60767453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60777453f775SEmil Constantinescu } 60787453f775SEmil Constantinescu if(tolr>0.){ 60797453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60807453f775SEmil Constantinescu } 60817453f775SEmil Constantinescu if(tol>0.){ 60827453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60837453f775SEmil Constantinescu } 60849c6b16b5SShri Abhyankar } 60859c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60869c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 60879c6b16b5SShri Abhyankar const PetscScalar *rtol; 60889c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60897453f775SEmil Constantinescu 60907453f775SEmil Constantinescu for (i=0; i<n; i++) { 60917453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60927453f775SEmil Constantinescu tola = ts->atol; 60937453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60947453f775SEmil Constantinescu tol = tola+tolr; 60957453f775SEmil Constantinescu if(tola>0.){ 60967453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 60977453f775SEmil Constantinescu } 60987453f775SEmil Constantinescu if(tolr>0.){ 60997453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 61007453f775SEmil Constantinescu } 61017453f775SEmil Constantinescu if(tol>0.){ 61027453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 61037453f775SEmil Constantinescu } 61049c6b16b5SShri Abhyankar } 61059c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61069c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 61077453f775SEmil Constantinescu 61087453f775SEmil Constantinescu for (i=0; i<n; i++) { 61097453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 61107453f775SEmil Constantinescu tola = ts->atol; 61117453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61127453f775SEmil Constantinescu tol = tola+tolr; 61137453f775SEmil Constantinescu if(tola>0.){ 61147453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 61157453f775SEmil Constantinescu } 61167453f775SEmil Constantinescu if(tolr>0.){ 61177453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 61187453f775SEmil Constantinescu } 61197453f775SEmil Constantinescu if(tol>0.){ 61207453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 61217453f775SEmil Constantinescu } 61229c6b16b5SShri Abhyankar } 61239c6b16b5SShri Abhyankar } 61249c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 61259c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 61267453f775SEmil Constantinescu err_loc[0] = max; 61277453f775SEmil Constantinescu err_loc[1] = maxa; 61287453f775SEmil Constantinescu err_loc[2] = maxr; 6129a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 61307453f775SEmil Constantinescu gmax = err_glb[0]; 61317453f775SEmil Constantinescu gmaxa = err_glb[1]; 61327453f775SEmil Constantinescu gmaxr = err_glb[2]; 61339c6b16b5SShri Abhyankar 61349c6b16b5SShri Abhyankar *norm = gmax; 61357453f775SEmil Constantinescu *norma = gmaxa; 61367453f775SEmil Constantinescu *normr = gmaxr; 61379c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 61387453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 61397453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 61409c6b16b5SShri Abhyankar PetscFunctionReturn(0); 61419c6b16b5SShri Abhyankar } 61429c6b16b5SShri Abhyankar 61431c3436cfSJed Brown /*@ 61448a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 61451c3436cfSJed Brown 61461c3436cfSJed Brown Collective on TS 61471c3436cfSJed Brown 61481c3436cfSJed Brown Input Arguments: 61491c3436cfSJed Brown + ts - time stepping context 6150a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6151a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 6152a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 61537619abb3SShri 61541c3436cfSJed Brown Output Arguments: 61558a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 61568a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 61578a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 6158a4868fbcSLisandro Dalcin 6159a4868fbcSLisandro Dalcin Options Database Keys: 6160a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6161a4868fbcSLisandro Dalcin 61621c3436cfSJed Brown Level: developer 61631c3436cfSJed Brown 61648a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 61651c3436cfSJed Brown @*/ 61667453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61671c3436cfSJed Brown { 61688beabaa1SBarry Smith PetscErrorCode ierr; 61691c3436cfSJed Brown 61701c3436cfSJed Brown PetscFunctionBegin; 6171a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 61727453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6173a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 61747453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6175a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 61761c3436cfSJed Brown PetscFunctionReturn(0); 61771c3436cfSJed Brown } 61781c3436cfSJed Brown 61798a175baeSEmil Constantinescu 61808a175baeSEmil Constantinescu /*@ 61818a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 61828a175baeSEmil Constantinescu 61838a175baeSEmil Constantinescu Collective on TS 61848a175baeSEmil Constantinescu 61858a175baeSEmil Constantinescu Input Arguments: 61868a175baeSEmil Constantinescu + ts - time stepping context 61878a175baeSEmil Constantinescu . E - error vector 61888a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 61898a175baeSEmil Constantinescu - Y - state vector, previous time step 61908a175baeSEmil Constantinescu 61918a175baeSEmil Constantinescu Output Arguments: 61928a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 61938a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 61948a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 61958a175baeSEmil Constantinescu 61968a175baeSEmil Constantinescu Level: developer 61978a175baeSEmil Constantinescu 61988a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 61998a175baeSEmil Constantinescu @*/ 62008a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 62018a175baeSEmil Constantinescu { 62028a175baeSEmil Constantinescu PetscErrorCode ierr; 62038a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 62048a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 62058a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 62068a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 62078a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 62088a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 62098a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 62108a175baeSEmil Constantinescu 62118a175baeSEmil Constantinescu PetscFunctionBegin; 62128a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62138a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 62148a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 62158a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 62168a175baeSEmil Constantinescu PetscValidType(E,2); 62178a175baeSEmil Constantinescu PetscValidType(U,3); 62188a175baeSEmil Constantinescu PetscValidType(Y,4); 62198a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 62208a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 62218a175baeSEmil Constantinescu PetscValidPointer(norm,5); 62228a175baeSEmil Constantinescu PetscValidPointer(norma,6); 62238a175baeSEmil Constantinescu PetscValidPointer(normr,7); 62248a175baeSEmil Constantinescu 62258a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 62268a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 62278a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 62288a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 62298a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 62308a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 62318a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 62328a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 62338a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 62348a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 62358a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 62368a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62378a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62388a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62398a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62408a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62418a175baeSEmil Constantinescu if(tola>0.){ 62428a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62438a175baeSEmil Constantinescu na_loc++; 62448a175baeSEmil Constantinescu } 62458a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62468a175baeSEmil Constantinescu if(tolr>0.){ 62478a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62488a175baeSEmil Constantinescu nr_loc++; 62498a175baeSEmil Constantinescu } 62508a175baeSEmil Constantinescu tol=tola+tolr; 62518a175baeSEmil Constantinescu if(tol>0.){ 62528a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62538a175baeSEmil Constantinescu n_loc++; 62548a175baeSEmil Constantinescu } 62558a175baeSEmil Constantinescu } 62568a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62578a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62588a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 62598a175baeSEmil Constantinescu const PetscScalar *atol; 62608a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62618a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62628a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62638a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 62648a175baeSEmil Constantinescu if(tola>0.){ 62658a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62668a175baeSEmil Constantinescu na_loc++; 62678a175baeSEmil Constantinescu } 62688a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62698a175baeSEmil Constantinescu if(tolr>0.){ 62708a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62718a175baeSEmil Constantinescu nr_loc++; 62728a175baeSEmil Constantinescu } 62738a175baeSEmil Constantinescu tol=tola+tolr; 62748a175baeSEmil Constantinescu if(tol>0.){ 62758a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62768a175baeSEmil Constantinescu n_loc++; 62778a175baeSEmil Constantinescu } 62788a175baeSEmil Constantinescu } 62798a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62808a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 62818a175baeSEmil Constantinescu const PetscScalar *rtol; 62828a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62838a175baeSEmil Constantinescu for (i=0; i<n; i++) { 62848a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 62858a175baeSEmil Constantinescu tola = ts->atol; 62868a175baeSEmil Constantinescu if(tola>0.){ 62878a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 62888a175baeSEmil Constantinescu na_loc++; 62898a175baeSEmil Constantinescu } 62908a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62918a175baeSEmil Constantinescu if(tolr>0.){ 62928a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62938a175baeSEmil Constantinescu nr_loc++; 62948a175baeSEmil Constantinescu } 62958a175baeSEmil Constantinescu tol=tola+tolr; 62968a175baeSEmil Constantinescu if(tol>0.){ 62978a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62988a175baeSEmil Constantinescu n_loc++; 62998a175baeSEmil Constantinescu } 63008a175baeSEmil Constantinescu } 63018a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 63028a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 63038a175baeSEmil Constantinescu for (i=0; i<n; i++) { 63048a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63058a175baeSEmil Constantinescu tola = ts->atol; 63068a175baeSEmil Constantinescu if(tola>0.){ 63078a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 63088a175baeSEmil Constantinescu na_loc++; 63098a175baeSEmil Constantinescu } 63108a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63118a175baeSEmil Constantinescu if(tolr>0.){ 63128a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 63138a175baeSEmil Constantinescu nr_loc++; 63148a175baeSEmil Constantinescu } 63158a175baeSEmil Constantinescu tol=tola+tolr; 63168a175baeSEmil Constantinescu if(tol>0.){ 63178a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 63188a175baeSEmil Constantinescu n_loc++; 63198a175baeSEmil Constantinescu } 63208a175baeSEmil Constantinescu } 63218a175baeSEmil Constantinescu } 63228a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 63238a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 63248a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 63258a175baeSEmil Constantinescu 63268a175baeSEmil Constantinescu err_loc[0] = sum; 63278a175baeSEmil Constantinescu err_loc[1] = suma; 63288a175baeSEmil Constantinescu err_loc[2] = sumr; 63298a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 63308a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 63318a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 63328a175baeSEmil Constantinescu 6333a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 63348a175baeSEmil Constantinescu 63358a175baeSEmil Constantinescu gsum = err_glb[0]; 63368a175baeSEmil Constantinescu gsuma = err_glb[1]; 63378a175baeSEmil Constantinescu gsumr = err_glb[2]; 63388a175baeSEmil Constantinescu n_glb = err_glb[3]; 63398a175baeSEmil Constantinescu na_glb = err_glb[4]; 63408a175baeSEmil Constantinescu nr_glb = err_glb[5]; 63418a175baeSEmil Constantinescu 63428a175baeSEmil Constantinescu *norm = 0.; 63438a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 63448a175baeSEmil Constantinescu *norma = 0.; 63458a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 63468a175baeSEmil Constantinescu *normr = 0.; 63478a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 63488a175baeSEmil Constantinescu 63498a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 63508a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 63518a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 63528a175baeSEmil Constantinescu PetscFunctionReturn(0); 63538a175baeSEmil Constantinescu } 63548a175baeSEmil Constantinescu 63558a175baeSEmil Constantinescu /*@ 63568a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 63578a175baeSEmil Constantinescu Collective on TS 63588a175baeSEmil Constantinescu 63598a175baeSEmil Constantinescu Input Arguments: 63608a175baeSEmil Constantinescu + ts - time stepping context 63618a175baeSEmil Constantinescu . E - error vector 63628a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 63638a175baeSEmil Constantinescu - Y - state vector, previous time step 63648a175baeSEmil Constantinescu 63658a175baeSEmil Constantinescu Output Arguments: 63668a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 63678a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 63688a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 63698a175baeSEmil Constantinescu 63708a175baeSEmil Constantinescu Level: developer 63718a175baeSEmil Constantinescu 63728a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 63738a175baeSEmil Constantinescu @*/ 63748a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 63758a175baeSEmil Constantinescu { 63768a175baeSEmil Constantinescu PetscErrorCode ierr; 63778a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 63788a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 63798a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 63808a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 63818a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 63828a175baeSEmil Constantinescu 63838a175baeSEmil Constantinescu PetscFunctionBegin; 63848a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 63858a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 63868a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 63878a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 63888a175baeSEmil Constantinescu PetscValidType(E,2); 63898a175baeSEmil Constantinescu PetscValidType(U,3); 63908a175baeSEmil Constantinescu PetscValidType(Y,4); 63918a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 63928a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 63938a175baeSEmil Constantinescu PetscValidPointer(norm,5); 63948a175baeSEmil Constantinescu PetscValidPointer(norma,6); 63958a175baeSEmil Constantinescu PetscValidPointer(normr,7); 63968a175baeSEmil Constantinescu 63978a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 63988a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 63998a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 64008a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 64018a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 64028a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 64038a175baeSEmil Constantinescu 64048a175baeSEmil Constantinescu max=0.; 64058a175baeSEmil Constantinescu maxa=0.; 64068a175baeSEmil Constantinescu maxr=0.; 64078a175baeSEmil Constantinescu 64088a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 64098a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 64108a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64118a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64128a175baeSEmil Constantinescu 64138a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64148a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64158a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64168a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64178a175baeSEmil Constantinescu tol = tola+tolr; 64188a175baeSEmil Constantinescu if(tola>0.){ 64198a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64208a175baeSEmil Constantinescu } 64218a175baeSEmil Constantinescu if(tolr>0.){ 64228a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64238a175baeSEmil Constantinescu } 64248a175baeSEmil Constantinescu if(tol>0.){ 64258a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64268a175baeSEmil Constantinescu } 64278a175baeSEmil Constantinescu } 64288a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64298a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64308a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 64318a175baeSEmil Constantinescu const PetscScalar *atol; 64328a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64338a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64348a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64358a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64368a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64378a175baeSEmil Constantinescu tol = tola+tolr; 64388a175baeSEmil Constantinescu if(tola>0.){ 64398a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64408a175baeSEmil Constantinescu } 64418a175baeSEmil Constantinescu if(tolr>0.){ 64428a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64438a175baeSEmil Constantinescu } 64448a175baeSEmil Constantinescu if(tol>0.){ 64458a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64468a175baeSEmil Constantinescu } 64478a175baeSEmil Constantinescu } 64488a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64498a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 64508a175baeSEmil Constantinescu const PetscScalar *rtol; 64518a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64528a175baeSEmil Constantinescu 64538a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64548a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64558a175baeSEmil Constantinescu tola = ts->atol; 64568a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64578a175baeSEmil Constantinescu tol = tola+tolr; 64588a175baeSEmil Constantinescu if(tola>0.){ 64598a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64608a175baeSEmil Constantinescu } 64618a175baeSEmil Constantinescu if(tolr>0.){ 64628a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64638a175baeSEmil Constantinescu } 64648a175baeSEmil Constantinescu if(tol>0.){ 64658a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64668a175baeSEmil Constantinescu } 64678a175baeSEmil Constantinescu } 64688a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64698a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 64708a175baeSEmil Constantinescu 64718a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64728a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64738a175baeSEmil Constantinescu tola = ts->atol; 64748a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64758a175baeSEmil Constantinescu tol = tola+tolr; 64768a175baeSEmil Constantinescu if(tola>0.){ 64778a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 64788a175baeSEmil Constantinescu } 64798a175baeSEmil Constantinescu if(tolr>0.){ 64808a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 64818a175baeSEmil Constantinescu } 64828a175baeSEmil Constantinescu if(tol>0.){ 64838a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 64848a175baeSEmil Constantinescu } 64858a175baeSEmil Constantinescu } 64868a175baeSEmil Constantinescu } 64878a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 64888a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 64898a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 64908a175baeSEmil Constantinescu err_loc[0] = max; 64918a175baeSEmil Constantinescu err_loc[1] = maxa; 64928a175baeSEmil Constantinescu err_loc[2] = maxr; 6493a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 64948a175baeSEmil Constantinescu gmax = err_glb[0]; 64958a175baeSEmil Constantinescu gmaxa = err_glb[1]; 64968a175baeSEmil Constantinescu gmaxr = err_glb[2]; 64978a175baeSEmil Constantinescu 64988a175baeSEmil Constantinescu *norm = gmax; 64998a175baeSEmil Constantinescu *norma = gmaxa; 65008a175baeSEmil Constantinescu *normr = gmaxr; 65018a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 65028a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 65038a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 65048a175baeSEmil Constantinescu PetscFunctionReturn(0); 65058a175baeSEmil Constantinescu } 65068a175baeSEmil Constantinescu 65078a175baeSEmil Constantinescu /*@ 65088a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 65098a175baeSEmil Constantinescu 65108a175baeSEmil Constantinescu Collective on TS 65118a175baeSEmil Constantinescu 65128a175baeSEmil Constantinescu Input Arguments: 65138a175baeSEmil Constantinescu + ts - time stepping context 65148a175baeSEmil Constantinescu . E - error vector 65158a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 65168a175baeSEmil Constantinescu . Y - state vector, previous time step 65178a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 65188a175baeSEmil Constantinescu 65198a175baeSEmil Constantinescu Output Arguments: 65208a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 65218a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 65228a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 65238a175baeSEmil Constantinescu 65248a175baeSEmil Constantinescu Options Database Keys: 65258a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 65268a175baeSEmil Constantinescu 65278a175baeSEmil Constantinescu Level: developer 65288a175baeSEmil Constantinescu 65298a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 65308a175baeSEmil Constantinescu @*/ 65318a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 65328a175baeSEmil Constantinescu { 65338a175baeSEmil Constantinescu PetscErrorCode ierr; 65348a175baeSEmil Constantinescu 65358a175baeSEmil Constantinescu PetscFunctionBegin; 65368a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 65378a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65388a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 65398a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 65408a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 65418a175baeSEmil Constantinescu PetscFunctionReturn(0); 65428a175baeSEmil Constantinescu } 65438a175baeSEmil Constantinescu 65448a175baeSEmil Constantinescu 65458d59e960SJed Brown /*@ 65468d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 65478d59e960SJed Brown 65488d59e960SJed Brown Logically Collective on TS 65498d59e960SJed Brown 65508d59e960SJed Brown Input Arguments: 65518d59e960SJed Brown + ts - time stepping context 65528d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 65538d59e960SJed Brown 65548d59e960SJed Brown Note: 65558d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 65568d59e960SJed Brown 65578d59e960SJed Brown Level: intermediate 65588d59e960SJed Brown 65598d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 65608d59e960SJed Brown @*/ 65618d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 65628d59e960SJed Brown { 65638d59e960SJed Brown PetscFunctionBegin; 65648d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 65658d59e960SJed Brown ts->cfltime_local = cfltime; 65668d59e960SJed Brown ts->cfltime = -1.; 65678d59e960SJed Brown PetscFunctionReturn(0); 65688d59e960SJed Brown } 65698d59e960SJed Brown 65708d59e960SJed Brown /*@ 65718d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 65728d59e960SJed Brown 65738d59e960SJed Brown Collective on TS 65748d59e960SJed Brown 65758d59e960SJed Brown Input Arguments: 65768d59e960SJed Brown . ts - time stepping context 65778d59e960SJed Brown 65788d59e960SJed Brown Output Arguments: 65798d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 65808d59e960SJed Brown 65818d59e960SJed Brown Level: advanced 65828d59e960SJed Brown 65838d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 65848d59e960SJed Brown @*/ 65858d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 65868d59e960SJed Brown { 65878d59e960SJed Brown PetscErrorCode ierr; 65888d59e960SJed Brown 65898d59e960SJed Brown PetscFunctionBegin; 65908d59e960SJed Brown if (ts->cfltime < 0) { 6591b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 65928d59e960SJed Brown } 65938d59e960SJed Brown *cfltime = ts->cfltime; 65948d59e960SJed Brown PetscFunctionReturn(0); 65958d59e960SJed Brown } 65968d59e960SJed Brown 6597d6ebe24aSShri Abhyankar /*@ 6598d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6599d6ebe24aSShri Abhyankar 6600d6ebe24aSShri Abhyankar Input Parameters: 6601d6ebe24aSShri Abhyankar . ts - the TS context. 6602d6ebe24aSShri Abhyankar . xl - lower bound. 6603d6ebe24aSShri Abhyankar . xu - upper bound. 6604d6ebe24aSShri Abhyankar 6605d6ebe24aSShri Abhyankar Notes: 6606d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6607e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6608d6ebe24aSShri Abhyankar 66092bd2b0e6SSatish Balay Level: advanced 66102bd2b0e6SSatish Balay 6611d6ebe24aSShri Abhyankar @*/ 6612d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6613d6ebe24aSShri Abhyankar { 6614d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6615d6ebe24aSShri Abhyankar SNES snes; 6616d6ebe24aSShri Abhyankar 6617d6ebe24aSShri Abhyankar PetscFunctionBegin; 6618d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6619d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6620d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6621d6ebe24aSShri Abhyankar } 6622d6ebe24aSShri Abhyankar 6623325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6624c6db04a5SJed Brown #include <mex.h> 6625325fc9f4SBarry Smith 6626325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6627325fc9f4SBarry Smith 6628325fc9f4SBarry Smith /* 6629325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6630325fc9f4SBarry Smith TSSetFunctionMatlab(). 6631325fc9f4SBarry Smith 6632325fc9f4SBarry Smith Collective on TS 6633325fc9f4SBarry Smith 6634325fc9f4SBarry Smith Input Parameters: 6635325fc9f4SBarry Smith + snes - the TS context 66360910c330SBarry Smith - u - input vector 6637325fc9f4SBarry Smith 6638325fc9f4SBarry Smith Output Parameter: 6639325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6640325fc9f4SBarry Smith 6641325fc9f4SBarry Smith Notes: 6642325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6643325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6644325fc9f4SBarry Smith themselves. 6645325fc9f4SBarry Smith 6646325fc9f4SBarry Smith Level: developer 6647325fc9f4SBarry Smith 6648325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6649325fc9f4SBarry Smith 6650325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6651325fc9f4SBarry Smith */ 66520910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6653325fc9f4SBarry Smith { 6654325fc9f4SBarry Smith PetscErrorCode ierr; 6655325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6656325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6657325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6658325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6659325fc9f4SBarry Smith 6660325fc9f4SBarry Smith PetscFunctionBegin; 6661325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 66620910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 66630910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6664325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 66650910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6666325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6667325fc9f4SBarry Smith 6668325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 66690910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 66700910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 66710910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6672bbd56ea5SKarl Rupp 6673325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6674325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6675325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6676325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6677325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6678325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6679325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6680325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6681325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6682325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6683325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6684325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6685325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6686325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6687325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6688325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6689325fc9f4SBarry Smith PetscFunctionReturn(0); 6690325fc9f4SBarry Smith } 6691325fc9f4SBarry Smith 6692325fc9f4SBarry Smith 6693325fc9f4SBarry Smith /* 6694325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6695325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6696e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6697325fc9f4SBarry Smith 6698325fc9f4SBarry Smith Logically Collective on TS 6699325fc9f4SBarry Smith 6700325fc9f4SBarry Smith Input Parameters: 6701325fc9f4SBarry Smith + ts - the TS context 6702325fc9f4SBarry Smith - func - function evaluation routine 6703325fc9f4SBarry Smith 6704325fc9f4SBarry Smith Calling sequence of func: 67050910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6706325fc9f4SBarry Smith 6707325fc9f4SBarry Smith Level: beginner 6708325fc9f4SBarry Smith 6709325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6710325fc9f4SBarry Smith 6711325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6712325fc9f4SBarry Smith */ 6713cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6714325fc9f4SBarry Smith { 6715325fc9f4SBarry Smith PetscErrorCode ierr; 6716325fc9f4SBarry Smith TSMatlabContext *sctx; 6717325fc9f4SBarry Smith 6718325fc9f4SBarry Smith PetscFunctionBegin; 6719325fc9f4SBarry Smith /* currently sctx is memory bleed */ 672095dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6721325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6722325fc9f4SBarry Smith /* 6723325fc9f4SBarry Smith This should work, but it doesn't 6724325fc9f4SBarry Smith sctx->ctx = ctx; 6725325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6726325fc9f4SBarry Smith */ 6727325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6728bbd56ea5SKarl Rupp 67290298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6730325fc9f4SBarry Smith PetscFunctionReturn(0); 6731325fc9f4SBarry Smith } 6732325fc9f4SBarry Smith 6733325fc9f4SBarry Smith /* 6734325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6735325fc9f4SBarry Smith TSSetJacobianMatlab(). 6736325fc9f4SBarry Smith 6737325fc9f4SBarry Smith Collective on TS 6738325fc9f4SBarry Smith 6739325fc9f4SBarry Smith Input Parameters: 6740cdcf91faSSean Farley + ts - the TS context 67410910c330SBarry Smith . u - input vector 6742325fc9f4SBarry Smith . A, B - the matrices 6743325fc9f4SBarry Smith - ctx - user context 6744325fc9f4SBarry Smith 6745325fc9f4SBarry Smith Level: developer 6746325fc9f4SBarry Smith 6747325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6748325fc9f4SBarry Smith 6749325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6750325fc9f4SBarry Smith @*/ 6751f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6752325fc9f4SBarry Smith { 6753325fc9f4SBarry Smith PetscErrorCode ierr; 6754325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6755325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6756325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6757325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6758325fc9f4SBarry Smith 6759325fc9f4SBarry Smith PetscFunctionBegin; 6760cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 67610910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6762325fc9f4SBarry Smith 67630910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6764325fc9f4SBarry Smith 6765cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 67660910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 67670910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 67680910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 67690910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6770bbd56ea5SKarl Rupp 6771325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6772325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6773325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6774325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6775325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6776325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6777325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6778325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6779325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6780325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6781325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6782325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6783325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6784325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6785325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6786325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6787325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6788325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6789325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6790325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6791325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6792325fc9f4SBarry Smith PetscFunctionReturn(0); 6793325fc9f4SBarry Smith } 6794325fc9f4SBarry Smith 6795325fc9f4SBarry Smith 6796325fc9f4SBarry Smith /* 6797325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6798e3c5b3baSBarry 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 6799325fc9f4SBarry Smith 6800325fc9f4SBarry Smith Logically Collective on TS 6801325fc9f4SBarry Smith 6802325fc9f4SBarry Smith Input Parameters: 6803cdcf91faSSean Farley + ts - the TS context 6804325fc9f4SBarry Smith . A,B - Jacobian matrices 6805325fc9f4SBarry Smith . func - function evaluation routine 6806325fc9f4SBarry Smith - ctx - user context 6807325fc9f4SBarry Smith 6808325fc9f4SBarry Smith Calling sequence of func: 68090910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6810325fc9f4SBarry Smith 6811325fc9f4SBarry Smith 6812325fc9f4SBarry Smith Level: developer 6813325fc9f4SBarry Smith 6814325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6815325fc9f4SBarry Smith 6816325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6817325fc9f4SBarry Smith */ 6818cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6819325fc9f4SBarry Smith { 6820325fc9f4SBarry Smith PetscErrorCode ierr; 6821325fc9f4SBarry Smith TSMatlabContext *sctx; 6822325fc9f4SBarry Smith 6823325fc9f4SBarry Smith PetscFunctionBegin; 6824325fc9f4SBarry Smith /* currently sctx is memory bleed */ 682595dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6826325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6827325fc9f4SBarry Smith /* 6828325fc9f4SBarry Smith This should work, but it doesn't 6829325fc9f4SBarry Smith sctx->ctx = ctx; 6830325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6831325fc9f4SBarry Smith */ 6832325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6833bbd56ea5SKarl Rupp 6834cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6835325fc9f4SBarry Smith PetscFunctionReturn(0); 6836325fc9f4SBarry Smith } 6837325fc9f4SBarry Smith 6838b5b1a830SBarry Smith /* 6839b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6840b5b1a830SBarry Smith 6841b5b1a830SBarry Smith Collective on TS 6842b5b1a830SBarry Smith 6843b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6844b5b1a830SBarry Smith @*/ 68450910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6846b5b1a830SBarry Smith { 6847b5b1a830SBarry Smith PetscErrorCode ierr; 6848b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6849a530c242SBarry Smith int nlhs = 1,nrhs = 6; 6850b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 6851b5b1a830SBarry Smith long long int lx = 0,ls = 0; 6852b5b1a830SBarry Smith 6853b5b1a830SBarry Smith PetscFunctionBegin; 6854cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 68550910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6856b5b1a830SBarry Smith 6857cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 68580910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6859bbd56ea5SKarl Rupp 6860b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6861b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 6862b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 6863b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 6864b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 6865b5b1a830SBarry Smith prhs[5] = sctx->ctx; 6866b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6867b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6868b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 6869b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 6870b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 6871b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 6872b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 6873b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 6874b5b1a830SBarry Smith PetscFunctionReturn(0); 6875b5b1a830SBarry Smith } 6876b5b1a830SBarry Smith 6877b5b1a830SBarry Smith 6878b5b1a830SBarry Smith /* 6879b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 6880b5b1a830SBarry Smith 6881b5b1a830SBarry Smith Level: developer 6882b5b1a830SBarry Smith 6883b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 6884b5b1a830SBarry Smith 6885b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6886b5b1a830SBarry Smith */ 6887cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6888b5b1a830SBarry Smith { 6889b5b1a830SBarry Smith PetscErrorCode ierr; 6890b5b1a830SBarry Smith TSMatlabContext *sctx; 6891b5b1a830SBarry Smith 6892b5b1a830SBarry Smith PetscFunctionBegin; 6893b5b1a830SBarry Smith /* currently sctx is memory bleed */ 689495dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6895b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6896b5b1a830SBarry Smith /* 6897b5b1a830SBarry Smith This should work, but it doesn't 6898b5b1a830SBarry Smith sctx->ctx = ctx; 6899b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6900b5b1a830SBarry Smith */ 6901b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6902bbd56ea5SKarl Rupp 69030298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6904b5b1a830SBarry Smith PetscFunctionReturn(0); 6905b5b1a830SBarry Smith } 6906325fc9f4SBarry Smith #endif 6907b3603a34SBarry Smith 6908b3603a34SBarry Smith /*@C 69094f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6910b3603a34SBarry Smith in a time based line graph 6911b3603a34SBarry Smith 6912b3603a34SBarry Smith Collective on TS 6913b3603a34SBarry Smith 6914b3603a34SBarry Smith Input Parameters: 6915b3603a34SBarry Smith + ts - the TS context 6916b3603a34SBarry Smith . step - current time-step 6917b3603a34SBarry Smith . ptime - current time 69187db568b7SBarry Smith . u - current solution 69197db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6920b3603a34SBarry Smith 6921b3d3934dSBarry Smith Options Database: 69229ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6923b3d3934dSBarry Smith 6924b3603a34SBarry Smith Level: intermediate 6925b3603a34SBarry Smith 69266934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component solutions in a separate window 6927b3603a34SBarry Smith 6928b3603a34SBarry Smith .keywords: TS, vector, monitor, view 6929b3603a34SBarry Smith 69307db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 69317db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 69327db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 69337db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6934b3603a34SBarry Smith @*/ 69357db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6936b3603a34SBarry Smith { 6937b3603a34SBarry Smith PetscErrorCode ierr; 69387db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6939b3603a34SBarry Smith const PetscScalar *yy; 694080666b62SBarry Smith Vec v; 6941b3603a34SBarry Smith 6942b3603a34SBarry Smith PetscFunctionBegin; 694363e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 694458ff32f7SBarry Smith if (!step) { 6945a9f9c1f6SBarry Smith PetscDrawAxis axis; 69466934998bSLisandro Dalcin PetscInt dim; 6947a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6948a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6949bab0a581SBarry Smith if (!ctx->names) { 6950bab0a581SBarry Smith PetscBool flg; 6951bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6952bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6953bab0a581SBarry Smith if (flg) { 6954bab0a581SBarry Smith PetscInt i,n; 6955bab0a581SBarry Smith char **names; 6956bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6957bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6958bab0a581SBarry Smith for (i=0; i<n; i++) { 6959bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6960bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6961bab0a581SBarry Smith } 6962bab0a581SBarry Smith names[n] = NULL; 6963bab0a581SBarry Smith ctx->names = names; 6964bab0a581SBarry Smith } 6965bab0a581SBarry Smith } 6966387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6967387f4636SBarry Smith char **displaynames; 6968387f4636SBarry Smith PetscBool flg; 6969387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 697095dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6971387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6972c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6973387f4636SBarry Smith if (flg) { 6974a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6975387f4636SBarry Smith } 6976387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6977387f4636SBarry Smith } 6978387f4636SBarry Smith if (ctx->displaynames) { 6979387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6980387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6981387f4636SBarry Smith } else if (ctx->names) { 69820910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 69830b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6984387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6985b0bc92c6SBarry Smith } else { 6986b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6987b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6988387f4636SBarry Smith } 69890b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 699058ff32f7SBarry Smith } 69916934998bSLisandro Dalcin 69926934998bSLisandro Dalcin if (!ctx->transform) v = u; 69936934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 699480666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 69956934998bSLisandro Dalcin if (ctx->displaynames) { 69966934998bSLisandro Dalcin PetscInt i; 69976934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 69986934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 69996934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 70006934998bSLisandro Dalcin } else { 7001e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7002e3efe391SJed Brown PetscInt i,n; 70036934998bSLisandro Dalcin PetscReal *yreal; 700480666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 7005785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7006e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 70070b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7008e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7009e3efe391SJed Brown #else 70100b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7011e3efe391SJed Brown #endif 701280666b62SBarry Smith } 70136934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 70146934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 70156934998bSLisandro Dalcin 7016b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 70170b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 70186934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 70193923b477SBarry Smith } 7020b3603a34SBarry Smith PetscFunctionReturn(0); 7021b3603a34SBarry Smith } 7022b3603a34SBarry Smith 7023387f4636SBarry Smith 7024b037adc7SBarry Smith /*@C 702531152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7026b037adc7SBarry Smith 7027b037adc7SBarry Smith Collective on TS 7028b037adc7SBarry Smith 7029b037adc7SBarry Smith Input Parameters: 7030b037adc7SBarry Smith + ts - the TS context 7031b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 7032b037adc7SBarry Smith 7033b037adc7SBarry Smith Level: intermediate 7034b037adc7SBarry Smith 70357db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70367db568b7SBarry Smith 7037b037adc7SBarry Smith .keywords: TS, vector, monitor, view 7038b037adc7SBarry Smith 7039a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 7040b037adc7SBarry Smith @*/ 704131152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 7042b037adc7SBarry Smith { 7043b037adc7SBarry Smith PetscErrorCode ierr; 7044b037adc7SBarry Smith PetscInt i; 7045b037adc7SBarry Smith 7046b037adc7SBarry Smith PetscFunctionBegin; 7047b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7048b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 70495537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 7050b3d3934dSBarry Smith break; 7051b3d3934dSBarry Smith } 7052b3d3934dSBarry Smith } 7053b3d3934dSBarry Smith PetscFunctionReturn(0); 7054b3d3934dSBarry Smith } 7055b3d3934dSBarry Smith 7056e673d494SBarry Smith /*@C 7057e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7058e673d494SBarry Smith 7059e673d494SBarry Smith Collective on TS 7060e673d494SBarry Smith 7061e673d494SBarry Smith Input Parameters: 7062e673d494SBarry Smith + ts - the TS context 7063e673d494SBarry Smith - names - the names of the components, final string must be NULL 7064e673d494SBarry Smith 7065e673d494SBarry Smith Level: intermediate 7066e673d494SBarry Smith 7067e673d494SBarry Smith .keywords: TS, vector, monitor, view 7068e673d494SBarry Smith 7069a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 7070e673d494SBarry Smith @*/ 7071e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 7072e673d494SBarry Smith { 7073e673d494SBarry Smith PetscErrorCode ierr; 7074e673d494SBarry Smith 7075e673d494SBarry Smith PetscFunctionBegin; 7076e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 7077e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 7078e673d494SBarry Smith PetscFunctionReturn(0); 7079e673d494SBarry Smith } 7080e673d494SBarry Smith 7081b3d3934dSBarry Smith /*@C 7082b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 7083b3d3934dSBarry Smith 7084b3d3934dSBarry Smith Collective on TS 7085b3d3934dSBarry Smith 7086b3d3934dSBarry Smith Input Parameter: 7087b3d3934dSBarry Smith . ts - the TS context 7088b3d3934dSBarry Smith 7089b3d3934dSBarry Smith Output Parameter: 7090b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 7091b3d3934dSBarry Smith 7092b3d3934dSBarry Smith Level: intermediate 7093b3d3934dSBarry Smith 70947db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 70957db568b7SBarry Smith 7096b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7097b3d3934dSBarry Smith 7098b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7099b3d3934dSBarry Smith @*/ 7100b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 7101b3d3934dSBarry Smith { 7102b3d3934dSBarry Smith PetscInt i; 7103b3d3934dSBarry Smith 7104b3d3934dSBarry Smith PetscFunctionBegin; 7105b3d3934dSBarry Smith *names = NULL; 7106b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7107b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71085537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 7109b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 7110b3d3934dSBarry Smith break; 7111387f4636SBarry Smith } 7112387f4636SBarry Smith } 7113387f4636SBarry Smith PetscFunctionReturn(0); 7114387f4636SBarry Smith } 7115387f4636SBarry Smith 7116a66092f1SBarry Smith /*@C 7117a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 7118a66092f1SBarry Smith 7119a66092f1SBarry Smith Collective on TS 7120a66092f1SBarry Smith 7121a66092f1SBarry Smith Input Parameters: 7122a66092f1SBarry Smith + ctx - the TSMonitorLG context 7123a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 7124a66092f1SBarry Smith 7125a66092f1SBarry Smith Level: intermediate 7126a66092f1SBarry Smith 7127a66092f1SBarry Smith .keywords: TS, vector, monitor, view 7128a66092f1SBarry Smith 7129a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7130a66092f1SBarry Smith @*/ 7131a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 7132a66092f1SBarry Smith { 7133a66092f1SBarry Smith PetscInt j = 0,k; 7134a66092f1SBarry Smith PetscErrorCode ierr; 7135a66092f1SBarry Smith 7136a66092f1SBarry Smith PetscFunctionBegin; 7137a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 7138a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 7139a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 7140a66092f1SBarry Smith while (displaynames[j]) j++; 7141a66092f1SBarry Smith ctx->ndisplayvariables = j; 7142a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 7143a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 7144a66092f1SBarry Smith j = 0; 7145a66092f1SBarry Smith while (displaynames[j]) { 7146a66092f1SBarry Smith k = 0; 7147a66092f1SBarry Smith while (ctx->names[k]) { 7148a66092f1SBarry Smith PetscBool flg; 7149a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 7150a66092f1SBarry Smith if (flg) { 7151a66092f1SBarry Smith ctx->displayvariables[j] = k; 7152a66092f1SBarry Smith break; 7153a66092f1SBarry Smith } 7154a66092f1SBarry Smith k++; 7155a66092f1SBarry Smith } 7156a66092f1SBarry Smith j++; 7157a66092f1SBarry Smith } 7158a66092f1SBarry Smith PetscFunctionReturn(0); 7159a66092f1SBarry Smith } 7160a66092f1SBarry Smith 7161a66092f1SBarry Smith 7162387f4636SBarry Smith /*@C 7163387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 7164387f4636SBarry Smith 7165387f4636SBarry Smith Collective on TS 7166387f4636SBarry Smith 7167387f4636SBarry Smith Input Parameters: 7168387f4636SBarry Smith + ts - the TS context 7169387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 7170387f4636SBarry Smith 71717db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 71727db568b7SBarry Smith 7173387f4636SBarry Smith Level: intermediate 7174387f4636SBarry Smith 7175387f4636SBarry Smith .keywords: TS, vector, monitor, view 7176387f4636SBarry Smith 7177387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7178387f4636SBarry Smith @*/ 7179387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 7180387f4636SBarry Smith { 7181a66092f1SBarry Smith PetscInt i; 7182387f4636SBarry Smith PetscErrorCode ierr; 7183387f4636SBarry Smith 7184387f4636SBarry Smith PetscFunctionBegin; 7185387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7186387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 71875537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 7188b3d3934dSBarry Smith break; 7189b037adc7SBarry Smith } 7190b037adc7SBarry Smith } 7191b037adc7SBarry Smith PetscFunctionReturn(0); 7192b037adc7SBarry Smith } 7193b037adc7SBarry Smith 719480666b62SBarry Smith /*@C 719580666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 719680666b62SBarry Smith 719780666b62SBarry Smith Collective on TS 719880666b62SBarry Smith 719980666b62SBarry Smith Input Parameters: 720080666b62SBarry Smith + ts - the TS context 720180666b62SBarry Smith . transform - the transform function 72027684fa3eSBarry Smith . destroy - function to destroy the optional context 720380666b62SBarry Smith - ctx - optional context used by transform function 720480666b62SBarry Smith 72057db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 72067db568b7SBarry Smith 720780666b62SBarry Smith Level: intermediate 720880666b62SBarry Smith 720980666b62SBarry Smith .keywords: TS, vector, monitor, view 721080666b62SBarry Smith 7211a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 721280666b62SBarry Smith @*/ 72137684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 721480666b62SBarry Smith { 721580666b62SBarry Smith PetscInt i; 7216a66092f1SBarry Smith PetscErrorCode ierr; 721780666b62SBarry Smith 721880666b62SBarry Smith PetscFunctionBegin; 721980666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 722080666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 72215537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 722280666b62SBarry Smith } 722380666b62SBarry Smith } 722480666b62SBarry Smith PetscFunctionReturn(0); 722580666b62SBarry Smith } 722680666b62SBarry Smith 7227e673d494SBarry Smith /*@C 7228e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 7229e673d494SBarry Smith 7230e673d494SBarry Smith Collective on TSLGCtx 7231e673d494SBarry Smith 7232e673d494SBarry Smith Input Parameters: 7233e673d494SBarry Smith + ts - the TS context 7234e673d494SBarry Smith . transform - the transform function 72357684fa3eSBarry Smith . destroy - function to destroy the optional context 7236e673d494SBarry Smith - ctx - optional context used by transform function 7237e673d494SBarry Smith 7238e673d494SBarry Smith Level: intermediate 7239e673d494SBarry Smith 7240e673d494SBarry Smith .keywords: TS, vector, monitor, view 7241e673d494SBarry Smith 7242a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 7243e673d494SBarry Smith @*/ 72447684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 7245e673d494SBarry Smith { 7246e673d494SBarry Smith PetscFunctionBegin; 7247e673d494SBarry Smith ctx->transform = transform; 72487684fa3eSBarry Smith ctx->transformdestroy = destroy; 7249e673d494SBarry Smith ctx->transformctx = tctx; 7250e673d494SBarry Smith PetscFunctionReturn(0); 7251e673d494SBarry Smith } 7252e673d494SBarry Smith 7253ef20d060SBarry Smith /*@C 72544f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 7255ef20d060SBarry Smith in a time based line graph 7256ef20d060SBarry Smith 7257ef20d060SBarry Smith Collective on TS 7258ef20d060SBarry Smith 7259ef20d060SBarry Smith Input Parameters: 7260ef20d060SBarry Smith + ts - the TS context 7261ef20d060SBarry Smith . step - current time-step 7262ef20d060SBarry Smith . ptime - current time 72637db568b7SBarry Smith . u - current solution 72647db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 7265ef20d060SBarry Smith 7266ef20d060SBarry Smith Level: intermediate 7267ef20d060SBarry Smith 72686934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component errors in a separate window 7269abd5a294SJed Brown 7270abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 7271abd5a294SJed Brown 7272abd5a294SJed Brown Options Database Keys: 72734f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 7274ef20d060SBarry Smith 7275ef20d060SBarry Smith .keywords: TS, vector, monitor, view 7276ef20d060SBarry Smith 7277abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 7278ef20d060SBarry Smith @*/ 72790910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 7280ef20d060SBarry Smith { 7281ef20d060SBarry Smith PetscErrorCode ierr; 72820b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 7283ef20d060SBarry Smith const PetscScalar *yy; 7284ef20d060SBarry Smith Vec y; 7285ef20d060SBarry Smith 7286ef20d060SBarry Smith PetscFunctionBegin; 7287a9f9c1f6SBarry Smith if (!step) { 7288a9f9c1f6SBarry Smith PetscDrawAxis axis; 72896934998bSLisandro Dalcin PetscInt dim; 7290a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 72911ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 72920910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 7293a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7294a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7295a9f9c1f6SBarry Smith } 72960910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 7297ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 72980910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7299ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 7300e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7301e3efe391SJed Brown { 7302e3efe391SJed Brown PetscReal *yreal; 7303e3efe391SJed Brown PetscInt i,n; 7304e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 7305785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7306e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 73070b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7308e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7309e3efe391SJed Brown } 7310e3efe391SJed Brown #else 73110b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7312e3efe391SJed Brown #endif 7313ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 7314ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 7315b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 73160b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73176934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 73183923b477SBarry Smith } 7319ef20d060SBarry Smith PetscFunctionReturn(0); 7320ef20d060SBarry Smith } 7321ef20d060SBarry Smith 7322201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7323201da799SBarry Smith { 7324201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7325201da799SBarry Smith PetscReal x = ptime,y; 7326201da799SBarry Smith PetscErrorCode ierr; 7327201da799SBarry Smith PetscInt its; 7328201da799SBarry Smith 7329201da799SBarry Smith PetscFunctionBegin; 733063e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7331201da799SBarry Smith if (!n) { 7332201da799SBarry Smith PetscDrawAxis axis; 7333201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7334201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7335201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7336201da799SBarry Smith ctx->snes_its = 0; 7337201da799SBarry Smith } 7338201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7339201da799SBarry Smith y = its - ctx->snes_its; 7340201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 73413fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7342201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73436934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7344201da799SBarry Smith } 7345201da799SBarry Smith ctx->snes_its = its; 7346201da799SBarry Smith PetscFunctionReturn(0); 7347201da799SBarry Smith } 7348201da799SBarry Smith 7349201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7350201da799SBarry Smith { 7351201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7352201da799SBarry Smith PetscReal x = ptime,y; 7353201da799SBarry Smith PetscErrorCode ierr; 7354201da799SBarry Smith PetscInt its; 7355201da799SBarry Smith 7356201da799SBarry Smith PetscFunctionBegin; 735763e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7358201da799SBarry Smith if (!n) { 7359201da799SBarry Smith PetscDrawAxis axis; 7360201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7361201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7362201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7363201da799SBarry Smith ctx->ksp_its = 0; 7364201da799SBarry Smith } 7365201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7366201da799SBarry Smith y = its - ctx->ksp_its; 7367201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 736899fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7369201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 73706934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7371201da799SBarry Smith } 7372201da799SBarry Smith ctx->ksp_its = its; 7373201da799SBarry Smith PetscFunctionReturn(0); 7374201da799SBarry Smith } 7375f9c1d6abSBarry Smith 7376f9c1d6abSBarry Smith /*@ 7377f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7378f9c1d6abSBarry Smith 7379f9c1d6abSBarry Smith Collective on TS and Vec 7380f9c1d6abSBarry Smith 7381f9c1d6abSBarry Smith Input Parameters: 7382f9c1d6abSBarry Smith + ts - the TS context 7383f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7384f9c1d6abSBarry Smith 7385f9c1d6abSBarry Smith Output Parameters: 7386f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7387f9c1d6abSBarry Smith 7388f9c1d6abSBarry Smith Level: developer 7389f9c1d6abSBarry Smith 7390f9c1d6abSBarry Smith .keywords: TS, compute 7391f9c1d6abSBarry Smith 7392f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7393f9c1d6abSBarry Smith @*/ 7394f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7395f9c1d6abSBarry Smith { 7396f9c1d6abSBarry Smith PetscErrorCode ierr; 7397f9c1d6abSBarry Smith 7398f9c1d6abSBarry Smith PetscFunctionBegin; 7399f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7400ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7401f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7402f9c1d6abSBarry Smith PetscFunctionReturn(0); 7403f9c1d6abSBarry Smith } 740424655328SShri 7405b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7406b3d3934dSBarry Smith /*@C 7407b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7408b3d3934dSBarry Smith 7409b3d3934dSBarry Smith Collective on TS 7410b3d3934dSBarry Smith 7411b3d3934dSBarry Smith Input Parameters: 7412b3d3934dSBarry Smith . ts - the ODE solver object 7413b3d3934dSBarry Smith 7414b3d3934dSBarry Smith Output Parameter: 7415b3d3934dSBarry Smith . ctx - the context 7416b3d3934dSBarry Smith 7417b3d3934dSBarry Smith Level: intermediate 7418b3d3934dSBarry Smith 7419b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 7420b3d3934dSBarry Smith 7421b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7422b3d3934dSBarry Smith 7423b3d3934dSBarry Smith @*/ 7424b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7425b3d3934dSBarry Smith { 7426b3d3934dSBarry Smith PetscErrorCode ierr; 7427b3d3934dSBarry Smith 7428b3d3934dSBarry Smith PetscFunctionBegin; 7429a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7430b3d3934dSBarry Smith PetscFunctionReturn(0); 7431b3d3934dSBarry Smith } 7432b3d3934dSBarry Smith 7433b3d3934dSBarry Smith /*@C 7434b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7435b3d3934dSBarry Smith 7436b3d3934dSBarry Smith Collective on TS 7437b3d3934dSBarry Smith 7438b3d3934dSBarry Smith Input Parameters: 7439b3d3934dSBarry Smith + ts - the TS context 7440b3d3934dSBarry Smith . step - current time-step 7441b3d3934dSBarry Smith . ptime - current time 74427db568b7SBarry Smith . u - current solution 74437db568b7SBarry Smith - dctx - the envelope context 7444b3d3934dSBarry Smith 7445b3d3934dSBarry Smith Options Database: 7446b3d3934dSBarry Smith . -ts_monitor_envelope 7447b3d3934dSBarry Smith 7448b3d3934dSBarry Smith Level: intermediate 7449b3d3934dSBarry Smith 7450b3d3934dSBarry Smith Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7451b3d3934dSBarry Smith 7452b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7453b3d3934dSBarry Smith 74547db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7455b3d3934dSBarry Smith @*/ 74567db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7457b3d3934dSBarry Smith { 7458b3d3934dSBarry Smith PetscErrorCode ierr; 74597db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7460b3d3934dSBarry Smith 7461b3d3934dSBarry Smith PetscFunctionBegin; 7462b3d3934dSBarry Smith if (!ctx->max) { 7463b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7464b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7465b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7466b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7467b3d3934dSBarry Smith } else { 7468b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7469b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7470b3d3934dSBarry Smith } 7471b3d3934dSBarry Smith PetscFunctionReturn(0); 7472b3d3934dSBarry Smith } 7473b3d3934dSBarry Smith 7474b3d3934dSBarry Smith 7475b3d3934dSBarry Smith /*@C 7476b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7477b3d3934dSBarry Smith 7478b3d3934dSBarry Smith Collective on TS 7479b3d3934dSBarry Smith 7480b3d3934dSBarry Smith Input Parameter: 7481b3d3934dSBarry Smith . ts - the TS context 7482b3d3934dSBarry Smith 7483b3d3934dSBarry Smith Output Parameter: 7484b3d3934dSBarry Smith + max - the maximum values 7485b3d3934dSBarry Smith - min - the minimum values 7486b3d3934dSBarry Smith 74877db568b7SBarry Smith Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 74887db568b7SBarry Smith 7489b3d3934dSBarry Smith Level: intermediate 7490b3d3934dSBarry Smith 7491b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7492b3d3934dSBarry Smith 7493b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7494b3d3934dSBarry Smith @*/ 7495b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7496b3d3934dSBarry Smith { 7497b3d3934dSBarry Smith PetscInt i; 7498b3d3934dSBarry Smith 7499b3d3934dSBarry Smith PetscFunctionBegin; 7500b3d3934dSBarry Smith if (max) *max = NULL; 7501b3d3934dSBarry Smith if (min) *min = NULL; 7502b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7503b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 75045537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7505b3d3934dSBarry Smith if (max) *max = ctx->max; 7506b3d3934dSBarry Smith if (min) *min = ctx->min; 7507b3d3934dSBarry Smith break; 7508b3d3934dSBarry Smith } 7509b3d3934dSBarry Smith } 7510b3d3934dSBarry Smith PetscFunctionReturn(0); 7511b3d3934dSBarry Smith } 7512b3d3934dSBarry Smith 7513b3d3934dSBarry Smith /*@C 7514b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7515b3d3934dSBarry Smith 7516b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7517b3d3934dSBarry Smith 7518b3d3934dSBarry Smith Input Parameter: 7519b3d3934dSBarry Smith . ctx - the monitor context 7520b3d3934dSBarry Smith 7521b3d3934dSBarry Smith Level: intermediate 7522b3d3934dSBarry Smith 7523b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7524b3d3934dSBarry Smith 75257db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7526b3d3934dSBarry Smith @*/ 7527b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7528b3d3934dSBarry Smith { 7529b3d3934dSBarry Smith PetscErrorCode ierr; 7530b3d3934dSBarry Smith 7531b3d3934dSBarry Smith PetscFunctionBegin; 7532b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7533b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7534b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7535b3d3934dSBarry Smith PetscFunctionReturn(0); 7536b3d3934dSBarry Smith } 7537f2dee214SBarry Smith 753824655328SShri /*@ 753924655328SShri TSRollBack - Rolls back one time step 754024655328SShri 754124655328SShri Collective on TS 754224655328SShri 754324655328SShri Input Parameter: 754424655328SShri . ts - the TS context obtained from TSCreate() 754524655328SShri 754624655328SShri Level: advanced 754724655328SShri 754824655328SShri .keywords: TS, timestep, rollback 754924655328SShri 755024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 755124655328SShri @*/ 755224655328SShri PetscErrorCode TSRollBack(TS ts) 755324655328SShri { 755424655328SShri PetscErrorCode ierr; 755524655328SShri 755624655328SShri PetscFunctionBegin; 755724655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7558b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 755924655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 756024655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 756124655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 756224655328SShri ts->ptime = ts->ptime_prev; 7563be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 7564be5899b3SLisandro Dalcin ts->steps--; ts->total_steps--; 756510b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 7566b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 756724655328SShri PetscFunctionReturn(0); 756824655328SShri } 7569aeb4809dSShri Abhyankar 7570ff22ae23SHong Zhang /*@ 7571ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7572ff22ae23SHong Zhang 7573ff22ae23SHong Zhang Input Parameter: 7574ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7575ff22ae23SHong Zhang 7576ff22ae23SHong Zhang Level: advanced 7577ff22ae23SHong Zhang 7578ff22ae23SHong Zhang .keywords: TS, getstages 7579ff22ae23SHong Zhang 7580ff22ae23SHong Zhang .seealso: TSCreate() 7581ff22ae23SHong Zhang @*/ 7582ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7583ff22ae23SHong Zhang { 7584ff22ae23SHong Zhang PetscErrorCode ierr; 7585ff22ae23SHong Zhang 7586ff22ae23SHong Zhang PetscFunctionBegin; 7587ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7588ff22ae23SHong Zhang PetscValidPointer(ns,2); 7589ff22ae23SHong Zhang 7590ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 7591ff22ae23SHong Zhang else { 7592ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7593ff22ae23SHong Zhang } 7594ff22ae23SHong Zhang PetscFunctionReturn(0); 7595ff22ae23SHong Zhang } 7596ff22ae23SHong Zhang 7597847ff0e1SMatthew G. Knepley /*@C 7598847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7599847ff0e1SMatthew G. Knepley 7600847ff0e1SMatthew G. Knepley Collective on SNES 7601847ff0e1SMatthew G. Knepley 7602847ff0e1SMatthew G. Knepley Input Parameters: 7603847ff0e1SMatthew G. Knepley + ts - the TS context 7604847ff0e1SMatthew G. Knepley . t - current timestep 7605847ff0e1SMatthew G. Knepley . U - state vector 7606847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7607847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7608847ff0e1SMatthew G. Knepley - ctx - an optional user context 7609847ff0e1SMatthew G. Knepley 7610847ff0e1SMatthew G. Knepley Output Parameters: 7611847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7612847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7613847ff0e1SMatthew G. Knepley 7614847ff0e1SMatthew G. Knepley Level: intermediate 7615847ff0e1SMatthew G. Knepley 7616847ff0e1SMatthew G. Knepley Notes: 7617847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7618847ff0e1SMatthew G. Knepley 7619847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7620847ff0e1SMatthew G. Knepley 7621847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7622847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7623847ff0e1SMatthew G. Knepley 7624847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7625847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7626847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7627847ff0e1SMatthew G. Knepley 7628847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7629847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7630847ff0e1SMatthew G. Knepley @*/ 7631847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7632847ff0e1SMatthew G. Knepley { 7633847ff0e1SMatthew G. Knepley SNES snes; 7634847ff0e1SMatthew G. Knepley MatFDColoring color; 7635847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7636847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7637847ff0e1SMatthew G. Knepley 7638847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7639c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7640847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7641847ff0e1SMatthew G. Knepley if (!color) { 7642847ff0e1SMatthew G. Knepley DM dm; 7643847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7644847ff0e1SMatthew G. Knepley 7645847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7646847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7647847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7648847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7649847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7650847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7651847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7652847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7653847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7654847ff0e1SMatthew G. Knepley } else { 7655847ff0e1SMatthew G. Knepley MatColoring mc; 7656847ff0e1SMatthew G. Knepley 7657847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7658847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7659847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7660847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7661847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7662847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7663847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7664847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7665847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7666847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7667847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7668847ff0e1SMatthew G. Knepley } 7669847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7670847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7671847ff0e1SMatthew G. Knepley } 7672847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7673847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7674847ff0e1SMatthew G. Knepley if (J != B) { 7675847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7676847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7677847ff0e1SMatthew G. Knepley } 7678847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7679847ff0e1SMatthew G. Knepley } 768093b34091SDebojyoti Ghosh 7681cb9d8021SPierre Barbier de Reuille /*@ 7682cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7683cb9d8021SPierre Barbier de Reuille 7684cb9d8021SPierre Barbier de Reuille Input Parameters: 7685cb9d8021SPierre Barbier de Reuille ts - the TS context 7686cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7687cb9d8021SPierre Barbier de Reuille 7688cb9d8021SPierre Barbier de Reuille Level: intermediate 7689cb9d8021SPierre Barbier de Reuille 7690cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7691cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7692cb9d8021SPierre Barbier de Reuille @*/ 7693cb9d8021SPierre Barbier de Reuille 7694d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7695cb9d8021SPierre Barbier de Reuille { 7696cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7697cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7698cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7699cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7700cb9d8021SPierre Barbier de Reuille } 7701cb9d8021SPierre Barbier de Reuille 7702cb9d8021SPierre Barbier de Reuille /*@ 7703cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7704cb9d8021SPierre Barbier de Reuille 7705cb9d8021SPierre Barbier de Reuille Input Parameters: 7706cb9d8021SPierre Barbier de Reuille ts - the TS context 7707cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7708d183316bSPierre Barbier de Reuille Y - state vector to check. 7709cb9d8021SPierre Barbier de Reuille 7710cb9d8021SPierre Barbier de Reuille Output Parameter: 7711cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7712cb9d8021SPierre Barbier de Reuille 7713cb9d8021SPierre Barbier de Reuille Note: 7714cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7715cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 771696a0c994SBarry Smith 771796a0c994SBarry Smith Level: advanced 7718cb9d8021SPierre Barbier de Reuille @*/ 7719d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7720cb9d8021SPierre Barbier de Reuille { 7721cb9d8021SPierre Barbier de Reuille PetscErrorCode ierr; 7722cb9d8021SPierre Barbier de Reuille 7723cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7724cb9d8021SPierre Barbier de Reuille 7725cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7726cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7727cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7728d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7729cb9d8021SPierre Barbier de Reuille } 7730cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7731cb9d8021SPierre Barbier de Reuille } 77321ceb14c0SBarry Smith 773393b34091SDebojyoti Ghosh /*@C 7734e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 773593b34091SDebojyoti Ghosh 773693b34091SDebojyoti Ghosh Collective on MPI_Comm 773793b34091SDebojyoti Ghosh 773893b34091SDebojyoti Ghosh Input Parameter: 773993b34091SDebojyoti Ghosh . tsin - The input TS 774093b34091SDebojyoti Ghosh 774193b34091SDebojyoti Ghosh Output Parameter: 7742e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 774393b34091SDebojyoti Ghosh 77445eca1a21SEmil Constantinescu Notes: 77455eca1a21SEmil 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. 77465eca1a21SEmil Constantinescu 7747baa10174SEmil 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); 77485eca1a21SEmil Constantinescu 77495eca1a21SEmil Constantinescu Level: developer 775093b34091SDebojyoti Ghosh 7751e5168f73SEmil Constantinescu .keywords: TS, clone 7752e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 775393b34091SDebojyoti Ghosh @*/ 7754baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 775593b34091SDebojyoti Ghosh { 775693b34091SDebojyoti Ghosh TS t; 775793b34091SDebojyoti Ghosh PetscErrorCode ierr; 7758dc846ba4SSatish Balay SNES snes_start; 7759dc846ba4SSatish Balay DM dm; 7760dc846ba4SSatish Balay TSType type; 776193b34091SDebojyoti Ghosh 776293b34091SDebojyoti Ghosh PetscFunctionBegin; 776393b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 776493b34091SDebojyoti Ghosh *tsout = NULL; 776593b34091SDebojyoti Ghosh 77667a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 776793b34091SDebojyoti Ghosh 776893b34091SDebojyoti Ghosh /* General TS description */ 776993b34091SDebojyoti Ghosh t->numbermonitors = 0; 777093b34091SDebojyoti Ghosh t->setupcalled = 0; 777193b34091SDebojyoti Ghosh t->ksp_its = 0; 777293b34091SDebojyoti Ghosh t->snes_its = 0; 777393b34091SDebojyoti Ghosh t->nwork = 0; 777493b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 777593b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 777693b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 777793b34091SDebojyoti Ghosh 777834561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 777934561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7780d15a3a53SEmil Constantinescu 778193b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 778293b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 778393b34091SDebojyoti Ghosh 778493b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 778551699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 778693b34091SDebojyoti Ghosh 7787e7069c78SShri t->trajectory = tsin->trajectory; 7788e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7789e7069c78SShri 7790e7069c78SShri t->event = tsin->event; 77916b10a48eSSatish Balay if (t->event) t->event->refct++; 7792e7069c78SShri 779393b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 779493b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7795e7069c78SShri t->ptime_prev = tsin->ptime_prev; 779693b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 779793b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 779893b34091SDebojyoti Ghosh t->steps = tsin->steps; 7799e7069c78SShri t->total_steps = tsin->total_steps; 780093b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 780193b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 780293b34091SDebojyoti Ghosh t->atol = tsin->atol; 780393b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 780493b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 780593b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 780693b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 780793b34091SDebojyoti Ghosh 780893b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 780993b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 781093b34091SDebojyoti Ghosh 781193b34091SDebojyoti Ghosh t->vec_sol = NULL; 781293b34091SDebojyoti Ghosh 781393b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 781493b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 781593b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 781693b34091SDebojyoti Ghosh 781793b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 781893b34091SDebojyoti Ghosh 78190d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 78200d4fed19SBarry Smith PetscInt i; 78210d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 78220d4fed19SBarry Smith for (i=0; i<10; i++) { 78230d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 78240d4fed19SBarry Smith } 78250d4fed19SBarry Smith } 782693b34091SDebojyoti Ghosh *tsout = t; 782793b34091SDebojyoti Ghosh PetscFunctionReturn(0); 782893b34091SDebojyoti Ghosh } 7829