1af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 2496e6a7aSJed Brown #include <petscdmshell.h> 31e25c274SJed Brown #include <petscdmda.h> 42d5ee99bSBarry Smith #include <petscviewer.h> 52d5ee99bSBarry Smith #include <petscdraw.h> 6d763cef2SBarry Smith 7d5ba7fb7SMatthew Knepley /* Logging support */ 8d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 98d0ad7a8SHong Zhang PetscLogEvent TS_AdjointStep, TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 10d405a339SMatthew Knepley 11feed9e9dSBarry Smith const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0}; 1249354f04SShri Abhyankar 132d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx { 142d5ee99bSBarry Smith PetscViewer viewer; 152d5ee99bSBarry Smith Vec initialsolution; 162d5ee99bSBarry Smith PetscBool showinitial; 172d5ee99bSBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 182d5ee99bSBarry Smith PetscBool showtimestepandtime; 192d5ee99bSBarry Smith }; 202d5ee99bSBarry Smith 21fde5950dSBarry Smith /*@C 22fde5950dSBarry Smith TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 23fde5950dSBarry Smith 24fde5950dSBarry Smith Collective on TS 25fde5950dSBarry Smith 26fde5950dSBarry Smith Input Parameters: 27fde5950dSBarry Smith + ts - TS object you wish to monitor 28fde5950dSBarry Smith . name - the monitor type one is seeking 29fde5950dSBarry Smith . help - message indicating what monitoring is done 30fde5950dSBarry Smith . manual - manual page for the monitor 31fde5950dSBarry Smith . monitor - the monitor function 32fde5950dSBarry 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 33fde5950dSBarry Smith 34fde5950dSBarry Smith Level: developer 35fde5950dSBarry Smith 36fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 37fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 38fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 39fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 40fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 41fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 42fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 43fde5950dSBarry Smith @*/ 44721cd6eeSBarry 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*)) 45fde5950dSBarry Smith { 46fde5950dSBarry Smith PetscErrorCode ierr; 47fde5950dSBarry Smith PetscViewer viewer; 48fde5950dSBarry Smith PetscViewerFormat format; 49fde5950dSBarry Smith PetscBool flg; 50fde5950dSBarry Smith 51fde5950dSBarry Smith PetscFunctionBegin; 52fde5950dSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 53fde5950dSBarry Smith if (flg) { 54721cd6eeSBarry Smith PetscViewerAndFormat *vf; 55721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 56721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 57fde5950dSBarry Smith if (monitorsetup) { 58721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 59fde5950dSBarry Smith } 60721cd6eeSBarry Smith ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 61fde5950dSBarry Smith } 62fde5950dSBarry Smith PetscFunctionReturn(0); 63fde5950dSBarry Smith } 64fde5950dSBarry Smith 65fde5950dSBarry Smith /*@C 66e875c4f7SBarry Smith TSAdjointMonitorSensi - monitors the first lambda sensitivity 67287c2655SBarry Smith 68287c2655SBarry Smith Level: intermediate 69287c2655SBarry Smith 70287c2655SBarry Smith .keywords: TS, set, monitor 71287c2655SBarry Smith 72287c2655SBarry Smith .seealso: TSAdjointMonitorSet() 73287c2655SBarry Smith @*/ 74f4c7b390SBarry Smith PetscErrorCode TSAdjointMonitorSensi(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 75287c2655SBarry Smith { 76287c2655SBarry Smith PetscErrorCode ierr; 77287c2655SBarry Smith PetscViewer viewer = vf->viewer; 78287c2655SBarry Smith 79287c2655SBarry Smith PetscFunctionBegin; 80287c2655SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 81287c2655SBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 82287c2655SBarry Smith ierr = VecView(lambda[0],viewer);CHKERRQ(ierr); 83287c2655SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 84287c2655SBarry Smith PetscFunctionReturn(0); 85287c2655SBarry Smith } 86287c2655SBarry Smith 87287c2655SBarry Smith /*@C 88fde5950dSBarry Smith TSAdjointMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 89fde5950dSBarry Smith 90fde5950dSBarry Smith Collective on TS 91fde5950dSBarry Smith 92fde5950dSBarry Smith Input Parameters: 93fde5950dSBarry Smith + ts - TS object you wish to monitor 94fde5950dSBarry Smith . name - the monitor type one is seeking 95fde5950dSBarry Smith . help - message indicating what monitoring is done 96fde5950dSBarry Smith . manual - manual page for the monitor 97fde5950dSBarry Smith . monitor - the monitor function 98fde5950dSBarry 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 99fde5950dSBarry Smith 100fde5950dSBarry Smith Level: developer 101fde5950dSBarry Smith 102fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 103fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 104fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 105fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 106fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 107fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 108fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 109fde5950dSBarry Smith @*/ 110721cd6eeSBarry 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*)) 111fde5950dSBarry Smith { 112fde5950dSBarry Smith PetscErrorCode ierr; 113fde5950dSBarry Smith PetscViewer viewer; 114fde5950dSBarry Smith PetscViewerFormat format; 115fde5950dSBarry Smith PetscBool flg; 116fde5950dSBarry Smith 117fde5950dSBarry Smith PetscFunctionBegin; 118fde5950dSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 119fde5950dSBarry Smith if (flg) { 120721cd6eeSBarry Smith PetscViewerAndFormat *vf; 121721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 122721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 123fde5950dSBarry Smith if (monitorsetup) { 124721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 125fde5950dSBarry Smith } 126721cd6eeSBarry Smith ierr = TSAdjointMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 127fde5950dSBarry Smith } 128fde5950dSBarry Smith PetscFunctionReturn(0); 129fde5950dSBarry Smith } 130fde5950dSBarry Smith 1312ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type) 1322ffb9264SLisandro Dalcin { 1332ffb9264SLisandro Dalcin PetscErrorCode ierr; 1342ffb9264SLisandro Dalcin 1352ffb9264SLisandro Dalcin PetscFunctionBegin; 136b92453a8SLisandro Dalcin PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 137b92453a8SLisandro Dalcin PetscValidCharPointer(default_type,2); 1382ffb9264SLisandro Dalcin if (!((PetscObject)adapt)->type_name) { 1392ffb9264SLisandro Dalcin ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr); 1402ffb9264SLisandro Dalcin } 1412ffb9264SLisandro Dalcin PetscFunctionReturn(0); 1422ffb9264SLisandro Dalcin } 1432ffb9264SLisandro Dalcin 144bdad233fSMatthew Knepley /*@ 145bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 146bdad233fSMatthew Knepley 147bdad233fSMatthew Knepley Collective on TS 148bdad233fSMatthew Knepley 149bdad233fSMatthew Knepley Input Parameter: 150bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 151bdad233fSMatthew Knepley 152bdad233fSMatthew Knepley Options Database Keys: 153b6a60446SDebojyoti Ghosh + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE 154ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 1553e4cdcaaSBarry Smith . -ts_max_steps <maxsteps> - maximum number of time-steps to take 1563e4cdcaaSBarry Smith . -ts_final_time <time> - maximum time to compute to 1573e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 158a3cdaa26SBarry 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 159a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 160a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 161a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 162a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 163a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 164ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 165847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 166bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 167de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 168de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 1696934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 170de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 171de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 172de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 173de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 1743e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 1753e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 176fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 177e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 178110eb670SHong Zhang . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 179110eb670SHong Zhang . -ts_adjoint_monitor - print information at each adjoint time step 18053ea634cSHong Zhang - -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically 18153ea634cSHong Zhang 18291b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 183bdad233fSMatthew Knepley 184bdad233fSMatthew Knepley Level: beginner 185bdad233fSMatthew Knepley 186bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 187bdad233fSMatthew Knepley 188a313700dSBarry Smith .seealso: TSGetType() 189bdad233fSMatthew Knepley @*/ 1907087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 191bdad233fSMatthew Knepley { 192bc952696SBarry Smith PetscBool opt,flg,tflg; 193dfbe8321SBarry Smith PetscErrorCode ierr; 194eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 19531748224SBarry Smith PetscReal time_step; 19649354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 197d1212d36SBarry Smith char dir[16]; 198cd11d68dSLisandro Dalcin TSIFunction ifun; 1996991f827SBarry Smith const char *defaultType; 2006991f827SBarry Smith char typeName[256]; 201bdad233fSMatthew Knepley 202bdad233fSMatthew Knepley PetscFunctionBegin; 2030700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2046991f827SBarry Smith 2056991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 206cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 207cd11d68dSLisandro Dalcin 208cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 209cd11d68dSLisandro Dalcin if (((PetscObject)ts)->type_name) 210cd11d68dSLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 211cd11d68dSLisandro Dalcin else 212cd11d68dSLisandro Dalcin defaultType = ifun ? TSBEULER : TSEULER; 2136991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 2146991f827SBarry Smith if (opt) { 2156991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 2166991f827SBarry Smith } else { 2176991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 2186991f827SBarry Smith } 219bdad233fSMatthew Knepley 220bdad233fSMatthew Knepley /* Handle generic TS options */ 2210298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 2220298fd71SBarry Smith ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 2230298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 22431748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 225cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 22649354f04SShri 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); 22749354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 2280298fd71SBarry 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); 2290298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 2300298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 2310298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 2320298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 233bdad233fSMatthew Knepley 23456f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 23556f85f32SBarry Smith { 23656f85f32SBarry Smith PetscBool set; 23756f85f32SBarry Smith flg = PETSC_FALSE; 23856f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 23956f85f32SBarry Smith if (set) { 24056f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 24156f85f32SBarry Smith } 24256f85f32SBarry Smith } 24356f85f32SBarry Smith #endif 24456f85f32SBarry Smith 245bdad233fSMatthew Knepley /* Monitor options */ 246cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 247fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 248fde5950dSBarry Smith ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault",TSAdjointMonitorDefault,NULL);CHKERRQ(ierr); 249e875c4f7SBarry Smith ierr = TSAdjointMonitorSetFromOptions(ts,"-ts_adjoint_monitor_sensi","Monitor sensitivity in the adjoint computation","TSAdjointMonitorSensi",TSAdjointMonitorSensi,NULL);CHKERRQ(ierr); 250fde5950dSBarry Smith 2515180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 2525180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 2535180491cSLisandro Dalcin 2544f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 255b3603a34SBarry Smith if (opt) { 2560b039ecaSBarry Smith TSMonitorLGCtx ctx; 2573923b477SBarry Smith PetscInt howoften = 1; 258b3603a34SBarry Smith 2590298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2606ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2614f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 262bdad233fSMatthew Knepley } 2636ba87a44SLisandro Dalcin 2644f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 265ef20d060SBarry Smith if (opt) { 2660b039ecaSBarry Smith TSMonitorLGCtx ctx; 2673923b477SBarry Smith PetscInt howoften = 1; 268ef20d060SBarry Smith 2690298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 2706ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2714f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 272ef20d060SBarry Smith } 2736934998bSLisandro Dalcin 2746934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2756934998bSLisandro Dalcin if (opt) { 2766934998bSLisandro Dalcin TSMonitorLGCtx ctx; 2776934998bSLisandro Dalcin PetscInt howoften = 1; 2786934998bSLisandro Dalcin 2796934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2806ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2816934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2826934998bSLisandro Dalcin } 283201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 284201da799SBarry Smith if (opt) { 285201da799SBarry Smith TSMonitorLGCtx ctx; 286201da799SBarry Smith PetscInt howoften = 1; 287201da799SBarry Smith 2880298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2896ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 290201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 291201da799SBarry Smith } 292201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 293201da799SBarry Smith if (opt) { 294201da799SBarry Smith TSMonitorLGCtx ctx; 295201da799SBarry Smith PetscInt howoften = 1; 296201da799SBarry Smith 2970298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2986ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 299201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 300201da799SBarry Smith } 3018189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 3028189c53fSBarry Smith if (opt) { 3038189c53fSBarry Smith TSMonitorSPEigCtx ctx; 3048189c53fSBarry Smith PetscInt howoften = 1; 3058189c53fSBarry Smith 3060298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 3076934998bSLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 3088189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 3098189c53fSBarry Smith } 310ef20d060SBarry Smith opt = PETSC_FALSE; 3110dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 312a7cc72afSBarry Smith if (opt) { 31383a4ac43SBarry Smith TSMonitorDrawCtx ctx; 31483a4ac43SBarry Smith PetscInt howoften = 1; 315a80ad3e0SBarry Smith 3160298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 3176934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 31883a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 319bdad233fSMatthew Knepley } 320fb1732b5SBarry Smith opt = PETSC_FALSE; 3219110b2e7SHong Zhang ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr); 3229110b2e7SHong Zhang if (opt) { 3239110b2e7SHong Zhang TSMonitorDrawCtx ctx; 3249110b2e7SHong Zhang PetscInt howoften = 1; 3259110b2e7SHong Zhang 3269110b2e7SHong Zhang ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr); 3276934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 3289110b2e7SHong Zhang ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3299110b2e7SHong Zhang } 3309110b2e7SHong Zhang opt = PETSC_FALSE; 3312d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 3322d5ee99bSBarry Smith if (opt) { 3332d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 3342d5ee99bSBarry Smith PetscReal bounds[4]; 3352d5ee99bSBarry Smith PetscInt n = 4; 3362d5ee99bSBarry Smith PetscDraw draw; 3376934998bSLisandro Dalcin PetscDrawAxis axis; 3382d5ee99bSBarry Smith 3392d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 3402d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 3416934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 3422d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 3436934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 3446934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 3456934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 3462d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3472d5ee99bSBarry Smith } 3482d5ee99bSBarry Smith opt = PETSC_FALSE; 3490dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 3503a471f94SBarry Smith if (opt) { 35183a4ac43SBarry Smith TSMonitorDrawCtx ctx; 35283a4ac43SBarry Smith PetscInt howoften = 1; 3533a471f94SBarry Smith 3540298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 3556934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 35683a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3573a471f94SBarry Smith } 358fde5950dSBarry Smith 359ed81e22dSJed Brown opt = PETSC_FALSE; 36091b97e58SBarry 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); 361ed81e22dSJed Brown if (flg) { 362ed81e22dSJed Brown const char *ptr,*ptr2; 363ed81e22dSJed Brown char *filetemplate; 364ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 365ed81e22dSJed Brown /* Do some cursory validation of the input. */ 366ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 367ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 368ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 369ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 370ce94432eSBarry 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"); 371ed81e22dSJed Brown if (ptr2) break; 372ed81e22dSJed Brown } 373ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 374ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 375ed81e22dSJed Brown } 376bdad233fSMatthew Knepley 377d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 378d1212d36SBarry Smith if (flg) { 379d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 380d1212d36SBarry Smith int ray = 0; 381d1212d36SBarry Smith DMDADirection ddir; 382d1212d36SBarry Smith DM da; 383d1212d36SBarry Smith PetscMPIInt rank; 384d1212d36SBarry Smith 385ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 386d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 387d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 388ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 389d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 390d1212d36SBarry Smith 391d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 392b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 393d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 394d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 395ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 396d1212d36SBarry Smith if (!rank) { 397d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 398d1212d36SBarry Smith } 39951b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 400d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 401d1212d36SBarry Smith } 40251b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 40351b4a12fSMatthew G. Knepley if (flg) { 40451b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 40551b4a12fSMatthew G. Knepley int ray = 0; 40651b4a12fSMatthew G. Knepley DMDADirection ddir; 40751b4a12fSMatthew G. Knepley DM da; 40851b4a12fSMatthew G. Knepley PetscInt howoften = 1; 409d1212d36SBarry Smith 41051b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 41151b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 41251b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 41351b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 41451b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 4151c3436cfSJed Brown 41651b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 417b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 41851b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 41951b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 42051b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 42151b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 42251b4a12fSMatthew G. Knepley } 423a7a1495cSBarry Smith 424b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 425b3d3934dSBarry Smith if (opt) { 426b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 427b3d3934dSBarry Smith 428b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 429b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 430b3d3934dSBarry Smith } 431b3d3934dSBarry Smith 432847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 433847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 434847ff0e1SMatthew G. Knepley if (flg) { 435847ff0e1SMatthew G. Knepley DM dm; 436847ff0e1SMatthew G. Knepley DMTS tdm; 437847ff0e1SMatthew G. Knepley 438847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 439847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 440847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 441847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 442847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 443847ff0e1SMatthew G. Knepley } 444847ff0e1SMatthew G. Knepley 445d763cef2SBarry Smith /* Handle specific TS options */ 446d763cef2SBarry Smith if (ts->ops->setfromoptions) { 4476991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 448d763cef2SBarry Smith } 449fbc52257SHong Zhang 450a7bdc993SLisandro Dalcin /* Handle TSAdapt options */ 451a7bdc993SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 452a7bdc993SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 453a7bdc993SLisandro Dalcin ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 454a7bdc993SLisandro Dalcin 45568bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 4564f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 45768bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 45868bece0bSHong Zhang if (tflg) { 45968bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 46068bece0bSHong Zhang } 4614f122a70SLisandro Dalcin tflg = ts->adjoint_solve ? PETSC_TRUE : PETSC_FALSE; 46268bece0bSHong Zhang ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr); 46368bece0bSHong Zhang if (flg) { 46468bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 46568bece0bSHong Zhang ts->adjoint_solve = tflg; 46668bece0bSHong Zhang } 467d763cef2SBarry Smith 468d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4690633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 470fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 471d763cef2SBarry Smith 4724f122a70SLisandro Dalcin if (ts->trajectory) { 4734f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 474d763cef2SBarry Smith } 47568bece0bSHong Zhang 4764f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4774f122a70SLisandro Dalcin if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);} 4784f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 479d763cef2SBarry Smith PetscFunctionReturn(0); 480d763cef2SBarry Smith } 481d763cef2SBarry Smith 482d2daff3dSHong Zhang /*@ 48378fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 48478fbdcc8SBarry Smith 48578fbdcc8SBarry Smith Collective on TS 48678fbdcc8SBarry Smith 48778fbdcc8SBarry Smith Input Parameters: 48878fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 48978fbdcc8SBarry Smith 49078fbdcc8SBarry Smith Output Parameters; 49178fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 49278fbdcc8SBarry Smith 49378fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 49478fbdcc8SBarry Smith 49578fbdcc8SBarry Smith Level: advanced 49678fbdcc8SBarry Smith 49778fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 49878fbdcc8SBarry Smith 49978fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 50078fbdcc8SBarry Smith @*/ 50178fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 50278fbdcc8SBarry Smith { 50378fbdcc8SBarry Smith PetscFunctionBegin; 50478fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 50578fbdcc8SBarry Smith *tr = ts->trajectory; 50678fbdcc8SBarry Smith PetscFunctionReturn(0); 50778fbdcc8SBarry Smith } 50878fbdcc8SBarry Smith 50978fbdcc8SBarry Smith /*@ 510bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 511d2daff3dSHong Zhang 512d2daff3dSHong Zhang Collective on TS 513d2daff3dSHong Zhang 514d2daff3dSHong Zhang Input Parameters: 515bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 516bc952696SBarry Smith 51778fbdcc8SBarry Smith Options Database: 51878fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 51978fbdcc8SBarry Smith - -ts_trajectory_type type 52078fbdcc8SBarry Smith 52168bece0bSHong Zhang Note: This routine should be called after all TS options have been set 522d2daff3dSHong Zhang 52378fbdcc8SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/bin/PetscBinaryIOTrajectory.py and 52478fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 52578fbdcc8SBarry Smith 526d2daff3dSHong Zhang Level: intermediate 527d2daff3dSHong Zhang 52878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType() 529d2daff3dSHong Zhang 530bc952696SBarry Smith .keywords: TS, set, checkpoint, 531d2daff3dSHong Zhang @*/ 532bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 533d2daff3dSHong Zhang { 534bc952696SBarry Smith PetscErrorCode ierr; 535bc952696SBarry Smith 536d2daff3dSHong Zhang PetscFunctionBegin; 537d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 538bc952696SBarry Smith if (!ts->trajectory) { 539bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 540972caf09SHong Zhang ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 541bc952696SBarry Smith } 542d2daff3dSHong Zhang PetscFunctionReturn(0); 543d2daff3dSHong Zhang } 544d2daff3dSHong Zhang 545a7a1495cSBarry Smith /*@ 546a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 547a7a1495cSBarry Smith set with TSSetRHSJacobian(). 548a7a1495cSBarry Smith 549a7a1495cSBarry Smith Collective on TS and Vec 550a7a1495cSBarry Smith 551a7a1495cSBarry Smith Input Parameters: 552316643e7SJed Brown + ts - the TS context 553a7a1495cSBarry Smith . t - current timestep 5540910c330SBarry Smith - U - input vector 555a7a1495cSBarry Smith 556a7a1495cSBarry Smith Output Parameters: 557a7a1495cSBarry Smith + A - Jacobian matrix 558a7a1495cSBarry Smith . B - optional preconditioning matrix 559a7a1495cSBarry Smith - flag - flag indicating matrix structure 560a7a1495cSBarry Smith 561a7a1495cSBarry Smith Notes: 562a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 563a7a1495cSBarry Smith is used internally within the nonlinear solvers. 564a7a1495cSBarry Smith 56594b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 566a7a1495cSBarry Smith flag parameter. 567a7a1495cSBarry Smith 568a7a1495cSBarry Smith Level: developer 569a7a1495cSBarry Smith 570a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 571a7a1495cSBarry Smith 57294b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 573a7a1495cSBarry Smith @*/ 574d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 575a7a1495cSBarry Smith { 576dfbe8321SBarry Smith PetscErrorCode ierr; 577270bf2e7SJed Brown PetscObjectState Ustate; 5786c1e1eecSBarry Smith PetscObjectId Uid; 57924989b8cSPeter Brune DM dm; 580942e3340SBarry Smith DMTS tsdm; 58124989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 58224989b8cSPeter Brune void *ctx; 58324989b8cSPeter Brune TSIJacobian ijacobianfunc; 584b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 585a7a1495cSBarry Smith 586a7a1495cSBarry Smith PetscFunctionBegin; 5870700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5880910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5890910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 59024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 591942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 59224989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 5930298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 594b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 59559e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 5966c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 5976c1e1eecSBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 5980e4ef248SJed Brown PetscFunctionReturn(0); 599f8ede8e7SJed Brown } 600d90be118SSean Farley 601ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 602d90be118SSean Farley 603e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 60494ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 60594ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 60694ab13aaSBarry Smith if (A != B) { 60794ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 60894ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 609e1244c69SJed Brown } 610e1244c69SJed Brown ts->rhsjacobian.shift = 0; 611e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 612e1244c69SJed Brown } 613e1244c69SJed Brown 61424989b8cSPeter Brune if (rhsjacobianfunc) { 6156cd88445SBarry Smith PetscBool missing; 61694ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 617a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 618d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 619a7a1495cSBarry Smith PetscStackPop; 62094ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 6216cd88445SBarry Smith if (A) { 6226cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 6236cd88445SBarry 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"); 6246cd88445SBarry Smith } 6256cd88445SBarry Smith if (B && B != A) { 6266cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 6276cd88445SBarry 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"); 6286cd88445SBarry Smith } 629ef66eb69SBarry Smith } else { 63094ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 63194ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 632ef66eb69SBarry Smith } 6330e4ef248SJed Brown ts->rhsjacobian.time = t; 6347f79407eSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr); 63559e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 636a7a1495cSBarry Smith PetscFunctionReturn(0); 637a7a1495cSBarry Smith } 638a7a1495cSBarry Smith 639316643e7SJed Brown /*@ 640d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 641d763cef2SBarry Smith 642316643e7SJed Brown Collective on TS and Vec 643316643e7SJed Brown 644316643e7SJed Brown Input Parameters: 645316643e7SJed Brown + ts - the TS context 646316643e7SJed Brown . t - current time 6470910c330SBarry Smith - U - state vector 648316643e7SJed Brown 649316643e7SJed Brown Output Parameter: 650316643e7SJed Brown . y - right hand side 651316643e7SJed Brown 652316643e7SJed Brown Note: 653316643e7SJed Brown Most users should not need to explicitly call this routine, as it 654316643e7SJed Brown is used internally within the nonlinear solvers. 655316643e7SJed Brown 656316643e7SJed Brown Level: developer 657316643e7SJed Brown 658316643e7SJed Brown .keywords: TS, compute 659316643e7SJed Brown 660316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 661316643e7SJed Brown @*/ 6620910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 663d763cef2SBarry Smith { 664dfbe8321SBarry Smith PetscErrorCode ierr; 66524989b8cSPeter Brune TSRHSFunction rhsfunction; 66624989b8cSPeter Brune TSIFunction ifunction; 66724989b8cSPeter Brune void *ctx; 66824989b8cSPeter Brune DM dm; 66924989b8cSPeter Brune 670d763cef2SBarry Smith PetscFunctionBegin; 6710700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6720910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6730700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 67424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 67524989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6760298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 677d763cef2SBarry Smith 678ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 679d763cef2SBarry Smith 6800910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 68124989b8cSPeter Brune if (rhsfunction) { 682d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6830910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 684d763cef2SBarry Smith PetscStackPop; 685214bc6a2SJed Brown } else { 686214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 687b2cd27e8SJed Brown } 68844a41b28SSean Farley 6890910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 690d763cef2SBarry Smith PetscFunctionReturn(0); 691d763cef2SBarry Smith } 692d763cef2SBarry Smith 693ef20d060SBarry Smith /*@ 694ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 695ef20d060SBarry Smith 696ef20d060SBarry Smith Collective on TS and Vec 697ef20d060SBarry Smith 698ef20d060SBarry Smith Input Parameters: 699ef20d060SBarry Smith + ts - the TS context 700ef20d060SBarry Smith - t - current time 701ef20d060SBarry Smith 702ef20d060SBarry Smith Output Parameter: 7030910c330SBarry Smith . U - the solution 704ef20d060SBarry Smith 705ef20d060SBarry Smith Note: 706ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 707ef20d060SBarry Smith is used internally within the nonlinear solvers. 708ef20d060SBarry Smith 709ef20d060SBarry Smith Level: developer 710ef20d060SBarry Smith 711ef20d060SBarry Smith .keywords: TS, compute 712ef20d060SBarry Smith 713abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 714ef20d060SBarry Smith @*/ 7150910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 716ef20d060SBarry Smith { 717ef20d060SBarry Smith PetscErrorCode ierr; 718ef20d060SBarry Smith TSSolutionFunction solutionfunction; 719ef20d060SBarry Smith void *ctx; 720ef20d060SBarry Smith DM dm; 721ef20d060SBarry Smith 722ef20d060SBarry Smith PetscFunctionBegin; 723ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7240910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 725ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 726ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 727ef20d060SBarry Smith 728ef20d060SBarry Smith if (solutionfunction) { 7299b7cd975SBarry Smith PetscStackPush("TS user solution function"); 7300910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 731ef20d060SBarry Smith PetscStackPop; 732ef20d060SBarry Smith } 733ef20d060SBarry Smith PetscFunctionReturn(0); 734ef20d060SBarry Smith } 7359b7cd975SBarry Smith /*@ 7369b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 7379b7cd975SBarry Smith 7389b7cd975SBarry Smith Collective on TS and Vec 7399b7cd975SBarry Smith 7409b7cd975SBarry Smith Input Parameters: 7419b7cd975SBarry Smith + ts - the TS context 7429b7cd975SBarry Smith - t - current time 7439b7cd975SBarry Smith 7449b7cd975SBarry Smith Output Parameter: 7459b7cd975SBarry Smith . U - the function value 7469b7cd975SBarry Smith 7479b7cd975SBarry Smith Note: 7489b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 7499b7cd975SBarry Smith is used internally within the nonlinear solvers. 7509b7cd975SBarry Smith 7519b7cd975SBarry Smith Level: developer 7529b7cd975SBarry Smith 7539b7cd975SBarry Smith .keywords: TS, compute 7549b7cd975SBarry Smith 7559b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 7569b7cd975SBarry Smith @*/ 7579b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 7589b7cd975SBarry Smith { 7599b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 7609b7cd975SBarry Smith void *ctx; 7619b7cd975SBarry Smith DM dm; 7629b7cd975SBarry Smith 7639b7cd975SBarry Smith PetscFunctionBegin; 7649b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7659b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7669b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7679b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7689b7cd975SBarry Smith 7699b7cd975SBarry Smith if (forcing) { 7709b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7719b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7729b7cd975SBarry Smith PetscStackPop; 7739b7cd975SBarry Smith } 7749b7cd975SBarry Smith PetscFunctionReturn(0); 7759b7cd975SBarry Smith } 776ef20d060SBarry Smith 777214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 778214bc6a2SJed Brown { 7792dd45cf8SJed Brown Vec F; 780214bc6a2SJed Brown PetscErrorCode ierr; 781214bc6a2SJed Brown 782214bc6a2SJed Brown PetscFunctionBegin; 7830298fd71SBarry Smith *Frhs = NULL; 7840298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 785214bc6a2SJed Brown if (!ts->Frhs) { 7862dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 787214bc6a2SJed Brown } 788214bc6a2SJed Brown *Frhs = ts->Frhs; 789214bc6a2SJed Brown PetscFunctionReturn(0); 790214bc6a2SJed Brown } 791214bc6a2SJed Brown 792214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 793214bc6a2SJed Brown { 794214bc6a2SJed Brown Mat A,B; 7952dd45cf8SJed Brown PetscErrorCode ierr; 79641a1d4d2SBarry Smith TSIJacobian ijacobian; 797214bc6a2SJed Brown 798214bc6a2SJed Brown PetscFunctionBegin; 799c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 800c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 80141a1d4d2SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 802214bc6a2SJed Brown if (Arhs) { 803214bc6a2SJed Brown if (!ts->Arhs) { 80441a1d4d2SBarry Smith if (ijacobian) { 805214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 80641a1d4d2SBarry Smith } else { 80741a1d4d2SBarry Smith ts->Arhs = A; 80841a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 80941a1d4d2SBarry Smith } 8103565c898SBarry Smith } else { 8113565c898SBarry Smith PetscBool flg; 8123565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 8133565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 8143565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 8153565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 8163565c898SBarry Smith ts->Arhs = A; 8173565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 8183565c898SBarry Smith } 819214bc6a2SJed Brown } 820214bc6a2SJed Brown *Arhs = ts->Arhs; 821214bc6a2SJed Brown } 822214bc6a2SJed Brown if (Brhs) { 823214bc6a2SJed Brown if (!ts->Brhs) { 824bdb70873SJed Brown if (A != B) { 82541a1d4d2SBarry Smith if (ijacobian) { 826214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 827bdb70873SJed Brown } else { 82841a1d4d2SBarry Smith ts->Brhs = B; 82941a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 83041a1d4d2SBarry Smith } 83141a1d4d2SBarry Smith } else { 832bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 83351699248SLisandro Dalcin ts->Brhs = ts->Arhs; 834bdb70873SJed Brown } 835214bc6a2SJed Brown } 836214bc6a2SJed Brown *Brhs = ts->Brhs; 837214bc6a2SJed Brown } 838214bc6a2SJed Brown PetscFunctionReturn(0); 839214bc6a2SJed Brown } 840214bc6a2SJed Brown 841316643e7SJed Brown /*@ 8420910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 843316643e7SJed Brown 844316643e7SJed Brown Collective on TS and Vec 845316643e7SJed Brown 846316643e7SJed Brown Input Parameters: 847316643e7SJed Brown + ts - the TS context 848316643e7SJed Brown . t - current time 8490910c330SBarry Smith . U - state vector 8500910c330SBarry Smith . Udot - time derivative of state vector 851214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 852316643e7SJed Brown 853316643e7SJed Brown Output Parameter: 854316643e7SJed Brown . Y - right hand side 855316643e7SJed Brown 856316643e7SJed Brown Note: 857316643e7SJed Brown Most users should not need to explicitly call this routine, as it 858316643e7SJed Brown is used internally within the nonlinear solvers. 859316643e7SJed Brown 860316643e7SJed Brown If the user did did not write their equations in implicit form, this 861316643e7SJed Brown function recasts them in implicit form. 862316643e7SJed Brown 863316643e7SJed Brown Level: developer 864316643e7SJed Brown 865316643e7SJed Brown .keywords: TS, compute 866316643e7SJed Brown 867316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 868316643e7SJed Brown @*/ 8690910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 870316643e7SJed Brown { 871316643e7SJed Brown PetscErrorCode ierr; 87224989b8cSPeter Brune TSIFunction ifunction; 87324989b8cSPeter Brune TSRHSFunction rhsfunction; 87424989b8cSPeter Brune void *ctx; 87524989b8cSPeter Brune DM dm; 876316643e7SJed Brown 877316643e7SJed Brown PetscFunctionBegin; 8780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8790910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8800910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8810700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 882316643e7SJed Brown 88324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 88424989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8850298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 88624989b8cSPeter Brune 887ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 888d90be118SSean Farley 8890910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 89024989b8cSPeter Brune if (ifunction) { 891316643e7SJed Brown PetscStackPush("TS user implicit function"); 8920910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 893316643e7SJed Brown PetscStackPop; 894214bc6a2SJed Brown } 895214bc6a2SJed Brown if (imex) { 89624989b8cSPeter Brune if (!ifunction) { 8970910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8982dd45cf8SJed Brown } 89924989b8cSPeter Brune } else if (rhsfunction) { 90024989b8cSPeter Brune if (ifunction) { 901214bc6a2SJed Brown Vec Frhs; 902214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 9030910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 904214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 9052dd45cf8SJed Brown } else { 9060910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 9070910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 908316643e7SJed Brown } 9094a6899ffSJed Brown } 9100910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 911316643e7SJed Brown PetscFunctionReturn(0); 912316643e7SJed Brown } 913316643e7SJed Brown 914316643e7SJed Brown /*@ 915316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 916316643e7SJed Brown 917316643e7SJed Brown Collective on TS and Vec 918316643e7SJed Brown 919316643e7SJed Brown Input 920316643e7SJed Brown Input Parameters: 921316643e7SJed Brown + ts - the TS context 922316643e7SJed Brown . t - current timestep 9230910c330SBarry Smith . U - state vector 9240910c330SBarry Smith . Udot - time derivative of state vector 925214bc6a2SJed Brown . shift - shift to apply, see note below 926214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 927316643e7SJed Brown 928316643e7SJed Brown Output Parameters: 929316643e7SJed Brown + A - Jacobian matrix 9303565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 931316643e7SJed Brown 932316643e7SJed Brown Notes: 9330910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 934316643e7SJed Brown 9350910c330SBarry Smith dF/dU + shift*dF/dUdot 936316643e7SJed Brown 937316643e7SJed Brown Most users should not need to explicitly call this routine, as it 938316643e7SJed Brown is used internally within the nonlinear solvers. 939316643e7SJed Brown 940316643e7SJed Brown Level: developer 941316643e7SJed Brown 942316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 943316643e7SJed Brown 944316643e7SJed Brown .seealso: TSSetIJacobian() 94563495f91SJed Brown @*/ 946d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 947316643e7SJed Brown { 948316643e7SJed Brown PetscErrorCode ierr; 94924989b8cSPeter Brune TSIJacobian ijacobian; 95024989b8cSPeter Brune TSRHSJacobian rhsjacobian; 95124989b8cSPeter Brune DM dm; 95224989b8cSPeter Brune void *ctx; 953316643e7SJed Brown 954316643e7SJed Brown PetscFunctionBegin; 9550700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9560910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9570910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 958316643e7SJed Brown PetscValidPointer(A,6); 95994ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 960316643e7SJed Brown PetscValidPointer(B,7); 96194ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 96224989b8cSPeter Brune 96324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 96424989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9650298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 96624989b8cSPeter Brune 967ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 968316643e7SJed Brown 96994ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 97024989b8cSPeter Brune if (ijacobian) { 9716cd88445SBarry Smith PetscBool missing; 972316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 973d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 974316643e7SJed Brown PetscStackPop; 9756cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9766cd88445SBarry 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"); 9773565c898SBarry Smith if (B != A) { 9786cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9796cd88445SBarry 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"); 9806cd88445SBarry Smith } 9814a6899ffSJed Brown } 982214bc6a2SJed Brown if (imex) { 983b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9844c26be97Sstefano_zampini PetscBool assembled; 98594ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9864c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9874c26be97Sstefano_zampini if (!assembled) { 9884c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9894c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9904c26be97Sstefano_zampini } 99194ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 99294ab13aaSBarry Smith if (A != B) { 99394ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9944c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9954c26be97Sstefano_zampini if (!assembled) { 9964c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9974c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9984c26be97Sstefano_zampini } 99994ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1000214bc6a2SJed Brown } 1001214bc6a2SJed Brown } 1002214bc6a2SJed Brown } else { 1003e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 1004e1244c69SJed Brown if (rhsjacobian) { 1005214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 1006d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 1007e1244c69SJed Brown } 100894ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 10093565c898SBarry Smith PetscBool flg; 1010e1244c69SJed Brown ts->rhsjacobian.scale = -1; 1011e1244c69SJed Brown ts->rhsjacobian.shift = shift; 10123565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 10133565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 10143565c898SBarry Smith if (!flg) { 101594ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 101694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 10173565c898SBarry Smith } 101894ab13aaSBarry Smith if (A != B) { 101994ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 102094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1021316643e7SJed Brown } 1022e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 1023e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1024e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 102594ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 102694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 102794ab13aaSBarry Smith if (A != B) { 102894ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 102994ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1030214bc6a2SJed Brown } 1031316643e7SJed Brown } 103294ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 103394ab13aaSBarry Smith if (A != B) { 103494ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 1035316643e7SJed Brown } 1036316643e7SJed Brown } 1037316643e7SJed Brown } 103894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 1039316643e7SJed Brown PetscFunctionReturn(0); 1040316643e7SJed Brown } 1041316643e7SJed Brown 1042d763cef2SBarry Smith /*@C 1043d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1044b5abc632SBarry Smith where U_t = G(t,u). 1045d763cef2SBarry Smith 10463f9fe445SBarry Smith Logically Collective on TS 1047d763cef2SBarry Smith 1048d763cef2SBarry Smith Input Parameters: 1049d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10500298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1051d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1052d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10530298fd71SBarry Smith function evaluation routine (may be NULL) 1054d763cef2SBarry Smith 1055d763cef2SBarry Smith Calling sequence of func: 105687828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1057d763cef2SBarry Smith 1058d763cef2SBarry Smith + t - current timestep 1059d763cef2SBarry Smith . u - input vector 1060d763cef2SBarry Smith . F - function vector 1061d763cef2SBarry Smith - ctx - [optional] user-defined function context 1062d763cef2SBarry Smith 1063d763cef2SBarry Smith Level: beginner 1064d763cef2SBarry Smith 10652bbac0d3SBarry Smith Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10662bbac0d3SBarry Smith 1067d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1068d763cef2SBarry Smith 1069ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1070d763cef2SBarry Smith @*/ 1071089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1072d763cef2SBarry Smith { 1073089b2837SJed Brown PetscErrorCode ierr; 1074089b2837SJed Brown SNES snes; 10750298fd71SBarry Smith Vec ralloc = NULL; 107624989b8cSPeter Brune DM dm; 1077d763cef2SBarry Smith 1078089b2837SJed Brown PetscFunctionBegin; 10790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1080ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 108124989b8cSPeter Brune 108224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 108324989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1084089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1085e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1086e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1087e856ceecSJed Brown r = ralloc; 1088e856ceecSJed Brown } 1089089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1090e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1091d763cef2SBarry Smith PetscFunctionReturn(0); 1092d763cef2SBarry Smith } 1093d763cef2SBarry Smith 1094ef20d060SBarry Smith /*@C 1095abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1096ef20d060SBarry Smith 1097ef20d060SBarry Smith Logically Collective on TS 1098ef20d060SBarry Smith 1099ef20d060SBarry Smith Input Parameters: 1100ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1101ef20d060SBarry Smith . f - routine for evaluating the solution 1102ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 11030298fd71SBarry Smith function evaluation routine (may be NULL) 1104ef20d060SBarry Smith 1105ef20d060SBarry Smith Calling sequence of func: 1106ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1107ef20d060SBarry Smith 1108ef20d060SBarry Smith + t - current timestep 1109ef20d060SBarry Smith . u - output vector 1110ef20d060SBarry Smith - ctx - [optional] user-defined function context 1111ef20d060SBarry Smith 1112abd5a294SJed Brown Notes: 1113abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1114abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1115abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1116abd5a294SJed Brown 11174f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1118abd5a294SJed Brown 1119ef20d060SBarry Smith Level: beginner 1120ef20d060SBarry Smith 1121ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1122ef20d060SBarry Smith 11239b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction() 1124ef20d060SBarry Smith @*/ 1125ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1126ef20d060SBarry Smith { 1127ef20d060SBarry Smith PetscErrorCode ierr; 1128ef20d060SBarry Smith DM dm; 1129ef20d060SBarry Smith 1130ef20d060SBarry Smith PetscFunctionBegin; 1131ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1132ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1133ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1134ef20d060SBarry Smith PetscFunctionReturn(0); 1135ef20d060SBarry Smith } 1136ef20d060SBarry Smith 11379b7cd975SBarry Smith /*@C 11389b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 11399b7cd975SBarry Smith 11409b7cd975SBarry Smith Logically Collective on TS 11419b7cd975SBarry Smith 11429b7cd975SBarry Smith Input Parameters: 11439b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1144e162b725SBarry Smith . func - routine for evaluating the forcing function 11459b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11460298fd71SBarry Smith function evaluation routine (may be NULL) 11479b7cd975SBarry Smith 11489b7cd975SBarry Smith Calling sequence of func: 1149e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 11509b7cd975SBarry Smith 11519b7cd975SBarry Smith + t - current timestep 1152e162b725SBarry Smith . f - output vector 11539b7cd975SBarry Smith - ctx - [optional] user-defined function context 11549b7cd975SBarry Smith 11559b7cd975SBarry Smith Notes: 11569b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1157e162b725SBarry 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 1158e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1159e162b725SBarry Smith 1160e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1161e162b725SBarry Smith 1162e162b725SBarry 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 1163e162b725SBarry Smith parameters can be passed in the ctx variable. 11649b7cd975SBarry Smith 11659b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11669b7cd975SBarry Smith 11679b7cd975SBarry Smith Level: beginner 11689b7cd975SBarry Smith 11699b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11709b7cd975SBarry Smith 11719b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11729b7cd975SBarry Smith @*/ 1173e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11749b7cd975SBarry Smith { 11759b7cd975SBarry Smith PetscErrorCode ierr; 11769b7cd975SBarry Smith DM dm; 11779b7cd975SBarry Smith 11789b7cd975SBarry Smith PetscFunctionBegin; 11799b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11809b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1181e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11829b7cd975SBarry Smith PetscFunctionReturn(0); 11839b7cd975SBarry Smith } 11849b7cd975SBarry Smith 1185d763cef2SBarry Smith /*@C 1186f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1187b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1188d763cef2SBarry Smith 11893f9fe445SBarry Smith Logically Collective on TS 1190d763cef2SBarry Smith 1191d763cef2SBarry Smith Input Parameters: 1192d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1193e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1194e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1195d763cef2SBarry Smith . f - the Jacobian evaluation routine 1196d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11970298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1198d763cef2SBarry Smith 1199f7ab8db6SBarry Smith Calling sequence of f: 1200ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1201d763cef2SBarry Smith 1202d763cef2SBarry Smith + t - current timestep 1203d763cef2SBarry Smith . u - input vector 1204e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1205e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1206d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1207d763cef2SBarry Smith 12086cd88445SBarry Smith Notes: 12096cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 12106cd88445SBarry Smith 12116cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1212ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1213d763cef2SBarry Smith 1214d763cef2SBarry Smith Level: beginner 1215d763cef2SBarry Smith 1216d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1217d763cef2SBarry Smith 1218ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1219d763cef2SBarry Smith 1220d763cef2SBarry Smith @*/ 1221e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1222d763cef2SBarry Smith { 1223277b19d0SLisandro Dalcin PetscErrorCode ierr; 1224089b2837SJed Brown SNES snes; 122524989b8cSPeter Brune DM dm; 122624989b8cSPeter Brune TSIJacobian ijacobian; 1227277b19d0SLisandro Dalcin 1228d763cef2SBarry Smith PetscFunctionBegin; 12290700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1230e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1231e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1232e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1233e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1234d763cef2SBarry Smith 123524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 123624989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1237e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1238e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1239e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1240e1244c69SJed Brown } 12410298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1242089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12435f659677SPeter Brune if (!ijacobian) { 1244e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12450e4ef248SJed Brown } 1246e5d3d808SBarry Smith if (Amat) { 1247e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12480e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1249e5d3d808SBarry Smith ts->Arhs = Amat; 12500e4ef248SJed Brown } 1251e5d3d808SBarry Smith if (Pmat) { 1252e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12530e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1254e5d3d808SBarry Smith ts->Brhs = Pmat; 12550e4ef248SJed Brown } 1256d763cef2SBarry Smith PetscFunctionReturn(0); 1257d763cef2SBarry Smith } 1258d763cef2SBarry Smith 1259316643e7SJed Brown /*@C 1260b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1261316643e7SJed Brown 12623f9fe445SBarry Smith Logically Collective on TS 1263316643e7SJed Brown 1264316643e7SJed Brown Input Parameters: 1265316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12660298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1267316643e7SJed Brown . f - the function evaluation routine 12680298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1269316643e7SJed Brown 1270316643e7SJed Brown Calling sequence of f: 1271316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1272316643e7SJed Brown 1273316643e7SJed Brown + t - time at step/stage being solved 1274316643e7SJed Brown . u - state vector 1275316643e7SJed Brown . u_t - time derivative of state vector 1276316643e7SJed Brown . F - function vector 1277316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1278316643e7SJed Brown 1279316643e7SJed Brown Important: 12802bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1281316643e7SJed Brown 1282316643e7SJed Brown Level: beginner 1283316643e7SJed Brown 1284316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1285316643e7SJed Brown 1286d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1287316643e7SJed Brown @*/ 128851699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1289316643e7SJed Brown { 1290089b2837SJed Brown PetscErrorCode ierr; 1291089b2837SJed Brown SNES snes; 129251699248SLisandro Dalcin Vec ralloc = NULL; 129324989b8cSPeter Brune DM dm; 1294316643e7SJed Brown 1295316643e7SJed Brown PetscFunctionBegin; 12960700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 129751699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 129824989b8cSPeter Brune 129924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 130024989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 130124989b8cSPeter Brune 1302089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 130351699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 130451699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 130551699248SLisandro Dalcin r = ralloc; 1306e856ceecSJed Brown } 130751699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 130851699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1309089b2837SJed Brown PetscFunctionReturn(0); 1310089b2837SJed Brown } 1311089b2837SJed Brown 1312089b2837SJed Brown /*@C 1313089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1314089b2837SJed Brown 1315089b2837SJed Brown Not Collective 1316089b2837SJed Brown 1317089b2837SJed Brown Input Parameter: 1318089b2837SJed Brown . ts - the TS context 1319089b2837SJed Brown 1320089b2837SJed Brown Output Parameter: 13210298fd71SBarry Smith + r - vector to hold residual (or NULL) 13220298fd71SBarry Smith . func - the function to compute residual (or NULL) 13230298fd71SBarry Smith - ctx - the function context (or NULL) 1324089b2837SJed Brown 1325089b2837SJed Brown Level: advanced 1326089b2837SJed Brown 1327089b2837SJed Brown .keywords: TS, nonlinear, get, function 1328089b2837SJed Brown 1329089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1330089b2837SJed Brown @*/ 1331089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1332089b2837SJed Brown { 1333089b2837SJed Brown PetscErrorCode ierr; 1334089b2837SJed Brown SNES snes; 133524989b8cSPeter Brune DM dm; 1336089b2837SJed Brown 1337089b2837SJed Brown PetscFunctionBegin; 1338089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1339089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13400298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 134124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 134224989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1343089b2837SJed Brown PetscFunctionReturn(0); 1344089b2837SJed Brown } 1345089b2837SJed Brown 1346089b2837SJed Brown /*@C 1347089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1348089b2837SJed Brown 1349089b2837SJed Brown Not Collective 1350089b2837SJed Brown 1351089b2837SJed Brown Input Parameter: 1352089b2837SJed Brown . ts - the TS context 1353089b2837SJed Brown 1354089b2837SJed Brown Output Parameter: 13550298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13560298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13570298fd71SBarry Smith - ctx - the function context (or NULL) 1358089b2837SJed Brown 1359089b2837SJed Brown Level: advanced 1360089b2837SJed Brown 1361089b2837SJed Brown .keywords: TS, nonlinear, get, function 1362089b2837SJed Brown 13632bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1364089b2837SJed Brown @*/ 1365089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1366089b2837SJed Brown { 1367089b2837SJed Brown PetscErrorCode ierr; 1368089b2837SJed Brown SNES snes; 136924989b8cSPeter Brune DM dm; 1370089b2837SJed Brown 1371089b2837SJed Brown PetscFunctionBegin; 1372089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1373089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13740298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 137524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 137624989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1377316643e7SJed Brown PetscFunctionReturn(0); 1378316643e7SJed Brown } 1379316643e7SJed Brown 1380316643e7SJed Brown /*@C 1381a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1382ae8867d6SBarry Smith provided with TSSetIFunction(). 1383316643e7SJed Brown 13843f9fe445SBarry Smith Logically Collective on TS 1385316643e7SJed Brown 1386316643e7SJed Brown Input Parameters: 1387316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1388e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1389e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1390316643e7SJed Brown . f - the Jacobian evaluation routine 13910298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1392316643e7SJed Brown 1393316643e7SJed Brown Calling sequence of f: 1394ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1395316643e7SJed Brown 1396316643e7SJed Brown + t - time at step/stage being solved 13971b4a444bSJed Brown . U - state vector 13981b4a444bSJed Brown . U_t - time derivative of state vector 1399316643e7SJed Brown . a - shift 1400e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1401e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1402316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1403316643e7SJed Brown 1404316643e7SJed Brown Notes: 1405e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1406316643e7SJed Brown 1407895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1408895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1409895c21f2SBarry Smith 1410a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1411b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1412a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1413a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1414a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1415a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1416a4f0a591SBarry Smith 14176cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 14186cd88445SBarry Smith 14196cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1420ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1421ca5f011dSBarry Smith 1422316643e7SJed Brown Level: beginner 1423316643e7SJed Brown 1424316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1425316643e7SJed Brown 1426ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1427316643e7SJed Brown 1428316643e7SJed Brown @*/ 1429e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1430316643e7SJed Brown { 1431316643e7SJed Brown PetscErrorCode ierr; 1432089b2837SJed Brown SNES snes; 143324989b8cSPeter Brune DM dm; 1434316643e7SJed Brown 1435316643e7SJed Brown PetscFunctionBegin; 14360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1437e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1438e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1439e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1440e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 144124989b8cSPeter Brune 144224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 144324989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 144424989b8cSPeter Brune 1445089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1446e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1447316643e7SJed Brown PetscFunctionReturn(0); 1448316643e7SJed Brown } 1449316643e7SJed Brown 1450e1244c69SJed Brown /*@ 1451e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1452e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1453e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1454e1244c69SJed Brown not been changed by the TS. 1455e1244c69SJed Brown 1456e1244c69SJed Brown Logically Collective 1457e1244c69SJed Brown 1458e1244c69SJed Brown Input Arguments: 1459e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1460e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1461e1244c69SJed Brown 1462e1244c69SJed Brown Level: intermediate 1463e1244c69SJed Brown 1464e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1465e1244c69SJed Brown @*/ 1466e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1467e1244c69SJed Brown { 1468e1244c69SJed Brown PetscFunctionBegin; 1469e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1470e1244c69SJed Brown PetscFunctionReturn(0); 1471e1244c69SJed Brown } 1472e1244c69SJed Brown 1473efe9872eSLisandro Dalcin /*@C 1474efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1475efe9872eSLisandro Dalcin 1476efe9872eSLisandro Dalcin Logically Collective on TS 1477efe9872eSLisandro Dalcin 1478efe9872eSLisandro Dalcin Input Parameters: 1479efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1480efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1481efe9872eSLisandro Dalcin . fun - the function evaluation routine 1482efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1483efe9872eSLisandro Dalcin 1484efe9872eSLisandro Dalcin Calling sequence of fun: 1485efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1486efe9872eSLisandro Dalcin 1487efe9872eSLisandro Dalcin + t - time at step/stage being solved 1488efe9872eSLisandro Dalcin . U - state vector 1489efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1490efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1491efe9872eSLisandro Dalcin . F - function vector 1492efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1493efe9872eSLisandro Dalcin 1494efe9872eSLisandro Dalcin Level: beginner 1495efe9872eSLisandro Dalcin 1496efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1497efe9872eSLisandro Dalcin 1498efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1499efe9872eSLisandro Dalcin @*/ 1500efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1501efe9872eSLisandro Dalcin { 1502efe9872eSLisandro Dalcin DM dm; 1503efe9872eSLisandro Dalcin PetscErrorCode ierr; 1504efe9872eSLisandro Dalcin 1505efe9872eSLisandro Dalcin PetscFunctionBegin; 1506efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1507efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1508efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1509efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1510efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1511efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1512efe9872eSLisandro Dalcin } 1513efe9872eSLisandro Dalcin 1514efe9872eSLisandro Dalcin /*@C 1515efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1516efe9872eSLisandro Dalcin 1517efe9872eSLisandro Dalcin Not Collective 1518efe9872eSLisandro Dalcin 1519efe9872eSLisandro Dalcin Input Parameter: 1520efe9872eSLisandro Dalcin . ts - the TS context 1521efe9872eSLisandro Dalcin 1522efe9872eSLisandro Dalcin Output Parameter: 1523efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1524efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1525efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1526efe9872eSLisandro Dalcin 1527efe9872eSLisandro Dalcin Level: advanced 1528efe9872eSLisandro Dalcin 1529efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1530efe9872eSLisandro Dalcin 1531efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1532efe9872eSLisandro Dalcin @*/ 1533efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1534efe9872eSLisandro Dalcin { 1535efe9872eSLisandro Dalcin PetscErrorCode ierr; 1536efe9872eSLisandro Dalcin SNES snes; 1537efe9872eSLisandro Dalcin DM dm; 1538efe9872eSLisandro Dalcin 1539efe9872eSLisandro Dalcin PetscFunctionBegin; 1540efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1541efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1542efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1543efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1544efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1545efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1546efe9872eSLisandro Dalcin } 1547efe9872eSLisandro Dalcin 1548efe9872eSLisandro Dalcin /*@C 1549bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1550efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1551efe9872eSLisandro Dalcin 1552efe9872eSLisandro Dalcin Logically Collective on TS 1553efe9872eSLisandro Dalcin 1554efe9872eSLisandro Dalcin Input Parameters: 1555efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1556efe9872eSLisandro Dalcin . J - Jacobian matrix 1557efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1558efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1559efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1560efe9872eSLisandro Dalcin 1561efe9872eSLisandro Dalcin Calling sequence of jac: 1562bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1563efe9872eSLisandro Dalcin 1564efe9872eSLisandro Dalcin + t - time at step/stage being solved 1565efe9872eSLisandro Dalcin . U - state vector 1566efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1567efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1568efe9872eSLisandro Dalcin . v - shift for U_t 1569efe9872eSLisandro Dalcin . a - shift for U_tt 1570efe9872eSLisandro 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 1571efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1572efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1573efe9872eSLisandro Dalcin 1574efe9872eSLisandro Dalcin Notes: 1575efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1576efe9872eSLisandro Dalcin 1577efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1578efe9872eSLisandro 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. 1579efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1580bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1581efe9872eSLisandro Dalcin 1582efe9872eSLisandro Dalcin Level: beginner 1583efe9872eSLisandro Dalcin 1584efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1585efe9872eSLisandro Dalcin 1586efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1587efe9872eSLisandro Dalcin @*/ 1588efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1589efe9872eSLisandro Dalcin { 1590efe9872eSLisandro Dalcin DM dm; 1591efe9872eSLisandro Dalcin PetscErrorCode ierr; 1592efe9872eSLisandro Dalcin 1593efe9872eSLisandro Dalcin PetscFunctionBegin; 1594efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1595efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1596efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1597efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1598efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1599efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1600efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1601efe9872eSLisandro Dalcin } 1602efe9872eSLisandro Dalcin 1603efe9872eSLisandro Dalcin /*@C 1604efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1605efe9872eSLisandro Dalcin 1606efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1607efe9872eSLisandro Dalcin 1608efe9872eSLisandro Dalcin Input Parameter: 1609efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1610efe9872eSLisandro Dalcin 1611efe9872eSLisandro Dalcin Output Parameters: 1612efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1613efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1614efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1615efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1616efe9872eSLisandro Dalcin 1617efe9872eSLisandro Dalcin Notes: You can pass in NULL for any return argument you do not need. 1618efe9872eSLisandro Dalcin 1619efe9872eSLisandro Dalcin Level: advanced 1620efe9872eSLisandro Dalcin 1621*80275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 1622efe9872eSLisandro Dalcin 1623efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1624efe9872eSLisandro Dalcin @*/ 1625efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1626efe9872eSLisandro Dalcin { 1627efe9872eSLisandro Dalcin PetscErrorCode ierr; 1628efe9872eSLisandro Dalcin SNES snes; 1629efe9872eSLisandro Dalcin DM dm; 1630efe9872eSLisandro Dalcin 1631efe9872eSLisandro Dalcin PetscFunctionBegin; 1632efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1633efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1634efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1635efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1636efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1637efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1638efe9872eSLisandro Dalcin } 1639efe9872eSLisandro Dalcin 1640efe9872eSLisandro Dalcin /*@ 1641efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1642efe9872eSLisandro Dalcin 1643efe9872eSLisandro Dalcin Collective on TS and Vec 1644efe9872eSLisandro Dalcin 1645efe9872eSLisandro Dalcin Input Parameters: 1646efe9872eSLisandro Dalcin + ts - the TS context 1647efe9872eSLisandro Dalcin . t - current time 1648efe9872eSLisandro Dalcin . U - state vector 1649efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1650efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1651efe9872eSLisandro Dalcin 1652efe9872eSLisandro Dalcin Output Parameter: 1653efe9872eSLisandro Dalcin . F - the residual vector 1654efe9872eSLisandro Dalcin 1655efe9872eSLisandro Dalcin Note: 1656efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1657efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1658efe9872eSLisandro Dalcin 1659efe9872eSLisandro Dalcin Level: developer 1660efe9872eSLisandro Dalcin 1661efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1662efe9872eSLisandro Dalcin 1663efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1664efe9872eSLisandro Dalcin @*/ 1665efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1666efe9872eSLisandro Dalcin { 1667efe9872eSLisandro Dalcin DM dm; 1668efe9872eSLisandro Dalcin TSI2Function I2Function; 1669efe9872eSLisandro Dalcin void *ctx; 1670efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1671efe9872eSLisandro Dalcin PetscErrorCode ierr; 1672efe9872eSLisandro Dalcin 1673efe9872eSLisandro Dalcin PetscFunctionBegin; 1674efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1675efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1676efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1677efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1678efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1679efe9872eSLisandro Dalcin 1680efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1681efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1682efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1683efe9872eSLisandro Dalcin 1684efe9872eSLisandro Dalcin if (!I2Function) { 1685efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1686efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1687efe9872eSLisandro Dalcin } 1688efe9872eSLisandro Dalcin 1689efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1690efe9872eSLisandro Dalcin 1691efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1692efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1693efe9872eSLisandro Dalcin PetscStackPop; 1694efe9872eSLisandro Dalcin 1695efe9872eSLisandro Dalcin if (rhsfunction) { 1696efe9872eSLisandro Dalcin Vec Frhs; 1697efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1698efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1699efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1700efe9872eSLisandro Dalcin } 1701efe9872eSLisandro Dalcin 1702efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1703efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1704efe9872eSLisandro Dalcin } 1705efe9872eSLisandro Dalcin 1706efe9872eSLisandro Dalcin /*@ 1707efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1708efe9872eSLisandro Dalcin 1709efe9872eSLisandro Dalcin Collective on TS and Vec 1710efe9872eSLisandro Dalcin 1711efe9872eSLisandro Dalcin Input Parameters: 1712efe9872eSLisandro Dalcin + ts - the TS context 1713efe9872eSLisandro Dalcin . t - current timestep 1714efe9872eSLisandro Dalcin . U - state vector 1715efe9872eSLisandro Dalcin . V - time derivative of state vector 1716efe9872eSLisandro Dalcin . A - second time derivative of state vector 1717efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1718efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1719efe9872eSLisandro Dalcin 1720efe9872eSLisandro Dalcin Output Parameters: 1721efe9872eSLisandro Dalcin + J - Jacobian matrix 1722efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1723efe9872eSLisandro Dalcin 1724efe9872eSLisandro Dalcin Notes: 1725efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1726efe9872eSLisandro Dalcin 1727efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1728efe9872eSLisandro Dalcin 1729efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1730efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1731efe9872eSLisandro Dalcin 1732efe9872eSLisandro Dalcin Level: developer 1733efe9872eSLisandro Dalcin 1734efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1735efe9872eSLisandro Dalcin 1736efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1737efe9872eSLisandro Dalcin @*/ 1738efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1739efe9872eSLisandro Dalcin { 1740efe9872eSLisandro Dalcin DM dm; 1741efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1742efe9872eSLisandro Dalcin void *ctx; 1743efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1744efe9872eSLisandro Dalcin PetscErrorCode ierr; 1745efe9872eSLisandro Dalcin 1746efe9872eSLisandro Dalcin PetscFunctionBegin; 1747efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1748efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1749efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1750efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1751efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1752efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1753efe9872eSLisandro Dalcin 1754efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1755efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1756efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1757efe9872eSLisandro Dalcin 1758efe9872eSLisandro Dalcin if (!I2Jacobian) { 1759efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1760efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1761efe9872eSLisandro Dalcin } 1762efe9872eSLisandro Dalcin 1763efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1764efe9872eSLisandro Dalcin 1765efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1766efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1767efe9872eSLisandro Dalcin PetscStackPop; 1768efe9872eSLisandro Dalcin 1769efe9872eSLisandro Dalcin if (rhsjacobian) { 1770efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1771efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1772efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1773efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1774efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1775efe9872eSLisandro Dalcin } 1776efe9872eSLisandro Dalcin 1777efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1778efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1779efe9872eSLisandro Dalcin } 1780efe9872eSLisandro Dalcin 1781efe9872eSLisandro Dalcin /*@ 1782efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1783efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1784efe9872eSLisandro Dalcin 1785efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1786efe9872eSLisandro Dalcin 1787efe9872eSLisandro Dalcin Input Parameters: 1788efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1789efe9872eSLisandro Dalcin . u - the solution vector 1790efe9872eSLisandro Dalcin - v - the time derivative vector 1791efe9872eSLisandro Dalcin 1792efe9872eSLisandro Dalcin Level: beginner 1793efe9872eSLisandro Dalcin 1794efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1795efe9872eSLisandro Dalcin @*/ 1796efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1797efe9872eSLisandro Dalcin { 1798efe9872eSLisandro Dalcin PetscErrorCode ierr; 1799efe9872eSLisandro Dalcin 1800efe9872eSLisandro Dalcin PetscFunctionBegin; 1801efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1802efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1803efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1804efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1805efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1806efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1807efe9872eSLisandro Dalcin ts->vec_dot = v; 1808efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1809efe9872eSLisandro Dalcin } 1810efe9872eSLisandro Dalcin 1811efe9872eSLisandro Dalcin /*@ 1812efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1813efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1814efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1815efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1816efe9872eSLisandro Dalcin 1817efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1818efe9872eSLisandro Dalcin 1819efe9872eSLisandro Dalcin Input Parameter: 1820efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1821efe9872eSLisandro Dalcin 1822efe9872eSLisandro Dalcin Output Parameter: 1823efe9872eSLisandro Dalcin + u - the vector containing the solution 1824efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1825efe9872eSLisandro Dalcin 1826efe9872eSLisandro Dalcin Level: intermediate 1827efe9872eSLisandro Dalcin 1828efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1829efe9872eSLisandro Dalcin 1830efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1831efe9872eSLisandro Dalcin @*/ 1832efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1833efe9872eSLisandro Dalcin { 1834efe9872eSLisandro Dalcin PetscFunctionBegin; 1835efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1836efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1837efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1838efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1839efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1840efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1841efe9872eSLisandro Dalcin } 1842efe9872eSLisandro Dalcin 184355849f57SBarry Smith /*@C 184455849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 184555849f57SBarry Smith 184655849f57SBarry Smith Collective on PetscViewer 184755849f57SBarry Smith 184855849f57SBarry Smith Input Parameters: 184955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 185055849f57SBarry Smith some related function before a call to TSLoad(). 185155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 185255849f57SBarry Smith 185355849f57SBarry Smith Level: intermediate 185455849f57SBarry Smith 185555849f57SBarry Smith Notes: 185655849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 185755849f57SBarry Smith 185855849f57SBarry Smith Notes for advanced users: 185955849f57SBarry Smith Most users should not need to know the details of the binary storage 186055849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 186155849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 186255849f57SBarry Smith format is 186355849f57SBarry Smith .vb 186455849f57SBarry Smith has not yet been determined 186555849f57SBarry Smith .ve 186655849f57SBarry Smith 186755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 186855849f57SBarry Smith @*/ 1869f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 187055849f57SBarry Smith { 187155849f57SBarry Smith PetscErrorCode ierr; 187255849f57SBarry Smith PetscBool isbinary; 187355849f57SBarry Smith PetscInt classid; 187455849f57SBarry Smith char type[256]; 18752d53ad75SBarry Smith DMTS sdm; 1876ad6bc421SBarry Smith DM dm; 187755849f57SBarry Smith 187855849f57SBarry Smith PetscFunctionBegin; 1879f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 188055849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 188155849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 188255849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 188355849f57SBarry Smith 1884060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1885ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1886060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1887f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1888f2c2a1b9SBarry Smith if (ts->ops->load) { 1889f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1890f2c2a1b9SBarry Smith } 1891ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1892ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1893ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1894f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1895f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 18962d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 18972d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 189855849f57SBarry Smith PetscFunctionReturn(0); 189955849f57SBarry Smith } 190055849f57SBarry Smith 19019804daf3SBarry Smith #include <petscdraw.h> 1902e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1903e04113cfSBarry Smith #include <petscviewersaws.h> 1904f05ece33SBarry Smith #endif 19057e2c5f70SBarry Smith /*@C 1906d763cef2SBarry Smith TSView - Prints the TS data structure. 1907d763cef2SBarry Smith 19084c49b128SBarry Smith Collective on TS 1909d763cef2SBarry Smith 1910d763cef2SBarry Smith Input Parameters: 1911d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1912d763cef2SBarry Smith - viewer - visualization context 1913d763cef2SBarry Smith 1914d763cef2SBarry Smith Options Database Key: 1915d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1916d763cef2SBarry Smith 1917d763cef2SBarry Smith Notes: 1918d763cef2SBarry Smith The available visualization contexts include 1919b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1920b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1921d763cef2SBarry Smith output where only the first processor opens 1922d763cef2SBarry Smith the file. All other processors send their 1923d763cef2SBarry Smith data to the first processor to print. 1924d763cef2SBarry Smith 1925d763cef2SBarry Smith The user can open an alternative visualization context with 1926b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1927d763cef2SBarry Smith 1928d763cef2SBarry Smith Level: beginner 1929d763cef2SBarry Smith 1930d763cef2SBarry Smith .keywords: TS, timestep, view 1931d763cef2SBarry Smith 1932b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1933d763cef2SBarry Smith @*/ 19347087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1935d763cef2SBarry Smith { 1936dfbe8321SBarry Smith PetscErrorCode ierr; 193719fd82e9SBarry Smith TSType type; 19382b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 19392d53ad75SBarry Smith DMTS sdm; 1940e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1941536b137fSBarry Smith PetscBool issaws; 1942f05ece33SBarry Smith #endif 1943d763cef2SBarry Smith 1944d763cef2SBarry Smith PetscFunctionBegin; 19450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19463050cee2SBarry Smith if (!viewer) { 1947ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 19483050cee2SBarry Smith } 19490700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1950c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1951fd16b177SBarry Smith 1952251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1953251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 195455849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 19552b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1956e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1957536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1958f05ece33SBarry Smith #endif 195932077d6dSBarry Smith if (iascii) { 1960dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 1961efd4aadfSBarry Smith if (ts->ops->view) { 1962efd4aadfSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1963efd4aadfSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1964efd4aadfSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1965efd4aadfSBarry Smith } 196677431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 19677c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1968efd4aadfSBarry Smith if (ts->usessnes) { 1969efd4aadfSBarry Smith PetscBool lin; 1970d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19715ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1972d763cef2SBarry Smith } 19735ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1974efd4aadfSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr); 1975efd4aadfSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr); 1976efd4aadfSBarry Smith } 1977193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1978a0af407cSBarry Smith if (ts->vrtol) { 1979a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1980a0af407cSBarry Smith } else { 1981a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1982a0af407cSBarry Smith } 1983a0af407cSBarry Smith if (ts->vatol) { 1984a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1985a0af407cSBarry Smith } else { 1986a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1987a0af407cSBarry Smith } 1988efd4aadfSBarry Smith ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr); 1989efd4aadfSBarry Smith if (ts->snes && ts->usessnes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 19902d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19912d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19920f5bd95cSBarry Smith } else if (isstring) { 1993a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1994b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 199555849f57SBarry Smith } else if (isbinary) { 199655849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 199755849f57SBarry Smith MPI_Comm comm; 199855849f57SBarry Smith PetscMPIInt rank; 199955849f57SBarry Smith char type[256]; 200055849f57SBarry Smith 200155849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 200255849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 200355849f57SBarry Smith if (!rank) { 200455849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 200555849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 200655849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 200755849f57SBarry Smith } 200855849f57SBarry Smith if (ts->ops->view) { 200955849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 201055849f57SBarry Smith } 2011efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2012f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 2013f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 20142d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 20152d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 20162b0a91c0SBarry Smith } else if (isdraw) { 20172b0a91c0SBarry Smith PetscDraw draw; 20182b0a91c0SBarry Smith char str[36]; 201989fd9fafSBarry Smith PetscReal x,y,bottom,h; 20202b0a91c0SBarry Smith 20212b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 20222b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 20232b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 20242b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 202551fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 202689fd9fafSBarry Smith bottom = y - h; 20272b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 20282b0a91c0SBarry Smith if (ts->ops->view) { 20292b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20302b0a91c0SBarry Smith } 2031efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2032efd4aadfSBarry Smith if (ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 20332b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2034e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2035536b137fSBarry Smith } else if (issaws) { 2036d45a07a7SBarry Smith PetscMPIInt rank; 20372657e9d9SBarry Smith const char *name; 20382657e9d9SBarry Smith 20392657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 2040d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 2041d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 2042d45a07a7SBarry Smith char dir[1024]; 2043d45a07a7SBarry Smith 2044e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 2045a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 20462657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 20472657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 20482657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2049d763cef2SBarry Smith } 20500acecf5bSBarry Smith if (ts->ops->view) { 20510acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20520acecf5bSBarry Smith } 2053f05ece33SBarry Smith #endif 2054f05ece33SBarry Smith } 2055f05ece33SBarry Smith 2056b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2057251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2058b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2059d763cef2SBarry Smith PetscFunctionReturn(0); 2060d763cef2SBarry Smith } 2061d763cef2SBarry Smith 2062b07ff414SBarry Smith /*@ 2063d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2064d763cef2SBarry Smith the timesteppers. 2065d763cef2SBarry Smith 20663f9fe445SBarry Smith Logically Collective on TS 2067d763cef2SBarry Smith 2068d763cef2SBarry Smith Input Parameters: 2069d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2070d763cef2SBarry Smith - usrP - optional user context 2071d763cef2SBarry Smith 2072daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2073daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2074daf670e6SBarry Smith 2075d763cef2SBarry Smith Level: intermediate 2076d763cef2SBarry Smith 2077d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2078d763cef2SBarry Smith 2079d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2080d763cef2SBarry Smith @*/ 20817087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2082d763cef2SBarry Smith { 2083d763cef2SBarry Smith PetscFunctionBegin; 20840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2085d763cef2SBarry Smith ts->user = usrP; 2086d763cef2SBarry Smith PetscFunctionReturn(0); 2087d763cef2SBarry Smith } 2088d763cef2SBarry Smith 2089b07ff414SBarry Smith /*@ 2090d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2091d763cef2SBarry Smith timestepper. 2092d763cef2SBarry Smith 2093d763cef2SBarry Smith Not Collective 2094d763cef2SBarry Smith 2095d763cef2SBarry Smith Input Parameter: 2096d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2097d763cef2SBarry Smith 2098d763cef2SBarry Smith Output Parameter: 2099d763cef2SBarry Smith . usrP - user context 2100d763cef2SBarry Smith 2101daf670e6SBarry Smith Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this 2102daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2103daf670e6SBarry Smith 2104d763cef2SBarry Smith Level: intermediate 2105d763cef2SBarry Smith 2106d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2107d763cef2SBarry Smith 2108d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2109d763cef2SBarry Smith @*/ 2110e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2111d763cef2SBarry Smith { 2112d763cef2SBarry Smith PetscFunctionBegin; 21130700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2114e71120c6SJed Brown *(void**)usrP = ts->user; 2115d763cef2SBarry Smith PetscFunctionReturn(0); 2116d763cef2SBarry Smith } 2117d763cef2SBarry Smith 2118d763cef2SBarry Smith /*@ 2119*80275a0aSLisandro Dalcin TSGetStepNumber - Gets the number of steps completed. 2120d763cef2SBarry Smith 2121d763cef2SBarry Smith Not Collective 2122d763cef2SBarry Smith 2123d763cef2SBarry Smith Input Parameter: 2124d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2125d763cef2SBarry Smith 2126d763cef2SBarry Smith Output Parameter: 2127*80275a0aSLisandro Dalcin . steps - number of steps completed so far 2128d763cef2SBarry Smith 2129d763cef2SBarry Smith Level: intermediate 2130d763cef2SBarry Smith 2131d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 21329be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2133d763cef2SBarry Smith @*/ 2134*80275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps) 2135d763cef2SBarry Smith { 2136d763cef2SBarry Smith PetscFunctionBegin; 21370700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2138*80275a0aSLisandro Dalcin PetscValidIntPointer(steps,2); 2139*80275a0aSLisandro Dalcin *steps = ts->steps; 2140*80275a0aSLisandro Dalcin PetscFunctionReturn(0); 2141*80275a0aSLisandro Dalcin } 2142*80275a0aSLisandro Dalcin 2143*80275a0aSLisandro Dalcin /*@ 2144*80275a0aSLisandro Dalcin TSSetStepNumber - Sets the number of steps completed. 2145*80275a0aSLisandro Dalcin 2146*80275a0aSLisandro Dalcin Logically Collective on TS 2147*80275a0aSLisandro Dalcin 2148*80275a0aSLisandro Dalcin Input Parameters: 2149*80275a0aSLisandro Dalcin + ts - the TS context 2150*80275a0aSLisandro Dalcin - steps - number of steps completed so far 2151*80275a0aSLisandro Dalcin 2152*80275a0aSLisandro Dalcin Notes: 2153*80275a0aSLisandro Dalcin For most uses of the TS solvers the user need not explicitly call 2154*80275a0aSLisandro Dalcin TSSetStepNumber(), as the step counter is appropriately updated in 2155*80275a0aSLisandro Dalcin TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to 2156*80275a0aSLisandro Dalcin reinitialize timestepping by setting the step counter to zero (and time 2157*80275a0aSLisandro Dalcin to the initial time) to solve a similar problem with different initial 2158*80275a0aSLisandro Dalcin conditions or parameters. Other possible use case is to continue 2159*80275a0aSLisandro Dalcin timestepping from a previously interrupted run in such a way that TS 2160*80275a0aSLisandro Dalcin monitors will be called with a initial nonzero step counter. 2161*80275a0aSLisandro Dalcin 2162*80275a0aSLisandro Dalcin Level: advanced 2163*80275a0aSLisandro Dalcin 2164*80275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number 2165*80275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution() 2166*80275a0aSLisandro Dalcin @*/ 2167*80275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps) 2168*80275a0aSLisandro Dalcin { 2169*80275a0aSLisandro Dalcin PetscFunctionBegin; 2170*80275a0aSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2171*80275a0aSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,steps,2); 2172*80275a0aSLisandro Dalcin if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative"); 2173*80275a0aSLisandro Dalcin ts->steps = steps; 2174d763cef2SBarry Smith PetscFunctionReturn(0); 2175d763cef2SBarry Smith } 2176d763cef2SBarry Smith 2177d763cef2SBarry Smith /*@ 2178d763cef2SBarry Smith TSSetInitialTimeStep - Sets the initial timestep to be used, 2179d763cef2SBarry Smith as well as the initial time. 2180d763cef2SBarry Smith 21813f9fe445SBarry Smith Logically Collective on TS 2182d763cef2SBarry Smith 2183d763cef2SBarry Smith Input Parameters: 2184d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2185d763cef2SBarry Smith . initial_time - the initial time 2186d763cef2SBarry Smith - time_step - the size of the timestep 2187d763cef2SBarry Smith 2188d763cef2SBarry Smith Level: intermediate 2189d763cef2SBarry Smith 2190d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep() 2191d763cef2SBarry Smith 2192d763cef2SBarry Smith .keywords: TS, set, initial, timestep 2193d763cef2SBarry Smith @*/ 21947087cfbeSBarry Smith PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2195d763cef2SBarry Smith { 2196e144a568SJed Brown PetscErrorCode ierr; 2197e144a568SJed Brown 2198d763cef2SBarry Smith PetscFunctionBegin; 21990700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2200e144a568SJed Brown ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2201d8cd7023SBarry Smith ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2202d763cef2SBarry Smith PetscFunctionReturn(0); 2203d763cef2SBarry Smith } 2204d763cef2SBarry Smith 2205d763cef2SBarry Smith /*@ 2206d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2207d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2208d763cef2SBarry Smith 22093f9fe445SBarry Smith Logically Collective on TS 2210d763cef2SBarry Smith 2211d763cef2SBarry Smith Input Parameters: 2212d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2213d763cef2SBarry Smith - time_step - the size of the timestep 2214d763cef2SBarry Smith 2215d763cef2SBarry Smith Level: intermediate 2216d763cef2SBarry Smith 2217d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2218d763cef2SBarry Smith 2219d763cef2SBarry Smith .keywords: TS, set, timestep 2220d763cef2SBarry Smith @*/ 22217087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2222d763cef2SBarry Smith { 2223d763cef2SBarry Smith PetscFunctionBegin; 22240700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2225c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2226d763cef2SBarry Smith ts->time_step = time_step; 2227d763cef2SBarry Smith PetscFunctionReturn(0); 2228d763cef2SBarry Smith } 2229d763cef2SBarry Smith 2230a43b19c4SJed Brown /*@ 223149354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 223249354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 223349354f04SShri Abhyankar or just return at the final time TS computed. 2234a43b19c4SJed Brown 2235a43b19c4SJed Brown Logically Collective on TS 2236a43b19c4SJed Brown 2237a43b19c4SJed Brown Input Parameter: 2238a43b19c4SJed Brown + ts - the time-step context 223949354f04SShri Abhyankar - eftopt - exact final time option 2240a43b19c4SJed Brown 2241feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2242feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2243feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2244feed9e9dSBarry Smith 2245feed9e9dSBarry Smith Options Database: 2246feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2247feed9e9dSBarry Smith 2248ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2249ee346746SBarry Smith then the final time you selected. 2250ee346746SBarry Smith 2251a43b19c4SJed Brown Level: beginner 2252a43b19c4SJed Brown 2253a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption 2254a43b19c4SJed Brown @*/ 225549354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2256a43b19c4SJed Brown { 2257a43b19c4SJed Brown PetscFunctionBegin; 2258a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 225949354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 226049354f04SShri Abhyankar ts->exact_final_time = eftopt; 2261a43b19c4SJed Brown PetscFunctionReturn(0); 2262a43b19c4SJed Brown } 2263a43b19c4SJed Brown 2264d763cef2SBarry Smith /*@ 2265d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2266d763cef2SBarry Smith 2267d763cef2SBarry Smith Not Collective 2268d763cef2SBarry Smith 2269d763cef2SBarry Smith Input Parameter: 2270d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2271d763cef2SBarry Smith 2272d763cef2SBarry Smith Output Parameter: 2273d763cef2SBarry Smith . dt - the current timestep size 2274d763cef2SBarry Smith 2275d763cef2SBarry Smith Level: intermediate 2276d763cef2SBarry Smith 2277d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 2278d763cef2SBarry Smith 2279d763cef2SBarry Smith .keywords: TS, get, timestep 2280d763cef2SBarry Smith @*/ 22817087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2282d763cef2SBarry Smith { 2283d763cef2SBarry Smith PetscFunctionBegin; 22840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2285f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2286d763cef2SBarry Smith *dt = ts->time_step; 2287d763cef2SBarry Smith PetscFunctionReturn(0); 2288d763cef2SBarry Smith } 2289d763cef2SBarry Smith 2290d8e5e3e6SSatish Balay /*@ 2291d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2292d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2293d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2294d763cef2SBarry Smith the solution at the next timestep has been calculated. 2295d763cef2SBarry Smith 2296d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2297d763cef2SBarry Smith 2298d763cef2SBarry Smith Input Parameter: 2299d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2300d763cef2SBarry Smith 2301d763cef2SBarry Smith Output Parameter: 2302d763cef2SBarry Smith . v - the vector containing the solution 2303d763cef2SBarry Smith 230463e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 230563e21af5SBarry Smith final time. It returns the solution at the next timestep. 230663e21af5SBarry Smith 2307d763cef2SBarry Smith Level: intermediate 2308d763cef2SBarry Smith 2309b2bf4f3aSDebojyoti Ghosh .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents() 2310d763cef2SBarry Smith 2311d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2312d763cef2SBarry Smith @*/ 23137087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2314d763cef2SBarry Smith { 2315d763cef2SBarry Smith PetscFunctionBegin; 23160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23174482741eSBarry Smith PetscValidPointer(v,2); 23188737fe31SLisandro Dalcin *v = ts->vec_sol; 2319d763cef2SBarry Smith PetscFunctionReturn(0); 2320d763cef2SBarry Smith } 2321d763cef2SBarry Smith 232203fe5f5eSDebojyoti Ghosh /*@ 2323b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 232403fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2325b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 232603fe5f5eSDebojyoti Ghosh structure as the solution vector. 232703fe5f5eSDebojyoti Ghosh 232803fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 232903fe5f5eSDebojyoti Ghosh 233003fe5f5eSDebojyoti Ghosh Parameters : 233103fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2332b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2333b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 233403fe5f5eSDebojyoti Ghosh returned in v. 2335b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 233603fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2337b2bf4f3aSDebojyoti Ghosh the number of solutions components). 233803fe5f5eSDebojyoti Ghosh 23394cdd57e5SDebojyoti Ghosh Level: advanced 234003fe5f5eSDebojyoti Ghosh 234103fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 234203fe5f5eSDebojyoti Ghosh 234303fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 234403fe5f5eSDebojyoti Ghosh @*/ 2345b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 234603fe5f5eSDebojyoti Ghosh { 234703fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 234803fe5f5eSDebojyoti Ghosh 234903fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 235003fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2351b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 235203fe5f5eSDebojyoti Ghosh else { 2353b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 235403fe5f5eSDebojyoti Ghosh } 235503fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 235603fe5f5eSDebojyoti Ghosh } 235703fe5f5eSDebojyoti Ghosh 23584cdd57e5SDebojyoti Ghosh /*@ 23594cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 23604cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 23614cdd57e5SDebojyoti Ghosh 23624cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23634cdd57e5SDebojyoti Ghosh 23644cdd57e5SDebojyoti Ghosh Parameters : 23654cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 23664cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 23674cdd57e5SDebojyoti Ghosh 23684cdd57e5SDebojyoti Ghosh Level: intermediate 23694cdd57e5SDebojyoti Ghosh 23704cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 23714cdd57e5SDebojyoti Ghosh 23724cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 23734cdd57e5SDebojyoti Ghosh @*/ 23744cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 23754cdd57e5SDebojyoti Ghosh { 23764cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23774cdd57e5SDebojyoti Ghosh 23784cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23794cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2380f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 23814cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2382f6356ec7SDebojyoti Ghosh } else { 2383f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2384f6356ec7SDebojyoti Ghosh } 23854cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23864cdd57e5SDebojyoti Ghosh } 23874cdd57e5SDebojyoti Ghosh 23884cdd57e5SDebojyoti Ghosh /*@ 23894cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 23904cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 23914cdd57e5SDebojyoti Ghosh 23924cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23934cdd57e5SDebojyoti Ghosh 23949657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 23959657682dSDebojyoti Ghosh 23964cdd57e5SDebojyoti Ghosh Parameters : 23974cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2398657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 23994cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 24004cdd57e5SDebojyoti Ghosh 24014cdd57e5SDebojyoti Ghosh Level: intermediate 24024cdd57e5SDebojyoti Ghosh 240357df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 24044cdd57e5SDebojyoti Ghosh 24054cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 24064cdd57e5SDebojyoti Ghosh @*/ 24070a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 24084cdd57e5SDebojyoti Ghosh { 24094cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 24104cdd57e5SDebojyoti Ghosh 24114cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 24124cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2413f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 24140a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2415f6356ec7SDebojyoti Ghosh } else { 2416f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2417f6356ec7SDebojyoti Ghosh } 24184cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 24194cdd57e5SDebojyoti Ghosh } 24204cdd57e5SDebojyoti Ghosh 242157df6a1bSDebojyoti Ghosh /*@ 242257df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 242357df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 242457df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 242557df6a1bSDebojyoti Ghosh 242657df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 242757df6a1bSDebojyoti Ghosh 242857df6a1bSDebojyoti Ghosh Parameters : 242957df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 243057df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 243157df6a1bSDebojyoti Ghosh 243257df6a1bSDebojyoti Ghosh Level: intermediate 243357df6a1bSDebojyoti Ghosh 243457df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 243557df6a1bSDebojyoti Ghosh 243657df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 243757df6a1bSDebojyoti Ghosh @*/ 243857df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 243957df6a1bSDebojyoti Ghosh { 244057df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 244157df6a1bSDebojyoti Ghosh 244257df6a1bSDebojyoti Ghosh PetscFunctionBegin; 244357df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24449657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 244557df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 244657df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 244757df6a1bSDebojyoti Ghosh } 244857df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 244957df6a1bSDebojyoti Ghosh } 245057df6a1bSDebojyoti Ghosh 2451c235aa8dSHong Zhang /*@ 2452dfb21088SHong Zhang TSGetCostGradients - Returns the gradients from the TSAdjointSolve() 2453c235aa8dSHong Zhang 2454c235aa8dSHong Zhang Not Collective, but Vec returned is parallel if TS is parallel 2455c235aa8dSHong Zhang 2456c235aa8dSHong Zhang Input Parameter: 2457c235aa8dSHong Zhang . ts - the TS context obtained from TSCreate() 2458c235aa8dSHong Zhang 2459c235aa8dSHong Zhang Output Parameter: 2460abc2977eSBarry Smith + lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 2461abc2977eSBarry Smith - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 2462c235aa8dSHong Zhang 2463c235aa8dSHong Zhang Level: intermediate 2464c235aa8dSHong Zhang 2465c235aa8dSHong Zhang .seealso: TSGetTimeStep() 2466c235aa8dSHong Zhang 2467c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity 2468c235aa8dSHong Zhang @*/ 2469dfb21088SHong Zhang PetscErrorCode TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu) 2470c235aa8dSHong Zhang { 2471c235aa8dSHong Zhang PetscFunctionBegin; 2472c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2473abc2977eSBarry Smith if (numcost) *numcost = ts->numcost; 2474abc2977eSBarry Smith if (lambda) *lambda = ts->vecs_sensi; 2475abc2977eSBarry Smith if (mu) *mu = ts->vecs_sensip; 2476c235aa8dSHong Zhang PetscFunctionReturn(0); 2477c235aa8dSHong Zhang } 2478c235aa8dSHong Zhang 2479bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2480d8e5e3e6SSatish Balay /*@ 2481bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2482d763cef2SBarry Smith 2483bdad233fSMatthew Knepley Not collective 2484d763cef2SBarry Smith 2485bdad233fSMatthew Knepley Input Parameters: 2486bdad233fSMatthew Knepley + ts - The TS 2487bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2488d763cef2SBarry Smith .vb 24890910c330SBarry Smith U_t - A U = 0 (linear) 24900910c330SBarry Smith U_t - A(t) U = 0 (linear) 24910910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2492d763cef2SBarry Smith .ve 2493d763cef2SBarry Smith 2494d763cef2SBarry Smith Level: beginner 2495d763cef2SBarry Smith 2496bdad233fSMatthew Knepley .keywords: TS, problem type 2497bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2498d763cef2SBarry Smith @*/ 24997087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2500a7cc72afSBarry Smith { 25019e2a6581SJed Brown PetscErrorCode ierr; 25029e2a6581SJed Brown 2503d763cef2SBarry Smith PetscFunctionBegin; 25040700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2505bdad233fSMatthew Knepley ts->problem_type = type; 25069e2a6581SJed Brown if (type == TS_LINEAR) { 25079e2a6581SJed Brown SNES snes; 25089e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 25099e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 25109e2a6581SJed Brown } 2511d763cef2SBarry Smith PetscFunctionReturn(0); 2512d763cef2SBarry Smith } 2513d763cef2SBarry Smith 2514bdad233fSMatthew Knepley /*@C 2515bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2516bdad233fSMatthew Knepley 2517bdad233fSMatthew Knepley Not collective 2518bdad233fSMatthew Knepley 2519bdad233fSMatthew Knepley Input Parameter: 2520bdad233fSMatthew Knepley . ts - The TS 2521bdad233fSMatthew Knepley 2522bdad233fSMatthew Knepley Output Parameter: 2523bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2524bdad233fSMatthew Knepley .vb 2525089b2837SJed Brown M U_t = A U 2526089b2837SJed Brown M(t) U_t = A(t) U 2527b5abc632SBarry Smith F(t,U,U_t) 2528bdad233fSMatthew Knepley .ve 2529bdad233fSMatthew Knepley 2530bdad233fSMatthew Knepley Level: beginner 2531bdad233fSMatthew Knepley 2532bdad233fSMatthew Knepley .keywords: TS, problem type 2533bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2534bdad233fSMatthew Knepley @*/ 25357087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2536a7cc72afSBarry Smith { 2537bdad233fSMatthew Knepley PetscFunctionBegin; 25380700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 25394482741eSBarry Smith PetscValidIntPointer(type,2); 2540bdad233fSMatthew Knepley *type = ts->problem_type; 2541bdad233fSMatthew Knepley PetscFunctionReturn(0); 2542bdad233fSMatthew Knepley } 2543d763cef2SBarry Smith 2544d763cef2SBarry Smith /*@ 2545d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2546d763cef2SBarry Smith of a timestepper. 2547d763cef2SBarry Smith 2548d763cef2SBarry Smith Collective on TS 2549d763cef2SBarry Smith 2550d763cef2SBarry Smith Input Parameter: 2551d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2552d763cef2SBarry Smith 2553d763cef2SBarry Smith Notes: 2554d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2555d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2556d763cef2SBarry Smith the call to TSStep(). However, if one wishes to control this 2557d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2558d763cef2SBarry Smith and optional routines of the form TSSetXXX(), but before TSStep(). 2559d763cef2SBarry Smith 2560d763cef2SBarry Smith Level: advanced 2561d763cef2SBarry Smith 2562d763cef2SBarry Smith .keywords: TS, timestep, setup 2563d763cef2SBarry Smith 2564d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy() 2565d763cef2SBarry Smith @*/ 25667087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2567d763cef2SBarry Smith { 2568dfbe8321SBarry Smith PetscErrorCode ierr; 25696c6b9e74SPeter Brune DM dm; 25706c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2571d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2572cd11d68dSLisandro Dalcin TSIFunction ifun; 25736c6b9e74SPeter Brune TSIJacobian ijac; 2574efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 25756c6b9e74SPeter Brune TSRHSJacobian rhsjac; 25762ffb9264SLisandro Dalcin PetscBool isnone; 2577d763cef2SBarry Smith 2578d763cef2SBarry Smith PetscFunctionBegin; 25790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2580277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2581277b19d0SLisandro Dalcin 25827adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2583cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2584cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2585d763cef2SBarry Smith } 2586277b19d0SLisandro Dalcin 2587277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2588277b19d0SLisandro Dalcin 2589e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 2590e1244c69SJed Brown Mat Amat,Pmat; 2591e1244c69SJed Brown SNES snes; 2592e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2593e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2594e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2595e1244c69SJed Brown * have displaced the RHS matrix */ 2596e1244c69SJed Brown if (Amat == ts->Arhs) { 2597abc0d4abSBarry Smith /* we need to copy the values of the matrix because for the constant Jacobian case the user will never set the numerical values in this new location */ 2598abc0d4abSBarry Smith ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2599e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2600e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2601e1244c69SJed Brown } 2602e1244c69SJed Brown if (Pmat == ts->Brhs) { 2603abc0d4abSBarry Smith ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2604e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2605e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2606e1244c69SJed Brown } 2607e1244c69SJed Brown } 26082ffb9264SLisandro Dalcin 26092ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 26102ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 26112ffb9264SLisandro Dalcin 2612277b19d0SLisandro Dalcin if (ts->ops->setup) { 2613000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2614277b19d0SLisandro Dalcin } 2615277b19d0SLisandro Dalcin 26162ffb9264SLisandro Dalcin /* Attempt to check/preset a default value for the exact final time option */ 26172ffb9264SLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 26182ffb9264SLisandro Dalcin if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) 26192ffb9264SLisandro Dalcin ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 26202ffb9264SLisandro Dalcin 2621a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 26226c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 26236c6b9e74SPeter Brune */ 26246c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 26250298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 26266c6b9e74SPeter Brune if (!func) { 26276c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 26286c6b9e74SPeter Brune } 2629a6772fa2SLisandro 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. 26306c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 26316c6b9e74SPeter Brune */ 26320298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 26330298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2634efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 26350298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2636efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 26376c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 26386c6b9e74SPeter Brune } 2639c0517034SDebojyoti Ghosh 2640c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2641c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2642c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2643c0517034SDebojyoti Ghosh } 2644c0517034SDebojyoti Ghosh 2645277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2646277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2647277b19d0SLisandro Dalcin } 2648277b19d0SLisandro Dalcin 2649f6a906c0SBarry Smith /*@ 2650f6a906c0SBarry Smith TSAdjointSetUp - Sets up the internal data structures for the later use 2651f6a906c0SBarry Smith of an adjoint solver 2652f6a906c0SBarry Smith 2653f6a906c0SBarry Smith Collective on TS 2654f6a906c0SBarry Smith 2655f6a906c0SBarry Smith Input Parameter: 2656f6a906c0SBarry Smith . ts - the TS context obtained from TSCreate() 2657f6a906c0SBarry Smith 2658f6a906c0SBarry Smith Level: advanced 2659f6a906c0SBarry Smith 2660f6a906c0SBarry Smith .keywords: TS, timestep, setup 2661f6a906c0SBarry Smith 2662947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients() 2663f6a906c0SBarry Smith @*/ 2664f6a906c0SBarry Smith PetscErrorCode TSAdjointSetUp(TS ts) 2665f6a906c0SBarry Smith { 2666f6a906c0SBarry Smith PetscErrorCode ierr; 2667f6a906c0SBarry Smith 2668f6a906c0SBarry Smith PetscFunctionBegin; 2669f6a906c0SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2670f6a906c0SBarry Smith if (ts->adjointsetupcalled) PetscFunctionReturn(0); 267123706b9aSHong Zhang if (!ts->vecs_sensi) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first"); 2672c5767687SHong Zhang if (ts->vecs_sensip && !ts->Jacp) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetRHSJacobian() first"); 2673d8151eeaSBarry Smith 2674947abb85SHong Zhang if (ts->vec_costintegral) { /* if there is integral in the cost function */ 2675d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2676d8151eeaSBarry Smith if (ts->vecs_sensip){ 2677d8151eeaSBarry Smith ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2678d8151eeaSBarry Smith } 2679947abb85SHong Zhang } 2680d8151eeaSBarry Smith 268142f2b339SBarry Smith if (ts->ops->adjointsetup) { 268242f2b339SBarry Smith ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr); 2683f6a906c0SBarry Smith } 2684f6a906c0SBarry Smith ts->adjointsetupcalled = PETSC_TRUE; 2685f6a906c0SBarry Smith PetscFunctionReturn(0); 2686f6a906c0SBarry Smith } 2687f6a906c0SBarry Smith 2688277b19d0SLisandro Dalcin /*@ 2689277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2690277b19d0SLisandro Dalcin 2691277b19d0SLisandro Dalcin Collective on TS 2692277b19d0SLisandro Dalcin 2693277b19d0SLisandro Dalcin Input Parameter: 2694277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2695277b19d0SLisandro Dalcin 2696277b19d0SLisandro Dalcin Level: beginner 2697277b19d0SLisandro Dalcin 2698277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2699277b19d0SLisandro Dalcin 2700277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2701277b19d0SLisandro Dalcin @*/ 2702277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2703277b19d0SLisandro Dalcin { 2704277b19d0SLisandro Dalcin PetscErrorCode ierr; 2705277b19d0SLisandro Dalcin 2706277b19d0SLisandro Dalcin PetscFunctionBegin; 2707277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2708b18ea86cSHong Zhang 2709277b19d0SLisandro Dalcin if (ts->ops->reset) { 2710277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2711277b19d0SLisandro Dalcin } 2712277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2713e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2714bbd56ea5SKarl Rupp 27154e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 27164e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2717214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 27186bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2719efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2720e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2721e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 272238637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2723bbd56ea5SKarl Rupp 2724d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2725d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2726715f1b00SHong Zhang 2727ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 27282c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 272936eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2730715f1b00SHong Zhang 2731022c081aSHong Zhang ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr); 2732022c081aSHong Zhang 2733277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2734d763cef2SBarry Smith PetscFunctionReturn(0); 2735d763cef2SBarry Smith } 2736d763cef2SBarry Smith 2737d8e5e3e6SSatish Balay /*@ 2738d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2739d763cef2SBarry Smith with TSCreate(). 2740d763cef2SBarry Smith 2741d763cef2SBarry Smith Collective on TS 2742d763cef2SBarry Smith 2743d763cef2SBarry Smith Input Parameter: 2744d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2745d763cef2SBarry Smith 2746d763cef2SBarry Smith Level: beginner 2747d763cef2SBarry Smith 2748d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2749d763cef2SBarry Smith 2750d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2751d763cef2SBarry Smith @*/ 27526bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2753d763cef2SBarry Smith { 27546849ba73SBarry Smith PetscErrorCode ierr; 2755d763cef2SBarry Smith 2756d763cef2SBarry Smith PetscFunctionBegin; 27576bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 27586bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 27596bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2760d763cef2SBarry Smith 27616bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2762277b19d0SLisandro Dalcin 2763e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2764e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 27656bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 27666d4c513bSLisandro Dalcin 2767bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2768bc952696SBarry Smith 276984df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 27706427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 27716427ac75SLisandro Dalcin 27726bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 27736bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 27746bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 27750dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 27766d4c513bSLisandro Dalcin 2777a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2778d763cef2SBarry Smith PetscFunctionReturn(0); 2779d763cef2SBarry Smith } 2780d763cef2SBarry Smith 2781d8e5e3e6SSatish Balay /*@ 2782d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2783d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2784d763cef2SBarry Smith 2785d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2786d763cef2SBarry Smith 2787d763cef2SBarry Smith Input Parameter: 2788d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2789d763cef2SBarry Smith 2790d763cef2SBarry Smith Output Parameter: 2791d763cef2SBarry Smith . snes - the nonlinear solver context 2792d763cef2SBarry Smith 2793d763cef2SBarry Smith Notes: 2794d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2795d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 279694b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2797d763cef2SBarry Smith 2798d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 27990298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2800d763cef2SBarry Smith 2801d763cef2SBarry Smith Level: beginner 2802d763cef2SBarry Smith 2803d763cef2SBarry Smith .keywords: timestep, get, SNES 2804d763cef2SBarry Smith @*/ 28057087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2806d763cef2SBarry Smith { 2807d372ba47SLisandro Dalcin PetscErrorCode ierr; 2808d372ba47SLisandro Dalcin 2809d763cef2SBarry Smith PetscFunctionBegin; 28100700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28114482741eSBarry Smith PetscValidPointer(snes,2); 2812d372ba47SLisandro Dalcin if (!ts->snes) { 2813ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 28140298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 28153bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2816d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2817496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 28189e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 28199e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 28209e2a6581SJed Brown } 2821d372ba47SLisandro Dalcin } 2822d763cef2SBarry Smith *snes = ts->snes; 2823d763cef2SBarry Smith PetscFunctionReturn(0); 2824d763cef2SBarry Smith } 2825d763cef2SBarry Smith 2826deb2cd25SJed Brown /*@ 2827deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2828deb2cd25SJed Brown 2829deb2cd25SJed Brown Collective 2830deb2cd25SJed Brown 2831deb2cd25SJed Brown Input Parameter: 2832deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2833deb2cd25SJed Brown - snes - the nonlinear solver context 2834deb2cd25SJed Brown 2835deb2cd25SJed Brown Notes: 2836deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2837deb2cd25SJed Brown 2838deb2cd25SJed Brown Level: developer 2839deb2cd25SJed Brown 2840deb2cd25SJed Brown .keywords: timestep, set, SNES 2841deb2cd25SJed Brown @*/ 2842deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2843deb2cd25SJed Brown { 2844deb2cd25SJed Brown PetscErrorCode ierr; 2845d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2846deb2cd25SJed Brown 2847deb2cd25SJed Brown PetscFunctionBegin; 2848deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2849deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2850deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2851deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2852bbd56ea5SKarl Rupp 2853deb2cd25SJed Brown ts->snes = snes; 2854bbd56ea5SKarl Rupp 28550298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 28560298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2857740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 28580298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2859740132f1SEmil Constantinescu } 2860deb2cd25SJed Brown PetscFunctionReturn(0); 2861deb2cd25SJed Brown } 2862deb2cd25SJed Brown 2863d8e5e3e6SSatish Balay /*@ 286494b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2865d763cef2SBarry Smith a TS (timestepper) context. 2866d763cef2SBarry Smith 286794b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2868d763cef2SBarry Smith 2869d763cef2SBarry Smith Input Parameter: 2870d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2871d763cef2SBarry Smith 2872d763cef2SBarry Smith Output Parameter: 287394b7f48cSBarry Smith . ksp - the nonlinear solver context 2874d763cef2SBarry Smith 2875d763cef2SBarry Smith Notes: 287694b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2877d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2878d763cef2SBarry Smith KSP and PC contexts as well. 2879d763cef2SBarry Smith 288094b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 28810298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2882d763cef2SBarry Smith 2883d763cef2SBarry Smith Level: beginner 2884d763cef2SBarry Smith 288594b7f48cSBarry Smith .keywords: timestep, get, KSP 2886d763cef2SBarry Smith @*/ 28877087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2888d763cef2SBarry Smith { 2889d372ba47SLisandro Dalcin PetscErrorCode ierr; 2890089b2837SJed Brown SNES snes; 2891d372ba47SLisandro Dalcin 2892d763cef2SBarry Smith PetscFunctionBegin; 28930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28944482741eSBarry Smith PetscValidPointer(ksp,2); 289517186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2896e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2897089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2898089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2899d763cef2SBarry Smith PetscFunctionReturn(0); 2900d763cef2SBarry Smith } 2901d763cef2SBarry Smith 2902d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2903d763cef2SBarry Smith 2904adb62b0dSMatthew Knepley /*@ 2905618ce8baSLisandro Dalcin TSSetMaxSteps - Sets the maximum number of steps to use. 2906618ce8baSLisandro Dalcin 2907618ce8baSLisandro Dalcin Logically Collective on TS 2908618ce8baSLisandro Dalcin 2909618ce8baSLisandro Dalcin Input Parameters: 2910618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2911618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use 2912618ce8baSLisandro Dalcin 2913618ce8baSLisandro Dalcin Options Database Keys: 2914618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps 2915618ce8baSLisandro Dalcin 2916618ce8baSLisandro Dalcin Notes: 2917618ce8baSLisandro Dalcin The default maximum number of steps is 5000 2918618ce8baSLisandro Dalcin 2919618ce8baSLisandro Dalcin Level: intermediate 2920618ce8baSLisandro Dalcin 2921618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps 2922618ce8baSLisandro Dalcin 2923618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime() 2924618ce8baSLisandro Dalcin @*/ 2925618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps) 2926618ce8baSLisandro Dalcin { 2927618ce8baSLisandro Dalcin PetscFunctionBegin; 2928618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2929618ce8baSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2930618ce8baSLisandro Dalcin if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative"); 2931618ce8baSLisandro Dalcin ts->max_steps = maxsteps; 2932618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2933618ce8baSLisandro Dalcin } 2934618ce8baSLisandro Dalcin 2935618ce8baSLisandro Dalcin /*@ 2936618ce8baSLisandro Dalcin TSGetMaxSteps - Gets the maximum number of steps to use. 2937618ce8baSLisandro Dalcin 2938618ce8baSLisandro Dalcin Not Collective 2939618ce8baSLisandro Dalcin 2940618ce8baSLisandro Dalcin Input Parameters: 2941618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2942618ce8baSLisandro Dalcin 2943618ce8baSLisandro Dalcin Output Parameter: 2944618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use 2945618ce8baSLisandro Dalcin 2946618ce8baSLisandro Dalcin Level: advanced 2947618ce8baSLisandro Dalcin 2948618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps 2949618ce8baSLisandro Dalcin 2950618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime() 2951618ce8baSLisandro Dalcin @*/ 2952618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps) 2953618ce8baSLisandro Dalcin { 2954618ce8baSLisandro Dalcin PetscFunctionBegin; 2955618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2956618ce8baSLisandro Dalcin PetscValidIntPointer(maxsteps,2); 2957618ce8baSLisandro Dalcin *maxsteps = ts->max_steps; 2958618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2959618ce8baSLisandro Dalcin } 2960618ce8baSLisandro Dalcin 2961618ce8baSLisandro Dalcin /*@ 2962618ce8baSLisandro Dalcin TSSetMaxTime - Sets the maximum (or final) time for timestepping. 2963618ce8baSLisandro Dalcin 2964618ce8baSLisandro Dalcin Logically Collective on TS 2965618ce8baSLisandro Dalcin 2966618ce8baSLisandro Dalcin Input Parameters: 2967618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2968618ce8baSLisandro Dalcin - maxtime - final time to step to 2969618ce8baSLisandro Dalcin 2970618ce8baSLisandro Dalcin Options Database Keys: 2971618ce8baSLisandro Dalcin . -ts_final_time <maxtime> - Sets maxtime 2972618ce8baSLisandro Dalcin 2973618ce8baSLisandro Dalcin Notes: 2974618ce8baSLisandro Dalcin The default maximum time is 5.0 2975618ce8baSLisandro Dalcin 2976618ce8baSLisandro Dalcin Level: intermediate 2977618ce8baSLisandro Dalcin 2978618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time 2979618ce8baSLisandro Dalcin 2980618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime() 2981618ce8baSLisandro Dalcin @*/ 2982618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime) 2983618ce8baSLisandro Dalcin { 2984618ce8baSLisandro Dalcin PetscFunctionBegin; 2985618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2986618ce8baSLisandro Dalcin PetscValidLogicalCollectiveReal(ts,maxtime,2); 2987618ce8baSLisandro Dalcin ts->max_time = maxtime; 2988618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2989618ce8baSLisandro Dalcin } 2990618ce8baSLisandro Dalcin 2991618ce8baSLisandro Dalcin /*@ 2992618ce8baSLisandro Dalcin TSGetMaxTime - Gets the maximum (or final) time for timestepping. 2993618ce8baSLisandro Dalcin 2994618ce8baSLisandro Dalcin Not Collective 2995618ce8baSLisandro Dalcin 2996618ce8baSLisandro Dalcin Input Parameters: 2997618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2998618ce8baSLisandro Dalcin 2999618ce8baSLisandro Dalcin Output Parameter: 3000618ce8baSLisandro Dalcin . maxtime - final time to step to 3001618ce8baSLisandro Dalcin 3002618ce8baSLisandro Dalcin Level: advanced 3003618ce8baSLisandro Dalcin 3004618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time 3005618ce8baSLisandro Dalcin 3006618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps() 3007618ce8baSLisandro Dalcin @*/ 3008618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime) 3009618ce8baSLisandro Dalcin { 3010618ce8baSLisandro Dalcin PetscFunctionBegin; 3011618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3012618ce8baSLisandro Dalcin PetscValidRealPointer(maxtime,2); 3013618ce8baSLisandro Dalcin *maxtime = ts->max_time; 3014618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3015618ce8baSLisandro Dalcin } 3016618ce8baSLisandro Dalcin 3017618ce8baSLisandro Dalcin /*@ 3018adb62b0dSMatthew Knepley TSGetDuration - Gets the maximum number of timesteps to use and 3019adb62b0dSMatthew Knepley maximum time for iteration. 3020adb62b0dSMatthew Knepley 30213f9fe445SBarry Smith Not Collective 3022adb62b0dSMatthew Knepley 3023adb62b0dSMatthew Knepley Input Parameters: 3024adb62b0dSMatthew Knepley + ts - the TS context obtained from TSCreate() 30250298fd71SBarry Smith . maxsteps - maximum number of iterations to use, or NULL 30260298fd71SBarry Smith - maxtime - final time to iterate to, or NULL 3027adb62b0dSMatthew Knepley 3028adb62b0dSMatthew Knepley Level: intermediate 3029adb62b0dSMatthew Knepley 3030adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time 3031adb62b0dSMatthew Knepley @*/ 30327087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 3033adb62b0dSMatthew Knepley { 3034adb62b0dSMatthew Knepley PetscFunctionBegin; 30350700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3036abc0a331SBarry Smith if (maxsteps) { 30374482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 3038adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 3039adb62b0dSMatthew Knepley } 3040abc0a331SBarry Smith if (maxtime) { 30414482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 3042adb62b0dSMatthew Knepley *maxtime = ts->max_time; 3043adb62b0dSMatthew Knepley } 3044adb62b0dSMatthew Knepley PetscFunctionReturn(0); 3045adb62b0dSMatthew Knepley } 3046adb62b0dSMatthew Knepley 3047d763cef2SBarry Smith /*@ 3048d763cef2SBarry Smith TSSetDuration - Sets the maximum number of timesteps to use and 3049d763cef2SBarry Smith maximum time for iteration. 3050d763cef2SBarry Smith 30513f9fe445SBarry Smith Logically Collective on TS 3052d763cef2SBarry Smith 3053d763cef2SBarry Smith Input Parameters: 3054d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3055d763cef2SBarry Smith . maxsteps - maximum number of iterations to use 3056d763cef2SBarry Smith - maxtime - final time to iterate to 3057d763cef2SBarry Smith 3058d763cef2SBarry Smith Options Database Keys: 3059d763cef2SBarry Smith . -ts_max_steps <maxsteps> - Sets maxsteps 30603bca7d26SBarry Smith . -ts_final_time <maxtime> - Sets maxtime 3061d763cef2SBarry Smith 3062d763cef2SBarry Smith Notes: 3063d763cef2SBarry Smith The default maximum number of iterations is 5000. Default time is 5.0 3064d763cef2SBarry Smith 3065d763cef2SBarry Smith Level: intermediate 3066d763cef2SBarry Smith 3067d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations 3068a43b19c4SJed Brown 3069a43b19c4SJed Brown .seealso: TSSetExactFinalTime() 3070d763cef2SBarry Smith @*/ 30717087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 3072d763cef2SBarry Smith { 3073d763cef2SBarry Smith PetscFunctionBegin; 30740700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3075c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3076c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 307739b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 307839b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 3079d763cef2SBarry Smith PetscFunctionReturn(0); 3080d763cef2SBarry Smith } 3081d763cef2SBarry Smith 3082d763cef2SBarry Smith /*@ 3083d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 3084d763cef2SBarry Smith for use by the TS routines. 3085d763cef2SBarry Smith 30863f9fe445SBarry Smith Logically Collective on TS and Vec 3087d763cef2SBarry Smith 3088d763cef2SBarry Smith Input Parameters: 3089d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 30900910c330SBarry Smith - u - the solution vector 3091d763cef2SBarry Smith 3092d763cef2SBarry Smith Level: beginner 3093d763cef2SBarry Smith 3094715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values 3095d763cef2SBarry Smith @*/ 30960910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 3097d763cef2SBarry Smith { 30988737fe31SLisandro Dalcin PetscErrorCode ierr; 3099496e6a7aSJed Brown DM dm; 31008737fe31SLisandro Dalcin 3101d763cef2SBarry Smith PetscFunctionBegin; 31020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31030910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 31040910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 31056bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 31060910c330SBarry Smith ts->vec_sol = u; 3107bbd56ea5SKarl Rupp 3108496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 31090910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 3110d763cef2SBarry Smith PetscFunctionReturn(0); 3111d763cef2SBarry Smith } 3112d763cef2SBarry Smith 311373b18844SBarry Smith /*@ 311473b18844SBarry Smith TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time 311573b18844SBarry Smith 311673b18844SBarry Smith Logically Collective on TS 311773b18844SBarry Smith 311873b18844SBarry Smith Input Parameters: 311973b18844SBarry Smith + ts - the TS context obtained from TSCreate() 312073b18844SBarry Smith . steps - number of steps to use 312173b18844SBarry Smith 312273b18844SBarry Smith Level: intermediate 312373b18844SBarry Smith 312473b18844SBarry Smith Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this 312573b18844SBarry Smith so as to integrate back to less than the original timestep 312673b18844SBarry Smith 312773b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations 312873b18844SBarry Smith 312973b18844SBarry Smith .seealso: TSSetExactFinalTime() 313073b18844SBarry Smith @*/ 313173b18844SBarry Smith PetscErrorCode TSAdjointSetSteps(TS ts,PetscInt steps) 313273b18844SBarry Smith { 313373b18844SBarry Smith PetscFunctionBegin; 313473b18844SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 313573b18844SBarry Smith PetscValidLogicalCollectiveInt(ts,steps,2); 313673b18844SBarry Smith if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps"); 313773b18844SBarry 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"); 313873b18844SBarry Smith ts->adjoint_max_steps = steps; 313973b18844SBarry Smith PetscFunctionReturn(0); 314073b18844SBarry Smith } 314173b18844SBarry Smith 3142c235aa8dSHong Zhang /*@ 3143715f1b00SHong Zhang TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial values and w.r.t. the problem parameters 31440cf82b59SBarry Smith for use by the TSAdjoint routines. 3145c235aa8dSHong Zhang 3146c235aa8dSHong Zhang Logically Collective on TS and Vec 3147c235aa8dSHong Zhang 3148c235aa8dSHong Zhang Input Parameters: 3149c235aa8dSHong Zhang + ts - the TS context obtained from TSCreate() 3150abc2977eSBarry 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 3151abc2977eSBarry Smith - mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters 3152c235aa8dSHong Zhang 3153c235aa8dSHong Zhang Level: beginner 3154c235aa8dSHong Zhang 3155abc2977eSBarry Smith Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime mu_i = df/dp|finaltime 31560cf82b59SBarry Smith 3157715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values 3158c235aa8dSHong Zhang @*/ 3159dfb21088SHong Zhang PetscErrorCode TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu) 3160c235aa8dSHong Zhang { 3161c235aa8dSHong Zhang PetscFunctionBegin; 3162c235aa8dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3163abc2977eSBarry Smith PetscValidPointer(lambda,2); 3164abc2977eSBarry Smith ts->vecs_sensi = lambda; 3165abc2977eSBarry Smith ts->vecs_sensip = mu; 3166dfb21088SHong 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"); 3167abc2977eSBarry Smith ts->numcost = numcost; 3168ad8e2604SHong Zhang PetscFunctionReturn(0); 3169ad8e2604SHong Zhang } 3170ad8e2604SHong Zhang 3171ad8e2604SHong Zhang /*@C 31720cf82b59SBarry 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. 3173ad8e2604SHong Zhang 3174ad8e2604SHong Zhang Logically Collective on TS 3175ad8e2604SHong Zhang 3176ad8e2604SHong Zhang Input Parameters: 3177ad8e2604SHong Zhang + ts - The TS context obtained from TSCreate() 3178ad8e2604SHong Zhang - func - The function 3179ad8e2604SHong Zhang 3180ad8e2604SHong Zhang Calling sequence of func: 31810cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx); 318205755b9cSHong Zhang + t - current timestep 31830cf82b59SBarry Smith . y - input vector (current ODE solution) 318405755b9cSHong Zhang . A - output matrix 318505755b9cSHong Zhang - ctx - [optional] user-defined function context 3186ad8e2604SHong Zhang 3187ad8e2604SHong Zhang Level: intermediate 3188ad8e2604SHong Zhang 31890cf82b59SBarry 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 31900cf82b59SBarry Smith 3191ad8e2604SHong Zhang .keywords: TS, sensitivity 3192ad8e2604SHong Zhang .seealso: 3193ad8e2604SHong Zhang @*/ 31945bf8c567SBarry Smith PetscErrorCode TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx) 3195ad8e2604SHong Zhang { 3196ad8e2604SHong Zhang PetscErrorCode ierr; 3197ad8e2604SHong Zhang 3198ad8e2604SHong Zhang PetscFunctionBegin; 3199ad8e2604SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 320023706b9aSHong Zhang PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 3201ad8e2604SHong Zhang 3202ad8e2604SHong Zhang ts->rhsjacobianp = func; 3203ad8e2604SHong Zhang ts->rhsjacobianpctx = ctx; 3204ad8e2604SHong Zhang if(Amat) { 3205ad8e2604SHong Zhang ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 3206ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 3207ad8e2604SHong Zhang ts->Jacp = Amat; 3208ad8e2604SHong Zhang } 3209ad8e2604SHong Zhang PetscFunctionReturn(0); 3210ad8e2604SHong Zhang } 3211ad8e2604SHong Zhang 32120cf82b59SBarry Smith /*@C 32135bf8c567SBarry Smith TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function. 3214ad8e2604SHong Zhang 3215ad8e2604SHong Zhang Collective on TS 3216ad8e2604SHong Zhang 3217ad8e2604SHong Zhang Input Parameters: 3218ad8e2604SHong Zhang . ts - The TS context obtained from TSCreate() 3219ad8e2604SHong Zhang 3220ad8e2604SHong Zhang Level: developer 3221ad8e2604SHong Zhang 3222ad8e2604SHong Zhang .keywords: TS, sensitivity 32235bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian() 3224ad8e2604SHong Zhang @*/ 32255bf8c567SBarry Smith PetscErrorCode TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat) 3226ad8e2604SHong Zhang { 3227ad8e2604SHong Zhang PetscErrorCode ierr; 3228ad8e2604SHong Zhang 3229ad8e2604SHong Zhang PetscFunctionBegin; 3230ad8e2604SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3231ad8e2604SHong Zhang PetscValidHeaderSpecific(X,VEC_CLASSID,3); 3232ad8e2604SHong Zhang PetscValidPointer(Amat,4); 3233ad8e2604SHong Zhang 3234ad8e2604SHong Zhang PetscStackPush("TS user JacobianP function for sensitivity analysis"); 3235ad8e2604SHong Zhang ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr); 3236ad8e2604SHong Zhang PetscStackPop; 3237c235aa8dSHong Zhang PetscFunctionReturn(0); 3238c235aa8dSHong Zhang } 3239c235aa8dSHong Zhang 32406fd0887fSHong Zhang /*@C 3241dfb21088SHong Zhang TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions 32426fd0887fSHong Zhang 32436fd0887fSHong Zhang Logically Collective on TS 32446fd0887fSHong Zhang 32456fd0887fSHong Zhang Input Parameters: 32466fd0887fSHong Zhang + ts - the TS context obtained from TSCreate() 3247abc2977eSBarry Smith . numcost - number of gradients to be computed, this is the number of cost functions 32483d1d12c6SHong Zhang . costintegral - vector that stores the integral values 32490cf82b59SBarry Smith . rf - routine for evaluating the integrand function 3250b612ec54SBarry Smith . drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y 3251b612ec54SBarry Smith . drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p 3252feaa1ddbSSatish Balay . fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run 3253b612ec54SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL) 32546fd0887fSHong Zhang 32550cf82b59SBarry Smith Calling sequence of rf: 32563d1d12c6SHong Zhang $ PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx); 32576fd0887fSHong Zhang 3258b612ec54SBarry Smith Calling sequence of drdyf: 32590cf82b59SBarry Smith $ PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx); 3260b612ec54SBarry Smith 3261b612ec54SBarry Smith Calling sequence of drdpf: 32620cf82b59SBarry Smith $ PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx); 3263b612ec54SBarry Smith 3264b612ec54SBarry Smith Level: intermediate 32656fd0887fSHong Zhang 3266715f1b00SHong Zhang Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions 32670cf82b59SBarry Smith 32686fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function 32696fd0887fSHong Zhang 3270dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients() 32716fd0887fSHong Zhang @*/ 32723d1d12c6SHong Zhang PetscErrorCode TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*), 3273d8151eeaSBarry Smith PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*), 3274b1cb36f3SHong Zhang PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*), 3275b1cb36f3SHong Zhang PetscBool fwd,void *ctx) 32766fd0887fSHong Zhang { 32776fd0887fSHong Zhang PetscErrorCode ierr; 32786fd0887fSHong Zhang 32796fd0887fSHong Zhang PetscFunctionBegin; 32806fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 32813d1d12c6SHong Zhang if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3); 3282715f1b00SHong 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() or TSForwardSetIntegralGradients()"); 3283c72ed514SHong Zhang if (!ts->numcost) ts->numcost=numcost; 32846fd0887fSHong Zhang 32853d1d12c6SHong Zhang if (costintegral) { 32863d1d12c6SHong Zhang ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr); 32873d1d12c6SHong Zhang ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 32883d1d12c6SHong Zhang ts->vec_costintegral = costintegral; 3289afe7b317SHong Zhang } else { 3290afe7b317SHong Zhang if (!ts->vec_costintegral) { /* Create a seq vec if user does not provide one */ 3291afe7b317SHong Zhang ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr); 3292afe7b317SHong Zhang } else { 3293afe7b317SHong Zhang ierr = VecSet(ts->vec_costintegral,0.0);CHKERRQ(ierr); 3294afe7b317SHong Zhang } 3295afe7b317SHong Zhang } 3296afe7b317SHong Zhang if (!ts->vec_costintegrand) { 32972c39e106SBarry Smith ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr); 3298afe7b317SHong Zhang } else { 3299afe7b317SHong Zhang ierr = VecSet(ts->vec_costintegrand,0.0);CHKERRQ(ierr); 3300afe7b317SHong Zhang } 3301afe7b317SHong Zhang ts->costintegralfwd = fwd; /* Evaluate the cost integral in forward run if fwd is true */ 33020cf82b59SBarry Smith ts->costintegrand = rf; 330305755b9cSHong Zhang ts->costintegrandctx = ctx; 3304b612ec54SBarry Smith ts->drdyfunction = drdyf; 3305b612ec54SBarry Smith ts->drdpfunction = drdpf; 33066fd0887fSHong Zhang PetscFunctionReturn(0); 33076fd0887fSHong Zhang } 33086fd0887fSHong Zhang 330936eaed60SHong Zhang /*@ 3310dfb21088SHong Zhang TSGetCostIntegral - Returns the values of the integral term in the cost functions. 331136eaed60SHong Zhang It is valid to call the routine after a backward run. 331236eaed60SHong Zhang 331336eaed60SHong Zhang Not Collective 331436eaed60SHong Zhang 331536eaed60SHong Zhang Input Parameter: 331636eaed60SHong Zhang . ts - the TS context obtained from TSCreate() 331736eaed60SHong Zhang 331836eaed60SHong Zhang Output Parameter: 33192c39e106SBarry Smith . v - the vector containing the integrals for each cost function 332036eaed60SHong Zhang 332136eaed60SHong Zhang Level: intermediate 332236eaed60SHong Zhang 3323dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 332436eaed60SHong Zhang 332536eaed60SHong Zhang .keywords: TS, sensitivity analysis 332636eaed60SHong Zhang @*/ 3327dfb21088SHong Zhang PetscErrorCode TSGetCostIntegral(TS ts,Vec *v) 332836eaed60SHong Zhang { 332936eaed60SHong Zhang PetscFunctionBegin; 333036eaed60SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 333136eaed60SHong Zhang PetscValidPointer(v,2); 33322c39e106SBarry Smith *v = ts->vec_costintegral; 333336eaed60SHong Zhang PetscFunctionReturn(0); 333436eaed60SHong Zhang } 333536eaed60SHong Zhang 33366fd0887fSHong Zhang /*@ 3337022c081aSHong Zhang TSComputeCostIntegrand - Evaluates the integral function in the cost functions. 33386fd0887fSHong Zhang 33396fd0887fSHong Zhang Input Parameters: 33406fd0887fSHong Zhang + ts - the TS context 33416fd0887fSHong Zhang . t - current time 33420cf82b59SBarry Smith - y - state vector, i.e. current solution 33436fd0887fSHong Zhang 33446fd0887fSHong Zhang Output Parameter: 3345abc2977eSBarry Smith . q - vector of size numcost to hold the outputs 33466fd0887fSHong Zhang 33476fd0887fSHong Zhang Note: 33486fd0887fSHong Zhang Most users should not need to explicitly call this routine, as it 33496fd0887fSHong Zhang is used internally within the sensitivity analysis context. 33506fd0887fSHong Zhang 33516fd0887fSHong Zhang Level: developer 33526fd0887fSHong Zhang 33536fd0887fSHong Zhang .keywords: TS, compute 33546fd0887fSHong Zhang 3355dfb21088SHong Zhang .seealso: TSSetCostIntegrand() 33566fd0887fSHong Zhang @*/ 3357022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q) 33586fd0887fSHong Zhang { 33596fd0887fSHong Zhang PetscErrorCode ierr; 33606fd0887fSHong Zhang 33616fd0887fSHong Zhang PetscFunctionBegin; 33626fd0887fSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33630cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 33646fd0887fSHong Zhang PetscValidHeaderSpecific(q,VEC_CLASSID,4); 33656fd0887fSHong Zhang 33660cf82b59SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 3367e4680132SHong Zhang if (ts->costintegrand) { 3368e4680132SHong Zhang PetscStackPush("TS user integrand in the cost function"); 33690cf82b59SBarry Smith ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr); 33706fd0887fSHong Zhang PetscStackPop; 33716fd0887fSHong Zhang } else { 33726fd0887fSHong Zhang ierr = VecZeroEntries(q);CHKERRQ(ierr); 33736fd0887fSHong Zhang } 33746fd0887fSHong Zhang 33750cf82b59SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr); 33766fd0887fSHong Zhang PetscFunctionReturn(0); 33776fd0887fSHong Zhang } 33786fd0887fSHong Zhang 337905755b9cSHong Zhang /*@ 3380d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function. 338105755b9cSHong Zhang 338205755b9cSHong Zhang Collective on TS 338305755b9cSHong Zhang 338405755b9cSHong Zhang Input Parameters: 338505755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 338605755b9cSHong Zhang 338705755b9cSHong Zhang Notes: 3388d4aa0a58SBarry Smith TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation, 338905755b9cSHong Zhang so most users would not generally call this routine themselves. 339005755b9cSHong Zhang 339105755b9cSHong Zhang Level: developer 339205755b9cSHong Zhang 339305755b9cSHong Zhang .keywords: TS, sensitivity 3394d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction() 339505755b9cSHong Zhang @*/ 33960cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy) 339705755b9cSHong Zhang { 339805755b9cSHong Zhang PetscErrorCode ierr; 339905755b9cSHong Zhang 340005755b9cSHong Zhang PetscFunctionBegin; 340105755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34020cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 340305755b9cSHong Zhang 340405755b9cSHong Zhang PetscStackPush("TS user DRDY function for sensitivity analysis"); 34050cf82b59SBarry Smith ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr); 340605755b9cSHong Zhang PetscStackPop; 340705755b9cSHong Zhang PetscFunctionReturn(0); 340805755b9cSHong Zhang } 340905755b9cSHong Zhang 341005755b9cSHong Zhang /*@ 3411d4aa0a58SBarry Smith TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function. 341205755b9cSHong Zhang 341305755b9cSHong Zhang Collective on TS 341405755b9cSHong Zhang 341505755b9cSHong Zhang Input Parameters: 341605755b9cSHong Zhang . ts - The TS context obtained from TSCreate() 341705755b9cSHong Zhang 341805755b9cSHong Zhang Notes: 341905755b9cSHong Zhang TSDRDPFunction() is typically used for sensitivity implementation, 342005755b9cSHong Zhang so most users would not generally call this routine themselves. 342105755b9cSHong Zhang 342205755b9cSHong Zhang Level: developer 342305755b9cSHong Zhang 342405755b9cSHong Zhang .keywords: TS, sensitivity 3425d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction() 342605755b9cSHong Zhang @*/ 34270cf82b59SBarry Smith PetscErrorCode TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp) 342805755b9cSHong Zhang { 342905755b9cSHong Zhang PetscErrorCode ierr; 343005755b9cSHong Zhang 343105755b9cSHong Zhang PetscFunctionBegin; 343205755b9cSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 34330cf82b59SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 343405755b9cSHong Zhang 343505755b9cSHong Zhang PetscStackPush("TS user DRDP function for sensitivity analysis"); 34360cf82b59SBarry Smith ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr); 343705755b9cSHong Zhang PetscStackPop; 343805755b9cSHong Zhang PetscFunctionReturn(0); 343905755b9cSHong Zhang } 344005755b9cSHong Zhang 3441ac226902SBarry Smith /*@C 3442000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 34433f2090d5SJed Brown called once at the beginning of each time step. 3444000e7ae3SMatthew Knepley 34453f9fe445SBarry Smith Logically Collective on TS 3446000e7ae3SMatthew Knepley 3447000e7ae3SMatthew Knepley Input Parameters: 3448000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3449000e7ae3SMatthew Knepley - func - The function 3450000e7ae3SMatthew Knepley 3451000e7ae3SMatthew Knepley Calling sequence of func: 3452000e7ae3SMatthew Knepley . func (TS ts); 3453000e7ae3SMatthew Knepley 3454000e7ae3SMatthew Knepley Level: intermediate 3455000e7ae3SMatthew Knepley 3456000e7ae3SMatthew Knepley .keywords: TS, timestep 34579be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep() 3458000e7ae3SMatthew Knepley @*/ 34597087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3460000e7ae3SMatthew Knepley { 3461000e7ae3SMatthew Knepley PetscFunctionBegin; 34620700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3463ae60f76fSBarry Smith ts->prestep = func; 3464000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3465000e7ae3SMatthew Knepley } 3466000e7ae3SMatthew Knepley 346709ee8438SJed Brown /*@ 34683f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 34693f2090d5SJed Brown 34703f2090d5SJed Brown Collective on TS 34713f2090d5SJed Brown 34723f2090d5SJed Brown Input Parameters: 34733f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 34743f2090d5SJed Brown 34753f2090d5SJed Brown Notes: 34763f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 34773f2090d5SJed Brown so most users would not generally call this routine themselves. 34783f2090d5SJed Brown 34793f2090d5SJed Brown Level: developer 34803f2090d5SJed Brown 34813f2090d5SJed Brown .keywords: TS, timestep 34829be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 34833f2090d5SJed Brown @*/ 34847087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 34853f2090d5SJed Brown { 34863f2090d5SJed Brown PetscErrorCode ierr; 34873f2090d5SJed Brown 34883f2090d5SJed Brown PetscFunctionBegin; 34890700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3490ae60f76fSBarry Smith if (ts->prestep) { 3491ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 3492312ce896SJed Brown } 34933f2090d5SJed Brown PetscFunctionReturn(0); 34943f2090d5SJed Brown } 34953f2090d5SJed Brown 3496b8123daeSJed Brown /*@C 3497b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3498b8123daeSJed Brown called once at the beginning of each stage. 3499b8123daeSJed Brown 3500b8123daeSJed Brown Logically Collective on TS 3501b8123daeSJed Brown 3502b8123daeSJed Brown Input Parameters: 3503b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3504b8123daeSJed Brown - func - The function 3505b8123daeSJed Brown 3506b8123daeSJed Brown Calling sequence of func: 3507b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3508b8123daeSJed Brown 3509b8123daeSJed Brown Level: intermediate 3510b8123daeSJed Brown 3511b8123daeSJed Brown Note: 3512b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3513*80275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 3514b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3515b8123daeSJed Brown 3516b8123daeSJed Brown .keywords: TS, timestep 35179be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3518b8123daeSJed Brown @*/ 3519b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3520b8123daeSJed Brown { 3521b8123daeSJed Brown PetscFunctionBegin; 3522b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3523ae60f76fSBarry Smith ts->prestage = func; 3524b8123daeSJed Brown PetscFunctionReturn(0); 3525b8123daeSJed Brown } 3526b8123daeSJed Brown 35279be3e283SDebojyoti Ghosh /*@C 35289be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 35299be3e283SDebojyoti Ghosh called once at the end of each stage. 35309be3e283SDebojyoti Ghosh 35319be3e283SDebojyoti Ghosh Logically Collective on TS 35329be3e283SDebojyoti Ghosh 35339be3e283SDebojyoti Ghosh Input Parameters: 35349be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 35359be3e283SDebojyoti Ghosh - func - The function 35369be3e283SDebojyoti Ghosh 35379be3e283SDebojyoti Ghosh Calling sequence of func: 35389be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 35399be3e283SDebojyoti Ghosh 35409be3e283SDebojyoti Ghosh Level: intermediate 35419be3e283SDebojyoti Ghosh 35429be3e283SDebojyoti Ghosh Note: 35439be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3544*80275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 35459be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 35469be3e283SDebojyoti Ghosh 35479be3e283SDebojyoti Ghosh .keywords: TS, timestep 35489be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 35499be3e283SDebojyoti Ghosh @*/ 35509be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 35519be3e283SDebojyoti Ghosh { 35529be3e283SDebojyoti Ghosh PetscFunctionBegin; 35539be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 35549be3e283SDebojyoti Ghosh ts->poststage = func; 35559be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 35569be3e283SDebojyoti Ghosh } 35579be3e283SDebojyoti Ghosh 3558c688d042SShri Abhyankar /*@C 3559c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3560c688d042SShri Abhyankar called once at the end of each step evaluation. 3561c688d042SShri Abhyankar 3562c688d042SShri Abhyankar Logically Collective on TS 3563c688d042SShri Abhyankar 3564c688d042SShri Abhyankar Input Parameters: 3565c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3566c688d042SShri Abhyankar - func - The function 3567c688d042SShri Abhyankar 3568c688d042SShri Abhyankar Calling sequence of func: 3569c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3570c688d042SShri Abhyankar 3571c688d042SShri Abhyankar Level: intermediate 3572c688d042SShri Abhyankar 3573c688d042SShri Abhyankar Note: 35741785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 35751785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3576e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3577e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3578e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3579c688d042SShri Abhyankar 3580c688d042SShri Abhyankar .keywords: TS, timestep 3581c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3582c688d042SShri Abhyankar @*/ 3583c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3584c688d042SShri Abhyankar { 3585c688d042SShri Abhyankar PetscFunctionBegin; 3586c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3587c688d042SShri Abhyankar ts->postevaluate = func; 3588c688d042SShri Abhyankar PetscFunctionReturn(0); 3589c688d042SShri Abhyankar } 3590c688d042SShri Abhyankar 3591b8123daeSJed Brown /*@ 3592b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3593b8123daeSJed Brown 3594b8123daeSJed Brown Collective on TS 3595b8123daeSJed Brown 3596b8123daeSJed Brown Input Parameters: 3597b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 35989be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3599b8123daeSJed Brown 3600b8123daeSJed Brown Notes: 3601b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3602b8123daeSJed Brown most users would not generally call this routine themselves. 3603b8123daeSJed Brown 3604b8123daeSJed Brown Level: developer 3605b8123daeSJed Brown 3606b8123daeSJed Brown .keywords: TS, timestep 36079be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3608b8123daeSJed Brown @*/ 3609b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3610b8123daeSJed Brown { 3611b8123daeSJed Brown PetscErrorCode ierr; 3612b8123daeSJed Brown 3613b8123daeSJed Brown PetscFunctionBegin; 3614b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3615ae60f76fSBarry Smith if (ts->prestage) { 3616ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3617b8123daeSJed Brown } 3618b8123daeSJed Brown PetscFunctionReturn(0); 3619b8123daeSJed Brown } 3620b8123daeSJed Brown 36219be3e283SDebojyoti Ghosh /*@ 36229be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 36239be3e283SDebojyoti Ghosh 36249be3e283SDebojyoti Ghosh Collective on TS 36259be3e283SDebojyoti Ghosh 36269be3e283SDebojyoti Ghosh Input Parameters: 36279be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 36289be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 36299be3e283SDebojyoti Ghosh stageindex - Stage number 36309be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 36319be3e283SDebojyoti Ghosh of stages) with the stage solutions 36329be3e283SDebojyoti Ghosh 36339be3e283SDebojyoti Ghosh Notes: 36349be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 36359be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 36369be3e283SDebojyoti Ghosh 36379be3e283SDebojyoti Ghosh Level: developer 36389be3e283SDebojyoti Ghosh 36399be3e283SDebojyoti Ghosh .keywords: TS, timestep 36409be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 36419be3e283SDebojyoti Ghosh @*/ 36429be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 36439be3e283SDebojyoti Ghosh { 36449be3e283SDebojyoti Ghosh PetscErrorCode ierr; 36459be3e283SDebojyoti Ghosh 36469be3e283SDebojyoti Ghosh PetscFunctionBegin; 36479be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 36484beae5d8SLisandro Dalcin if (ts->poststage) { 36499be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 36509be3e283SDebojyoti Ghosh } 36519be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 36529be3e283SDebojyoti Ghosh } 36539be3e283SDebojyoti Ghosh 3654c688d042SShri Abhyankar /*@ 3655c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3656c688d042SShri Abhyankar 3657c688d042SShri Abhyankar Collective on TS 3658c688d042SShri Abhyankar 3659c688d042SShri Abhyankar Input Parameters: 3660c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3661c688d042SShri Abhyankar 3662c688d042SShri Abhyankar Notes: 3663c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3664c688d042SShri Abhyankar most users would not generally call this routine themselves. 3665c688d042SShri Abhyankar 3666c688d042SShri Abhyankar Level: developer 3667c688d042SShri Abhyankar 3668c688d042SShri Abhyankar .keywords: TS, timestep 3669c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3670c688d042SShri Abhyankar @*/ 3671c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3672c688d042SShri Abhyankar { 3673c688d042SShri Abhyankar PetscErrorCode ierr; 3674c688d042SShri Abhyankar 3675c688d042SShri Abhyankar PetscFunctionBegin; 3676c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3677c688d042SShri Abhyankar if (ts->postevaluate) { 3678c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3679c688d042SShri Abhyankar } 3680c688d042SShri Abhyankar PetscFunctionReturn(0); 3681c688d042SShri Abhyankar } 3682c688d042SShri Abhyankar 3683ac226902SBarry Smith /*@C 3684000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 36853f2090d5SJed Brown called once at the end of each time step. 3686000e7ae3SMatthew Knepley 36873f9fe445SBarry Smith Logically Collective on TS 3688000e7ae3SMatthew Knepley 3689000e7ae3SMatthew Knepley Input Parameters: 3690000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3691000e7ae3SMatthew Knepley - func - The function 3692000e7ae3SMatthew Knepley 3693000e7ae3SMatthew Knepley Calling sequence of func: 3694b8123daeSJed Brown $ func (TS ts); 3695000e7ae3SMatthew Knepley 36961785ff2aSShri Abhyankar Notes: 36971785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 36981785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 36991785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 37001785ff2aSShri Abhyankar 3701000e7ae3SMatthew Knepley Level: intermediate 3702000e7ae3SMatthew Knepley 3703000e7ae3SMatthew Knepley .keywords: TS, timestep 3704*80275a0aSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime() 3705000e7ae3SMatthew Knepley @*/ 37067087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3707000e7ae3SMatthew Knepley { 3708000e7ae3SMatthew Knepley PetscFunctionBegin; 37090700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3710ae60f76fSBarry Smith ts->poststep = func; 3711000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3712000e7ae3SMatthew Knepley } 3713000e7ae3SMatthew Knepley 371409ee8438SJed Brown /*@ 37153f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 37163f2090d5SJed Brown 37173f2090d5SJed Brown Collective on TS 37183f2090d5SJed Brown 37193f2090d5SJed Brown Input Parameters: 37203f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 37213f2090d5SJed Brown 37223f2090d5SJed Brown Notes: 37233f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 37243f2090d5SJed Brown so most users would not generally call this routine themselves. 37253f2090d5SJed Brown 37263f2090d5SJed Brown Level: developer 37273f2090d5SJed Brown 37283f2090d5SJed Brown .keywords: TS, timestep 37293f2090d5SJed Brown @*/ 37307087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 37313f2090d5SJed Brown { 37323f2090d5SJed Brown PetscErrorCode ierr; 37333f2090d5SJed Brown 37343f2090d5SJed Brown PetscFunctionBegin; 37350700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3736ae60f76fSBarry Smith if (ts->poststep) { 3737ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 373872ac3e02SJed Brown } 37393f2090d5SJed Brown PetscFunctionReturn(0); 37403f2090d5SJed Brown } 37413f2090d5SJed Brown 3742d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3743d763cef2SBarry Smith 3744d763cef2SBarry Smith /*@C 3745a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3746d763cef2SBarry Smith timestep to display the iteration's progress. 3747d763cef2SBarry Smith 37483f9fe445SBarry Smith Logically Collective on TS 3749d763cef2SBarry Smith 3750d763cef2SBarry Smith Input Parameters: 3751d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3752e213d8f1SJed Brown . monitor - monitoring routine 3753329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 37540298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3755b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 37560298fd71SBarry Smith (may be NULL) 3757d763cef2SBarry Smith 3758e213d8f1SJed Brown Calling sequence of monitor: 37590910c330SBarry Smith $ int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3760d763cef2SBarry Smith 3761d763cef2SBarry Smith + ts - the TS context 376263e21af5SBarry 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) 37631f06c33eSBarry Smith . time - current time 37640910c330SBarry Smith . u - current iterate 3765d763cef2SBarry Smith - mctx - [optional] monitoring context 3766d763cef2SBarry Smith 3767d763cef2SBarry Smith Notes: 3768d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3769d763cef2SBarry Smith already has been loaded. 3770d763cef2SBarry Smith 3771025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each TS object 3772025f1a04SBarry Smith 3773d763cef2SBarry Smith Level: intermediate 3774d763cef2SBarry Smith 3775d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3776d763cef2SBarry Smith 3777a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3778d763cef2SBarry Smith @*/ 3779c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3780d763cef2SBarry Smith { 378178064530SBarry Smith PetscErrorCode ierr; 378278064530SBarry Smith PetscInt i; 378378064530SBarry Smith PetscBool identical; 378478064530SBarry Smith 3785d763cef2SBarry Smith PetscFunctionBegin; 37860700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 378778064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 378878064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 378978064530SBarry Smith if (identical) PetscFunctionReturn(0); 379078064530SBarry Smith } 379117186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3792d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 37938704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3794d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3795d763cef2SBarry Smith PetscFunctionReturn(0); 3796d763cef2SBarry Smith } 3797d763cef2SBarry Smith 3798d763cef2SBarry Smith /*@C 3799a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3800d763cef2SBarry Smith 38013f9fe445SBarry Smith Logically Collective on TS 3802d763cef2SBarry Smith 3803d763cef2SBarry Smith Input Parameters: 3804d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3805d763cef2SBarry Smith 3806d763cef2SBarry Smith Notes: 3807d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3808d763cef2SBarry Smith 3809d763cef2SBarry Smith Level: intermediate 3810d763cef2SBarry Smith 3811d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3812d763cef2SBarry Smith 3813a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3814d763cef2SBarry Smith @*/ 38157087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3816d763cef2SBarry Smith { 3817d952e501SBarry Smith PetscErrorCode ierr; 3818d952e501SBarry Smith PetscInt i; 3819d952e501SBarry Smith 3820d763cef2SBarry Smith PetscFunctionBegin; 38210700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3822d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 38238704b422SBarry Smith if (ts->monitordestroy[i]) { 38248704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3825d952e501SBarry Smith } 3826d952e501SBarry Smith } 3827d763cef2SBarry Smith ts->numbermonitors = 0; 3828d763cef2SBarry Smith PetscFunctionReturn(0); 3829d763cef2SBarry Smith } 3830d763cef2SBarry Smith 3831721cd6eeSBarry Smith /*@C 3832721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 38335516499fSSatish Balay 38345516499fSSatish Balay Level: intermediate 383541251cbbSSatish Balay 38365516499fSSatish Balay .keywords: TS, set, monitor 38375516499fSSatish Balay 383863e21af5SBarry Smith .seealso: TSMonitorSet() 383941251cbbSSatish Balay @*/ 3840721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3841d763cef2SBarry Smith { 3842dfbe8321SBarry Smith PetscErrorCode ierr; 3843721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 384441aca3d6SBarry Smith PetscBool iascii,ibinary; 3845d132466eSBarry Smith 3846d763cef2SBarry Smith PetscFunctionBegin; 38474d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 384841aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 384941aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3850721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 385141aca3d6SBarry Smith if (iascii) { 3852649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 385363e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 385463e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 385563e21af5SBarry Smith } else { 38568392e04aSShri 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); 385763e21af5SBarry Smith } 3858649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 385941aca3d6SBarry Smith } else if (ibinary) { 386041aca3d6SBarry Smith PetscMPIInt rank; 386141aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 386241aca3d6SBarry Smith if (!rank) { 3863450a797fSBarry Smith PetscBool skipHeader; 3864450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3865450a797fSBarry Smith 3866450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3867450a797fSBarry Smith if (!skipHeader) { 3868450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3869450a797fSBarry Smith } 387041aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 387141aca3d6SBarry Smith } else { 387241aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 387341aca3d6SBarry Smith } 387441aca3d6SBarry Smith } 3875721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3876d763cef2SBarry Smith PetscFunctionReturn(0); 3877d763cef2SBarry Smith } 3878d763cef2SBarry Smith 38799110b2e7SHong Zhang /*@C 38809110b2e7SHong Zhang TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every 38819110b2e7SHong Zhang timestep to display the iteration's progress. 38829110b2e7SHong Zhang 38839110b2e7SHong Zhang Logically Collective on TS 38849110b2e7SHong Zhang 38859110b2e7SHong Zhang Input Parameters: 38869110b2e7SHong Zhang + ts - the TS context obtained from TSCreate() 38879110b2e7SHong Zhang . adjointmonitor - monitoring routine 38889110b2e7SHong Zhang . adjointmctx - [optional] user-defined context for private data for the 38899110b2e7SHong Zhang monitor routine (use NULL if no context is desired) 38909110b2e7SHong Zhang - adjointmonitordestroy - [optional] routine that frees monitor context 38919110b2e7SHong Zhang (may be NULL) 38929110b2e7SHong Zhang 38939110b2e7SHong Zhang Calling sequence of monitor: 38949110b2e7SHong Zhang $ int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx) 38959110b2e7SHong Zhang 38969110b2e7SHong Zhang + ts - the TS context 38979110b2e7SHong 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 38989110b2e7SHong Zhang been interpolated to) 38999110b2e7SHong Zhang . time - current time 39009110b2e7SHong Zhang . u - current iterate 39019110b2e7SHong Zhang . numcost - number of cost functionos 39029110b2e7SHong Zhang . lambda - sensitivities to initial conditions 39039110b2e7SHong Zhang . mu - sensitivities to parameters 39049110b2e7SHong Zhang - adjointmctx - [optional] adjoint monitoring context 39059110b2e7SHong Zhang 39069110b2e7SHong Zhang Notes: 39079110b2e7SHong Zhang This routine adds an additional monitor to the list of monitors that 39089110b2e7SHong Zhang already has been loaded. 39099110b2e7SHong Zhang 39109110b2e7SHong Zhang Fortran notes: Only a single monitor function can be set for each TS object 39119110b2e7SHong Zhang 39129110b2e7SHong Zhang Level: intermediate 39139110b2e7SHong Zhang 39149110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 39159110b2e7SHong Zhang 39169110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel() 39179110b2e7SHong Zhang @*/ 39189110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**)) 39199110b2e7SHong Zhang { 392078064530SBarry Smith PetscErrorCode ierr; 392178064530SBarry Smith PetscInt i; 392278064530SBarry Smith PetscBool identical; 392378064530SBarry Smith 39249110b2e7SHong Zhang PetscFunctionBegin; 39259110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 392678064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 392778064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr); 392878064530SBarry Smith if (identical) PetscFunctionReturn(0); 392978064530SBarry Smith } 39309110b2e7SHong Zhang if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set"); 39319110b2e7SHong Zhang ts->adjointmonitor[ts->numberadjointmonitors] = adjointmonitor; 39329110b2e7SHong Zhang ts->adjointmonitordestroy[ts->numberadjointmonitors] = adjointmdestroy; 39339110b2e7SHong Zhang ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx; 39349110b2e7SHong Zhang PetscFunctionReturn(0); 39359110b2e7SHong Zhang } 39369110b2e7SHong Zhang 39379110b2e7SHong Zhang /*@C 39389110b2e7SHong Zhang TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object. 39399110b2e7SHong Zhang 39409110b2e7SHong Zhang Logically Collective on TS 39419110b2e7SHong Zhang 39429110b2e7SHong Zhang Input Parameters: 39439110b2e7SHong Zhang . ts - the TS context obtained from TSCreate() 39449110b2e7SHong Zhang 39459110b2e7SHong Zhang Notes: 39469110b2e7SHong Zhang There is no way to remove a single, specific monitor. 39479110b2e7SHong Zhang 39489110b2e7SHong Zhang Level: intermediate 39499110b2e7SHong Zhang 39509110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor 39519110b2e7SHong Zhang 39529110b2e7SHong Zhang .seealso: TSAdjointMonitorSet() 39539110b2e7SHong Zhang @*/ 39549110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorCancel(TS ts) 39559110b2e7SHong Zhang { 39569110b2e7SHong Zhang PetscErrorCode ierr; 39579110b2e7SHong Zhang PetscInt i; 39589110b2e7SHong Zhang 39599110b2e7SHong Zhang PetscFunctionBegin; 39609110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 39619110b2e7SHong Zhang for (i=0; i<ts->numberadjointmonitors; i++) { 39629110b2e7SHong Zhang if (ts->adjointmonitordestroy[i]) { 39639110b2e7SHong Zhang ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 39649110b2e7SHong Zhang } 39659110b2e7SHong Zhang } 39669110b2e7SHong Zhang ts->numberadjointmonitors = 0; 39679110b2e7SHong Zhang PetscFunctionReturn(0); 39689110b2e7SHong Zhang } 39699110b2e7SHong Zhang 3970721cd6eeSBarry Smith /*@C 3971721cd6eeSBarry Smith TSAdjointMonitorDefault - the default monitor of adjoint computations 3972110eb670SHong Zhang 3973110eb670SHong Zhang Level: intermediate 3974110eb670SHong Zhang 3975110eb670SHong Zhang .keywords: TS, set, monitor 3976110eb670SHong Zhang 3977110eb670SHong Zhang .seealso: TSAdjointMonitorSet() 3978110eb670SHong Zhang @*/ 3979721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf) 3980110eb670SHong Zhang { 3981110eb670SHong Zhang PetscErrorCode ierr; 3982721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 3983110eb670SHong Zhang 3984110eb670SHong Zhang PetscFunctionBegin; 3985110eb670SHong Zhang PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3986721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3987110eb670SHong Zhang ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3988110eb670SHong 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); 3989110eb670SHong Zhang ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3990721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3991110eb670SHong Zhang PetscFunctionReturn(0); 3992110eb670SHong Zhang } 3993110eb670SHong Zhang 3994cd652676SJed Brown /*@ 3995cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3996cd652676SJed Brown 3997cd652676SJed Brown Collective on TS 3998cd652676SJed Brown 3999cd652676SJed Brown Input Argument: 4000cd652676SJed Brown + ts - time stepping context 4001cd652676SJed Brown - t - time to interpolate to 4002cd652676SJed Brown 4003cd652676SJed Brown Output Argument: 40040910c330SBarry Smith . U - state at given time 4005cd652676SJed Brown 4006cd652676SJed Brown Level: intermediate 4007cd652676SJed Brown 4008cd652676SJed Brown Developer Notes: 4009cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 4010cd652676SJed Brown 4011cd652676SJed Brown .keywords: TS, set 4012cd652676SJed Brown 4013874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 4014cd652676SJed Brown @*/ 40150910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 4016cd652676SJed Brown { 4017cd652676SJed Brown PetscErrorCode ierr; 4018cd652676SJed Brown 4019cd652676SJed Brown PetscFunctionBegin; 4020cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4021b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4022be5899b3SLisandro 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); 4023ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 40240910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 4025cd652676SJed Brown PetscFunctionReturn(0); 4026cd652676SJed Brown } 4027cd652676SJed Brown 4028d763cef2SBarry Smith /*@ 40296d9e5789SSean Farley TSStep - Steps one time step 4030d763cef2SBarry Smith 4031d763cef2SBarry Smith Collective on TS 4032d763cef2SBarry Smith 4033d763cef2SBarry Smith Input Parameter: 4034d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4035d763cef2SBarry Smith 403627829d71SBarry Smith Level: developer 4037d763cef2SBarry Smith 4038b8123daeSJed Brown Notes: 403927829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 404027829d71SBarry Smith 4041b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 4042b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 4043b8123daeSJed Brown 404425cb2221SBarry Smith This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the 404525cb2221SBarry Smith time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 404625cb2221SBarry Smith 4047d763cef2SBarry Smith .keywords: TS, timestep, solve 4048d763cef2SBarry Smith 40499be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 4050d763cef2SBarry Smith @*/ 4051193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 4052d763cef2SBarry Smith { 4053dfbe8321SBarry Smith PetscErrorCode ierr; 4054fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 4055be5899b3SLisandro Dalcin PetscReal ptime; 4056d763cef2SBarry Smith 4057d763cef2SBarry Smith PetscFunctionBegin; 40580700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4059fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 4060fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 4061fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 4062fffbeea8SBarry Smith " type = {Preprint},\n" 4063fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 4064fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 4065302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 4066fffbeea8SBarry Smith 4067d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 406868bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4069d405a339SMatthew Knepley 4070a6772fa2SLisandro 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()"); 4071be5899b3SLisandro 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"); 4072a6772fa2SLisandro Dalcin 4073be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 4074362cd11cSLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 4075be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 4076e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 4077d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 4078193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 4079d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 4080be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 4081be5899b3SLisandro Dalcin ts->steps++; ts->total_steps++; 4082be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 408328d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 4084362cd11cSLisandro Dalcin 4085362cd11cSLisandro Dalcin if (ts->reason < 0) { 4086cef5090cSJed Brown if (ts->errorifstepfailed) { 408708c7845fSBarry 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]); 408808c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 4089d2daff3dSHong Zhang } 409008c7845fSBarry Smith } else if (!ts->reason) { 409108c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 409208c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 409308c7845fSBarry Smith } 409408c7845fSBarry Smith PetscFunctionReturn(0); 409508c7845fSBarry Smith } 409608c7845fSBarry Smith 409708c7845fSBarry Smith /*@ 4098b957a604SHong Zhang TSAdjointStep - Steps one time step backward in the adjoint run 409908c7845fSBarry Smith 410008c7845fSBarry Smith Collective on TS 410108c7845fSBarry Smith 410208c7845fSBarry Smith Input Parameter: 410308c7845fSBarry Smith . ts - the TS context obtained from TSCreate() 410408c7845fSBarry Smith 41056a4d4014SLisandro Dalcin Level: intermediate 41066a4d4014SLisandro Dalcin 4107b957a604SHong Zhang .keywords: TS, adjoint, step 41086a4d4014SLisandro Dalcin 4109b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve() 41106a4d4014SLisandro Dalcin @*/ 411108c7845fSBarry Smith PetscErrorCode TSAdjointStep(TS ts) 41126a4d4014SLisandro Dalcin { 411308c7845fSBarry Smith DM dm; 41146a4d4014SLisandro Dalcin PetscErrorCode ierr; 41156a4d4014SLisandro Dalcin 41166a4d4014SLisandro Dalcin PetscFunctionBegin; 41174a2ae208SSatish Balay PetscValidHeaderSpecific(ts,TS_CLASSID,1); 411808c7845fSBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 411908c7845fSBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 4120d763cef2SBarry Smith 4121685405a1SBarry Smith ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr); 4122d763cef2SBarry Smith 4123be5899b3SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 4124be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime; 412542f2b339SBarry 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); 4126be5899b3SLisandro Dalcin ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 412742f2b339SBarry Smith ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr); 41288d0ad7a8SHong Zhang ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr); 4129be5899b3SLisandro Dalcin ts->steps++; ts->total_steps--; 4130362cd11cSLisandro Dalcin 4131362cd11cSLisandro Dalcin if (ts->reason < 0) { 4132cef5090cSJed Brown if (ts->errorifstepfailed) { 41336c4ed002SBarry 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]); 41346c4ed002SBarry 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]); 41356c4ed002SBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 4136cef5090cSJed Brown } 4137362cd11cSLisandro Dalcin } else if (!ts->reason) { 413873b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4139362cd11cSLisandro Dalcin } 4140d763cef2SBarry Smith PetscFunctionReturn(0); 4141d763cef2SBarry Smith } 4142d763cef2SBarry Smith 41437cbde773SLisandro Dalcin /*@ 41447cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 41457cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 41467cbde773SLisandro Dalcin 41477cbde773SLisandro Dalcin Collective on TS 41487cbde773SLisandro Dalcin 41497cbde773SLisandro Dalcin Input Arguments: 41507cbde773SLisandro Dalcin + ts - time stepping context 41517cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 41527cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 41537cbde773SLisandro Dalcin 41547cbde773SLisandro Dalcin Output Arguments: 41557cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 41567cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 41577cbde773SLisandro Dalcin 41587cbde773SLisandro Dalcin Level: advanced 41597cbde773SLisandro Dalcin 41607cbde773SLisandro Dalcin Notes: 41617cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 41627cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 41637cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 41647cbde773SLisandro Dalcin 41657cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 41667cbde773SLisandro Dalcin @*/ 41677cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 41687cbde773SLisandro Dalcin { 41697cbde773SLisandro Dalcin PetscErrorCode ierr; 41707cbde773SLisandro Dalcin 41717cbde773SLisandro Dalcin PetscFunctionBegin; 41727cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41737cbde773SLisandro Dalcin PetscValidType(ts,1); 41747cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 41757cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 41767cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 41777cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 41787cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 41797cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 41807cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 41817cbde773SLisandro Dalcin PetscFunctionReturn(0); 41827cbde773SLisandro Dalcin } 41837cbde773SLisandro Dalcin 418405175c85SJed Brown /*@ 418505175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 418605175c85SJed Brown 41871c3436cfSJed Brown Collective on TS 418805175c85SJed Brown 418905175c85SJed Brown Input Arguments: 41901c3436cfSJed Brown + ts - time stepping context 41911c3436cfSJed Brown . order - desired order of accuracy 41920298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 419305175c85SJed Brown 419405175c85SJed Brown Output Arguments: 41950910c330SBarry Smith . U - state at the end of the current step 419605175c85SJed Brown 419705175c85SJed Brown Level: advanced 419805175c85SJed Brown 4199108c343cSJed Brown Notes: 4200108c343cSJed Brown This function cannot be called until all stages have been evaluated. 4201108c343cSJed 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. 4202108c343cSJed Brown 42031c3436cfSJed Brown .seealso: TSStep(), TSAdapt 420405175c85SJed Brown @*/ 42050910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 420605175c85SJed Brown { 420705175c85SJed Brown PetscErrorCode ierr; 420805175c85SJed Brown 420905175c85SJed Brown PetscFunctionBegin; 421005175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 421105175c85SJed Brown PetscValidType(ts,1); 42120910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 4213ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 42140910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 421505175c85SJed Brown PetscFunctionReturn(0); 421605175c85SJed Brown } 421705175c85SJed Brown 4218b1cb36f3SHong Zhang /*@ 4219b1cb36f3SHong Zhang TSForwardCostIntegral - Evaluate the cost integral in the forward run. 4220b1cb36f3SHong Zhang 4221b1cb36f3SHong Zhang Collective on TS 4222b1cb36f3SHong Zhang 4223b1cb36f3SHong Zhang Input Arguments: 4224b1cb36f3SHong Zhang . ts - time stepping context 4225b1cb36f3SHong Zhang 4226b1cb36f3SHong Zhang Level: advanced 4227b1cb36f3SHong Zhang 4228b1cb36f3SHong Zhang Notes: 4229b1cb36f3SHong Zhang This function cannot be called until TSStep() has been completed. 4230b1cb36f3SHong Zhang 4231b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral() 4232b1cb36f3SHong Zhang @*/ 4233b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts) 4234b1cb36f3SHong Zhang { 4235b1cb36f3SHong Zhang PetscErrorCode ierr; 4236b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4237b1cb36f3SHong 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); 4238b1cb36f3SHong Zhang ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr); 4239b1cb36f3SHong Zhang PetscFunctionReturn(0); 4240b1cb36f3SHong Zhang } 4241d67e68b7SBarry Smith 4242d763cef2SBarry Smith /*@ 4243d763cef2SBarry Smith TSSolve - Steps the requested number of timesteps. 4244d763cef2SBarry Smith 4245d763cef2SBarry Smith Collective on TS 4246d763cef2SBarry Smith 4247d763cef2SBarry Smith Input Parameter: 4248d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 424963e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 425063e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 42515a3a76d0SJed Brown 4252d763cef2SBarry Smith Level: beginner 4253d763cef2SBarry Smith 42545a3a76d0SJed Brown Notes: 42555a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 42565a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 42575a3a76d0SJed Brown stepped over the final time. 42585a3a76d0SJed Brown 4259d763cef2SBarry Smith .keywords: TS, timestep, solve 4260d763cef2SBarry Smith 426163e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 4262d763cef2SBarry Smith @*/ 4263cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 4264d763cef2SBarry Smith { 4265b06615a5SLisandro Dalcin Vec solution; 4266d763cef2SBarry Smith PetscErrorCode ierr; 4267d763cef2SBarry Smith 4268d763cef2SBarry Smith PetscFunctionBegin; 4269d763cef2SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4270f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4271feed9e9dSBarry Smith 427249354f04SShri 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 */ 4273b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 42740910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 4275b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4276b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4277b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 42785a3a76d0SJed Brown } 42790910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4280715f1b00SHong Zhang if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 4281bbd56ea5SKarl Rupp } else if (u) { 42820910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 42835a3a76d0SJed Brown } 4284b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 428568bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4286a6772fa2SLisandro Dalcin 4287a6772fa2SLisandro 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()"); 4288a6772fa2SLisandro 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"); 4289a6772fa2SLisandro Dalcin 4290715f1b00SHong Zhang if (ts->forward_solve) { 4291715f1b00SHong Zhang ierr = TSForwardSetUp(ts);CHKERRQ(ierr); 4292715f1b00SHong Zhang } 4293715f1b00SHong Zhang 4294e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 4295715f1b00SHong Zhang restarts the step after an event. Resetting these counters in such case causes 4296e7069c78SShri TSTrajectory to incorrectly save the output files 4297e7069c78SShri */ 4298715f1b00SHong Zhang /* reset time step and iteration counters */ 4299193ac0bcSJed Brown ts->steps = 0; 43005ef26d82SJed Brown ts->ksp_its = 0; 43015ef26d82SJed Brown ts->snes_its = 0; 4302c610991cSLisandro Dalcin ts->num_snes_failures = 0; 4303c610991cSLisandro Dalcin ts->reject = 0; 4304193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 4305193ac0bcSJed Brown 4306ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4307f05ece33SBarry Smith 4308193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4309193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4310a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4311cc708dedSBarry Smith ts->solvetime = ts->ptime; 4312a6772fa2SLisandro Dalcin solution = ts->vec_sol; 4313be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 4314db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4315db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4316e7069c78SShri 4317938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 43186427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 4319e7069c78SShri 432028d5b5d6SLisandro Dalcin ts->steprollback = PETSC_FALSE; 432128d5b5d6SLisandro Dalcin ts->steprestart = PETSC_TRUE; 43226427ac75SLisandro Dalcin 4323e1a7a14fSJed Brown while (!ts->reason) { 4324938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 43259687d888SLisandro Dalcin if (!ts->steprollback) { 43269687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 43279687d888SLisandro Dalcin } 4328193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 4329e783b05fSHong 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. */ 4330b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 4331b1cb36f3SHong Zhang } 4332715f1b00SHong Zhang if (!ts->steprollback && ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 4333715f1b00SHong Zhang ierr = TSForwardStep(ts);CHKERRQ(ierr); 4334715f1b00SHong Zhang } 433510b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 4336e783b05fSHong 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. */ 4337e783b05fSHong Zhang if (!ts->steprollback) { 4338938c94caSShri Abhyankar ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 43391eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 4340aeb4809dSShri Abhyankar } 4341193ac0bcSJed Brown } 4342938c94caSShri Abhyankar ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 43436427ac75SLisandro Dalcin 434449354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 43450910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4346cc708dedSBarry Smith ts->solvetime = ts->max_time; 4347b06615a5SLisandro Dalcin solution = u; 434863e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 43490574a7fbSJed Brown } else { 4350ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4351cc708dedSBarry Smith ts->solvetime = ts->ptime; 4352b06615a5SLisandro Dalcin solution = ts->vec_sol; 43530574a7fbSJed Brown } 4354193ac0bcSJed Brown } 4355d2daff3dSHong Zhang 4356ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 435763e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 435856f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4359ef222394SBarry Smith if (ts->adjoint_solve) { 4360ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 43612b0a91c0SBarry Smith } 4362d763cef2SBarry Smith PetscFunctionReturn(0); 4363d763cef2SBarry Smith } 4364d763cef2SBarry Smith 4365b1cb36f3SHong Zhang /*@ 4366b1cb36f3SHong Zhang TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run. 4367b1cb36f3SHong Zhang 4368b1cb36f3SHong Zhang Collective on TS 4369b1cb36f3SHong Zhang 4370b1cb36f3SHong Zhang Input Arguments: 4371b1cb36f3SHong Zhang . ts - time stepping context 4372b1cb36f3SHong Zhang 4373b1cb36f3SHong Zhang Level: advanced 4374b1cb36f3SHong Zhang 4375b1cb36f3SHong Zhang Notes: 4376b1cb36f3SHong Zhang This function cannot be called until TSAdjointStep() has been completed. 4377b1cb36f3SHong Zhang 4378b1cb36f3SHong Zhang .seealso: TSAdjointSolve(), TSAdjointStep 4379b1cb36f3SHong Zhang @*/ 4380b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts) 4381b1cb36f3SHong Zhang { 4382b1cb36f3SHong Zhang PetscErrorCode ierr; 4383b1cb36f3SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4384b1cb36f3SHong 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); 4385b1cb36f3SHong Zhang ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr); 4386b1cb36f3SHong Zhang PetscFunctionReturn(0); 4387b1cb36f3SHong Zhang } 4388b1cb36f3SHong Zhang 4389c88f2d44SBarry Smith /*@ 4390c88f2d44SBarry Smith TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE 4391c88f2d44SBarry Smith 4392c88f2d44SBarry Smith Collective on TS 4393c88f2d44SBarry Smith 4394c88f2d44SBarry Smith Input Parameter: 43952c39e106SBarry Smith . ts - the TS context obtained from TSCreate() 4396c88f2d44SBarry Smith 4397e87fd094SBarry Smith Options Database: 4398715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values 4399e87fd094SBarry Smith 4400c88f2d44SBarry Smith Level: intermediate 4401c88f2d44SBarry Smith 4402c88f2d44SBarry Smith Notes: 4403c88f2d44SBarry Smith This must be called after a call to TSSolve() that solves the forward problem 4404c88f2d44SBarry Smith 440573b18844SBarry Smith By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time 440673b18844SBarry Smith 4407c88f2d44SBarry Smith .keywords: TS, timestep, solve 4408c88f2d44SBarry Smith 4409b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep() 4410c88f2d44SBarry Smith @*/ 44112c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts) 4412c88f2d44SBarry Smith { 4413c88f2d44SBarry Smith PetscErrorCode ierr; 4414c88f2d44SBarry Smith 4415c88f2d44SBarry Smith PetscFunctionBegin; 4416c88f2d44SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4417c88f2d44SBarry Smith ierr = TSAdjointSetUp(ts);CHKERRQ(ierr); 441868bece0bSHong Zhang 4419c88f2d44SBarry Smith /* reset time step and iteration counters */ 4420c88f2d44SBarry Smith ts->steps = 0; 4421c88f2d44SBarry Smith ts->ksp_its = 0; 4422c88f2d44SBarry Smith ts->snes_its = 0; 4423c88f2d44SBarry Smith ts->num_snes_failures = 0; 4424c88f2d44SBarry Smith ts->reject = 0; 4425c88f2d44SBarry Smith ts->reason = TS_CONVERGED_ITERATING; 4426c88f2d44SBarry Smith 442773b18844SBarry Smith if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps; 4428c88f2d44SBarry Smith 442973b18844SBarry Smith if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS; 4430c88f2d44SBarry Smith while (!ts->reason) { 443155c52731SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 44329110b2e7SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 44336427ac75SLisandro Dalcin ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr); 4434616946c1SHong Zhang ierr = TSAdjointStep(ts);CHKERRQ(ierr); 4435b1cb36f3SHong Zhang if (ts->vec_costintegral && !ts->costintegralfwd) { 4436b1cb36f3SHong Zhang ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr); 4437b1cb36f3SHong Zhang } 4438c88f2d44SBarry Smith } 443926656371SHong Zhang ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr); 444026656371SHong Zhang ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr); 4441c88f2d44SBarry Smith ts->solvetime = ts->ptime; 4442e210cd0eSHong Zhang ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr); 4443685405a1SBarry Smith ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr); 4444c88f2d44SBarry Smith PetscFunctionReturn(0); 4445c88f2d44SBarry Smith } 4446c88f2d44SBarry Smith 44477db568b7SBarry Smith /*@C 4448228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4449228d79bcSJed Brown 4450228d79bcSJed Brown Collective on TS 4451228d79bcSJed Brown 4452228d79bcSJed Brown Input Parameters: 4453228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 4454228d79bcSJed Brown . step - step number that has just completed 4455228d79bcSJed Brown . ptime - model time of the state 44560910c330SBarry Smith - u - state at the current model time 4457228d79bcSJed Brown 4458228d79bcSJed Brown Notes: 44597db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 44607db568b7SBarry Smith Users would almost never call this routine directly. 4461228d79bcSJed Brown 446263e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 446363e21af5SBarry Smith 44647db568b7SBarry Smith Level: developer 4465228d79bcSJed Brown 4466228d79bcSJed Brown .keywords: TS, timestep 4467228d79bcSJed Brown @*/ 44680910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4469d763cef2SBarry Smith { 4470d6152f81SLisandro Dalcin DM dm; 4471a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 4472d6152f81SLisandro Dalcin PetscErrorCode ierr; 4473d763cef2SBarry Smith 4474d763cef2SBarry Smith PetscFunctionBegin; 4475b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4476b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4477d6152f81SLisandro Dalcin 4478d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4479d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4480d6152f81SLisandro Dalcin 44815edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 4482d763cef2SBarry Smith for (i=0; i<n; i++) { 44830910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4484d763cef2SBarry Smith } 44855edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 4486d763cef2SBarry Smith PetscFunctionReturn(0); 4487d763cef2SBarry Smith } 4488d763cef2SBarry Smith 44897db568b7SBarry Smith /*@C 44909110b2e7SHong Zhang TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet() 44919110b2e7SHong Zhang 44929110b2e7SHong Zhang Collective on TS 44939110b2e7SHong Zhang 44949110b2e7SHong Zhang Input Parameters: 44959110b2e7SHong Zhang + ts - time stepping context obtained from TSCreate() 44969110b2e7SHong Zhang . step - step number that has just completed 44979110b2e7SHong Zhang . ptime - model time of the state 44989110b2e7SHong Zhang . u - state at the current model time 44999110b2e7SHong Zhang . numcost - number of cost functions (dimension of lambda or mu) 45009110b2e7SHong Zhang . lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables 45019110b2e7SHong Zhang - mu - vectors containing the gradients of the cost functions with respect to the problem parameters 45029110b2e7SHong Zhang 45039110b2e7SHong Zhang Notes: 45047db568b7SBarry Smith TSAdjointMonitor() is typically used automatically within the time stepping implementations. 45057db568b7SBarry Smith Users would almost never call this routine directly. 45069110b2e7SHong Zhang 45077db568b7SBarry Smith Level: developer 45089110b2e7SHong Zhang 45099110b2e7SHong Zhang .keywords: TS, timestep 45109110b2e7SHong Zhang @*/ 45119110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu) 45129110b2e7SHong Zhang { 45139110b2e7SHong Zhang PetscErrorCode ierr; 45149110b2e7SHong Zhang PetscInt i,n = ts->numberadjointmonitors; 45159110b2e7SHong Zhang 45169110b2e7SHong Zhang PetscFunctionBegin; 45179110b2e7SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45189110b2e7SHong Zhang PetscValidHeaderSpecific(u,VEC_CLASSID,4); 45199110b2e7SHong Zhang ierr = VecLockPush(u);CHKERRQ(ierr); 45209110b2e7SHong Zhang for (i=0; i<n; i++) { 45219110b2e7SHong Zhang ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr); 45229110b2e7SHong Zhang } 45239110b2e7SHong Zhang ierr = VecLockPop(u);CHKERRQ(ierr); 45249110b2e7SHong Zhang PetscFunctionReturn(0); 45259110b2e7SHong Zhang } 45269110b2e7SHong Zhang 4527d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 4528d763cef2SBarry Smith /*@C 45297db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4530a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 4531d763cef2SBarry Smith 4532d763cef2SBarry Smith Collective on TS 4533d763cef2SBarry Smith 4534d763cef2SBarry Smith Input Parameters: 4535d763cef2SBarry Smith + host - the X display to open, or null for the local machine 4536d763cef2SBarry Smith . label - the title to put in the title bar 45377c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 4538a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 4539a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4540d763cef2SBarry Smith 4541d763cef2SBarry Smith Output Parameter: 45420b039ecaSBarry Smith . ctx - the context 4543d763cef2SBarry Smith 4544d763cef2SBarry Smith Options Database Key: 45454f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 45467db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 45477db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 45487db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 45497db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4550b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4551d763cef2SBarry Smith 4552d763cef2SBarry Smith Notes: 4553a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 4554d763cef2SBarry Smith 45557db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 45567db568b7SBarry Smith 45577db568b7SBarry 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 45587db568b7SBarry 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 45597db568b7SBarry Smith as the first argument. 45607db568b7SBarry Smith 45617db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 45627db568b7SBarry Smith 4563d763cef2SBarry Smith Level: intermediate 4564d763cef2SBarry Smith 45657db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 4566d763cef2SBarry Smith 45677db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 45687db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 45697db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 45707db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 45717db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 45727c922b88SBarry Smith 4573d763cef2SBarry Smith @*/ 4574a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4575d763cef2SBarry Smith { 45767f52daa2SLisandro Dalcin PetscDraw draw; 4577dfbe8321SBarry Smith PetscErrorCode ierr; 4578d763cef2SBarry Smith 4579d763cef2SBarry Smith PetscFunctionBegin; 4580b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 45817f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 45827f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 45837f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4584287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 45857f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4586a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4587d763cef2SBarry Smith PetscFunctionReturn(0); 4588d763cef2SBarry Smith } 4589d763cef2SBarry Smith 4590b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4591d763cef2SBarry Smith { 45920b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4593c32365f1SBarry Smith PetscReal x = ptime,y; 4594dfbe8321SBarry Smith PetscErrorCode ierr; 4595d763cef2SBarry Smith 4596d763cef2SBarry Smith PetscFunctionBegin; 459763e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4598b06615a5SLisandro Dalcin if (!step) { 4599a9f9c1f6SBarry Smith PetscDrawAxis axis; 4600a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 46016934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr); 4602a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4603a9f9c1f6SBarry Smith } 4604c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 460508763aebSBarry Smith y = PetscLog10Real(y); 46060b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4607b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 46080b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 46096934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 46103923b477SBarry Smith } 4611d763cef2SBarry Smith PetscFunctionReturn(0); 4612d763cef2SBarry Smith } 4613d763cef2SBarry Smith 4614d763cef2SBarry Smith /*@C 4615a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4616a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4617d763cef2SBarry Smith 46180b039ecaSBarry Smith Collective on TSMonitorLGCtx 4619d763cef2SBarry Smith 4620d763cef2SBarry Smith Input Parameter: 46210b039ecaSBarry Smith . ctx - the monitor context 4622d763cef2SBarry Smith 4623d763cef2SBarry Smith Level: intermediate 4624d763cef2SBarry Smith 4625d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 4626d763cef2SBarry Smith 46274f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4628d763cef2SBarry Smith @*/ 4629a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4630d763cef2SBarry Smith { 4631dfbe8321SBarry Smith PetscErrorCode ierr; 4632d763cef2SBarry Smith 4633d763cef2SBarry Smith PetscFunctionBegin; 46347684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 46357684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 46367684fa3eSBarry Smith } 46370b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 463831152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4639387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4640387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4641387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 46420b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4643d763cef2SBarry Smith PetscFunctionReturn(0); 4644d763cef2SBarry Smith } 4645d763cef2SBarry Smith 4646d763cef2SBarry Smith /*@ 4647b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4648d763cef2SBarry Smith 4649d763cef2SBarry Smith Not Collective 4650d763cef2SBarry Smith 4651d763cef2SBarry Smith Input Parameter: 4652d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4653d763cef2SBarry Smith 4654d763cef2SBarry Smith Output Parameter: 465563e21af5SBarry Smith . t - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime(). 4656d763cef2SBarry Smith 4657d763cef2SBarry Smith Level: beginner 4658d763cef2SBarry Smith 4659b8123daeSJed Brown Note: 4660b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 46619be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4662b8123daeSJed Brown 466363e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime() 4664d763cef2SBarry Smith 4665d763cef2SBarry Smith .keywords: TS, get, time 4666d763cef2SBarry Smith @*/ 46677087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4668d763cef2SBarry Smith { 4669d763cef2SBarry Smith PetscFunctionBegin; 46700700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4671f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4672d763cef2SBarry Smith *t = ts->ptime; 4673d763cef2SBarry Smith PetscFunctionReturn(0); 4674d763cef2SBarry Smith } 4675d763cef2SBarry Smith 4676e5e524a1SHong Zhang /*@ 4677e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4678e5e524a1SHong Zhang 4679e5e524a1SHong Zhang Not Collective 4680e5e524a1SHong Zhang 4681e5e524a1SHong Zhang Input Parameter: 4682e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4683e5e524a1SHong Zhang 4684e5e524a1SHong Zhang Output Parameter: 4685e5e524a1SHong Zhang . t - the previous time 4686e5e524a1SHong Zhang 4687e5e524a1SHong Zhang Level: beginner 4688e5e524a1SHong Zhang 4689e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep() 4690e5e524a1SHong Zhang 4691e5e524a1SHong Zhang .keywords: TS, get, time 4692e5e524a1SHong Zhang @*/ 4693e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4694e5e524a1SHong Zhang { 4695e5e524a1SHong Zhang PetscFunctionBegin; 4696e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4697e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4698e5e524a1SHong Zhang *t = ts->ptime_prev; 4699e5e524a1SHong Zhang PetscFunctionReturn(0); 4700e5e524a1SHong Zhang } 4701e5e524a1SHong Zhang 47026a4d4014SLisandro Dalcin /*@ 47036a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 47046a4d4014SLisandro Dalcin 47053f9fe445SBarry Smith Logically Collective on TS 47066a4d4014SLisandro Dalcin 47076a4d4014SLisandro Dalcin Input Parameters: 47086a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 47096a4d4014SLisandro Dalcin - time - the time 47106a4d4014SLisandro Dalcin 47116a4d4014SLisandro Dalcin Level: intermediate 47126a4d4014SLisandro Dalcin 47136a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration() 47146a4d4014SLisandro Dalcin 47156a4d4014SLisandro Dalcin .keywords: TS, set, time 47166a4d4014SLisandro Dalcin @*/ 47177087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 47186a4d4014SLisandro Dalcin { 47196a4d4014SLisandro Dalcin PetscFunctionBegin; 47200700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4721c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 47226a4d4014SLisandro Dalcin ts->ptime = t; 47236a4d4014SLisandro Dalcin PetscFunctionReturn(0); 47246a4d4014SLisandro Dalcin } 47256a4d4014SLisandro Dalcin 4726d763cef2SBarry Smith /*@C 4727d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4728d763cef2SBarry Smith TS options in the database. 4729d763cef2SBarry Smith 47303f9fe445SBarry Smith Logically Collective on TS 4731d763cef2SBarry Smith 4732d763cef2SBarry Smith Input Parameter: 4733d763cef2SBarry Smith + ts - The TS context 4734d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4735d763cef2SBarry Smith 4736d763cef2SBarry Smith Notes: 4737d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4738d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4739d763cef2SBarry Smith hyphen. 4740d763cef2SBarry Smith 4741d763cef2SBarry Smith Level: advanced 4742d763cef2SBarry Smith 4743d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4744d763cef2SBarry Smith 4745d763cef2SBarry Smith .seealso: TSSetFromOptions() 4746d763cef2SBarry Smith 4747d763cef2SBarry Smith @*/ 47487087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4749d763cef2SBarry Smith { 4750dfbe8321SBarry Smith PetscErrorCode ierr; 4751089b2837SJed Brown SNES snes; 4752d763cef2SBarry Smith 4753d763cef2SBarry Smith PetscFunctionBegin; 47540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4755d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4756089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4757089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4758d763cef2SBarry Smith PetscFunctionReturn(0); 4759d763cef2SBarry Smith } 4760d763cef2SBarry Smith 4761d763cef2SBarry Smith /*@C 4762d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4763d763cef2SBarry Smith TS options in the database. 4764d763cef2SBarry Smith 47653f9fe445SBarry Smith Logically Collective on TS 4766d763cef2SBarry Smith 4767d763cef2SBarry Smith Input Parameter: 4768d763cef2SBarry Smith + ts - The TS context 4769d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4770d763cef2SBarry Smith 4771d763cef2SBarry Smith Notes: 4772d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4773d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4774d763cef2SBarry Smith hyphen. 4775d763cef2SBarry Smith 4776d763cef2SBarry Smith Level: advanced 4777d763cef2SBarry Smith 4778d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4779d763cef2SBarry Smith 4780d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4781d763cef2SBarry Smith 4782d763cef2SBarry Smith @*/ 47837087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4784d763cef2SBarry Smith { 4785dfbe8321SBarry Smith PetscErrorCode ierr; 4786089b2837SJed Brown SNES snes; 4787d763cef2SBarry Smith 4788d763cef2SBarry Smith PetscFunctionBegin; 47890700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4790d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4791089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4792089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4793d763cef2SBarry Smith PetscFunctionReturn(0); 4794d763cef2SBarry Smith } 4795d763cef2SBarry Smith 4796d763cef2SBarry Smith /*@C 4797d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4798d763cef2SBarry Smith TS options in the database. 4799d763cef2SBarry Smith 4800d763cef2SBarry Smith Not Collective 4801d763cef2SBarry Smith 4802d763cef2SBarry Smith Input Parameter: 4803d763cef2SBarry Smith . ts - The TS context 4804d763cef2SBarry Smith 4805d763cef2SBarry Smith Output Parameter: 4806d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4807d763cef2SBarry Smith 4808d763cef2SBarry Smith Notes: On the fortran side, the user should pass in a string 'prifix' of 4809d763cef2SBarry Smith sufficient length to hold the prefix. 4810d763cef2SBarry Smith 4811d763cef2SBarry Smith Level: intermediate 4812d763cef2SBarry Smith 4813d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4814d763cef2SBarry Smith 4815d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4816d763cef2SBarry Smith @*/ 48177087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4818d763cef2SBarry Smith { 4819dfbe8321SBarry Smith PetscErrorCode ierr; 4820d763cef2SBarry Smith 4821d763cef2SBarry Smith PetscFunctionBegin; 48220700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 48234482741eSBarry Smith PetscValidPointer(prefix,2); 4824d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4825d763cef2SBarry Smith PetscFunctionReturn(0); 4826d763cef2SBarry Smith } 4827d763cef2SBarry Smith 4828d763cef2SBarry Smith /*@C 4829d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4830d763cef2SBarry Smith 4831d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4832d763cef2SBarry Smith 4833d763cef2SBarry Smith Input Parameter: 4834d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4835d763cef2SBarry Smith 4836d763cef2SBarry Smith Output Parameters: 4837e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4838e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4839e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4840e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4841d763cef2SBarry Smith 48420298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 4843d763cef2SBarry Smith 4844d763cef2SBarry Smith Level: intermediate 4845d763cef2SBarry Smith 4846*80275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 4847d763cef2SBarry Smith 4848d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4849d763cef2SBarry Smith @*/ 4850e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4851d763cef2SBarry Smith { 4852089b2837SJed Brown PetscErrorCode ierr; 485324989b8cSPeter Brune DM dm; 4854089b2837SJed Brown 4855d763cef2SBarry Smith PetscFunctionBegin; 485623a57915SBarry Smith if (Amat || Pmat) { 485723a57915SBarry Smith SNES snes; 4858089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 485923a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4860e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 486123a57915SBarry Smith } 486224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 486324989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4864d763cef2SBarry Smith PetscFunctionReturn(0); 4865d763cef2SBarry Smith } 4866d763cef2SBarry Smith 48672eca1d9cSJed Brown /*@C 48682eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 48692eca1d9cSJed Brown 48702eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 48712eca1d9cSJed Brown 48722eca1d9cSJed Brown Input Parameter: 48732eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 48742eca1d9cSJed Brown 48752eca1d9cSJed Brown Output Parameters: 4876e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4877e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 48782eca1d9cSJed Brown . f - The function to compute the matrices 48792eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 48802eca1d9cSJed Brown 48810298fd71SBarry Smith Notes: You can pass in NULL for any return argument you do not need. 48822eca1d9cSJed Brown 48832eca1d9cSJed Brown Level: advanced 48842eca1d9cSJed Brown 4885*80275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 48862eca1d9cSJed Brown 48872eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 48882eca1d9cSJed Brown @*/ 4889e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 48902eca1d9cSJed Brown { 4891089b2837SJed Brown PetscErrorCode ierr; 489224989b8cSPeter Brune DM dm; 48930910c330SBarry Smith 48942eca1d9cSJed Brown PetscFunctionBegin; 4895c0aab802Sstefano_zampini if (Amat || Pmat) { 4896c0aab802Sstefano_zampini SNES snes; 4897089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4898f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4899e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4900c0aab802Sstefano_zampini } 490124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 490224989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 49032eca1d9cSJed Brown PetscFunctionReturn(0); 49042eca1d9cSJed Brown } 49052eca1d9cSJed Brown 49061713a123SBarry Smith /*@C 490783a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 49081713a123SBarry Smith VecView() for the solution at each timestep 49091713a123SBarry Smith 49101713a123SBarry Smith Collective on TS 49111713a123SBarry Smith 49121713a123SBarry Smith Input Parameters: 49131713a123SBarry Smith + ts - the TS context 49141713a123SBarry Smith . step - current time-step 4915142b95e3SSatish Balay . ptime - current time 49160298fd71SBarry Smith - dummy - either a viewer or NULL 49171713a123SBarry Smith 491899fdda47SBarry Smith Options Database: 491999fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 492099fdda47SBarry Smith 4921387f4636SBarry 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 492299fdda47SBarry Smith will look bad 492399fdda47SBarry Smith 49241713a123SBarry Smith Level: intermediate 49251713a123SBarry Smith 49261713a123SBarry Smith .keywords: TS, vector, monitor, view 49271713a123SBarry Smith 4928a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 49291713a123SBarry Smith @*/ 49300910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 49311713a123SBarry Smith { 4932dfbe8321SBarry Smith PetscErrorCode ierr; 493383a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4934473a3ab2SBarry Smith PetscDraw draw; 49351713a123SBarry Smith 49361713a123SBarry Smith PetscFunctionBegin; 49376083293cSBarry Smith if (!step && ictx->showinitial) { 49386083293cSBarry Smith if (!ictx->initialsolution) { 49390910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 49401713a123SBarry Smith } 49410910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 49426083293cSBarry Smith } 4943b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 49440dcf80beSBarry Smith 49456083293cSBarry Smith if (ictx->showinitial) { 49466083293cSBarry Smith PetscReal pause; 49476083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 49486083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 49496083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 49506083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 49516083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 49526083293cSBarry Smith } 49530910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4954473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 495551fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4956473a3ab2SBarry Smith char time[32]; 4957473a3ab2SBarry Smith 4958473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 495985b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4960473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4961473a3ab2SBarry Smith h = yl + .95*(yr - yl); 496251fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4963473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4964473a3ab2SBarry Smith } 4965473a3ab2SBarry Smith 49666083293cSBarry Smith if (ictx->showinitial) { 49676083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 49686083293cSBarry Smith } 49691713a123SBarry Smith PetscFunctionReturn(0); 49701713a123SBarry Smith } 49711713a123SBarry Smith 49729110b2e7SHong Zhang /*@C 49739110b2e7SHong Zhang TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling 49749110b2e7SHong Zhang VecView() for the sensitivities to initial states at each timestep 49759110b2e7SHong Zhang 49769110b2e7SHong Zhang Collective on TS 49779110b2e7SHong Zhang 49789110b2e7SHong Zhang Input Parameters: 49799110b2e7SHong Zhang + ts - the TS context 49809110b2e7SHong Zhang . step - current time-step 49819110b2e7SHong Zhang . ptime - current time 49829110b2e7SHong Zhang . u - current state 49839110b2e7SHong Zhang . numcost - number of cost functions 49849110b2e7SHong Zhang . lambda - sensitivities to initial conditions 49859110b2e7SHong Zhang . mu - sensitivities to parameters 49869110b2e7SHong Zhang - dummy - either a viewer or NULL 49879110b2e7SHong Zhang 49889110b2e7SHong Zhang Level: intermediate 49899110b2e7SHong Zhang 49909110b2e7SHong Zhang .keywords: TS, vector, adjoint, monitor, view 49919110b2e7SHong Zhang 49929110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView() 49939110b2e7SHong Zhang @*/ 49949110b2e7SHong Zhang PetscErrorCode TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy) 49959110b2e7SHong Zhang { 49969110b2e7SHong Zhang PetscErrorCode ierr; 49979110b2e7SHong Zhang TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 49989110b2e7SHong Zhang PetscDraw draw; 4999a0046e2cSSatish Balay PetscReal xl,yl,xr,yr,h; 5000a0046e2cSSatish Balay char time[32]; 50019110b2e7SHong Zhang 50029110b2e7SHong Zhang PetscFunctionBegin; 50039110b2e7SHong Zhang if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 50049110b2e7SHong Zhang 50059110b2e7SHong Zhang ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr); 50069110b2e7SHong Zhang ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 50079110b2e7SHong Zhang ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 50089110b2e7SHong Zhang ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 50099110b2e7SHong Zhang h = yl + .95*(yr - yl); 50109110b2e7SHong Zhang ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 50119110b2e7SHong Zhang ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 50129110b2e7SHong Zhang PetscFunctionReturn(0); 50139110b2e7SHong Zhang } 50149110b2e7SHong Zhang 50152d5ee99bSBarry Smith /*@C 50162d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 50172d5ee99bSBarry Smith 50182d5ee99bSBarry Smith Collective on TS 50192d5ee99bSBarry Smith 50202d5ee99bSBarry Smith Input Parameters: 50212d5ee99bSBarry Smith + ts - the TS context 50222d5ee99bSBarry Smith . step - current time-step 50232d5ee99bSBarry Smith . ptime - current time 50242d5ee99bSBarry Smith - dummy - either a viewer or NULL 50252d5ee99bSBarry Smith 50262d5ee99bSBarry Smith Level: intermediate 50272d5ee99bSBarry Smith 50282d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 50292d5ee99bSBarry Smith 50302d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 50312d5ee99bSBarry Smith @*/ 50322d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 50332d5ee99bSBarry Smith { 50342d5ee99bSBarry Smith PetscErrorCode ierr; 50352d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 50362d5ee99bSBarry Smith PetscDraw draw; 50376934998bSLisandro Dalcin PetscDrawAxis axis; 50382d5ee99bSBarry Smith PetscInt n; 50392d5ee99bSBarry Smith PetscMPIInt size; 50406934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 50412d5ee99bSBarry Smith char time[32]; 50422d5ee99bSBarry Smith const PetscScalar *U; 50432d5ee99bSBarry Smith 50442d5ee99bSBarry Smith PetscFunctionBegin; 50456934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 50466934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 50472d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 50486934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 50492d5ee99bSBarry Smith 50502d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 50516934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 50526934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 50536934998bSLisandro Dalcin if (!step) { 50546934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 50556934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 50566934998bSLisandro Dalcin } 50572d5ee99bSBarry Smith 50582d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 50596934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 50606934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 5061a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 50626934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 50632d5ee99bSBarry Smith 50646934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 50656934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 50662d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 50674b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 506885b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 50692d5ee99bSBarry Smith h = yl + .95*(yr - yl); 507051fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 50712d5ee99bSBarry Smith } 50726934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 50732d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 507456d62c8fSLisandro Dalcin ierr = PetscDrawPause(draw);CHKERRQ(ierr); 50756934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 50762d5ee99bSBarry Smith PetscFunctionReturn(0); 50772d5ee99bSBarry Smith } 50782d5ee99bSBarry Smith 50796083293cSBarry Smith /*@C 508083a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 50816083293cSBarry Smith 50826083293cSBarry Smith Collective on TS 50836083293cSBarry Smith 50846083293cSBarry Smith Input Parameters: 50856083293cSBarry Smith . ctx - the monitor context 50866083293cSBarry Smith 50876083293cSBarry Smith Level: intermediate 50886083293cSBarry Smith 50896083293cSBarry Smith .keywords: TS, vector, monitor, view 50906083293cSBarry Smith 509183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 50926083293cSBarry Smith @*/ 509383a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 50946083293cSBarry Smith { 50956083293cSBarry Smith PetscErrorCode ierr; 50966083293cSBarry Smith 50976083293cSBarry Smith PetscFunctionBegin; 509883a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 509983a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 510083a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 51016083293cSBarry Smith PetscFunctionReturn(0); 51026083293cSBarry Smith } 51036083293cSBarry Smith 51046083293cSBarry Smith /*@C 510583a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 51066083293cSBarry Smith 51076083293cSBarry Smith Collective on TS 51086083293cSBarry Smith 51096083293cSBarry Smith Input Parameter: 51106083293cSBarry Smith . ts - time-step context 51116083293cSBarry Smith 51126083293cSBarry Smith Output Patameter: 51136083293cSBarry Smith . ctx - the monitor context 51146083293cSBarry Smith 511599fdda47SBarry Smith Options Database: 511699fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 511799fdda47SBarry Smith 51186083293cSBarry Smith Level: intermediate 51196083293cSBarry Smith 51206083293cSBarry Smith .keywords: TS, vector, monitor, view 51216083293cSBarry Smith 512283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 51236083293cSBarry Smith @*/ 512483a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 51256083293cSBarry Smith { 51266083293cSBarry Smith PetscErrorCode ierr; 51276083293cSBarry Smith 51286083293cSBarry Smith PetscFunctionBegin; 5129b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 513083a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 5131e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 5132bbd56ea5SKarl Rupp 513383a4ac43SBarry Smith (*ctx)->howoften = howoften; 5134473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 5135c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 5136473a3ab2SBarry Smith 5137473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 5138c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 51396083293cSBarry Smith PetscFunctionReturn(0); 51406083293cSBarry Smith } 51416083293cSBarry Smith 51423a471f94SBarry Smith /*@C 514383a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 51443a471f94SBarry Smith VecView() for the error at each timestep 51453a471f94SBarry Smith 51463a471f94SBarry Smith Collective on TS 51473a471f94SBarry Smith 51483a471f94SBarry Smith Input Parameters: 51493a471f94SBarry Smith + ts - the TS context 51503a471f94SBarry Smith . step - current time-step 51513a471f94SBarry Smith . ptime - current time 51520298fd71SBarry Smith - dummy - either a viewer or NULL 51533a471f94SBarry Smith 51543a471f94SBarry Smith Level: intermediate 51553a471f94SBarry Smith 51563a471f94SBarry Smith .keywords: TS, vector, monitor, view 51573a471f94SBarry Smith 51583a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 51593a471f94SBarry Smith @*/ 51600910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 51613a471f94SBarry Smith { 51623a471f94SBarry Smith PetscErrorCode ierr; 516383a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 516483a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 51653a471f94SBarry Smith Vec work; 51663a471f94SBarry Smith 51673a471f94SBarry Smith PetscFunctionBegin; 5168b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 51690910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 51703a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 51710910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 51723a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 51733a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 51743a471f94SBarry Smith PetscFunctionReturn(0); 51753a471f94SBarry Smith } 51763a471f94SBarry Smith 5177af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 51786c699258SBarry Smith /*@ 51792a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 51806c699258SBarry Smith 51813f9fe445SBarry Smith Logically Collective on TS and DM 51826c699258SBarry Smith 51836c699258SBarry Smith Input Parameters: 51842a808120SBarry Smith + ts - the ODE integrator object 51852a808120SBarry Smith - dm - the dm, cannot be NULL 51866c699258SBarry Smith 51876c699258SBarry Smith Level: intermediate 51886c699258SBarry Smith 51896c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 51906c699258SBarry Smith @*/ 51917087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 51926c699258SBarry Smith { 51936c699258SBarry Smith PetscErrorCode ierr; 5194089b2837SJed Brown SNES snes; 5195942e3340SBarry Smith DMTS tsdm; 51966c699258SBarry Smith 51976c699258SBarry Smith PetscFunctionBegin; 51980700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 51992a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 520070663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 5201942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 52022a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 5203942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 5204942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 520524989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 520624989b8cSPeter Brune tsdm->originaldm = dm; 520724989b8cSPeter Brune } 520824989b8cSPeter Brune } 52096bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 521024989b8cSPeter Brune } 52116c699258SBarry Smith ts->dm = dm; 5212bbd56ea5SKarl Rupp 5213089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 5214089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 52156c699258SBarry Smith PetscFunctionReturn(0); 52166c699258SBarry Smith } 52176c699258SBarry Smith 52186c699258SBarry Smith /*@ 52196c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 52206c699258SBarry Smith 52213f9fe445SBarry Smith Not Collective 52226c699258SBarry Smith 52236c699258SBarry Smith Input Parameter: 52246c699258SBarry Smith . ts - the preconditioner context 52256c699258SBarry Smith 52266c699258SBarry Smith Output Parameter: 52276c699258SBarry Smith . dm - the dm 52286c699258SBarry Smith 52296c699258SBarry Smith Level: intermediate 52306c699258SBarry Smith 52316c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 52326c699258SBarry Smith @*/ 52337087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 52346c699258SBarry Smith { 5235496e6a7aSJed Brown PetscErrorCode ierr; 5236496e6a7aSJed Brown 52376c699258SBarry Smith PetscFunctionBegin; 52380700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5239496e6a7aSJed Brown if (!ts->dm) { 5240ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 5241496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 5242496e6a7aSJed Brown } 52436c699258SBarry Smith *dm = ts->dm; 52446c699258SBarry Smith PetscFunctionReturn(0); 52456c699258SBarry Smith } 52461713a123SBarry Smith 52470f5c6efeSJed Brown /*@ 52480f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 52490f5c6efeSJed Brown 52503f9fe445SBarry Smith Logically Collective on SNES 52510f5c6efeSJed Brown 52520f5c6efeSJed Brown Input Parameter: 5253d42a1c89SJed Brown + snes - nonlinear solver 52540910c330SBarry Smith . U - the current state at which to evaluate the residual 5255d42a1c89SJed Brown - ctx - user context, must be a TS 52560f5c6efeSJed Brown 52570f5c6efeSJed Brown Output Parameter: 52580f5c6efeSJed Brown . F - the nonlinear residual 52590f5c6efeSJed Brown 52600f5c6efeSJed Brown Notes: 52610f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 52620f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 52630f5c6efeSJed Brown 52640f5c6efeSJed Brown Level: advanced 52650f5c6efeSJed Brown 52660f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 52670f5c6efeSJed Brown @*/ 52680910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 52690f5c6efeSJed Brown { 52700f5c6efeSJed Brown TS ts = (TS)ctx; 52710f5c6efeSJed Brown PetscErrorCode ierr; 52720f5c6efeSJed Brown 52730f5c6efeSJed Brown PetscFunctionBegin; 52740f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 52750910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 52760f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 52770f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 52780910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 52790f5c6efeSJed Brown PetscFunctionReturn(0); 52800f5c6efeSJed Brown } 52810f5c6efeSJed Brown 52820f5c6efeSJed Brown /*@ 52830f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 52840f5c6efeSJed Brown 52850f5c6efeSJed Brown Collective on SNES 52860f5c6efeSJed Brown 52870f5c6efeSJed Brown Input Parameter: 52880f5c6efeSJed Brown + snes - nonlinear solver 52890910c330SBarry Smith . U - the current state at which to evaluate the residual 52900f5c6efeSJed Brown - ctx - user context, must be a TS 52910f5c6efeSJed Brown 52920f5c6efeSJed Brown Output Parameter: 52930f5c6efeSJed Brown + A - the Jacobian 52940f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 52950f5c6efeSJed Brown - flag - indicates any structure change in the matrix 52960f5c6efeSJed Brown 52970f5c6efeSJed Brown Notes: 52980f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 52990f5c6efeSJed Brown 53000f5c6efeSJed Brown Level: developer 53010f5c6efeSJed Brown 53020f5c6efeSJed Brown .seealso: SNESSetJacobian() 53030f5c6efeSJed Brown @*/ 5304d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 53050f5c6efeSJed Brown { 53060f5c6efeSJed Brown TS ts = (TS)ctx; 53070f5c6efeSJed Brown PetscErrorCode ierr; 53080f5c6efeSJed Brown 53090f5c6efeSJed Brown PetscFunctionBegin; 53100f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 53110910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 53120f5c6efeSJed Brown PetscValidPointer(A,3); 531394ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 53140f5c6efeSJed Brown PetscValidPointer(B,4); 531594ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 53160f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5317d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 53180f5c6efeSJed Brown PetscFunctionReturn(0); 53190f5c6efeSJed Brown } 5320325fc9f4SBarry Smith 53210e4ef248SJed Brown /*@C 53229ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 53230e4ef248SJed Brown 53240e4ef248SJed Brown Collective on TS 53250e4ef248SJed Brown 53260e4ef248SJed Brown Input Arguments: 53270e4ef248SJed Brown + ts - time stepping context 53280e4ef248SJed Brown . t - time at which to evaluate 53290910c330SBarry Smith . U - state at which to evaluate 53300e4ef248SJed Brown - ctx - context 53310e4ef248SJed Brown 53320e4ef248SJed Brown Output Arguments: 53330e4ef248SJed Brown . F - right hand side 53340e4ef248SJed Brown 53350e4ef248SJed Brown Level: intermediate 53360e4ef248SJed Brown 53370e4ef248SJed Brown Notes: 53380e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 53390e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 53400e4ef248SJed Brown 53410e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 53420e4ef248SJed Brown @*/ 53430910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 53440e4ef248SJed Brown { 53450e4ef248SJed Brown PetscErrorCode ierr; 53460e4ef248SJed Brown Mat Arhs,Brhs; 53470e4ef248SJed Brown 53480e4ef248SJed Brown PetscFunctionBegin; 53490e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 5350d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 53510910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 53520e4ef248SJed Brown PetscFunctionReturn(0); 53530e4ef248SJed Brown } 53540e4ef248SJed Brown 53550e4ef248SJed Brown /*@C 53560e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 53570e4ef248SJed Brown 53580e4ef248SJed Brown Collective on TS 53590e4ef248SJed Brown 53600e4ef248SJed Brown Input Arguments: 53610e4ef248SJed Brown + ts - time stepping context 53620e4ef248SJed Brown . t - time at which to evaluate 53630910c330SBarry Smith . U - state at which to evaluate 53640e4ef248SJed Brown - ctx - context 53650e4ef248SJed Brown 53660e4ef248SJed Brown Output Arguments: 53670e4ef248SJed Brown + A - pointer to operator 53680e4ef248SJed Brown . B - pointer to preconditioning matrix 53690e4ef248SJed Brown - flg - matrix structure flag 53700e4ef248SJed Brown 53710e4ef248SJed Brown Level: intermediate 53720e4ef248SJed Brown 53730e4ef248SJed Brown Notes: 53740e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 53750e4ef248SJed Brown 53760e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 53770e4ef248SJed Brown @*/ 5378d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 53790e4ef248SJed Brown { 53800e4ef248SJed Brown PetscFunctionBegin; 53810e4ef248SJed Brown PetscFunctionReturn(0); 53820e4ef248SJed Brown } 53830e4ef248SJed Brown 53840026cea9SSean Farley /*@C 53850026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 53860026cea9SSean Farley 53870026cea9SSean Farley Collective on TS 53880026cea9SSean Farley 53890026cea9SSean Farley Input Arguments: 53900026cea9SSean Farley + ts - time stepping context 53910026cea9SSean Farley . t - time at which to evaluate 53920910c330SBarry Smith . U - state at which to evaluate 53930910c330SBarry Smith . Udot - time derivative of state vector 53940026cea9SSean Farley - ctx - context 53950026cea9SSean Farley 53960026cea9SSean Farley Output Arguments: 53970026cea9SSean Farley . F - left hand side 53980026cea9SSean Farley 53990026cea9SSean Farley Level: intermediate 54000026cea9SSean Farley 54010026cea9SSean Farley Notes: 54020910c330SBarry 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 54030026cea9SSean Farley user is required to write their own TSComputeIFunction. 54040026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 54050026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 54060026cea9SSean Farley 54079ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 54089ae8fd06SBarry Smith 54099ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 54100026cea9SSean Farley @*/ 54110910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 54120026cea9SSean Farley { 54130026cea9SSean Farley PetscErrorCode ierr; 54140026cea9SSean Farley Mat A,B; 54150026cea9SSean Farley 54160026cea9SSean Farley PetscFunctionBegin; 54170298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5418d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 54190910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 54200026cea9SSean Farley PetscFunctionReturn(0); 54210026cea9SSean Farley } 54220026cea9SSean Farley 54230026cea9SSean Farley /*@C 5424b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 54250026cea9SSean Farley 54260026cea9SSean Farley Collective on TS 54270026cea9SSean Farley 54280026cea9SSean Farley Input Arguments: 54290026cea9SSean Farley + ts - time stepping context 54300026cea9SSean Farley . t - time at which to evaluate 54310910c330SBarry Smith . U - state at which to evaluate 54320910c330SBarry Smith . Udot - time derivative of state vector 54330026cea9SSean Farley . shift - shift to apply 54340026cea9SSean Farley - ctx - context 54350026cea9SSean Farley 54360026cea9SSean Farley Output Arguments: 54370026cea9SSean Farley + A - pointer to operator 54380026cea9SSean Farley . B - pointer to preconditioning matrix 54390026cea9SSean Farley - flg - matrix structure flag 54400026cea9SSean Farley 5441b41af12eSJed Brown Level: advanced 54420026cea9SSean Farley 54430026cea9SSean Farley Notes: 54440026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 54450026cea9SSean Farley 5446b41af12eSJed Brown It is only appropriate for problems of the form 5447b41af12eSJed Brown 5448b41af12eSJed Brown $ M Udot = F(U,t) 5449b41af12eSJed Brown 5450b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5451b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5452b41af12eSJed Brown an implicit operator of the form 5453b41af12eSJed Brown 5454b41af12eSJed Brown $ shift*M + J 5455b41af12eSJed Brown 5456b41af12eSJed 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 5457b41af12eSJed Brown a copy of M or reassemble it when requested. 5458b41af12eSJed Brown 54590026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 54600026cea9SSean Farley @*/ 5461d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 54620026cea9SSean Farley { 5463b41af12eSJed Brown PetscErrorCode ierr; 5464b41af12eSJed Brown 54650026cea9SSean Farley PetscFunctionBegin; 546694ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5467b41af12eSJed Brown ts->ijacobian.shift = shift; 54680026cea9SSean Farley PetscFunctionReturn(0); 54690026cea9SSean Farley } 5470b41af12eSJed Brown 5471e817cc15SEmil Constantinescu /*@ 5472e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 5473e817cc15SEmil Constantinescu 5474e817cc15SEmil Constantinescu Not Collective 5475e817cc15SEmil Constantinescu 5476e817cc15SEmil Constantinescu Input Parameter: 5477e817cc15SEmil Constantinescu . ts - the TS context 5478e817cc15SEmil Constantinescu 5479e817cc15SEmil Constantinescu Output Parameter: 54804e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 5481e817cc15SEmil Constantinescu 5482e817cc15SEmil Constantinescu Level: beginner 5483e817cc15SEmil Constantinescu 5484e817cc15SEmil Constantinescu .keywords: TS, equation type 5485e817cc15SEmil Constantinescu 5486e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 5487e817cc15SEmil Constantinescu @*/ 5488e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5489e817cc15SEmil Constantinescu { 5490e817cc15SEmil Constantinescu PetscFunctionBegin; 5491e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5492e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 5493e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 5494e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5495e817cc15SEmil Constantinescu } 5496e817cc15SEmil Constantinescu 5497e817cc15SEmil Constantinescu /*@ 5498e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 5499e817cc15SEmil Constantinescu 5500e817cc15SEmil Constantinescu Not Collective 5501e817cc15SEmil Constantinescu 5502e817cc15SEmil Constantinescu Input Parameter: 5503e817cc15SEmil Constantinescu + ts - the TS context 55041297b224SEmil Constantinescu - equation_type - see TSEquationType 5505e817cc15SEmil Constantinescu 5506e817cc15SEmil Constantinescu Level: advanced 5507e817cc15SEmil Constantinescu 5508e817cc15SEmil Constantinescu .keywords: TS, equation type 5509e817cc15SEmil Constantinescu 5510e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 5511e817cc15SEmil Constantinescu @*/ 5512e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5513e817cc15SEmil Constantinescu { 5514e817cc15SEmil Constantinescu PetscFunctionBegin; 5515e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5516e817cc15SEmil Constantinescu ts->equation_type = equation_type; 5517e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5518e817cc15SEmil Constantinescu } 55190026cea9SSean Farley 55204af1b03aSJed Brown /*@ 55214af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 55224af1b03aSJed Brown 55234af1b03aSJed Brown Not Collective 55244af1b03aSJed Brown 55254af1b03aSJed Brown Input Parameter: 55264af1b03aSJed Brown . ts - the TS context 55274af1b03aSJed Brown 55284af1b03aSJed Brown Output Parameter: 55294af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 55304af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 55314af1b03aSJed Brown 5532487e0bb9SJed Brown Level: beginner 55334af1b03aSJed Brown 5534cd652676SJed Brown Notes: 5535cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 55364af1b03aSJed Brown 55374af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 55384af1b03aSJed Brown 55394af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 55404af1b03aSJed Brown @*/ 55414af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 55424af1b03aSJed Brown { 55434af1b03aSJed Brown PetscFunctionBegin; 55444af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 55454af1b03aSJed Brown PetscValidPointer(reason,2); 55464af1b03aSJed Brown *reason = ts->reason; 55474af1b03aSJed Brown PetscFunctionReturn(0); 55484af1b03aSJed Brown } 55494af1b03aSJed Brown 5550d6ad946cSShri Abhyankar /*@ 5551d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5552d6ad946cSShri Abhyankar 5553d6ad946cSShri Abhyankar Not Collective 5554d6ad946cSShri Abhyankar 5555d6ad946cSShri Abhyankar Input Parameter: 5556d6ad946cSShri Abhyankar + ts - the TS context 5557d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5558d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5559d6ad946cSShri Abhyankar 5560f5abba47SShri Abhyankar Level: advanced 5561d6ad946cSShri Abhyankar 5562d6ad946cSShri Abhyankar Notes: 5563d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 5564d6ad946cSShri Abhyankar 5565d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 5566d6ad946cSShri Abhyankar 5567d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5568d6ad946cSShri Abhyankar @*/ 5569d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5570d6ad946cSShri Abhyankar { 5571d6ad946cSShri Abhyankar PetscFunctionBegin; 5572d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5573d6ad946cSShri Abhyankar ts->reason = reason; 5574d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5575d6ad946cSShri Abhyankar } 5576d6ad946cSShri Abhyankar 5577cc708dedSBarry Smith /*@ 5578cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5579cc708dedSBarry Smith 5580cc708dedSBarry Smith Not Collective 5581cc708dedSBarry Smith 5582cc708dedSBarry Smith Input Parameter: 5583cc708dedSBarry Smith . ts - the TS context 5584cc708dedSBarry Smith 5585cc708dedSBarry Smith Output Parameter: 558663e21af5SBarry Smith . ftime - the final time. This time corresponds to the final time set with TSSetDuration() 5587cc708dedSBarry Smith 5588487e0bb9SJed Brown Level: beginner 5589cc708dedSBarry Smith 5590cc708dedSBarry Smith Notes: 5591cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5592cc708dedSBarry Smith 5593cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 5594cc708dedSBarry Smith 5595cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5596cc708dedSBarry Smith @*/ 5597cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5598cc708dedSBarry Smith { 5599cc708dedSBarry Smith PetscFunctionBegin; 5600cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5601cc708dedSBarry Smith PetscValidPointer(ftime,2); 5602cc708dedSBarry Smith *ftime = ts->solvetime; 5603cc708dedSBarry Smith PetscFunctionReturn(0); 5604cc708dedSBarry Smith } 5605cc708dedSBarry Smith 56062c18e0fdSBarry Smith /*@ 56075ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 56089f67acb7SJed Brown used by the time integrator. 56099f67acb7SJed Brown 56109f67acb7SJed Brown Not Collective 56119f67acb7SJed Brown 56129f67acb7SJed Brown Input Parameter: 56139f67acb7SJed Brown . ts - TS context 56149f67acb7SJed Brown 56159f67acb7SJed Brown Output Parameter: 56169f67acb7SJed Brown . nits - number of nonlinear iterations 56179f67acb7SJed Brown 56189f67acb7SJed Brown Notes: 56199f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 56209f67acb7SJed Brown 56219f67acb7SJed Brown Level: intermediate 56229f67acb7SJed Brown 56239f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 56249f67acb7SJed Brown 56255ef26d82SJed Brown .seealso: TSGetKSPIterations() 56269f67acb7SJed Brown @*/ 56275ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 56289f67acb7SJed Brown { 56299f67acb7SJed Brown PetscFunctionBegin; 56309f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 56319f67acb7SJed Brown PetscValidIntPointer(nits,2); 56325ef26d82SJed Brown *nits = ts->snes_its; 56339f67acb7SJed Brown PetscFunctionReturn(0); 56349f67acb7SJed Brown } 56359f67acb7SJed Brown 56369f67acb7SJed Brown /*@ 56375ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 56389f67acb7SJed Brown used by the time integrator. 56399f67acb7SJed Brown 56409f67acb7SJed Brown Not Collective 56419f67acb7SJed Brown 56429f67acb7SJed Brown Input Parameter: 56439f67acb7SJed Brown . ts - TS context 56449f67acb7SJed Brown 56459f67acb7SJed Brown Output Parameter: 56469f67acb7SJed Brown . lits - number of linear iterations 56479f67acb7SJed Brown 56489f67acb7SJed Brown Notes: 56499f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 56509f67acb7SJed Brown 56519f67acb7SJed Brown Level: intermediate 56529f67acb7SJed Brown 56539f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 56549f67acb7SJed Brown 56555ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 56569f67acb7SJed Brown @*/ 56575ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 56589f67acb7SJed Brown { 56599f67acb7SJed Brown PetscFunctionBegin; 56609f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 56619f67acb7SJed Brown PetscValidIntPointer(lits,2); 56625ef26d82SJed Brown *lits = ts->ksp_its; 56639f67acb7SJed Brown PetscFunctionReturn(0); 56649f67acb7SJed Brown } 56659f67acb7SJed Brown 5666cef5090cSJed Brown /*@ 5667cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5668cef5090cSJed Brown 5669cef5090cSJed Brown Not Collective 5670cef5090cSJed Brown 5671cef5090cSJed Brown Input Parameter: 5672cef5090cSJed Brown . ts - TS context 5673cef5090cSJed Brown 5674cef5090cSJed Brown Output Parameter: 5675cef5090cSJed Brown . rejects - number of steps rejected 5676cef5090cSJed Brown 5677cef5090cSJed Brown Notes: 5678cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5679cef5090cSJed Brown 5680cef5090cSJed Brown Level: intermediate 5681cef5090cSJed Brown 5682cef5090cSJed Brown .keywords: TS, get, number 5683cef5090cSJed Brown 56845ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5685cef5090cSJed Brown @*/ 5686cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5687cef5090cSJed Brown { 5688cef5090cSJed Brown PetscFunctionBegin; 5689cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5690cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5691cef5090cSJed Brown *rejects = ts->reject; 5692cef5090cSJed Brown PetscFunctionReturn(0); 5693cef5090cSJed Brown } 5694cef5090cSJed Brown 5695cef5090cSJed Brown /*@ 5696cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5697cef5090cSJed Brown 5698cef5090cSJed Brown Not Collective 5699cef5090cSJed Brown 5700cef5090cSJed Brown Input Parameter: 5701cef5090cSJed Brown . ts - TS context 5702cef5090cSJed Brown 5703cef5090cSJed Brown Output Parameter: 5704cef5090cSJed Brown . fails - number of failed nonlinear solves 5705cef5090cSJed Brown 5706cef5090cSJed Brown Notes: 5707cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5708cef5090cSJed Brown 5709cef5090cSJed Brown Level: intermediate 5710cef5090cSJed Brown 5711cef5090cSJed Brown .keywords: TS, get, number 5712cef5090cSJed Brown 57135ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5714cef5090cSJed Brown @*/ 5715cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5716cef5090cSJed Brown { 5717cef5090cSJed Brown PetscFunctionBegin; 5718cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5719cef5090cSJed Brown PetscValidIntPointer(fails,2); 5720cef5090cSJed Brown *fails = ts->num_snes_failures; 5721cef5090cSJed Brown PetscFunctionReturn(0); 5722cef5090cSJed Brown } 5723cef5090cSJed Brown 5724cef5090cSJed Brown /*@ 5725cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5726cef5090cSJed Brown 5727cef5090cSJed Brown Not Collective 5728cef5090cSJed Brown 5729cef5090cSJed Brown Input Parameter: 5730cef5090cSJed Brown + ts - TS context 5731cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5732cef5090cSJed Brown 5733cef5090cSJed Brown Notes: 5734cef5090cSJed Brown The counter is reset to zero for each step 5735cef5090cSJed Brown 5736cef5090cSJed Brown Options Database Key: 5737cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5738cef5090cSJed Brown 5739cef5090cSJed Brown Level: intermediate 5740cef5090cSJed Brown 5741cef5090cSJed Brown .keywords: TS, set, maximum, number 5742cef5090cSJed Brown 57435ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5744cef5090cSJed Brown @*/ 5745cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5746cef5090cSJed Brown { 5747cef5090cSJed Brown PetscFunctionBegin; 5748cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5749cef5090cSJed Brown ts->max_reject = rejects; 5750cef5090cSJed Brown PetscFunctionReturn(0); 5751cef5090cSJed Brown } 5752cef5090cSJed Brown 5753cef5090cSJed Brown /*@ 5754cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5755cef5090cSJed Brown 5756cef5090cSJed Brown Not Collective 5757cef5090cSJed Brown 5758cef5090cSJed Brown Input Parameter: 5759cef5090cSJed Brown + ts - TS context 5760cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5761cef5090cSJed Brown 5762cef5090cSJed Brown Notes: 5763cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5764cef5090cSJed Brown 5765cef5090cSJed Brown Options Database Key: 5766cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5767cef5090cSJed Brown 5768cef5090cSJed Brown Level: intermediate 5769cef5090cSJed Brown 5770cef5090cSJed Brown .keywords: TS, set, maximum, number 5771cef5090cSJed Brown 57725ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5773cef5090cSJed Brown @*/ 5774cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5775cef5090cSJed Brown { 5776cef5090cSJed Brown PetscFunctionBegin; 5777cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5778cef5090cSJed Brown ts->max_snes_failures = fails; 5779cef5090cSJed Brown PetscFunctionReturn(0); 5780cef5090cSJed Brown } 5781cef5090cSJed Brown 5782cef5090cSJed Brown /*@ 5783cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5784cef5090cSJed Brown 5785cef5090cSJed Brown Not Collective 5786cef5090cSJed Brown 5787cef5090cSJed Brown Input Parameter: 5788cef5090cSJed Brown + ts - TS context 5789cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5790cef5090cSJed Brown 5791cef5090cSJed Brown Options Database Key: 5792cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5793cef5090cSJed Brown 5794cef5090cSJed Brown Level: intermediate 5795cef5090cSJed Brown 5796cef5090cSJed Brown .keywords: TS, set, error 5797cef5090cSJed Brown 57985ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5799cef5090cSJed Brown @*/ 5800cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5801cef5090cSJed Brown { 5802cef5090cSJed Brown PetscFunctionBegin; 5803cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5804cef5090cSJed Brown ts->errorifstepfailed = err; 5805cef5090cSJed Brown PetscFunctionReturn(0); 5806cef5090cSJed Brown } 5807cef5090cSJed Brown 5808fb1732b5SBarry Smith /*@C 5809fde5950dSBarry 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 5810fb1732b5SBarry Smith 5811fb1732b5SBarry Smith Collective on TS 5812fb1732b5SBarry Smith 5813fb1732b5SBarry Smith Input Parameters: 5814fb1732b5SBarry Smith + ts - the TS context 5815fb1732b5SBarry Smith . step - current time-step 5816fb1732b5SBarry Smith . ptime - current time 58170910c330SBarry Smith . u - current state 5818721cd6eeSBarry Smith - vf - viewer and its format 5819fb1732b5SBarry Smith 5820fb1732b5SBarry Smith Level: intermediate 5821fb1732b5SBarry Smith 5822fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5823fb1732b5SBarry Smith 5824fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5825fb1732b5SBarry Smith @*/ 5826721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5827fb1732b5SBarry Smith { 5828fb1732b5SBarry Smith PetscErrorCode ierr; 5829fb1732b5SBarry Smith 5830fb1732b5SBarry Smith PetscFunctionBegin; 5831721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5832721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5833721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5834ed81e22dSJed Brown PetscFunctionReturn(0); 5835ed81e22dSJed Brown } 5836ed81e22dSJed Brown 5837ed81e22dSJed Brown /*@C 5838ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5839ed81e22dSJed Brown 5840ed81e22dSJed Brown Collective on TS 5841ed81e22dSJed Brown 5842ed81e22dSJed Brown Input Parameters: 5843ed81e22dSJed Brown + ts - the TS context 5844ed81e22dSJed Brown . step - current time-step 5845ed81e22dSJed Brown . ptime - current time 58460910c330SBarry Smith . u - current state 5847ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5848ed81e22dSJed Brown 5849ed81e22dSJed Brown Level: intermediate 5850ed81e22dSJed Brown 5851ed81e22dSJed Brown Notes: 5852ed81e22dSJed 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. 5853ed81e22dSJed Brown These are named according to the file name template. 5854ed81e22dSJed Brown 5855ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5856ed81e22dSJed Brown 5857ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5858ed81e22dSJed Brown 5859ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5860ed81e22dSJed Brown @*/ 58610910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5862ed81e22dSJed Brown { 5863ed81e22dSJed Brown PetscErrorCode ierr; 5864ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5865ed81e22dSJed Brown PetscViewer viewer; 5866ed81e22dSJed Brown 5867ed81e22dSJed Brown PetscFunctionBegin; 586863e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 58698caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5870ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 58710910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5872ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5873ed81e22dSJed Brown PetscFunctionReturn(0); 5874ed81e22dSJed Brown } 5875ed81e22dSJed Brown 5876ed81e22dSJed Brown /*@C 5877ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5878ed81e22dSJed Brown 5879ed81e22dSJed Brown Collective on TS 5880ed81e22dSJed Brown 5881ed81e22dSJed Brown Input Parameters: 5882ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5883ed81e22dSJed Brown 5884ed81e22dSJed Brown Level: intermediate 5885ed81e22dSJed Brown 5886ed81e22dSJed Brown Note: 5887ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5888ed81e22dSJed Brown 5889ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5890ed81e22dSJed Brown 5891ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5892ed81e22dSJed Brown @*/ 5893ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5894ed81e22dSJed Brown { 5895ed81e22dSJed Brown PetscErrorCode ierr; 5896ed81e22dSJed Brown 5897ed81e22dSJed Brown PetscFunctionBegin; 5898ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5899fb1732b5SBarry Smith PetscFunctionReturn(0); 5900fb1732b5SBarry Smith } 5901fb1732b5SBarry Smith 590284df9cb4SJed Brown /*@ 5903552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 590484df9cb4SJed Brown 5905ed81e22dSJed Brown Collective on TS if controller has not been created yet 590684df9cb4SJed Brown 590784df9cb4SJed Brown Input Arguments: 5908ed81e22dSJed Brown . ts - time stepping context 590984df9cb4SJed Brown 591084df9cb4SJed Brown Output Arguments: 5911ed81e22dSJed Brown . adapt - adaptive controller 591284df9cb4SJed Brown 591384df9cb4SJed Brown Level: intermediate 591484df9cb4SJed Brown 5915ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 591684df9cb4SJed Brown @*/ 5917552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 591884df9cb4SJed Brown { 591984df9cb4SJed Brown PetscErrorCode ierr; 592084df9cb4SJed Brown 592184df9cb4SJed Brown PetscFunctionBegin; 592284df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5923bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 592484df9cb4SJed Brown if (!ts->adapt) { 5925ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 59263bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 59271c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 592884df9cb4SJed Brown } 5929bec58848SLisandro Dalcin *adapt = ts->adapt; 593084df9cb4SJed Brown PetscFunctionReturn(0); 593184df9cb4SJed Brown } 5932d6ebe24aSShri Abhyankar 59331c3436cfSJed Brown /*@ 59341c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 59351c3436cfSJed Brown 59361c3436cfSJed Brown Logically Collective 59371c3436cfSJed Brown 59381c3436cfSJed Brown Input Arguments: 59391c3436cfSJed Brown + ts - time integration context 59401c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 59410298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 59421c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 59430298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 59441c3436cfSJed Brown 5945a3cdaa26SBarry Smith Options Database keys: 5946a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5947a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5948a3cdaa26SBarry Smith 59493ff766beSShri Abhyankar Notes: 59503ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 59513ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 59523ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 59533ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 59543ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 59553ff766beSShri Abhyankar differential variables. 59563ff766beSShri Abhyankar 59571c3436cfSJed Brown Level: beginner 59581c3436cfSJed Brown 5959c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 59601c3436cfSJed Brown @*/ 59611c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 59621c3436cfSJed Brown { 59631c3436cfSJed Brown PetscErrorCode ierr; 59641c3436cfSJed Brown 59651c3436cfSJed Brown PetscFunctionBegin; 5966c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 59671c3436cfSJed Brown if (vatol) { 59681c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 59691c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 59701c3436cfSJed Brown ts->vatol = vatol; 59711c3436cfSJed Brown } 5972c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 59731c3436cfSJed Brown if (vrtol) { 59741c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 59751c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 59761c3436cfSJed Brown ts->vrtol = vrtol; 59771c3436cfSJed Brown } 59781c3436cfSJed Brown PetscFunctionReturn(0); 59791c3436cfSJed Brown } 59801c3436cfSJed Brown 5981c5033834SJed Brown /*@ 5982c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5983c5033834SJed Brown 5984c5033834SJed Brown Logically Collective 5985c5033834SJed Brown 5986c5033834SJed Brown Input Arguments: 5987c5033834SJed Brown . ts - time integration context 5988c5033834SJed Brown 5989c5033834SJed Brown Output Arguments: 59900298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 59910298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 59920298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 59930298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5994c5033834SJed Brown 5995c5033834SJed Brown Level: beginner 5996c5033834SJed Brown 5997c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5998c5033834SJed Brown @*/ 5999c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 6000c5033834SJed Brown { 6001c5033834SJed Brown PetscFunctionBegin; 6002c5033834SJed Brown if (atol) *atol = ts->atol; 6003c5033834SJed Brown if (vatol) *vatol = ts->vatol; 6004c5033834SJed Brown if (rtol) *rtol = ts->rtol; 6005c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 6006c5033834SJed Brown PetscFunctionReturn(0); 6007c5033834SJed Brown } 6008c5033834SJed Brown 60099c6b16b5SShri Abhyankar /*@ 6010a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 60119c6b16b5SShri Abhyankar 60129c6b16b5SShri Abhyankar Collective on TS 60139c6b16b5SShri Abhyankar 60149c6b16b5SShri Abhyankar Input Arguments: 60159c6b16b5SShri Abhyankar + ts - time stepping context 6016a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6017a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 60189c6b16b5SShri Abhyankar 60199c6b16b5SShri Abhyankar Output Arguments: 60207453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 60217453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 60227453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 60239c6b16b5SShri Abhyankar 60249c6b16b5SShri Abhyankar Level: developer 60259c6b16b5SShri Abhyankar 6026deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 60279c6b16b5SShri Abhyankar @*/ 60287453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60299c6b16b5SShri Abhyankar { 60309c6b16b5SShri Abhyankar PetscErrorCode ierr; 60319c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 60327453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 60337453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 60349c6b16b5SShri Abhyankar const PetscScalar *u,*y; 60357453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 60367453f775SEmil Constantinescu PetscReal tol,tola,tolr; 60377453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 60389c6b16b5SShri Abhyankar 60399c6b16b5SShri Abhyankar PetscFunctionBegin; 60409c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6041a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 6042a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 6043a4868fbcSLisandro Dalcin PetscValidType(U,2); 6044a4868fbcSLisandro Dalcin PetscValidType(Y,3); 6045a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 6046a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 60478a175baeSEmil Constantinescu PetscValidPointer(norma,5); 60488a175baeSEmil Constantinescu PetscValidPointer(normr,6); 6049a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 60509c6b16b5SShri Abhyankar 60519c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 60529c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 60539c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 60549c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 60559c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 60567453f775SEmil Constantinescu sum = 0.; n_loc = 0; 60577453f775SEmil Constantinescu suma = 0.; na_loc = 0; 60587453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 60599c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 60609c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 60619c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60629c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60639c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 60647453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60657453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60667453f775SEmil Constantinescu if(tola>0.){ 60677453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 60687453f775SEmil Constantinescu na_loc++; 60697453f775SEmil Constantinescu } 60707453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60717453f775SEmil Constantinescu if(tolr>0.){ 60727453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 60737453f775SEmil Constantinescu nr_loc++; 60747453f775SEmil Constantinescu } 60757453f775SEmil Constantinescu tol=tola+tolr; 60767453f775SEmil Constantinescu if(tol>0.){ 60777453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 60787453f775SEmil Constantinescu n_loc++; 60797453f775SEmil Constantinescu } 60809c6b16b5SShri Abhyankar } 60819c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60829c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60839c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 60849c6b16b5SShri Abhyankar const PetscScalar *atol; 60859c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60869c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 60877453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 60887453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 60897453f775SEmil Constantinescu if(tola>0.){ 60907453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 60917453f775SEmil Constantinescu na_loc++; 60927453f775SEmil Constantinescu } 60937453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60947453f775SEmil Constantinescu if(tolr>0.){ 60957453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 60967453f775SEmil Constantinescu nr_loc++; 60977453f775SEmil Constantinescu } 60987453f775SEmil Constantinescu tol=tola+tolr; 60997453f775SEmil Constantinescu if(tol>0.){ 61007453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 61017453f775SEmil Constantinescu n_loc++; 61027453f775SEmil Constantinescu } 61039c6b16b5SShri Abhyankar } 61049c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 61059c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 61069c6b16b5SShri Abhyankar const PetscScalar *rtol; 61079c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61089c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 61097453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 61107453f775SEmil Constantinescu tola = ts->atol; 61117453f775SEmil Constantinescu if(tola>0.){ 61127453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 61137453f775SEmil Constantinescu na_loc++; 61147453f775SEmil Constantinescu } 61157453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61167453f775SEmil Constantinescu if(tolr>0.){ 61177453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 61187453f775SEmil Constantinescu nr_loc++; 61197453f775SEmil Constantinescu } 61207453f775SEmil Constantinescu tol=tola+tolr; 61217453f775SEmil Constantinescu if(tol>0.){ 61227453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 61237453f775SEmil Constantinescu n_loc++; 61247453f775SEmil Constantinescu } 61259c6b16b5SShri Abhyankar } 61269c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61279c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 61289c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 61297453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 61307453f775SEmil Constantinescu tola = ts->atol; 61317453f775SEmil Constantinescu if(tola>0.){ 61327453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 61337453f775SEmil Constantinescu na_loc++; 61347453f775SEmil Constantinescu } 61357453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61367453f775SEmil Constantinescu if(tolr>0.){ 61377453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 61387453f775SEmil Constantinescu nr_loc++; 61397453f775SEmil Constantinescu } 61407453f775SEmil Constantinescu tol=tola+tolr; 61417453f775SEmil Constantinescu if(tol>0.){ 61427453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 61437453f775SEmil Constantinescu n_loc++; 61447453f775SEmil Constantinescu } 61459c6b16b5SShri Abhyankar } 61469c6b16b5SShri Abhyankar } 61479c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 61489c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 61499c6b16b5SShri Abhyankar 61507453f775SEmil Constantinescu err_loc[0] = sum; 61517453f775SEmil Constantinescu err_loc[1] = suma; 61527453f775SEmil Constantinescu err_loc[2] = sumr; 61537453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 61547453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 61557453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 61567453f775SEmil Constantinescu 6157a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 61587453f775SEmil Constantinescu 61597453f775SEmil Constantinescu gsum = err_glb[0]; 61607453f775SEmil Constantinescu gsuma = err_glb[1]; 61617453f775SEmil Constantinescu gsumr = err_glb[2]; 61627453f775SEmil Constantinescu n_glb = err_glb[3]; 61637453f775SEmil Constantinescu na_glb = err_glb[4]; 61647453f775SEmil Constantinescu nr_glb = err_glb[5]; 61657453f775SEmil Constantinescu 6166b1316ef9SEmil Constantinescu *norm = 0.; 6167b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 6168b1316ef9SEmil Constantinescu *norma = 0.; 6169b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 6170b1316ef9SEmil Constantinescu *normr = 0.; 6171b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 61729c6b16b5SShri Abhyankar 61739c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 61747453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 61757453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 61769c6b16b5SShri Abhyankar PetscFunctionReturn(0); 61779c6b16b5SShri Abhyankar } 61789c6b16b5SShri Abhyankar 61799c6b16b5SShri Abhyankar /*@ 6180a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 61819c6b16b5SShri Abhyankar 61829c6b16b5SShri Abhyankar Collective on TS 61839c6b16b5SShri Abhyankar 61849c6b16b5SShri Abhyankar Input Arguments: 61859c6b16b5SShri Abhyankar + ts - time stepping context 6186a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6187a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 61889c6b16b5SShri Abhyankar 61899c6b16b5SShri Abhyankar Output Arguments: 61907453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 61917453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 61927453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 61939c6b16b5SShri Abhyankar 61949c6b16b5SShri Abhyankar Level: developer 61959c6b16b5SShri Abhyankar 6196deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 61979c6b16b5SShri Abhyankar @*/ 61987453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61999c6b16b5SShri Abhyankar { 62009c6b16b5SShri Abhyankar PetscErrorCode ierr; 62017453f775SEmil Constantinescu PetscInt i,n,N,rstart; 62029c6b16b5SShri Abhyankar const PetscScalar *u,*y; 62037453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 62047453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 62057453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 62069c6b16b5SShri Abhyankar 62079c6b16b5SShri Abhyankar PetscFunctionBegin; 62089c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6209a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 6210a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 6211a4868fbcSLisandro Dalcin PetscValidType(U,2); 6212a4868fbcSLisandro Dalcin PetscValidType(Y,3); 6213a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 6214a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 62158a175baeSEmil Constantinescu PetscValidPointer(norma,5); 62168a175baeSEmil Constantinescu PetscValidPointer(normr,6); 6217a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 62189c6b16b5SShri Abhyankar 62199c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 62209c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 62219c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 62229c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 62239c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 62247453f775SEmil Constantinescu 62257453f775SEmil Constantinescu max=0.; 62267453f775SEmil Constantinescu maxa=0.; 62277453f775SEmil Constantinescu maxr=0.; 62287453f775SEmil Constantinescu 62297453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 62309c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 62319c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62329c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62337453f775SEmil Constantinescu 62347453f775SEmil Constantinescu for (i=0; i<n; i++) { 62357453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 62367453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 62377453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62387453f775SEmil Constantinescu tol = tola+tolr; 62397453f775SEmil Constantinescu if(tola>0.){ 62407453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 62417453f775SEmil Constantinescu } 62427453f775SEmil Constantinescu if(tolr>0.){ 62437453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 62447453f775SEmil Constantinescu } 62457453f775SEmil Constantinescu if(tol>0.){ 62467453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 62477453f775SEmil Constantinescu } 62489c6b16b5SShri Abhyankar } 62499c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62509c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62519c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 62529c6b16b5SShri Abhyankar const PetscScalar *atol; 62539c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62547453f775SEmil Constantinescu for (i=0; i<n; i++) { 62557453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 62567453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 62577453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62587453f775SEmil Constantinescu tol = tola+tolr; 62597453f775SEmil Constantinescu if(tola>0.){ 62607453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 62617453f775SEmil Constantinescu } 62627453f775SEmil Constantinescu if(tolr>0.){ 62637453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 62647453f775SEmil Constantinescu } 62657453f775SEmil Constantinescu if(tol>0.){ 62667453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 62677453f775SEmil Constantinescu } 62689c6b16b5SShri Abhyankar } 62699c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62709c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 62719c6b16b5SShri Abhyankar const PetscScalar *rtol; 62729c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62737453f775SEmil Constantinescu 62747453f775SEmil Constantinescu for (i=0; i<n; i++) { 62757453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 62767453f775SEmil Constantinescu tola = ts->atol; 62777453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62787453f775SEmil Constantinescu tol = tola+tolr; 62797453f775SEmil Constantinescu if(tola>0.){ 62807453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 62817453f775SEmil Constantinescu } 62827453f775SEmil Constantinescu if(tolr>0.){ 62837453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 62847453f775SEmil Constantinescu } 62857453f775SEmil Constantinescu if(tol>0.){ 62867453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 62877453f775SEmil Constantinescu } 62889c6b16b5SShri Abhyankar } 62899c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62909c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 62917453f775SEmil Constantinescu 62927453f775SEmil Constantinescu for (i=0; i<n; i++) { 62937453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 62947453f775SEmil Constantinescu tola = ts->atol; 62957453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 62967453f775SEmil Constantinescu tol = tola+tolr; 62977453f775SEmil Constantinescu if(tola>0.){ 62987453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 62997453f775SEmil Constantinescu } 63007453f775SEmil Constantinescu if(tolr>0.){ 63017453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 63027453f775SEmil Constantinescu } 63037453f775SEmil Constantinescu if(tol>0.){ 63047453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 63057453f775SEmil Constantinescu } 63069c6b16b5SShri Abhyankar } 63079c6b16b5SShri Abhyankar } 63089c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 63099c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 63107453f775SEmil Constantinescu err_loc[0] = max; 63117453f775SEmil Constantinescu err_loc[1] = maxa; 63127453f775SEmil Constantinescu err_loc[2] = maxr; 6313a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 63147453f775SEmil Constantinescu gmax = err_glb[0]; 63157453f775SEmil Constantinescu gmaxa = err_glb[1]; 63167453f775SEmil Constantinescu gmaxr = err_glb[2]; 63179c6b16b5SShri Abhyankar 63189c6b16b5SShri Abhyankar *norm = gmax; 63197453f775SEmil Constantinescu *norma = gmaxa; 63207453f775SEmil Constantinescu *normr = gmaxr; 63219c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 63227453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 63237453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 63249c6b16b5SShri Abhyankar PetscFunctionReturn(0); 63259c6b16b5SShri Abhyankar } 63269c6b16b5SShri Abhyankar 63271c3436cfSJed Brown /*@ 63288a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 63291c3436cfSJed Brown 63301c3436cfSJed Brown Collective on TS 63311c3436cfSJed Brown 63321c3436cfSJed Brown Input Arguments: 63331c3436cfSJed Brown + ts - time stepping context 6334a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6335a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 6336a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 63377619abb3SShri 63381c3436cfSJed Brown Output Arguments: 63398a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 63408a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 63418a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 6342a4868fbcSLisandro Dalcin 6343a4868fbcSLisandro Dalcin Options Database Keys: 6344a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6345a4868fbcSLisandro Dalcin 63461c3436cfSJed Brown Level: developer 63471c3436cfSJed Brown 63488a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 63491c3436cfSJed Brown @*/ 63507453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 63511c3436cfSJed Brown { 63528beabaa1SBarry Smith PetscErrorCode ierr; 63531c3436cfSJed Brown 63541c3436cfSJed Brown PetscFunctionBegin; 6355a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 63567453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6357a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 63587453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6359a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 63601c3436cfSJed Brown PetscFunctionReturn(0); 63611c3436cfSJed Brown } 63621c3436cfSJed Brown 63638a175baeSEmil Constantinescu 63648a175baeSEmil Constantinescu /*@ 63658a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 63668a175baeSEmil Constantinescu 63678a175baeSEmil Constantinescu Collective on TS 63688a175baeSEmil Constantinescu 63698a175baeSEmil Constantinescu Input Arguments: 63708a175baeSEmil Constantinescu + ts - time stepping context 63718a175baeSEmil Constantinescu . E - error vector 63728a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 63738a175baeSEmil Constantinescu - Y - state vector, previous time step 63748a175baeSEmil Constantinescu 63758a175baeSEmil Constantinescu Output Arguments: 63768a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 63778a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 63788a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 63798a175baeSEmil Constantinescu 63808a175baeSEmil Constantinescu Level: developer 63818a175baeSEmil Constantinescu 63828a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 63838a175baeSEmil Constantinescu @*/ 63848a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 63858a175baeSEmil Constantinescu { 63868a175baeSEmil Constantinescu PetscErrorCode ierr; 63878a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 63888a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 63898a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 63908a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 63918a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 63928a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 63938a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 63948a175baeSEmil Constantinescu 63958a175baeSEmil Constantinescu PetscFunctionBegin; 63968a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 63978a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 63988a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 63998a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 64008a175baeSEmil Constantinescu PetscValidType(E,2); 64018a175baeSEmil Constantinescu PetscValidType(U,3); 64028a175baeSEmil Constantinescu PetscValidType(Y,4); 64038a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 64048a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 64058a175baeSEmil Constantinescu PetscValidPointer(norm,5); 64068a175baeSEmil Constantinescu PetscValidPointer(norma,6); 64078a175baeSEmil Constantinescu PetscValidPointer(normr,7); 64088a175baeSEmil Constantinescu 64098a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 64108a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 64118a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 64128a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 64138a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 64148a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 64158a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 64168a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 64178a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 64188a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 64198a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 64208a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64218a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64228a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64238a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64248a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64258a175baeSEmil Constantinescu if(tola>0.){ 64268a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 64278a175baeSEmil Constantinescu na_loc++; 64288a175baeSEmil Constantinescu } 64298a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64308a175baeSEmil Constantinescu if(tolr>0.){ 64318a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 64328a175baeSEmil Constantinescu nr_loc++; 64338a175baeSEmil Constantinescu } 64348a175baeSEmil Constantinescu tol=tola+tolr; 64358a175baeSEmil Constantinescu if(tol>0.){ 64368a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 64378a175baeSEmil Constantinescu n_loc++; 64388a175baeSEmil Constantinescu } 64398a175baeSEmil Constantinescu } 64408a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64418a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64428a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 64438a175baeSEmil Constantinescu const PetscScalar *atol; 64448a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64458a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64468a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64478a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 64488a175baeSEmil Constantinescu if(tola>0.){ 64498a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 64508a175baeSEmil Constantinescu na_loc++; 64518a175baeSEmil Constantinescu } 64528a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64538a175baeSEmil Constantinescu if(tolr>0.){ 64548a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 64558a175baeSEmil Constantinescu nr_loc++; 64568a175baeSEmil Constantinescu } 64578a175baeSEmil Constantinescu tol=tola+tolr; 64588a175baeSEmil Constantinescu if(tol>0.){ 64598a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 64608a175baeSEmil Constantinescu n_loc++; 64618a175baeSEmil Constantinescu } 64628a175baeSEmil Constantinescu } 64638a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 64648a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 64658a175baeSEmil Constantinescu const PetscScalar *rtol; 64668a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64678a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64688a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64698a175baeSEmil Constantinescu tola = ts->atol; 64708a175baeSEmil Constantinescu if(tola>0.){ 64718a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 64728a175baeSEmil Constantinescu na_loc++; 64738a175baeSEmil Constantinescu } 64748a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64758a175baeSEmil Constantinescu if(tolr>0.){ 64768a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 64778a175baeSEmil Constantinescu nr_loc++; 64788a175baeSEmil Constantinescu } 64798a175baeSEmil Constantinescu tol=tola+tolr; 64808a175baeSEmil Constantinescu if(tol>0.){ 64818a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 64828a175baeSEmil Constantinescu n_loc++; 64838a175baeSEmil Constantinescu } 64848a175baeSEmil Constantinescu } 64858a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 64868a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 64878a175baeSEmil Constantinescu for (i=0; i<n; i++) { 64888a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 64898a175baeSEmil Constantinescu tola = ts->atol; 64908a175baeSEmil Constantinescu if(tola>0.){ 64918a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 64928a175baeSEmil Constantinescu na_loc++; 64938a175baeSEmil Constantinescu } 64948a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 64958a175baeSEmil Constantinescu if(tolr>0.){ 64968a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 64978a175baeSEmil Constantinescu nr_loc++; 64988a175baeSEmil Constantinescu } 64998a175baeSEmil Constantinescu tol=tola+tolr; 65008a175baeSEmil Constantinescu if(tol>0.){ 65018a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 65028a175baeSEmil Constantinescu n_loc++; 65038a175baeSEmil Constantinescu } 65048a175baeSEmil Constantinescu } 65058a175baeSEmil Constantinescu } 65068a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 65078a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 65088a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 65098a175baeSEmil Constantinescu 65108a175baeSEmil Constantinescu err_loc[0] = sum; 65118a175baeSEmil Constantinescu err_loc[1] = suma; 65128a175baeSEmil Constantinescu err_loc[2] = sumr; 65138a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 65148a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 65158a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 65168a175baeSEmil Constantinescu 6517a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 65188a175baeSEmil Constantinescu 65198a175baeSEmil Constantinescu gsum = err_glb[0]; 65208a175baeSEmil Constantinescu gsuma = err_glb[1]; 65218a175baeSEmil Constantinescu gsumr = err_glb[2]; 65228a175baeSEmil Constantinescu n_glb = err_glb[3]; 65238a175baeSEmil Constantinescu na_glb = err_glb[4]; 65248a175baeSEmil Constantinescu nr_glb = err_glb[5]; 65258a175baeSEmil Constantinescu 65268a175baeSEmil Constantinescu *norm = 0.; 65278a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 65288a175baeSEmil Constantinescu *norma = 0.; 65298a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 65308a175baeSEmil Constantinescu *normr = 0.; 65318a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 65328a175baeSEmil Constantinescu 65338a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 65348a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 65358a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 65368a175baeSEmil Constantinescu PetscFunctionReturn(0); 65378a175baeSEmil Constantinescu } 65388a175baeSEmil Constantinescu 65398a175baeSEmil Constantinescu /*@ 65408a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 65418a175baeSEmil Constantinescu Collective on TS 65428a175baeSEmil Constantinescu 65438a175baeSEmil Constantinescu Input Arguments: 65448a175baeSEmil Constantinescu + ts - time stepping context 65458a175baeSEmil Constantinescu . E - error vector 65468a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 65478a175baeSEmil Constantinescu - Y - state vector, previous time step 65488a175baeSEmil Constantinescu 65498a175baeSEmil Constantinescu Output Arguments: 65508a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 65518a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 65528a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 65538a175baeSEmil Constantinescu 65548a175baeSEmil Constantinescu Level: developer 65558a175baeSEmil Constantinescu 65568a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 65578a175baeSEmil Constantinescu @*/ 65588a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 65598a175baeSEmil Constantinescu { 65608a175baeSEmil Constantinescu PetscErrorCode ierr; 65618a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 65628a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 65638a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 65648a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 65658a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 65668a175baeSEmil Constantinescu 65678a175baeSEmil Constantinescu PetscFunctionBegin; 65688a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 65698a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 65708a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 65718a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 65728a175baeSEmil Constantinescu PetscValidType(E,2); 65738a175baeSEmil Constantinescu PetscValidType(U,3); 65748a175baeSEmil Constantinescu PetscValidType(Y,4); 65758a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 65768a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 65778a175baeSEmil Constantinescu PetscValidPointer(norm,5); 65788a175baeSEmil Constantinescu PetscValidPointer(norma,6); 65798a175baeSEmil Constantinescu PetscValidPointer(normr,7); 65808a175baeSEmil Constantinescu 65818a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 65828a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 65838a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 65848a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 65858a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 65868a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 65878a175baeSEmil Constantinescu 65888a175baeSEmil Constantinescu max=0.; 65898a175baeSEmil Constantinescu maxa=0.; 65908a175baeSEmil Constantinescu maxr=0.; 65918a175baeSEmil Constantinescu 65928a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 65938a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 65948a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 65958a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 65968a175baeSEmil Constantinescu 65978a175baeSEmil Constantinescu for (i=0; i<n; i++) { 65988a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 65998a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 66008a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 66018a175baeSEmil Constantinescu tol = tola+tolr; 66028a175baeSEmil Constantinescu if(tola>0.){ 66038a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 66048a175baeSEmil Constantinescu } 66058a175baeSEmil Constantinescu if(tolr>0.){ 66068a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 66078a175baeSEmil Constantinescu } 66088a175baeSEmil Constantinescu if(tol>0.){ 66098a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 66108a175baeSEmil Constantinescu } 66118a175baeSEmil Constantinescu } 66128a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 66138a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 66148a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 66158a175baeSEmil Constantinescu const PetscScalar *atol; 66168a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 66178a175baeSEmil Constantinescu for (i=0; i<n; i++) { 66188a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 66198a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 66208a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 66218a175baeSEmil Constantinescu tol = tola+tolr; 66228a175baeSEmil Constantinescu if(tola>0.){ 66238a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 66248a175baeSEmil Constantinescu } 66258a175baeSEmil Constantinescu if(tolr>0.){ 66268a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 66278a175baeSEmil Constantinescu } 66288a175baeSEmil Constantinescu if(tol>0.){ 66298a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 66308a175baeSEmil Constantinescu } 66318a175baeSEmil Constantinescu } 66328a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 66338a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 66348a175baeSEmil Constantinescu const PetscScalar *rtol; 66358a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 66368a175baeSEmil Constantinescu 66378a175baeSEmil Constantinescu for (i=0; i<n; i++) { 66388a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 66398a175baeSEmil Constantinescu tola = ts->atol; 66408a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 66418a175baeSEmil Constantinescu tol = tola+tolr; 66428a175baeSEmil Constantinescu if(tola>0.){ 66438a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 66448a175baeSEmil Constantinescu } 66458a175baeSEmil Constantinescu if(tolr>0.){ 66468a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 66478a175baeSEmil Constantinescu } 66488a175baeSEmil Constantinescu if(tol>0.){ 66498a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 66508a175baeSEmil Constantinescu } 66518a175baeSEmil Constantinescu } 66528a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 66538a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 66548a175baeSEmil Constantinescu 66558a175baeSEmil Constantinescu for (i=0; i<n; i++) { 66568a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 66578a175baeSEmil Constantinescu tola = ts->atol; 66588a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 66598a175baeSEmil Constantinescu tol = tola+tolr; 66608a175baeSEmil Constantinescu if(tola>0.){ 66618a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 66628a175baeSEmil Constantinescu } 66638a175baeSEmil Constantinescu if(tolr>0.){ 66648a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 66658a175baeSEmil Constantinescu } 66668a175baeSEmil Constantinescu if(tol>0.){ 66678a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 66688a175baeSEmil Constantinescu } 66698a175baeSEmil Constantinescu } 66708a175baeSEmil Constantinescu } 66718a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 66728a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 66738a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 66748a175baeSEmil Constantinescu err_loc[0] = max; 66758a175baeSEmil Constantinescu err_loc[1] = maxa; 66768a175baeSEmil Constantinescu err_loc[2] = maxr; 6677a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 66788a175baeSEmil Constantinescu gmax = err_glb[0]; 66798a175baeSEmil Constantinescu gmaxa = err_glb[1]; 66808a175baeSEmil Constantinescu gmaxr = err_glb[2]; 66818a175baeSEmil Constantinescu 66828a175baeSEmil Constantinescu *norm = gmax; 66838a175baeSEmil Constantinescu *norma = gmaxa; 66848a175baeSEmil Constantinescu *normr = gmaxr; 66858a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 66868a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 66878a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 66888a175baeSEmil Constantinescu PetscFunctionReturn(0); 66898a175baeSEmil Constantinescu } 66908a175baeSEmil Constantinescu 66918a175baeSEmil Constantinescu /*@ 66928a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 66938a175baeSEmil Constantinescu 66948a175baeSEmil Constantinescu Collective on TS 66958a175baeSEmil Constantinescu 66968a175baeSEmil Constantinescu Input Arguments: 66978a175baeSEmil Constantinescu + ts - time stepping context 66988a175baeSEmil Constantinescu . E - error vector 66998a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 67008a175baeSEmil Constantinescu . Y - state vector, previous time step 67018a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 67028a175baeSEmil Constantinescu 67038a175baeSEmil Constantinescu Output Arguments: 67048a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 67058a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 67068a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 67078a175baeSEmil Constantinescu 67088a175baeSEmil Constantinescu Options Database Keys: 67098a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 67108a175baeSEmil Constantinescu 67118a175baeSEmil Constantinescu Level: developer 67128a175baeSEmil Constantinescu 67138a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 67148a175baeSEmil Constantinescu @*/ 67158a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 67168a175baeSEmil Constantinescu { 67178a175baeSEmil Constantinescu PetscErrorCode ierr; 67188a175baeSEmil Constantinescu 67198a175baeSEmil Constantinescu PetscFunctionBegin; 67208a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 67218a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 67228a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 67238a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 67248a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 67258a175baeSEmil Constantinescu PetscFunctionReturn(0); 67268a175baeSEmil Constantinescu } 67278a175baeSEmil Constantinescu 67288a175baeSEmil Constantinescu 67298d59e960SJed Brown /*@ 67308d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 67318d59e960SJed Brown 67328d59e960SJed Brown Logically Collective on TS 67338d59e960SJed Brown 67348d59e960SJed Brown Input Arguments: 67358d59e960SJed Brown + ts - time stepping context 67368d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 67378d59e960SJed Brown 67388d59e960SJed Brown Note: 67398d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 67408d59e960SJed Brown 67418d59e960SJed Brown Level: intermediate 67428d59e960SJed Brown 67438d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 67448d59e960SJed Brown @*/ 67458d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 67468d59e960SJed Brown { 67478d59e960SJed Brown PetscFunctionBegin; 67488d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 67498d59e960SJed Brown ts->cfltime_local = cfltime; 67508d59e960SJed Brown ts->cfltime = -1.; 67518d59e960SJed Brown PetscFunctionReturn(0); 67528d59e960SJed Brown } 67538d59e960SJed Brown 67548d59e960SJed Brown /*@ 67558d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 67568d59e960SJed Brown 67578d59e960SJed Brown Collective on TS 67588d59e960SJed Brown 67598d59e960SJed Brown Input Arguments: 67608d59e960SJed Brown . ts - time stepping context 67618d59e960SJed Brown 67628d59e960SJed Brown Output Arguments: 67638d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 67648d59e960SJed Brown 67658d59e960SJed Brown Level: advanced 67668d59e960SJed Brown 67678d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 67688d59e960SJed Brown @*/ 67698d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 67708d59e960SJed Brown { 67718d59e960SJed Brown PetscErrorCode ierr; 67728d59e960SJed Brown 67738d59e960SJed Brown PetscFunctionBegin; 67748d59e960SJed Brown if (ts->cfltime < 0) { 6775b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 67768d59e960SJed Brown } 67778d59e960SJed Brown *cfltime = ts->cfltime; 67788d59e960SJed Brown PetscFunctionReturn(0); 67798d59e960SJed Brown } 67808d59e960SJed Brown 6781d6ebe24aSShri Abhyankar /*@ 6782d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6783d6ebe24aSShri Abhyankar 6784d6ebe24aSShri Abhyankar Input Parameters: 6785d6ebe24aSShri Abhyankar . ts - the TS context. 6786d6ebe24aSShri Abhyankar . xl - lower bound. 6787d6ebe24aSShri Abhyankar . xu - upper bound. 6788d6ebe24aSShri Abhyankar 6789d6ebe24aSShri Abhyankar Notes: 6790d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6791e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6792d6ebe24aSShri Abhyankar 67932bd2b0e6SSatish Balay Level: advanced 67942bd2b0e6SSatish Balay 6795d6ebe24aSShri Abhyankar @*/ 6796d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6797d6ebe24aSShri Abhyankar { 6798d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6799d6ebe24aSShri Abhyankar SNES snes; 6800d6ebe24aSShri Abhyankar 6801d6ebe24aSShri Abhyankar PetscFunctionBegin; 6802d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6803d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6804d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6805d6ebe24aSShri Abhyankar } 6806d6ebe24aSShri Abhyankar 6807325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6808c6db04a5SJed Brown #include <mex.h> 6809325fc9f4SBarry Smith 6810325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6811325fc9f4SBarry Smith 6812325fc9f4SBarry Smith /* 6813325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6814325fc9f4SBarry Smith TSSetFunctionMatlab(). 6815325fc9f4SBarry Smith 6816325fc9f4SBarry Smith Collective on TS 6817325fc9f4SBarry Smith 6818325fc9f4SBarry Smith Input Parameters: 6819325fc9f4SBarry Smith + snes - the TS context 68200910c330SBarry Smith - u - input vector 6821325fc9f4SBarry Smith 6822325fc9f4SBarry Smith Output Parameter: 6823325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6824325fc9f4SBarry Smith 6825325fc9f4SBarry Smith Notes: 6826325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6827325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6828325fc9f4SBarry Smith themselves. 6829325fc9f4SBarry Smith 6830325fc9f4SBarry Smith Level: developer 6831325fc9f4SBarry Smith 6832325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6833325fc9f4SBarry Smith 6834325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6835325fc9f4SBarry Smith */ 68360910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6837325fc9f4SBarry Smith { 6838325fc9f4SBarry Smith PetscErrorCode ierr; 6839325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6840325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6841325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6842325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6843325fc9f4SBarry Smith 6844325fc9f4SBarry Smith PetscFunctionBegin; 6845325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 68460910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 68470910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6848325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 68490910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6850325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6851325fc9f4SBarry Smith 6852325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 68530910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 68540910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 68550910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6856bbd56ea5SKarl Rupp 6857325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6858325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6859325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6860325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6861325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6862325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6863325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6864325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6865325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6866325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6867325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6868325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6869325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6870325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6871325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6872325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6873325fc9f4SBarry Smith PetscFunctionReturn(0); 6874325fc9f4SBarry Smith } 6875325fc9f4SBarry Smith 6876325fc9f4SBarry Smith /* 6877325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6878325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6879e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6880325fc9f4SBarry Smith 6881325fc9f4SBarry Smith Logically Collective on TS 6882325fc9f4SBarry Smith 6883325fc9f4SBarry Smith Input Parameters: 6884325fc9f4SBarry Smith + ts - the TS context 6885325fc9f4SBarry Smith - func - function evaluation routine 6886325fc9f4SBarry Smith 6887325fc9f4SBarry Smith Calling sequence of func: 68880910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6889325fc9f4SBarry Smith 6890325fc9f4SBarry Smith Level: beginner 6891325fc9f4SBarry Smith 6892325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6893325fc9f4SBarry Smith 6894325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6895325fc9f4SBarry Smith */ 6896cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6897325fc9f4SBarry Smith { 6898325fc9f4SBarry Smith PetscErrorCode ierr; 6899325fc9f4SBarry Smith TSMatlabContext *sctx; 6900325fc9f4SBarry Smith 6901325fc9f4SBarry Smith PetscFunctionBegin; 6902325fc9f4SBarry Smith /* currently sctx is memory bleed */ 690395dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6904325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6905325fc9f4SBarry Smith /* 6906325fc9f4SBarry Smith This should work, but it doesn't 6907325fc9f4SBarry Smith sctx->ctx = ctx; 6908325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6909325fc9f4SBarry Smith */ 6910325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6911bbd56ea5SKarl Rupp 69120298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6913325fc9f4SBarry Smith PetscFunctionReturn(0); 6914325fc9f4SBarry Smith } 6915325fc9f4SBarry Smith 6916325fc9f4SBarry Smith /* 6917325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6918325fc9f4SBarry Smith TSSetJacobianMatlab(). 6919325fc9f4SBarry Smith 6920325fc9f4SBarry Smith Collective on TS 6921325fc9f4SBarry Smith 6922325fc9f4SBarry Smith Input Parameters: 6923cdcf91faSSean Farley + ts - the TS context 69240910c330SBarry Smith . u - input vector 6925325fc9f4SBarry Smith . A, B - the matrices 6926325fc9f4SBarry Smith - ctx - user context 6927325fc9f4SBarry Smith 6928325fc9f4SBarry Smith Level: developer 6929325fc9f4SBarry Smith 6930325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6931325fc9f4SBarry Smith 6932325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6933325fc9f4SBarry Smith @*/ 6934f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6935325fc9f4SBarry Smith { 6936325fc9f4SBarry Smith PetscErrorCode ierr; 6937325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6938325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6939325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6940325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6941325fc9f4SBarry Smith 6942325fc9f4SBarry Smith PetscFunctionBegin; 6943cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 69440910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6945325fc9f4SBarry Smith 69460910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6947325fc9f4SBarry Smith 6948cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 69490910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 69500910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 69510910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 69520910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6953bbd56ea5SKarl Rupp 6954325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6955325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6956325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6957325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6958325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6959325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6960325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6961325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6962325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6963325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6964325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6965325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6966325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6967325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6968325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6969325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6970325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6971325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6972325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6973325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6974325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6975325fc9f4SBarry Smith PetscFunctionReturn(0); 6976325fc9f4SBarry Smith } 6977325fc9f4SBarry Smith 6978325fc9f4SBarry Smith /* 6979325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6980e3c5b3baSBarry 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 6981325fc9f4SBarry Smith 6982325fc9f4SBarry Smith Logically Collective on TS 6983325fc9f4SBarry Smith 6984325fc9f4SBarry Smith Input Parameters: 6985cdcf91faSSean Farley + ts - the TS context 6986325fc9f4SBarry Smith . A,B - Jacobian matrices 6987325fc9f4SBarry Smith . func - function evaluation routine 6988325fc9f4SBarry Smith - ctx - user context 6989325fc9f4SBarry Smith 6990325fc9f4SBarry Smith Calling sequence of func: 69910910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6992325fc9f4SBarry Smith 6993325fc9f4SBarry Smith Level: developer 6994325fc9f4SBarry Smith 6995325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6996325fc9f4SBarry Smith 6997325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6998325fc9f4SBarry Smith */ 6999cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 7000325fc9f4SBarry Smith { 7001325fc9f4SBarry Smith PetscErrorCode ierr; 7002325fc9f4SBarry Smith TSMatlabContext *sctx; 7003325fc9f4SBarry Smith 7004325fc9f4SBarry Smith PetscFunctionBegin; 7005325fc9f4SBarry Smith /* currently sctx is memory bleed */ 700695dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 7007325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 7008325fc9f4SBarry Smith /* 7009325fc9f4SBarry Smith This should work, but it doesn't 7010325fc9f4SBarry Smith sctx->ctx = ctx; 7011325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 7012325fc9f4SBarry Smith */ 7013325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 7014bbd56ea5SKarl Rupp 7015cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 7016325fc9f4SBarry Smith PetscFunctionReturn(0); 7017325fc9f4SBarry Smith } 7018325fc9f4SBarry Smith 7019b5b1a830SBarry Smith /* 7020b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 7021b5b1a830SBarry Smith 7022b5b1a830SBarry Smith Collective on TS 7023b5b1a830SBarry Smith 7024b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 7025b5b1a830SBarry Smith @*/ 70260910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 7027b5b1a830SBarry Smith { 7028b5b1a830SBarry Smith PetscErrorCode ierr; 7029b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 7030a530c242SBarry Smith int nlhs = 1,nrhs = 6; 7031b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 7032b5b1a830SBarry Smith long long int lx = 0,ls = 0; 7033b5b1a830SBarry Smith 7034b5b1a830SBarry Smith PetscFunctionBegin; 7035cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 70360910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 7037b5b1a830SBarry Smith 7038cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 70390910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 7040bbd56ea5SKarl Rupp 7041b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 7042b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 7043b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 7044b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 7045b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 7046b5b1a830SBarry Smith prhs[5] = sctx->ctx; 7047b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 7048b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 7049b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 7050b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 7051b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 7052b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 7053b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 7054b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 7055b5b1a830SBarry Smith PetscFunctionReturn(0); 7056b5b1a830SBarry Smith } 7057b5b1a830SBarry Smith 7058b5b1a830SBarry Smith /* 7059b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 7060b5b1a830SBarry Smith 7061b5b1a830SBarry Smith Level: developer 7062b5b1a830SBarry Smith 7063b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 7064b5b1a830SBarry Smith 7065b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 7066b5b1a830SBarry Smith */ 7067cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 7068b5b1a830SBarry Smith { 7069b5b1a830SBarry Smith PetscErrorCode ierr; 7070b5b1a830SBarry Smith TSMatlabContext *sctx; 7071b5b1a830SBarry Smith 7072b5b1a830SBarry Smith PetscFunctionBegin; 7073b5b1a830SBarry Smith /* currently sctx is memory bleed */ 707495dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 7075b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 7076b5b1a830SBarry Smith /* 7077b5b1a830SBarry Smith This should work, but it doesn't 7078b5b1a830SBarry Smith sctx->ctx = ctx; 7079b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 7080b5b1a830SBarry Smith */ 7081b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 7082bbd56ea5SKarl Rupp 70830298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 7084b5b1a830SBarry Smith PetscFunctionReturn(0); 7085b5b1a830SBarry Smith } 7086325fc9f4SBarry Smith #endif 7087b3603a34SBarry Smith 7088b3603a34SBarry Smith /*@C 70894f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 7090b3603a34SBarry Smith in a time based line graph 7091b3603a34SBarry Smith 7092b3603a34SBarry Smith Collective on TS 7093b3603a34SBarry Smith 7094b3603a34SBarry Smith Input Parameters: 7095b3603a34SBarry Smith + ts - the TS context 7096b3603a34SBarry Smith . step - current time-step 7097b3603a34SBarry Smith . ptime - current time 70987db568b7SBarry Smith . u - current solution 70997db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 7100b3603a34SBarry Smith 7101b3d3934dSBarry Smith Options Database: 71029ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 7103b3d3934dSBarry Smith 7104b3603a34SBarry Smith Level: intermediate 7105b3603a34SBarry Smith 71066934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component solutions in a separate window 7107b3603a34SBarry Smith 7108b3603a34SBarry Smith .keywords: TS, vector, monitor, view 7109b3603a34SBarry Smith 71107db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 71117db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 71127db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 71137db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 7114b3603a34SBarry Smith @*/ 71157db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7116b3603a34SBarry Smith { 7117b3603a34SBarry Smith PetscErrorCode ierr; 71187db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 7119b3603a34SBarry Smith const PetscScalar *yy; 712080666b62SBarry Smith Vec v; 7121b3603a34SBarry Smith 7122b3603a34SBarry Smith PetscFunctionBegin; 712363e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 712458ff32f7SBarry Smith if (!step) { 7125a9f9c1f6SBarry Smith PetscDrawAxis axis; 71266934998bSLisandro Dalcin PetscInt dim; 7127a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7128a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 7129bab0a581SBarry Smith if (!ctx->names) { 7130bab0a581SBarry Smith PetscBool flg; 7131bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 7132bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 7133bab0a581SBarry Smith if (flg) { 7134bab0a581SBarry Smith PetscInt i,n; 7135bab0a581SBarry Smith char **names; 7136bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 7137bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 7138bab0a581SBarry Smith for (i=0; i<n; i++) { 7139bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 7140bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 7141bab0a581SBarry Smith } 7142bab0a581SBarry Smith names[n] = NULL; 7143bab0a581SBarry Smith ctx->names = names; 7144bab0a581SBarry Smith } 7145bab0a581SBarry Smith } 7146387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 7147387f4636SBarry Smith char **displaynames; 7148387f4636SBarry Smith PetscBool flg; 7149387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 715095dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 7151387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 7152c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 7153387f4636SBarry Smith if (flg) { 7154a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 7155387f4636SBarry Smith } 7156387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 7157387f4636SBarry Smith } 7158387f4636SBarry Smith if (ctx->displaynames) { 7159387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 7160387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 7161387f4636SBarry Smith } else if (ctx->names) { 71620910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 71630b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7164387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 7165b0bc92c6SBarry Smith } else { 7166b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 7167b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7168387f4636SBarry Smith } 71690b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 717058ff32f7SBarry Smith } 71716934998bSLisandro Dalcin 71726934998bSLisandro Dalcin if (!ctx->transform) v = u; 71736934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 717480666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 71756934998bSLisandro Dalcin if (ctx->displaynames) { 71766934998bSLisandro Dalcin PetscInt i; 71776934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 71786934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 71796934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 71806934998bSLisandro Dalcin } else { 7181e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7182e3efe391SJed Brown PetscInt i,n; 71836934998bSLisandro Dalcin PetscReal *yreal; 718480666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 7185785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7186e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 71870b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7188e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7189e3efe391SJed Brown #else 71900b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7191e3efe391SJed Brown #endif 719280666b62SBarry Smith } 71936934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 71946934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 71956934998bSLisandro Dalcin 7196b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 71970b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 71986934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 71993923b477SBarry Smith } 7200b3603a34SBarry Smith PetscFunctionReturn(0); 7201b3603a34SBarry Smith } 7202b3603a34SBarry Smith 7203b037adc7SBarry Smith /*@C 720431152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7205b037adc7SBarry Smith 7206b037adc7SBarry Smith Collective on TS 7207b037adc7SBarry Smith 7208b037adc7SBarry Smith Input Parameters: 7209b037adc7SBarry Smith + ts - the TS context 7210b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 7211b037adc7SBarry Smith 7212b037adc7SBarry Smith Level: intermediate 7213b037adc7SBarry Smith 72147db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 72157db568b7SBarry Smith 7216b037adc7SBarry Smith .keywords: TS, vector, monitor, view 7217b037adc7SBarry Smith 7218a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 7219b037adc7SBarry Smith @*/ 722031152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 7221b037adc7SBarry Smith { 7222b037adc7SBarry Smith PetscErrorCode ierr; 7223b037adc7SBarry Smith PetscInt i; 7224b037adc7SBarry Smith 7225b037adc7SBarry Smith PetscFunctionBegin; 7226b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7227b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 72285537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 7229b3d3934dSBarry Smith break; 7230b3d3934dSBarry Smith } 7231b3d3934dSBarry Smith } 7232b3d3934dSBarry Smith PetscFunctionReturn(0); 7233b3d3934dSBarry Smith } 7234b3d3934dSBarry Smith 7235e673d494SBarry Smith /*@C 7236e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 7237e673d494SBarry Smith 7238e673d494SBarry Smith Collective on TS 7239e673d494SBarry Smith 7240e673d494SBarry Smith Input Parameters: 7241e673d494SBarry Smith + ts - the TS context 7242e673d494SBarry Smith - names - the names of the components, final string must be NULL 7243e673d494SBarry Smith 7244e673d494SBarry Smith Level: intermediate 7245e673d494SBarry Smith 7246e673d494SBarry Smith .keywords: TS, vector, monitor, view 7247e673d494SBarry Smith 7248a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 7249e673d494SBarry Smith @*/ 7250e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 7251e673d494SBarry Smith { 7252e673d494SBarry Smith PetscErrorCode ierr; 7253e673d494SBarry Smith 7254e673d494SBarry Smith PetscFunctionBegin; 7255e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 7256e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 7257e673d494SBarry Smith PetscFunctionReturn(0); 7258e673d494SBarry Smith } 7259e673d494SBarry Smith 7260b3d3934dSBarry Smith /*@C 7261b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 7262b3d3934dSBarry Smith 7263b3d3934dSBarry Smith Collective on TS 7264b3d3934dSBarry Smith 7265b3d3934dSBarry Smith Input Parameter: 7266b3d3934dSBarry Smith . ts - the TS context 7267b3d3934dSBarry Smith 7268b3d3934dSBarry Smith Output Parameter: 7269b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 7270b3d3934dSBarry Smith 7271b3d3934dSBarry Smith Level: intermediate 7272b3d3934dSBarry Smith 72737db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 72747db568b7SBarry Smith 7275b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7276b3d3934dSBarry Smith 7277b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7278b3d3934dSBarry Smith @*/ 7279b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 7280b3d3934dSBarry Smith { 7281b3d3934dSBarry Smith PetscInt i; 7282b3d3934dSBarry Smith 7283b3d3934dSBarry Smith PetscFunctionBegin; 7284b3d3934dSBarry Smith *names = NULL; 7285b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7286b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 72875537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 7288b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 7289b3d3934dSBarry Smith break; 7290387f4636SBarry Smith } 7291387f4636SBarry Smith } 7292387f4636SBarry Smith PetscFunctionReturn(0); 7293387f4636SBarry Smith } 7294387f4636SBarry Smith 7295a66092f1SBarry Smith /*@C 7296a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 7297a66092f1SBarry Smith 7298a66092f1SBarry Smith Collective on TS 7299a66092f1SBarry Smith 7300a66092f1SBarry Smith Input Parameters: 7301a66092f1SBarry Smith + ctx - the TSMonitorLG context 7302a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 7303a66092f1SBarry Smith 7304a66092f1SBarry Smith Level: intermediate 7305a66092f1SBarry Smith 7306a66092f1SBarry Smith .keywords: TS, vector, monitor, view 7307a66092f1SBarry Smith 7308a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7309a66092f1SBarry Smith @*/ 7310a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 7311a66092f1SBarry Smith { 7312a66092f1SBarry Smith PetscInt j = 0,k; 7313a66092f1SBarry Smith PetscErrorCode ierr; 7314a66092f1SBarry Smith 7315a66092f1SBarry Smith PetscFunctionBegin; 7316a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 7317a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 7318a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 7319a66092f1SBarry Smith while (displaynames[j]) j++; 7320a66092f1SBarry Smith ctx->ndisplayvariables = j; 7321a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 7322a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 7323a66092f1SBarry Smith j = 0; 7324a66092f1SBarry Smith while (displaynames[j]) { 7325a66092f1SBarry Smith k = 0; 7326a66092f1SBarry Smith while (ctx->names[k]) { 7327a66092f1SBarry Smith PetscBool flg; 7328a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 7329a66092f1SBarry Smith if (flg) { 7330a66092f1SBarry Smith ctx->displayvariables[j] = k; 7331a66092f1SBarry Smith break; 7332a66092f1SBarry Smith } 7333a66092f1SBarry Smith k++; 7334a66092f1SBarry Smith } 7335a66092f1SBarry Smith j++; 7336a66092f1SBarry Smith } 7337a66092f1SBarry Smith PetscFunctionReturn(0); 7338a66092f1SBarry Smith } 7339a66092f1SBarry Smith 7340387f4636SBarry Smith /*@C 7341387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 7342387f4636SBarry Smith 7343387f4636SBarry Smith Collective on TS 7344387f4636SBarry Smith 7345387f4636SBarry Smith Input Parameters: 7346387f4636SBarry Smith + ts - the TS context 7347387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 7348387f4636SBarry Smith 73497db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 73507db568b7SBarry Smith 7351387f4636SBarry Smith Level: intermediate 7352387f4636SBarry Smith 7353387f4636SBarry Smith .keywords: TS, vector, monitor, view 7354387f4636SBarry Smith 7355387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 7356387f4636SBarry Smith @*/ 7357387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 7358387f4636SBarry Smith { 7359a66092f1SBarry Smith PetscInt i; 7360387f4636SBarry Smith PetscErrorCode ierr; 7361387f4636SBarry Smith 7362387f4636SBarry Smith PetscFunctionBegin; 7363387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7364387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 73655537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 7366b3d3934dSBarry Smith break; 7367b037adc7SBarry Smith } 7368b037adc7SBarry Smith } 7369b037adc7SBarry Smith PetscFunctionReturn(0); 7370b037adc7SBarry Smith } 7371b037adc7SBarry Smith 737280666b62SBarry Smith /*@C 737380666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 737480666b62SBarry Smith 737580666b62SBarry Smith Collective on TS 737680666b62SBarry Smith 737780666b62SBarry Smith Input Parameters: 737880666b62SBarry Smith + ts - the TS context 737980666b62SBarry Smith . transform - the transform function 73807684fa3eSBarry Smith . destroy - function to destroy the optional context 738180666b62SBarry Smith - ctx - optional context used by transform function 738280666b62SBarry Smith 73837db568b7SBarry Smith Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 73847db568b7SBarry Smith 738580666b62SBarry Smith Level: intermediate 738680666b62SBarry Smith 738780666b62SBarry Smith .keywords: TS, vector, monitor, view 738880666b62SBarry Smith 7389a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 739080666b62SBarry Smith @*/ 73917684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 739280666b62SBarry Smith { 739380666b62SBarry Smith PetscInt i; 7394a66092f1SBarry Smith PetscErrorCode ierr; 739580666b62SBarry Smith 739680666b62SBarry Smith PetscFunctionBegin; 739780666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 739880666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 73995537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 740080666b62SBarry Smith } 740180666b62SBarry Smith } 740280666b62SBarry Smith PetscFunctionReturn(0); 740380666b62SBarry Smith } 740480666b62SBarry Smith 7405e673d494SBarry Smith /*@C 7406e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 7407e673d494SBarry Smith 7408e673d494SBarry Smith Collective on TSLGCtx 7409e673d494SBarry Smith 7410e673d494SBarry Smith Input Parameters: 7411e673d494SBarry Smith + ts - the TS context 7412e673d494SBarry Smith . transform - the transform function 74137684fa3eSBarry Smith . destroy - function to destroy the optional context 7414e673d494SBarry Smith - ctx - optional context used by transform function 7415e673d494SBarry Smith 7416e673d494SBarry Smith Level: intermediate 7417e673d494SBarry Smith 7418e673d494SBarry Smith .keywords: TS, vector, monitor, view 7419e673d494SBarry Smith 7420a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 7421e673d494SBarry Smith @*/ 74227684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 7423e673d494SBarry Smith { 7424e673d494SBarry Smith PetscFunctionBegin; 7425e673d494SBarry Smith ctx->transform = transform; 74267684fa3eSBarry Smith ctx->transformdestroy = destroy; 7427e673d494SBarry Smith ctx->transformctx = tctx; 7428e673d494SBarry Smith PetscFunctionReturn(0); 7429e673d494SBarry Smith } 7430e673d494SBarry Smith 7431ef20d060SBarry Smith /*@C 74324f09c107SBarry Smith TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector 7433ef20d060SBarry Smith in a time based line graph 7434ef20d060SBarry Smith 7435ef20d060SBarry Smith Collective on TS 7436ef20d060SBarry Smith 7437ef20d060SBarry Smith Input Parameters: 7438ef20d060SBarry Smith + ts - the TS context 7439ef20d060SBarry Smith . step - current time-step 7440ef20d060SBarry Smith . ptime - current time 74417db568b7SBarry Smith . u - current solution 74427db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 7443ef20d060SBarry Smith 7444ef20d060SBarry Smith Level: intermediate 7445ef20d060SBarry Smith 74466934998bSLisandro Dalcin Notes: Each process in a parallel run displays its component errors in a separate window 7447abd5a294SJed Brown 7448abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 7449abd5a294SJed Brown 7450abd5a294SJed Brown Options Database Keys: 74514f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 7452ef20d060SBarry Smith 7453ef20d060SBarry Smith .keywords: TS, vector, monitor, view 7454ef20d060SBarry Smith 7455abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 7456ef20d060SBarry Smith @*/ 74570910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 7458ef20d060SBarry Smith { 7459ef20d060SBarry Smith PetscErrorCode ierr; 74600b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 7461ef20d060SBarry Smith const PetscScalar *yy; 7462ef20d060SBarry Smith Vec y; 7463ef20d060SBarry Smith 7464ef20d060SBarry Smith PetscFunctionBegin; 7465a9f9c1f6SBarry Smith if (!step) { 7466a9f9c1f6SBarry Smith PetscDrawAxis axis; 74676934998bSLisandro Dalcin PetscInt dim; 7468a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 74691ae185eaSBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr); 74700910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 7471a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 7472a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7473a9f9c1f6SBarry Smith } 74740910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 7475ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 74760910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7477ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 7478e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 7479e3efe391SJed Brown { 7480e3efe391SJed Brown PetscReal *yreal; 7481e3efe391SJed Brown PetscInt i,n; 7482e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 7483785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 7484e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 74850b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 7486e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 7487e3efe391SJed Brown } 7488e3efe391SJed Brown #else 74890b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 7490e3efe391SJed Brown #endif 7491ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 7492ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 7493b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 74940b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 74956934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 74963923b477SBarry Smith } 7497ef20d060SBarry Smith PetscFunctionReturn(0); 7498ef20d060SBarry Smith } 7499ef20d060SBarry Smith 7500201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7501201da799SBarry Smith { 7502201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7503201da799SBarry Smith PetscReal x = ptime,y; 7504201da799SBarry Smith PetscErrorCode ierr; 7505201da799SBarry Smith PetscInt its; 7506201da799SBarry Smith 7507201da799SBarry Smith PetscFunctionBegin; 750863e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7509201da799SBarry Smith if (!n) { 7510201da799SBarry Smith PetscDrawAxis axis; 7511201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7512201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7513201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7514201da799SBarry Smith ctx->snes_its = 0; 7515201da799SBarry Smith } 7516201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7517201da799SBarry Smith y = its - ctx->snes_its; 7518201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 75193fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7520201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 75216934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7522201da799SBarry Smith } 7523201da799SBarry Smith ctx->snes_its = its; 7524201da799SBarry Smith PetscFunctionReturn(0); 7525201da799SBarry Smith } 7526201da799SBarry Smith 7527201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7528201da799SBarry Smith { 7529201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7530201da799SBarry Smith PetscReal x = ptime,y; 7531201da799SBarry Smith PetscErrorCode ierr; 7532201da799SBarry Smith PetscInt its; 7533201da799SBarry Smith 7534201da799SBarry Smith PetscFunctionBegin; 753563e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7536201da799SBarry Smith if (!n) { 7537201da799SBarry Smith PetscDrawAxis axis; 7538201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7539201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7540201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7541201da799SBarry Smith ctx->ksp_its = 0; 7542201da799SBarry Smith } 7543201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7544201da799SBarry Smith y = its - ctx->ksp_its; 7545201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 754699fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7547201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 75486934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7549201da799SBarry Smith } 7550201da799SBarry Smith ctx->ksp_its = its; 7551201da799SBarry Smith PetscFunctionReturn(0); 7552201da799SBarry Smith } 7553f9c1d6abSBarry Smith 7554f9c1d6abSBarry Smith /*@ 7555f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7556f9c1d6abSBarry Smith 7557f9c1d6abSBarry Smith Collective on TS and Vec 7558f9c1d6abSBarry Smith 7559f9c1d6abSBarry Smith Input Parameters: 7560f9c1d6abSBarry Smith + ts - the TS context 7561f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7562f9c1d6abSBarry Smith 7563f9c1d6abSBarry Smith Output Parameters: 7564f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7565f9c1d6abSBarry Smith 7566f9c1d6abSBarry Smith Level: developer 7567f9c1d6abSBarry Smith 7568f9c1d6abSBarry Smith .keywords: TS, compute 7569f9c1d6abSBarry Smith 7570f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7571f9c1d6abSBarry Smith @*/ 7572f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7573f9c1d6abSBarry Smith { 7574f9c1d6abSBarry Smith PetscErrorCode ierr; 7575f9c1d6abSBarry Smith 7576f9c1d6abSBarry Smith PetscFunctionBegin; 7577f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7578ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7579f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7580f9c1d6abSBarry Smith PetscFunctionReturn(0); 7581f9c1d6abSBarry Smith } 758224655328SShri 7583b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7584b3d3934dSBarry Smith /*@C 7585b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7586b3d3934dSBarry Smith 7587b3d3934dSBarry Smith Collective on TS 7588b3d3934dSBarry Smith 7589b3d3934dSBarry Smith Input Parameters: 7590b3d3934dSBarry Smith . ts - the ODE solver object 7591b3d3934dSBarry Smith 7592b3d3934dSBarry Smith Output Parameter: 7593b3d3934dSBarry Smith . ctx - the context 7594b3d3934dSBarry Smith 7595b3d3934dSBarry Smith Level: intermediate 7596b3d3934dSBarry Smith 7597b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 7598b3d3934dSBarry Smith 7599b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7600b3d3934dSBarry Smith 7601b3d3934dSBarry Smith @*/ 7602b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7603b3d3934dSBarry Smith { 7604b3d3934dSBarry Smith PetscErrorCode ierr; 7605b3d3934dSBarry Smith 7606b3d3934dSBarry Smith PetscFunctionBegin; 7607a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7608b3d3934dSBarry Smith PetscFunctionReturn(0); 7609b3d3934dSBarry Smith } 7610b3d3934dSBarry Smith 7611b3d3934dSBarry Smith /*@C 7612b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7613b3d3934dSBarry Smith 7614b3d3934dSBarry Smith Collective on TS 7615b3d3934dSBarry Smith 7616b3d3934dSBarry Smith Input Parameters: 7617b3d3934dSBarry Smith + ts - the TS context 7618b3d3934dSBarry Smith . step - current time-step 7619b3d3934dSBarry Smith . ptime - current time 76207db568b7SBarry Smith . u - current solution 76217db568b7SBarry Smith - dctx - the envelope context 7622b3d3934dSBarry Smith 7623b3d3934dSBarry Smith Options Database: 7624b3d3934dSBarry Smith . -ts_monitor_envelope 7625b3d3934dSBarry Smith 7626b3d3934dSBarry Smith Level: intermediate 7627b3d3934dSBarry Smith 7628b3d3934dSBarry Smith Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7629b3d3934dSBarry Smith 7630b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7631b3d3934dSBarry Smith 76327db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7633b3d3934dSBarry Smith @*/ 76347db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7635b3d3934dSBarry Smith { 7636b3d3934dSBarry Smith PetscErrorCode ierr; 76377db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7638b3d3934dSBarry Smith 7639b3d3934dSBarry Smith PetscFunctionBegin; 7640b3d3934dSBarry Smith if (!ctx->max) { 7641b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7642b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7643b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7644b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7645b3d3934dSBarry Smith } else { 7646b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7647b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7648b3d3934dSBarry Smith } 7649b3d3934dSBarry Smith PetscFunctionReturn(0); 7650b3d3934dSBarry Smith } 7651b3d3934dSBarry Smith 7652b3d3934dSBarry Smith /*@C 7653b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7654b3d3934dSBarry Smith 7655b3d3934dSBarry Smith Collective on TS 7656b3d3934dSBarry Smith 7657b3d3934dSBarry Smith Input Parameter: 7658b3d3934dSBarry Smith . ts - the TS context 7659b3d3934dSBarry Smith 7660b3d3934dSBarry Smith Output Parameter: 7661b3d3934dSBarry Smith + max - the maximum values 7662b3d3934dSBarry Smith - min - the minimum values 7663b3d3934dSBarry Smith 76647db568b7SBarry Smith Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 76657db568b7SBarry Smith 7666b3d3934dSBarry Smith Level: intermediate 7667b3d3934dSBarry Smith 7668b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7669b3d3934dSBarry Smith 7670b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7671b3d3934dSBarry Smith @*/ 7672b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7673b3d3934dSBarry Smith { 7674b3d3934dSBarry Smith PetscInt i; 7675b3d3934dSBarry Smith 7676b3d3934dSBarry Smith PetscFunctionBegin; 7677b3d3934dSBarry Smith if (max) *max = NULL; 7678b3d3934dSBarry Smith if (min) *min = NULL; 7679b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7680b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 76815537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7682b3d3934dSBarry Smith if (max) *max = ctx->max; 7683b3d3934dSBarry Smith if (min) *min = ctx->min; 7684b3d3934dSBarry Smith break; 7685b3d3934dSBarry Smith } 7686b3d3934dSBarry Smith } 7687b3d3934dSBarry Smith PetscFunctionReturn(0); 7688b3d3934dSBarry Smith } 7689b3d3934dSBarry Smith 7690b3d3934dSBarry Smith /*@C 7691b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7692b3d3934dSBarry Smith 7693b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7694b3d3934dSBarry Smith 7695b3d3934dSBarry Smith Input Parameter: 7696b3d3934dSBarry Smith . ctx - the monitor context 7697b3d3934dSBarry Smith 7698b3d3934dSBarry Smith Level: intermediate 7699b3d3934dSBarry Smith 7700b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7701b3d3934dSBarry Smith 77027db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7703b3d3934dSBarry Smith @*/ 7704b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7705b3d3934dSBarry Smith { 7706b3d3934dSBarry Smith PetscErrorCode ierr; 7707b3d3934dSBarry Smith 7708b3d3934dSBarry Smith PetscFunctionBegin; 7709b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7710b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7711b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7712b3d3934dSBarry Smith PetscFunctionReturn(0); 7713b3d3934dSBarry Smith } 7714f2dee214SBarry Smith 771524655328SShri /*@ 771624655328SShri TSRollBack - Rolls back one time step 771724655328SShri 771824655328SShri Collective on TS 771924655328SShri 772024655328SShri Input Parameter: 772124655328SShri . ts - the TS context obtained from TSCreate() 772224655328SShri 772324655328SShri Level: advanced 772424655328SShri 772524655328SShri .keywords: TS, timestep, rollback 772624655328SShri 772724655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 772824655328SShri @*/ 772924655328SShri PetscErrorCode TSRollBack(TS ts) 773024655328SShri { 773124655328SShri PetscErrorCode ierr; 773224655328SShri 773324655328SShri PetscFunctionBegin; 773424655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7735b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 773624655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 773724655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 773824655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 773924655328SShri ts->ptime = ts->ptime_prev; 7740be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 7741be5899b3SLisandro Dalcin ts->steps--; ts->total_steps--; 774210b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 7743b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 774424655328SShri PetscFunctionReturn(0); 774524655328SShri } 7746aeb4809dSShri Abhyankar 7747ff22ae23SHong Zhang /*@ 7748ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7749ff22ae23SHong Zhang 7750ff22ae23SHong Zhang Input Parameter: 7751ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7752ff22ae23SHong Zhang 7753ff22ae23SHong Zhang Level: advanced 7754ff22ae23SHong Zhang 7755ff22ae23SHong Zhang .keywords: TS, getstages 7756ff22ae23SHong Zhang 7757ff22ae23SHong Zhang .seealso: TSCreate() 7758ff22ae23SHong Zhang @*/ 7759ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7760ff22ae23SHong Zhang { 7761ff22ae23SHong Zhang PetscErrorCode ierr; 7762ff22ae23SHong Zhang 7763ff22ae23SHong Zhang PetscFunctionBegin; 7764ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7765ff22ae23SHong Zhang PetscValidPointer(ns,2); 7766ff22ae23SHong Zhang 7767ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 7768ff22ae23SHong Zhang else { 7769ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7770ff22ae23SHong Zhang } 7771ff22ae23SHong Zhang PetscFunctionReturn(0); 7772ff22ae23SHong Zhang } 7773ff22ae23SHong Zhang 7774847ff0e1SMatthew G. Knepley /*@C 7775847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7776847ff0e1SMatthew G. Knepley 7777847ff0e1SMatthew G. Knepley Collective on SNES 7778847ff0e1SMatthew G. Knepley 7779847ff0e1SMatthew G. Knepley Input Parameters: 7780847ff0e1SMatthew G. Knepley + ts - the TS context 7781847ff0e1SMatthew G. Knepley . t - current timestep 7782847ff0e1SMatthew G. Knepley . U - state vector 7783847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7784847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7785847ff0e1SMatthew G. Knepley - ctx - an optional user context 7786847ff0e1SMatthew G. Knepley 7787847ff0e1SMatthew G. Knepley Output Parameters: 7788847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7789847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7790847ff0e1SMatthew G. Knepley 7791847ff0e1SMatthew G. Knepley Level: intermediate 7792847ff0e1SMatthew G. Knepley 7793847ff0e1SMatthew G. Knepley Notes: 7794847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7795847ff0e1SMatthew G. Knepley 7796847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7797847ff0e1SMatthew G. Knepley 7798847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7799847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7800847ff0e1SMatthew G. Knepley 7801847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7802847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7803847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7804847ff0e1SMatthew G. Knepley 7805847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7806847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7807847ff0e1SMatthew G. Knepley @*/ 7808847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7809847ff0e1SMatthew G. Knepley { 7810847ff0e1SMatthew G. Knepley SNES snes; 7811847ff0e1SMatthew G. Knepley MatFDColoring color; 7812847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7813847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7814847ff0e1SMatthew G. Knepley 7815847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7816c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7817847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7818847ff0e1SMatthew G. Knepley if (!color) { 7819847ff0e1SMatthew G. Knepley DM dm; 7820847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7821847ff0e1SMatthew G. Knepley 7822847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7823847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7824847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7825847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7826847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7827847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7828847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7829847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7830847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7831847ff0e1SMatthew G. Knepley } else { 7832847ff0e1SMatthew G. Knepley MatColoring mc; 7833847ff0e1SMatthew G. Knepley 7834847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7835847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7836847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7837847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7838847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7839847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7840847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7841847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7842847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7843847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7844847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7845847ff0e1SMatthew G. Knepley } 7846847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7847847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7848847ff0e1SMatthew G. Knepley } 7849847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7850847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7851847ff0e1SMatthew G. Knepley if (J != B) { 7852847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7853847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7854847ff0e1SMatthew G. Knepley } 7855847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7856847ff0e1SMatthew G. Knepley } 785793b34091SDebojyoti Ghosh 7858cb9d8021SPierre Barbier de Reuille /*@ 7859cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7860cb9d8021SPierre Barbier de Reuille 7861cb9d8021SPierre Barbier de Reuille Input Parameters: 7862cb9d8021SPierre Barbier de Reuille ts - the TS context 7863cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7864cb9d8021SPierre Barbier de Reuille 7865cb9d8021SPierre Barbier de Reuille Level: intermediate 7866cb9d8021SPierre Barbier de Reuille 7867cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7868cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7869cb9d8021SPierre Barbier de Reuille @*/ 7870cb9d8021SPierre Barbier de Reuille 7871d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7872cb9d8021SPierre Barbier de Reuille { 7873cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7874cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7875cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7876cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7877cb9d8021SPierre Barbier de Reuille } 7878cb9d8021SPierre Barbier de Reuille 7879cb9d8021SPierre Barbier de Reuille /*@ 7880cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7881cb9d8021SPierre Barbier de Reuille 7882cb9d8021SPierre Barbier de Reuille Input Parameters: 7883cb9d8021SPierre Barbier de Reuille ts - the TS context 7884cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7885d183316bSPierre Barbier de Reuille Y - state vector to check. 7886cb9d8021SPierre Barbier de Reuille 7887cb9d8021SPierre Barbier de Reuille Output Parameter: 7888cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7889cb9d8021SPierre Barbier de Reuille 7890cb9d8021SPierre Barbier de Reuille Note: 7891cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7892cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 789396a0c994SBarry Smith 789496a0c994SBarry Smith Level: advanced 7895cb9d8021SPierre Barbier de Reuille @*/ 7896d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7897cb9d8021SPierre Barbier de Reuille { 7898cb9d8021SPierre Barbier de Reuille PetscErrorCode ierr; 7899cb9d8021SPierre Barbier de Reuille 7900cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7901cb9d8021SPierre Barbier de Reuille 7902cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7903cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7904cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7905d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7906cb9d8021SPierre Barbier de Reuille } 7907cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7908cb9d8021SPierre Barbier de Reuille } 79091ceb14c0SBarry Smith 791093b34091SDebojyoti Ghosh /*@C 7911e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 791293b34091SDebojyoti Ghosh 791393b34091SDebojyoti Ghosh Collective on MPI_Comm 791493b34091SDebojyoti Ghosh 791593b34091SDebojyoti Ghosh Input Parameter: 791693b34091SDebojyoti Ghosh . tsin - The input TS 791793b34091SDebojyoti Ghosh 791893b34091SDebojyoti Ghosh Output Parameter: 7919e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 792093b34091SDebojyoti Ghosh 79215eca1a21SEmil Constantinescu Notes: 79225eca1a21SEmil 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. 79235eca1a21SEmil Constantinescu 7924baa10174SEmil 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); 79255eca1a21SEmil Constantinescu 79265eca1a21SEmil Constantinescu Level: developer 792793b34091SDebojyoti Ghosh 7928e5168f73SEmil Constantinescu .keywords: TS, clone 7929e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 793093b34091SDebojyoti Ghosh @*/ 7931baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 793293b34091SDebojyoti Ghosh { 793393b34091SDebojyoti Ghosh TS t; 793493b34091SDebojyoti Ghosh PetscErrorCode ierr; 7935dc846ba4SSatish Balay SNES snes_start; 7936dc846ba4SSatish Balay DM dm; 7937dc846ba4SSatish Balay TSType type; 793893b34091SDebojyoti Ghosh 793993b34091SDebojyoti Ghosh PetscFunctionBegin; 794093b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 794193b34091SDebojyoti Ghosh *tsout = NULL; 794293b34091SDebojyoti Ghosh 79437a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 794493b34091SDebojyoti Ghosh 794593b34091SDebojyoti Ghosh /* General TS description */ 794693b34091SDebojyoti Ghosh t->numbermonitors = 0; 794793b34091SDebojyoti Ghosh t->setupcalled = 0; 794893b34091SDebojyoti Ghosh t->ksp_its = 0; 794993b34091SDebojyoti Ghosh t->snes_its = 0; 795093b34091SDebojyoti Ghosh t->nwork = 0; 795193b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 795293b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 795393b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 795493b34091SDebojyoti Ghosh 795534561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 795634561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7957d15a3a53SEmil Constantinescu 795893b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 795993b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 796093b34091SDebojyoti Ghosh 796193b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 796251699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 796393b34091SDebojyoti Ghosh 7964e7069c78SShri t->trajectory = tsin->trajectory; 7965e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7966e7069c78SShri 7967e7069c78SShri t->event = tsin->event; 79686b10a48eSSatish Balay if (t->event) t->event->refct++; 7969e7069c78SShri 797093b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 797193b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7972e7069c78SShri t->ptime_prev = tsin->ptime_prev; 797393b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 797493b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 797593b34091SDebojyoti Ghosh t->steps = tsin->steps; 7976e7069c78SShri t->total_steps = tsin->total_steps; 797793b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 797893b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 797993b34091SDebojyoti Ghosh t->atol = tsin->atol; 798093b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 798193b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 798293b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 798393b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 798493b34091SDebojyoti Ghosh 798593b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 798693b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 798793b34091SDebojyoti Ghosh 798893b34091SDebojyoti Ghosh t->vec_sol = NULL; 798993b34091SDebojyoti Ghosh 799093b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 799193b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 799293b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 799393b34091SDebojyoti Ghosh 799493b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 799593b34091SDebojyoti Ghosh 79960d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 79970d4fed19SBarry Smith PetscInt i; 79980d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 79990d4fed19SBarry Smith for (i=0; i<10; i++) { 80000d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 80010d4fed19SBarry Smith } 80020d4fed19SBarry Smith } 800393b34091SDebojyoti Ghosh *tsout = t; 800493b34091SDebojyoti Ghosh PetscFunctionReturn(0); 800593b34091SDebojyoti Ghosh } 8006