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; 9a05bf03eSHong Zhang PetscLogEvent 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 13fde5950dSBarry Smith /*@C 14fde5950dSBarry Smith TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 15fde5950dSBarry Smith 16fde5950dSBarry Smith Collective on TS 17fde5950dSBarry Smith 18fde5950dSBarry Smith Input Parameters: 19fde5950dSBarry Smith + ts - TS object you wish to monitor 20fde5950dSBarry Smith . name - the monitor type one is seeking 21fde5950dSBarry Smith . help - message indicating what monitoring is done 22fde5950dSBarry Smith . manual - manual page for the monitor 23fde5950dSBarry Smith . monitor - the monitor function 24fde5950dSBarry 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 25fde5950dSBarry Smith 26fde5950dSBarry Smith Level: developer 27fde5950dSBarry Smith 28fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 29fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 30fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 31fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 32fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 33fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 34fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 35fde5950dSBarry Smith @*/ 36721cd6eeSBarry 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*)) 37fde5950dSBarry Smith { 38fde5950dSBarry Smith PetscErrorCode ierr; 39fde5950dSBarry Smith PetscViewer viewer; 40fde5950dSBarry Smith PetscViewerFormat format; 41fde5950dSBarry Smith PetscBool flg; 42fde5950dSBarry Smith 43fde5950dSBarry Smith PetscFunctionBegin; 44fde5950dSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 45fde5950dSBarry Smith if (flg) { 46721cd6eeSBarry Smith PetscViewerAndFormat *vf; 47721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 48721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 49fde5950dSBarry Smith if (monitorsetup) { 50721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 51fde5950dSBarry Smith } 52721cd6eeSBarry Smith ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 53fde5950dSBarry Smith } 54fde5950dSBarry Smith PetscFunctionReturn(0); 55fde5950dSBarry Smith } 56fde5950dSBarry Smith 572ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type) 582ffb9264SLisandro Dalcin { 592ffb9264SLisandro Dalcin PetscErrorCode ierr; 602ffb9264SLisandro Dalcin 612ffb9264SLisandro Dalcin PetscFunctionBegin; 62b92453a8SLisandro Dalcin PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 63b92453a8SLisandro Dalcin PetscValidCharPointer(default_type,2); 642ffb9264SLisandro Dalcin if (!((PetscObject)adapt)->type_name) { 652ffb9264SLisandro Dalcin ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr); 662ffb9264SLisandro Dalcin } 672ffb9264SLisandro Dalcin PetscFunctionReturn(0); 682ffb9264SLisandro Dalcin } 692ffb9264SLisandro Dalcin 70bdad233fSMatthew Knepley /*@ 71bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 72bdad233fSMatthew Knepley 73bdad233fSMatthew Knepley Collective on TS 74bdad233fSMatthew Knepley 75bdad233fSMatthew Knepley Input Parameter: 76bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 77bdad233fSMatthew Knepley 78bdad233fSMatthew Knepley Options Database Keys: 796bd7aeb5SHong Zhang + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSI 80ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 81ef85077eSLisandro Dalcin . -ts_max_time <time> - maximum time to compute to 82ef85077eSLisandro Dalcin . -ts_max_steps <steps> - maximum number of time-steps to take 83ef85077eSLisandro Dalcin . -ts_init_time <time> - initial time to start computation 84ef85077eSLisandro Dalcin . -ts_final_time <time> - final time to compute to 853e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 86a3cdaa26SBarry 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 87a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 88a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 89a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 90a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 91a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 92f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function 93f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - test the Jacobian at each iteration against finite difference with RHS function 94ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 95847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 96bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 97de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 98de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 997cf37e64SBarry Smith . -ts_monitor_error - Monitors norm of error 1006934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 1018b668821SLisandro Dalcin . -ts_monitor_lg_timestep_log - Monitor log timestep size graphically 102de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 103de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 104de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 105de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 1063e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 1073e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 108fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 109e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 110110eb670SHong Zhang . -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 11153ea634cSHong Zhang 11291b97e58SBarry Smith Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified 113bdad233fSMatthew Knepley 114bdad233fSMatthew Knepley Level: beginner 115bdad233fSMatthew Knepley 116bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database 117bdad233fSMatthew Knepley 118a313700dSBarry Smith .seealso: TSGetType() 119bdad233fSMatthew Knepley @*/ 1207087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 121bdad233fSMatthew Knepley { 122bc952696SBarry Smith PetscBool opt,flg,tflg; 123dfbe8321SBarry Smith PetscErrorCode ierr; 124eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 12531748224SBarry Smith PetscReal time_step; 12649354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 127d1212d36SBarry Smith char dir[16]; 128cd11d68dSLisandro Dalcin TSIFunction ifun; 1296991f827SBarry Smith const char *defaultType; 1306991f827SBarry Smith char typeName[256]; 131bdad233fSMatthew Knepley 132bdad233fSMatthew Knepley PetscFunctionBegin; 1330700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1346991f827SBarry Smith 1356991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 136cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 137cd11d68dSLisandro Dalcin 138cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 139cd11d68dSLisandro Dalcin if (((PetscObject)ts)->type_name) 140cd11d68dSLisandro Dalcin defaultType = ((PetscObject)ts)->type_name; 141cd11d68dSLisandro Dalcin else 142cd11d68dSLisandro Dalcin defaultType = ifun ? TSBEULER : TSEULER; 1436991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1446991f827SBarry Smith if (opt) { 1456991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1466991f827SBarry Smith } else { 1476991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1486991f827SBarry Smith } 149bdad233fSMatthew Knepley 150bdad233fSMatthew Knepley /* Handle generic TS options */ 151ef85077eSLisandro Dalcin ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 15219eac22cSLisandro Dalcin ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1530298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 154ef85077eSLisandro Dalcin ierr = PetscOptionsReal("-ts_final_time","Final time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 15531748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 156cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 15749354f04SShri 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); 15849354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1590298fd71SBarry 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); 1600298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1610298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1620298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1630298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 164bdad233fSMatthew Knepley 165f3b1f45cSBarry Smith ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult","Test the RHS Jacobian for consistency with RHS at each solve ","None",ts->testjacobian,&ts->testjacobian,NULL);CHKERRQ(ierr); 166f3b1f45cSBarry Smith ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult_transpose","Test the RHS Jacobian transpose for consistency with RHS at each solve ","None",ts->testjacobiantranspose,&ts->testjacobiantranspose,NULL);CHKERRQ(ierr); 16756f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 16856f85f32SBarry Smith { 16956f85f32SBarry Smith PetscBool set; 17056f85f32SBarry Smith flg = PETSC_FALSE; 17156f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 17256f85f32SBarry Smith if (set) { 17356f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 17456f85f32SBarry Smith } 17556f85f32SBarry Smith } 17656f85f32SBarry Smith #endif 17756f85f32SBarry Smith 178bdad233fSMatthew Knepley /* Monitor options */ 179cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 180fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 181fde5950dSBarry Smith 1825180491cSLisandro Dalcin ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 1835180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1845180491cSLisandro Dalcin 1854f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 186b3603a34SBarry Smith if (opt) { 1870b039ecaSBarry Smith TSMonitorLGCtx ctx; 1883923b477SBarry Smith PetscInt howoften = 1; 189b3603a34SBarry Smith 1900298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 1916ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 1924f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 193bdad233fSMatthew Knepley } 1946ba87a44SLisandro Dalcin 1954f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 196ef20d060SBarry Smith if (opt) { 1970b039ecaSBarry Smith TSMonitorLGCtx ctx; 1983923b477SBarry Smith PetscInt howoften = 1; 199ef20d060SBarry Smith 2000298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 2016ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2024f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 203ef20d060SBarry Smith } 204edbaebb3SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr); 2057cf37e64SBarry Smith 2066934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2076934998bSLisandro Dalcin if (opt) { 2086934998bSLisandro Dalcin TSMonitorLGCtx ctx; 2096934998bSLisandro Dalcin PetscInt howoften = 1; 2106934998bSLisandro Dalcin 2116934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2126ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2136934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2146934998bSLisandro Dalcin } 2158b668821SLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2168b668821SLisandro Dalcin if (opt) { 2178b668821SLisandro Dalcin TSMonitorLGCtx ctx; 2188b668821SLisandro Dalcin PetscInt howoften = 1; 2198b668821SLisandro Dalcin 2208b668821SLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2218b668821SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2228b668821SLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2238b668821SLisandro Dalcin ctx->semilogy = PETSC_TRUE; 2248b668821SLisandro Dalcin } 2258b668821SLisandro Dalcin 226201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 227201da799SBarry Smith if (opt) { 228201da799SBarry Smith TSMonitorLGCtx ctx; 229201da799SBarry Smith PetscInt howoften = 1; 230201da799SBarry Smith 2310298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2326ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 233201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 234201da799SBarry Smith } 235201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 236201da799SBarry Smith if (opt) { 237201da799SBarry Smith TSMonitorLGCtx ctx; 238201da799SBarry Smith PetscInt howoften = 1; 239201da799SBarry Smith 2400298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2416ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 242201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 243201da799SBarry Smith } 2448189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2458189c53fSBarry Smith if (opt) { 2468189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2478189c53fSBarry Smith PetscInt howoften = 1; 2488189c53fSBarry Smith 2490298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 2506934998bSLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2518189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2528189c53fSBarry Smith } 253ef20d060SBarry Smith opt = PETSC_FALSE; 2540dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 255a7cc72afSBarry Smith if (opt) { 25683a4ac43SBarry Smith TSMonitorDrawCtx ctx; 25783a4ac43SBarry Smith PetscInt howoften = 1; 258a80ad3e0SBarry Smith 2590298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2600ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 26183a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 262bdad233fSMatthew Knepley } 263fb1732b5SBarry Smith opt = PETSC_FALSE; 2642d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2652d5ee99bSBarry Smith if (opt) { 2662d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2672d5ee99bSBarry Smith PetscReal bounds[4]; 2682d5ee99bSBarry Smith PetscInt n = 4; 2692d5ee99bSBarry Smith PetscDraw draw; 2706934998bSLisandro Dalcin PetscDrawAxis axis; 2712d5ee99bSBarry Smith 2722d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2732d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2746934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 2752d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2766934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 2776934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 2786934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2792d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2802d5ee99bSBarry Smith } 2812d5ee99bSBarry Smith opt = PETSC_FALSE; 2820dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2833a471f94SBarry Smith if (opt) { 28483a4ac43SBarry Smith TSMonitorDrawCtx ctx; 28583a4ac43SBarry Smith PetscInt howoften = 1; 2863a471f94SBarry Smith 2870298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 2880ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 28983a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2903a471f94SBarry Smith } 2910ed3bfb6SBarry Smith opt = PETSC_FALSE; 2920ed3bfb6SBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr); 2930ed3bfb6SBarry Smith if (opt) { 2940ed3bfb6SBarry Smith TSMonitorDrawCtx ctx; 2950ed3bfb6SBarry Smith PetscInt howoften = 1; 2960ed3bfb6SBarry Smith 2970ed3bfb6SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr); 2980ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2990ed3bfb6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3000ed3bfb6SBarry Smith } 301fde5950dSBarry Smith 302ed81e22dSJed Brown opt = PETSC_FALSE; 30391b97e58SBarry 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); 304ed81e22dSJed Brown if (flg) { 305ed81e22dSJed Brown const char *ptr,*ptr2; 306ed81e22dSJed Brown char *filetemplate; 307ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 308ed81e22dSJed Brown /* Do some cursory validation of the input. */ 309ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 310ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 311ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 312ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 313ce94432eSBarry 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"); 314ed81e22dSJed Brown if (ptr2) break; 315ed81e22dSJed Brown } 316ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 317ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 318ed81e22dSJed Brown } 319bdad233fSMatthew Knepley 320d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 321d1212d36SBarry Smith if (flg) { 322d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 323d1212d36SBarry Smith int ray = 0; 324d1212d36SBarry Smith DMDADirection ddir; 325d1212d36SBarry Smith DM da; 326d1212d36SBarry Smith PetscMPIInt rank; 327d1212d36SBarry Smith 328ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 329d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 330d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 331ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 332d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 333d1212d36SBarry Smith 334d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 335b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 336d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 337d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 338ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 339d1212d36SBarry Smith if (!rank) { 340d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 341d1212d36SBarry Smith } 34251b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 343d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 344d1212d36SBarry Smith } 34551b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 34651b4a12fSMatthew G. Knepley if (flg) { 34751b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 34851b4a12fSMatthew G. Knepley int ray = 0; 34951b4a12fSMatthew G. Knepley DMDADirection ddir; 35051b4a12fSMatthew G. Knepley DM da; 35151b4a12fSMatthew G. Knepley PetscInt howoften = 1; 352d1212d36SBarry Smith 35351b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 35451b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 35551b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 35651b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 35751b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3581c3436cfSJed Brown 35951b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 360b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 36151b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 36251b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 36351b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 36451b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 36551b4a12fSMatthew G. Knepley } 366a7a1495cSBarry Smith 367b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 368b3d3934dSBarry Smith if (opt) { 369b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 370b3d3934dSBarry Smith 371b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 372b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 373b3d3934dSBarry Smith } 374b3d3934dSBarry Smith 375847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 376847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 377847ff0e1SMatthew G. Knepley if (flg) { 378847ff0e1SMatthew G. Knepley DM dm; 379847ff0e1SMatthew G. Knepley DMTS tdm; 380847ff0e1SMatthew G. Knepley 381847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 382847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 383847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 384847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 385847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 386847ff0e1SMatthew G. Knepley } 387847ff0e1SMatthew G. Knepley 388d763cef2SBarry Smith /* Handle specific TS options */ 389d763cef2SBarry Smith if (ts->ops->setfromoptions) { 3906991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 391d763cef2SBarry Smith } 392fbc52257SHong Zhang 393a7bdc993SLisandro Dalcin /* Handle TSAdapt options */ 394a7bdc993SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 395a7bdc993SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 396a7bdc993SLisandro Dalcin ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 397a7bdc993SLisandro Dalcin 39868bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 3994f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 40068bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 40168bece0bSHong Zhang if (tflg) { 40268bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 40368bece0bSHong Zhang } 404a05bf03eSHong Zhang 405a05bf03eSHong Zhang ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr); 406d763cef2SBarry Smith 407d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4080633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 409fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 410d763cef2SBarry Smith 4114f122a70SLisandro Dalcin if (ts->trajectory) { 4124f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 413d763cef2SBarry Smith } 41468bece0bSHong Zhang 4154f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4164f122a70SLisandro Dalcin if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);} 4174f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 418d763cef2SBarry Smith PetscFunctionReturn(0); 419d763cef2SBarry Smith } 420d763cef2SBarry Smith 421d2daff3dSHong Zhang /*@ 42278fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 42378fbdcc8SBarry Smith 42478fbdcc8SBarry Smith Collective on TS 42578fbdcc8SBarry Smith 42678fbdcc8SBarry Smith Input Parameters: 42778fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 42878fbdcc8SBarry Smith 42978fbdcc8SBarry Smith Output Parameters; 43078fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 43178fbdcc8SBarry Smith 43278fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 43378fbdcc8SBarry Smith 43478fbdcc8SBarry Smith Level: advanced 43578fbdcc8SBarry Smith 43678fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 43778fbdcc8SBarry Smith 43878fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 43978fbdcc8SBarry Smith @*/ 44078fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 44178fbdcc8SBarry Smith { 44278fbdcc8SBarry Smith PetscFunctionBegin; 44378fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 44478fbdcc8SBarry Smith *tr = ts->trajectory; 44578fbdcc8SBarry Smith PetscFunctionReturn(0); 44678fbdcc8SBarry Smith } 44778fbdcc8SBarry Smith 44878fbdcc8SBarry Smith /*@ 449bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 450d2daff3dSHong Zhang 451d2daff3dSHong Zhang Collective on TS 452d2daff3dSHong Zhang 453d2daff3dSHong Zhang Input Parameters: 454bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 455bc952696SBarry Smith 45678fbdcc8SBarry Smith Options Database: 45778fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 45878fbdcc8SBarry Smith - -ts_trajectory_type type 45978fbdcc8SBarry Smith 46068bece0bSHong Zhang Note: This routine should be called after all TS options have been set 461d2daff3dSHong Zhang 462c3a89c15SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and 46378fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 46478fbdcc8SBarry Smith 465d2daff3dSHong Zhang Level: intermediate 466d2daff3dSHong Zhang 46778fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType() 468d2daff3dSHong Zhang 469bc952696SBarry Smith .keywords: TS, set, checkpoint, 470d2daff3dSHong Zhang @*/ 471bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 472d2daff3dSHong Zhang { 473bc952696SBarry Smith PetscErrorCode ierr; 474bc952696SBarry Smith 475d2daff3dSHong Zhang PetscFunctionBegin; 476d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 477bc952696SBarry Smith if (!ts->trajectory) { 478bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 479bc952696SBarry Smith } 480d2daff3dSHong Zhang PetscFunctionReturn(0); 481d2daff3dSHong Zhang } 482d2daff3dSHong Zhang 483a7a1495cSBarry Smith /*@ 484a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 485a7a1495cSBarry Smith set with TSSetRHSJacobian(). 486a7a1495cSBarry Smith 487a7a1495cSBarry Smith Collective on TS and Vec 488a7a1495cSBarry Smith 489a7a1495cSBarry Smith Input Parameters: 490316643e7SJed Brown + ts - the TS context 491a7a1495cSBarry Smith . t - current timestep 4920910c330SBarry Smith - U - input vector 493a7a1495cSBarry Smith 494a7a1495cSBarry Smith Output Parameters: 495a7a1495cSBarry Smith + A - Jacobian matrix 496a7a1495cSBarry Smith . B - optional preconditioning matrix 497a7a1495cSBarry Smith - flag - flag indicating matrix structure 498a7a1495cSBarry Smith 499a7a1495cSBarry Smith Notes: 500a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 501a7a1495cSBarry Smith is used internally within the nonlinear solvers. 502a7a1495cSBarry Smith 50394b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 504a7a1495cSBarry Smith flag parameter. 505a7a1495cSBarry Smith 506a7a1495cSBarry Smith Level: developer 507a7a1495cSBarry Smith 508a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 509a7a1495cSBarry Smith 51094b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 511a7a1495cSBarry Smith @*/ 512d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 513a7a1495cSBarry Smith { 514dfbe8321SBarry Smith PetscErrorCode ierr; 515270bf2e7SJed Brown PetscObjectState Ustate; 5166c1e1eecSBarry Smith PetscObjectId Uid; 51724989b8cSPeter Brune DM dm; 518942e3340SBarry Smith DMTS tsdm; 51924989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 52024989b8cSPeter Brune void *ctx; 52124989b8cSPeter Brune TSIJacobian ijacobianfunc; 522b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 523a7a1495cSBarry Smith 524a7a1495cSBarry Smith PetscFunctionBegin; 5250700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5260910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5270910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 52824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 529942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 53024989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 5310298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 532b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 53359e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 5346c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 5356c1e1eecSBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 5360e4ef248SJed Brown PetscFunctionReturn(0); 537f8ede8e7SJed Brown } 538d90be118SSean Farley 539ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 540d90be118SSean Farley 541e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 54294ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 54394ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 544303f9b21SStefano Zampini if (B && A != B) { 54594ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 54694ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 547e1244c69SJed Brown } 548e1244c69SJed Brown ts->rhsjacobian.shift = 0; 549e1244c69SJed Brown ts->rhsjacobian.scale = 1.; 550e1244c69SJed Brown } 551e1244c69SJed Brown 55224989b8cSPeter Brune if (rhsjacobianfunc) { 5536cd88445SBarry Smith PetscBool missing; 55494ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 555a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 556d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 557a7a1495cSBarry Smith PetscStackPop; 55894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 5596cd88445SBarry Smith if (A) { 5606cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 5616cd88445SBarry 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"); 5626cd88445SBarry Smith } 5636cd88445SBarry Smith if (B && B != A) { 5646cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 5656cd88445SBarry 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"); 5666cd88445SBarry Smith } 567ef66eb69SBarry Smith } else { 56894ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 56994ab13aaSBarry Smith if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 570ef66eb69SBarry Smith } 5710e4ef248SJed Brown ts->rhsjacobian.time = t; 5727f79407eSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr); 57359e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 574a7a1495cSBarry Smith PetscFunctionReturn(0); 575a7a1495cSBarry Smith } 576a7a1495cSBarry Smith 577316643e7SJed Brown /*@ 578d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 579d763cef2SBarry Smith 580316643e7SJed Brown Collective on TS and Vec 581316643e7SJed Brown 582316643e7SJed Brown Input Parameters: 583316643e7SJed Brown + ts - the TS context 584316643e7SJed Brown . t - current time 5850910c330SBarry Smith - U - state vector 586316643e7SJed Brown 587316643e7SJed Brown Output Parameter: 588316643e7SJed Brown . y - right hand side 589316643e7SJed Brown 590316643e7SJed Brown Note: 591316643e7SJed Brown Most users should not need to explicitly call this routine, as it 592316643e7SJed Brown is used internally within the nonlinear solvers. 593316643e7SJed Brown 594316643e7SJed Brown Level: developer 595316643e7SJed Brown 596316643e7SJed Brown .keywords: TS, compute 597316643e7SJed Brown 598316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 599316643e7SJed Brown @*/ 6000910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 601d763cef2SBarry Smith { 602dfbe8321SBarry Smith PetscErrorCode ierr; 60324989b8cSPeter Brune TSRHSFunction rhsfunction; 60424989b8cSPeter Brune TSIFunction ifunction; 60524989b8cSPeter Brune void *ctx; 60624989b8cSPeter Brune DM dm; 60724989b8cSPeter Brune 608d763cef2SBarry Smith PetscFunctionBegin; 6090700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6100910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6110700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 61224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 61324989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6140298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 615d763cef2SBarry Smith 616ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 617d763cef2SBarry Smith 6180910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 61924989b8cSPeter Brune if (rhsfunction) { 620d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6210910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 622d763cef2SBarry Smith PetscStackPop; 623214bc6a2SJed Brown } else { 624214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 625b2cd27e8SJed Brown } 62644a41b28SSean Farley 6270910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 628d763cef2SBarry Smith PetscFunctionReturn(0); 629d763cef2SBarry Smith } 630d763cef2SBarry Smith 631ef20d060SBarry Smith /*@ 632ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 633ef20d060SBarry Smith 634ef20d060SBarry Smith Collective on TS and Vec 635ef20d060SBarry Smith 636ef20d060SBarry Smith Input Parameters: 637ef20d060SBarry Smith + ts - the TS context 638ef20d060SBarry Smith - t - current time 639ef20d060SBarry Smith 640ef20d060SBarry Smith Output Parameter: 6410910c330SBarry Smith . U - the solution 642ef20d060SBarry Smith 643ef20d060SBarry Smith Note: 644ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 645ef20d060SBarry Smith is used internally within the nonlinear solvers. 646ef20d060SBarry Smith 647ef20d060SBarry Smith Level: developer 648ef20d060SBarry Smith 649ef20d060SBarry Smith .keywords: TS, compute 650ef20d060SBarry Smith 651abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 652ef20d060SBarry Smith @*/ 6530910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 654ef20d060SBarry Smith { 655ef20d060SBarry Smith PetscErrorCode ierr; 656ef20d060SBarry Smith TSSolutionFunction solutionfunction; 657ef20d060SBarry Smith void *ctx; 658ef20d060SBarry Smith DM dm; 659ef20d060SBarry Smith 660ef20d060SBarry Smith PetscFunctionBegin; 661ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6620910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 663ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 664ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 665ef20d060SBarry Smith 666ef20d060SBarry Smith if (solutionfunction) { 6679b7cd975SBarry Smith PetscStackPush("TS user solution function"); 6680910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 669ef20d060SBarry Smith PetscStackPop; 670ef20d060SBarry Smith } 671ef20d060SBarry Smith PetscFunctionReturn(0); 672ef20d060SBarry Smith } 6739b7cd975SBarry Smith /*@ 6749b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 6759b7cd975SBarry Smith 6769b7cd975SBarry Smith Collective on TS and Vec 6779b7cd975SBarry Smith 6789b7cd975SBarry Smith Input Parameters: 6799b7cd975SBarry Smith + ts - the TS context 6809b7cd975SBarry Smith - t - current time 6819b7cd975SBarry Smith 6829b7cd975SBarry Smith Output Parameter: 6839b7cd975SBarry Smith . U - the function value 6849b7cd975SBarry Smith 6859b7cd975SBarry Smith Note: 6869b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 6879b7cd975SBarry Smith is used internally within the nonlinear solvers. 6889b7cd975SBarry Smith 6899b7cd975SBarry Smith Level: developer 6909b7cd975SBarry Smith 6919b7cd975SBarry Smith .keywords: TS, compute 6929b7cd975SBarry Smith 6939b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 6949b7cd975SBarry Smith @*/ 6959b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 6969b7cd975SBarry Smith { 6979b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 6989b7cd975SBarry Smith void *ctx; 6999b7cd975SBarry Smith DM dm; 7009b7cd975SBarry Smith 7019b7cd975SBarry Smith PetscFunctionBegin; 7029b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7039b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7049b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7059b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7069b7cd975SBarry Smith 7079b7cd975SBarry Smith if (forcing) { 7089b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7099b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7109b7cd975SBarry Smith PetscStackPop; 7119b7cd975SBarry Smith } 7129b7cd975SBarry Smith PetscFunctionReturn(0); 7139b7cd975SBarry Smith } 714ef20d060SBarry Smith 715214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 716214bc6a2SJed Brown { 7172dd45cf8SJed Brown Vec F; 718214bc6a2SJed Brown PetscErrorCode ierr; 719214bc6a2SJed Brown 720214bc6a2SJed Brown PetscFunctionBegin; 7210298fd71SBarry Smith *Frhs = NULL; 7220298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 723214bc6a2SJed Brown if (!ts->Frhs) { 7242dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 725214bc6a2SJed Brown } 726214bc6a2SJed Brown *Frhs = ts->Frhs; 727214bc6a2SJed Brown PetscFunctionReturn(0); 728214bc6a2SJed Brown } 729214bc6a2SJed Brown 730214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 731214bc6a2SJed Brown { 732214bc6a2SJed Brown Mat A,B; 7332dd45cf8SJed Brown PetscErrorCode ierr; 73441a1d4d2SBarry Smith TSIJacobian ijacobian; 735214bc6a2SJed Brown 736214bc6a2SJed Brown PetscFunctionBegin; 737c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 738c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 73941a1d4d2SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 740214bc6a2SJed Brown if (Arhs) { 741214bc6a2SJed Brown if (!ts->Arhs) { 74241a1d4d2SBarry Smith if (ijacobian) { 743214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 74441a1d4d2SBarry Smith } else { 74541a1d4d2SBarry Smith ts->Arhs = A; 74641a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 74741a1d4d2SBarry Smith } 7483565c898SBarry Smith } else { 7493565c898SBarry Smith PetscBool flg; 7503565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 7513565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 7523565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 7533565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 7543565c898SBarry Smith ts->Arhs = A; 7553565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 7563565c898SBarry Smith } 757214bc6a2SJed Brown } 758214bc6a2SJed Brown *Arhs = ts->Arhs; 759214bc6a2SJed Brown } 760214bc6a2SJed Brown if (Brhs) { 761214bc6a2SJed Brown if (!ts->Brhs) { 762bdb70873SJed Brown if (A != B) { 76341a1d4d2SBarry Smith if (ijacobian) { 764214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 765bdb70873SJed Brown } else { 76641a1d4d2SBarry Smith ts->Brhs = B; 76741a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 76841a1d4d2SBarry Smith } 76941a1d4d2SBarry Smith } else { 770bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 77151699248SLisandro Dalcin ts->Brhs = ts->Arhs; 772bdb70873SJed Brown } 773214bc6a2SJed Brown } 774214bc6a2SJed Brown *Brhs = ts->Brhs; 775214bc6a2SJed Brown } 776214bc6a2SJed Brown PetscFunctionReturn(0); 777214bc6a2SJed Brown } 778214bc6a2SJed Brown 779316643e7SJed Brown /*@ 7800910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 781316643e7SJed Brown 782316643e7SJed Brown Collective on TS and Vec 783316643e7SJed Brown 784316643e7SJed Brown Input Parameters: 785316643e7SJed Brown + ts - the TS context 786316643e7SJed Brown . t - current time 7870910c330SBarry Smith . U - state vector 7880910c330SBarry Smith . Udot - time derivative of state vector 789214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 790316643e7SJed Brown 791316643e7SJed Brown Output Parameter: 792316643e7SJed Brown . Y - right hand side 793316643e7SJed Brown 794316643e7SJed Brown Note: 795316643e7SJed Brown Most users should not need to explicitly call this routine, as it 796316643e7SJed Brown is used internally within the nonlinear solvers. 797316643e7SJed Brown 798316643e7SJed Brown If the user did did not write their equations in implicit form, this 799316643e7SJed Brown function recasts them in implicit form. 800316643e7SJed Brown 801316643e7SJed Brown Level: developer 802316643e7SJed Brown 803316643e7SJed Brown .keywords: TS, compute 804316643e7SJed Brown 805316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 806316643e7SJed Brown @*/ 8070910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 808316643e7SJed Brown { 809316643e7SJed Brown PetscErrorCode ierr; 81024989b8cSPeter Brune TSIFunction ifunction; 81124989b8cSPeter Brune TSRHSFunction rhsfunction; 81224989b8cSPeter Brune void *ctx; 81324989b8cSPeter Brune DM dm; 814316643e7SJed Brown 815316643e7SJed Brown PetscFunctionBegin; 8160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8170910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8180910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8190700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 820316643e7SJed Brown 82124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 82224989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8230298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 82424989b8cSPeter Brune 825ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 826d90be118SSean Farley 8270910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 82824989b8cSPeter Brune if (ifunction) { 829316643e7SJed Brown PetscStackPush("TS user implicit function"); 8300910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 831316643e7SJed Brown PetscStackPop; 832214bc6a2SJed Brown } 833214bc6a2SJed Brown if (imex) { 83424989b8cSPeter Brune if (!ifunction) { 8350910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8362dd45cf8SJed Brown } 83724989b8cSPeter Brune } else if (rhsfunction) { 83824989b8cSPeter Brune if (ifunction) { 839214bc6a2SJed Brown Vec Frhs; 840214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8410910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 842214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8432dd45cf8SJed Brown } else { 8440910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8450910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 846316643e7SJed Brown } 8474a6899ffSJed Brown } 8480910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 849316643e7SJed Brown PetscFunctionReturn(0); 850316643e7SJed Brown } 851316643e7SJed Brown 852316643e7SJed Brown /*@ 853316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 854316643e7SJed Brown 855316643e7SJed Brown Collective on TS and Vec 856316643e7SJed Brown 857316643e7SJed Brown Input 858316643e7SJed Brown Input Parameters: 859316643e7SJed Brown + ts - the TS context 860316643e7SJed Brown . t - current timestep 8610910c330SBarry Smith . U - state vector 8620910c330SBarry Smith . Udot - time derivative of state vector 863214bc6a2SJed Brown . shift - shift to apply, see note below 864214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 865316643e7SJed Brown 866316643e7SJed Brown Output Parameters: 867316643e7SJed Brown + A - Jacobian matrix 8683565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 869316643e7SJed Brown 870316643e7SJed Brown Notes: 8710910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 872316643e7SJed Brown 8730910c330SBarry Smith dF/dU + shift*dF/dUdot 874316643e7SJed Brown 875316643e7SJed Brown Most users should not need to explicitly call this routine, as it 876316643e7SJed Brown is used internally within the nonlinear solvers. 877316643e7SJed Brown 878316643e7SJed Brown Level: developer 879316643e7SJed Brown 880316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 881316643e7SJed Brown 882316643e7SJed Brown .seealso: TSSetIJacobian() 88363495f91SJed Brown @*/ 884d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 885316643e7SJed Brown { 886316643e7SJed Brown PetscErrorCode ierr; 88724989b8cSPeter Brune TSIJacobian ijacobian; 88824989b8cSPeter Brune TSRHSJacobian rhsjacobian; 88924989b8cSPeter Brune DM dm; 89024989b8cSPeter Brune void *ctx; 891316643e7SJed Brown 892316643e7SJed Brown PetscFunctionBegin; 8930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8940910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8950910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 896316643e7SJed Brown PetscValidPointer(A,6); 89794ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 898316643e7SJed Brown PetscValidPointer(B,7); 89994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 90024989b8cSPeter Brune 90124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 90224989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9030298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 90424989b8cSPeter Brune 905ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 906316643e7SJed Brown 90794ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 90824989b8cSPeter Brune if (ijacobian) { 9096cd88445SBarry Smith PetscBool missing; 910316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 911d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 912316643e7SJed Brown PetscStackPop; 9136cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9146cd88445SBarry 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"); 9153565c898SBarry Smith if (B != A) { 9166cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9176cd88445SBarry 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"); 9186cd88445SBarry Smith } 9194a6899ffSJed Brown } 920214bc6a2SJed Brown if (imex) { 921b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9224c26be97Sstefano_zampini PetscBool assembled; 92394ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9244c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9254c26be97Sstefano_zampini if (!assembled) { 9264c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9274c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9284c26be97Sstefano_zampini } 92994ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 93094ab13aaSBarry Smith if (A != B) { 93194ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9324c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9334c26be97Sstefano_zampini if (!assembled) { 9344c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9354c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9364c26be97Sstefano_zampini } 93794ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 938214bc6a2SJed Brown } 939214bc6a2SJed Brown } 940214bc6a2SJed Brown } else { 941e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 942e1244c69SJed Brown if (rhsjacobian) { 943214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 944d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 945e1244c69SJed Brown } 94694ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 9473565c898SBarry Smith PetscBool flg; 948e1244c69SJed Brown ts->rhsjacobian.scale = -1; 949e1244c69SJed Brown ts->rhsjacobian.shift = shift; 9503565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 9513565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 9523565c898SBarry Smith if (!flg) { 95394ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 95494ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 9553565c898SBarry Smith } 95694ab13aaSBarry Smith if (A != B) { 95794ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 95894ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 959316643e7SJed Brown } 960e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 961e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 962e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 96394ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 96494ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 96594ab13aaSBarry Smith if (A != B) { 96694ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 96794ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 968214bc6a2SJed Brown } 969316643e7SJed Brown } 97094ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 97194ab13aaSBarry Smith if (A != B) { 97294ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 973316643e7SJed Brown } 974316643e7SJed Brown } 975316643e7SJed Brown } 97694ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 977316643e7SJed Brown PetscFunctionReturn(0); 978316643e7SJed Brown } 979316643e7SJed Brown 980d763cef2SBarry Smith /*@C 981d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 982b5abc632SBarry Smith where U_t = G(t,u). 983d763cef2SBarry Smith 9843f9fe445SBarry Smith Logically Collective on TS 985d763cef2SBarry Smith 986d763cef2SBarry Smith Input Parameters: 987d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 9880298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 989d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 990d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 9910298fd71SBarry Smith function evaluation routine (may be NULL) 992d763cef2SBarry Smith 993d763cef2SBarry Smith Calling sequence of func: 99487828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 995d763cef2SBarry Smith 996d763cef2SBarry Smith + t - current timestep 997d763cef2SBarry Smith . u - input vector 998d763cef2SBarry Smith . F - function vector 999d763cef2SBarry Smith - ctx - [optional] user-defined function context 1000d763cef2SBarry Smith 1001d763cef2SBarry Smith Level: beginner 1002d763cef2SBarry Smith 100395452b02SPatrick Sanan Notes: 100495452b02SPatrick Sanan You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10052bbac0d3SBarry Smith 1006d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1007d763cef2SBarry Smith 1008ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1009d763cef2SBarry Smith @*/ 1010089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1011d763cef2SBarry Smith { 1012089b2837SJed Brown PetscErrorCode ierr; 1013089b2837SJed Brown SNES snes; 10140298fd71SBarry Smith Vec ralloc = NULL; 101524989b8cSPeter Brune DM dm; 1016d763cef2SBarry Smith 1017089b2837SJed Brown PetscFunctionBegin; 10180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1019ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 102024989b8cSPeter Brune 102124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 102224989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1023089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1024e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1025e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1026e856ceecSJed Brown r = ralloc; 1027e856ceecSJed Brown } 1028089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1029e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1030d763cef2SBarry Smith PetscFunctionReturn(0); 1031d763cef2SBarry Smith } 1032d763cef2SBarry Smith 1033ef20d060SBarry Smith /*@C 1034abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1035ef20d060SBarry Smith 1036ef20d060SBarry Smith Logically Collective on TS 1037ef20d060SBarry Smith 1038ef20d060SBarry Smith Input Parameters: 1039ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1040ef20d060SBarry Smith . f - routine for evaluating the solution 1041ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 10420298fd71SBarry Smith function evaluation routine (may be NULL) 1043ef20d060SBarry Smith 1044ef20d060SBarry Smith Calling sequence of func: 1045ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1046ef20d060SBarry Smith 1047ef20d060SBarry Smith + t - current timestep 1048ef20d060SBarry Smith . u - output vector 1049ef20d060SBarry Smith - ctx - [optional] user-defined function context 1050ef20d060SBarry Smith 10510ed3bfb6SBarry Smith Options Database: 10520ed3bfb6SBarry Smith + -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction() 10530ed3bfb6SBarry Smith - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 10540ed3bfb6SBarry Smith 1055abd5a294SJed Brown Notes: 1056abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1057abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1058abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1059abd5a294SJed Brown 10604f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1061abd5a294SJed Brown 1062ef20d060SBarry Smith Level: beginner 1063ef20d060SBarry Smith 1064ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1065ef20d060SBarry Smith 10660ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError() 1067ef20d060SBarry Smith @*/ 1068ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1069ef20d060SBarry Smith { 1070ef20d060SBarry Smith PetscErrorCode ierr; 1071ef20d060SBarry Smith DM dm; 1072ef20d060SBarry Smith 1073ef20d060SBarry Smith PetscFunctionBegin; 1074ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1075ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1076ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1077ef20d060SBarry Smith PetscFunctionReturn(0); 1078ef20d060SBarry Smith } 1079ef20d060SBarry Smith 10809b7cd975SBarry Smith /*@C 10819b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 10829b7cd975SBarry Smith 10839b7cd975SBarry Smith Logically Collective on TS 10849b7cd975SBarry Smith 10859b7cd975SBarry Smith Input Parameters: 10869b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1087e162b725SBarry Smith . func - routine for evaluating the forcing function 10889b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 10890298fd71SBarry Smith function evaluation routine (may be NULL) 10909b7cd975SBarry Smith 10919b7cd975SBarry Smith Calling sequence of func: 1092e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 10939b7cd975SBarry Smith 10949b7cd975SBarry Smith + t - current timestep 1095e162b725SBarry Smith . f - output vector 10969b7cd975SBarry Smith - ctx - [optional] user-defined function context 10979b7cd975SBarry Smith 10989b7cd975SBarry Smith Notes: 10999b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1100e162b725SBarry 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 1101e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1102e162b725SBarry Smith 1103e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1104e162b725SBarry Smith 1105e162b725SBarry 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 1106e162b725SBarry Smith parameters can be passed in the ctx variable. 11079b7cd975SBarry Smith 11089b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11099b7cd975SBarry Smith 11109b7cd975SBarry Smith Level: beginner 11119b7cd975SBarry Smith 11129b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11139b7cd975SBarry Smith 11149b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11159b7cd975SBarry Smith @*/ 1116e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11179b7cd975SBarry Smith { 11189b7cd975SBarry Smith PetscErrorCode ierr; 11199b7cd975SBarry Smith DM dm; 11209b7cd975SBarry Smith 11219b7cd975SBarry Smith PetscFunctionBegin; 11229b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11239b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1124e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11259b7cd975SBarry Smith PetscFunctionReturn(0); 11269b7cd975SBarry Smith } 11279b7cd975SBarry Smith 1128d763cef2SBarry Smith /*@C 1129f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1130b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1131d763cef2SBarry Smith 11323f9fe445SBarry Smith Logically Collective on TS 1133d763cef2SBarry Smith 1134d763cef2SBarry Smith Input Parameters: 1135d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1136e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1137e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1138d763cef2SBarry Smith . f - the Jacobian evaluation routine 1139d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 11400298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1141d763cef2SBarry Smith 1142f7ab8db6SBarry Smith Calling sequence of f: 1143ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1144d763cef2SBarry Smith 1145d763cef2SBarry Smith + t - current timestep 1146d763cef2SBarry Smith . u - input vector 1147e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1148e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1149d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1150d763cef2SBarry Smith 11516cd88445SBarry Smith Notes: 11526cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 11536cd88445SBarry Smith 11546cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1155ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1156d763cef2SBarry Smith 1157d763cef2SBarry Smith Level: beginner 1158d763cef2SBarry Smith 1159d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1160d763cef2SBarry Smith 1161ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1162d763cef2SBarry Smith 1163d763cef2SBarry Smith @*/ 1164e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1165d763cef2SBarry Smith { 1166277b19d0SLisandro Dalcin PetscErrorCode ierr; 1167089b2837SJed Brown SNES snes; 116824989b8cSPeter Brune DM dm; 116924989b8cSPeter Brune TSIJacobian ijacobian; 1170277b19d0SLisandro Dalcin 1171d763cef2SBarry Smith PetscFunctionBegin; 11720700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1173e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1174e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1175e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1176e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1177d763cef2SBarry Smith 117824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 117924989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1180e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1181e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1182e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1183e1244c69SJed Brown } 11840298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1185089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 11865f659677SPeter Brune if (!ijacobian) { 1187e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 11880e4ef248SJed Brown } 1189e5d3d808SBarry Smith if (Amat) { 1190e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 11910e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1192e5d3d808SBarry Smith ts->Arhs = Amat; 11930e4ef248SJed Brown } 1194e5d3d808SBarry Smith if (Pmat) { 1195e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 11960e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1197e5d3d808SBarry Smith ts->Brhs = Pmat; 11980e4ef248SJed Brown } 1199d763cef2SBarry Smith PetscFunctionReturn(0); 1200d763cef2SBarry Smith } 1201d763cef2SBarry Smith 1202316643e7SJed Brown /*@C 1203b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1204316643e7SJed Brown 12053f9fe445SBarry Smith Logically Collective on TS 1206316643e7SJed Brown 1207316643e7SJed Brown Input Parameters: 1208316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12090298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1210316643e7SJed Brown . f - the function evaluation routine 12110298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1212316643e7SJed Brown 1213316643e7SJed Brown Calling sequence of f: 1214316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1215316643e7SJed Brown 1216316643e7SJed Brown + t - time at step/stage being solved 1217316643e7SJed Brown . u - state vector 1218316643e7SJed Brown . u_t - time derivative of state vector 1219316643e7SJed Brown . F - function vector 1220316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1221316643e7SJed Brown 1222316643e7SJed Brown Important: 12232bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1224316643e7SJed Brown 1225316643e7SJed Brown Level: beginner 1226316643e7SJed Brown 1227316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1228316643e7SJed Brown 1229d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1230316643e7SJed Brown @*/ 123151699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1232316643e7SJed Brown { 1233089b2837SJed Brown PetscErrorCode ierr; 1234089b2837SJed Brown SNES snes; 123551699248SLisandro Dalcin Vec ralloc = NULL; 123624989b8cSPeter Brune DM dm; 1237316643e7SJed Brown 1238316643e7SJed Brown PetscFunctionBegin; 12390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 124051699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 124124989b8cSPeter Brune 124224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 124324989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 124424989b8cSPeter Brune 1245089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 124651699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 124751699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 124851699248SLisandro Dalcin r = ralloc; 1249e856ceecSJed Brown } 125051699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 125151699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1252089b2837SJed Brown PetscFunctionReturn(0); 1253089b2837SJed Brown } 1254089b2837SJed Brown 1255089b2837SJed Brown /*@C 1256089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1257089b2837SJed Brown 1258089b2837SJed Brown Not Collective 1259089b2837SJed Brown 1260089b2837SJed Brown Input Parameter: 1261089b2837SJed Brown . ts - the TS context 1262089b2837SJed Brown 1263089b2837SJed Brown Output Parameter: 12640298fd71SBarry Smith + r - vector to hold residual (or NULL) 12650298fd71SBarry Smith . func - the function to compute residual (or NULL) 12660298fd71SBarry Smith - ctx - the function context (or NULL) 1267089b2837SJed Brown 1268089b2837SJed Brown Level: advanced 1269089b2837SJed Brown 1270089b2837SJed Brown .keywords: TS, nonlinear, get, function 1271089b2837SJed Brown 1272089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1273089b2837SJed Brown @*/ 1274089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1275089b2837SJed Brown { 1276089b2837SJed Brown PetscErrorCode ierr; 1277089b2837SJed Brown SNES snes; 127824989b8cSPeter Brune DM dm; 1279089b2837SJed Brown 1280089b2837SJed Brown PetscFunctionBegin; 1281089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1282089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12830298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 128424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 128524989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1286089b2837SJed Brown PetscFunctionReturn(0); 1287089b2837SJed Brown } 1288089b2837SJed Brown 1289089b2837SJed Brown /*@C 1290089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1291089b2837SJed Brown 1292089b2837SJed Brown Not Collective 1293089b2837SJed Brown 1294089b2837SJed Brown Input Parameter: 1295089b2837SJed Brown . ts - the TS context 1296089b2837SJed Brown 1297089b2837SJed Brown Output Parameter: 12980298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 12990298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13000298fd71SBarry Smith - ctx - the function context (or NULL) 1301089b2837SJed Brown 1302089b2837SJed Brown Level: advanced 1303089b2837SJed Brown 1304089b2837SJed Brown .keywords: TS, nonlinear, get, function 1305089b2837SJed Brown 13062bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1307089b2837SJed Brown @*/ 1308089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1309089b2837SJed Brown { 1310089b2837SJed Brown PetscErrorCode ierr; 1311089b2837SJed Brown SNES snes; 131224989b8cSPeter Brune DM dm; 1313089b2837SJed Brown 1314089b2837SJed Brown PetscFunctionBegin; 1315089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1316089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13170298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 131824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 131924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1320316643e7SJed Brown PetscFunctionReturn(0); 1321316643e7SJed Brown } 1322316643e7SJed Brown 1323316643e7SJed Brown /*@C 1324a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1325ae8867d6SBarry Smith provided with TSSetIFunction(). 1326316643e7SJed Brown 13273f9fe445SBarry Smith Logically Collective on TS 1328316643e7SJed Brown 1329316643e7SJed Brown Input Parameters: 1330316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1331e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1332e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1333316643e7SJed Brown . f - the Jacobian evaluation routine 13340298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1335316643e7SJed Brown 1336316643e7SJed Brown Calling sequence of f: 1337ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1338316643e7SJed Brown 1339316643e7SJed Brown + t - time at step/stage being solved 13401b4a444bSJed Brown . U - state vector 13411b4a444bSJed Brown . U_t - time derivative of state vector 1342316643e7SJed Brown . a - shift 1343e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1344e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1345316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1346316643e7SJed Brown 1347316643e7SJed Brown Notes: 1348e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1349316643e7SJed Brown 1350895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1351895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1352895c21f2SBarry Smith 1353a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1354b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1355a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1356a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1357a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1358a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1359a4f0a591SBarry Smith 13606cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 13616cd88445SBarry Smith 13626cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1363ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1364ca5f011dSBarry Smith 1365316643e7SJed Brown Level: beginner 1366316643e7SJed Brown 1367316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1368316643e7SJed Brown 1369ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1370316643e7SJed Brown 1371316643e7SJed Brown @*/ 1372e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1373316643e7SJed Brown { 1374316643e7SJed Brown PetscErrorCode ierr; 1375089b2837SJed Brown SNES snes; 137624989b8cSPeter Brune DM dm; 1377316643e7SJed Brown 1378316643e7SJed Brown PetscFunctionBegin; 13790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1380e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1381e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1382e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1383e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 138424989b8cSPeter Brune 138524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 138624989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 138724989b8cSPeter Brune 1388089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1389e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1390316643e7SJed Brown PetscFunctionReturn(0); 1391316643e7SJed Brown } 1392316643e7SJed Brown 1393e1244c69SJed Brown /*@ 1394e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1395e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1396e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1397e1244c69SJed Brown not been changed by the TS. 1398e1244c69SJed Brown 1399e1244c69SJed Brown Logically Collective 1400e1244c69SJed Brown 1401e1244c69SJed Brown Input Arguments: 1402e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1403e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1404e1244c69SJed Brown 1405e1244c69SJed Brown Level: intermediate 1406e1244c69SJed Brown 1407e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1408e1244c69SJed Brown @*/ 1409e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1410e1244c69SJed Brown { 1411e1244c69SJed Brown PetscFunctionBegin; 1412e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1413e1244c69SJed Brown PetscFunctionReturn(0); 1414e1244c69SJed Brown } 1415e1244c69SJed Brown 1416efe9872eSLisandro Dalcin /*@C 1417efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1418efe9872eSLisandro Dalcin 1419efe9872eSLisandro Dalcin Logically Collective on TS 1420efe9872eSLisandro Dalcin 1421efe9872eSLisandro Dalcin Input Parameters: 1422efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1423efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1424efe9872eSLisandro Dalcin . fun - the function evaluation routine 1425efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1426efe9872eSLisandro Dalcin 1427efe9872eSLisandro Dalcin Calling sequence of fun: 1428efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1429efe9872eSLisandro Dalcin 1430efe9872eSLisandro Dalcin + t - time at step/stage being solved 1431efe9872eSLisandro Dalcin . U - state vector 1432efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1433efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1434efe9872eSLisandro Dalcin . F - function vector 1435efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1436efe9872eSLisandro Dalcin 1437efe9872eSLisandro Dalcin Level: beginner 1438efe9872eSLisandro Dalcin 1439efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1440efe9872eSLisandro Dalcin 1441efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1442efe9872eSLisandro Dalcin @*/ 1443efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1444efe9872eSLisandro Dalcin { 1445efe9872eSLisandro Dalcin DM dm; 1446efe9872eSLisandro Dalcin PetscErrorCode ierr; 1447efe9872eSLisandro Dalcin 1448efe9872eSLisandro Dalcin PetscFunctionBegin; 1449efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1450efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1451efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1452efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1453efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1454efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1455efe9872eSLisandro Dalcin } 1456efe9872eSLisandro Dalcin 1457efe9872eSLisandro Dalcin /*@C 1458efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1459efe9872eSLisandro Dalcin 1460efe9872eSLisandro Dalcin Not Collective 1461efe9872eSLisandro Dalcin 1462efe9872eSLisandro Dalcin Input Parameter: 1463efe9872eSLisandro Dalcin . ts - the TS context 1464efe9872eSLisandro Dalcin 1465efe9872eSLisandro Dalcin Output Parameter: 1466efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1467efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1468efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1469efe9872eSLisandro Dalcin 1470efe9872eSLisandro Dalcin Level: advanced 1471efe9872eSLisandro Dalcin 1472efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1473efe9872eSLisandro Dalcin 1474efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1475efe9872eSLisandro Dalcin @*/ 1476efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1477efe9872eSLisandro Dalcin { 1478efe9872eSLisandro Dalcin PetscErrorCode ierr; 1479efe9872eSLisandro Dalcin SNES snes; 1480efe9872eSLisandro Dalcin DM dm; 1481efe9872eSLisandro Dalcin 1482efe9872eSLisandro Dalcin PetscFunctionBegin; 1483efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1484efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1485efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1486efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1487efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1488efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1489efe9872eSLisandro Dalcin } 1490efe9872eSLisandro Dalcin 1491efe9872eSLisandro Dalcin /*@C 1492bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1493efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1494efe9872eSLisandro Dalcin 1495efe9872eSLisandro Dalcin Logically Collective on TS 1496efe9872eSLisandro Dalcin 1497efe9872eSLisandro Dalcin Input Parameters: 1498efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1499efe9872eSLisandro Dalcin . J - Jacobian matrix 1500efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1501efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1502efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1503efe9872eSLisandro Dalcin 1504efe9872eSLisandro Dalcin Calling sequence of jac: 1505bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1506efe9872eSLisandro Dalcin 1507efe9872eSLisandro Dalcin + t - time at step/stage being solved 1508efe9872eSLisandro Dalcin . U - state vector 1509efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1510efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1511efe9872eSLisandro Dalcin . v - shift for U_t 1512efe9872eSLisandro Dalcin . a - shift for U_tt 1513efe9872eSLisandro 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 1514efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1515efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1516efe9872eSLisandro Dalcin 1517efe9872eSLisandro Dalcin Notes: 1518efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1519efe9872eSLisandro Dalcin 1520efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1521efe9872eSLisandro 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. 1522efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1523bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1524efe9872eSLisandro Dalcin 1525efe9872eSLisandro Dalcin Level: beginner 1526efe9872eSLisandro Dalcin 1527efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1528efe9872eSLisandro Dalcin 1529efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1530efe9872eSLisandro Dalcin @*/ 1531efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1532efe9872eSLisandro Dalcin { 1533efe9872eSLisandro Dalcin DM dm; 1534efe9872eSLisandro Dalcin PetscErrorCode ierr; 1535efe9872eSLisandro Dalcin 1536efe9872eSLisandro Dalcin PetscFunctionBegin; 1537efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1538efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1539efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1540efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1541efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1542efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1543efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1544efe9872eSLisandro Dalcin } 1545efe9872eSLisandro Dalcin 1546efe9872eSLisandro Dalcin /*@C 1547efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1548efe9872eSLisandro Dalcin 1549efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1550efe9872eSLisandro Dalcin 1551efe9872eSLisandro Dalcin Input Parameter: 1552efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1553efe9872eSLisandro Dalcin 1554efe9872eSLisandro Dalcin Output Parameters: 1555efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1556efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1557efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1558efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1559efe9872eSLisandro Dalcin 156095452b02SPatrick Sanan Notes: 156195452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 1562efe9872eSLisandro Dalcin 1563efe9872eSLisandro Dalcin Level: advanced 1564efe9872eSLisandro Dalcin 156580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 1566efe9872eSLisandro Dalcin 1567efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1568efe9872eSLisandro Dalcin @*/ 1569efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1570efe9872eSLisandro Dalcin { 1571efe9872eSLisandro Dalcin PetscErrorCode ierr; 1572efe9872eSLisandro Dalcin SNES snes; 1573efe9872eSLisandro Dalcin DM dm; 1574efe9872eSLisandro Dalcin 1575efe9872eSLisandro Dalcin PetscFunctionBegin; 1576efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1577efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1578efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1579efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1580efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1581efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1582efe9872eSLisandro Dalcin } 1583efe9872eSLisandro Dalcin 1584efe9872eSLisandro Dalcin /*@ 1585efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1586efe9872eSLisandro Dalcin 1587efe9872eSLisandro Dalcin Collective on TS and Vec 1588efe9872eSLisandro Dalcin 1589efe9872eSLisandro Dalcin Input Parameters: 1590efe9872eSLisandro Dalcin + ts - the TS context 1591efe9872eSLisandro Dalcin . t - current time 1592efe9872eSLisandro Dalcin . U - state vector 1593efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1594efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1595efe9872eSLisandro Dalcin 1596efe9872eSLisandro Dalcin Output Parameter: 1597efe9872eSLisandro Dalcin . F - the residual vector 1598efe9872eSLisandro Dalcin 1599efe9872eSLisandro Dalcin Note: 1600efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1601efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1602efe9872eSLisandro Dalcin 1603efe9872eSLisandro Dalcin Level: developer 1604efe9872eSLisandro Dalcin 1605efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1606efe9872eSLisandro Dalcin 1607efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1608efe9872eSLisandro Dalcin @*/ 1609efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1610efe9872eSLisandro Dalcin { 1611efe9872eSLisandro Dalcin DM dm; 1612efe9872eSLisandro Dalcin TSI2Function I2Function; 1613efe9872eSLisandro Dalcin void *ctx; 1614efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1615efe9872eSLisandro Dalcin PetscErrorCode ierr; 1616efe9872eSLisandro Dalcin 1617efe9872eSLisandro Dalcin PetscFunctionBegin; 1618efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1619efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1620efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1621efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1622efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1623efe9872eSLisandro Dalcin 1624efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1625efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1626efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1627efe9872eSLisandro Dalcin 1628efe9872eSLisandro Dalcin if (!I2Function) { 1629efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1630efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1631efe9872eSLisandro Dalcin } 1632efe9872eSLisandro Dalcin 1633efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1634efe9872eSLisandro Dalcin 1635efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1636efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1637efe9872eSLisandro Dalcin PetscStackPop; 1638efe9872eSLisandro Dalcin 1639efe9872eSLisandro Dalcin if (rhsfunction) { 1640efe9872eSLisandro Dalcin Vec Frhs; 1641efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1642efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1643efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1644efe9872eSLisandro Dalcin } 1645efe9872eSLisandro Dalcin 1646efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1647efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1648efe9872eSLisandro Dalcin } 1649efe9872eSLisandro Dalcin 1650efe9872eSLisandro Dalcin /*@ 1651efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1652efe9872eSLisandro Dalcin 1653efe9872eSLisandro Dalcin Collective on TS and Vec 1654efe9872eSLisandro Dalcin 1655efe9872eSLisandro Dalcin Input Parameters: 1656efe9872eSLisandro Dalcin + ts - the TS context 1657efe9872eSLisandro Dalcin . t - current timestep 1658efe9872eSLisandro Dalcin . U - state vector 1659efe9872eSLisandro Dalcin . V - time derivative of state vector 1660efe9872eSLisandro Dalcin . A - second time derivative of state vector 1661efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1662efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1663efe9872eSLisandro Dalcin 1664efe9872eSLisandro Dalcin Output Parameters: 1665efe9872eSLisandro Dalcin + J - Jacobian matrix 1666efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1667efe9872eSLisandro Dalcin 1668efe9872eSLisandro Dalcin Notes: 1669efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1670efe9872eSLisandro Dalcin 1671efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1672efe9872eSLisandro Dalcin 1673efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1674efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1675efe9872eSLisandro Dalcin 1676efe9872eSLisandro Dalcin Level: developer 1677efe9872eSLisandro Dalcin 1678efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1679efe9872eSLisandro Dalcin 1680efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1681efe9872eSLisandro Dalcin @*/ 1682efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1683efe9872eSLisandro Dalcin { 1684efe9872eSLisandro Dalcin DM dm; 1685efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1686efe9872eSLisandro Dalcin void *ctx; 1687efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1688efe9872eSLisandro Dalcin PetscErrorCode ierr; 1689efe9872eSLisandro Dalcin 1690efe9872eSLisandro Dalcin PetscFunctionBegin; 1691efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1692efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1693efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1694efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1695efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1696efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1697efe9872eSLisandro Dalcin 1698efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1699efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1700efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1701efe9872eSLisandro Dalcin 1702efe9872eSLisandro Dalcin if (!I2Jacobian) { 1703efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1704efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1705efe9872eSLisandro Dalcin } 1706efe9872eSLisandro Dalcin 1707efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1708efe9872eSLisandro Dalcin 1709efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1710efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1711efe9872eSLisandro Dalcin PetscStackPop; 1712efe9872eSLisandro Dalcin 1713efe9872eSLisandro Dalcin if (rhsjacobian) { 1714efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1715efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1716efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1717efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1718efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1719efe9872eSLisandro Dalcin } 1720efe9872eSLisandro Dalcin 1721efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1722efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1723efe9872eSLisandro Dalcin } 1724efe9872eSLisandro Dalcin 1725efe9872eSLisandro Dalcin /*@ 1726efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1727efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1728efe9872eSLisandro Dalcin 1729efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1730efe9872eSLisandro Dalcin 1731efe9872eSLisandro Dalcin Input Parameters: 1732efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1733efe9872eSLisandro Dalcin . u - the solution vector 1734efe9872eSLisandro Dalcin - v - the time derivative vector 1735efe9872eSLisandro Dalcin 1736efe9872eSLisandro Dalcin Level: beginner 1737efe9872eSLisandro Dalcin 1738efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1739efe9872eSLisandro Dalcin @*/ 1740efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1741efe9872eSLisandro Dalcin { 1742efe9872eSLisandro Dalcin PetscErrorCode ierr; 1743efe9872eSLisandro Dalcin 1744efe9872eSLisandro Dalcin PetscFunctionBegin; 1745efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1746efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1747efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1748efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1749efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1750efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1751efe9872eSLisandro Dalcin ts->vec_dot = v; 1752efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1753efe9872eSLisandro Dalcin } 1754efe9872eSLisandro Dalcin 1755efe9872eSLisandro Dalcin /*@ 1756efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1757efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1758efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1759efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1760efe9872eSLisandro Dalcin 1761efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1762efe9872eSLisandro Dalcin 1763efe9872eSLisandro Dalcin Input Parameter: 1764efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1765efe9872eSLisandro Dalcin 1766efe9872eSLisandro Dalcin Output Parameter: 1767efe9872eSLisandro Dalcin + u - the vector containing the solution 1768efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1769efe9872eSLisandro Dalcin 1770efe9872eSLisandro Dalcin Level: intermediate 1771efe9872eSLisandro Dalcin 1772efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1773efe9872eSLisandro Dalcin 1774efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1775efe9872eSLisandro Dalcin @*/ 1776efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1777efe9872eSLisandro Dalcin { 1778efe9872eSLisandro Dalcin PetscFunctionBegin; 1779efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1780efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1781efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1782efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1783efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1784efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1785efe9872eSLisandro Dalcin } 1786efe9872eSLisandro Dalcin 178755849f57SBarry Smith /*@C 178855849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 178955849f57SBarry Smith 179055849f57SBarry Smith Collective on PetscViewer 179155849f57SBarry Smith 179255849f57SBarry Smith Input Parameters: 179355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 179455849f57SBarry Smith some related function before a call to TSLoad(). 179555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 179655849f57SBarry Smith 179755849f57SBarry Smith Level: intermediate 179855849f57SBarry Smith 179955849f57SBarry Smith Notes: 180055849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 180155849f57SBarry Smith 180255849f57SBarry Smith Notes for advanced users: 180355849f57SBarry Smith Most users should not need to know the details of the binary storage 180455849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 180555849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 180655849f57SBarry Smith format is 180755849f57SBarry Smith .vb 180855849f57SBarry Smith has not yet been determined 180955849f57SBarry Smith .ve 181055849f57SBarry Smith 181155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 181255849f57SBarry Smith @*/ 1813f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 181455849f57SBarry Smith { 181555849f57SBarry Smith PetscErrorCode ierr; 181655849f57SBarry Smith PetscBool isbinary; 181755849f57SBarry Smith PetscInt classid; 181855849f57SBarry Smith char type[256]; 18192d53ad75SBarry Smith DMTS sdm; 1820ad6bc421SBarry Smith DM dm; 182155849f57SBarry Smith 182255849f57SBarry Smith PetscFunctionBegin; 1823f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 182455849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 182555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 182655849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 182755849f57SBarry Smith 1828060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1829ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1830060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1831f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1832f2c2a1b9SBarry Smith if (ts->ops->load) { 1833f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1834f2c2a1b9SBarry Smith } 1835ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1836ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1837ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1838f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1839f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 18402d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 18412d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 184255849f57SBarry Smith PetscFunctionReturn(0); 184355849f57SBarry Smith } 184455849f57SBarry Smith 18459804daf3SBarry Smith #include <petscdraw.h> 1846e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1847e04113cfSBarry Smith #include <petscviewersaws.h> 1848f05ece33SBarry Smith #endif 18497e2c5f70SBarry Smith /*@C 1850d763cef2SBarry Smith TSView - Prints the TS data structure. 1851d763cef2SBarry Smith 18524c49b128SBarry Smith Collective on TS 1853d763cef2SBarry Smith 1854d763cef2SBarry Smith Input Parameters: 1855d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1856d763cef2SBarry Smith - viewer - visualization context 1857d763cef2SBarry Smith 1858d763cef2SBarry Smith Options Database Key: 1859d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1860d763cef2SBarry Smith 1861d763cef2SBarry Smith Notes: 1862d763cef2SBarry Smith The available visualization contexts include 1863b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1864b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1865d763cef2SBarry Smith output where only the first processor opens 1866d763cef2SBarry Smith the file. All other processors send their 1867d763cef2SBarry Smith data to the first processor to print. 1868d763cef2SBarry Smith 1869d763cef2SBarry Smith The user can open an alternative visualization context with 1870b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1871d763cef2SBarry Smith 1872d763cef2SBarry Smith Level: beginner 1873d763cef2SBarry Smith 1874d763cef2SBarry Smith .keywords: TS, timestep, view 1875d763cef2SBarry Smith 1876b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1877d763cef2SBarry Smith @*/ 18787087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1879d763cef2SBarry Smith { 1880dfbe8321SBarry Smith PetscErrorCode ierr; 188119fd82e9SBarry Smith TSType type; 18822b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 18832d53ad75SBarry Smith DMTS sdm; 1884e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1885536b137fSBarry Smith PetscBool issaws; 1886f05ece33SBarry Smith #endif 1887d763cef2SBarry Smith 1888d763cef2SBarry Smith PetscFunctionBegin; 18890700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 18903050cee2SBarry Smith if (!viewer) { 1891ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 18923050cee2SBarry Smith } 18930700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1894c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1895fd16b177SBarry Smith 1896251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1897251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 189855849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 18992b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1900e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1901536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1902f05ece33SBarry Smith #endif 190332077d6dSBarry Smith if (iascii) { 1904dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 1905efd4aadfSBarry Smith if (ts->ops->view) { 1906efd4aadfSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1907efd4aadfSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1908efd4aadfSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1909efd4aadfSBarry Smith } 1910ef85077eSLisandro Dalcin if (ts->max_steps < PETSC_MAX_INT) { 191177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1912ef85077eSLisandro Dalcin } 1913ef85077eSLisandro Dalcin if (ts->max_time < PETSC_MAX_REAL) { 19147c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1915ef85077eSLisandro Dalcin } 1916efd4aadfSBarry Smith if (ts->usessnes) { 1917efd4aadfSBarry Smith PetscBool lin; 1918d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19195ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 1920d763cef2SBarry Smith } 19215ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 1922efd4aadfSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr); 1923efd4aadfSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr); 1924efd4aadfSBarry Smith } 1925193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 1926a0af407cSBarry Smith if (ts->vrtol) { 1927a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 1928a0af407cSBarry Smith } else { 1929a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 1930a0af407cSBarry Smith } 1931a0af407cSBarry Smith if (ts->vatol) { 1932a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 1933a0af407cSBarry Smith } else { 1934a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 1935a0af407cSBarry Smith } 1936825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1937efd4aadfSBarry Smith ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr); 1938825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1939825ab935SBarry Smith if (ts->snes && ts->usessnes) { 1940825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1941825ab935SBarry Smith ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr); 1942825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1943825ab935SBarry Smith } 19442d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19452d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19460f5bd95cSBarry Smith } else if (isstring) { 1947a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 1948b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 194955849f57SBarry Smith } else if (isbinary) { 195055849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 195155849f57SBarry Smith MPI_Comm comm; 195255849f57SBarry Smith PetscMPIInt rank; 195355849f57SBarry Smith char type[256]; 195455849f57SBarry Smith 195555849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 195655849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 195755849f57SBarry Smith if (!rank) { 195855849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 195955849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 196055849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 196155849f57SBarry Smith } 196255849f57SBarry Smith if (ts->ops->view) { 196355849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 196455849f57SBarry Smith } 1965efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 1966f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 1967f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 19682d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19692d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 19702b0a91c0SBarry Smith } else if (isdraw) { 19712b0a91c0SBarry Smith PetscDraw draw; 19722b0a91c0SBarry Smith char str[36]; 197389fd9fafSBarry Smith PetscReal x,y,bottom,h; 19742b0a91c0SBarry Smith 19752b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 19762b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 19772b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 19782b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 197951fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 198089fd9fafSBarry Smith bottom = y - h; 19812b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 19822b0a91c0SBarry Smith if (ts->ops->view) { 19832b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 19842b0a91c0SBarry Smith } 1985efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 1986efd4aadfSBarry Smith if (ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 19872b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 1988e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1989536b137fSBarry Smith } else if (issaws) { 1990d45a07a7SBarry Smith PetscMPIInt rank; 19912657e9d9SBarry Smith const char *name; 19922657e9d9SBarry Smith 19932657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 1994d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 1995d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 1996d45a07a7SBarry Smith char dir[1024]; 1997d45a07a7SBarry Smith 1998e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 1999a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 20002657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 20012657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 20022657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2003d763cef2SBarry Smith } 20040acecf5bSBarry Smith if (ts->ops->view) { 20050acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20060acecf5bSBarry Smith } 2007f05ece33SBarry Smith #endif 2008f05ece33SBarry Smith } 2009f05ece33SBarry Smith 2010b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2011251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2012b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2013d763cef2SBarry Smith PetscFunctionReturn(0); 2014d763cef2SBarry Smith } 2015d763cef2SBarry Smith 2016b07ff414SBarry Smith /*@ 2017d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2018d763cef2SBarry Smith the timesteppers. 2019d763cef2SBarry Smith 20203f9fe445SBarry Smith Logically Collective on TS 2021d763cef2SBarry Smith 2022d763cef2SBarry Smith Input Parameters: 2023d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2024d763cef2SBarry Smith - usrP - optional user context 2025d763cef2SBarry Smith 202695452b02SPatrick Sanan Fortran Notes: 202795452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2028daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2029daf670e6SBarry Smith 2030d763cef2SBarry Smith Level: intermediate 2031d763cef2SBarry Smith 2032d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2033d763cef2SBarry Smith 2034d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2035d763cef2SBarry Smith @*/ 20367087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2037d763cef2SBarry Smith { 2038d763cef2SBarry Smith PetscFunctionBegin; 20390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2040d763cef2SBarry Smith ts->user = usrP; 2041d763cef2SBarry Smith PetscFunctionReturn(0); 2042d763cef2SBarry Smith } 2043d763cef2SBarry Smith 2044b07ff414SBarry Smith /*@ 2045d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2046d763cef2SBarry Smith timestepper. 2047d763cef2SBarry Smith 2048d763cef2SBarry Smith Not Collective 2049d763cef2SBarry Smith 2050d763cef2SBarry Smith Input Parameter: 2051d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2052d763cef2SBarry Smith 2053d763cef2SBarry Smith Output Parameter: 2054d763cef2SBarry Smith . usrP - user context 2055d763cef2SBarry Smith 205695452b02SPatrick Sanan Fortran Notes: 205795452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2058daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2059daf670e6SBarry Smith 2060d763cef2SBarry Smith Level: intermediate 2061d763cef2SBarry Smith 2062d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2063d763cef2SBarry Smith 2064d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2065d763cef2SBarry Smith @*/ 2066e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2067d763cef2SBarry Smith { 2068d763cef2SBarry Smith PetscFunctionBegin; 20690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2070e71120c6SJed Brown *(void**)usrP = ts->user; 2071d763cef2SBarry Smith PetscFunctionReturn(0); 2072d763cef2SBarry Smith } 2073d763cef2SBarry Smith 2074d763cef2SBarry Smith /*@ 207580275a0aSLisandro Dalcin TSGetStepNumber - Gets the number of steps completed. 2076d763cef2SBarry Smith 2077d763cef2SBarry Smith Not Collective 2078d763cef2SBarry Smith 2079d763cef2SBarry Smith Input Parameter: 2080d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2081d763cef2SBarry Smith 2082d763cef2SBarry Smith Output Parameter: 208380275a0aSLisandro Dalcin . steps - number of steps completed so far 2084d763cef2SBarry Smith 2085d763cef2SBarry Smith Level: intermediate 2086d763cef2SBarry Smith 2087d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 20889be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2089d763cef2SBarry Smith @*/ 209080275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps) 2091d763cef2SBarry Smith { 2092d763cef2SBarry Smith PetscFunctionBegin; 20930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 209480275a0aSLisandro Dalcin PetscValidIntPointer(steps,2); 209580275a0aSLisandro Dalcin *steps = ts->steps; 209680275a0aSLisandro Dalcin PetscFunctionReturn(0); 209780275a0aSLisandro Dalcin } 209880275a0aSLisandro Dalcin 209980275a0aSLisandro Dalcin /*@ 210080275a0aSLisandro Dalcin TSSetStepNumber - Sets the number of steps completed. 210180275a0aSLisandro Dalcin 210280275a0aSLisandro Dalcin Logically Collective on TS 210380275a0aSLisandro Dalcin 210480275a0aSLisandro Dalcin Input Parameters: 210580275a0aSLisandro Dalcin + ts - the TS context 210680275a0aSLisandro Dalcin - steps - number of steps completed so far 210780275a0aSLisandro Dalcin 210880275a0aSLisandro Dalcin Notes: 210980275a0aSLisandro Dalcin For most uses of the TS solvers the user need not explicitly call 211080275a0aSLisandro Dalcin TSSetStepNumber(), as the step counter is appropriately updated in 211180275a0aSLisandro Dalcin TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to 211280275a0aSLisandro Dalcin reinitialize timestepping by setting the step counter to zero (and time 211380275a0aSLisandro Dalcin to the initial time) to solve a similar problem with different initial 211480275a0aSLisandro Dalcin conditions or parameters. Other possible use case is to continue 211580275a0aSLisandro Dalcin timestepping from a previously interrupted run in such a way that TS 211680275a0aSLisandro Dalcin monitors will be called with a initial nonzero step counter. 211780275a0aSLisandro Dalcin 211880275a0aSLisandro Dalcin Level: advanced 211980275a0aSLisandro Dalcin 212080275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number 212180275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution() 212280275a0aSLisandro Dalcin @*/ 212380275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps) 212480275a0aSLisandro Dalcin { 212580275a0aSLisandro Dalcin PetscFunctionBegin; 212680275a0aSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 212780275a0aSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,steps,2); 212880275a0aSLisandro Dalcin if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative"); 212980275a0aSLisandro Dalcin ts->steps = steps; 2130d763cef2SBarry Smith PetscFunctionReturn(0); 2131d763cef2SBarry Smith } 2132d763cef2SBarry Smith 2133d763cef2SBarry Smith /*@ 2134d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2135d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2136d763cef2SBarry Smith 21373f9fe445SBarry Smith Logically Collective on TS 2138d763cef2SBarry Smith 2139d763cef2SBarry Smith Input Parameters: 2140d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2141d763cef2SBarry Smith - time_step - the size of the timestep 2142d763cef2SBarry Smith 2143d763cef2SBarry Smith Level: intermediate 2144d763cef2SBarry Smith 2145aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime() 2146d763cef2SBarry Smith 2147d763cef2SBarry Smith .keywords: TS, set, timestep 2148d763cef2SBarry Smith @*/ 21497087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2150d763cef2SBarry Smith { 2151d763cef2SBarry Smith PetscFunctionBegin; 21520700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2153c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2154d763cef2SBarry Smith ts->time_step = time_step; 2155d763cef2SBarry Smith PetscFunctionReturn(0); 2156d763cef2SBarry Smith } 2157d763cef2SBarry Smith 2158a43b19c4SJed Brown /*@ 215949354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 216049354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 216149354f04SShri Abhyankar or just return at the final time TS computed. 2162a43b19c4SJed Brown 2163a43b19c4SJed Brown Logically Collective on TS 2164a43b19c4SJed Brown 2165a43b19c4SJed Brown Input Parameter: 2166a43b19c4SJed Brown + ts - the time-step context 216749354f04SShri Abhyankar - eftopt - exact final time option 2168a43b19c4SJed Brown 2169feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2170feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2171feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2172feed9e9dSBarry Smith 2173feed9e9dSBarry Smith Options Database: 2174feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2175feed9e9dSBarry Smith 2176ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2177ee346746SBarry Smith then the final time you selected. 2178ee346746SBarry Smith 2179a43b19c4SJed Brown Level: beginner 2180a43b19c4SJed Brown 2181f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime() 2182a43b19c4SJed Brown @*/ 218349354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2184a43b19c4SJed Brown { 2185a43b19c4SJed Brown PetscFunctionBegin; 2186a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 218749354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 218849354f04SShri Abhyankar ts->exact_final_time = eftopt; 2189a43b19c4SJed Brown PetscFunctionReturn(0); 2190a43b19c4SJed Brown } 2191a43b19c4SJed Brown 2192d763cef2SBarry Smith /*@ 2193f6953c82SLisandro Dalcin TSGetExactFinalTime - Gets the exact final time option. 2194f6953c82SLisandro Dalcin 2195f6953c82SLisandro Dalcin Not Collective 2196f6953c82SLisandro Dalcin 2197f6953c82SLisandro Dalcin Input Parameter: 2198f6953c82SLisandro Dalcin . ts - the TS context 2199f6953c82SLisandro Dalcin 2200f6953c82SLisandro Dalcin Output Parameter: 2201f6953c82SLisandro Dalcin . eftopt - exact final time option 2202f6953c82SLisandro Dalcin 2203f6953c82SLisandro Dalcin Level: beginner 2204f6953c82SLisandro Dalcin 2205f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime() 2206f6953c82SLisandro Dalcin @*/ 2207f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt) 2208f6953c82SLisandro Dalcin { 2209f6953c82SLisandro Dalcin PetscFunctionBegin; 2210f6953c82SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2211f6953c82SLisandro Dalcin PetscValidPointer(eftopt,2); 2212f6953c82SLisandro Dalcin *eftopt = ts->exact_final_time; 2213f6953c82SLisandro Dalcin PetscFunctionReturn(0); 2214f6953c82SLisandro Dalcin } 2215f6953c82SLisandro Dalcin 2216f6953c82SLisandro Dalcin /*@ 2217d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2218d763cef2SBarry Smith 2219d763cef2SBarry Smith Not Collective 2220d763cef2SBarry Smith 2221d763cef2SBarry Smith Input Parameter: 2222d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2223d763cef2SBarry Smith 2224d763cef2SBarry Smith Output Parameter: 2225d763cef2SBarry Smith . dt - the current timestep size 2226d763cef2SBarry Smith 2227d763cef2SBarry Smith Level: intermediate 2228d763cef2SBarry Smith 2229aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime() 2230d763cef2SBarry Smith 2231d763cef2SBarry Smith .keywords: TS, get, timestep 2232d763cef2SBarry Smith @*/ 22337087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2234d763cef2SBarry Smith { 2235d763cef2SBarry Smith PetscFunctionBegin; 22360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2237f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2238d763cef2SBarry Smith *dt = ts->time_step; 2239d763cef2SBarry Smith PetscFunctionReturn(0); 2240d763cef2SBarry Smith } 2241d763cef2SBarry Smith 2242d8e5e3e6SSatish Balay /*@ 2243d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2244d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2245d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2246d763cef2SBarry Smith the solution at the next timestep has been calculated. 2247d763cef2SBarry Smith 2248d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2249d763cef2SBarry Smith 2250d763cef2SBarry Smith Input Parameter: 2251d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2252d763cef2SBarry Smith 2253d763cef2SBarry Smith Output Parameter: 2254d763cef2SBarry Smith . v - the vector containing the solution 2255d763cef2SBarry Smith 225663e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 225763e21af5SBarry Smith final time. It returns the solution at the next timestep. 225863e21af5SBarry Smith 2259d763cef2SBarry Smith Level: intermediate 2260d763cef2SBarry Smith 22610ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction() 2262d763cef2SBarry Smith 2263d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2264d763cef2SBarry Smith @*/ 22657087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2266d763cef2SBarry Smith { 2267d763cef2SBarry Smith PetscFunctionBegin; 22680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 22694482741eSBarry Smith PetscValidPointer(v,2); 22708737fe31SLisandro Dalcin *v = ts->vec_sol; 2271d763cef2SBarry Smith PetscFunctionReturn(0); 2272d763cef2SBarry Smith } 2273d763cef2SBarry Smith 227403fe5f5eSDebojyoti Ghosh /*@ 2275b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 227603fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2277b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 227803fe5f5eSDebojyoti Ghosh structure as the solution vector. 227903fe5f5eSDebojyoti Ghosh 228003fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 228103fe5f5eSDebojyoti Ghosh 228203fe5f5eSDebojyoti Ghosh Parameters : 228303fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2284b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2285b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 228603fe5f5eSDebojyoti Ghosh returned in v. 2287b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 228803fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2289b2bf4f3aSDebojyoti Ghosh the number of solutions components). 229003fe5f5eSDebojyoti Ghosh 22914cdd57e5SDebojyoti Ghosh Level: advanced 229203fe5f5eSDebojyoti Ghosh 229303fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 229403fe5f5eSDebojyoti Ghosh 229503fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 229603fe5f5eSDebojyoti Ghosh @*/ 2297b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 229803fe5f5eSDebojyoti Ghosh { 229903fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 230003fe5f5eSDebojyoti Ghosh 230103fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 230203fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2303b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 230403fe5f5eSDebojyoti Ghosh else { 2305b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 230603fe5f5eSDebojyoti Ghosh } 230703fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 230803fe5f5eSDebojyoti Ghosh } 230903fe5f5eSDebojyoti Ghosh 23104cdd57e5SDebojyoti Ghosh /*@ 23114cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 23124cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 23134cdd57e5SDebojyoti Ghosh 23144cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23154cdd57e5SDebojyoti Ghosh 23164cdd57e5SDebojyoti Ghosh Parameters : 23174cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 23184cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 23194cdd57e5SDebojyoti Ghosh 23204cdd57e5SDebojyoti Ghosh Level: intermediate 23214cdd57e5SDebojyoti Ghosh 23224cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 23234cdd57e5SDebojyoti Ghosh 23244cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 23254cdd57e5SDebojyoti Ghosh @*/ 23264cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 23274cdd57e5SDebojyoti Ghosh { 23284cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23294cdd57e5SDebojyoti Ghosh 23304cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23314cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2332f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 23334cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2334f6356ec7SDebojyoti Ghosh } else { 2335f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2336f6356ec7SDebojyoti Ghosh } 23374cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23384cdd57e5SDebojyoti Ghosh } 23394cdd57e5SDebojyoti Ghosh 23404cdd57e5SDebojyoti Ghosh /*@ 23414cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 23424cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 23434cdd57e5SDebojyoti Ghosh 23444cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23454cdd57e5SDebojyoti Ghosh 23469657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 23479657682dSDebojyoti Ghosh 23484cdd57e5SDebojyoti Ghosh Parameters : 23494cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2350657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 23514cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 23524cdd57e5SDebojyoti Ghosh 23534cdd57e5SDebojyoti Ghosh Level: intermediate 23544cdd57e5SDebojyoti Ghosh 235557df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 23564cdd57e5SDebojyoti Ghosh 23574cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 23584cdd57e5SDebojyoti Ghosh @*/ 23590a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 23604cdd57e5SDebojyoti Ghosh { 23614cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 23624cdd57e5SDebojyoti Ghosh 23634cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 23644cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2365f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 23660a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2367f6356ec7SDebojyoti Ghosh } else { 2368f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2369f6356ec7SDebojyoti Ghosh } 23704cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 23714cdd57e5SDebojyoti Ghosh } 23724cdd57e5SDebojyoti Ghosh 237357df6a1bSDebojyoti Ghosh /*@ 237457df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 237557df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 237657df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 237757df6a1bSDebojyoti Ghosh 237857df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 237957df6a1bSDebojyoti Ghosh 238057df6a1bSDebojyoti Ghosh Parameters : 238157df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 238257df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 238357df6a1bSDebojyoti Ghosh 238457df6a1bSDebojyoti Ghosh Level: intermediate 238557df6a1bSDebojyoti Ghosh 238657df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 238757df6a1bSDebojyoti Ghosh 238857df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 238957df6a1bSDebojyoti Ghosh @*/ 239057df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 239157df6a1bSDebojyoti Ghosh { 239257df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 239357df6a1bSDebojyoti Ghosh 239457df6a1bSDebojyoti Ghosh PetscFunctionBegin; 239557df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23969657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 239757df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 239857df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 239957df6a1bSDebojyoti Ghosh } 240057df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 240157df6a1bSDebojyoti Ghosh } 240257df6a1bSDebojyoti Ghosh 2403bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2404d8e5e3e6SSatish Balay /*@ 2405bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2406d763cef2SBarry Smith 2407bdad233fSMatthew Knepley Not collective 2408d763cef2SBarry Smith 2409bdad233fSMatthew Knepley Input Parameters: 2410bdad233fSMatthew Knepley + ts - The TS 2411bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2412d763cef2SBarry Smith .vb 24130910c330SBarry Smith U_t - A U = 0 (linear) 24140910c330SBarry Smith U_t - A(t) U = 0 (linear) 24150910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2416d763cef2SBarry Smith .ve 2417d763cef2SBarry Smith 2418d763cef2SBarry Smith Level: beginner 2419d763cef2SBarry Smith 2420bdad233fSMatthew Knepley .keywords: TS, problem type 2421bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2422d763cef2SBarry Smith @*/ 24237087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2424a7cc72afSBarry Smith { 24259e2a6581SJed Brown PetscErrorCode ierr; 24269e2a6581SJed Brown 2427d763cef2SBarry Smith PetscFunctionBegin; 24280700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2429bdad233fSMatthew Knepley ts->problem_type = type; 24309e2a6581SJed Brown if (type == TS_LINEAR) { 24319e2a6581SJed Brown SNES snes; 24329e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 24339e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 24349e2a6581SJed Brown } 2435d763cef2SBarry Smith PetscFunctionReturn(0); 2436d763cef2SBarry Smith } 2437d763cef2SBarry Smith 2438bdad233fSMatthew Knepley /*@C 2439bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2440bdad233fSMatthew Knepley 2441bdad233fSMatthew Knepley Not collective 2442bdad233fSMatthew Knepley 2443bdad233fSMatthew Knepley Input Parameter: 2444bdad233fSMatthew Knepley . ts - The TS 2445bdad233fSMatthew Knepley 2446bdad233fSMatthew Knepley Output Parameter: 2447bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2448bdad233fSMatthew Knepley .vb 2449089b2837SJed Brown M U_t = A U 2450089b2837SJed Brown M(t) U_t = A(t) U 2451b5abc632SBarry Smith F(t,U,U_t) 2452bdad233fSMatthew Knepley .ve 2453bdad233fSMatthew Knepley 2454bdad233fSMatthew Knepley Level: beginner 2455bdad233fSMatthew Knepley 2456bdad233fSMatthew Knepley .keywords: TS, problem type 2457bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2458bdad233fSMatthew Knepley @*/ 24597087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2460a7cc72afSBarry Smith { 2461bdad233fSMatthew Knepley PetscFunctionBegin; 24620700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 24634482741eSBarry Smith PetscValidIntPointer(type,2); 2464bdad233fSMatthew Knepley *type = ts->problem_type; 2465bdad233fSMatthew Knepley PetscFunctionReturn(0); 2466bdad233fSMatthew Knepley } 2467d763cef2SBarry Smith 2468d763cef2SBarry Smith /*@ 2469d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2470d763cef2SBarry Smith of a timestepper. 2471d763cef2SBarry Smith 2472d763cef2SBarry Smith Collective on TS 2473d763cef2SBarry Smith 2474d763cef2SBarry Smith Input Parameter: 2475d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2476d763cef2SBarry Smith 2477d763cef2SBarry Smith Notes: 2478d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2479d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2480141bd67dSStefano Zampini the call to TSStep() or TSSolve(). However, if one wishes to control this 2481d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2482141bd67dSStefano Zampini and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve(). 2483d763cef2SBarry Smith 2484d763cef2SBarry Smith Level: advanced 2485d763cef2SBarry Smith 2486d763cef2SBarry Smith .keywords: TS, timestep, setup 2487d763cef2SBarry Smith 2488141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve() 2489d763cef2SBarry Smith @*/ 24907087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2491d763cef2SBarry Smith { 2492dfbe8321SBarry Smith PetscErrorCode ierr; 24936c6b9e74SPeter Brune DM dm; 24946c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2495d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2496cd11d68dSLisandro Dalcin TSIFunction ifun; 24976c6b9e74SPeter Brune TSIJacobian ijac; 2498efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 24996c6b9e74SPeter Brune TSRHSJacobian rhsjac; 25002ffb9264SLisandro Dalcin PetscBool isnone; 2501d763cef2SBarry Smith 2502d763cef2SBarry Smith PetscFunctionBegin; 25030700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2504277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2505277b19d0SLisandro Dalcin 25067adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2507cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2508cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2509d763cef2SBarry Smith } 2510277b19d0SLisandro Dalcin 2511277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2512277b19d0SLisandro Dalcin 2513e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 2514e1244c69SJed Brown Mat Amat,Pmat; 2515e1244c69SJed Brown SNES snes; 2516e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2517e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2518e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2519e1244c69SJed Brown * have displaced the RHS matrix */ 2520e1244c69SJed Brown if (Amat == ts->Arhs) { 2521abc0d4abSBarry 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 */ 2522abc0d4abSBarry Smith ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2523e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2524e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2525e1244c69SJed Brown } 2526e1244c69SJed Brown if (Pmat == ts->Brhs) { 2527abc0d4abSBarry Smith ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2528e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2529e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2530e1244c69SJed Brown } 2531e1244c69SJed Brown } 25322ffb9264SLisandro Dalcin 25332ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 25342ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 25352ffb9264SLisandro Dalcin 2536277b19d0SLisandro Dalcin if (ts->ops->setup) { 2537000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2538277b19d0SLisandro Dalcin } 2539277b19d0SLisandro Dalcin 25402ffb9264SLisandro Dalcin /* Attempt to check/preset a default value for the exact final time option */ 25412ffb9264SLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 25422ffb9264SLisandro Dalcin if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) 25432ffb9264SLisandro Dalcin ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 25442ffb9264SLisandro Dalcin 2545a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 25466c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 25476c6b9e74SPeter Brune */ 25486c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 25490298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 25506c6b9e74SPeter Brune if (!func) { 25516c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 25526c6b9e74SPeter Brune } 2553a6772fa2SLisandro 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. 25546c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 25556c6b9e74SPeter Brune */ 25560298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 25570298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2558efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 25590298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2560efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 25616c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 25626c6b9e74SPeter Brune } 2563c0517034SDebojyoti Ghosh 2564c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2565c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2566c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2567c0517034SDebojyoti Ghosh } 2568c0517034SDebojyoti Ghosh 2569277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2570277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2571277b19d0SLisandro Dalcin } 2572277b19d0SLisandro Dalcin 2573f6a906c0SBarry Smith /*@ 2574277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2575277b19d0SLisandro Dalcin 2576277b19d0SLisandro Dalcin Collective on TS 2577277b19d0SLisandro Dalcin 2578277b19d0SLisandro Dalcin Input Parameter: 2579277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2580277b19d0SLisandro Dalcin 2581277b19d0SLisandro Dalcin Level: beginner 2582277b19d0SLisandro Dalcin 2583277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2584277b19d0SLisandro Dalcin 2585277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2586277b19d0SLisandro Dalcin @*/ 2587277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2588277b19d0SLisandro Dalcin { 258987f4e208SHong Zhang PetscInt i; 2590277b19d0SLisandro Dalcin PetscErrorCode ierr; 2591277b19d0SLisandro Dalcin 2592277b19d0SLisandro Dalcin PetscFunctionBegin; 2593277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2594b18ea86cSHong Zhang 2595277b19d0SLisandro Dalcin if (ts->ops->reset) { 2596277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2597277b19d0SLisandro Dalcin } 2598277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2599e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2600bbd56ea5SKarl Rupp 26014e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 26024e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2603214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 26046bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2605efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2606e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2607e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 260838637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2609bbd56ea5SKarl Rupp 2610d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr); 2611d8151eeaSBarry Smith ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr); 2612715f1b00SHong Zhang 2613ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 26142c39e106SBarry Smith ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr); 261536eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 261613b1b0ffSHong Zhang ierr = MatDestroy(&ts->mat_sensip);CHKERRQ(ierr); 2617022c081aSHong Zhang 261887f4e208SHong Zhang for (i=0; i<ts->num_rhs_splits; i++) { 2619*545aaa6fSHong Zhang ierr = TSDestroy(&ts->tsrhssplit[i]->ts);CHKERRQ(ierr); 2620*545aaa6fSHong Zhang ierr = PetscFree(ts->tsrhssplit[i]->splitname);CHKERRQ(ierr); 2621*545aaa6fSHong Zhang ierr = ISDestroy(&ts->tsrhssplit[i]->is);CHKERRQ(ierr); 2622*545aaa6fSHong Zhang ierr = PetscFree(ts->tsrhssplit[i]);CHKERRQ(ierr); 262387f4e208SHong Zhang } 2624*545aaa6fSHong Zhang ts->num_rhs_splits = 0; 2625277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2626d763cef2SBarry Smith PetscFunctionReturn(0); 2627d763cef2SBarry Smith } 2628d763cef2SBarry Smith 2629d8e5e3e6SSatish Balay /*@ 2630d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2631d763cef2SBarry Smith with TSCreate(). 2632d763cef2SBarry Smith 2633d763cef2SBarry Smith Collective on TS 2634d763cef2SBarry Smith 2635d763cef2SBarry Smith Input Parameter: 2636d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2637d763cef2SBarry Smith 2638d763cef2SBarry Smith Level: beginner 2639d763cef2SBarry Smith 2640d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2641d763cef2SBarry Smith 2642d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2643d763cef2SBarry Smith @*/ 26446bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2645d763cef2SBarry Smith { 26466849ba73SBarry Smith PetscErrorCode ierr; 2647d763cef2SBarry Smith 2648d763cef2SBarry Smith PetscFunctionBegin; 26496bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 26506bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 26516bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2652d763cef2SBarry Smith 26536bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2654277b19d0SLisandro Dalcin 2655e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2656e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 26576bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 26586d4c513bSLisandro Dalcin 2659bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2660bc952696SBarry Smith 266184df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 26626427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 26636427ac75SLisandro Dalcin 26646bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 26656bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 26666bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 26670dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 26686d4c513bSLisandro Dalcin 2669a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2670d763cef2SBarry Smith PetscFunctionReturn(0); 2671d763cef2SBarry Smith } 2672d763cef2SBarry Smith 2673d8e5e3e6SSatish Balay /*@ 2674d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2675d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2676d763cef2SBarry Smith 2677d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2678d763cef2SBarry Smith 2679d763cef2SBarry Smith Input Parameter: 2680d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2681d763cef2SBarry Smith 2682d763cef2SBarry Smith Output Parameter: 2683d763cef2SBarry Smith . snes - the nonlinear solver context 2684d763cef2SBarry Smith 2685d763cef2SBarry Smith Notes: 2686d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2687d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 268894b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2689d763cef2SBarry Smith 2690d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 26910298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2692d763cef2SBarry Smith 2693d763cef2SBarry Smith Level: beginner 2694d763cef2SBarry Smith 2695d763cef2SBarry Smith .keywords: timestep, get, SNES 2696d763cef2SBarry Smith @*/ 26977087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2698d763cef2SBarry Smith { 2699d372ba47SLisandro Dalcin PetscErrorCode ierr; 2700d372ba47SLisandro Dalcin 2701d763cef2SBarry Smith PetscFunctionBegin; 27020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27034482741eSBarry Smith PetscValidPointer(snes,2); 2704d372ba47SLisandro Dalcin if (!ts->snes) { 2705ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 27060298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27073bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2708d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2709496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 27109e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 27119e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 27129e2a6581SJed Brown } 2713d372ba47SLisandro Dalcin } 2714d763cef2SBarry Smith *snes = ts->snes; 2715d763cef2SBarry Smith PetscFunctionReturn(0); 2716d763cef2SBarry Smith } 2717d763cef2SBarry Smith 2718deb2cd25SJed Brown /*@ 2719deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2720deb2cd25SJed Brown 2721deb2cd25SJed Brown Collective 2722deb2cd25SJed Brown 2723deb2cd25SJed Brown Input Parameter: 2724deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2725deb2cd25SJed Brown - snes - the nonlinear solver context 2726deb2cd25SJed Brown 2727deb2cd25SJed Brown Notes: 2728deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2729deb2cd25SJed Brown 2730deb2cd25SJed Brown Level: developer 2731deb2cd25SJed Brown 2732deb2cd25SJed Brown .keywords: timestep, set, SNES 2733deb2cd25SJed Brown @*/ 2734deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2735deb2cd25SJed Brown { 2736deb2cd25SJed Brown PetscErrorCode ierr; 2737d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2738deb2cd25SJed Brown 2739deb2cd25SJed Brown PetscFunctionBegin; 2740deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2741deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2742deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2743deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2744bbd56ea5SKarl Rupp 2745deb2cd25SJed Brown ts->snes = snes; 2746bbd56ea5SKarl Rupp 27470298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27480298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2749740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 27500298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2751740132f1SEmil Constantinescu } 2752deb2cd25SJed Brown PetscFunctionReturn(0); 2753deb2cd25SJed Brown } 2754deb2cd25SJed Brown 2755d8e5e3e6SSatish Balay /*@ 275694b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2757d763cef2SBarry Smith a TS (timestepper) context. 2758d763cef2SBarry Smith 275994b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2760d763cef2SBarry Smith 2761d763cef2SBarry Smith Input Parameter: 2762d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2763d763cef2SBarry Smith 2764d763cef2SBarry Smith Output Parameter: 276594b7f48cSBarry Smith . ksp - the nonlinear solver context 2766d763cef2SBarry Smith 2767d763cef2SBarry Smith Notes: 276894b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2769d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2770d763cef2SBarry Smith KSP and PC contexts as well. 2771d763cef2SBarry Smith 277294b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 27730298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2774d763cef2SBarry Smith 2775d763cef2SBarry Smith Level: beginner 2776d763cef2SBarry Smith 277794b7f48cSBarry Smith .keywords: timestep, get, KSP 2778d763cef2SBarry Smith @*/ 27797087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2780d763cef2SBarry Smith { 2781d372ba47SLisandro Dalcin PetscErrorCode ierr; 2782089b2837SJed Brown SNES snes; 2783d372ba47SLisandro Dalcin 2784d763cef2SBarry Smith PetscFunctionBegin; 27850700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27864482741eSBarry Smith PetscValidPointer(ksp,2); 278717186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2788e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2789089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2790089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2791d763cef2SBarry Smith PetscFunctionReturn(0); 2792d763cef2SBarry Smith } 2793d763cef2SBarry Smith 2794d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2795d763cef2SBarry Smith 2796adb62b0dSMatthew Knepley /*@ 2797618ce8baSLisandro Dalcin TSSetMaxSteps - Sets the maximum number of steps to use. 2798618ce8baSLisandro Dalcin 2799618ce8baSLisandro Dalcin Logically Collective on TS 2800618ce8baSLisandro Dalcin 2801618ce8baSLisandro Dalcin Input Parameters: 2802618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2803618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use 2804618ce8baSLisandro Dalcin 2805618ce8baSLisandro Dalcin Options Database Keys: 2806618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps 2807618ce8baSLisandro Dalcin 2808618ce8baSLisandro Dalcin Notes: 2809618ce8baSLisandro Dalcin The default maximum number of steps is 5000 2810618ce8baSLisandro Dalcin 2811618ce8baSLisandro Dalcin Level: intermediate 2812618ce8baSLisandro Dalcin 2813618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps 2814618ce8baSLisandro Dalcin 2815618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime() 2816618ce8baSLisandro Dalcin @*/ 2817618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps) 2818618ce8baSLisandro Dalcin { 2819618ce8baSLisandro Dalcin PetscFunctionBegin; 2820618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2821618ce8baSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2822618ce8baSLisandro Dalcin if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative"); 2823618ce8baSLisandro Dalcin ts->max_steps = maxsteps; 2824618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2825618ce8baSLisandro Dalcin } 2826618ce8baSLisandro Dalcin 2827618ce8baSLisandro Dalcin /*@ 2828618ce8baSLisandro Dalcin TSGetMaxSteps - Gets the maximum number of steps to use. 2829618ce8baSLisandro Dalcin 2830618ce8baSLisandro Dalcin Not Collective 2831618ce8baSLisandro Dalcin 2832618ce8baSLisandro Dalcin Input Parameters: 2833618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2834618ce8baSLisandro Dalcin 2835618ce8baSLisandro Dalcin Output Parameter: 2836618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use 2837618ce8baSLisandro Dalcin 2838618ce8baSLisandro Dalcin Level: advanced 2839618ce8baSLisandro Dalcin 2840618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps 2841618ce8baSLisandro Dalcin 2842618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime() 2843618ce8baSLisandro Dalcin @*/ 2844618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps) 2845618ce8baSLisandro Dalcin { 2846618ce8baSLisandro Dalcin PetscFunctionBegin; 2847618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2848618ce8baSLisandro Dalcin PetscValidIntPointer(maxsteps,2); 2849618ce8baSLisandro Dalcin *maxsteps = ts->max_steps; 2850618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2851618ce8baSLisandro Dalcin } 2852618ce8baSLisandro Dalcin 2853618ce8baSLisandro Dalcin /*@ 2854618ce8baSLisandro Dalcin TSSetMaxTime - Sets the maximum (or final) time for timestepping. 2855618ce8baSLisandro Dalcin 2856618ce8baSLisandro Dalcin Logically Collective on TS 2857618ce8baSLisandro Dalcin 2858618ce8baSLisandro Dalcin Input Parameters: 2859618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2860618ce8baSLisandro Dalcin - maxtime - final time to step to 2861618ce8baSLisandro Dalcin 2862618ce8baSLisandro Dalcin Options Database Keys: 2863ef85077eSLisandro Dalcin . -ts_max_time <maxtime> - Sets maxtime 2864618ce8baSLisandro Dalcin 2865618ce8baSLisandro Dalcin Notes: 2866618ce8baSLisandro Dalcin The default maximum time is 5.0 2867618ce8baSLisandro Dalcin 2868618ce8baSLisandro Dalcin Level: intermediate 2869618ce8baSLisandro Dalcin 2870618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time 2871618ce8baSLisandro Dalcin 2872618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime() 2873618ce8baSLisandro Dalcin @*/ 2874618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime) 2875618ce8baSLisandro Dalcin { 2876618ce8baSLisandro Dalcin PetscFunctionBegin; 2877618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2878618ce8baSLisandro Dalcin PetscValidLogicalCollectiveReal(ts,maxtime,2); 2879618ce8baSLisandro Dalcin ts->max_time = maxtime; 2880618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2881618ce8baSLisandro Dalcin } 2882618ce8baSLisandro Dalcin 2883618ce8baSLisandro Dalcin /*@ 2884618ce8baSLisandro Dalcin TSGetMaxTime - Gets the maximum (or final) time for timestepping. 2885618ce8baSLisandro Dalcin 2886618ce8baSLisandro Dalcin Not Collective 2887618ce8baSLisandro Dalcin 2888618ce8baSLisandro Dalcin Input Parameters: 2889618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2890618ce8baSLisandro Dalcin 2891618ce8baSLisandro Dalcin Output Parameter: 2892618ce8baSLisandro Dalcin . maxtime - final time to step to 2893618ce8baSLisandro Dalcin 2894618ce8baSLisandro Dalcin Level: advanced 2895618ce8baSLisandro Dalcin 2896618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time 2897618ce8baSLisandro Dalcin 2898618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps() 2899618ce8baSLisandro Dalcin @*/ 2900618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime) 2901618ce8baSLisandro Dalcin { 2902618ce8baSLisandro Dalcin PetscFunctionBegin; 2903618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2904618ce8baSLisandro Dalcin PetscValidRealPointer(maxtime,2); 2905618ce8baSLisandro Dalcin *maxtime = ts->max_time; 2906618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2907618ce8baSLisandro Dalcin } 2908618ce8baSLisandro Dalcin 2909618ce8baSLisandro Dalcin /*@ 2910aaa6c58dSLisandro Dalcin TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep(). 2911edc382c3SSatish Balay 2912edc382c3SSatish Balay Level: deprecated 2913edc382c3SSatish Balay 2914aaa6c58dSLisandro Dalcin @*/ 2915aaa6c58dSLisandro Dalcin PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 2916aaa6c58dSLisandro Dalcin { 2917aaa6c58dSLisandro Dalcin PetscErrorCode ierr; 2918aaa6c58dSLisandro Dalcin PetscFunctionBegin; 2919aaa6c58dSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2920aaa6c58dSLisandro Dalcin ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 2921aaa6c58dSLisandro Dalcin ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 2922aaa6c58dSLisandro Dalcin PetscFunctionReturn(0); 2923aaa6c58dSLisandro Dalcin } 2924aaa6c58dSLisandro Dalcin 2925aaa6c58dSLisandro Dalcin /*@ 292619eac22cSLisandro Dalcin TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime(). 2927edc382c3SSatish Balay 2928edc382c3SSatish Balay Level: deprecated 2929edc382c3SSatish Balay 2930adb62b0dSMatthew Knepley @*/ 29317087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2932adb62b0dSMatthew Knepley { 2933adb62b0dSMatthew Knepley PetscFunctionBegin; 29340700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2935abc0a331SBarry Smith if (maxsteps) { 29364482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 2937adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 2938adb62b0dSMatthew Knepley } 2939abc0a331SBarry Smith if (maxtime) { 29404482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 2941adb62b0dSMatthew Knepley *maxtime = ts->max_time; 2942adb62b0dSMatthew Knepley } 2943adb62b0dSMatthew Knepley PetscFunctionReturn(0); 2944adb62b0dSMatthew Knepley } 2945adb62b0dSMatthew Knepley 2946d763cef2SBarry Smith /*@ 294719eac22cSLisandro Dalcin TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime(). 2948edc382c3SSatish Balay 2949edc382c3SSatish Balay Level: deprecated 2950edc382c3SSatish Balay 2951d763cef2SBarry Smith @*/ 29527087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 2953d763cef2SBarry Smith { 2954d763cef2SBarry Smith PetscFunctionBegin; 29550700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2956c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2957c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 295839b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 295939b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 2960d763cef2SBarry Smith PetscFunctionReturn(0); 2961d763cef2SBarry Smith } 2962d763cef2SBarry Smith 2963d763cef2SBarry Smith /*@ 29645c5f5948SLisandro Dalcin TSGetTimeStepNumber - Deprecated, use TSGetStepNumber(). 2965edc382c3SSatish Balay 2966edc382c3SSatish Balay Level: deprecated 2967edc382c3SSatish Balay 29685c5f5948SLisandro Dalcin @*/ 2969e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 29705c5f5948SLisandro Dalcin 297119eac22cSLisandro Dalcin /*@ 29724f4e0956SLisandro Dalcin TSGetTotalSteps - Deprecated, use TSGetStepNumber(). 2973edc382c3SSatish Balay 2974edc382c3SSatish Balay Level: deprecated 2975edc382c3SSatish Balay 29764f4e0956SLisandro Dalcin @*/ 29774f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 29784f4e0956SLisandro Dalcin 29794f4e0956SLisandro Dalcin /*@ 2980d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 2981d763cef2SBarry Smith for use by the TS routines. 2982d763cef2SBarry Smith 29833f9fe445SBarry Smith Logically Collective on TS and Vec 2984d763cef2SBarry Smith 2985d763cef2SBarry Smith Input Parameters: 2986d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 29870910c330SBarry Smith - u - the solution vector 2988d763cef2SBarry Smith 2989d763cef2SBarry Smith Level: beginner 2990d763cef2SBarry Smith 2991715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values 29920ed3bfb6SBarry Smith 29930ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate() 2994d763cef2SBarry Smith @*/ 29950910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 2996d763cef2SBarry Smith { 29978737fe31SLisandro Dalcin PetscErrorCode ierr; 2998496e6a7aSJed Brown DM dm; 29998737fe31SLisandro Dalcin 3000d763cef2SBarry Smith PetscFunctionBegin; 30010700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30020910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 30030910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 30046bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 30050910c330SBarry Smith ts->vec_sol = u; 3006bbd56ea5SKarl Rupp 3007496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 30080910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 3009d763cef2SBarry Smith PetscFunctionReturn(0); 3010d763cef2SBarry Smith } 3011d763cef2SBarry Smith 3012ac226902SBarry Smith /*@C 3013000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 30143f2090d5SJed Brown called once at the beginning of each time step. 3015000e7ae3SMatthew Knepley 30163f9fe445SBarry Smith Logically Collective on TS 3017000e7ae3SMatthew Knepley 3018000e7ae3SMatthew Knepley Input Parameters: 3019000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3020000e7ae3SMatthew Knepley - func - The function 3021000e7ae3SMatthew Knepley 3022000e7ae3SMatthew Knepley Calling sequence of func: 3023000e7ae3SMatthew Knepley . func (TS ts); 3024000e7ae3SMatthew Knepley 3025000e7ae3SMatthew Knepley Level: intermediate 3026000e7ae3SMatthew Knepley 3027000e7ae3SMatthew Knepley .keywords: TS, timestep 3028dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep() 3029000e7ae3SMatthew Knepley @*/ 30307087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3031000e7ae3SMatthew Knepley { 3032000e7ae3SMatthew Knepley PetscFunctionBegin; 30330700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3034ae60f76fSBarry Smith ts->prestep = func; 3035000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3036000e7ae3SMatthew Knepley } 3037000e7ae3SMatthew Knepley 303809ee8438SJed Brown /*@ 30393f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 30403f2090d5SJed Brown 30413f2090d5SJed Brown Collective on TS 30423f2090d5SJed Brown 30433f2090d5SJed Brown Input Parameters: 30443f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 30453f2090d5SJed Brown 30463f2090d5SJed Brown Notes: 30473f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 30483f2090d5SJed Brown so most users would not generally call this routine themselves. 30493f2090d5SJed Brown 30503f2090d5SJed Brown Level: developer 30513f2090d5SJed Brown 30523f2090d5SJed Brown .keywords: TS, timestep 30539be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 30543f2090d5SJed Brown @*/ 30557087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 30563f2090d5SJed Brown { 30573f2090d5SJed Brown PetscErrorCode ierr; 30583f2090d5SJed Brown 30593f2090d5SJed Brown PetscFunctionBegin; 30600700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3061ae60f76fSBarry Smith if (ts->prestep) { 30625efd42a4SStefano Zampini Vec U; 30635efd42a4SStefano Zampini PetscObjectState sprev,spost; 30645efd42a4SStefano Zampini 30655efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 30665efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3067ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 30685efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3069dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3070312ce896SJed Brown } 30713f2090d5SJed Brown PetscFunctionReturn(0); 30723f2090d5SJed Brown } 30733f2090d5SJed Brown 3074b8123daeSJed Brown /*@C 3075b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3076b8123daeSJed Brown called once at the beginning of each stage. 3077b8123daeSJed Brown 3078b8123daeSJed Brown Logically Collective on TS 3079b8123daeSJed Brown 3080b8123daeSJed Brown Input Parameters: 3081b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3082b8123daeSJed Brown - func - The function 3083b8123daeSJed Brown 3084b8123daeSJed Brown Calling sequence of func: 3085b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3086b8123daeSJed Brown 3087b8123daeSJed Brown Level: intermediate 3088b8123daeSJed Brown 3089b8123daeSJed Brown Note: 3090b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 309180275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 3092b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3093b8123daeSJed Brown 3094b8123daeSJed Brown .keywords: TS, timestep 30959be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3096b8123daeSJed Brown @*/ 3097b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3098b8123daeSJed Brown { 3099b8123daeSJed Brown PetscFunctionBegin; 3100b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3101ae60f76fSBarry Smith ts->prestage = func; 3102b8123daeSJed Brown PetscFunctionReturn(0); 3103b8123daeSJed Brown } 3104b8123daeSJed Brown 31059be3e283SDebojyoti Ghosh /*@C 31069be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 31079be3e283SDebojyoti Ghosh called once at the end of each stage. 31089be3e283SDebojyoti Ghosh 31099be3e283SDebojyoti Ghosh Logically Collective on TS 31109be3e283SDebojyoti Ghosh 31119be3e283SDebojyoti Ghosh Input Parameters: 31129be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 31139be3e283SDebojyoti Ghosh - func - The function 31149be3e283SDebojyoti Ghosh 31159be3e283SDebojyoti Ghosh Calling sequence of func: 31169be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 31179be3e283SDebojyoti Ghosh 31189be3e283SDebojyoti Ghosh Level: intermediate 31199be3e283SDebojyoti Ghosh 31209be3e283SDebojyoti Ghosh Note: 31219be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 312280275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 31239be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 31249be3e283SDebojyoti Ghosh 31259be3e283SDebojyoti Ghosh .keywords: TS, timestep 31269be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 31279be3e283SDebojyoti Ghosh @*/ 31289be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 31299be3e283SDebojyoti Ghosh { 31309be3e283SDebojyoti Ghosh PetscFunctionBegin; 31319be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 31329be3e283SDebojyoti Ghosh ts->poststage = func; 31339be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 31349be3e283SDebojyoti Ghosh } 31359be3e283SDebojyoti Ghosh 3136c688d042SShri Abhyankar /*@C 3137c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3138c688d042SShri Abhyankar called once at the end of each step evaluation. 3139c688d042SShri Abhyankar 3140c688d042SShri Abhyankar Logically Collective on TS 3141c688d042SShri Abhyankar 3142c688d042SShri Abhyankar Input Parameters: 3143c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3144c688d042SShri Abhyankar - func - The function 3145c688d042SShri Abhyankar 3146c688d042SShri Abhyankar Calling sequence of func: 3147c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3148c688d042SShri Abhyankar 3149c688d042SShri Abhyankar Level: intermediate 3150c688d042SShri Abhyankar 3151c688d042SShri Abhyankar Note: 31521785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 31531785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3154e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3155e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3156e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3157c688d042SShri Abhyankar 3158c688d042SShri Abhyankar .keywords: TS, timestep 3159c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3160c688d042SShri Abhyankar @*/ 3161c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3162c688d042SShri Abhyankar { 3163c688d042SShri Abhyankar PetscFunctionBegin; 3164c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3165c688d042SShri Abhyankar ts->postevaluate = func; 3166c688d042SShri Abhyankar PetscFunctionReturn(0); 3167c688d042SShri Abhyankar } 3168c688d042SShri Abhyankar 3169b8123daeSJed Brown /*@ 3170b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3171b8123daeSJed Brown 3172b8123daeSJed Brown Collective on TS 3173b8123daeSJed Brown 3174b8123daeSJed Brown Input Parameters: 3175b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 31769be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3177b8123daeSJed Brown 3178b8123daeSJed Brown Notes: 3179b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3180b8123daeSJed Brown most users would not generally call this routine themselves. 3181b8123daeSJed Brown 3182b8123daeSJed Brown Level: developer 3183b8123daeSJed Brown 3184b8123daeSJed Brown .keywords: TS, timestep 31859be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3186b8123daeSJed Brown @*/ 3187b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3188b8123daeSJed Brown { 3189b8123daeSJed Brown PetscErrorCode ierr; 3190b8123daeSJed Brown 3191b8123daeSJed Brown PetscFunctionBegin; 3192b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3193ae60f76fSBarry Smith if (ts->prestage) { 3194ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3195b8123daeSJed Brown } 3196b8123daeSJed Brown PetscFunctionReturn(0); 3197b8123daeSJed Brown } 3198b8123daeSJed Brown 31999be3e283SDebojyoti Ghosh /*@ 32009be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 32019be3e283SDebojyoti Ghosh 32029be3e283SDebojyoti Ghosh Collective on TS 32039be3e283SDebojyoti Ghosh 32049be3e283SDebojyoti Ghosh Input Parameters: 32059be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 32069be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 32079be3e283SDebojyoti Ghosh stageindex - Stage number 32089be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 32099be3e283SDebojyoti Ghosh of stages) with the stage solutions 32109be3e283SDebojyoti Ghosh 32119be3e283SDebojyoti Ghosh Notes: 32129be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 32139be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 32149be3e283SDebojyoti Ghosh 32159be3e283SDebojyoti Ghosh Level: developer 32169be3e283SDebojyoti Ghosh 32179be3e283SDebojyoti Ghosh .keywords: TS, timestep 32189be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 32199be3e283SDebojyoti Ghosh @*/ 32209be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 32219be3e283SDebojyoti Ghosh { 32229be3e283SDebojyoti Ghosh PetscErrorCode ierr; 32239be3e283SDebojyoti Ghosh 32249be3e283SDebojyoti Ghosh PetscFunctionBegin; 32259be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 32264beae5d8SLisandro Dalcin if (ts->poststage) { 32279be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 32289be3e283SDebojyoti Ghosh } 32299be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 32309be3e283SDebojyoti Ghosh } 32319be3e283SDebojyoti Ghosh 3232c688d042SShri Abhyankar /*@ 3233c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3234c688d042SShri Abhyankar 3235c688d042SShri Abhyankar Collective on TS 3236c688d042SShri Abhyankar 3237c688d042SShri Abhyankar Input Parameters: 3238c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3239c688d042SShri Abhyankar 3240c688d042SShri Abhyankar Notes: 3241c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3242c688d042SShri Abhyankar most users would not generally call this routine themselves. 3243c688d042SShri Abhyankar 3244c688d042SShri Abhyankar Level: developer 3245c688d042SShri Abhyankar 3246c688d042SShri Abhyankar .keywords: TS, timestep 3247c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3248c688d042SShri Abhyankar @*/ 3249c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3250c688d042SShri Abhyankar { 3251c688d042SShri Abhyankar PetscErrorCode ierr; 3252c688d042SShri Abhyankar 3253c688d042SShri Abhyankar PetscFunctionBegin; 3254c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3255c688d042SShri Abhyankar if (ts->postevaluate) { 3256dcb233daSLisandro Dalcin Vec U; 3257dcb233daSLisandro Dalcin PetscObjectState sprev,spost; 3258dcb233daSLisandro Dalcin 3259dcb233daSLisandro Dalcin ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 3260dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3261c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3262dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3263dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3264c688d042SShri Abhyankar } 3265c688d042SShri Abhyankar PetscFunctionReturn(0); 3266c688d042SShri Abhyankar } 3267c688d042SShri Abhyankar 3268ac226902SBarry Smith /*@C 3269000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 32703f2090d5SJed Brown called once at the end of each time step. 3271000e7ae3SMatthew Knepley 32723f9fe445SBarry Smith Logically Collective on TS 3273000e7ae3SMatthew Knepley 3274000e7ae3SMatthew Knepley Input Parameters: 3275000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3276000e7ae3SMatthew Knepley - func - The function 3277000e7ae3SMatthew Knepley 3278000e7ae3SMatthew Knepley Calling sequence of func: 3279b8123daeSJed Brown $ func (TS ts); 3280000e7ae3SMatthew Knepley 32811785ff2aSShri Abhyankar Notes: 32821785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 32831785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 32841785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 32851785ff2aSShri Abhyankar 3286000e7ae3SMatthew Knepley Level: intermediate 3287000e7ae3SMatthew Knepley 3288000e7ae3SMatthew Knepley .keywords: TS, timestep 3289dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep() 3290000e7ae3SMatthew Knepley @*/ 32917087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3292000e7ae3SMatthew Knepley { 3293000e7ae3SMatthew Knepley PetscFunctionBegin; 32940700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3295ae60f76fSBarry Smith ts->poststep = func; 3296000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3297000e7ae3SMatthew Knepley } 3298000e7ae3SMatthew Knepley 329909ee8438SJed Brown /*@ 33003f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 33013f2090d5SJed Brown 33023f2090d5SJed Brown Collective on TS 33033f2090d5SJed Brown 33043f2090d5SJed Brown Input Parameters: 33053f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 33063f2090d5SJed Brown 33073f2090d5SJed Brown Notes: 33083f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 33093f2090d5SJed Brown so most users would not generally call this routine themselves. 33103f2090d5SJed Brown 33113f2090d5SJed Brown Level: developer 33123f2090d5SJed Brown 33133f2090d5SJed Brown .keywords: TS, timestep 33143f2090d5SJed Brown @*/ 33157087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 33163f2090d5SJed Brown { 33173f2090d5SJed Brown PetscErrorCode ierr; 33183f2090d5SJed Brown 33193f2090d5SJed Brown PetscFunctionBegin; 33200700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3321ae60f76fSBarry Smith if (ts->poststep) { 33225efd42a4SStefano Zampini Vec U; 33235efd42a4SStefano Zampini PetscObjectState sprev,spost; 33245efd42a4SStefano Zampini 33255efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 33265efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3327ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 33285efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3329dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 333072ac3e02SJed Brown } 33313f2090d5SJed Brown PetscFunctionReturn(0); 33323f2090d5SJed Brown } 33333f2090d5SJed Brown 3334d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3335d763cef2SBarry Smith 3336d763cef2SBarry Smith /*@C 3337a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3338d763cef2SBarry Smith timestep to display the iteration's progress. 3339d763cef2SBarry Smith 33403f9fe445SBarry Smith Logically Collective on TS 3341d763cef2SBarry Smith 3342d763cef2SBarry Smith Input Parameters: 3343d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3344e213d8f1SJed Brown . monitor - monitoring routine 3345329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 33460298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3347b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 33480298fd71SBarry Smith (may be NULL) 3349d763cef2SBarry Smith 3350e213d8f1SJed Brown Calling sequence of monitor: 3351dcb233daSLisandro Dalcin $ PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3352d763cef2SBarry Smith 3353d763cef2SBarry Smith + ts - the TS context 335463e21af5SBarry 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) 33551f06c33eSBarry Smith . time - current time 33560910c330SBarry Smith . u - current iterate 3357d763cef2SBarry Smith - mctx - [optional] monitoring context 3358d763cef2SBarry Smith 3359d763cef2SBarry Smith Notes: 3360d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3361d763cef2SBarry Smith already has been loaded. 3362d763cef2SBarry Smith 336395452b02SPatrick Sanan Fortran Notes: 336495452b02SPatrick Sanan Only a single monitor function can be set for each TS object 3365025f1a04SBarry Smith 3366d763cef2SBarry Smith Level: intermediate 3367d763cef2SBarry Smith 3368d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3369d763cef2SBarry Smith 3370a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3371d763cef2SBarry Smith @*/ 3372c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3373d763cef2SBarry Smith { 337478064530SBarry Smith PetscErrorCode ierr; 337578064530SBarry Smith PetscInt i; 337678064530SBarry Smith PetscBool identical; 337778064530SBarry Smith 3378d763cef2SBarry Smith PetscFunctionBegin; 33790700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 338078064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 338178064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 338278064530SBarry Smith if (identical) PetscFunctionReturn(0); 338378064530SBarry Smith } 338417186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3385d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 33868704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3387d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3388d763cef2SBarry Smith PetscFunctionReturn(0); 3389d763cef2SBarry Smith } 3390d763cef2SBarry Smith 3391d763cef2SBarry Smith /*@C 3392a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3393d763cef2SBarry Smith 33943f9fe445SBarry Smith Logically Collective on TS 3395d763cef2SBarry Smith 3396d763cef2SBarry Smith Input Parameters: 3397d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3398d763cef2SBarry Smith 3399d763cef2SBarry Smith Notes: 3400d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3401d763cef2SBarry Smith 3402d763cef2SBarry Smith Level: intermediate 3403d763cef2SBarry Smith 3404d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3405d763cef2SBarry Smith 3406a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3407d763cef2SBarry Smith @*/ 34087087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3409d763cef2SBarry Smith { 3410d952e501SBarry Smith PetscErrorCode ierr; 3411d952e501SBarry Smith PetscInt i; 3412d952e501SBarry Smith 3413d763cef2SBarry Smith PetscFunctionBegin; 34140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3415d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 34168704b422SBarry Smith if (ts->monitordestroy[i]) { 34178704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3418d952e501SBarry Smith } 3419d952e501SBarry Smith } 3420d763cef2SBarry Smith ts->numbermonitors = 0; 3421d763cef2SBarry Smith PetscFunctionReturn(0); 3422d763cef2SBarry Smith } 3423d763cef2SBarry Smith 3424721cd6eeSBarry Smith /*@C 3425721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 34265516499fSSatish Balay 34275516499fSSatish Balay Level: intermediate 342841251cbbSSatish Balay 34295516499fSSatish Balay .keywords: TS, set, monitor 34305516499fSSatish Balay 343163e21af5SBarry Smith .seealso: TSMonitorSet() 343241251cbbSSatish Balay @*/ 3433721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3434d763cef2SBarry Smith { 3435dfbe8321SBarry Smith PetscErrorCode ierr; 3436721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 343741aca3d6SBarry Smith PetscBool iascii,ibinary; 3438d132466eSBarry Smith 3439d763cef2SBarry Smith PetscFunctionBegin; 34404d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 344141aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 344241aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3443721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 344441aca3d6SBarry Smith if (iascii) { 3445649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 344663e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 344763e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 344863e21af5SBarry Smith } else { 34498392e04aSShri 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); 345063e21af5SBarry Smith } 3451649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 345241aca3d6SBarry Smith } else if (ibinary) { 345341aca3d6SBarry Smith PetscMPIInt rank; 345441aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 345541aca3d6SBarry Smith if (!rank) { 3456450a797fSBarry Smith PetscBool skipHeader; 3457450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3458450a797fSBarry Smith 3459450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3460450a797fSBarry Smith if (!skipHeader) { 3461450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3462450a797fSBarry Smith } 346341aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 346441aca3d6SBarry Smith } else { 346541aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 346641aca3d6SBarry Smith } 346741aca3d6SBarry Smith } 3468721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3469d763cef2SBarry Smith PetscFunctionReturn(0); 3470d763cef2SBarry Smith } 3471d763cef2SBarry Smith 3472cd652676SJed Brown /*@ 3473cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3474cd652676SJed Brown 3475cd652676SJed Brown Collective on TS 3476cd652676SJed Brown 3477cd652676SJed Brown Input Argument: 3478cd652676SJed Brown + ts - time stepping context 3479cd652676SJed Brown - t - time to interpolate to 3480cd652676SJed Brown 3481cd652676SJed Brown Output Argument: 34820910c330SBarry Smith . U - state at given time 3483cd652676SJed Brown 3484cd652676SJed Brown Level: intermediate 3485cd652676SJed Brown 3486cd652676SJed Brown Developer Notes: 3487cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3488cd652676SJed Brown 3489cd652676SJed Brown .keywords: TS, set 3490cd652676SJed Brown 3491874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3492cd652676SJed Brown @*/ 34930910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3494cd652676SJed Brown { 3495cd652676SJed Brown PetscErrorCode ierr; 3496cd652676SJed Brown 3497cd652676SJed Brown PetscFunctionBegin; 3498cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3499b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3500be5899b3SLisandro 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); 3501ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 35020910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3503cd652676SJed Brown PetscFunctionReturn(0); 3504cd652676SJed Brown } 3505cd652676SJed Brown 3506d763cef2SBarry Smith /*@ 35076d9e5789SSean Farley TSStep - Steps one time step 3508d763cef2SBarry Smith 3509d763cef2SBarry Smith Collective on TS 3510d763cef2SBarry Smith 3511d763cef2SBarry Smith Input Parameter: 3512d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3513d763cef2SBarry Smith 351427829d71SBarry Smith Level: developer 3515d763cef2SBarry Smith 3516b8123daeSJed Brown Notes: 351727829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 351827829d71SBarry Smith 3519b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3520b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3521b8123daeSJed Brown 352219eac22cSLisandro Dalcin This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the 352319eac22cSLisandro Dalcin time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 352425cb2221SBarry Smith 3525d763cef2SBarry Smith .keywords: TS, timestep, solve 3526d763cef2SBarry Smith 35279be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3528d763cef2SBarry Smith @*/ 3529193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3530d763cef2SBarry Smith { 3531dfbe8321SBarry Smith PetscErrorCode ierr; 3532fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3533be5899b3SLisandro Dalcin PetscReal ptime; 3534d763cef2SBarry Smith 3535d763cef2SBarry Smith PetscFunctionBegin; 35360700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3537fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3538fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3539fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3540fffbeea8SBarry Smith " type = {Preprint},\n" 3541fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3542fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3543302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3544fffbeea8SBarry Smith 3545d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 354668bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3547d405a339SMatthew Knepley 3548ef85077eSLisandro Dalcin if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3549a6772fa2SLisandro 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()"); 3550be5899b3SLisandro 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"); 3551a6772fa2SLisandro Dalcin 3552be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3553be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 35542808aa04SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3555e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3556d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3557193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3558d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3559be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 35602808aa04SLisandro Dalcin ts->steps++; 3561be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 356228d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3563362cd11cSLisandro Dalcin 3564362cd11cSLisandro Dalcin if (ts->reason < 0) { 3565cef5090cSJed Brown if (ts->errorifstepfailed) { 356608c7845fSBarry 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]); 356708c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3568d2daff3dSHong Zhang } 356908c7845fSBarry Smith } else if (!ts->reason) { 357008c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 357108c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 357208c7845fSBarry Smith } 357308c7845fSBarry Smith PetscFunctionReturn(0); 357408c7845fSBarry Smith } 357508c7845fSBarry Smith 357608c7845fSBarry Smith /*@ 35777cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 35787cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 35797cbde773SLisandro Dalcin 35807cbde773SLisandro Dalcin Collective on TS 35817cbde773SLisandro Dalcin 35827cbde773SLisandro Dalcin Input Arguments: 35837cbde773SLisandro Dalcin + ts - time stepping context 35847cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 35857cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 35867cbde773SLisandro Dalcin 35877cbde773SLisandro Dalcin Output Arguments: 35887cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 35897cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 35907cbde773SLisandro Dalcin 35917cbde773SLisandro Dalcin Level: advanced 35927cbde773SLisandro Dalcin 35937cbde773SLisandro Dalcin Notes: 35947cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 35957cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 35967cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 35977cbde773SLisandro Dalcin 35987cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 35997cbde773SLisandro Dalcin @*/ 36007cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 36017cbde773SLisandro Dalcin { 36027cbde773SLisandro Dalcin PetscErrorCode ierr; 36037cbde773SLisandro Dalcin 36047cbde773SLisandro Dalcin PetscFunctionBegin; 36057cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 36067cbde773SLisandro Dalcin PetscValidType(ts,1); 36077cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 36087cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 36097cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 36107cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 36117cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 36127cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 36137cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 36147cbde773SLisandro Dalcin PetscFunctionReturn(0); 36157cbde773SLisandro Dalcin } 36167cbde773SLisandro Dalcin 361705175c85SJed Brown /*@ 361805175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 361905175c85SJed Brown 36201c3436cfSJed Brown Collective on TS 362105175c85SJed Brown 362205175c85SJed Brown Input Arguments: 36231c3436cfSJed Brown + ts - time stepping context 36241c3436cfSJed Brown . order - desired order of accuracy 36250298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 362605175c85SJed Brown 362705175c85SJed Brown Output Arguments: 36280910c330SBarry Smith . U - state at the end of the current step 362905175c85SJed Brown 363005175c85SJed Brown Level: advanced 363105175c85SJed Brown 3632108c343cSJed Brown Notes: 3633108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3634108c343cSJed 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. 3635108c343cSJed Brown 36361c3436cfSJed Brown .seealso: TSStep(), TSAdapt 363705175c85SJed Brown @*/ 36380910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 363905175c85SJed Brown { 364005175c85SJed Brown PetscErrorCode ierr; 364105175c85SJed Brown 364205175c85SJed Brown PetscFunctionBegin; 364305175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 364405175c85SJed Brown PetscValidType(ts,1); 36450910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3646ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 36470910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 364805175c85SJed Brown PetscFunctionReturn(0); 364905175c85SJed Brown } 365005175c85SJed Brown 3651b1cb36f3SHong Zhang /*@ 36526a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 36536a4d4014SLisandro Dalcin 36546a4d4014SLisandro Dalcin Collective on TS 36556a4d4014SLisandro Dalcin 36566a4d4014SLisandro Dalcin Input Parameter: 36576a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 365863e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 365963e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 36605a3a76d0SJed Brown 36616a4d4014SLisandro Dalcin Level: beginner 36626a4d4014SLisandro Dalcin 36635a3a76d0SJed Brown Notes: 36645a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 36655a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 36665a3a76d0SJed Brown stepped over the final time. 36675a3a76d0SJed Brown 36686a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 36696a4d4014SLisandro Dalcin 367063e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 36716a4d4014SLisandro Dalcin @*/ 3672cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 36736a4d4014SLisandro Dalcin { 3674b06615a5SLisandro Dalcin Vec solution; 36756a4d4014SLisandro Dalcin PetscErrorCode ierr; 3676f22f69f0SBarry Smith 36776a4d4014SLisandro Dalcin PetscFunctionBegin; 36780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3679f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3680feed9e9dSBarry Smith 3681ee41a567SStefano Zampini if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && u) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */ 36820910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3683b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3684b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3685b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 36865a3a76d0SJed Brown } 36870910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3688715f1b00SHong Zhang if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 3689bbd56ea5SKarl Rupp } else if (u) { 36900910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 36915a3a76d0SJed Brown } 3692b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 369368bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3694a6772fa2SLisandro Dalcin 3695ef85077eSLisandro Dalcin if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3696a6772fa2SLisandro 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()"); 3697a6772fa2SLisandro 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"); 3698a6772fa2SLisandro Dalcin 3699715f1b00SHong Zhang if (ts->forward_solve) { 3700715f1b00SHong Zhang ierr = TSForwardSetUp(ts);CHKERRQ(ierr); 3701715f1b00SHong Zhang } 3702715f1b00SHong Zhang 3703e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 3704715f1b00SHong Zhang restarts the step after an event. Resetting these counters in such case causes 3705e7069c78SShri TSTrajectory to incorrectly save the output files 3706e7069c78SShri */ 3707715f1b00SHong Zhang /* reset time step and iteration counters */ 37082808aa04SLisandro Dalcin if (!ts->steps) { 37095ef26d82SJed Brown ts->ksp_its = 0; 37105ef26d82SJed Brown ts->snes_its = 0; 3711c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3712c610991cSLisandro Dalcin ts->reject = 0; 37132808aa04SLisandro Dalcin ts->steprestart = PETSC_TRUE; 37142808aa04SLisandro Dalcin ts->steprollback = PETSC_FALSE; 37152808aa04SLisandro Dalcin } 371610bc0e4dSStefano Zampini if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && ts->ptime + ts->time_step > ts->max_time) ts->time_step = ts->max_time - ts->ptime; 3717193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3718193ac0bcSJed Brown 3719ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3720f05ece33SBarry Smith 3721193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3722193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 3723a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3724cc708dedSBarry Smith ts->solvetime = ts->ptime; 3725a6772fa2SLisandro Dalcin solution = ts->vec_sol; 3726be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 3727db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3728db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3729e7069c78SShri 37302808aa04SLisandro Dalcin if (!ts->steps) { 37312808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 37326427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 37332808aa04SLisandro Dalcin } 37346427ac75SLisandro Dalcin 3735e1a7a14fSJed Brown while (!ts->reason) { 37362808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 37379687d888SLisandro Dalcin if (!ts->steprollback) { 37389687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 37399687d888SLisandro Dalcin } 3740193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3741f3b1f45cSBarry Smith if (ts->testjacobian) { 3742f3b1f45cSBarry Smith ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr); 3743f3b1f45cSBarry Smith } 3744f3b1f45cSBarry Smith if (ts->testjacobiantranspose) { 3745f3b1f45cSBarry Smith ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr); 3746f3b1f45cSBarry Smith } 3747e783b05fSHong 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. */ 3748b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 3749b1cb36f3SHong Zhang } 375058818c2dSLisandro Dalcin if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 3751715f1b00SHong Zhang ierr = TSForwardStep(ts);CHKERRQ(ierr); 3752715f1b00SHong Zhang } 375310b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 3754e783b05fSHong 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. */ 375558818c2dSLisandro Dalcin if (ts->steprollback) { 375658818c2dSLisandro Dalcin ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 375758818c2dSLisandro Dalcin } 3758e783b05fSHong Zhang if (!ts->steprollback) { 37592808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 37601eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3761aeb4809dSShri Abhyankar } 3762193ac0bcSJed Brown } 37632808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 37646427ac75SLisandro Dalcin 376549354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 37660910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3767cc708dedSBarry Smith ts->solvetime = ts->max_time; 3768b06615a5SLisandro Dalcin solution = u; 376963e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 37700574a7fbSJed Brown } else { 3771ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3772cc708dedSBarry Smith ts->solvetime = ts->ptime; 3773b06615a5SLisandro Dalcin solution = ts->vec_sol; 37740574a7fbSJed Brown } 3775193ac0bcSJed Brown } 3776d2daff3dSHong Zhang 3777ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 377863e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 377956f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 3780ef222394SBarry Smith if (ts->adjoint_solve) { 3781ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 37822b0a91c0SBarry Smith } 37836a4d4014SLisandro Dalcin PetscFunctionReturn(0); 37846a4d4014SLisandro Dalcin } 37856a4d4014SLisandro Dalcin 37867db568b7SBarry Smith /*@C 3787228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 3788228d79bcSJed Brown 3789228d79bcSJed Brown Collective on TS 3790228d79bcSJed Brown 3791228d79bcSJed Brown Input Parameters: 3792228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 3793228d79bcSJed Brown . step - step number that has just completed 3794228d79bcSJed Brown . ptime - model time of the state 37950910c330SBarry Smith - u - state at the current model time 3796228d79bcSJed Brown 3797228d79bcSJed Brown Notes: 37987db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 37997db568b7SBarry Smith Users would almost never call this routine directly. 3800228d79bcSJed Brown 380163e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 380263e21af5SBarry Smith 38037db568b7SBarry Smith Level: developer 3804228d79bcSJed Brown 3805228d79bcSJed Brown .keywords: TS, timestep 3806228d79bcSJed Brown @*/ 38070910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 3808d763cef2SBarry Smith { 3809d6152f81SLisandro Dalcin DM dm; 3810a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 3811d6152f81SLisandro Dalcin PetscErrorCode ierr; 3812d763cef2SBarry Smith 3813d763cef2SBarry Smith PetscFunctionBegin; 3814b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3815b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 3816d6152f81SLisandro Dalcin 3817d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3818d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 3819d6152f81SLisandro Dalcin 38205edff71fSBarry Smith ierr = VecLockPush(u);CHKERRQ(ierr); 3821d763cef2SBarry Smith for (i=0; i<n; i++) { 38220910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 3823d763cef2SBarry Smith } 38245edff71fSBarry Smith ierr = VecLockPop(u);CHKERRQ(ierr); 3825d763cef2SBarry Smith PetscFunctionReturn(0); 3826d763cef2SBarry Smith } 3827d763cef2SBarry Smith 3828d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 3829d763cef2SBarry Smith /*@C 38307db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 3831a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 3832d763cef2SBarry Smith 3833d763cef2SBarry Smith Collective on TS 3834d763cef2SBarry Smith 3835d763cef2SBarry Smith Input Parameters: 3836d763cef2SBarry Smith + host - the X display to open, or null for the local machine 3837d763cef2SBarry Smith . label - the title to put in the title bar 38387c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 3839a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 3840a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 3841d763cef2SBarry Smith 3842d763cef2SBarry Smith Output Parameter: 38430b039ecaSBarry Smith . ctx - the context 3844d763cef2SBarry Smith 3845d763cef2SBarry Smith Options Database Key: 38464f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 38478b668821SLisandro Dalcin + -ts_monitor_lg_timestep_log - automatically sets line graph monitor 38487db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 38497db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 38507db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 38517db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 3852b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 3853d763cef2SBarry Smith 3854d763cef2SBarry Smith Notes: 3855a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 3856d763cef2SBarry Smith 38577db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 38587db568b7SBarry Smith 38597db568b7SBarry 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 38607db568b7SBarry 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 38617db568b7SBarry Smith as the first argument. 38627db568b7SBarry Smith 38637db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 38647db568b7SBarry Smith 3865d763cef2SBarry Smith Level: intermediate 3866d763cef2SBarry Smith 38677db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 3868d763cef2SBarry Smith 38697db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 38707db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 38717db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 38727db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 38737db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 38747c922b88SBarry Smith 3875d763cef2SBarry Smith @*/ 3876a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 3877d763cef2SBarry Smith { 38787f52daa2SLisandro Dalcin PetscDraw draw; 3879dfbe8321SBarry Smith PetscErrorCode ierr; 3880d763cef2SBarry Smith 3881d763cef2SBarry Smith PetscFunctionBegin; 3882b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 38837f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 38847f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 38857f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 3886287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 38877f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 3888a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 3889d763cef2SBarry Smith PetscFunctionReturn(0); 3890d763cef2SBarry Smith } 3891d763cef2SBarry Smith 3892b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 3893d763cef2SBarry Smith { 38940b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 3895c32365f1SBarry Smith PetscReal x = ptime,y; 3896dfbe8321SBarry Smith PetscErrorCode ierr; 3897d763cef2SBarry Smith 3898d763cef2SBarry Smith PetscFunctionBegin; 389963e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 3900b06615a5SLisandro Dalcin if (!step) { 3901a9f9c1f6SBarry Smith PetscDrawAxis axis; 39028b668821SLisandro Dalcin const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step"; 3903a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 39048b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr); 3905a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 3906a9f9c1f6SBarry Smith } 3907c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 39088b668821SLisandro Dalcin if (ctx->semilogy) y = PetscLog10Real(y); 39090b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 3910b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 39110b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 39126934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 39133923b477SBarry Smith } 3914d763cef2SBarry Smith PetscFunctionReturn(0); 3915d763cef2SBarry Smith } 3916d763cef2SBarry Smith 3917d763cef2SBarry Smith /*@C 3918a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 3919a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 3920d763cef2SBarry Smith 39210b039ecaSBarry Smith Collective on TSMonitorLGCtx 3922d763cef2SBarry Smith 3923d763cef2SBarry Smith Input Parameter: 39240b039ecaSBarry Smith . ctx - the monitor context 3925d763cef2SBarry Smith 3926d763cef2SBarry Smith Level: intermediate 3927d763cef2SBarry Smith 3928d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 3929d763cef2SBarry Smith 39304f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 3931d763cef2SBarry Smith @*/ 3932a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 3933d763cef2SBarry Smith { 3934dfbe8321SBarry Smith PetscErrorCode ierr; 3935d763cef2SBarry Smith 3936d763cef2SBarry Smith PetscFunctionBegin; 39377684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 39387684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 39397684fa3eSBarry Smith } 39400b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 394131152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 3942387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 3943387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 3944387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 39450b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 3946d763cef2SBarry Smith PetscFunctionReturn(0); 3947d763cef2SBarry Smith } 3948d763cef2SBarry Smith 3949d763cef2SBarry Smith /*@ 3950b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 3951d763cef2SBarry Smith 3952d763cef2SBarry Smith Not Collective 3953d763cef2SBarry Smith 3954d763cef2SBarry Smith Input Parameter: 3955d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3956d763cef2SBarry Smith 3957d763cef2SBarry Smith Output Parameter: 395819eac22cSLisandro Dalcin . t - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime(). 3959d763cef2SBarry Smith 3960d763cef2SBarry Smith Level: beginner 3961d763cef2SBarry Smith 3962b8123daeSJed Brown Note: 3963b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 39649be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 3965b8123daeSJed Brown 3966aaa6c58dSLisandro Dalcin .seealso: TSGetSolveTime(), TSSetTime(), TSGetTimeStep() 3967d763cef2SBarry Smith 3968d763cef2SBarry Smith .keywords: TS, get, time 3969d763cef2SBarry Smith @*/ 39707087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 3971d763cef2SBarry Smith { 3972d763cef2SBarry Smith PetscFunctionBegin; 39730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3974f7cf8827SBarry Smith PetscValidRealPointer(t,2); 3975d763cef2SBarry Smith *t = ts->ptime; 3976d763cef2SBarry Smith PetscFunctionReturn(0); 3977d763cef2SBarry Smith } 3978d763cef2SBarry Smith 3979e5e524a1SHong Zhang /*@ 3980e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 3981e5e524a1SHong Zhang 3982e5e524a1SHong Zhang Not Collective 3983e5e524a1SHong Zhang 3984e5e524a1SHong Zhang Input Parameter: 3985e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 3986e5e524a1SHong Zhang 3987e5e524a1SHong Zhang Output Parameter: 3988e5e524a1SHong Zhang . t - the previous time 3989e5e524a1SHong Zhang 3990e5e524a1SHong Zhang Level: beginner 3991e5e524a1SHong Zhang 3992aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep() 3993e5e524a1SHong Zhang 3994e5e524a1SHong Zhang .keywords: TS, get, time 3995e5e524a1SHong Zhang @*/ 3996e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 3997e5e524a1SHong Zhang { 3998e5e524a1SHong Zhang PetscFunctionBegin; 3999e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4000e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4001e5e524a1SHong Zhang *t = ts->ptime_prev; 4002e5e524a1SHong Zhang PetscFunctionReturn(0); 4003e5e524a1SHong Zhang } 4004e5e524a1SHong Zhang 40056a4d4014SLisandro Dalcin /*@ 40066a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 40076a4d4014SLisandro Dalcin 40083f9fe445SBarry Smith Logically Collective on TS 40096a4d4014SLisandro Dalcin 40106a4d4014SLisandro Dalcin Input Parameters: 40116a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 40126a4d4014SLisandro Dalcin - time - the time 40136a4d4014SLisandro Dalcin 40146a4d4014SLisandro Dalcin Level: intermediate 40156a4d4014SLisandro Dalcin 401619eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps() 40176a4d4014SLisandro Dalcin 40186a4d4014SLisandro Dalcin .keywords: TS, set, time 40196a4d4014SLisandro Dalcin @*/ 40207087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 40216a4d4014SLisandro Dalcin { 40226a4d4014SLisandro Dalcin PetscFunctionBegin; 40230700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4024c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 40256a4d4014SLisandro Dalcin ts->ptime = t; 40266a4d4014SLisandro Dalcin PetscFunctionReturn(0); 40276a4d4014SLisandro Dalcin } 40286a4d4014SLisandro Dalcin 4029d763cef2SBarry Smith /*@C 4030d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4031d763cef2SBarry Smith TS options in the database. 4032d763cef2SBarry Smith 40333f9fe445SBarry Smith Logically Collective on TS 4034d763cef2SBarry Smith 4035d763cef2SBarry Smith Input Parameter: 4036d763cef2SBarry Smith + ts - The TS context 4037d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4038d763cef2SBarry Smith 4039d763cef2SBarry Smith Notes: 4040d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4041d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4042d763cef2SBarry Smith hyphen. 4043d763cef2SBarry Smith 4044d763cef2SBarry Smith Level: advanced 4045d763cef2SBarry Smith 4046d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4047d763cef2SBarry Smith 4048d763cef2SBarry Smith .seealso: TSSetFromOptions() 4049d763cef2SBarry Smith 4050d763cef2SBarry Smith @*/ 40517087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4052d763cef2SBarry Smith { 4053dfbe8321SBarry Smith PetscErrorCode ierr; 4054089b2837SJed Brown SNES snes; 4055d763cef2SBarry Smith 4056d763cef2SBarry Smith PetscFunctionBegin; 40570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4058d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4059089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4060089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4061d763cef2SBarry Smith PetscFunctionReturn(0); 4062d763cef2SBarry Smith } 4063d763cef2SBarry Smith 4064d763cef2SBarry Smith /*@C 4065d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4066d763cef2SBarry Smith TS options in the database. 4067d763cef2SBarry Smith 40683f9fe445SBarry Smith Logically Collective on TS 4069d763cef2SBarry Smith 4070d763cef2SBarry Smith Input Parameter: 4071d763cef2SBarry Smith + ts - The TS context 4072d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4073d763cef2SBarry Smith 4074d763cef2SBarry Smith Notes: 4075d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4076d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4077d763cef2SBarry Smith hyphen. 4078d763cef2SBarry Smith 4079d763cef2SBarry Smith Level: advanced 4080d763cef2SBarry Smith 4081d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4082d763cef2SBarry Smith 4083d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4084d763cef2SBarry Smith 4085d763cef2SBarry Smith @*/ 40867087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4087d763cef2SBarry Smith { 4088dfbe8321SBarry Smith PetscErrorCode ierr; 4089089b2837SJed Brown SNES snes; 4090d763cef2SBarry Smith 4091d763cef2SBarry Smith PetscFunctionBegin; 40920700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4093d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4094089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4095089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4096d763cef2SBarry Smith PetscFunctionReturn(0); 4097d763cef2SBarry Smith } 4098d763cef2SBarry Smith 4099d763cef2SBarry Smith /*@C 4100d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4101d763cef2SBarry Smith TS options in the database. 4102d763cef2SBarry Smith 4103d763cef2SBarry Smith Not Collective 4104d763cef2SBarry Smith 4105d763cef2SBarry Smith Input Parameter: 4106d763cef2SBarry Smith . ts - The TS context 4107d763cef2SBarry Smith 4108d763cef2SBarry Smith Output Parameter: 4109d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4110d763cef2SBarry Smith 411195452b02SPatrick Sanan Notes: 411295452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prifix' of 4113d763cef2SBarry Smith sufficient length to hold the prefix. 4114d763cef2SBarry Smith 4115d763cef2SBarry Smith Level: intermediate 4116d763cef2SBarry Smith 4117d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4118d763cef2SBarry Smith 4119d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4120d763cef2SBarry Smith @*/ 41217087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4122d763cef2SBarry Smith { 4123dfbe8321SBarry Smith PetscErrorCode ierr; 4124d763cef2SBarry Smith 4125d763cef2SBarry Smith PetscFunctionBegin; 41260700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 41274482741eSBarry Smith PetscValidPointer(prefix,2); 4128d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4129d763cef2SBarry Smith PetscFunctionReturn(0); 4130d763cef2SBarry Smith } 4131d763cef2SBarry Smith 4132d763cef2SBarry Smith /*@C 4133d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4134d763cef2SBarry Smith 4135d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4136d763cef2SBarry Smith 4137d763cef2SBarry Smith Input Parameter: 4138d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4139d763cef2SBarry Smith 4140d763cef2SBarry Smith Output Parameters: 4141e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4142e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4143e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4144e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4145d763cef2SBarry Smith 414695452b02SPatrick Sanan Notes: 414795452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 4148d763cef2SBarry Smith 4149d763cef2SBarry Smith Level: intermediate 4150d763cef2SBarry Smith 415180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 4152d763cef2SBarry Smith 4153d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4154d763cef2SBarry Smith @*/ 4155e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4156d763cef2SBarry Smith { 4157089b2837SJed Brown PetscErrorCode ierr; 415824989b8cSPeter Brune DM dm; 4159089b2837SJed Brown 4160d763cef2SBarry Smith PetscFunctionBegin; 416123a57915SBarry Smith if (Amat || Pmat) { 416223a57915SBarry Smith SNES snes; 4163089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 416423a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4165e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 416623a57915SBarry Smith } 416724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 416824989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4169d763cef2SBarry Smith PetscFunctionReturn(0); 4170d763cef2SBarry Smith } 4171d763cef2SBarry Smith 41722eca1d9cSJed Brown /*@C 41732eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 41742eca1d9cSJed Brown 41752eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 41762eca1d9cSJed Brown 41772eca1d9cSJed Brown Input Parameter: 41782eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 41792eca1d9cSJed Brown 41802eca1d9cSJed Brown Output Parameters: 4181e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4182e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 41832eca1d9cSJed Brown . f - The function to compute the matrices 41842eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 41852eca1d9cSJed Brown 418695452b02SPatrick Sanan Notes: 418795452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 41882eca1d9cSJed Brown 41892eca1d9cSJed Brown Level: advanced 41902eca1d9cSJed Brown 419180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 41922eca1d9cSJed Brown 41932eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 41942eca1d9cSJed Brown @*/ 4195e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 41962eca1d9cSJed Brown { 4197089b2837SJed Brown PetscErrorCode ierr; 419824989b8cSPeter Brune DM dm; 41990910c330SBarry Smith 42002eca1d9cSJed Brown PetscFunctionBegin; 4201c0aab802Sstefano_zampini if (Amat || Pmat) { 4202c0aab802Sstefano_zampini SNES snes; 4203089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4204f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4205e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4206c0aab802Sstefano_zampini } 420724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 420824989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 42092eca1d9cSJed Brown PetscFunctionReturn(0); 42102eca1d9cSJed Brown } 42112eca1d9cSJed Brown 42121713a123SBarry Smith /*@C 421383a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 42141713a123SBarry Smith VecView() for the solution at each timestep 42151713a123SBarry Smith 42161713a123SBarry Smith Collective on TS 42171713a123SBarry Smith 42181713a123SBarry Smith Input Parameters: 42191713a123SBarry Smith + ts - the TS context 42201713a123SBarry Smith . step - current time-step 4221142b95e3SSatish Balay . ptime - current time 42220298fd71SBarry Smith - dummy - either a viewer or NULL 42231713a123SBarry Smith 422499fdda47SBarry Smith Options Database: 422599fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 422699fdda47SBarry Smith 422795452b02SPatrick Sanan Notes: 422895452b02SPatrick Sanan the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 422999fdda47SBarry Smith will look bad 423099fdda47SBarry Smith 42311713a123SBarry Smith Level: intermediate 42321713a123SBarry Smith 42331713a123SBarry Smith .keywords: TS, vector, monitor, view 42341713a123SBarry Smith 4235a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 42361713a123SBarry Smith @*/ 42370910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 42381713a123SBarry Smith { 4239dfbe8321SBarry Smith PetscErrorCode ierr; 424083a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4241473a3ab2SBarry Smith PetscDraw draw; 42421713a123SBarry Smith 42431713a123SBarry Smith PetscFunctionBegin; 42446083293cSBarry Smith if (!step && ictx->showinitial) { 42456083293cSBarry Smith if (!ictx->initialsolution) { 42460910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 42471713a123SBarry Smith } 42480910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 42496083293cSBarry Smith } 4250b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 42510dcf80beSBarry Smith 42526083293cSBarry Smith if (ictx->showinitial) { 42536083293cSBarry Smith PetscReal pause; 42546083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 42556083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 42566083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 42576083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 42586083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 42596083293cSBarry Smith } 42600910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4261473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 426251fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4263473a3ab2SBarry Smith char time[32]; 4264473a3ab2SBarry Smith 4265473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 426685b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4267473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4268473a3ab2SBarry Smith h = yl + .95*(yr - yl); 426951fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4270473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4271473a3ab2SBarry Smith } 4272473a3ab2SBarry Smith 42736083293cSBarry Smith if (ictx->showinitial) { 42746083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 42756083293cSBarry Smith } 42761713a123SBarry Smith PetscFunctionReturn(0); 42771713a123SBarry Smith } 42781713a123SBarry Smith 42799110b2e7SHong Zhang /*@C 42802d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 42812d5ee99bSBarry Smith 42822d5ee99bSBarry Smith Collective on TS 42832d5ee99bSBarry Smith 42842d5ee99bSBarry Smith Input Parameters: 42852d5ee99bSBarry Smith + ts - the TS context 42862d5ee99bSBarry Smith . step - current time-step 42872d5ee99bSBarry Smith . ptime - current time 42882d5ee99bSBarry Smith - dummy - either a viewer or NULL 42892d5ee99bSBarry Smith 42902d5ee99bSBarry Smith Level: intermediate 42912d5ee99bSBarry Smith 42922d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 42932d5ee99bSBarry Smith 42942d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 42952d5ee99bSBarry Smith @*/ 42962d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 42972d5ee99bSBarry Smith { 42982d5ee99bSBarry Smith PetscErrorCode ierr; 42992d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 43002d5ee99bSBarry Smith PetscDraw draw; 43016934998bSLisandro Dalcin PetscDrawAxis axis; 43022d5ee99bSBarry Smith PetscInt n; 43032d5ee99bSBarry Smith PetscMPIInt size; 43046934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 43052d5ee99bSBarry Smith char time[32]; 43062d5ee99bSBarry Smith const PetscScalar *U; 43072d5ee99bSBarry Smith 43082d5ee99bSBarry Smith PetscFunctionBegin; 43096934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 43106934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 43112d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 43126934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 43132d5ee99bSBarry Smith 43142d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 43156934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 43166934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 43176934998bSLisandro Dalcin if (!step) { 43186934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 43196934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 43206934998bSLisandro Dalcin } 43212d5ee99bSBarry Smith 43222d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 43236934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 43246934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4325a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 43266934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 43272d5ee99bSBarry Smith 43286934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 43296934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 43302d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 43314b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 433285b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 43332d5ee99bSBarry Smith h = yl + .95*(yr - yl); 433451fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 43352d5ee99bSBarry Smith } 43366934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 43372d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 433856d62c8fSLisandro Dalcin ierr = PetscDrawPause(draw);CHKERRQ(ierr); 43396934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 43402d5ee99bSBarry Smith PetscFunctionReturn(0); 43412d5ee99bSBarry Smith } 43422d5ee99bSBarry Smith 43436083293cSBarry Smith /*@C 434483a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 43456083293cSBarry Smith 43466083293cSBarry Smith Collective on TS 43476083293cSBarry Smith 43486083293cSBarry Smith Input Parameters: 43496083293cSBarry Smith . ctx - the monitor context 43506083293cSBarry Smith 43516083293cSBarry Smith Level: intermediate 43526083293cSBarry Smith 43536083293cSBarry Smith .keywords: TS, vector, monitor, view 43546083293cSBarry Smith 435583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 43566083293cSBarry Smith @*/ 435783a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 43586083293cSBarry Smith { 43596083293cSBarry Smith PetscErrorCode ierr; 43606083293cSBarry Smith 43616083293cSBarry Smith PetscFunctionBegin; 436283a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 436383a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 436483a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 43656083293cSBarry Smith PetscFunctionReturn(0); 43666083293cSBarry Smith } 43676083293cSBarry Smith 43686083293cSBarry Smith /*@C 436983a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 43706083293cSBarry Smith 43716083293cSBarry Smith Collective on TS 43726083293cSBarry Smith 43736083293cSBarry Smith Input Parameter: 43746083293cSBarry Smith . ts - time-step context 43756083293cSBarry Smith 43766083293cSBarry Smith Output Patameter: 43776083293cSBarry Smith . ctx - the monitor context 43786083293cSBarry Smith 437999fdda47SBarry Smith Options Database: 438099fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 438199fdda47SBarry Smith 43826083293cSBarry Smith Level: intermediate 43836083293cSBarry Smith 43846083293cSBarry Smith .keywords: TS, vector, monitor, view 43856083293cSBarry Smith 438683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 43876083293cSBarry Smith @*/ 438883a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 43896083293cSBarry Smith { 43906083293cSBarry Smith PetscErrorCode ierr; 43916083293cSBarry Smith 43926083293cSBarry Smith PetscFunctionBegin; 4393b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 439483a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4395e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4396bbd56ea5SKarl Rupp 439783a4ac43SBarry Smith (*ctx)->howoften = howoften; 4398473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4399c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4400473a3ab2SBarry Smith 4401473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4402c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 44036083293cSBarry Smith PetscFunctionReturn(0); 44046083293cSBarry Smith } 44056083293cSBarry Smith 44063a471f94SBarry Smith /*@C 44070ed3bfb6SBarry Smith TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling 44080ed3bfb6SBarry Smith VecView() for the solution provided by TSSetSolutionFunction() at each timestep 44090ed3bfb6SBarry Smith 44100ed3bfb6SBarry Smith Collective on TS 44110ed3bfb6SBarry Smith 44120ed3bfb6SBarry Smith Input Parameters: 44130ed3bfb6SBarry Smith + ts - the TS context 44140ed3bfb6SBarry Smith . step - current time-step 44150ed3bfb6SBarry Smith . ptime - current time 44160ed3bfb6SBarry Smith - dummy - either a viewer or NULL 44170ed3bfb6SBarry Smith 44180ed3bfb6SBarry Smith Options Database: 44190ed3bfb6SBarry Smith . -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 44200ed3bfb6SBarry Smith 44210ed3bfb6SBarry Smith Level: intermediate 44220ed3bfb6SBarry Smith 44230ed3bfb6SBarry Smith .keywords: TS, vector, monitor, view 44240ed3bfb6SBarry Smith 44250ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 44260ed3bfb6SBarry Smith @*/ 44270ed3bfb6SBarry Smith PetscErrorCode TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 44280ed3bfb6SBarry Smith { 44290ed3bfb6SBarry Smith PetscErrorCode ierr; 44300ed3bfb6SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 44310ed3bfb6SBarry Smith PetscViewer viewer = ctx->viewer; 44320ed3bfb6SBarry Smith Vec work; 44330ed3bfb6SBarry Smith 44340ed3bfb6SBarry Smith PetscFunctionBegin; 44350ed3bfb6SBarry Smith if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 44360ed3bfb6SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 44370ed3bfb6SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 44380ed3bfb6SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 44390ed3bfb6SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 44400ed3bfb6SBarry Smith PetscFunctionReturn(0); 44410ed3bfb6SBarry Smith } 44420ed3bfb6SBarry Smith 44430ed3bfb6SBarry Smith /*@C 444483a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 44453a471f94SBarry Smith VecView() for the error at each timestep 44463a471f94SBarry Smith 44473a471f94SBarry Smith Collective on TS 44483a471f94SBarry Smith 44493a471f94SBarry Smith Input Parameters: 44503a471f94SBarry Smith + ts - the TS context 44513a471f94SBarry Smith . step - current time-step 44523a471f94SBarry Smith . ptime - current time 44530298fd71SBarry Smith - dummy - either a viewer or NULL 44543a471f94SBarry Smith 44550ed3bfb6SBarry Smith Options Database: 44560ed3bfb6SBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 44570ed3bfb6SBarry Smith 44583a471f94SBarry Smith Level: intermediate 44593a471f94SBarry Smith 44603a471f94SBarry Smith .keywords: TS, vector, monitor, view 44613a471f94SBarry Smith 44620ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 44633a471f94SBarry Smith @*/ 44640910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 44653a471f94SBarry Smith { 44663a471f94SBarry Smith PetscErrorCode ierr; 446783a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 446883a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 44693a471f94SBarry Smith Vec work; 44703a471f94SBarry Smith 44713a471f94SBarry Smith PetscFunctionBegin; 4472b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 44730910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 44743a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 44750910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 44763a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 44773a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 44783a471f94SBarry Smith PetscFunctionReturn(0); 44793a471f94SBarry Smith } 44803a471f94SBarry Smith 4481af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 44826c699258SBarry Smith /*@ 44832a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 44846c699258SBarry Smith 44853f9fe445SBarry Smith Logically Collective on TS and DM 44866c699258SBarry Smith 44876c699258SBarry Smith Input Parameters: 44882a808120SBarry Smith + ts - the ODE integrator object 44892a808120SBarry Smith - dm - the dm, cannot be NULL 44906c699258SBarry Smith 44916c699258SBarry Smith Level: intermediate 44926c699258SBarry Smith 44936c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 44946c699258SBarry Smith @*/ 44957087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 44966c699258SBarry Smith { 44976c699258SBarry Smith PetscErrorCode ierr; 4498089b2837SJed Brown SNES snes; 4499942e3340SBarry Smith DMTS tsdm; 45006c699258SBarry Smith 45016c699258SBarry Smith PetscFunctionBegin; 45020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45032a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 450470663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4505942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 45062a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4507942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4508942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 450924989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 451024989b8cSPeter Brune tsdm->originaldm = dm; 451124989b8cSPeter Brune } 451224989b8cSPeter Brune } 45136bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 451424989b8cSPeter Brune } 45156c699258SBarry Smith ts->dm = dm; 4516bbd56ea5SKarl Rupp 4517089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4518089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 45196c699258SBarry Smith PetscFunctionReturn(0); 45206c699258SBarry Smith } 45216c699258SBarry Smith 45226c699258SBarry Smith /*@ 45236c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 45246c699258SBarry Smith 45253f9fe445SBarry Smith Not Collective 45266c699258SBarry Smith 45276c699258SBarry Smith Input Parameter: 45286c699258SBarry Smith . ts - the preconditioner context 45296c699258SBarry Smith 45306c699258SBarry Smith Output Parameter: 45316c699258SBarry Smith . dm - the dm 45326c699258SBarry Smith 45336c699258SBarry Smith Level: intermediate 45346c699258SBarry Smith 45356c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 45366c699258SBarry Smith @*/ 45377087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 45386c699258SBarry Smith { 4539496e6a7aSJed Brown PetscErrorCode ierr; 4540496e6a7aSJed Brown 45416c699258SBarry Smith PetscFunctionBegin; 45420700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4543496e6a7aSJed Brown if (!ts->dm) { 4544ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4545496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4546496e6a7aSJed Brown } 45476c699258SBarry Smith *dm = ts->dm; 45486c699258SBarry Smith PetscFunctionReturn(0); 45496c699258SBarry Smith } 45501713a123SBarry Smith 45510f5c6efeSJed Brown /*@ 45520f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 45530f5c6efeSJed Brown 45543f9fe445SBarry Smith Logically Collective on SNES 45550f5c6efeSJed Brown 45560f5c6efeSJed Brown Input Parameter: 4557d42a1c89SJed Brown + snes - nonlinear solver 45580910c330SBarry Smith . U - the current state at which to evaluate the residual 4559d42a1c89SJed Brown - ctx - user context, must be a TS 45600f5c6efeSJed Brown 45610f5c6efeSJed Brown Output Parameter: 45620f5c6efeSJed Brown . F - the nonlinear residual 45630f5c6efeSJed Brown 45640f5c6efeSJed Brown Notes: 45650f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 45660f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 45670f5c6efeSJed Brown 45680f5c6efeSJed Brown Level: advanced 45690f5c6efeSJed Brown 45700f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 45710f5c6efeSJed Brown @*/ 45720910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 45730f5c6efeSJed Brown { 45740f5c6efeSJed Brown TS ts = (TS)ctx; 45750f5c6efeSJed Brown PetscErrorCode ierr; 45760f5c6efeSJed Brown 45770f5c6efeSJed Brown PetscFunctionBegin; 45780f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 45790910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 45800f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 45810f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 45820910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 45830f5c6efeSJed Brown PetscFunctionReturn(0); 45840f5c6efeSJed Brown } 45850f5c6efeSJed Brown 45860f5c6efeSJed Brown /*@ 45870f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 45880f5c6efeSJed Brown 45890f5c6efeSJed Brown Collective on SNES 45900f5c6efeSJed Brown 45910f5c6efeSJed Brown Input Parameter: 45920f5c6efeSJed Brown + snes - nonlinear solver 45930910c330SBarry Smith . U - the current state at which to evaluate the residual 45940f5c6efeSJed Brown - ctx - user context, must be a TS 45950f5c6efeSJed Brown 45960f5c6efeSJed Brown Output Parameter: 45970f5c6efeSJed Brown + A - the Jacobian 45980f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 45990f5c6efeSJed Brown - flag - indicates any structure change in the matrix 46000f5c6efeSJed Brown 46010f5c6efeSJed Brown Notes: 46020f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 46030f5c6efeSJed Brown 46040f5c6efeSJed Brown Level: developer 46050f5c6efeSJed Brown 46060f5c6efeSJed Brown .seealso: SNESSetJacobian() 46070f5c6efeSJed Brown @*/ 4608d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 46090f5c6efeSJed Brown { 46100f5c6efeSJed Brown TS ts = (TS)ctx; 46110f5c6efeSJed Brown PetscErrorCode ierr; 46120f5c6efeSJed Brown 46130f5c6efeSJed Brown PetscFunctionBegin; 46140f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 46150910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 46160f5c6efeSJed Brown PetscValidPointer(A,3); 461794ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 46180f5c6efeSJed Brown PetscValidPointer(B,4); 461994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 46200f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 4621d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 46220f5c6efeSJed Brown PetscFunctionReturn(0); 46230f5c6efeSJed Brown } 4624325fc9f4SBarry Smith 46250e4ef248SJed Brown /*@C 46269ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 46270e4ef248SJed Brown 46280e4ef248SJed Brown Collective on TS 46290e4ef248SJed Brown 46300e4ef248SJed Brown Input Arguments: 46310e4ef248SJed Brown + ts - time stepping context 46320e4ef248SJed Brown . t - time at which to evaluate 46330910c330SBarry Smith . U - state at which to evaluate 46340e4ef248SJed Brown - ctx - context 46350e4ef248SJed Brown 46360e4ef248SJed Brown Output Arguments: 46370e4ef248SJed Brown . F - right hand side 46380e4ef248SJed Brown 46390e4ef248SJed Brown Level: intermediate 46400e4ef248SJed Brown 46410e4ef248SJed Brown Notes: 46420e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 46430e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 46440e4ef248SJed Brown 46450e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 46460e4ef248SJed Brown @*/ 46470910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 46480e4ef248SJed Brown { 46490e4ef248SJed Brown PetscErrorCode ierr; 46500e4ef248SJed Brown Mat Arhs,Brhs; 46510e4ef248SJed Brown 46520e4ef248SJed Brown PetscFunctionBegin; 46530e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 4654d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 46550910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 46560e4ef248SJed Brown PetscFunctionReturn(0); 46570e4ef248SJed Brown } 46580e4ef248SJed Brown 46590e4ef248SJed Brown /*@C 46600e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 46610e4ef248SJed Brown 46620e4ef248SJed Brown Collective on TS 46630e4ef248SJed Brown 46640e4ef248SJed Brown Input Arguments: 46650e4ef248SJed Brown + ts - time stepping context 46660e4ef248SJed Brown . t - time at which to evaluate 46670910c330SBarry Smith . U - state at which to evaluate 46680e4ef248SJed Brown - ctx - context 46690e4ef248SJed Brown 46700e4ef248SJed Brown Output Arguments: 46710e4ef248SJed Brown + A - pointer to operator 46720e4ef248SJed Brown . B - pointer to preconditioning matrix 46730e4ef248SJed Brown - flg - matrix structure flag 46740e4ef248SJed Brown 46750e4ef248SJed Brown Level: intermediate 46760e4ef248SJed Brown 46770e4ef248SJed Brown Notes: 46780e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 46790e4ef248SJed Brown 46800e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 46810e4ef248SJed Brown @*/ 4682d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 46830e4ef248SJed Brown { 46840e4ef248SJed Brown PetscFunctionBegin; 46850e4ef248SJed Brown PetscFunctionReturn(0); 46860e4ef248SJed Brown } 46870e4ef248SJed Brown 46880026cea9SSean Farley /*@C 46890026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 46900026cea9SSean Farley 46910026cea9SSean Farley Collective on TS 46920026cea9SSean Farley 46930026cea9SSean Farley Input Arguments: 46940026cea9SSean Farley + ts - time stepping context 46950026cea9SSean Farley . t - time at which to evaluate 46960910c330SBarry Smith . U - state at which to evaluate 46970910c330SBarry Smith . Udot - time derivative of state vector 46980026cea9SSean Farley - ctx - context 46990026cea9SSean Farley 47000026cea9SSean Farley Output Arguments: 47010026cea9SSean Farley . F - left hand side 47020026cea9SSean Farley 47030026cea9SSean Farley Level: intermediate 47040026cea9SSean Farley 47050026cea9SSean Farley Notes: 47060910c330SBarry 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 47070026cea9SSean Farley user is required to write their own TSComputeIFunction. 47080026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 47090026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 47100026cea9SSean Farley 47119ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 47129ae8fd06SBarry Smith 47139ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 47140026cea9SSean Farley @*/ 47150910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 47160026cea9SSean Farley { 47170026cea9SSean Farley PetscErrorCode ierr; 47180026cea9SSean Farley Mat A,B; 47190026cea9SSean Farley 47200026cea9SSean Farley PetscFunctionBegin; 47210298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4722d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 47230910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 47240026cea9SSean Farley PetscFunctionReturn(0); 47250026cea9SSean Farley } 47260026cea9SSean Farley 47270026cea9SSean Farley /*@C 4728b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 47290026cea9SSean Farley 47300026cea9SSean Farley Collective on TS 47310026cea9SSean Farley 47320026cea9SSean Farley Input Arguments: 47330026cea9SSean Farley + ts - time stepping context 47340026cea9SSean Farley . t - time at which to evaluate 47350910c330SBarry Smith . U - state at which to evaluate 47360910c330SBarry Smith . Udot - time derivative of state vector 47370026cea9SSean Farley . shift - shift to apply 47380026cea9SSean Farley - ctx - context 47390026cea9SSean Farley 47400026cea9SSean Farley Output Arguments: 47410026cea9SSean Farley + A - pointer to operator 47420026cea9SSean Farley . B - pointer to preconditioning matrix 47430026cea9SSean Farley - flg - matrix structure flag 47440026cea9SSean Farley 4745b41af12eSJed Brown Level: advanced 47460026cea9SSean Farley 47470026cea9SSean Farley Notes: 47480026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 47490026cea9SSean Farley 4750b41af12eSJed Brown It is only appropriate for problems of the form 4751b41af12eSJed Brown 4752b41af12eSJed Brown $ M Udot = F(U,t) 4753b41af12eSJed Brown 4754b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4755b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4756b41af12eSJed Brown an implicit operator of the form 4757b41af12eSJed Brown 4758b41af12eSJed Brown $ shift*M + J 4759b41af12eSJed Brown 4760b41af12eSJed 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 4761b41af12eSJed Brown a copy of M or reassemble it when requested. 4762b41af12eSJed Brown 47630026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 47640026cea9SSean Farley @*/ 4765d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 47660026cea9SSean Farley { 4767b41af12eSJed Brown PetscErrorCode ierr; 4768b41af12eSJed Brown 47690026cea9SSean Farley PetscFunctionBegin; 477094ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4771b41af12eSJed Brown ts->ijacobian.shift = shift; 47720026cea9SSean Farley PetscFunctionReturn(0); 47730026cea9SSean Farley } 4774b41af12eSJed Brown 4775e817cc15SEmil Constantinescu /*@ 4776e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4777e817cc15SEmil Constantinescu 4778e817cc15SEmil Constantinescu Not Collective 4779e817cc15SEmil Constantinescu 4780e817cc15SEmil Constantinescu Input Parameter: 4781e817cc15SEmil Constantinescu . ts - the TS context 4782e817cc15SEmil Constantinescu 4783e817cc15SEmil Constantinescu Output Parameter: 47844e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4785e817cc15SEmil Constantinescu 4786e817cc15SEmil Constantinescu Level: beginner 4787e817cc15SEmil Constantinescu 4788e817cc15SEmil Constantinescu .keywords: TS, equation type 4789e817cc15SEmil Constantinescu 4790e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4791e817cc15SEmil Constantinescu @*/ 4792e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4793e817cc15SEmil Constantinescu { 4794e817cc15SEmil Constantinescu PetscFunctionBegin; 4795e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4796e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4797e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4798e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4799e817cc15SEmil Constantinescu } 4800e817cc15SEmil Constantinescu 4801e817cc15SEmil Constantinescu /*@ 4802e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4803e817cc15SEmil Constantinescu 4804e817cc15SEmil Constantinescu Not Collective 4805e817cc15SEmil Constantinescu 4806e817cc15SEmil Constantinescu Input Parameter: 4807e817cc15SEmil Constantinescu + ts - the TS context 48081297b224SEmil Constantinescu - equation_type - see TSEquationType 4809e817cc15SEmil Constantinescu 4810e817cc15SEmil Constantinescu Level: advanced 4811e817cc15SEmil Constantinescu 4812e817cc15SEmil Constantinescu .keywords: TS, equation type 4813e817cc15SEmil Constantinescu 4814e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4815e817cc15SEmil Constantinescu @*/ 4816e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4817e817cc15SEmil Constantinescu { 4818e817cc15SEmil Constantinescu PetscFunctionBegin; 4819e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4820e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4821e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4822e817cc15SEmil Constantinescu } 48230026cea9SSean Farley 48244af1b03aSJed Brown /*@ 48254af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 48264af1b03aSJed Brown 48274af1b03aSJed Brown Not Collective 48284af1b03aSJed Brown 48294af1b03aSJed Brown Input Parameter: 48304af1b03aSJed Brown . ts - the TS context 48314af1b03aSJed Brown 48324af1b03aSJed Brown Output Parameter: 48334af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 48344af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 48354af1b03aSJed Brown 4836487e0bb9SJed Brown Level: beginner 48374af1b03aSJed Brown 4838cd652676SJed Brown Notes: 4839cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 48404af1b03aSJed Brown 48414af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 48424af1b03aSJed Brown 48434af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 48444af1b03aSJed Brown @*/ 48454af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 48464af1b03aSJed Brown { 48474af1b03aSJed Brown PetscFunctionBegin; 48484af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 48494af1b03aSJed Brown PetscValidPointer(reason,2); 48504af1b03aSJed Brown *reason = ts->reason; 48514af1b03aSJed Brown PetscFunctionReturn(0); 48524af1b03aSJed Brown } 48534af1b03aSJed Brown 4854d6ad946cSShri Abhyankar /*@ 4855d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 4856d6ad946cSShri Abhyankar 4857d6ad946cSShri Abhyankar Not Collective 4858d6ad946cSShri Abhyankar 4859d6ad946cSShri Abhyankar Input Parameter: 4860d6ad946cSShri Abhyankar + ts - the TS context 4861d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 4862d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 4863d6ad946cSShri Abhyankar 4864f5abba47SShri Abhyankar Level: advanced 4865d6ad946cSShri Abhyankar 4866d6ad946cSShri Abhyankar Notes: 4867d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 4868d6ad946cSShri Abhyankar 4869d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 4870d6ad946cSShri Abhyankar 4871d6ad946cSShri Abhyankar .seealso: TSConvergedReason 4872d6ad946cSShri Abhyankar @*/ 4873d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 4874d6ad946cSShri Abhyankar { 4875d6ad946cSShri Abhyankar PetscFunctionBegin; 4876d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4877d6ad946cSShri Abhyankar ts->reason = reason; 4878d6ad946cSShri Abhyankar PetscFunctionReturn(0); 4879d6ad946cSShri Abhyankar } 4880d6ad946cSShri Abhyankar 4881cc708dedSBarry Smith /*@ 4882cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 4883cc708dedSBarry Smith 4884cc708dedSBarry Smith Not Collective 4885cc708dedSBarry Smith 4886cc708dedSBarry Smith Input Parameter: 4887cc708dedSBarry Smith . ts - the TS context 4888cc708dedSBarry Smith 4889cc708dedSBarry Smith Output Parameter: 489019eac22cSLisandro Dalcin . ftime - the final time. This time corresponds to the final time set with TSSetMaxTime() 4891cc708dedSBarry Smith 4892487e0bb9SJed Brown Level: beginner 4893cc708dedSBarry Smith 4894cc708dedSBarry Smith Notes: 4895cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 4896cc708dedSBarry Smith 4897cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 4898cc708dedSBarry Smith 4899cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 4900cc708dedSBarry Smith @*/ 4901cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 4902cc708dedSBarry Smith { 4903cc708dedSBarry Smith PetscFunctionBegin; 4904cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4905cc708dedSBarry Smith PetscValidPointer(ftime,2); 4906cc708dedSBarry Smith *ftime = ts->solvetime; 4907cc708dedSBarry Smith PetscFunctionReturn(0); 4908cc708dedSBarry Smith } 4909cc708dedSBarry Smith 49102c18e0fdSBarry Smith /*@ 49115ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 49129f67acb7SJed Brown used by the time integrator. 49139f67acb7SJed Brown 49149f67acb7SJed Brown Not Collective 49159f67acb7SJed Brown 49169f67acb7SJed Brown Input Parameter: 49179f67acb7SJed Brown . ts - TS context 49189f67acb7SJed Brown 49199f67acb7SJed Brown Output Parameter: 49209f67acb7SJed Brown . nits - number of nonlinear iterations 49219f67acb7SJed Brown 49229f67acb7SJed Brown Notes: 49239f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 49249f67acb7SJed Brown 49259f67acb7SJed Brown Level: intermediate 49269f67acb7SJed Brown 49279f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 49289f67acb7SJed Brown 49295ef26d82SJed Brown .seealso: TSGetKSPIterations() 49309f67acb7SJed Brown @*/ 49315ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 49329f67acb7SJed Brown { 49339f67acb7SJed Brown PetscFunctionBegin; 49349f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49359f67acb7SJed Brown PetscValidIntPointer(nits,2); 49365ef26d82SJed Brown *nits = ts->snes_its; 49379f67acb7SJed Brown PetscFunctionReturn(0); 49389f67acb7SJed Brown } 49399f67acb7SJed Brown 49409f67acb7SJed Brown /*@ 49415ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 49429f67acb7SJed Brown used by the time integrator. 49439f67acb7SJed Brown 49449f67acb7SJed Brown Not Collective 49459f67acb7SJed Brown 49469f67acb7SJed Brown Input Parameter: 49479f67acb7SJed Brown . ts - TS context 49489f67acb7SJed Brown 49499f67acb7SJed Brown Output Parameter: 49509f67acb7SJed Brown . lits - number of linear iterations 49519f67acb7SJed Brown 49529f67acb7SJed Brown Notes: 49539f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 49549f67acb7SJed Brown 49559f67acb7SJed Brown Level: intermediate 49569f67acb7SJed Brown 49579f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 49589f67acb7SJed Brown 49595ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 49609f67acb7SJed Brown @*/ 49615ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 49629f67acb7SJed Brown { 49639f67acb7SJed Brown PetscFunctionBegin; 49649f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49659f67acb7SJed Brown PetscValidIntPointer(lits,2); 49665ef26d82SJed Brown *lits = ts->ksp_its; 49679f67acb7SJed Brown PetscFunctionReturn(0); 49689f67acb7SJed Brown } 49699f67acb7SJed Brown 4970cef5090cSJed Brown /*@ 4971cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 4972cef5090cSJed Brown 4973cef5090cSJed Brown Not Collective 4974cef5090cSJed Brown 4975cef5090cSJed Brown Input Parameter: 4976cef5090cSJed Brown . ts - TS context 4977cef5090cSJed Brown 4978cef5090cSJed Brown Output Parameter: 4979cef5090cSJed Brown . rejects - number of steps rejected 4980cef5090cSJed Brown 4981cef5090cSJed Brown Notes: 4982cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 4983cef5090cSJed Brown 4984cef5090cSJed Brown Level: intermediate 4985cef5090cSJed Brown 4986cef5090cSJed Brown .keywords: TS, get, number 4987cef5090cSJed Brown 49885ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 4989cef5090cSJed Brown @*/ 4990cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 4991cef5090cSJed Brown { 4992cef5090cSJed Brown PetscFunctionBegin; 4993cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4994cef5090cSJed Brown PetscValidIntPointer(rejects,2); 4995cef5090cSJed Brown *rejects = ts->reject; 4996cef5090cSJed Brown PetscFunctionReturn(0); 4997cef5090cSJed Brown } 4998cef5090cSJed Brown 4999cef5090cSJed Brown /*@ 5000cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5001cef5090cSJed Brown 5002cef5090cSJed Brown Not Collective 5003cef5090cSJed Brown 5004cef5090cSJed Brown Input Parameter: 5005cef5090cSJed Brown . ts - TS context 5006cef5090cSJed Brown 5007cef5090cSJed Brown Output Parameter: 5008cef5090cSJed Brown . fails - number of failed nonlinear solves 5009cef5090cSJed Brown 5010cef5090cSJed Brown Notes: 5011cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5012cef5090cSJed Brown 5013cef5090cSJed Brown Level: intermediate 5014cef5090cSJed Brown 5015cef5090cSJed Brown .keywords: TS, get, number 5016cef5090cSJed Brown 50175ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5018cef5090cSJed Brown @*/ 5019cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5020cef5090cSJed Brown { 5021cef5090cSJed Brown PetscFunctionBegin; 5022cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5023cef5090cSJed Brown PetscValidIntPointer(fails,2); 5024cef5090cSJed Brown *fails = ts->num_snes_failures; 5025cef5090cSJed Brown PetscFunctionReturn(0); 5026cef5090cSJed Brown } 5027cef5090cSJed Brown 5028cef5090cSJed Brown /*@ 5029cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5030cef5090cSJed Brown 5031cef5090cSJed Brown Not Collective 5032cef5090cSJed Brown 5033cef5090cSJed Brown Input Parameter: 5034cef5090cSJed Brown + ts - TS context 5035cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5036cef5090cSJed Brown 5037cef5090cSJed Brown Notes: 5038cef5090cSJed Brown The counter is reset to zero for each step 5039cef5090cSJed Brown 5040cef5090cSJed Brown Options Database Key: 5041cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5042cef5090cSJed Brown 5043cef5090cSJed Brown Level: intermediate 5044cef5090cSJed Brown 5045cef5090cSJed Brown .keywords: TS, set, maximum, number 5046cef5090cSJed Brown 50475ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5048cef5090cSJed Brown @*/ 5049cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5050cef5090cSJed Brown { 5051cef5090cSJed Brown PetscFunctionBegin; 5052cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5053cef5090cSJed Brown ts->max_reject = rejects; 5054cef5090cSJed Brown PetscFunctionReturn(0); 5055cef5090cSJed Brown } 5056cef5090cSJed Brown 5057cef5090cSJed Brown /*@ 5058cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5059cef5090cSJed Brown 5060cef5090cSJed Brown Not Collective 5061cef5090cSJed Brown 5062cef5090cSJed Brown Input Parameter: 5063cef5090cSJed Brown + ts - TS context 5064cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5065cef5090cSJed Brown 5066cef5090cSJed Brown Notes: 5067cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5068cef5090cSJed Brown 5069cef5090cSJed Brown Options Database Key: 5070cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5071cef5090cSJed Brown 5072cef5090cSJed Brown Level: intermediate 5073cef5090cSJed Brown 5074cef5090cSJed Brown .keywords: TS, set, maximum, number 5075cef5090cSJed Brown 50765ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5077cef5090cSJed Brown @*/ 5078cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5079cef5090cSJed Brown { 5080cef5090cSJed Brown PetscFunctionBegin; 5081cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5082cef5090cSJed Brown ts->max_snes_failures = fails; 5083cef5090cSJed Brown PetscFunctionReturn(0); 5084cef5090cSJed Brown } 5085cef5090cSJed Brown 5086cef5090cSJed Brown /*@ 5087cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5088cef5090cSJed Brown 5089cef5090cSJed Brown Not Collective 5090cef5090cSJed Brown 5091cef5090cSJed Brown Input Parameter: 5092cef5090cSJed Brown + ts - TS context 5093cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5094cef5090cSJed Brown 5095cef5090cSJed Brown Options Database Key: 5096cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5097cef5090cSJed Brown 5098cef5090cSJed Brown Level: intermediate 5099cef5090cSJed Brown 5100cef5090cSJed Brown .keywords: TS, set, error 5101cef5090cSJed Brown 51025ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5103cef5090cSJed Brown @*/ 5104cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5105cef5090cSJed Brown { 5106cef5090cSJed Brown PetscFunctionBegin; 5107cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5108cef5090cSJed Brown ts->errorifstepfailed = err; 5109cef5090cSJed Brown PetscFunctionReturn(0); 5110cef5090cSJed Brown } 5111cef5090cSJed Brown 5112fb1732b5SBarry Smith /*@C 5113fde5950dSBarry 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 5114fb1732b5SBarry Smith 5115fb1732b5SBarry Smith Collective on TS 5116fb1732b5SBarry Smith 5117fb1732b5SBarry Smith Input Parameters: 5118fb1732b5SBarry Smith + ts - the TS context 5119fb1732b5SBarry Smith . step - current time-step 5120fb1732b5SBarry Smith . ptime - current time 51210910c330SBarry Smith . u - current state 5122721cd6eeSBarry Smith - vf - viewer and its format 5123fb1732b5SBarry Smith 5124fb1732b5SBarry Smith Level: intermediate 5125fb1732b5SBarry Smith 5126fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5127fb1732b5SBarry Smith 5128fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5129fb1732b5SBarry Smith @*/ 5130721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5131fb1732b5SBarry Smith { 5132fb1732b5SBarry Smith PetscErrorCode ierr; 5133fb1732b5SBarry Smith 5134fb1732b5SBarry Smith PetscFunctionBegin; 5135721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5136721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5137721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5138ed81e22dSJed Brown PetscFunctionReturn(0); 5139ed81e22dSJed Brown } 5140ed81e22dSJed Brown 5141ed81e22dSJed Brown /*@C 5142ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5143ed81e22dSJed Brown 5144ed81e22dSJed Brown Collective on TS 5145ed81e22dSJed Brown 5146ed81e22dSJed Brown Input Parameters: 5147ed81e22dSJed Brown + ts - the TS context 5148ed81e22dSJed Brown . step - current time-step 5149ed81e22dSJed Brown . ptime - current time 51500910c330SBarry Smith . u - current state 5151ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5152ed81e22dSJed Brown 5153ed81e22dSJed Brown Level: intermediate 5154ed81e22dSJed Brown 5155ed81e22dSJed Brown Notes: 5156ed81e22dSJed 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. 5157ed81e22dSJed Brown These are named according to the file name template. 5158ed81e22dSJed Brown 5159ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5160ed81e22dSJed Brown 5161ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5162ed81e22dSJed Brown 5163ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5164ed81e22dSJed Brown @*/ 51650910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5166ed81e22dSJed Brown { 5167ed81e22dSJed Brown PetscErrorCode ierr; 5168ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5169ed81e22dSJed Brown PetscViewer viewer; 5170ed81e22dSJed Brown 5171ed81e22dSJed Brown PetscFunctionBegin; 517263e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 51738caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5174ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 51750910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5176ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5177ed81e22dSJed Brown PetscFunctionReturn(0); 5178ed81e22dSJed Brown } 5179ed81e22dSJed Brown 5180ed81e22dSJed Brown /*@C 5181ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5182ed81e22dSJed Brown 5183ed81e22dSJed Brown Collective on TS 5184ed81e22dSJed Brown 5185ed81e22dSJed Brown Input Parameters: 5186ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5187ed81e22dSJed Brown 5188ed81e22dSJed Brown Level: intermediate 5189ed81e22dSJed Brown 5190ed81e22dSJed Brown Note: 5191ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5192ed81e22dSJed Brown 5193ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5194ed81e22dSJed Brown 5195ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5196ed81e22dSJed Brown @*/ 5197ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5198ed81e22dSJed Brown { 5199ed81e22dSJed Brown PetscErrorCode ierr; 5200ed81e22dSJed Brown 5201ed81e22dSJed Brown PetscFunctionBegin; 5202ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5203fb1732b5SBarry Smith PetscFunctionReturn(0); 5204fb1732b5SBarry Smith } 5205fb1732b5SBarry Smith 520684df9cb4SJed Brown /*@ 5207552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 520884df9cb4SJed Brown 5209ed81e22dSJed Brown Collective on TS if controller has not been created yet 521084df9cb4SJed Brown 521184df9cb4SJed Brown Input Arguments: 5212ed81e22dSJed Brown . ts - time stepping context 521384df9cb4SJed Brown 521484df9cb4SJed Brown Output Arguments: 5215ed81e22dSJed Brown . adapt - adaptive controller 521684df9cb4SJed Brown 521784df9cb4SJed Brown Level: intermediate 521884df9cb4SJed Brown 5219ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 522084df9cb4SJed Brown @*/ 5221552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 522284df9cb4SJed Brown { 522384df9cb4SJed Brown PetscErrorCode ierr; 522484df9cb4SJed Brown 522584df9cb4SJed Brown PetscFunctionBegin; 522684df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5227bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 522884df9cb4SJed Brown if (!ts->adapt) { 5229ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 52303bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 52311c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 523284df9cb4SJed Brown } 5233bec58848SLisandro Dalcin *adapt = ts->adapt; 523484df9cb4SJed Brown PetscFunctionReturn(0); 523584df9cb4SJed Brown } 5236d6ebe24aSShri Abhyankar 52371c3436cfSJed Brown /*@ 52381c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 52391c3436cfSJed Brown 52401c3436cfSJed Brown Logically Collective 52411c3436cfSJed Brown 52421c3436cfSJed Brown Input Arguments: 52431c3436cfSJed Brown + ts - time integration context 52441c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 52450298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 52461c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 52470298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 52481c3436cfSJed Brown 5249a3cdaa26SBarry Smith Options Database keys: 5250a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5251a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5252a3cdaa26SBarry Smith 52533ff766beSShri Abhyankar Notes: 52543ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 52553ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 52563ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 52573ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 52583ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 52593ff766beSShri Abhyankar differential variables. 52603ff766beSShri Abhyankar 52611c3436cfSJed Brown Level: beginner 52621c3436cfSJed Brown 5263c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 52641c3436cfSJed Brown @*/ 52651c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 52661c3436cfSJed Brown { 52671c3436cfSJed Brown PetscErrorCode ierr; 52681c3436cfSJed Brown 52691c3436cfSJed Brown PetscFunctionBegin; 5270c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 52711c3436cfSJed Brown if (vatol) { 52721c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 52731c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 52741c3436cfSJed Brown ts->vatol = vatol; 52751c3436cfSJed Brown } 5276c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 52771c3436cfSJed Brown if (vrtol) { 52781c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 52791c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 52801c3436cfSJed Brown ts->vrtol = vrtol; 52811c3436cfSJed Brown } 52821c3436cfSJed Brown PetscFunctionReturn(0); 52831c3436cfSJed Brown } 52841c3436cfSJed Brown 5285c5033834SJed Brown /*@ 5286c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5287c5033834SJed Brown 5288c5033834SJed Brown Logically Collective 5289c5033834SJed Brown 5290c5033834SJed Brown Input Arguments: 5291c5033834SJed Brown . ts - time integration context 5292c5033834SJed Brown 5293c5033834SJed Brown Output Arguments: 52940298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 52950298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 52960298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 52970298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5298c5033834SJed Brown 5299c5033834SJed Brown Level: beginner 5300c5033834SJed Brown 5301c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5302c5033834SJed Brown @*/ 5303c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5304c5033834SJed Brown { 5305c5033834SJed Brown PetscFunctionBegin; 5306c5033834SJed Brown if (atol) *atol = ts->atol; 5307c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5308c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5309c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5310c5033834SJed Brown PetscFunctionReturn(0); 5311c5033834SJed Brown } 5312c5033834SJed Brown 53139c6b16b5SShri Abhyankar /*@ 5314a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 53159c6b16b5SShri Abhyankar 53169c6b16b5SShri Abhyankar Collective on TS 53179c6b16b5SShri Abhyankar 53189c6b16b5SShri Abhyankar Input Arguments: 53199c6b16b5SShri Abhyankar + ts - time stepping context 5320a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5321a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 53229c6b16b5SShri Abhyankar 53239c6b16b5SShri Abhyankar Output Arguments: 53247453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 53257453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 53267453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 53279c6b16b5SShri Abhyankar 53289c6b16b5SShri Abhyankar Level: developer 53299c6b16b5SShri Abhyankar 5330deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 53319c6b16b5SShri Abhyankar @*/ 53327453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 53339c6b16b5SShri Abhyankar { 53349c6b16b5SShri Abhyankar PetscErrorCode ierr; 53359c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 53367453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 53377453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 53389c6b16b5SShri Abhyankar const PetscScalar *u,*y; 53397453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 53407453f775SEmil Constantinescu PetscReal tol,tola,tolr; 53417453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 53429c6b16b5SShri Abhyankar 53439c6b16b5SShri Abhyankar PetscFunctionBegin; 53449c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5345a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5346a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5347a4868fbcSLisandro Dalcin PetscValidType(U,2); 5348a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5349a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5350a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 53518a175baeSEmil Constantinescu PetscValidPointer(norma,5); 53528a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5353a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 53549c6b16b5SShri Abhyankar 53559c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 53569c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 53579c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 53589c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 53599c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 53607453f775SEmil Constantinescu sum = 0.; n_loc = 0; 53617453f775SEmil Constantinescu suma = 0.; na_loc = 0; 53627453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 53639c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 53649c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 53659c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53669c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53679c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 53687453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 53697453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 53707453f775SEmil Constantinescu if(tola>0.){ 53717453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 53727453f775SEmil Constantinescu na_loc++; 53737453f775SEmil Constantinescu } 53747453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53757453f775SEmil Constantinescu if(tolr>0.){ 53767453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 53777453f775SEmil Constantinescu nr_loc++; 53787453f775SEmil Constantinescu } 53797453f775SEmil Constantinescu tol=tola+tolr; 53807453f775SEmil Constantinescu if(tol>0.){ 53817453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 53827453f775SEmil Constantinescu n_loc++; 53837453f775SEmil Constantinescu } 53849c6b16b5SShri Abhyankar } 53859c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53869c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 53879c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 53889c6b16b5SShri Abhyankar const PetscScalar *atol; 53899c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 53909c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 53917453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 53927453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 53937453f775SEmil Constantinescu if(tola>0.){ 53947453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 53957453f775SEmil Constantinescu na_loc++; 53967453f775SEmil Constantinescu } 53977453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 53987453f775SEmil Constantinescu if(tolr>0.){ 53997453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 54007453f775SEmil Constantinescu nr_loc++; 54017453f775SEmil Constantinescu } 54027453f775SEmil Constantinescu tol=tola+tolr; 54037453f775SEmil Constantinescu if(tol>0.){ 54047453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 54057453f775SEmil Constantinescu n_loc++; 54067453f775SEmil Constantinescu } 54079c6b16b5SShri Abhyankar } 54089c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 54099c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 54109c6b16b5SShri Abhyankar const PetscScalar *rtol; 54119c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54129c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 54137453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 54147453f775SEmil Constantinescu tola = ts->atol; 54157453f775SEmil Constantinescu if(tola>0.){ 54167453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 54177453f775SEmil Constantinescu na_loc++; 54187453f775SEmil Constantinescu } 54197453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54207453f775SEmil Constantinescu if(tolr>0.){ 54217453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 54227453f775SEmil Constantinescu nr_loc++; 54237453f775SEmil Constantinescu } 54247453f775SEmil Constantinescu tol=tola+tolr; 54257453f775SEmil Constantinescu if(tol>0.){ 54267453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 54277453f775SEmil Constantinescu n_loc++; 54287453f775SEmil Constantinescu } 54299c6b16b5SShri Abhyankar } 54309c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 54319c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 54329c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 54337453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 54347453f775SEmil Constantinescu tola = ts->atol; 54357453f775SEmil Constantinescu if(tola>0.){ 54367453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 54377453f775SEmil Constantinescu na_loc++; 54387453f775SEmil Constantinescu } 54397453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 54407453f775SEmil Constantinescu if(tolr>0.){ 54417453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 54427453f775SEmil Constantinescu nr_loc++; 54437453f775SEmil Constantinescu } 54447453f775SEmil Constantinescu tol=tola+tolr; 54457453f775SEmil Constantinescu if(tol>0.){ 54467453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 54477453f775SEmil Constantinescu n_loc++; 54487453f775SEmil Constantinescu } 54499c6b16b5SShri Abhyankar } 54509c6b16b5SShri Abhyankar } 54519c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 54529c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 54539c6b16b5SShri Abhyankar 54547453f775SEmil Constantinescu err_loc[0] = sum; 54557453f775SEmil Constantinescu err_loc[1] = suma; 54567453f775SEmil Constantinescu err_loc[2] = sumr; 54577453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 54587453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 54597453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 54607453f775SEmil Constantinescu 5461a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 54627453f775SEmil Constantinescu 54637453f775SEmil Constantinescu gsum = err_glb[0]; 54647453f775SEmil Constantinescu gsuma = err_glb[1]; 54657453f775SEmil Constantinescu gsumr = err_glb[2]; 54667453f775SEmil Constantinescu n_glb = err_glb[3]; 54677453f775SEmil Constantinescu na_glb = err_glb[4]; 54687453f775SEmil Constantinescu nr_glb = err_glb[5]; 54697453f775SEmil Constantinescu 5470b1316ef9SEmil Constantinescu *norm = 0.; 5471b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 5472b1316ef9SEmil Constantinescu *norma = 0.; 5473b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5474b1316ef9SEmil Constantinescu *normr = 0.; 5475b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 54769c6b16b5SShri Abhyankar 54779c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 54787453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 54797453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 54809c6b16b5SShri Abhyankar PetscFunctionReturn(0); 54819c6b16b5SShri Abhyankar } 54829c6b16b5SShri Abhyankar 54839c6b16b5SShri Abhyankar /*@ 5484a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 54859c6b16b5SShri Abhyankar 54869c6b16b5SShri Abhyankar Collective on TS 54879c6b16b5SShri Abhyankar 54889c6b16b5SShri Abhyankar Input Arguments: 54899c6b16b5SShri Abhyankar + ts - time stepping context 5490a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5491a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 54929c6b16b5SShri Abhyankar 54939c6b16b5SShri Abhyankar Output Arguments: 54947453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 54957453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 54967453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 54979c6b16b5SShri Abhyankar 54989c6b16b5SShri Abhyankar Level: developer 54999c6b16b5SShri Abhyankar 5500deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 55019c6b16b5SShri Abhyankar @*/ 55027453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 55039c6b16b5SShri Abhyankar { 55049c6b16b5SShri Abhyankar PetscErrorCode ierr; 55057453f775SEmil Constantinescu PetscInt i,n,N,rstart; 55069c6b16b5SShri Abhyankar const PetscScalar *u,*y; 55077453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 55087453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 55097453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 55109c6b16b5SShri Abhyankar 55119c6b16b5SShri Abhyankar PetscFunctionBegin; 55129c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5513a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5514a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5515a4868fbcSLisandro Dalcin PetscValidType(U,2); 5516a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5517a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5518a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 55198a175baeSEmil Constantinescu PetscValidPointer(norma,5); 55208a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5521a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 55229c6b16b5SShri Abhyankar 55239c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 55249c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 55259c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 55269c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 55279c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 55287453f775SEmil Constantinescu 55297453f775SEmil Constantinescu max=0.; 55307453f775SEmil Constantinescu maxa=0.; 55317453f775SEmil Constantinescu maxr=0.; 55327453f775SEmil Constantinescu 55337453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 55349c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 55359c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55369c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55377453f775SEmil Constantinescu 55387453f775SEmil Constantinescu for (i=0; i<n; i++) { 55397453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55407453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 55417453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55427453f775SEmil Constantinescu tol = tola+tolr; 55437453f775SEmil Constantinescu if(tola>0.){ 55447453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 55457453f775SEmil Constantinescu } 55467453f775SEmil Constantinescu if(tolr>0.){ 55477453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 55487453f775SEmil Constantinescu } 55497453f775SEmil Constantinescu if(tol>0.){ 55507453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 55517453f775SEmil Constantinescu } 55529c6b16b5SShri Abhyankar } 55539c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55549c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55559c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 55569c6b16b5SShri Abhyankar const PetscScalar *atol; 55579c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55587453f775SEmil Constantinescu for (i=0; i<n; i++) { 55597453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55607453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 55617453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55627453f775SEmil Constantinescu tol = tola+tolr; 55637453f775SEmil Constantinescu if(tola>0.){ 55647453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 55657453f775SEmil Constantinescu } 55667453f775SEmil Constantinescu if(tolr>0.){ 55677453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 55687453f775SEmil Constantinescu } 55697453f775SEmil Constantinescu if(tol>0.){ 55707453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 55717453f775SEmil Constantinescu } 55729c6b16b5SShri Abhyankar } 55739c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55749c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 55759c6b16b5SShri Abhyankar const PetscScalar *rtol; 55769c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55777453f775SEmil Constantinescu 55787453f775SEmil Constantinescu for (i=0; i<n; i++) { 55797453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55807453f775SEmil Constantinescu tola = ts->atol; 55817453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55827453f775SEmil Constantinescu tol = tola+tolr; 55837453f775SEmil Constantinescu if(tola>0.){ 55847453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 55857453f775SEmil Constantinescu } 55867453f775SEmil Constantinescu if(tolr>0.){ 55877453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 55887453f775SEmil Constantinescu } 55897453f775SEmil Constantinescu if(tol>0.){ 55907453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 55917453f775SEmil Constantinescu } 55929c6b16b5SShri Abhyankar } 55939c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55949c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 55957453f775SEmil Constantinescu 55967453f775SEmil Constantinescu for (i=0; i<n; i++) { 55977453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55987453f775SEmil Constantinescu tola = ts->atol; 55997453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 56007453f775SEmil Constantinescu tol = tola+tolr; 56017453f775SEmil Constantinescu if(tola>0.){ 56027453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 56037453f775SEmil Constantinescu } 56047453f775SEmil Constantinescu if(tolr>0.){ 56057453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 56067453f775SEmil Constantinescu } 56077453f775SEmil Constantinescu if(tol>0.){ 56087453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 56097453f775SEmil Constantinescu } 56109c6b16b5SShri Abhyankar } 56119c6b16b5SShri Abhyankar } 56129c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 56139c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 56147453f775SEmil Constantinescu err_loc[0] = max; 56157453f775SEmil Constantinescu err_loc[1] = maxa; 56167453f775SEmil Constantinescu err_loc[2] = maxr; 5617a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 56187453f775SEmil Constantinescu gmax = err_glb[0]; 56197453f775SEmil Constantinescu gmaxa = err_glb[1]; 56207453f775SEmil Constantinescu gmaxr = err_glb[2]; 56219c6b16b5SShri Abhyankar 56229c6b16b5SShri Abhyankar *norm = gmax; 56237453f775SEmil Constantinescu *norma = gmaxa; 56247453f775SEmil Constantinescu *normr = gmaxr; 56259c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 56267453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 56277453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 56289c6b16b5SShri Abhyankar PetscFunctionReturn(0); 56299c6b16b5SShri Abhyankar } 56309c6b16b5SShri Abhyankar 56311c3436cfSJed Brown /*@ 56328a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 56331c3436cfSJed Brown 56341c3436cfSJed Brown Collective on TS 56351c3436cfSJed Brown 56361c3436cfSJed Brown Input Arguments: 56371c3436cfSJed Brown + ts - time stepping context 5638a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5639a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 5640a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 56417619abb3SShri 56421c3436cfSJed Brown Output Arguments: 56438a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 56448a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 56458a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 5646a4868fbcSLisandro Dalcin 5647a4868fbcSLisandro Dalcin Options Database Keys: 5648a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5649a4868fbcSLisandro Dalcin 56501c3436cfSJed Brown Level: developer 56511c3436cfSJed Brown 56528a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 56531c3436cfSJed Brown @*/ 56547453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 56551c3436cfSJed Brown { 56568beabaa1SBarry Smith PetscErrorCode ierr; 56571c3436cfSJed Brown 56581c3436cfSJed Brown PetscFunctionBegin; 5659a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 56607453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5661a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 56627453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5663a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 56641c3436cfSJed Brown PetscFunctionReturn(0); 56651c3436cfSJed Brown } 56661c3436cfSJed Brown 56678a175baeSEmil Constantinescu 56688a175baeSEmil Constantinescu /*@ 56698a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 56708a175baeSEmil Constantinescu 56718a175baeSEmil Constantinescu Collective on TS 56728a175baeSEmil Constantinescu 56738a175baeSEmil Constantinescu Input Arguments: 56748a175baeSEmil Constantinescu + ts - time stepping context 56758a175baeSEmil Constantinescu . E - error vector 56768a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 56778a175baeSEmil Constantinescu - Y - state vector, previous time step 56788a175baeSEmil Constantinescu 56798a175baeSEmil Constantinescu Output Arguments: 56808a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 56818a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 56828a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 56838a175baeSEmil Constantinescu 56848a175baeSEmil Constantinescu Level: developer 56858a175baeSEmil Constantinescu 56868a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 56878a175baeSEmil Constantinescu @*/ 56888a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 56898a175baeSEmil Constantinescu { 56908a175baeSEmil Constantinescu PetscErrorCode ierr; 56918a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 56928a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 56938a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 56948a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 56958a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 56968a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 56978a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 56988a175baeSEmil Constantinescu 56998a175baeSEmil Constantinescu PetscFunctionBegin; 57008a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 57018a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 57028a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 57038a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 57048a175baeSEmil Constantinescu PetscValidType(E,2); 57058a175baeSEmil Constantinescu PetscValidType(U,3); 57068a175baeSEmil Constantinescu PetscValidType(Y,4); 57078a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 57088a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 57098a175baeSEmil Constantinescu PetscValidPointer(norm,5); 57108a175baeSEmil Constantinescu PetscValidPointer(norma,6); 57118a175baeSEmil Constantinescu PetscValidPointer(normr,7); 57128a175baeSEmil Constantinescu 57138a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 57148a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 57158a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 57168a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 57178a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 57188a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 57198a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 57208a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 57218a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 57228a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 57238a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 57248a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57258a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57268a175baeSEmil Constantinescu for (i=0; i<n; i++) { 57278a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 57288a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 57298a175baeSEmil Constantinescu if(tola>0.){ 57308a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 57318a175baeSEmil Constantinescu na_loc++; 57328a175baeSEmil Constantinescu } 57338a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57348a175baeSEmil Constantinescu if(tolr>0.){ 57358a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 57368a175baeSEmil Constantinescu nr_loc++; 57378a175baeSEmil Constantinescu } 57388a175baeSEmil Constantinescu tol=tola+tolr; 57398a175baeSEmil Constantinescu if(tol>0.){ 57408a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 57418a175baeSEmil Constantinescu n_loc++; 57428a175baeSEmil Constantinescu } 57438a175baeSEmil Constantinescu } 57448a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57458a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57468a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 57478a175baeSEmil Constantinescu const PetscScalar *atol; 57488a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57498a175baeSEmil Constantinescu for (i=0; i<n; i++) { 57508a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 57518a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 57528a175baeSEmil Constantinescu if(tola>0.){ 57538a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 57548a175baeSEmil Constantinescu na_loc++; 57558a175baeSEmil Constantinescu } 57568a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57578a175baeSEmil Constantinescu if(tolr>0.){ 57588a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 57598a175baeSEmil Constantinescu nr_loc++; 57608a175baeSEmil Constantinescu } 57618a175baeSEmil Constantinescu tol=tola+tolr; 57628a175baeSEmil Constantinescu if(tol>0.){ 57638a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 57648a175baeSEmil Constantinescu n_loc++; 57658a175baeSEmil Constantinescu } 57668a175baeSEmil Constantinescu } 57678a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57688a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 57698a175baeSEmil Constantinescu const PetscScalar *rtol; 57708a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57718a175baeSEmil Constantinescu for (i=0; i<n; i++) { 57728a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 57738a175baeSEmil Constantinescu tola = ts->atol; 57748a175baeSEmil Constantinescu if(tola>0.){ 57758a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 57768a175baeSEmil Constantinescu na_loc++; 57778a175baeSEmil Constantinescu } 57788a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57798a175baeSEmil Constantinescu if(tolr>0.){ 57808a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 57818a175baeSEmil Constantinescu nr_loc++; 57828a175baeSEmil Constantinescu } 57838a175baeSEmil Constantinescu tol=tola+tolr; 57848a175baeSEmil Constantinescu if(tol>0.){ 57858a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 57868a175baeSEmil Constantinescu n_loc++; 57878a175baeSEmil Constantinescu } 57888a175baeSEmil Constantinescu } 57898a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57908a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 57918a175baeSEmil Constantinescu for (i=0; i<n; i++) { 57928a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 57938a175baeSEmil Constantinescu tola = ts->atol; 57948a175baeSEmil Constantinescu if(tola>0.){ 57958a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 57968a175baeSEmil Constantinescu na_loc++; 57978a175baeSEmil Constantinescu } 57988a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57998a175baeSEmil Constantinescu if(tolr>0.){ 58008a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 58018a175baeSEmil Constantinescu nr_loc++; 58028a175baeSEmil Constantinescu } 58038a175baeSEmil Constantinescu tol=tola+tolr; 58048a175baeSEmil Constantinescu if(tol>0.){ 58058a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 58068a175baeSEmil Constantinescu n_loc++; 58078a175baeSEmil Constantinescu } 58088a175baeSEmil Constantinescu } 58098a175baeSEmil Constantinescu } 58108a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 58118a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 58128a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 58138a175baeSEmil Constantinescu 58148a175baeSEmil Constantinescu err_loc[0] = sum; 58158a175baeSEmil Constantinescu err_loc[1] = suma; 58168a175baeSEmil Constantinescu err_loc[2] = sumr; 58178a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 58188a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 58198a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 58208a175baeSEmil Constantinescu 5821a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 58228a175baeSEmil Constantinescu 58238a175baeSEmil Constantinescu gsum = err_glb[0]; 58248a175baeSEmil Constantinescu gsuma = err_glb[1]; 58258a175baeSEmil Constantinescu gsumr = err_glb[2]; 58268a175baeSEmil Constantinescu n_glb = err_glb[3]; 58278a175baeSEmil Constantinescu na_glb = err_glb[4]; 58288a175baeSEmil Constantinescu nr_glb = err_glb[5]; 58298a175baeSEmil Constantinescu 58308a175baeSEmil Constantinescu *norm = 0.; 58318a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 58328a175baeSEmil Constantinescu *norma = 0.; 58338a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 58348a175baeSEmil Constantinescu *normr = 0.; 58358a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 58368a175baeSEmil Constantinescu 58378a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 58388a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 58398a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 58408a175baeSEmil Constantinescu PetscFunctionReturn(0); 58418a175baeSEmil Constantinescu } 58428a175baeSEmil Constantinescu 58438a175baeSEmil Constantinescu /*@ 58448a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 58458a175baeSEmil Constantinescu Collective on TS 58468a175baeSEmil Constantinescu 58478a175baeSEmil Constantinescu Input Arguments: 58488a175baeSEmil Constantinescu + ts - time stepping context 58498a175baeSEmil Constantinescu . E - error vector 58508a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 58518a175baeSEmil Constantinescu - Y - state vector, previous time step 58528a175baeSEmil Constantinescu 58538a175baeSEmil Constantinescu Output Arguments: 58548a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58558a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 58568a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58578a175baeSEmil Constantinescu 58588a175baeSEmil Constantinescu Level: developer 58598a175baeSEmil Constantinescu 58608a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 58618a175baeSEmil Constantinescu @*/ 58628a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58638a175baeSEmil Constantinescu { 58648a175baeSEmil Constantinescu PetscErrorCode ierr; 58658a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 58668a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 58678a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 58688a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 58698a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 58708a175baeSEmil Constantinescu 58718a175baeSEmil Constantinescu PetscFunctionBegin; 58728a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 58738a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 58748a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 58758a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 58768a175baeSEmil Constantinescu PetscValidType(E,2); 58778a175baeSEmil Constantinescu PetscValidType(U,3); 58788a175baeSEmil Constantinescu PetscValidType(Y,4); 58798a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 58808a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 58818a175baeSEmil Constantinescu PetscValidPointer(norm,5); 58828a175baeSEmil Constantinescu PetscValidPointer(norma,6); 58838a175baeSEmil Constantinescu PetscValidPointer(normr,7); 58848a175baeSEmil Constantinescu 58858a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 58868a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 58878a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 58888a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 58898a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 58908a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 58918a175baeSEmil Constantinescu 58928a175baeSEmil Constantinescu max=0.; 58938a175baeSEmil Constantinescu maxa=0.; 58948a175baeSEmil Constantinescu maxr=0.; 58958a175baeSEmil Constantinescu 58968a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 58978a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 58988a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58998a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59008a175baeSEmil Constantinescu 59018a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59028a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59038a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 59048a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59058a175baeSEmil Constantinescu tol = tola+tolr; 59068a175baeSEmil Constantinescu if(tola>0.){ 59078a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 59088a175baeSEmil Constantinescu } 59098a175baeSEmil Constantinescu if(tolr>0.){ 59108a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 59118a175baeSEmil Constantinescu } 59128a175baeSEmil Constantinescu if(tol>0.){ 59138a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 59148a175baeSEmil Constantinescu } 59158a175baeSEmil Constantinescu } 59168a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59178a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59188a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 59198a175baeSEmil Constantinescu const PetscScalar *atol; 59208a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59218a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59228a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59238a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 59248a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59258a175baeSEmil Constantinescu tol = tola+tolr; 59268a175baeSEmil Constantinescu if(tola>0.){ 59278a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 59288a175baeSEmil Constantinescu } 59298a175baeSEmil Constantinescu if(tolr>0.){ 59308a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 59318a175baeSEmil Constantinescu } 59328a175baeSEmil Constantinescu if(tol>0.){ 59338a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 59348a175baeSEmil Constantinescu } 59358a175baeSEmil Constantinescu } 59368a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59378a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 59388a175baeSEmil Constantinescu const PetscScalar *rtol; 59398a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59408a175baeSEmil Constantinescu 59418a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59428a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59438a175baeSEmil Constantinescu tola = ts->atol; 59448a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59458a175baeSEmil Constantinescu tol = tola+tolr; 59468a175baeSEmil Constantinescu if(tola>0.){ 59478a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 59488a175baeSEmil Constantinescu } 59498a175baeSEmil Constantinescu if(tolr>0.){ 59508a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 59518a175baeSEmil Constantinescu } 59528a175baeSEmil Constantinescu if(tol>0.){ 59538a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 59548a175baeSEmil Constantinescu } 59558a175baeSEmil Constantinescu } 59568a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59578a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 59588a175baeSEmil Constantinescu 59598a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59608a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59618a175baeSEmil Constantinescu tola = ts->atol; 59628a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59638a175baeSEmil Constantinescu tol = tola+tolr; 59648a175baeSEmil Constantinescu if(tola>0.){ 59658a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 59668a175baeSEmil Constantinescu } 59678a175baeSEmil Constantinescu if(tolr>0.){ 59688a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 59698a175baeSEmil Constantinescu } 59708a175baeSEmil Constantinescu if(tol>0.){ 59718a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 59728a175baeSEmil Constantinescu } 59738a175baeSEmil Constantinescu } 59748a175baeSEmil Constantinescu } 59758a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 59768a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 59778a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 59788a175baeSEmil Constantinescu err_loc[0] = max; 59798a175baeSEmil Constantinescu err_loc[1] = maxa; 59808a175baeSEmil Constantinescu err_loc[2] = maxr; 5981a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 59828a175baeSEmil Constantinescu gmax = err_glb[0]; 59838a175baeSEmil Constantinescu gmaxa = err_glb[1]; 59848a175baeSEmil Constantinescu gmaxr = err_glb[2]; 59858a175baeSEmil Constantinescu 59868a175baeSEmil Constantinescu *norm = gmax; 59878a175baeSEmil Constantinescu *norma = gmaxa; 59888a175baeSEmil Constantinescu *normr = gmaxr; 59898a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 59908a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 59918a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 59928a175baeSEmil Constantinescu PetscFunctionReturn(0); 59938a175baeSEmil Constantinescu } 59948a175baeSEmil Constantinescu 59958a175baeSEmil Constantinescu /*@ 59968a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 59978a175baeSEmil Constantinescu 59988a175baeSEmil Constantinescu Collective on TS 59998a175baeSEmil Constantinescu 60008a175baeSEmil Constantinescu Input Arguments: 60018a175baeSEmil Constantinescu + ts - time stepping context 60028a175baeSEmil Constantinescu . E - error vector 60038a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 60048a175baeSEmil Constantinescu . Y - state vector, previous time step 60058a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 60068a175baeSEmil Constantinescu 60078a175baeSEmil Constantinescu Output Arguments: 60088a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 60098a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 60108a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 60118a175baeSEmil Constantinescu 60128a175baeSEmil Constantinescu Options Database Keys: 60138a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 60148a175baeSEmil Constantinescu 60158a175baeSEmil Constantinescu Level: developer 60168a175baeSEmil Constantinescu 60178a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 60188a175baeSEmil Constantinescu @*/ 60198a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60208a175baeSEmil Constantinescu { 60218a175baeSEmil Constantinescu PetscErrorCode ierr; 60228a175baeSEmil Constantinescu 60238a175baeSEmil Constantinescu PetscFunctionBegin; 60248a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 60258a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 60268a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 60278a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 60288a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 60298a175baeSEmil Constantinescu PetscFunctionReturn(0); 60308a175baeSEmil Constantinescu } 60318a175baeSEmil Constantinescu 60328a175baeSEmil Constantinescu 60338d59e960SJed Brown /*@ 60348d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 60358d59e960SJed Brown 60368d59e960SJed Brown Logically Collective on TS 60378d59e960SJed Brown 60388d59e960SJed Brown Input Arguments: 60398d59e960SJed Brown + ts - time stepping context 60408d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 60418d59e960SJed Brown 60428d59e960SJed Brown Note: 60438d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 60448d59e960SJed Brown 60458d59e960SJed Brown Level: intermediate 60468d59e960SJed Brown 60478d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 60488d59e960SJed Brown @*/ 60498d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 60508d59e960SJed Brown { 60518d59e960SJed Brown PetscFunctionBegin; 60528d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 60538d59e960SJed Brown ts->cfltime_local = cfltime; 60548d59e960SJed Brown ts->cfltime = -1.; 60558d59e960SJed Brown PetscFunctionReturn(0); 60568d59e960SJed Brown } 60578d59e960SJed Brown 60588d59e960SJed Brown /*@ 60598d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 60608d59e960SJed Brown 60618d59e960SJed Brown Collective on TS 60628d59e960SJed Brown 60638d59e960SJed Brown Input Arguments: 60648d59e960SJed Brown . ts - time stepping context 60658d59e960SJed Brown 60668d59e960SJed Brown Output Arguments: 60678d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 60688d59e960SJed Brown 60698d59e960SJed Brown Level: advanced 60708d59e960SJed Brown 60718d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 60728d59e960SJed Brown @*/ 60738d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 60748d59e960SJed Brown { 60758d59e960SJed Brown PetscErrorCode ierr; 60768d59e960SJed Brown 60778d59e960SJed Brown PetscFunctionBegin; 60788d59e960SJed Brown if (ts->cfltime < 0) { 6079b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 60808d59e960SJed Brown } 60818d59e960SJed Brown *cfltime = ts->cfltime; 60828d59e960SJed Brown PetscFunctionReturn(0); 60838d59e960SJed Brown } 60848d59e960SJed Brown 6085d6ebe24aSShri Abhyankar /*@ 6086d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6087d6ebe24aSShri Abhyankar 6088d6ebe24aSShri Abhyankar Input Parameters: 6089d6ebe24aSShri Abhyankar . ts - the TS context. 6090d6ebe24aSShri Abhyankar . xl - lower bound. 6091d6ebe24aSShri Abhyankar . xu - upper bound. 6092d6ebe24aSShri Abhyankar 6093d6ebe24aSShri Abhyankar Notes: 6094d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6095e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6096d6ebe24aSShri Abhyankar 60972bd2b0e6SSatish Balay Level: advanced 60982bd2b0e6SSatish Balay 6099d6ebe24aSShri Abhyankar @*/ 6100d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6101d6ebe24aSShri Abhyankar { 6102d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6103d6ebe24aSShri Abhyankar SNES snes; 6104d6ebe24aSShri Abhyankar 6105d6ebe24aSShri Abhyankar PetscFunctionBegin; 6106d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6107d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6108d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6109d6ebe24aSShri Abhyankar } 6110d6ebe24aSShri Abhyankar 6111325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6112c6db04a5SJed Brown #include <mex.h> 6113325fc9f4SBarry Smith 6114325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6115325fc9f4SBarry Smith 6116325fc9f4SBarry Smith /* 6117325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6118325fc9f4SBarry Smith TSSetFunctionMatlab(). 6119325fc9f4SBarry Smith 6120325fc9f4SBarry Smith Collective on TS 6121325fc9f4SBarry Smith 6122325fc9f4SBarry Smith Input Parameters: 6123325fc9f4SBarry Smith + snes - the TS context 61240910c330SBarry Smith - u - input vector 6125325fc9f4SBarry Smith 6126325fc9f4SBarry Smith Output Parameter: 6127325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6128325fc9f4SBarry Smith 6129325fc9f4SBarry Smith Notes: 6130325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6131325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6132325fc9f4SBarry Smith themselves. 6133325fc9f4SBarry Smith 6134325fc9f4SBarry Smith Level: developer 6135325fc9f4SBarry Smith 6136325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6137325fc9f4SBarry Smith 6138325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6139325fc9f4SBarry Smith */ 61400910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6141325fc9f4SBarry Smith { 6142325fc9f4SBarry Smith PetscErrorCode ierr; 6143325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6144325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6145325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6146325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6147325fc9f4SBarry Smith 6148325fc9f4SBarry Smith PetscFunctionBegin; 6149325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 61500910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 61510910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6152325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 61530910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6154325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6155325fc9f4SBarry Smith 6156325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 61570910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 61580910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 61590910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6160bbd56ea5SKarl Rupp 6161325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6162325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6163325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6164325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6165325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6166325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6167325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6168325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6169325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6170325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6171325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6172325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6173325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6174325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6175325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6176325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6177325fc9f4SBarry Smith PetscFunctionReturn(0); 6178325fc9f4SBarry Smith } 6179325fc9f4SBarry Smith 6180325fc9f4SBarry Smith /* 6181325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6182325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6183e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6184325fc9f4SBarry Smith 6185325fc9f4SBarry Smith Logically Collective on TS 6186325fc9f4SBarry Smith 6187325fc9f4SBarry Smith Input Parameters: 6188325fc9f4SBarry Smith + ts - the TS context 6189325fc9f4SBarry Smith - func - function evaluation routine 6190325fc9f4SBarry Smith 6191325fc9f4SBarry Smith Calling sequence of func: 61920910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6193325fc9f4SBarry Smith 6194325fc9f4SBarry Smith Level: beginner 6195325fc9f4SBarry Smith 6196325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6197325fc9f4SBarry Smith 6198325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6199325fc9f4SBarry Smith */ 6200cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6201325fc9f4SBarry Smith { 6202325fc9f4SBarry Smith PetscErrorCode ierr; 6203325fc9f4SBarry Smith TSMatlabContext *sctx; 6204325fc9f4SBarry Smith 6205325fc9f4SBarry Smith PetscFunctionBegin; 6206325fc9f4SBarry Smith /* currently sctx is memory bleed */ 620795dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6208325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6209325fc9f4SBarry Smith /* 6210325fc9f4SBarry Smith This should work, but it doesn't 6211325fc9f4SBarry Smith sctx->ctx = ctx; 6212325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6213325fc9f4SBarry Smith */ 6214325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6215bbd56ea5SKarl Rupp 62160298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6217325fc9f4SBarry Smith PetscFunctionReturn(0); 6218325fc9f4SBarry Smith } 6219325fc9f4SBarry Smith 6220325fc9f4SBarry Smith /* 6221325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6222325fc9f4SBarry Smith TSSetJacobianMatlab(). 6223325fc9f4SBarry Smith 6224325fc9f4SBarry Smith Collective on TS 6225325fc9f4SBarry Smith 6226325fc9f4SBarry Smith Input Parameters: 6227cdcf91faSSean Farley + ts - the TS context 62280910c330SBarry Smith . u - input vector 6229325fc9f4SBarry Smith . A, B - the matrices 6230325fc9f4SBarry Smith - ctx - user context 6231325fc9f4SBarry Smith 6232325fc9f4SBarry Smith Level: developer 6233325fc9f4SBarry Smith 6234325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6235325fc9f4SBarry Smith 6236325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6237325fc9f4SBarry Smith @*/ 6238f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6239325fc9f4SBarry Smith { 6240325fc9f4SBarry Smith PetscErrorCode ierr; 6241325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6242325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6243325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6244325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6245325fc9f4SBarry Smith 6246325fc9f4SBarry Smith PetscFunctionBegin; 6247cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62480910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6249325fc9f4SBarry Smith 62500910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6251325fc9f4SBarry Smith 6252cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 62530910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 62540910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 62550910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 62560910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6257bbd56ea5SKarl Rupp 6258325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6259325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6260325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6261325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6262325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6263325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6264325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6265325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6266325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6267325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6268325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6269325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6270325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6271325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6272325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6273325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6274325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6275325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6276325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6277325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6278325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6279325fc9f4SBarry Smith PetscFunctionReturn(0); 6280325fc9f4SBarry Smith } 6281325fc9f4SBarry Smith 6282325fc9f4SBarry Smith /* 6283325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6284e3c5b3baSBarry 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 6285325fc9f4SBarry Smith 6286325fc9f4SBarry Smith Logically Collective on TS 6287325fc9f4SBarry Smith 6288325fc9f4SBarry Smith Input Parameters: 6289cdcf91faSSean Farley + ts - the TS context 6290325fc9f4SBarry Smith . A,B - Jacobian matrices 6291325fc9f4SBarry Smith . func - function evaluation routine 6292325fc9f4SBarry Smith - ctx - user context 6293325fc9f4SBarry Smith 6294325fc9f4SBarry Smith Calling sequence of func: 62950910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6296325fc9f4SBarry Smith 6297325fc9f4SBarry Smith Level: developer 6298325fc9f4SBarry Smith 6299325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6300325fc9f4SBarry Smith 6301325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6302325fc9f4SBarry Smith */ 6303cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6304325fc9f4SBarry Smith { 6305325fc9f4SBarry Smith PetscErrorCode ierr; 6306325fc9f4SBarry Smith TSMatlabContext *sctx; 6307325fc9f4SBarry Smith 6308325fc9f4SBarry Smith PetscFunctionBegin; 6309325fc9f4SBarry Smith /* currently sctx is memory bleed */ 631095dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6311325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6312325fc9f4SBarry Smith /* 6313325fc9f4SBarry Smith This should work, but it doesn't 6314325fc9f4SBarry Smith sctx->ctx = ctx; 6315325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6316325fc9f4SBarry Smith */ 6317325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6318bbd56ea5SKarl Rupp 6319cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6320325fc9f4SBarry Smith PetscFunctionReturn(0); 6321325fc9f4SBarry Smith } 6322325fc9f4SBarry Smith 6323b5b1a830SBarry Smith /* 6324b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6325b5b1a830SBarry Smith 6326b5b1a830SBarry Smith Collective on TS 6327b5b1a830SBarry Smith 6328b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6329b5b1a830SBarry Smith @*/ 63300910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6331b5b1a830SBarry Smith { 6332b5b1a830SBarry Smith PetscErrorCode ierr; 6333b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6334a530c242SBarry Smith int nlhs = 1,nrhs = 6; 6335b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 6336b5b1a830SBarry Smith long long int lx = 0,ls = 0; 6337b5b1a830SBarry Smith 6338b5b1a830SBarry Smith PetscFunctionBegin; 6339cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 63400910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6341b5b1a830SBarry Smith 6342cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 63430910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6344bbd56ea5SKarl Rupp 6345b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6346b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 6347b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 6348b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 6349b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 6350b5b1a830SBarry Smith prhs[5] = sctx->ctx; 6351b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6352b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6353b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 6354b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 6355b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 6356b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 6357b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 6358b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 6359b5b1a830SBarry Smith PetscFunctionReturn(0); 6360b5b1a830SBarry Smith } 6361b5b1a830SBarry Smith 6362b5b1a830SBarry Smith /* 6363b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 6364b5b1a830SBarry Smith 6365b5b1a830SBarry Smith Level: developer 6366b5b1a830SBarry Smith 6367b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 6368b5b1a830SBarry Smith 6369b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6370b5b1a830SBarry Smith */ 6371cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6372b5b1a830SBarry Smith { 6373b5b1a830SBarry Smith PetscErrorCode ierr; 6374b5b1a830SBarry Smith TSMatlabContext *sctx; 6375b5b1a830SBarry Smith 6376b5b1a830SBarry Smith PetscFunctionBegin; 6377b5b1a830SBarry Smith /* currently sctx is memory bleed */ 637895dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6379b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6380b5b1a830SBarry Smith /* 6381b5b1a830SBarry Smith This should work, but it doesn't 6382b5b1a830SBarry Smith sctx->ctx = ctx; 6383b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6384b5b1a830SBarry Smith */ 6385b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6386bbd56ea5SKarl Rupp 63870298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6388b5b1a830SBarry Smith PetscFunctionReturn(0); 6389b5b1a830SBarry Smith } 6390325fc9f4SBarry Smith #endif 6391b3603a34SBarry Smith 6392b3603a34SBarry Smith /*@C 63934f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6394b3603a34SBarry Smith in a time based line graph 6395b3603a34SBarry Smith 6396b3603a34SBarry Smith Collective on TS 6397b3603a34SBarry Smith 6398b3603a34SBarry Smith Input Parameters: 6399b3603a34SBarry Smith + ts - the TS context 6400b3603a34SBarry Smith . step - current time-step 6401b3603a34SBarry Smith . ptime - current time 64027db568b7SBarry Smith . u - current solution 64037db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6404b3603a34SBarry Smith 6405b3d3934dSBarry Smith Options Database: 64069ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6407b3d3934dSBarry Smith 6408b3603a34SBarry Smith Level: intermediate 6409b3603a34SBarry Smith 641095452b02SPatrick Sanan Notes: 641195452b02SPatrick Sanan Each process in a parallel run displays its component solutions in a separate window 6412b3603a34SBarry Smith 6413b3603a34SBarry Smith .keywords: TS, vector, monitor, view 6414b3603a34SBarry Smith 64157db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 64167db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 64177db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 64187db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6419b3603a34SBarry Smith @*/ 64207db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6421b3603a34SBarry Smith { 6422b3603a34SBarry Smith PetscErrorCode ierr; 64237db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6424b3603a34SBarry Smith const PetscScalar *yy; 642580666b62SBarry Smith Vec v; 6426b3603a34SBarry Smith 6427b3603a34SBarry Smith PetscFunctionBegin; 642863e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 642958ff32f7SBarry Smith if (!step) { 6430a9f9c1f6SBarry Smith PetscDrawAxis axis; 64316934998bSLisandro Dalcin PetscInt dim; 6432a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6433a9f9c1f6SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6434bab0a581SBarry Smith if (!ctx->names) { 6435bab0a581SBarry Smith PetscBool flg; 6436bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6437bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6438bab0a581SBarry Smith if (flg) { 6439bab0a581SBarry Smith PetscInt i,n; 6440bab0a581SBarry Smith char **names; 6441bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6442bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6443bab0a581SBarry Smith for (i=0; i<n; i++) { 6444bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6445bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6446bab0a581SBarry Smith } 6447bab0a581SBarry Smith names[n] = NULL; 6448bab0a581SBarry Smith ctx->names = names; 6449bab0a581SBarry Smith } 6450bab0a581SBarry Smith } 6451387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6452387f4636SBarry Smith char **displaynames; 6453387f4636SBarry Smith PetscBool flg; 6454387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 645595dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6456387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6457c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6458387f4636SBarry Smith if (flg) { 6459a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6460387f4636SBarry Smith } 6461387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6462387f4636SBarry Smith } 6463387f4636SBarry Smith if (ctx->displaynames) { 6464387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6465387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6466387f4636SBarry Smith } else if (ctx->names) { 64670910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 64680b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6469387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6470b0bc92c6SBarry Smith } else { 6471b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6472b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6473387f4636SBarry Smith } 64740b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 647558ff32f7SBarry Smith } 64766934998bSLisandro Dalcin 64776934998bSLisandro Dalcin if (!ctx->transform) v = u; 64786934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 647980666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 64806934998bSLisandro Dalcin if (ctx->displaynames) { 64816934998bSLisandro Dalcin PetscInt i; 64826934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 64836934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 64846934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 64856934998bSLisandro Dalcin } else { 6486e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6487e3efe391SJed Brown PetscInt i,n; 64886934998bSLisandro Dalcin PetscReal *yreal; 648980666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6490785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6491e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 64920b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6493e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6494e3efe391SJed Brown #else 64950b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6496e3efe391SJed Brown #endif 649780666b62SBarry Smith } 64986934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 64996934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 65006934998bSLisandro Dalcin 6501b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 65020b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 65036934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 65043923b477SBarry Smith } 6505b3603a34SBarry Smith PetscFunctionReturn(0); 6506b3603a34SBarry Smith } 6507b3603a34SBarry Smith 6508b037adc7SBarry Smith /*@C 650931152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6510b037adc7SBarry Smith 6511b037adc7SBarry Smith Collective on TS 6512b037adc7SBarry Smith 6513b037adc7SBarry Smith Input Parameters: 6514b037adc7SBarry Smith + ts - the TS context 6515b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 6516b037adc7SBarry Smith 6517b037adc7SBarry Smith Level: intermediate 6518b037adc7SBarry Smith 651995452b02SPatrick Sanan Notes: 652095452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 65217db568b7SBarry Smith 6522b037adc7SBarry Smith .keywords: TS, vector, monitor, view 6523b037adc7SBarry Smith 6524a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 6525b037adc7SBarry Smith @*/ 652631152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 6527b037adc7SBarry Smith { 6528b037adc7SBarry Smith PetscErrorCode ierr; 6529b037adc7SBarry Smith PetscInt i; 6530b037adc7SBarry Smith 6531b037adc7SBarry Smith PetscFunctionBegin; 6532b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6533b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 65345537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 6535b3d3934dSBarry Smith break; 6536b3d3934dSBarry Smith } 6537b3d3934dSBarry Smith } 6538b3d3934dSBarry Smith PetscFunctionReturn(0); 6539b3d3934dSBarry Smith } 6540b3d3934dSBarry Smith 6541e673d494SBarry Smith /*@C 6542e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6543e673d494SBarry Smith 6544e673d494SBarry Smith Collective on TS 6545e673d494SBarry Smith 6546e673d494SBarry Smith Input Parameters: 6547e673d494SBarry Smith + ts - the TS context 6548e673d494SBarry Smith - names - the names of the components, final string must be NULL 6549e673d494SBarry Smith 6550e673d494SBarry Smith Level: intermediate 6551e673d494SBarry Smith 6552e673d494SBarry Smith .keywords: TS, vector, monitor, view 6553e673d494SBarry Smith 6554a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 6555e673d494SBarry Smith @*/ 6556e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 6557e673d494SBarry Smith { 6558e673d494SBarry Smith PetscErrorCode ierr; 6559e673d494SBarry Smith 6560e673d494SBarry Smith PetscFunctionBegin; 6561e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 6562e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 6563e673d494SBarry Smith PetscFunctionReturn(0); 6564e673d494SBarry Smith } 6565e673d494SBarry Smith 6566b3d3934dSBarry Smith /*@C 6567b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 6568b3d3934dSBarry Smith 6569b3d3934dSBarry Smith Collective on TS 6570b3d3934dSBarry Smith 6571b3d3934dSBarry Smith Input Parameter: 6572b3d3934dSBarry Smith . ts - the TS context 6573b3d3934dSBarry Smith 6574b3d3934dSBarry Smith Output Parameter: 6575b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 6576b3d3934dSBarry Smith 6577b3d3934dSBarry Smith Level: intermediate 6578b3d3934dSBarry Smith 657995452b02SPatrick Sanan Notes: 658095452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 65817db568b7SBarry Smith 6582b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 6583b3d3934dSBarry Smith 6584b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6585b3d3934dSBarry Smith @*/ 6586b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 6587b3d3934dSBarry Smith { 6588b3d3934dSBarry Smith PetscInt i; 6589b3d3934dSBarry Smith 6590b3d3934dSBarry Smith PetscFunctionBegin; 6591b3d3934dSBarry Smith *names = NULL; 6592b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6593b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 65945537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 6595b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 6596b3d3934dSBarry Smith break; 6597387f4636SBarry Smith } 6598387f4636SBarry Smith } 6599387f4636SBarry Smith PetscFunctionReturn(0); 6600387f4636SBarry Smith } 6601387f4636SBarry Smith 6602a66092f1SBarry Smith /*@C 6603a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 6604a66092f1SBarry Smith 6605a66092f1SBarry Smith Collective on TS 6606a66092f1SBarry Smith 6607a66092f1SBarry Smith Input Parameters: 6608a66092f1SBarry Smith + ctx - the TSMonitorLG context 6609a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 6610a66092f1SBarry Smith 6611a66092f1SBarry Smith Level: intermediate 6612a66092f1SBarry Smith 6613a66092f1SBarry Smith .keywords: TS, vector, monitor, view 6614a66092f1SBarry Smith 6615a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6616a66092f1SBarry Smith @*/ 6617a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 6618a66092f1SBarry Smith { 6619a66092f1SBarry Smith PetscInt j = 0,k; 6620a66092f1SBarry Smith PetscErrorCode ierr; 6621a66092f1SBarry Smith 6622a66092f1SBarry Smith PetscFunctionBegin; 6623a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 6624a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6625a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6626a66092f1SBarry Smith while (displaynames[j]) j++; 6627a66092f1SBarry Smith ctx->ndisplayvariables = j; 6628a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6629a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6630a66092f1SBarry Smith j = 0; 6631a66092f1SBarry Smith while (displaynames[j]) { 6632a66092f1SBarry Smith k = 0; 6633a66092f1SBarry Smith while (ctx->names[k]) { 6634a66092f1SBarry Smith PetscBool flg; 6635a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6636a66092f1SBarry Smith if (flg) { 6637a66092f1SBarry Smith ctx->displayvariables[j] = k; 6638a66092f1SBarry Smith break; 6639a66092f1SBarry Smith } 6640a66092f1SBarry Smith k++; 6641a66092f1SBarry Smith } 6642a66092f1SBarry Smith j++; 6643a66092f1SBarry Smith } 6644a66092f1SBarry Smith PetscFunctionReturn(0); 6645a66092f1SBarry Smith } 6646a66092f1SBarry Smith 6647387f4636SBarry Smith /*@C 6648387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6649387f4636SBarry Smith 6650387f4636SBarry Smith Collective on TS 6651387f4636SBarry Smith 6652387f4636SBarry Smith Input Parameters: 6653387f4636SBarry Smith + ts - the TS context 6654387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 6655387f4636SBarry Smith 665695452b02SPatrick Sanan Notes: 665795452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 66587db568b7SBarry Smith 6659387f4636SBarry Smith Level: intermediate 6660387f4636SBarry Smith 6661387f4636SBarry Smith .keywords: TS, vector, monitor, view 6662387f4636SBarry Smith 6663387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6664387f4636SBarry Smith @*/ 6665387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6666387f4636SBarry Smith { 6667a66092f1SBarry Smith PetscInt i; 6668387f4636SBarry Smith PetscErrorCode ierr; 6669387f4636SBarry Smith 6670387f4636SBarry Smith PetscFunctionBegin; 6671387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6672387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 66735537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6674b3d3934dSBarry Smith break; 6675b037adc7SBarry Smith } 6676b037adc7SBarry Smith } 6677b037adc7SBarry Smith PetscFunctionReturn(0); 6678b037adc7SBarry Smith } 6679b037adc7SBarry Smith 668080666b62SBarry Smith /*@C 668180666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 668280666b62SBarry Smith 668380666b62SBarry Smith Collective on TS 668480666b62SBarry Smith 668580666b62SBarry Smith Input Parameters: 668680666b62SBarry Smith + ts - the TS context 668780666b62SBarry Smith . transform - the transform function 66887684fa3eSBarry Smith . destroy - function to destroy the optional context 668980666b62SBarry Smith - ctx - optional context used by transform function 669080666b62SBarry Smith 669195452b02SPatrick Sanan Notes: 669295452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 66937db568b7SBarry Smith 669480666b62SBarry Smith Level: intermediate 669580666b62SBarry Smith 669680666b62SBarry Smith .keywords: TS, vector, monitor, view 669780666b62SBarry Smith 6698a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 669980666b62SBarry Smith @*/ 67007684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 670180666b62SBarry Smith { 670280666b62SBarry Smith PetscInt i; 6703a66092f1SBarry Smith PetscErrorCode ierr; 670480666b62SBarry Smith 670580666b62SBarry Smith PetscFunctionBegin; 670680666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 670780666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 67085537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 670980666b62SBarry Smith } 671080666b62SBarry Smith } 671180666b62SBarry Smith PetscFunctionReturn(0); 671280666b62SBarry Smith } 671380666b62SBarry Smith 6714e673d494SBarry Smith /*@C 6715e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6716e673d494SBarry Smith 6717e673d494SBarry Smith Collective on TSLGCtx 6718e673d494SBarry Smith 6719e673d494SBarry Smith Input Parameters: 6720e673d494SBarry Smith + ts - the TS context 6721e673d494SBarry Smith . transform - the transform function 67227684fa3eSBarry Smith . destroy - function to destroy the optional context 6723e673d494SBarry Smith - ctx - optional context used by transform function 6724e673d494SBarry Smith 6725e673d494SBarry Smith Level: intermediate 6726e673d494SBarry Smith 6727e673d494SBarry Smith .keywords: TS, vector, monitor, view 6728e673d494SBarry Smith 6729a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6730e673d494SBarry Smith @*/ 67317684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6732e673d494SBarry Smith { 6733e673d494SBarry Smith PetscFunctionBegin; 6734e673d494SBarry Smith ctx->transform = transform; 67357684fa3eSBarry Smith ctx->transformdestroy = destroy; 6736e673d494SBarry Smith ctx->transformctx = tctx; 6737e673d494SBarry Smith PetscFunctionReturn(0); 6738e673d494SBarry Smith } 6739e673d494SBarry Smith 6740ef20d060SBarry Smith /*@C 67418b668821SLisandro Dalcin TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error 6742ef20d060SBarry Smith in a time based line graph 6743ef20d060SBarry Smith 6744ef20d060SBarry Smith Collective on TS 6745ef20d060SBarry Smith 6746ef20d060SBarry Smith Input Parameters: 6747ef20d060SBarry Smith + ts - the TS context 6748ef20d060SBarry Smith . step - current time-step 6749ef20d060SBarry Smith . ptime - current time 67507db568b7SBarry Smith . u - current solution 67517db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6752ef20d060SBarry Smith 6753ef20d060SBarry Smith Level: intermediate 6754ef20d060SBarry Smith 675595452b02SPatrick Sanan Notes: 675695452b02SPatrick Sanan Each process in a parallel run displays its component errors in a separate window 6757abd5a294SJed Brown 6758abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6759abd5a294SJed Brown 6760abd5a294SJed Brown Options Database Keys: 67614f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 6762ef20d060SBarry Smith 6763ef20d060SBarry Smith .keywords: TS, vector, monitor, view 6764ef20d060SBarry Smith 6765abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6766ef20d060SBarry Smith @*/ 67670910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6768ef20d060SBarry Smith { 6769ef20d060SBarry Smith PetscErrorCode ierr; 67700b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6771ef20d060SBarry Smith const PetscScalar *yy; 6772ef20d060SBarry Smith Vec y; 6773ef20d060SBarry Smith 6774ef20d060SBarry Smith PetscFunctionBegin; 6775a9f9c1f6SBarry Smith if (!step) { 6776a9f9c1f6SBarry Smith PetscDrawAxis axis; 67776934998bSLisandro Dalcin PetscInt dim; 6778a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 67798b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr); 67800910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6781a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6782a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6783a9f9c1f6SBarry Smith } 67840910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6785ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 67860910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6787ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6788e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6789e3efe391SJed Brown { 6790e3efe391SJed Brown PetscReal *yreal; 6791e3efe391SJed Brown PetscInt i,n; 6792e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6793785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6794e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 67950b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6796e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6797e3efe391SJed Brown } 6798e3efe391SJed Brown #else 67990b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6800e3efe391SJed Brown #endif 6801ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6802ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 6803b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 68040b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 68056934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 68063923b477SBarry Smith } 6807ef20d060SBarry Smith PetscFunctionReturn(0); 6808ef20d060SBarry Smith } 6809ef20d060SBarry Smith 68107cf37e64SBarry Smith /*@C 68117cf37e64SBarry Smith TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep 68127cf37e64SBarry Smith 68137cf37e64SBarry Smith Collective on TS 68147cf37e64SBarry Smith 68157cf37e64SBarry Smith Input Parameters: 68167cf37e64SBarry Smith + ts - the TS context 68177cf37e64SBarry Smith . step - current time-step 68187cf37e64SBarry Smith . ptime - current time 68197cf37e64SBarry Smith . u - current solution 68207cf37e64SBarry Smith - dctx - unused context 68217cf37e64SBarry Smith 68227cf37e64SBarry Smith Level: intermediate 68237cf37e64SBarry Smith 68247cf37e64SBarry Smith The user must provide the solution using TSSetSolutionFunction() to use this monitor. 68257cf37e64SBarry Smith 68267cf37e64SBarry Smith Options Database Keys: 68277cf37e64SBarry Smith . -ts_monitor_error - create a graphical monitor of error history 68287cf37e64SBarry Smith 68297cf37e64SBarry Smith .keywords: TS, vector, monitor, view 68307cf37e64SBarry Smith 68317cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 68327cf37e64SBarry Smith @*/ 6833edbaebb3SBarry Smith PetscErrorCode TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 68347cf37e64SBarry Smith { 68357cf37e64SBarry Smith PetscErrorCode ierr; 68367cf37e64SBarry Smith Vec y; 68377cf37e64SBarry Smith PetscReal nrm; 6838edbaebb3SBarry Smith PetscBool flg; 68397cf37e64SBarry Smith 68407cf37e64SBarry Smith PetscFunctionBegin; 68417cf37e64SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 68427cf37e64SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 68437cf37e64SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6844edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr); 6845edbaebb3SBarry Smith if (flg) { 68467cf37e64SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 6847edbaebb3SBarry Smith ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr); 6848edbaebb3SBarry Smith } 6849edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr); 6850edbaebb3SBarry Smith if (flg) { 6851edbaebb3SBarry Smith ierr = VecView(y,vf->viewer);CHKERRQ(ierr); 6852edbaebb3SBarry Smith } 6853edbaebb3SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 68547cf37e64SBarry Smith PetscFunctionReturn(0); 68557cf37e64SBarry Smith } 68567cf37e64SBarry Smith 6857201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6858201da799SBarry Smith { 6859201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6860201da799SBarry Smith PetscReal x = ptime,y; 6861201da799SBarry Smith PetscErrorCode ierr; 6862201da799SBarry Smith PetscInt its; 6863201da799SBarry Smith 6864201da799SBarry Smith PetscFunctionBegin; 686563e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6866201da799SBarry Smith if (!n) { 6867201da799SBarry Smith PetscDrawAxis axis; 6868201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6869201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 6870201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6871201da799SBarry Smith ctx->snes_its = 0; 6872201da799SBarry Smith } 6873201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 6874201da799SBarry Smith y = its - ctx->snes_its; 6875201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 68763fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6877201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 68786934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6879201da799SBarry Smith } 6880201da799SBarry Smith ctx->snes_its = its; 6881201da799SBarry Smith PetscFunctionReturn(0); 6882201da799SBarry Smith } 6883201da799SBarry Smith 6884201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 6885201da799SBarry Smith { 6886201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 6887201da799SBarry Smith PetscReal x = ptime,y; 6888201da799SBarry Smith PetscErrorCode ierr; 6889201da799SBarry Smith PetscInt its; 6890201da799SBarry Smith 6891201da799SBarry Smith PetscFunctionBegin; 689263e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 6893201da799SBarry Smith if (!n) { 6894201da799SBarry Smith PetscDrawAxis axis; 6895201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 6896201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 6897201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6898201da799SBarry Smith ctx->ksp_its = 0; 6899201da799SBarry Smith } 6900201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 6901201da799SBarry Smith y = its - ctx->ksp_its; 6902201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 690399fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 6904201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 69056934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 6906201da799SBarry Smith } 6907201da799SBarry Smith ctx->ksp_its = its; 6908201da799SBarry Smith PetscFunctionReturn(0); 6909201da799SBarry Smith } 6910f9c1d6abSBarry Smith 6911f9c1d6abSBarry Smith /*@ 6912f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 6913f9c1d6abSBarry Smith 6914f9c1d6abSBarry Smith Collective on TS and Vec 6915f9c1d6abSBarry Smith 6916f9c1d6abSBarry Smith Input Parameters: 6917f9c1d6abSBarry Smith + ts - the TS context 6918f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 6919f9c1d6abSBarry Smith 6920f9c1d6abSBarry Smith Output Parameters: 6921f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 6922f9c1d6abSBarry Smith 6923f9c1d6abSBarry Smith Level: developer 6924f9c1d6abSBarry Smith 6925f9c1d6abSBarry Smith .keywords: TS, compute 6926f9c1d6abSBarry Smith 6927f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 6928f9c1d6abSBarry Smith @*/ 6929f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 6930f9c1d6abSBarry Smith { 6931f9c1d6abSBarry Smith PetscErrorCode ierr; 6932f9c1d6abSBarry Smith 6933f9c1d6abSBarry Smith PetscFunctionBegin; 6934f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6935ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 6936f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 6937f9c1d6abSBarry Smith PetscFunctionReturn(0); 6938f9c1d6abSBarry Smith } 693924655328SShri 6940b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 6941b3d3934dSBarry Smith /*@C 6942b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 6943b3d3934dSBarry Smith 6944b3d3934dSBarry Smith Collective on TS 6945b3d3934dSBarry Smith 6946b3d3934dSBarry Smith Input Parameters: 6947b3d3934dSBarry Smith . ts - the ODE solver object 6948b3d3934dSBarry Smith 6949b3d3934dSBarry Smith Output Parameter: 6950b3d3934dSBarry Smith . ctx - the context 6951b3d3934dSBarry Smith 6952b3d3934dSBarry Smith Level: intermediate 6953b3d3934dSBarry Smith 6954b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 6955b3d3934dSBarry Smith 6956b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 6957b3d3934dSBarry Smith 6958b3d3934dSBarry Smith @*/ 6959b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 6960b3d3934dSBarry Smith { 6961b3d3934dSBarry Smith PetscErrorCode ierr; 6962b3d3934dSBarry Smith 6963b3d3934dSBarry Smith PetscFunctionBegin; 6964a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 6965b3d3934dSBarry Smith PetscFunctionReturn(0); 6966b3d3934dSBarry Smith } 6967b3d3934dSBarry Smith 6968b3d3934dSBarry Smith /*@C 6969b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 6970b3d3934dSBarry Smith 6971b3d3934dSBarry Smith Collective on TS 6972b3d3934dSBarry Smith 6973b3d3934dSBarry Smith Input Parameters: 6974b3d3934dSBarry Smith + ts - the TS context 6975b3d3934dSBarry Smith . step - current time-step 6976b3d3934dSBarry Smith . ptime - current time 69777db568b7SBarry Smith . u - current solution 69787db568b7SBarry Smith - dctx - the envelope context 6979b3d3934dSBarry Smith 6980b3d3934dSBarry Smith Options Database: 6981b3d3934dSBarry Smith . -ts_monitor_envelope 6982b3d3934dSBarry Smith 6983b3d3934dSBarry Smith Level: intermediate 6984b3d3934dSBarry Smith 698595452b02SPatrick Sanan Notes: 698695452b02SPatrick Sanan after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 6987b3d3934dSBarry Smith 6988b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 6989b3d3934dSBarry Smith 69907db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 6991b3d3934dSBarry Smith @*/ 69927db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6993b3d3934dSBarry Smith { 6994b3d3934dSBarry Smith PetscErrorCode ierr; 69957db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 6996b3d3934dSBarry Smith 6997b3d3934dSBarry Smith PetscFunctionBegin; 6998b3d3934dSBarry Smith if (!ctx->max) { 6999b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7000b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7001b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7002b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7003b3d3934dSBarry Smith } else { 7004b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7005b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7006b3d3934dSBarry Smith } 7007b3d3934dSBarry Smith PetscFunctionReturn(0); 7008b3d3934dSBarry Smith } 7009b3d3934dSBarry Smith 7010b3d3934dSBarry Smith /*@C 7011b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7012b3d3934dSBarry Smith 7013b3d3934dSBarry Smith Collective on TS 7014b3d3934dSBarry Smith 7015b3d3934dSBarry Smith Input Parameter: 7016b3d3934dSBarry Smith . ts - the TS context 7017b3d3934dSBarry Smith 7018b3d3934dSBarry Smith Output Parameter: 7019b3d3934dSBarry Smith + max - the maximum values 7020b3d3934dSBarry Smith - min - the minimum values 7021b3d3934dSBarry Smith 702295452b02SPatrick Sanan Notes: 702395452b02SPatrick Sanan If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 70247db568b7SBarry Smith 7025b3d3934dSBarry Smith Level: intermediate 7026b3d3934dSBarry Smith 7027b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7028b3d3934dSBarry Smith 7029b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7030b3d3934dSBarry Smith @*/ 7031b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7032b3d3934dSBarry Smith { 7033b3d3934dSBarry Smith PetscInt i; 7034b3d3934dSBarry Smith 7035b3d3934dSBarry Smith PetscFunctionBegin; 7036b3d3934dSBarry Smith if (max) *max = NULL; 7037b3d3934dSBarry Smith if (min) *min = NULL; 7038b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7039b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 70405537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7041b3d3934dSBarry Smith if (max) *max = ctx->max; 7042b3d3934dSBarry Smith if (min) *min = ctx->min; 7043b3d3934dSBarry Smith break; 7044b3d3934dSBarry Smith } 7045b3d3934dSBarry Smith } 7046b3d3934dSBarry Smith PetscFunctionReturn(0); 7047b3d3934dSBarry Smith } 7048b3d3934dSBarry Smith 7049b3d3934dSBarry Smith /*@C 7050b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7051b3d3934dSBarry Smith 7052b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7053b3d3934dSBarry Smith 7054b3d3934dSBarry Smith Input Parameter: 7055b3d3934dSBarry Smith . ctx - the monitor context 7056b3d3934dSBarry Smith 7057b3d3934dSBarry Smith Level: intermediate 7058b3d3934dSBarry Smith 7059b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7060b3d3934dSBarry Smith 70617db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7062b3d3934dSBarry Smith @*/ 7063b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7064b3d3934dSBarry Smith { 7065b3d3934dSBarry Smith PetscErrorCode ierr; 7066b3d3934dSBarry Smith 7067b3d3934dSBarry Smith PetscFunctionBegin; 7068b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7069b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7070b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7071b3d3934dSBarry Smith PetscFunctionReturn(0); 7072b3d3934dSBarry Smith } 7073f2dee214SBarry Smith 707424655328SShri /*@ 7075dcb233daSLisandro Dalcin TSRestartStep - Flags the solver to restart the next step 7076dcb233daSLisandro Dalcin 7077dcb233daSLisandro Dalcin Collective on TS 7078dcb233daSLisandro Dalcin 7079dcb233daSLisandro Dalcin Input Parameter: 7080dcb233daSLisandro Dalcin . ts - the TS context obtained from TSCreate() 7081dcb233daSLisandro Dalcin 7082dcb233daSLisandro Dalcin Level: advanced 7083dcb233daSLisandro Dalcin 7084dcb233daSLisandro Dalcin Notes: 7085dcb233daSLisandro Dalcin Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of 7086dcb233daSLisandro Dalcin discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution 7087dcb233daSLisandro Dalcin vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For 7088dcb233daSLisandro Dalcin the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce 7089dcb233daSLisandro Dalcin discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with 7090dcb233daSLisandro Dalcin discontinuous source terms). 7091dcb233daSLisandro Dalcin 7092dcb233daSLisandro Dalcin .keywords: TS, timestep, restart 7093dcb233daSLisandro Dalcin 7094dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep() 7095dcb233daSLisandro Dalcin @*/ 7096dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts) 7097dcb233daSLisandro Dalcin { 7098dcb233daSLisandro Dalcin PetscFunctionBegin; 7099dcb233daSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7100dcb233daSLisandro Dalcin ts->steprestart = PETSC_TRUE; 7101dcb233daSLisandro Dalcin PetscFunctionReturn(0); 7102dcb233daSLisandro Dalcin } 7103dcb233daSLisandro Dalcin 7104dcb233daSLisandro Dalcin /*@ 710524655328SShri TSRollBack - Rolls back one time step 710624655328SShri 710724655328SShri Collective on TS 710824655328SShri 710924655328SShri Input Parameter: 711024655328SShri . ts - the TS context obtained from TSCreate() 711124655328SShri 711224655328SShri Level: advanced 711324655328SShri 711424655328SShri .keywords: TS, timestep, rollback 711524655328SShri 711624655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 711724655328SShri @*/ 711824655328SShri PetscErrorCode TSRollBack(TS ts) 711924655328SShri { 712024655328SShri PetscErrorCode ierr; 712124655328SShri 712224655328SShri PetscFunctionBegin; 712324655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7124b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 712524655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 712624655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 712724655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 712824655328SShri ts->ptime = ts->ptime_prev; 7129be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 71302808aa04SLisandro Dalcin ts->steps--; 7131b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 713224655328SShri PetscFunctionReturn(0); 713324655328SShri } 7134aeb4809dSShri Abhyankar 7135ff22ae23SHong Zhang /*@ 7136ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7137ff22ae23SHong Zhang 7138ff22ae23SHong Zhang Input Parameter: 7139ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7140ff22ae23SHong Zhang 7141ff22ae23SHong Zhang Level: advanced 7142ff22ae23SHong Zhang 7143ff22ae23SHong Zhang .keywords: TS, getstages 7144ff22ae23SHong Zhang 7145ff22ae23SHong Zhang .seealso: TSCreate() 7146ff22ae23SHong Zhang @*/ 7147ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7148ff22ae23SHong Zhang { 7149ff22ae23SHong Zhang PetscErrorCode ierr; 7150ff22ae23SHong Zhang 7151ff22ae23SHong Zhang PetscFunctionBegin; 7152ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7153ff22ae23SHong Zhang PetscValidPointer(ns,2); 7154ff22ae23SHong Zhang 7155ff22ae23SHong Zhang if (!ts->ops->getstages) *ns=0; 7156ff22ae23SHong Zhang else { 7157ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7158ff22ae23SHong Zhang } 7159ff22ae23SHong Zhang PetscFunctionReturn(0); 7160ff22ae23SHong Zhang } 7161ff22ae23SHong Zhang 7162847ff0e1SMatthew G. Knepley /*@C 7163847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7164847ff0e1SMatthew G. Knepley 7165847ff0e1SMatthew G. Knepley Collective on SNES 7166847ff0e1SMatthew G. Knepley 7167847ff0e1SMatthew G. Knepley Input Parameters: 7168847ff0e1SMatthew G. Knepley + ts - the TS context 7169847ff0e1SMatthew G. Knepley . t - current timestep 7170847ff0e1SMatthew G. Knepley . U - state vector 7171847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7172847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7173847ff0e1SMatthew G. Knepley - ctx - an optional user context 7174847ff0e1SMatthew G. Knepley 7175847ff0e1SMatthew G. Knepley Output Parameters: 7176847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7177847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7178847ff0e1SMatthew G. Knepley 7179847ff0e1SMatthew G. Knepley Level: intermediate 7180847ff0e1SMatthew G. Knepley 7181847ff0e1SMatthew G. Knepley Notes: 7182847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7183847ff0e1SMatthew G. Knepley 7184847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7185847ff0e1SMatthew G. Knepley 7186847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7187847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7188847ff0e1SMatthew G. Knepley 7189847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7190847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7191847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7192847ff0e1SMatthew G. Knepley 7193847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7194847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7195847ff0e1SMatthew G. Knepley @*/ 7196847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7197847ff0e1SMatthew G. Knepley { 7198847ff0e1SMatthew G. Knepley SNES snes; 7199847ff0e1SMatthew G. Knepley MatFDColoring color; 7200847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7201847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7202847ff0e1SMatthew G. Knepley 7203847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7204c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7205847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7206847ff0e1SMatthew G. Knepley if (!color) { 7207847ff0e1SMatthew G. Knepley DM dm; 7208847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7209847ff0e1SMatthew G. Knepley 7210847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7211847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7212847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7213847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7214847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7215847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7216847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7217847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7218847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7219847ff0e1SMatthew G. Knepley } else { 7220847ff0e1SMatthew G. Knepley MatColoring mc; 7221847ff0e1SMatthew G. Knepley 7222847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7223847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7224847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7225847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7226847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7227847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7228847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7229847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7230847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7231847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7232847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7233847ff0e1SMatthew G. Knepley } 7234847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7235847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7236847ff0e1SMatthew G. Knepley } 7237847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7238847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7239847ff0e1SMatthew G. Knepley if (J != B) { 7240847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7241847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7242847ff0e1SMatthew G. Knepley } 7243847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7244847ff0e1SMatthew G. Knepley } 724593b34091SDebojyoti Ghosh 7246cb9d8021SPierre Barbier de Reuille /*@ 7247cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7248cb9d8021SPierre Barbier de Reuille 7249cb9d8021SPierre Barbier de Reuille Input Parameters: 7250cb9d8021SPierre Barbier de Reuille ts - the TS context 7251cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7252cb9d8021SPierre Barbier de Reuille 7253cb9d8021SPierre Barbier de Reuille Level: intermediate 7254cb9d8021SPierre Barbier de Reuille 7255cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7256cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7257cb9d8021SPierre Barbier de Reuille @*/ 7258cb9d8021SPierre Barbier de Reuille 7259d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7260cb9d8021SPierre Barbier de Reuille { 7261cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7262cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7263cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7264cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7265cb9d8021SPierre Barbier de Reuille } 7266cb9d8021SPierre Barbier de Reuille 7267cb9d8021SPierre Barbier de Reuille /*@ 7268cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7269cb9d8021SPierre Barbier de Reuille 7270cb9d8021SPierre Barbier de Reuille Input Parameters: 7271cb9d8021SPierre Barbier de Reuille ts - the TS context 7272cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7273d183316bSPierre Barbier de Reuille Y - state vector to check. 7274cb9d8021SPierre Barbier de Reuille 7275cb9d8021SPierre Barbier de Reuille Output Parameter: 7276cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7277cb9d8021SPierre Barbier de Reuille 7278cb9d8021SPierre Barbier de Reuille Note: 7279cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7280cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 728196a0c994SBarry Smith 728296a0c994SBarry Smith Level: advanced 7283cb9d8021SPierre Barbier de Reuille @*/ 7284d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7285cb9d8021SPierre Barbier de Reuille { 7286cb9d8021SPierre Barbier de Reuille PetscErrorCode ierr; 7287cb9d8021SPierre Barbier de Reuille 7288cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7289cb9d8021SPierre Barbier de Reuille 7290cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7291cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7292cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7293d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7294cb9d8021SPierre Barbier de Reuille } 7295cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7296cb9d8021SPierre Barbier de Reuille } 72971ceb14c0SBarry Smith 729893b34091SDebojyoti Ghosh /*@C 7299e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 730093b34091SDebojyoti Ghosh 730193b34091SDebojyoti Ghosh Collective on MPI_Comm 730293b34091SDebojyoti Ghosh 730393b34091SDebojyoti Ghosh Input Parameter: 730493b34091SDebojyoti Ghosh . tsin - The input TS 730593b34091SDebojyoti Ghosh 730693b34091SDebojyoti Ghosh Output Parameter: 7307e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 730893b34091SDebojyoti Ghosh 73095eca1a21SEmil Constantinescu Notes: 73105eca1a21SEmil 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. 73115eca1a21SEmil Constantinescu 7312baa10174SEmil 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); 73135eca1a21SEmil Constantinescu 73145eca1a21SEmil Constantinescu Level: developer 731593b34091SDebojyoti Ghosh 7316e5168f73SEmil Constantinescu .keywords: TS, clone 7317e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 731893b34091SDebojyoti Ghosh @*/ 7319baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 732093b34091SDebojyoti Ghosh { 732193b34091SDebojyoti Ghosh TS t; 732293b34091SDebojyoti Ghosh PetscErrorCode ierr; 7323dc846ba4SSatish Balay SNES snes_start; 7324dc846ba4SSatish Balay DM dm; 7325dc846ba4SSatish Balay TSType type; 732693b34091SDebojyoti Ghosh 732793b34091SDebojyoti Ghosh PetscFunctionBegin; 732893b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 732993b34091SDebojyoti Ghosh *tsout = NULL; 733093b34091SDebojyoti Ghosh 73317a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 733293b34091SDebojyoti Ghosh 733393b34091SDebojyoti Ghosh /* General TS description */ 733493b34091SDebojyoti Ghosh t->numbermonitors = 0; 733593b34091SDebojyoti Ghosh t->setupcalled = 0; 733693b34091SDebojyoti Ghosh t->ksp_its = 0; 733793b34091SDebojyoti Ghosh t->snes_its = 0; 733893b34091SDebojyoti Ghosh t->nwork = 0; 733993b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 734093b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 734193b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 734293b34091SDebojyoti Ghosh 734334561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 734434561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7345d15a3a53SEmil Constantinescu 734693b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 734793b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 734893b34091SDebojyoti Ghosh 734993b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 735051699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 735193b34091SDebojyoti Ghosh 7352e7069c78SShri t->trajectory = tsin->trajectory; 7353e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7354e7069c78SShri 7355e7069c78SShri t->event = tsin->event; 73566b10a48eSSatish Balay if (t->event) t->event->refct++; 7357e7069c78SShri 735893b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 735993b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7360e7069c78SShri t->ptime_prev = tsin->ptime_prev; 736193b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 736293b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 736393b34091SDebojyoti Ghosh t->steps = tsin->steps; 736493b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 736593b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 736693b34091SDebojyoti Ghosh t->atol = tsin->atol; 736793b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 736893b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 736993b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 737093b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 737193b34091SDebojyoti Ghosh 737293b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 737393b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 737493b34091SDebojyoti Ghosh 737593b34091SDebojyoti Ghosh t->vec_sol = NULL; 737693b34091SDebojyoti Ghosh 737793b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 737893b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 737993b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 738093b34091SDebojyoti Ghosh 738193b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 738293b34091SDebojyoti Ghosh 73830d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 73840d4fed19SBarry Smith PetscInt i; 73850d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 73860d4fed19SBarry Smith for (i=0; i<10; i++) { 73870d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 73880d4fed19SBarry Smith } 73890d4fed19SBarry Smith } 739093b34091SDebojyoti Ghosh *tsout = t; 739193b34091SDebojyoti Ghosh PetscFunctionReturn(0); 739293b34091SDebojyoti Ghosh } 7393f3b1f45cSBarry Smith 7394f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y) 7395f3b1f45cSBarry Smith { 7396f3b1f45cSBarry Smith PetscErrorCode ierr; 7397f3b1f45cSBarry Smith TS ts = (TS) ctx; 7398f3b1f45cSBarry Smith 7399f3b1f45cSBarry Smith PetscFunctionBegin; 7400f3b1f45cSBarry Smith ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr); 7401f3b1f45cSBarry Smith PetscFunctionReturn(0); 7402f3b1f45cSBarry Smith } 7403f3b1f45cSBarry Smith 7404f3b1f45cSBarry Smith /*@ 7405f3b1f45cSBarry Smith TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function. 7406f3b1f45cSBarry Smith 7407f3b1f45cSBarry Smith Logically Collective on TS and Mat 7408f3b1f45cSBarry Smith 7409f3b1f45cSBarry Smith Input Parameters: 7410f3b1f45cSBarry Smith TS - the time stepping routine 7411f3b1f45cSBarry Smith 7412f3b1f45cSBarry Smith Output Parameter: 7413f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7414f3b1f45cSBarry Smith 7415f3b1f45cSBarry Smith Options Database: 7416f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator 7417f3b1f45cSBarry Smith 7418f3b1f45cSBarry Smith Level: advanced 7419f3b1f45cSBarry Smith 742095452b02SPatrick Sanan Notes: 742195452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7422f3b1f45cSBarry Smith 7423f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose() 7424f3b1f45cSBarry Smith @*/ 7425f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTest(TS ts,PetscBool *flg) 7426f3b1f45cSBarry Smith { 7427f3b1f45cSBarry Smith Mat J,B; 7428f3b1f45cSBarry Smith PetscErrorCode ierr; 7429f3b1f45cSBarry Smith TSRHSJacobian func; 7430f3b1f45cSBarry Smith void* ctx; 7431f3b1f45cSBarry Smith 7432f3b1f45cSBarry Smith PetscFunctionBegin; 7433f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7434f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7435f3b1f45cSBarry Smith ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7436f3b1f45cSBarry Smith PetscFunctionReturn(0); 7437f3b1f45cSBarry Smith } 7438f3b1f45cSBarry Smith 7439f3b1f45cSBarry Smith /*@C 7440f3b1f45cSBarry Smith TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function. 7441f3b1f45cSBarry Smith 7442f3b1f45cSBarry Smith Logically Collective on TS and Mat 7443f3b1f45cSBarry Smith 7444f3b1f45cSBarry Smith Input Parameters: 7445f3b1f45cSBarry Smith TS - the time stepping routine 7446f3b1f45cSBarry Smith 7447f3b1f45cSBarry Smith Output Parameter: 7448f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7449f3b1f45cSBarry Smith 7450f3b1f45cSBarry Smith Options Database: 7451f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator 7452f3b1f45cSBarry Smith 745395452b02SPatrick Sanan Notes: 745495452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7455f3b1f45cSBarry Smith 7456f3b1f45cSBarry Smith Level: advanced 7457f3b1f45cSBarry Smith 7458f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest() 7459f3b1f45cSBarry Smith @*/ 7460f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTestTranspose(TS ts,PetscBool *flg) 7461f3b1f45cSBarry Smith { 7462f3b1f45cSBarry Smith Mat J,B; 7463f3b1f45cSBarry Smith PetscErrorCode ierr; 7464f3b1f45cSBarry Smith void *ctx; 7465f3b1f45cSBarry Smith TSRHSJacobian func; 7466f3b1f45cSBarry Smith 7467f3b1f45cSBarry Smith PetscFunctionBegin; 7468f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7469f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7470f3b1f45cSBarry Smith ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7471f3b1f45cSBarry Smith PetscFunctionReturn(0); 7472f3b1f45cSBarry Smith } 7473