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; 4416413a6aSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject) ts)->options,((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: 79e49d4f37SHong Zhang + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP 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 844dc72f7fSBarry Smith . -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time) 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); 1391ef27442SStefano Zampini if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 1401ef27442SStefano Zampini else defaultType = ifun ? TSBEULER : TSEULER; 1416991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1426991f827SBarry Smith if (opt) { 1436991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1446991f827SBarry Smith } else { 1456991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1466991f827SBarry Smith } 147bdad233fSMatthew Knepley 148bdad233fSMatthew Knepley /* Handle generic TS options */ 1494dc72f7fSBarry Smith ierr = PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL);CHKERRQ(ierr); 150ef85077eSLisandro Dalcin ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 15119eac22cSLisandro Dalcin ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1520298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 15331748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 154cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 15549354f04SShri 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); 15649354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1570298fd71SBarry 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); 1580298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1590298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1600298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1610298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 162bdad233fSMatthew Knepley 163f3b1f45cSBarry 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); 164f3b1f45cSBarry 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); 1650fe4d17eSHong Zhang ierr = PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL);CHKERRQ(ierr); 16656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 16756f85f32SBarry Smith { 16856f85f32SBarry Smith PetscBool set; 16956f85f32SBarry Smith flg = PETSC_FALSE; 17056f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 17156f85f32SBarry Smith if (set) { 17256f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 17356f85f32SBarry Smith } 17456f85f32SBarry Smith } 17556f85f32SBarry Smith #endif 17656f85f32SBarry Smith 177bdad233fSMatthew Knepley /* Monitor options */ 178cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 179cc9c3a59SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,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 } 2530ec8ee2bSJoseph Pusztay ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr); 2541b575b74SJoseph Pusztay if (opt) { 2551b575b74SJoseph Pusztay TSMonitorSPCtx ctx; 2561b575b74SJoseph Pusztay PetscInt howoften = 1; 2570ec8ee2bSJoseph Pusztay ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr); 2581b575b74SJoseph Pusztay ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr); 2590ec8ee2bSJoseph Pusztay ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr); 2601b575b74SJoseph Pusztay } 261ef20d060SBarry Smith opt = PETSC_FALSE; 2620dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 263a7cc72afSBarry Smith if (opt) { 26483a4ac43SBarry Smith TSMonitorDrawCtx ctx; 26583a4ac43SBarry Smith PetscInt howoften = 1; 266a80ad3e0SBarry Smith 2670298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 2680ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 26983a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 270bdad233fSMatthew Knepley } 271fb1732b5SBarry Smith opt = PETSC_FALSE; 2722d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2732d5ee99bSBarry Smith if (opt) { 2742d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2752d5ee99bSBarry Smith PetscReal bounds[4]; 2762d5ee99bSBarry Smith PetscInt n = 4; 2772d5ee99bSBarry Smith PetscDraw draw; 2786934998bSLisandro Dalcin PetscDrawAxis axis; 2792d5ee99bSBarry Smith 2802d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2812d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 2826934998bSLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 2832d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2846934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 2856934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 2866934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2872d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2882d5ee99bSBarry Smith } 2892d5ee99bSBarry Smith opt = PETSC_FALSE; 2900dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 2913a471f94SBarry Smith if (opt) { 29283a4ac43SBarry Smith TSMonitorDrawCtx ctx; 29383a4ac43SBarry Smith PetscInt howoften = 1; 2943a471f94SBarry Smith 2950298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 2960ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 29783a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2983a471f94SBarry Smith } 2990ed3bfb6SBarry Smith opt = PETSC_FALSE; 3000ed3bfb6SBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr); 3010ed3bfb6SBarry Smith if (opt) { 3020ed3bfb6SBarry Smith TSMonitorDrawCtx ctx; 3030ed3bfb6SBarry Smith PetscInt howoften = 1; 3040ed3bfb6SBarry Smith 3050ed3bfb6SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr); 3060ed3bfb6SBarry Smith ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 3070ed3bfb6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3080ed3bfb6SBarry Smith } 309fde5950dSBarry Smith 310ed81e22dSJed Brown opt = PETSC_FALSE; 31191b97e58SBarry 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); 312ed81e22dSJed Brown if (flg) { 313ed81e22dSJed Brown const char *ptr,*ptr2; 314ed81e22dSJed Brown char *filetemplate; 315ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 316ed81e22dSJed Brown /* Do some cursory validation of the input. */ 317ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 318ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 319ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 320ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 321ce94432eSBarry 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"); 322ed81e22dSJed Brown if (ptr2) break; 323ed81e22dSJed Brown } 324ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 325ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 326ed81e22dSJed Brown } 327bdad233fSMatthew Knepley 328d1212d36SBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr); 329d1212d36SBarry Smith if (flg) { 330d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 331d1212d36SBarry Smith int ray = 0; 332d1212d36SBarry Smith DMDADirection ddir; 333d1212d36SBarry Smith DM da; 334d1212d36SBarry Smith PetscMPIInt rank; 335d1212d36SBarry Smith 336ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 337d1212d36SBarry Smith if (dir[0] == 'x') ddir = DMDA_X; 338d1212d36SBarry Smith else if (dir[0] == 'y') ddir = DMDA_Y; 339ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 340d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 341d1212d36SBarry Smith 342d1212d36SBarry Smith ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr); 343b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 344d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 345d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 346ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 347d1212d36SBarry Smith if (!rank) { 348d1212d36SBarry Smith ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 349d1212d36SBarry Smith } 35051b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 351d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 352d1212d36SBarry Smith } 35351b4a12fSMatthew G. Knepley ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr); 35451b4a12fSMatthew G. Knepley if (flg) { 35551b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 35651b4a12fSMatthew G. Knepley int ray = 0; 35751b4a12fSMatthew G. Knepley DMDADirection ddir; 35851b4a12fSMatthew G. Knepley DM da; 35951b4a12fSMatthew G. Knepley PetscInt howoften = 1; 360d1212d36SBarry Smith 36151b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 36251b4a12fSMatthew G. Knepley if (dir[0] == 'x') ddir = DMDA_X; 36351b4a12fSMatthew G. Knepley else if (dir[0] == 'y') ddir = DMDA_Y; 36451b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 36551b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3661c3436cfSJed Brown 36751b4a12fSMatthew G. Knepley ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr); 368b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 36951b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 37051b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 37151b4a12fSMatthew G. Knepley ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 37251b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 37351b4a12fSMatthew G. Knepley } 374a7a1495cSBarry Smith 375b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 376b3d3934dSBarry Smith if (opt) { 377b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 378b3d3934dSBarry Smith 379b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 380b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 381b3d3934dSBarry Smith } 382b3d3934dSBarry Smith 383847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 384847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 385847ff0e1SMatthew G. Knepley if (flg) { 386847ff0e1SMatthew G. Knepley DM dm; 387847ff0e1SMatthew G. Knepley DMTS tdm; 388847ff0e1SMatthew G. Knepley 389847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 390847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 391847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 392847ff0e1SMatthew G. Knepley ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr); 393847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 394847ff0e1SMatthew G. Knepley } 395847ff0e1SMatthew G. Knepley 396d763cef2SBarry Smith /* Handle specific TS options */ 397d763cef2SBarry Smith if (ts->ops->setfromoptions) { 3986991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 399d763cef2SBarry Smith } 400fbc52257SHong Zhang 401a7bdc993SLisandro Dalcin /* Handle TSAdapt options */ 402a7bdc993SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 403a7bdc993SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 404a7bdc993SLisandro Dalcin ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 405a7bdc993SLisandro Dalcin 40668bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 4074f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 40868bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 40968bece0bSHong Zhang if (tflg) { 41068bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 41168bece0bSHong Zhang } 412a05bf03eSHong Zhang 413a05bf03eSHong Zhang ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr); 414d763cef2SBarry Smith 415d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4160633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 417fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 418d763cef2SBarry Smith 4194f122a70SLisandro Dalcin if (ts->trajectory) { 4204f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 421d763cef2SBarry Smith } 42268bece0bSHong Zhang 4231ef27442SStefano Zampini /* why do we have to do this here and not during TSSetUp? */ 4244f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4251ef27442SStefano Zampini if (ts->problem_type == TS_LINEAR) { 4261ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 4271ef27442SStefano Zampini if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); } 4281ef27442SStefano Zampini } 4294f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 430d763cef2SBarry Smith PetscFunctionReturn(0); 431d763cef2SBarry Smith } 432d763cef2SBarry Smith 433d2daff3dSHong Zhang /*@ 43478fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 43578fbdcc8SBarry Smith 43678fbdcc8SBarry Smith Collective on TS 43778fbdcc8SBarry Smith 43878fbdcc8SBarry Smith Input Parameters: 43978fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 44078fbdcc8SBarry Smith 44178fbdcc8SBarry Smith Output Parameters; 44278fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 44378fbdcc8SBarry Smith 44478fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 44578fbdcc8SBarry Smith 44678fbdcc8SBarry Smith Level: advanced 44778fbdcc8SBarry Smith 44878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 44978fbdcc8SBarry Smith 45078fbdcc8SBarry Smith .keywords: TS, set, checkpoint, 45178fbdcc8SBarry Smith @*/ 45278fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 45378fbdcc8SBarry Smith { 45478fbdcc8SBarry Smith PetscFunctionBegin; 45578fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45678fbdcc8SBarry Smith *tr = ts->trajectory; 45778fbdcc8SBarry Smith PetscFunctionReturn(0); 45878fbdcc8SBarry Smith } 45978fbdcc8SBarry Smith 46078fbdcc8SBarry Smith /*@ 461bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 462d2daff3dSHong Zhang 463d2daff3dSHong Zhang Collective on TS 464d2daff3dSHong Zhang 465d2daff3dSHong Zhang Input Parameters: 466bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 467bc952696SBarry Smith 46878fbdcc8SBarry Smith Options Database: 46978fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 47078fbdcc8SBarry Smith - -ts_trajectory_type type 47178fbdcc8SBarry Smith 47268bece0bSHong Zhang Note: This routine should be called after all TS options have been set 473d2daff3dSHong Zhang 474c3a89c15SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and 47578fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 47678fbdcc8SBarry Smith 477d2daff3dSHong Zhang Level: intermediate 478d2daff3dSHong Zhang 4792d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 480d2daff3dSHong Zhang 481bc952696SBarry Smith .keywords: TS, set, checkpoint, 482d2daff3dSHong Zhang @*/ 483bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 484d2daff3dSHong Zhang { 485bc952696SBarry Smith PetscErrorCode ierr; 486bc952696SBarry Smith 487d2daff3dSHong Zhang PetscFunctionBegin; 488d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 489bc952696SBarry Smith if (!ts->trajectory) { 490bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 491bc952696SBarry Smith } 492d2daff3dSHong Zhang PetscFunctionReturn(0); 493d2daff3dSHong Zhang } 494d2daff3dSHong Zhang 495a7a1495cSBarry Smith /*@ 4962d29f1f2SStefano Zampini TSResetTrajectory - Destroys and recreates the internal TSTrajectory object 4972d29f1f2SStefano Zampini 4982d29f1f2SStefano Zampini Collective on TS 4992d29f1f2SStefano Zampini 5002d29f1f2SStefano Zampini Input Parameters: 5012d29f1f2SStefano Zampini . ts - the TS context obtained from TSCreate() 5022d29f1f2SStefano Zampini 5032d29f1f2SStefano Zampini Level: intermediate 5042d29f1f2SStefano Zampini 5052d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 5062d29f1f2SStefano Zampini 5072d29f1f2SStefano Zampini .keywords: TS, set, checkpoint, 5082d29f1f2SStefano Zampini @*/ 5092d29f1f2SStefano Zampini PetscErrorCode TSResetTrajectory(TS ts) 5102d29f1f2SStefano Zampini { 5112d29f1f2SStefano Zampini PetscErrorCode ierr; 5122d29f1f2SStefano Zampini 5132d29f1f2SStefano Zampini PetscFunctionBegin; 5142d29f1f2SStefano Zampini PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5152d29f1f2SStefano Zampini if (ts->trajectory) { 5162d29f1f2SStefano Zampini ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr); 5172d29f1f2SStefano Zampini ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 5182d29f1f2SStefano Zampini } 5192d29f1f2SStefano Zampini PetscFunctionReturn(0); 5202d29f1f2SStefano Zampini } 5212d29f1f2SStefano Zampini 5222d29f1f2SStefano Zampini /*@ 523a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 524a7a1495cSBarry Smith set with TSSetRHSJacobian(). 525a7a1495cSBarry Smith 526a7a1495cSBarry Smith Collective on TS and Vec 527a7a1495cSBarry Smith 528a7a1495cSBarry Smith Input Parameters: 529316643e7SJed Brown + ts - the TS context 530a7a1495cSBarry Smith . t - current timestep 5310910c330SBarry Smith - U - input vector 532a7a1495cSBarry Smith 533a7a1495cSBarry Smith Output Parameters: 534a7a1495cSBarry Smith + A - Jacobian matrix 535a7a1495cSBarry Smith . B - optional preconditioning matrix 536a7a1495cSBarry Smith - flag - flag indicating matrix structure 537a7a1495cSBarry Smith 538a7a1495cSBarry Smith Notes: 539a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 540a7a1495cSBarry Smith is used internally within the nonlinear solvers. 541a7a1495cSBarry Smith 54294b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 543a7a1495cSBarry Smith flag parameter. 544a7a1495cSBarry Smith 545a7a1495cSBarry Smith Level: developer 546a7a1495cSBarry Smith 547a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix 548a7a1495cSBarry Smith 54994b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 550a7a1495cSBarry Smith @*/ 551d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 552a7a1495cSBarry Smith { 553dfbe8321SBarry Smith PetscErrorCode ierr; 554270bf2e7SJed Brown PetscObjectState Ustate; 5556c1e1eecSBarry Smith PetscObjectId Uid; 55624989b8cSPeter Brune DM dm; 557942e3340SBarry Smith DMTS tsdm; 55824989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 55924989b8cSPeter Brune void *ctx; 56024989b8cSPeter Brune TSIJacobian ijacobianfunc; 561b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 562a7a1495cSBarry Smith 563a7a1495cSBarry Smith PetscFunctionBegin; 5640700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5650910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5660910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 56724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 568942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 56924989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 5700298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr); 571b2df71adSDebojyoti Ghosh ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 57259e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 5736c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 574971015bcSStefano Zampini 5756c1e1eecSBarry Smith if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) { 576971015bcSStefano Zampini /* restore back RHS Jacobian matrices if they have been shifted/scaled */ 577971015bcSStefano Zampini if (A == ts->Arhs) { 578971015bcSStefano Zampini if (ts->rhsjacobian.shift != 0) { 579971015bcSStefano Zampini ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 580971015bcSStefano Zampini } 581971015bcSStefano Zampini if (ts->rhsjacobian.scale != 1.) { 582971015bcSStefano Zampini ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 583971015bcSStefano Zampini } 584971015bcSStefano Zampini } 585971015bcSStefano Zampini if (B && B == ts->Brhs && A != B) { 586971015bcSStefano Zampini if (ts->rhsjacobian.shift != 0) { 587971015bcSStefano Zampini ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 588971015bcSStefano Zampini } 589971015bcSStefano Zampini if (ts->rhsjacobian.scale != 1.) { 590971015bcSStefano Zampini ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 591971015bcSStefano Zampini } 592971015bcSStefano Zampini } 593971015bcSStefano Zampini ts->rhsjacobian.shift = 0; 594971015bcSStefano Zampini ts->rhsjacobian.scale = 1.; 5950e4ef248SJed Brown PetscFunctionReturn(0); 596f8ede8e7SJed Brown } 597d90be118SSean Farley 598ce94432eSBarry Smith if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 599d90be118SSean Farley 600e1244c69SJed Brown if (ts->rhsjacobian.reuse) { 601971015bcSStefano Zampini if (A == ts->Arhs) { 602971015bcSStefano Zampini /* MatScale has a short path for this case. 603971015bcSStefano Zampini However, this code path is taken the first time TSComputeRHSJacobian is called 604971015bcSStefano Zampini and the matrices have not assembled yet */ 605971015bcSStefano Zampini if (ts->rhsjacobian.shift != 0) { 60694ab13aaSBarry Smith ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 607971015bcSStefano Zampini } 608971015bcSStefano Zampini if (ts->rhsjacobian.scale != 1.) { 60994ab13aaSBarry Smith ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 610971015bcSStefano Zampini } 611971015bcSStefano Zampini } 612971015bcSStefano Zampini if (B && B == ts->Brhs && A != B) { 613971015bcSStefano Zampini if (ts->rhsjacobian.shift != 0) { 61494ab13aaSBarry Smith ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 615971015bcSStefano Zampini } 616971015bcSStefano Zampini if (ts->rhsjacobian.scale != 1.) { 61794ab13aaSBarry Smith ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr); 618e1244c69SJed Brown } 619971015bcSStefano Zampini } 620e1244c69SJed Brown } 621e1244c69SJed Brown 62224989b8cSPeter Brune if (rhsjacobianfunc) { 6236cd88445SBarry Smith PetscBool missing; 62494ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 625a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 626d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 627a7a1495cSBarry Smith PetscStackPop; 62894ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 6296cd88445SBarry Smith if (A) { 6306cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 6316cd88445SBarry 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"); 6326cd88445SBarry Smith } 6336cd88445SBarry Smith if (B && B != A) { 6346cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 6356cd88445SBarry 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"); 6366cd88445SBarry Smith } 637ef66eb69SBarry Smith } else { 63894ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 639971015bcSStefano Zampini if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 640ef66eb69SBarry Smith } 6410e4ef248SJed Brown ts->rhsjacobian.time = t; 642971015bcSStefano Zampini ts->rhsjacobian.shift = 0; 643971015bcSStefano Zampini ts->rhsjacobian.scale = 1.; 6447f79407eSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr); 64559e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 646a7a1495cSBarry Smith PetscFunctionReturn(0); 647a7a1495cSBarry Smith } 648a7a1495cSBarry Smith 649316643e7SJed Brown /*@ 650d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 651d763cef2SBarry Smith 652316643e7SJed Brown Collective on TS and Vec 653316643e7SJed Brown 654316643e7SJed Brown Input Parameters: 655316643e7SJed Brown + ts - the TS context 656316643e7SJed Brown . t - current time 6570910c330SBarry Smith - U - state vector 658316643e7SJed Brown 659316643e7SJed Brown Output Parameter: 660316643e7SJed Brown . y - right hand side 661316643e7SJed Brown 662316643e7SJed Brown Note: 663316643e7SJed Brown Most users should not need to explicitly call this routine, as it 664316643e7SJed Brown is used internally within the nonlinear solvers. 665316643e7SJed Brown 666316643e7SJed Brown Level: developer 667316643e7SJed Brown 668316643e7SJed Brown .keywords: TS, compute 669316643e7SJed Brown 670316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 671316643e7SJed Brown @*/ 6720910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 673d763cef2SBarry Smith { 674dfbe8321SBarry Smith PetscErrorCode ierr; 67524989b8cSPeter Brune TSRHSFunction rhsfunction; 67624989b8cSPeter Brune TSIFunction ifunction; 67724989b8cSPeter Brune void *ctx; 67824989b8cSPeter Brune DM dm; 67924989b8cSPeter Brune 680d763cef2SBarry Smith PetscFunctionBegin; 6810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6820910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6830700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 68424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 68524989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6860298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 687d763cef2SBarry Smith 688ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 689d763cef2SBarry Smith 6900910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 69124989b8cSPeter Brune if (rhsfunction) { 692d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6930910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 694d763cef2SBarry Smith PetscStackPop; 695214bc6a2SJed Brown } else { 696214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 697b2cd27e8SJed Brown } 69844a41b28SSean Farley 6990910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 700d763cef2SBarry Smith PetscFunctionReturn(0); 701d763cef2SBarry Smith } 702d763cef2SBarry Smith 703ef20d060SBarry Smith /*@ 704ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 705ef20d060SBarry Smith 706ef20d060SBarry Smith Collective on TS and Vec 707ef20d060SBarry Smith 708ef20d060SBarry Smith Input Parameters: 709ef20d060SBarry Smith + ts - the TS context 710ef20d060SBarry Smith - t - current time 711ef20d060SBarry Smith 712ef20d060SBarry Smith Output Parameter: 7130910c330SBarry Smith . U - the solution 714ef20d060SBarry Smith 715ef20d060SBarry Smith Note: 716ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 717ef20d060SBarry Smith is used internally within the nonlinear solvers. 718ef20d060SBarry Smith 719ef20d060SBarry Smith Level: developer 720ef20d060SBarry Smith 721ef20d060SBarry Smith .keywords: TS, compute 722ef20d060SBarry Smith 723abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 724ef20d060SBarry Smith @*/ 7250910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 726ef20d060SBarry Smith { 727ef20d060SBarry Smith PetscErrorCode ierr; 728ef20d060SBarry Smith TSSolutionFunction solutionfunction; 729ef20d060SBarry Smith void *ctx; 730ef20d060SBarry Smith DM dm; 731ef20d060SBarry Smith 732ef20d060SBarry Smith PetscFunctionBegin; 733ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7340910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 735ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 736ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 737ef20d060SBarry Smith 738ef20d060SBarry Smith if (solutionfunction) { 7399b7cd975SBarry Smith PetscStackPush("TS user solution function"); 7400910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 741ef20d060SBarry Smith PetscStackPop; 742ef20d060SBarry Smith } 743ef20d060SBarry Smith PetscFunctionReturn(0); 744ef20d060SBarry Smith } 7459b7cd975SBarry Smith /*@ 7469b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 7479b7cd975SBarry Smith 7489b7cd975SBarry Smith Collective on TS and Vec 7499b7cd975SBarry Smith 7509b7cd975SBarry Smith Input Parameters: 7519b7cd975SBarry Smith + ts - the TS context 7529b7cd975SBarry Smith - t - current time 7539b7cd975SBarry Smith 7549b7cd975SBarry Smith Output Parameter: 7559b7cd975SBarry Smith . U - the function value 7569b7cd975SBarry Smith 7579b7cd975SBarry Smith Note: 7589b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 7599b7cd975SBarry Smith is used internally within the nonlinear solvers. 7609b7cd975SBarry Smith 7619b7cd975SBarry Smith Level: developer 7629b7cd975SBarry Smith 7639b7cd975SBarry Smith .keywords: TS, compute 7649b7cd975SBarry Smith 7659b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 7669b7cd975SBarry Smith @*/ 7679b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 7689b7cd975SBarry Smith { 7699b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 7709b7cd975SBarry Smith void *ctx; 7719b7cd975SBarry Smith DM dm; 7729b7cd975SBarry Smith 7739b7cd975SBarry Smith PetscFunctionBegin; 7749b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7759b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7769b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7779b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7789b7cd975SBarry Smith 7799b7cd975SBarry Smith if (forcing) { 7809b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7819b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7829b7cd975SBarry Smith PetscStackPop; 7839b7cd975SBarry Smith } 7849b7cd975SBarry Smith PetscFunctionReturn(0); 7859b7cd975SBarry Smith } 786ef20d060SBarry Smith 787214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 788214bc6a2SJed Brown { 7892dd45cf8SJed Brown Vec F; 790214bc6a2SJed Brown PetscErrorCode ierr; 791214bc6a2SJed Brown 792214bc6a2SJed Brown PetscFunctionBegin; 7930298fd71SBarry Smith *Frhs = NULL; 7940298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 795214bc6a2SJed Brown if (!ts->Frhs) { 7962dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 797214bc6a2SJed Brown } 798214bc6a2SJed Brown *Frhs = ts->Frhs; 799214bc6a2SJed Brown PetscFunctionReturn(0); 800214bc6a2SJed Brown } 801214bc6a2SJed Brown 802971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 803214bc6a2SJed Brown { 804214bc6a2SJed Brown Mat A,B; 8052dd45cf8SJed Brown PetscErrorCode ierr; 80641a1d4d2SBarry Smith TSIJacobian ijacobian; 807214bc6a2SJed Brown 808214bc6a2SJed Brown PetscFunctionBegin; 809c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 810c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 81141a1d4d2SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 812214bc6a2SJed Brown if (Arhs) { 813214bc6a2SJed Brown if (!ts->Arhs) { 81441a1d4d2SBarry Smith if (ijacobian) { 815214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 81641a1d4d2SBarry Smith } else { 81741a1d4d2SBarry Smith ts->Arhs = A; 81841a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 81941a1d4d2SBarry Smith } 8203565c898SBarry Smith } else { 8213565c898SBarry Smith PetscBool flg; 8223565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 8233565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 8243565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 8253565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 8263565c898SBarry Smith ts->Arhs = A; 8273565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 8283565c898SBarry Smith } 829214bc6a2SJed Brown } 830214bc6a2SJed Brown *Arhs = ts->Arhs; 831214bc6a2SJed Brown } 832214bc6a2SJed Brown if (Brhs) { 833214bc6a2SJed Brown if (!ts->Brhs) { 834bdb70873SJed Brown if (A != B) { 83541a1d4d2SBarry Smith if (ijacobian) { 836214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 837bdb70873SJed Brown } else { 83841a1d4d2SBarry Smith ts->Brhs = B; 83941a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 84041a1d4d2SBarry Smith } 84141a1d4d2SBarry Smith } else { 842bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 84351699248SLisandro Dalcin ts->Brhs = ts->Arhs; 844bdb70873SJed Brown } 845214bc6a2SJed Brown } 846214bc6a2SJed Brown *Brhs = ts->Brhs; 847214bc6a2SJed Brown } 848214bc6a2SJed Brown PetscFunctionReturn(0); 849214bc6a2SJed Brown } 850214bc6a2SJed Brown 851316643e7SJed Brown /*@ 8520910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 853316643e7SJed Brown 854316643e7SJed Brown Collective on TS and Vec 855316643e7SJed Brown 856316643e7SJed Brown Input Parameters: 857316643e7SJed Brown + ts - the TS context 858316643e7SJed Brown . t - current time 8590910c330SBarry Smith . U - state vector 8600910c330SBarry Smith . Udot - time derivative of state vector 861214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 862316643e7SJed Brown 863316643e7SJed Brown Output Parameter: 864316643e7SJed Brown . Y - right hand side 865316643e7SJed Brown 866316643e7SJed Brown Note: 867316643e7SJed Brown Most users should not need to explicitly call this routine, as it 868316643e7SJed Brown is used internally within the nonlinear solvers. 869316643e7SJed Brown 870316643e7SJed Brown If the user did did not write their equations in implicit form, this 871316643e7SJed Brown function recasts them in implicit form. 872316643e7SJed Brown 873316643e7SJed Brown Level: developer 874316643e7SJed Brown 875316643e7SJed Brown .keywords: TS, compute 876316643e7SJed Brown 877316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 878316643e7SJed Brown @*/ 8790910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 880316643e7SJed Brown { 881316643e7SJed Brown PetscErrorCode ierr; 88224989b8cSPeter Brune TSIFunction ifunction; 88324989b8cSPeter Brune TSRHSFunction rhsfunction; 88424989b8cSPeter Brune void *ctx; 88524989b8cSPeter Brune DM dm; 886316643e7SJed Brown 887316643e7SJed Brown PetscFunctionBegin; 8880700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8890910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8900910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8910700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 892316643e7SJed Brown 89324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 89424989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8950298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 89624989b8cSPeter Brune 897ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 898d90be118SSean Farley 8990910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 90024989b8cSPeter Brune if (ifunction) { 901316643e7SJed Brown PetscStackPush("TS user implicit function"); 9020910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 903316643e7SJed Brown PetscStackPop; 904214bc6a2SJed Brown } 905214bc6a2SJed Brown if (imex) { 90624989b8cSPeter Brune if (!ifunction) { 9070910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 9082dd45cf8SJed Brown } 90924989b8cSPeter Brune } else if (rhsfunction) { 91024989b8cSPeter Brune if (ifunction) { 911214bc6a2SJed Brown Vec Frhs; 912214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 9130910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 914214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 9152dd45cf8SJed Brown } else { 9160910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 9170910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 918316643e7SJed Brown } 9194a6899ffSJed Brown } 9200910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 921316643e7SJed Brown PetscFunctionReturn(0); 922316643e7SJed Brown } 923316643e7SJed Brown 924316643e7SJed Brown /*@ 925316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 926316643e7SJed Brown 927316643e7SJed Brown Collective on TS and Vec 928316643e7SJed Brown 929316643e7SJed Brown Input 930316643e7SJed Brown Input Parameters: 931316643e7SJed Brown + ts - the TS context 932316643e7SJed Brown . t - current timestep 9330910c330SBarry Smith . U - state vector 9340910c330SBarry Smith . Udot - time derivative of state vector 935214bc6a2SJed Brown . shift - shift to apply, see note below 936214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 937316643e7SJed Brown 938316643e7SJed Brown Output Parameters: 939316643e7SJed Brown + A - Jacobian matrix 9403565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 941316643e7SJed Brown 942316643e7SJed Brown Notes: 9430910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 944316643e7SJed Brown 9450910c330SBarry Smith dF/dU + shift*dF/dUdot 946316643e7SJed Brown 947316643e7SJed Brown Most users should not need to explicitly call this routine, as it 948316643e7SJed Brown is used internally within the nonlinear solvers. 949316643e7SJed Brown 950316643e7SJed Brown Level: developer 951316643e7SJed Brown 952316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix 953316643e7SJed Brown 954316643e7SJed Brown .seealso: TSSetIJacobian() 95563495f91SJed Brown @*/ 956d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 957316643e7SJed Brown { 958316643e7SJed Brown PetscErrorCode ierr; 95924989b8cSPeter Brune TSIJacobian ijacobian; 96024989b8cSPeter Brune TSRHSJacobian rhsjacobian; 96124989b8cSPeter Brune DM dm; 96224989b8cSPeter Brune void *ctx; 963316643e7SJed Brown 964316643e7SJed Brown PetscFunctionBegin; 9650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9660910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9670910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 968316643e7SJed Brown PetscValidPointer(A,6); 96994ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 970316643e7SJed Brown PetscValidPointer(B,7); 97194ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 97224989b8cSPeter Brune 97324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 97424989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9750298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 97624989b8cSPeter Brune 977ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 978316643e7SJed Brown 97994ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 98024989b8cSPeter Brune if (ijacobian) { 9816cd88445SBarry Smith PetscBool missing; 982316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 983d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 984316643e7SJed Brown PetscStackPop; 9856cd88445SBarry Smith ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr); 9866cd88445SBarry 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"); 9873565c898SBarry Smith if (B != A) { 9886cd88445SBarry Smith ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr); 9896cd88445SBarry 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"); 9906cd88445SBarry Smith } 9914a6899ffSJed Brown } 992214bc6a2SJed Brown if (imex) { 993b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9944c26be97Sstefano_zampini PetscBool assembled; 995971015bcSStefano Zampini if (rhsjacobian) { 996971015bcSStefano Zampini Mat Arhs = NULL; 997971015bcSStefano Zampini ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr); 998971015bcSStefano Zampini if (A == Arhs) { 999971015bcSStefano Zampini if (rhsjacobian == TSComputeRHSJacobianConstant) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Unsupported operation! cannot use TSComputeRHSJacobianConstant"); 1000971015bcSStefano Zampini ts->rhsjacobian.time = PETSC_MIN_REAL; 1001971015bcSStefano Zampini } 1002971015bcSStefano Zampini } 100394ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 10044c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 10054c26be97Sstefano_zampini if (!assembled) { 10064c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 10074c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 10084c26be97Sstefano_zampini } 100994ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 101094ab13aaSBarry Smith if (A != B) { 101194ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 10124c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 10134c26be97Sstefano_zampini if (!assembled) { 10144c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 10154c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 10164c26be97Sstefano_zampini } 101794ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1018214bc6a2SJed Brown } 1019214bc6a2SJed Brown } 1020214bc6a2SJed Brown } else { 1021e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 1022e1244c69SJed Brown if (rhsjacobian) { 1023214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 1024d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 1025e1244c69SJed Brown } 102694ab13aaSBarry Smith if (Arhs == A) { /* No IJacobian, so we only have the RHS matrix */ 10273565c898SBarry Smith PetscBool flg; 1028e1244c69SJed Brown ts->rhsjacobian.scale = -1; 1029e1244c69SJed Brown ts->rhsjacobian.shift = shift; 10303565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 10313565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 10323565c898SBarry Smith if (!flg) { 103394ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 103494ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 10353565c898SBarry Smith } 103694ab13aaSBarry Smith if (A != B) { 103794ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 103894ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1039316643e7SJed Brown } 1040e1244c69SJed Brown } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 1041e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1042e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 104394ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 104494ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 104594ab13aaSBarry Smith if (A != B) { 104694ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 104794ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1048214bc6a2SJed Brown } 1049316643e7SJed Brown } 105094ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 105194ab13aaSBarry Smith if (A != B) { 105294ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 1053316643e7SJed Brown } 1054316643e7SJed Brown } 1055316643e7SJed Brown } 105694ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 1057316643e7SJed Brown PetscFunctionReturn(0); 1058316643e7SJed Brown } 1059316643e7SJed Brown 1060d763cef2SBarry Smith /*@C 1061d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1062b5abc632SBarry Smith where U_t = G(t,u). 1063d763cef2SBarry Smith 10643f9fe445SBarry Smith Logically Collective on TS 1065d763cef2SBarry Smith 1066d763cef2SBarry Smith Input Parameters: 1067d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10680298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1069d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1070d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10710298fd71SBarry Smith function evaluation routine (may be NULL) 1072d763cef2SBarry Smith 1073d763cef2SBarry Smith Calling sequence of func: 107487828ca2SBarry Smith $ func (TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1075d763cef2SBarry Smith 1076d763cef2SBarry Smith + t - current timestep 1077d763cef2SBarry Smith . u - input vector 1078d763cef2SBarry Smith . F - function vector 1079d763cef2SBarry Smith - ctx - [optional] user-defined function context 1080d763cef2SBarry Smith 1081d763cef2SBarry Smith Level: beginner 1082d763cef2SBarry Smith 108395452b02SPatrick Sanan Notes: 108495452b02SPatrick Sanan You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10852bbac0d3SBarry Smith 1086d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1087d763cef2SBarry Smith 1088ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1089d763cef2SBarry Smith @*/ 1090089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1091d763cef2SBarry Smith { 1092089b2837SJed Brown PetscErrorCode ierr; 1093089b2837SJed Brown SNES snes; 10940298fd71SBarry Smith Vec ralloc = NULL; 109524989b8cSPeter Brune DM dm; 1096d763cef2SBarry Smith 1097089b2837SJed Brown PetscFunctionBegin; 10980700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1099ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 110024989b8cSPeter Brune 110124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 110224989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1103089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1104e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1105e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1106e856ceecSJed Brown r = ralloc; 1107e856ceecSJed Brown } 1108089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1109e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1110d763cef2SBarry Smith PetscFunctionReturn(0); 1111d763cef2SBarry Smith } 1112d763cef2SBarry Smith 1113ef20d060SBarry Smith /*@C 1114abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1115ef20d060SBarry Smith 1116ef20d060SBarry Smith Logically Collective on TS 1117ef20d060SBarry Smith 1118ef20d060SBarry Smith Input Parameters: 1119ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1120ef20d060SBarry Smith . f - routine for evaluating the solution 1121ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 11220298fd71SBarry Smith function evaluation routine (may be NULL) 1123ef20d060SBarry Smith 1124ef20d060SBarry Smith Calling sequence of func: 1125ef20d060SBarry Smith $ func (TS ts,PetscReal t,Vec u,void *ctx); 1126ef20d060SBarry Smith 1127ef20d060SBarry Smith + t - current timestep 1128ef20d060SBarry Smith . u - output vector 1129ef20d060SBarry Smith - ctx - [optional] user-defined function context 1130ef20d060SBarry Smith 11310ed3bfb6SBarry Smith Options Database: 11320ed3bfb6SBarry Smith + -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction() 11330ed3bfb6SBarry Smith - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 11340ed3bfb6SBarry Smith 1135abd5a294SJed Brown Notes: 1136abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1137abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1138abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1139abd5a294SJed Brown 11404f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1141abd5a294SJed Brown 1142ef20d060SBarry Smith Level: beginner 1143ef20d060SBarry Smith 1144ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 1145ef20d060SBarry Smith 11460ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError() 1147ef20d060SBarry Smith @*/ 1148ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1149ef20d060SBarry Smith { 1150ef20d060SBarry Smith PetscErrorCode ierr; 1151ef20d060SBarry Smith DM dm; 1152ef20d060SBarry Smith 1153ef20d060SBarry Smith PetscFunctionBegin; 1154ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1155ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1156ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1157ef20d060SBarry Smith PetscFunctionReturn(0); 1158ef20d060SBarry Smith } 1159ef20d060SBarry Smith 11609b7cd975SBarry Smith /*@C 11619b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 11629b7cd975SBarry Smith 11639b7cd975SBarry Smith Logically Collective on TS 11649b7cd975SBarry Smith 11659b7cd975SBarry Smith Input Parameters: 11669b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1167e162b725SBarry Smith . func - routine for evaluating the forcing function 11689b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11690298fd71SBarry Smith function evaluation routine (may be NULL) 11709b7cd975SBarry Smith 11719b7cd975SBarry Smith Calling sequence of func: 1172e162b725SBarry Smith $ func (TS ts,PetscReal t,Vec f,void *ctx); 11739b7cd975SBarry Smith 11749b7cd975SBarry Smith + t - current timestep 1175e162b725SBarry Smith . f - output vector 11769b7cd975SBarry Smith - ctx - [optional] user-defined function context 11779b7cd975SBarry Smith 11789b7cd975SBarry Smith Notes: 11799b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1180e162b725SBarry 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 1181e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1182e162b725SBarry Smith 1183e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1184e162b725SBarry Smith 1185e162b725SBarry 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 1186e162b725SBarry Smith parameters can be passed in the ctx variable. 11879b7cd975SBarry Smith 11889b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11899b7cd975SBarry Smith 11909b7cd975SBarry Smith Level: beginner 11919b7cd975SBarry Smith 11929b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function 11939b7cd975SBarry Smith 11949b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11959b7cd975SBarry Smith @*/ 1196e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11979b7cd975SBarry Smith { 11989b7cd975SBarry Smith PetscErrorCode ierr; 11999b7cd975SBarry Smith DM dm; 12009b7cd975SBarry Smith 12019b7cd975SBarry Smith PetscFunctionBegin; 12029b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 12039b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1204e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 12059b7cd975SBarry Smith PetscFunctionReturn(0); 12069b7cd975SBarry Smith } 12079b7cd975SBarry Smith 1208d763cef2SBarry Smith /*@C 1209f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1210b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1211d763cef2SBarry Smith 12123f9fe445SBarry Smith Logically Collective on TS 1213d763cef2SBarry Smith 1214d763cef2SBarry Smith Input Parameters: 1215d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1216e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1217e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1218d763cef2SBarry Smith . f - the Jacobian evaluation routine 1219d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 12200298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1221d763cef2SBarry Smith 1222f7ab8db6SBarry Smith Calling sequence of f: 1223ae8867d6SBarry Smith $ func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1224d763cef2SBarry Smith 1225d763cef2SBarry Smith + t - current timestep 1226d763cef2SBarry Smith . u - input vector 1227e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1228e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1229d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1230d763cef2SBarry Smith 12316cd88445SBarry Smith Notes: 12326cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 12336cd88445SBarry Smith 12346cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1235ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1236d763cef2SBarry Smith 1237d763cef2SBarry Smith Level: beginner 1238d763cef2SBarry Smith 1239d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian 1240d763cef2SBarry Smith 1241ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1242d763cef2SBarry Smith 1243d763cef2SBarry Smith @*/ 1244e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1245d763cef2SBarry Smith { 1246277b19d0SLisandro Dalcin PetscErrorCode ierr; 1247089b2837SJed Brown SNES snes; 124824989b8cSPeter Brune DM dm; 124924989b8cSPeter Brune TSIJacobian ijacobian; 1250277b19d0SLisandro Dalcin 1251d763cef2SBarry Smith PetscFunctionBegin; 12520700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1253e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1254e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1255e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1256e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1257d763cef2SBarry Smith 125824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 125924989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 1260e1244c69SJed Brown if (f == TSComputeRHSJacobianConstant) { 1261e1244c69SJed Brown /* Handle this case automatically for the user; otherwise user should call themselves. */ 1262e1244c69SJed Brown ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr); 1263e1244c69SJed Brown } 12640298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1265089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12665f659677SPeter Brune if (!ijacobian) { 1267e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12680e4ef248SJed Brown } 1269e5d3d808SBarry Smith if (Amat) { 1270e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12710e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1272e5d3d808SBarry Smith ts->Arhs = Amat; 12730e4ef248SJed Brown } 1274e5d3d808SBarry Smith if (Pmat) { 1275e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12760e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1277e5d3d808SBarry Smith ts->Brhs = Pmat; 12780e4ef248SJed Brown } 1279d763cef2SBarry Smith PetscFunctionReturn(0); 1280d763cef2SBarry Smith } 1281d763cef2SBarry Smith 1282316643e7SJed Brown /*@C 1283b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1284316643e7SJed Brown 12853f9fe445SBarry Smith Logically Collective on TS 1286316643e7SJed Brown 1287316643e7SJed Brown Input Parameters: 1288316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12890298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1290316643e7SJed Brown . f - the function evaluation routine 12910298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1292316643e7SJed Brown 1293316643e7SJed Brown Calling sequence of f: 1294316643e7SJed Brown $ f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1295316643e7SJed Brown 1296316643e7SJed Brown + t - time at step/stage being solved 1297316643e7SJed Brown . u - state vector 1298316643e7SJed Brown . u_t - time derivative of state vector 1299316643e7SJed Brown . F - function vector 1300316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1301316643e7SJed Brown 1302316643e7SJed Brown Important: 13032bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1304316643e7SJed Brown 1305316643e7SJed Brown Level: beginner 1306316643e7SJed Brown 1307316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian 1308316643e7SJed Brown 1309d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1310316643e7SJed Brown @*/ 131151699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1312316643e7SJed Brown { 1313089b2837SJed Brown PetscErrorCode ierr; 1314089b2837SJed Brown SNES snes; 131551699248SLisandro Dalcin Vec ralloc = NULL; 131624989b8cSPeter Brune DM dm; 1317316643e7SJed Brown 1318316643e7SJed Brown PetscFunctionBegin; 13190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 132051699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 132124989b8cSPeter Brune 132224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 132324989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 132424989b8cSPeter Brune 1325089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 132651699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 132751699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 132851699248SLisandro Dalcin r = ralloc; 1329e856ceecSJed Brown } 133051699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 133151699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1332089b2837SJed Brown PetscFunctionReturn(0); 1333089b2837SJed Brown } 1334089b2837SJed Brown 1335089b2837SJed Brown /*@C 1336089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1337089b2837SJed Brown 1338089b2837SJed Brown Not Collective 1339089b2837SJed Brown 1340089b2837SJed Brown Input Parameter: 1341089b2837SJed Brown . ts - the TS context 1342089b2837SJed Brown 1343089b2837SJed Brown Output Parameter: 13440298fd71SBarry Smith + r - vector to hold residual (or NULL) 13450298fd71SBarry Smith . func - the function to compute residual (or NULL) 13460298fd71SBarry Smith - ctx - the function context (or NULL) 1347089b2837SJed Brown 1348089b2837SJed Brown Level: advanced 1349089b2837SJed Brown 1350089b2837SJed Brown .keywords: TS, nonlinear, get, function 1351089b2837SJed Brown 1352089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1353089b2837SJed Brown @*/ 1354089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1355089b2837SJed Brown { 1356089b2837SJed Brown PetscErrorCode ierr; 1357089b2837SJed Brown SNES snes; 135824989b8cSPeter Brune DM dm; 1359089b2837SJed Brown 1360089b2837SJed Brown PetscFunctionBegin; 1361089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1362089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13630298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 136424989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 136524989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1366089b2837SJed Brown PetscFunctionReturn(0); 1367089b2837SJed Brown } 1368089b2837SJed Brown 1369089b2837SJed Brown /*@C 1370089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1371089b2837SJed Brown 1372089b2837SJed Brown Not Collective 1373089b2837SJed Brown 1374089b2837SJed Brown Input Parameter: 1375089b2837SJed Brown . ts - the TS context 1376089b2837SJed Brown 1377089b2837SJed Brown Output Parameter: 13780298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13790298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13800298fd71SBarry Smith - ctx - the function context (or NULL) 1381089b2837SJed Brown 1382089b2837SJed Brown Level: advanced 1383089b2837SJed Brown 1384089b2837SJed Brown .keywords: TS, nonlinear, get, function 1385089b2837SJed Brown 13862bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1387089b2837SJed Brown @*/ 1388089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1389089b2837SJed Brown { 1390089b2837SJed Brown PetscErrorCode ierr; 1391089b2837SJed Brown SNES snes; 139224989b8cSPeter Brune DM dm; 1393089b2837SJed Brown 1394089b2837SJed Brown PetscFunctionBegin; 1395089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1396089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13970298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 139824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 139924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1400316643e7SJed Brown PetscFunctionReturn(0); 1401316643e7SJed Brown } 1402316643e7SJed Brown 1403316643e7SJed Brown /*@C 1404a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1405ae8867d6SBarry Smith provided with TSSetIFunction(). 1406316643e7SJed Brown 14073f9fe445SBarry Smith Logically Collective on TS 1408316643e7SJed Brown 1409316643e7SJed Brown Input Parameters: 1410316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1411e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1412e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1413316643e7SJed Brown . f - the Jacobian evaluation routine 14140298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1415316643e7SJed Brown 1416316643e7SJed Brown Calling sequence of f: 1417ae8867d6SBarry Smith $ f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1418316643e7SJed Brown 1419316643e7SJed Brown + t - time at step/stage being solved 14201b4a444bSJed Brown . U - state vector 14211b4a444bSJed Brown . U_t - time derivative of state vector 1422316643e7SJed Brown . a - shift 1423e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1424e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1425316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1426316643e7SJed Brown 1427316643e7SJed Brown Notes: 1428e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1429316643e7SJed Brown 1430895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1431895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1432895c21f2SBarry Smith 1433a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1434b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1435a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1436a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1437a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1438a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1439a4f0a591SBarry Smith 14406cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 14416cd88445SBarry Smith 14426cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1443ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1444ca5f011dSBarry Smith 1445316643e7SJed Brown Level: beginner 1446316643e7SJed Brown 1447316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian 1448316643e7SJed Brown 1449ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1450316643e7SJed Brown 1451316643e7SJed Brown @*/ 1452e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1453316643e7SJed Brown { 1454316643e7SJed Brown PetscErrorCode ierr; 1455089b2837SJed Brown SNES snes; 145624989b8cSPeter Brune DM dm; 1457316643e7SJed Brown 1458316643e7SJed Brown PetscFunctionBegin; 14590700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1460e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1461e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1462e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1463e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 146424989b8cSPeter Brune 146524989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 146624989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 146724989b8cSPeter Brune 1468089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1469e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1470316643e7SJed Brown PetscFunctionReturn(0); 1471316643e7SJed Brown } 1472316643e7SJed Brown 1473e1244c69SJed Brown /*@ 1474e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1475e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1476e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1477e1244c69SJed Brown not been changed by the TS. 1478e1244c69SJed Brown 1479e1244c69SJed Brown Logically Collective 1480e1244c69SJed Brown 1481e1244c69SJed Brown Input Arguments: 1482e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1483e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1484e1244c69SJed Brown 1485e1244c69SJed Brown Level: intermediate 1486e1244c69SJed Brown 1487e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1488e1244c69SJed Brown @*/ 1489e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1490e1244c69SJed Brown { 1491e1244c69SJed Brown PetscFunctionBegin; 1492e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1493e1244c69SJed Brown PetscFunctionReturn(0); 1494e1244c69SJed Brown } 1495e1244c69SJed Brown 1496efe9872eSLisandro Dalcin /*@C 1497efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1498efe9872eSLisandro Dalcin 1499efe9872eSLisandro Dalcin Logically Collective on TS 1500efe9872eSLisandro Dalcin 1501efe9872eSLisandro Dalcin Input Parameters: 1502efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1503efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1504efe9872eSLisandro Dalcin . fun - the function evaluation routine 1505efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1506efe9872eSLisandro Dalcin 1507efe9872eSLisandro Dalcin Calling sequence of fun: 1508efe9872eSLisandro Dalcin $ fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1509efe9872eSLisandro Dalcin 1510efe9872eSLisandro Dalcin + t - time at step/stage being solved 1511efe9872eSLisandro Dalcin . U - state vector 1512efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1513efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1514efe9872eSLisandro Dalcin . F - function vector 1515efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1516efe9872eSLisandro Dalcin 1517efe9872eSLisandro Dalcin Level: beginner 1518efe9872eSLisandro Dalcin 1519efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function 1520efe9872eSLisandro Dalcin 1521efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1522efe9872eSLisandro Dalcin @*/ 1523efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1524efe9872eSLisandro Dalcin { 1525efe9872eSLisandro Dalcin DM dm; 1526efe9872eSLisandro Dalcin PetscErrorCode ierr; 1527efe9872eSLisandro Dalcin 1528efe9872eSLisandro Dalcin PetscFunctionBegin; 1529efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1530efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1531efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1532efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1533efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1534efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1535efe9872eSLisandro Dalcin } 1536efe9872eSLisandro Dalcin 1537efe9872eSLisandro Dalcin /*@C 1538efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1539efe9872eSLisandro Dalcin 1540efe9872eSLisandro Dalcin Not Collective 1541efe9872eSLisandro Dalcin 1542efe9872eSLisandro Dalcin Input Parameter: 1543efe9872eSLisandro Dalcin . ts - the TS context 1544efe9872eSLisandro Dalcin 1545efe9872eSLisandro Dalcin Output Parameter: 1546efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1547efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1548efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1549efe9872eSLisandro Dalcin 1550efe9872eSLisandro Dalcin Level: advanced 1551efe9872eSLisandro Dalcin 1552efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function 1553efe9872eSLisandro Dalcin 1554efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction() 1555efe9872eSLisandro Dalcin @*/ 1556efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1557efe9872eSLisandro Dalcin { 1558efe9872eSLisandro Dalcin PetscErrorCode ierr; 1559efe9872eSLisandro Dalcin SNES snes; 1560efe9872eSLisandro Dalcin DM dm; 1561efe9872eSLisandro Dalcin 1562efe9872eSLisandro Dalcin PetscFunctionBegin; 1563efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1564efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1565efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1566efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1567efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1568efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1569efe9872eSLisandro Dalcin } 1570efe9872eSLisandro Dalcin 1571efe9872eSLisandro Dalcin /*@C 1572bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1573efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1574efe9872eSLisandro Dalcin 1575efe9872eSLisandro Dalcin Logically Collective on TS 1576efe9872eSLisandro Dalcin 1577efe9872eSLisandro Dalcin Input Parameters: 1578efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1579efe9872eSLisandro Dalcin . J - Jacobian matrix 1580efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1581efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1582efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1583efe9872eSLisandro Dalcin 1584efe9872eSLisandro Dalcin Calling sequence of jac: 1585bc77d74cSLisandro Dalcin $ jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1586efe9872eSLisandro Dalcin 1587efe9872eSLisandro Dalcin + t - time at step/stage being solved 1588efe9872eSLisandro Dalcin . U - state vector 1589efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1590efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1591efe9872eSLisandro Dalcin . v - shift for U_t 1592efe9872eSLisandro Dalcin . a - shift for U_tt 1593efe9872eSLisandro 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 1594efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1595efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1596efe9872eSLisandro Dalcin 1597efe9872eSLisandro Dalcin Notes: 1598efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1599efe9872eSLisandro Dalcin 1600efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1601efe9872eSLisandro 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. 1602efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1603bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1604efe9872eSLisandro Dalcin 1605efe9872eSLisandro Dalcin Level: beginner 1606efe9872eSLisandro Dalcin 1607efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian 1608efe9872eSLisandro Dalcin 1609efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1610efe9872eSLisandro Dalcin @*/ 1611efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1612efe9872eSLisandro Dalcin { 1613efe9872eSLisandro Dalcin DM dm; 1614efe9872eSLisandro Dalcin PetscErrorCode ierr; 1615efe9872eSLisandro Dalcin 1616efe9872eSLisandro Dalcin PetscFunctionBegin; 1617efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1618efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1619efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1620efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1621efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1622efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1623efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1624efe9872eSLisandro Dalcin } 1625efe9872eSLisandro Dalcin 1626efe9872eSLisandro Dalcin /*@C 1627efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1628efe9872eSLisandro Dalcin 1629efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1630efe9872eSLisandro Dalcin 1631efe9872eSLisandro Dalcin Input Parameter: 1632efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1633efe9872eSLisandro Dalcin 1634efe9872eSLisandro Dalcin Output Parameters: 1635efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1636efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1637efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1638efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1639efe9872eSLisandro Dalcin 164095452b02SPatrick Sanan Notes: 164195452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 1642efe9872eSLisandro Dalcin 1643efe9872eSLisandro Dalcin Level: advanced 1644efe9872eSLisandro Dalcin 164580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 1646efe9872eSLisandro Dalcin 1647efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian 1648efe9872eSLisandro Dalcin @*/ 1649efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1650efe9872eSLisandro Dalcin { 1651efe9872eSLisandro Dalcin PetscErrorCode ierr; 1652efe9872eSLisandro Dalcin SNES snes; 1653efe9872eSLisandro Dalcin DM dm; 1654efe9872eSLisandro Dalcin 1655efe9872eSLisandro Dalcin PetscFunctionBegin; 1656efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1657efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1658efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1659efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1660efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1661efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1662efe9872eSLisandro Dalcin } 1663efe9872eSLisandro Dalcin 1664efe9872eSLisandro Dalcin /*@ 1665efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1666efe9872eSLisandro Dalcin 1667efe9872eSLisandro Dalcin Collective on TS and Vec 1668efe9872eSLisandro Dalcin 1669efe9872eSLisandro Dalcin Input Parameters: 1670efe9872eSLisandro Dalcin + ts - the TS context 1671efe9872eSLisandro Dalcin . t - current time 1672efe9872eSLisandro Dalcin . U - state vector 1673efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1674efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1675efe9872eSLisandro Dalcin 1676efe9872eSLisandro Dalcin Output Parameter: 1677efe9872eSLisandro Dalcin . F - the residual vector 1678efe9872eSLisandro Dalcin 1679efe9872eSLisandro Dalcin Note: 1680efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1681efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1682efe9872eSLisandro Dalcin 1683efe9872eSLisandro Dalcin Level: developer 1684efe9872eSLisandro Dalcin 1685efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector 1686efe9872eSLisandro Dalcin 1687efe9872eSLisandro Dalcin .seealso: TSSetI2Function() 1688efe9872eSLisandro Dalcin @*/ 1689efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1690efe9872eSLisandro Dalcin { 1691efe9872eSLisandro Dalcin DM dm; 1692efe9872eSLisandro Dalcin TSI2Function I2Function; 1693efe9872eSLisandro Dalcin void *ctx; 1694efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1695efe9872eSLisandro Dalcin PetscErrorCode ierr; 1696efe9872eSLisandro Dalcin 1697efe9872eSLisandro Dalcin PetscFunctionBegin; 1698efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1699efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1700efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1701efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1702efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1703efe9872eSLisandro Dalcin 1704efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1705efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1706efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1707efe9872eSLisandro Dalcin 1708efe9872eSLisandro Dalcin if (!I2Function) { 1709efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1710efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1711efe9872eSLisandro Dalcin } 1712efe9872eSLisandro Dalcin 1713efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1714efe9872eSLisandro Dalcin 1715efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1716efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1717efe9872eSLisandro Dalcin PetscStackPop; 1718efe9872eSLisandro Dalcin 1719efe9872eSLisandro Dalcin if (rhsfunction) { 1720efe9872eSLisandro Dalcin Vec Frhs; 1721efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1722efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1723efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1724efe9872eSLisandro Dalcin } 1725efe9872eSLisandro Dalcin 1726efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1727efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1728efe9872eSLisandro Dalcin } 1729efe9872eSLisandro Dalcin 1730efe9872eSLisandro Dalcin /*@ 1731efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1732efe9872eSLisandro Dalcin 1733efe9872eSLisandro Dalcin Collective on TS and Vec 1734efe9872eSLisandro Dalcin 1735efe9872eSLisandro Dalcin Input Parameters: 1736efe9872eSLisandro Dalcin + ts - the TS context 1737efe9872eSLisandro Dalcin . t - current timestep 1738efe9872eSLisandro Dalcin . U - state vector 1739efe9872eSLisandro Dalcin . V - time derivative of state vector 1740efe9872eSLisandro Dalcin . A - second time derivative of state vector 1741efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1742efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1743efe9872eSLisandro Dalcin 1744efe9872eSLisandro Dalcin Output Parameters: 1745efe9872eSLisandro Dalcin + J - Jacobian matrix 1746efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1747efe9872eSLisandro Dalcin 1748efe9872eSLisandro Dalcin Notes: 1749efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1750efe9872eSLisandro Dalcin 1751efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1752efe9872eSLisandro Dalcin 1753efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1754efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1755efe9872eSLisandro Dalcin 1756efe9872eSLisandro Dalcin Level: developer 1757efe9872eSLisandro Dalcin 1758efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix 1759efe9872eSLisandro Dalcin 1760efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1761efe9872eSLisandro Dalcin @*/ 1762efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1763efe9872eSLisandro Dalcin { 1764efe9872eSLisandro Dalcin DM dm; 1765efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1766efe9872eSLisandro Dalcin void *ctx; 1767efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1768efe9872eSLisandro Dalcin PetscErrorCode ierr; 1769efe9872eSLisandro Dalcin 1770efe9872eSLisandro Dalcin PetscFunctionBegin; 1771efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1772efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1773efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1774efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1775efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1776efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1777efe9872eSLisandro Dalcin 1778efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1779efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1780efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1781efe9872eSLisandro Dalcin 1782efe9872eSLisandro Dalcin if (!I2Jacobian) { 1783efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1784efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1785efe9872eSLisandro Dalcin } 1786efe9872eSLisandro Dalcin 1787efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1788efe9872eSLisandro Dalcin 1789efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1790efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1791efe9872eSLisandro Dalcin PetscStackPop; 1792efe9872eSLisandro Dalcin 1793efe9872eSLisandro Dalcin if (rhsjacobian) { 1794efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1795efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1796efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1797efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1798efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1799efe9872eSLisandro Dalcin } 1800efe9872eSLisandro Dalcin 1801efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1802efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1803efe9872eSLisandro Dalcin } 1804efe9872eSLisandro Dalcin 1805efe9872eSLisandro Dalcin /*@ 1806efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1807efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1808efe9872eSLisandro Dalcin 1809efe9872eSLisandro Dalcin Logically Collective on TS and Vec 1810efe9872eSLisandro Dalcin 1811efe9872eSLisandro Dalcin Input Parameters: 1812efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1813efe9872eSLisandro Dalcin . u - the solution vector 1814efe9872eSLisandro Dalcin - v - the time derivative vector 1815efe9872eSLisandro Dalcin 1816efe9872eSLisandro Dalcin Level: beginner 1817efe9872eSLisandro Dalcin 1818efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions 1819efe9872eSLisandro Dalcin @*/ 1820efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1821efe9872eSLisandro Dalcin { 1822efe9872eSLisandro Dalcin PetscErrorCode ierr; 1823efe9872eSLisandro Dalcin 1824efe9872eSLisandro Dalcin PetscFunctionBegin; 1825efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1826efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1827efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1828efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1829efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1830efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1831efe9872eSLisandro Dalcin ts->vec_dot = v; 1832efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1833efe9872eSLisandro Dalcin } 1834efe9872eSLisandro Dalcin 1835efe9872eSLisandro Dalcin /*@ 1836efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1837efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1838efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1839efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1840efe9872eSLisandro Dalcin 1841efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1842efe9872eSLisandro Dalcin 1843efe9872eSLisandro Dalcin Input Parameter: 1844efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1845efe9872eSLisandro Dalcin 1846efe9872eSLisandro Dalcin Output Parameter: 1847efe9872eSLisandro Dalcin + u - the vector containing the solution 1848efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1849efe9872eSLisandro Dalcin 1850efe9872eSLisandro Dalcin Level: intermediate 1851efe9872eSLisandro Dalcin 1852efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1853efe9872eSLisandro Dalcin 1854efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution 1855efe9872eSLisandro Dalcin @*/ 1856efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1857efe9872eSLisandro Dalcin { 1858efe9872eSLisandro Dalcin PetscFunctionBegin; 1859efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1860efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1861efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1862efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1863efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1864efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1865efe9872eSLisandro Dalcin } 1866efe9872eSLisandro Dalcin 186755849f57SBarry Smith /*@C 186855849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 186955849f57SBarry Smith 187055849f57SBarry Smith Collective on PetscViewer 187155849f57SBarry Smith 187255849f57SBarry Smith Input Parameters: 187355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 187455849f57SBarry Smith some related function before a call to TSLoad(). 187555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 187655849f57SBarry Smith 187755849f57SBarry Smith Level: intermediate 187855849f57SBarry Smith 187955849f57SBarry Smith Notes: 188055849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 188155849f57SBarry Smith 188255849f57SBarry Smith Notes for advanced users: 188355849f57SBarry Smith Most users should not need to know the details of the binary storage 188455849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 188555849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 188655849f57SBarry Smith format is 188755849f57SBarry Smith .vb 188855849f57SBarry Smith has not yet been determined 188955849f57SBarry Smith .ve 189055849f57SBarry Smith 189155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 189255849f57SBarry Smith @*/ 1893f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 189455849f57SBarry Smith { 189555849f57SBarry Smith PetscErrorCode ierr; 189655849f57SBarry Smith PetscBool isbinary; 189755849f57SBarry Smith PetscInt classid; 189855849f57SBarry Smith char type[256]; 18992d53ad75SBarry Smith DMTS sdm; 1900ad6bc421SBarry Smith DM dm; 190155849f57SBarry Smith 190255849f57SBarry Smith PetscFunctionBegin; 1903f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 190455849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 190555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 190655849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 190755849f57SBarry Smith 1908060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1909ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1910060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1911f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1912f2c2a1b9SBarry Smith if (ts->ops->load) { 1913f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1914f2c2a1b9SBarry Smith } 1915ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1916ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1917ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1918f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1919f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 19202d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19212d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 192255849f57SBarry Smith PetscFunctionReturn(0); 192355849f57SBarry Smith } 192455849f57SBarry Smith 19259804daf3SBarry Smith #include <petscdraw.h> 1926e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1927e04113cfSBarry Smith #include <petscviewersaws.h> 1928f05ece33SBarry Smith #endif 19297e2c5f70SBarry Smith /*@C 1930d763cef2SBarry Smith TSView - Prints the TS data structure. 1931d763cef2SBarry Smith 19324c49b128SBarry Smith Collective on TS 1933d763cef2SBarry Smith 1934d763cef2SBarry Smith Input Parameters: 1935d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1936d763cef2SBarry Smith - viewer - visualization context 1937d763cef2SBarry Smith 1938d763cef2SBarry Smith Options Database Key: 1939d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 1940d763cef2SBarry Smith 1941d763cef2SBarry Smith Notes: 1942d763cef2SBarry Smith The available visualization contexts include 1943b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 1944b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 1945d763cef2SBarry Smith output where only the first processor opens 1946d763cef2SBarry Smith the file. All other processors send their 1947d763cef2SBarry Smith data to the first processor to print. 1948d763cef2SBarry Smith 1949d763cef2SBarry Smith The user can open an alternative visualization context with 1950b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 1951d763cef2SBarry Smith 1952d763cef2SBarry Smith Level: beginner 1953d763cef2SBarry Smith 1954d763cef2SBarry Smith .keywords: TS, timestep, view 1955d763cef2SBarry Smith 1956b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 1957d763cef2SBarry Smith @*/ 19587087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 1959d763cef2SBarry Smith { 1960dfbe8321SBarry Smith PetscErrorCode ierr; 196119fd82e9SBarry Smith TSType type; 19622b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 19632d53ad75SBarry Smith DMTS sdm; 1964e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1965536b137fSBarry Smith PetscBool issaws; 1966f05ece33SBarry Smith #endif 1967d763cef2SBarry Smith 1968d763cef2SBarry Smith PetscFunctionBegin; 19690700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 19703050cee2SBarry Smith if (!viewer) { 1971ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 19723050cee2SBarry Smith } 19730700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1974c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 1975fd16b177SBarry Smith 1976251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 1977251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 197855849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 19792b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 1980e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1981536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 1982f05ece33SBarry Smith #endif 198332077d6dSBarry Smith if (iascii) { 1984dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 1985efd4aadfSBarry Smith if (ts->ops->view) { 1986efd4aadfSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1987efd4aadfSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 1988efd4aadfSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1989efd4aadfSBarry Smith } 1990ef85077eSLisandro Dalcin if (ts->max_steps < PETSC_MAX_INT) { 199177431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 1992ef85077eSLisandro Dalcin } 1993ef85077eSLisandro Dalcin if (ts->max_time < PETSC_MAX_REAL) { 19947c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 1995ef85077eSLisandro Dalcin } 1996efd4aadfSBarry Smith if (ts->usessnes) { 1997efd4aadfSBarry Smith PetscBool lin; 1998d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 19995ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 2000d763cef2SBarry Smith } 20015ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 20021ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 2003efd4aadfSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr); 2004efd4aadfSBarry Smith } 2005193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 2006a0af407cSBarry Smith if (ts->vrtol) { 2007a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 2008a0af407cSBarry Smith } else { 2009a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 2010a0af407cSBarry Smith } 2011a0af407cSBarry Smith if (ts->vatol) { 2012a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 2013a0af407cSBarry Smith } else { 2014a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 2015a0af407cSBarry Smith } 2016825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2017efd4aadfSBarry Smith ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr); 2018825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2019825ab935SBarry Smith if (ts->snes && ts->usessnes) { 2020825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2021825ab935SBarry Smith ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr); 2022825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2023825ab935SBarry Smith } 20242d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 20252d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 20260f5bd95cSBarry Smith } else if (isstring) { 2027a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 2028b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr); 202955849f57SBarry Smith } else if (isbinary) { 203055849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 203155849f57SBarry Smith MPI_Comm comm; 203255849f57SBarry Smith PetscMPIInt rank; 203355849f57SBarry Smith char type[256]; 203455849f57SBarry Smith 203555849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 203655849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 203755849f57SBarry Smith if (!rank) { 203855849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 203955849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 204055849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 204155849f57SBarry Smith } 204255849f57SBarry Smith if (ts->ops->view) { 204355849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 204455849f57SBarry Smith } 2045efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2046f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 2047f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 20482d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 20492d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 20502b0a91c0SBarry Smith } else if (isdraw) { 20512b0a91c0SBarry Smith PetscDraw draw; 20522b0a91c0SBarry Smith char str[36]; 205389fd9fafSBarry Smith PetscReal x,y,bottom,h; 20542b0a91c0SBarry Smith 20552b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 20562b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 20572b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 20582b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 205951fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 206089fd9fafSBarry Smith bottom = y - h; 20612b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 20622b0a91c0SBarry Smith if (ts->ops->view) { 20632b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20642b0a91c0SBarry Smith } 2065efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2066efd4aadfSBarry Smith if (ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 20672b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2068e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2069536b137fSBarry Smith } else if (issaws) { 2070d45a07a7SBarry Smith PetscMPIInt rank; 20712657e9d9SBarry Smith const char *name; 20722657e9d9SBarry Smith 20732657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 2074d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 2075d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 2076d45a07a7SBarry Smith char dir[1024]; 2077d45a07a7SBarry Smith 2078e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 2079a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 20802657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 20812657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 20822657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2083d763cef2SBarry Smith } 20840acecf5bSBarry Smith if (ts->ops->view) { 20850acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 20860acecf5bSBarry Smith } 2087f05ece33SBarry Smith #endif 2088f05ece33SBarry Smith } 2089f05ece33SBarry Smith 2090b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2091251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2092b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2093d763cef2SBarry Smith PetscFunctionReturn(0); 2094d763cef2SBarry Smith } 2095d763cef2SBarry Smith 2096b07ff414SBarry Smith /*@ 2097d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2098d763cef2SBarry Smith the timesteppers. 2099d763cef2SBarry Smith 21003f9fe445SBarry Smith Logically Collective on TS 2101d763cef2SBarry Smith 2102d763cef2SBarry Smith Input Parameters: 2103d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2104d763cef2SBarry Smith - usrP - optional user context 2105d763cef2SBarry Smith 210695452b02SPatrick Sanan Fortran Notes: 210795452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2108daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2109daf670e6SBarry Smith 2110d763cef2SBarry Smith Level: intermediate 2111d763cef2SBarry Smith 2112d763cef2SBarry Smith .keywords: TS, timestep, set, application, context 2113d763cef2SBarry Smith 2114d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2115d763cef2SBarry Smith @*/ 21167087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2117d763cef2SBarry Smith { 2118d763cef2SBarry Smith PetscFunctionBegin; 21190700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2120d763cef2SBarry Smith ts->user = usrP; 2121d763cef2SBarry Smith PetscFunctionReturn(0); 2122d763cef2SBarry Smith } 2123d763cef2SBarry Smith 2124b07ff414SBarry Smith /*@ 2125d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2126d763cef2SBarry Smith timestepper. 2127d763cef2SBarry Smith 2128d763cef2SBarry Smith Not Collective 2129d763cef2SBarry Smith 2130d763cef2SBarry Smith Input Parameter: 2131d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2132d763cef2SBarry Smith 2133d763cef2SBarry Smith Output Parameter: 2134d763cef2SBarry Smith . usrP - user context 2135d763cef2SBarry Smith 213695452b02SPatrick Sanan Fortran Notes: 213795452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2138daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2139daf670e6SBarry Smith 2140d763cef2SBarry Smith Level: intermediate 2141d763cef2SBarry Smith 2142d763cef2SBarry Smith .keywords: TS, timestep, get, application, context 2143d763cef2SBarry Smith 2144d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2145d763cef2SBarry Smith @*/ 2146e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2147d763cef2SBarry Smith { 2148d763cef2SBarry Smith PetscFunctionBegin; 21490700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2150e71120c6SJed Brown *(void**)usrP = ts->user; 2151d763cef2SBarry Smith PetscFunctionReturn(0); 2152d763cef2SBarry Smith } 2153d763cef2SBarry Smith 2154d763cef2SBarry Smith /*@ 215580275a0aSLisandro Dalcin TSGetStepNumber - Gets the number of steps completed. 2156d763cef2SBarry Smith 2157d763cef2SBarry Smith Not Collective 2158d763cef2SBarry Smith 2159d763cef2SBarry Smith Input Parameter: 2160d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2161d763cef2SBarry Smith 2162d763cef2SBarry Smith Output Parameter: 216380275a0aSLisandro Dalcin . steps - number of steps completed so far 2164d763cef2SBarry Smith 2165d763cef2SBarry Smith Level: intermediate 2166d763cef2SBarry Smith 2167d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number 21689be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2169d763cef2SBarry Smith @*/ 217080275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps) 2171d763cef2SBarry Smith { 2172d763cef2SBarry Smith PetscFunctionBegin; 21730700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 217480275a0aSLisandro Dalcin PetscValidIntPointer(steps,2); 217580275a0aSLisandro Dalcin *steps = ts->steps; 217680275a0aSLisandro Dalcin PetscFunctionReturn(0); 217780275a0aSLisandro Dalcin } 217880275a0aSLisandro Dalcin 217980275a0aSLisandro Dalcin /*@ 218080275a0aSLisandro Dalcin TSSetStepNumber - Sets the number of steps completed. 218180275a0aSLisandro Dalcin 218280275a0aSLisandro Dalcin Logically Collective on TS 218380275a0aSLisandro Dalcin 218480275a0aSLisandro Dalcin Input Parameters: 218580275a0aSLisandro Dalcin + ts - the TS context 218680275a0aSLisandro Dalcin - steps - number of steps completed so far 218780275a0aSLisandro Dalcin 218880275a0aSLisandro Dalcin Notes: 218980275a0aSLisandro Dalcin For most uses of the TS solvers the user need not explicitly call 219080275a0aSLisandro Dalcin TSSetStepNumber(), as the step counter is appropriately updated in 219180275a0aSLisandro Dalcin TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to 219280275a0aSLisandro Dalcin reinitialize timestepping by setting the step counter to zero (and time 219380275a0aSLisandro Dalcin to the initial time) to solve a similar problem with different initial 219480275a0aSLisandro Dalcin conditions or parameters. Other possible use case is to continue 219580275a0aSLisandro Dalcin timestepping from a previously interrupted run in such a way that TS 219680275a0aSLisandro Dalcin monitors will be called with a initial nonzero step counter. 219780275a0aSLisandro Dalcin 219880275a0aSLisandro Dalcin Level: advanced 219980275a0aSLisandro Dalcin 220080275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number 220180275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution() 220280275a0aSLisandro Dalcin @*/ 220380275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps) 220480275a0aSLisandro Dalcin { 220580275a0aSLisandro Dalcin PetscFunctionBegin; 220680275a0aSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 220780275a0aSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,steps,2); 220880275a0aSLisandro Dalcin if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative"); 220980275a0aSLisandro Dalcin ts->steps = steps; 2210d763cef2SBarry Smith PetscFunctionReturn(0); 2211d763cef2SBarry Smith } 2212d763cef2SBarry Smith 2213d763cef2SBarry Smith /*@ 2214d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2215d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2216d763cef2SBarry Smith 22173f9fe445SBarry Smith Logically Collective on TS 2218d763cef2SBarry Smith 2219d763cef2SBarry Smith Input Parameters: 2220d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2221d763cef2SBarry Smith - time_step - the size of the timestep 2222d763cef2SBarry Smith 2223d763cef2SBarry Smith Level: intermediate 2224d763cef2SBarry Smith 2225aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime() 2226d763cef2SBarry Smith 2227d763cef2SBarry Smith .keywords: TS, set, timestep 2228d763cef2SBarry Smith @*/ 22297087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2230d763cef2SBarry Smith { 2231d763cef2SBarry Smith PetscFunctionBegin; 22320700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2233c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2234d763cef2SBarry Smith ts->time_step = time_step; 2235d763cef2SBarry Smith PetscFunctionReturn(0); 2236d763cef2SBarry Smith } 2237d763cef2SBarry Smith 2238a43b19c4SJed Brown /*@ 223949354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 224049354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 224149354f04SShri Abhyankar or just return at the final time TS computed. 2242a43b19c4SJed Brown 2243a43b19c4SJed Brown Logically Collective on TS 2244a43b19c4SJed Brown 2245a43b19c4SJed Brown Input Parameter: 2246a43b19c4SJed Brown + ts - the time-step context 224749354f04SShri Abhyankar - eftopt - exact final time option 2248a43b19c4SJed Brown 2249feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2250feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2251feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2252feed9e9dSBarry Smith 2253feed9e9dSBarry Smith Options Database: 2254feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2255feed9e9dSBarry Smith 2256ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2257ee346746SBarry Smith then the final time you selected. 2258ee346746SBarry Smith 2259a43b19c4SJed Brown Level: beginner 2260a43b19c4SJed Brown 2261f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime() 2262a43b19c4SJed Brown @*/ 226349354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2264a43b19c4SJed Brown { 2265a43b19c4SJed Brown PetscFunctionBegin; 2266a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 226749354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 226849354f04SShri Abhyankar ts->exact_final_time = eftopt; 2269a43b19c4SJed Brown PetscFunctionReturn(0); 2270a43b19c4SJed Brown } 2271a43b19c4SJed Brown 2272d763cef2SBarry Smith /*@ 2273f6953c82SLisandro Dalcin TSGetExactFinalTime - Gets the exact final time option. 2274f6953c82SLisandro Dalcin 2275f6953c82SLisandro Dalcin Not Collective 2276f6953c82SLisandro Dalcin 2277f6953c82SLisandro Dalcin Input Parameter: 2278f6953c82SLisandro Dalcin . ts - the TS context 2279f6953c82SLisandro Dalcin 2280f6953c82SLisandro Dalcin Output Parameter: 2281f6953c82SLisandro Dalcin . eftopt - exact final time option 2282f6953c82SLisandro Dalcin 2283f6953c82SLisandro Dalcin Level: beginner 2284f6953c82SLisandro Dalcin 2285f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime() 2286f6953c82SLisandro Dalcin @*/ 2287f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt) 2288f6953c82SLisandro Dalcin { 2289f6953c82SLisandro Dalcin PetscFunctionBegin; 2290f6953c82SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2291f6953c82SLisandro Dalcin PetscValidPointer(eftopt,2); 2292f6953c82SLisandro Dalcin *eftopt = ts->exact_final_time; 2293f6953c82SLisandro Dalcin PetscFunctionReturn(0); 2294f6953c82SLisandro Dalcin } 2295f6953c82SLisandro Dalcin 2296f6953c82SLisandro Dalcin /*@ 2297d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2298d763cef2SBarry Smith 2299d763cef2SBarry Smith Not Collective 2300d763cef2SBarry Smith 2301d763cef2SBarry Smith Input Parameter: 2302d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2303d763cef2SBarry Smith 2304d763cef2SBarry Smith Output Parameter: 2305d763cef2SBarry Smith . dt - the current timestep size 2306d763cef2SBarry Smith 2307d763cef2SBarry Smith Level: intermediate 2308d763cef2SBarry Smith 2309aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime() 2310d763cef2SBarry Smith 2311d763cef2SBarry Smith .keywords: TS, get, timestep 2312d763cef2SBarry Smith @*/ 23137087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2314d763cef2SBarry Smith { 2315d763cef2SBarry Smith PetscFunctionBegin; 23160700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2317f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2318d763cef2SBarry Smith *dt = ts->time_step; 2319d763cef2SBarry Smith PetscFunctionReturn(0); 2320d763cef2SBarry Smith } 2321d763cef2SBarry Smith 2322d8e5e3e6SSatish Balay /*@ 2323d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2324d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2325d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2326d763cef2SBarry Smith the solution at the next timestep has been calculated. 2327d763cef2SBarry Smith 2328d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2329d763cef2SBarry Smith 2330d763cef2SBarry Smith Input Parameter: 2331d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2332d763cef2SBarry Smith 2333d763cef2SBarry Smith Output Parameter: 2334d763cef2SBarry Smith . v - the vector containing the solution 2335d763cef2SBarry Smith 233663e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 233763e21af5SBarry Smith final time. It returns the solution at the next timestep. 233863e21af5SBarry Smith 2339d763cef2SBarry Smith Level: intermediate 2340d763cef2SBarry Smith 23410ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction() 2342d763cef2SBarry Smith 2343d763cef2SBarry Smith .keywords: TS, timestep, get, solution 2344d763cef2SBarry Smith @*/ 23457087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2346d763cef2SBarry Smith { 2347d763cef2SBarry Smith PetscFunctionBegin; 23480700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 23494482741eSBarry Smith PetscValidPointer(v,2); 23508737fe31SLisandro Dalcin *v = ts->vec_sol; 2351d763cef2SBarry Smith PetscFunctionReturn(0); 2352d763cef2SBarry Smith } 2353d763cef2SBarry Smith 235403fe5f5eSDebojyoti Ghosh /*@ 2355b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 235603fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2357b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 235803fe5f5eSDebojyoti Ghosh structure as the solution vector. 235903fe5f5eSDebojyoti Ghosh 236003fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 236103fe5f5eSDebojyoti Ghosh 236203fe5f5eSDebojyoti Ghosh Parameters : 236303fe5f5eSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2364b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2365b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 236603fe5f5eSDebojyoti Ghosh returned in v. 2367b2bf4f3aSDebojyoti Ghosh . v - the vector containing the n-th solution component 236803fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2369b2bf4f3aSDebojyoti Ghosh the number of solutions components). 237003fe5f5eSDebojyoti Ghosh 23714cdd57e5SDebojyoti Ghosh Level: advanced 237203fe5f5eSDebojyoti Ghosh 237303fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 237403fe5f5eSDebojyoti Ghosh 237503fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution 237603fe5f5eSDebojyoti Ghosh @*/ 2377b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 237803fe5f5eSDebojyoti Ghosh { 237903fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 238003fe5f5eSDebojyoti Ghosh 238103fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 238203fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2383b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 238403fe5f5eSDebojyoti Ghosh else { 2385b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 238603fe5f5eSDebojyoti Ghosh } 238703fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 238803fe5f5eSDebojyoti Ghosh } 238903fe5f5eSDebojyoti Ghosh 23904cdd57e5SDebojyoti Ghosh /*@ 23914cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 23924cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 23934cdd57e5SDebojyoti Ghosh 23944cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 23954cdd57e5SDebojyoti Ghosh 23964cdd57e5SDebojyoti Ghosh Parameters : 23974cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 23984cdd57e5SDebojyoti Ghosh . v - the vector containing the auxiliary solution 23994cdd57e5SDebojyoti Ghosh 24004cdd57e5SDebojyoti Ghosh Level: intermediate 24014cdd57e5SDebojyoti Ghosh 24024cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 24034cdd57e5SDebojyoti Ghosh 24044cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution 24054cdd57e5SDebojyoti Ghosh @*/ 24064cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 24074cdd57e5SDebojyoti Ghosh { 24084cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 24094cdd57e5SDebojyoti Ghosh 24104cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 24114cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2412f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 24134cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2414f6356ec7SDebojyoti Ghosh } else { 2415f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v); CHKERRQ(ierr); 2416f6356ec7SDebojyoti Ghosh } 24174cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 24184cdd57e5SDebojyoti Ghosh } 24194cdd57e5SDebojyoti Ghosh 24204cdd57e5SDebojyoti Ghosh /*@ 24214cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 24224cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 24234cdd57e5SDebojyoti Ghosh 24244cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 24254cdd57e5SDebojyoti Ghosh 24269657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 24279657682dSDebojyoti Ghosh 24284cdd57e5SDebojyoti Ghosh Parameters : 24294cdd57e5SDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 2430657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 24314cdd57e5SDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 24324cdd57e5SDebojyoti Ghosh 24334cdd57e5SDebojyoti Ghosh Level: intermediate 24344cdd57e5SDebojyoti Ghosh 243557df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 24364cdd57e5SDebojyoti Ghosh 24374cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error 24384cdd57e5SDebojyoti Ghosh @*/ 24390a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 24404cdd57e5SDebojyoti Ghosh { 24414cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 24424cdd57e5SDebojyoti Ghosh 24434cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 24444cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2445f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 24460a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2447f6356ec7SDebojyoti Ghosh } else { 2448f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2449f6356ec7SDebojyoti Ghosh } 24504cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 24514cdd57e5SDebojyoti Ghosh } 24524cdd57e5SDebojyoti Ghosh 245357df6a1bSDebojyoti Ghosh /*@ 245457df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 245557df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 245657df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 245757df6a1bSDebojyoti Ghosh 245857df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 245957df6a1bSDebojyoti Ghosh 246057df6a1bSDebojyoti Ghosh Parameters : 246157df6a1bSDebojyoti Ghosh . ts - the TS context obtained from TSCreate() (input parameter). 246257df6a1bSDebojyoti Ghosh . v - the vector containing the error (same size as the solution). 246357df6a1bSDebojyoti Ghosh 246457df6a1bSDebojyoti Ghosh Level: intermediate 246557df6a1bSDebojyoti Ghosh 246657df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 246757df6a1bSDebojyoti Ghosh 246857df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error 246957df6a1bSDebojyoti Ghosh @*/ 247057df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 247157df6a1bSDebojyoti Ghosh { 247257df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 247357df6a1bSDebojyoti Ghosh 247457df6a1bSDebojyoti Ghosh PetscFunctionBegin; 247557df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24769657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 247757df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 247857df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 247957df6a1bSDebojyoti Ghosh } 248057df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 248157df6a1bSDebojyoti Ghosh } 248257df6a1bSDebojyoti Ghosh 2483bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2484d8e5e3e6SSatish Balay /*@ 2485bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2486d763cef2SBarry Smith 2487bdad233fSMatthew Knepley Not collective 2488d763cef2SBarry Smith 2489bdad233fSMatthew Knepley Input Parameters: 2490bdad233fSMatthew Knepley + ts - The TS 2491bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2492d763cef2SBarry Smith .vb 24930910c330SBarry Smith U_t - A U = 0 (linear) 24940910c330SBarry Smith U_t - A(t) U = 0 (linear) 24950910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2496d763cef2SBarry Smith .ve 2497d763cef2SBarry Smith 2498d763cef2SBarry Smith Level: beginner 2499d763cef2SBarry Smith 2500bdad233fSMatthew Knepley .keywords: TS, problem type 2501bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2502d763cef2SBarry Smith @*/ 25037087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2504a7cc72afSBarry Smith { 25059e2a6581SJed Brown PetscErrorCode ierr; 25069e2a6581SJed Brown 2507d763cef2SBarry Smith PetscFunctionBegin; 25080700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2509bdad233fSMatthew Knepley ts->problem_type = type; 25109e2a6581SJed Brown if (type == TS_LINEAR) { 25119e2a6581SJed Brown SNES snes; 25129e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 25139e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 25149e2a6581SJed Brown } 2515d763cef2SBarry Smith PetscFunctionReturn(0); 2516d763cef2SBarry Smith } 2517d763cef2SBarry Smith 2518bdad233fSMatthew Knepley /*@C 2519bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2520bdad233fSMatthew Knepley 2521bdad233fSMatthew Knepley Not collective 2522bdad233fSMatthew Knepley 2523bdad233fSMatthew Knepley Input Parameter: 2524bdad233fSMatthew Knepley . ts - The TS 2525bdad233fSMatthew Knepley 2526bdad233fSMatthew Knepley Output Parameter: 2527bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2528bdad233fSMatthew Knepley .vb 2529089b2837SJed Brown M U_t = A U 2530089b2837SJed Brown M(t) U_t = A(t) U 2531b5abc632SBarry Smith F(t,U,U_t) 2532bdad233fSMatthew Knepley .ve 2533bdad233fSMatthew Knepley 2534bdad233fSMatthew Knepley Level: beginner 2535bdad233fSMatthew Knepley 2536bdad233fSMatthew Knepley .keywords: TS, problem type 2537bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2538bdad233fSMatthew Knepley @*/ 25397087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2540a7cc72afSBarry Smith { 2541bdad233fSMatthew Knepley PetscFunctionBegin; 25420700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 25434482741eSBarry Smith PetscValidIntPointer(type,2); 2544bdad233fSMatthew Knepley *type = ts->problem_type; 2545bdad233fSMatthew Knepley PetscFunctionReturn(0); 2546bdad233fSMatthew Knepley } 2547d763cef2SBarry Smith 2548d763cef2SBarry Smith /*@ 2549d763cef2SBarry Smith TSSetUp - Sets up the internal data structures for the later use 2550d763cef2SBarry Smith of a timestepper. 2551d763cef2SBarry Smith 2552d763cef2SBarry Smith Collective on TS 2553d763cef2SBarry Smith 2554d763cef2SBarry Smith Input Parameter: 2555d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2556d763cef2SBarry Smith 2557d763cef2SBarry Smith Notes: 2558d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2559d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2560141bd67dSStefano Zampini the call to TSStep() or TSSolve(). However, if one wishes to control this 2561d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2562141bd67dSStefano Zampini and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve(). 2563d763cef2SBarry Smith 2564d763cef2SBarry Smith Level: advanced 2565d763cef2SBarry Smith 2566d763cef2SBarry Smith .keywords: TS, timestep, setup 2567d763cef2SBarry Smith 2568141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve() 2569d763cef2SBarry Smith @*/ 25707087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2571d763cef2SBarry Smith { 2572dfbe8321SBarry Smith PetscErrorCode ierr; 25736c6b9e74SPeter Brune DM dm; 25746c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2575d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2576cd11d68dSLisandro Dalcin TSIFunction ifun; 25776c6b9e74SPeter Brune TSIJacobian ijac; 2578efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 25796c6b9e74SPeter Brune TSRHSJacobian rhsjac; 25802ffb9264SLisandro Dalcin PetscBool isnone; 2581d763cef2SBarry Smith 2582d763cef2SBarry Smith PetscFunctionBegin; 25830700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2584277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2585277b19d0SLisandro Dalcin 25867adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2587cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2588cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2589d763cef2SBarry Smith } 2590277b19d0SLisandro Dalcin 2591277b19d0SLisandro Dalcin if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 2592277b19d0SLisandro Dalcin 2593*cd4cee2dSHong Zhang if (ts->quadraturets) { 2594*cd4cee2dSHong Zhang ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr); 2595*cd4cee2dSHong Zhang ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr); 2596*cd4cee2dSHong Zhang } 2597*cd4cee2dSHong Zhang 2598971015bcSStefano Zampini ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr); 2599971015bcSStefano Zampini if (ts->rhsjacobian.reuse && rhsjac == TSComputeRHSJacobianConstant) { 2600e1244c69SJed Brown Mat Amat,Pmat; 2601e1244c69SJed Brown SNES snes; 2602e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2603e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2604e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2605e1244c69SJed Brown * have displaced the RHS matrix */ 2606971015bcSStefano Zampini if (Amat && Amat == ts->Arhs) { 2607abc0d4abSBarry 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 */ 2608abc0d4abSBarry Smith ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2609e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2610e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2611e1244c69SJed Brown } 2612971015bcSStefano Zampini if (Pmat && Pmat == ts->Brhs) { 2613abc0d4abSBarry Smith ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2614e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2615e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2616e1244c69SJed Brown } 2617e1244c69SJed Brown } 26182ffb9264SLisandro Dalcin 26192ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 26202ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 26212ffb9264SLisandro Dalcin 2622277b19d0SLisandro Dalcin if (ts->ops->setup) { 2623000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2624277b19d0SLisandro Dalcin } 2625277b19d0SLisandro Dalcin 26262ffb9264SLisandro Dalcin /* Attempt to check/preset a default value for the exact final time option */ 26272ffb9264SLisandro Dalcin ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 26282ffb9264SLisandro Dalcin if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) 26292ffb9264SLisandro Dalcin ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 26302ffb9264SLisandro Dalcin 2631a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 26326c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 26336c6b9e74SPeter Brune */ 26346c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 26350298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 26366c6b9e74SPeter Brune if (!func) { 26376c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 26386c6b9e74SPeter Brune } 2639a6772fa2SLisandro 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. 26406c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 26416c6b9e74SPeter Brune */ 26420298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 26430298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2644efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 26450298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2646efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 26476c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 26486c6b9e74SPeter Brune } 2649c0517034SDebojyoti Ghosh 2650c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2651c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2652c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2653c0517034SDebojyoti Ghosh } 2654c0517034SDebojyoti Ghosh 2655277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2656277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2657277b19d0SLisandro Dalcin } 2658277b19d0SLisandro Dalcin 2659f6a906c0SBarry Smith /*@ 2660277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2661277b19d0SLisandro Dalcin 2662277b19d0SLisandro Dalcin Collective on TS 2663277b19d0SLisandro Dalcin 2664277b19d0SLisandro Dalcin Input Parameter: 2665277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2666277b19d0SLisandro Dalcin 2667277b19d0SLisandro Dalcin Level: beginner 2668277b19d0SLisandro Dalcin 2669277b19d0SLisandro Dalcin .keywords: TS, timestep, reset 2670277b19d0SLisandro Dalcin 2671277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2672277b19d0SLisandro Dalcin @*/ 2673277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2674277b19d0SLisandro Dalcin { 26751d06f6b3SHong Zhang TS_RHSSplitLink ilink = ts->tsrhssplit,next; 2676277b19d0SLisandro Dalcin PetscErrorCode ierr; 2677277b19d0SLisandro Dalcin 2678277b19d0SLisandro Dalcin PetscFunctionBegin; 2679277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2680b18ea86cSHong Zhang 2681277b19d0SLisandro Dalcin if (ts->ops->reset) { 2682277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2683277b19d0SLisandro Dalcin } 2684277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2685e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2686bbd56ea5SKarl Rupp 26874e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 26884e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2689214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 26906bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2691efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2692e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2693e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 269438637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2695bbd56ea5SKarl Rupp 2696*cd4cee2dSHong Zhang ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr); 2697ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2698*cd4cee2dSHong Zhang if (ts->quadraturets) { 2699*cd4cee2dSHong Zhang ierr = TSReset(ts->quadraturets);CHKERRQ(ierr); 270036eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2701*cd4cee2dSHong Zhang } 27021d06f6b3SHong Zhang while (ilink) { 27031d06f6b3SHong Zhang next = ilink->next; 27041d06f6b3SHong Zhang ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr); 27051d06f6b3SHong Zhang ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 27061d06f6b3SHong Zhang ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 27071d06f6b3SHong Zhang ierr = PetscFree(ilink);CHKERRQ(ierr); 27081d06f6b3SHong Zhang ilink = next; 270987f4e208SHong Zhang } 2710545aaa6fSHong Zhang ts->num_rhs_splits = 0; 2711277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2712d763cef2SBarry Smith PetscFunctionReturn(0); 2713d763cef2SBarry Smith } 2714d763cef2SBarry Smith 2715d8e5e3e6SSatish Balay /*@ 2716d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2717d763cef2SBarry Smith with TSCreate(). 2718d763cef2SBarry Smith 2719d763cef2SBarry Smith Collective on TS 2720d763cef2SBarry Smith 2721d763cef2SBarry Smith Input Parameter: 2722d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2723d763cef2SBarry Smith 2724d763cef2SBarry Smith Level: beginner 2725d763cef2SBarry Smith 2726d763cef2SBarry Smith .keywords: TS, timestepper, destroy 2727d763cef2SBarry Smith 2728d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2729d763cef2SBarry Smith @*/ 27306bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2731d763cef2SBarry Smith { 27326849ba73SBarry Smith PetscErrorCode ierr; 2733d763cef2SBarry Smith 2734d763cef2SBarry Smith PetscFunctionBegin; 27356bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 27366bf464f9SBarry Smith PetscValidHeaderSpecific((*ts),TS_CLASSID,1); 27376bf464f9SBarry Smith if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);} 2738d763cef2SBarry Smith 27396bf464f9SBarry Smith ierr = TSReset((*ts));CHKERRQ(ierr); 2740cda2db4bSHong Zhang ierr = TSAdjointReset((*ts));CHKERRQ(ierr); 2741cda2db4bSHong Zhang ierr = TSForwardReset((*ts));CHKERRQ(ierr); 2742277b19d0SLisandro Dalcin 2743e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2744e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 27456bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 27466d4c513bSLisandro Dalcin 2747bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2748bc952696SBarry Smith 274984df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 27506427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 27516427ac75SLisandro Dalcin 27526bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 27536bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 27546bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 27550dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 27566d4c513bSLisandro Dalcin 2757*cd4cee2dSHong Zhang ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr); 2758a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2759d763cef2SBarry Smith PetscFunctionReturn(0); 2760d763cef2SBarry Smith } 2761d763cef2SBarry Smith 2762d8e5e3e6SSatish Balay /*@ 2763d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2764d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2765d763cef2SBarry Smith 2766d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2767d763cef2SBarry Smith 2768d763cef2SBarry Smith Input Parameter: 2769d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2770d763cef2SBarry Smith 2771d763cef2SBarry Smith Output Parameter: 2772d763cef2SBarry Smith . snes - the nonlinear solver context 2773d763cef2SBarry Smith 2774d763cef2SBarry Smith Notes: 2775d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2776d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 277794b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2778d763cef2SBarry Smith 2779d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 27800298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2781d763cef2SBarry Smith 2782d763cef2SBarry Smith Level: beginner 2783d763cef2SBarry Smith 2784d763cef2SBarry Smith .keywords: timestep, get, SNES 2785d763cef2SBarry Smith @*/ 27867087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2787d763cef2SBarry Smith { 2788d372ba47SLisandro Dalcin PetscErrorCode ierr; 2789d372ba47SLisandro Dalcin 2790d763cef2SBarry Smith PetscFunctionBegin; 27910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 27924482741eSBarry Smith PetscValidPointer(snes,2); 2793d372ba47SLisandro Dalcin if (!ts->snes) { 2794ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 279516413a6aSBarry Smith ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr); 27960298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 27973bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2798d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2799496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 28009e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 28019e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 28029e2a6581SJed Brown } 2803d372ba47SLisandro Dalcin } 2804d763cef2SBarry Smith *snes = ts->snes; 2805d763cef2SBarry Smith PetscFunctionReturn(0); 2806d763cef2SBarry Smith } 2807d763cef2SBarry Smith 2808deb2cd25SJed Brown /*@ 2809deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2810deb2cd25SJed Brown 2811deb2cd25SJed Brown Collective 2812deb2cd25SJed Brown 2813deb2cd25SJed Brown Input Parameter: 2814deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2815deb2cd25SJed Brown - snes - the nonlinear solver context 2816deb2cd25SJed Brown 2817deb2cd25SJed Brown Notes: 2818deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2819deb2cd25SJed Brown 2820deb2cd25SJed Brown Level: developer 2821deb2cd25SJed Brown 2822deb2cd25SJed Brown .keywords: timestep, set, SNES 2823deb2cd25SJed Brown @*/ 2824deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2825deb2cd25SJed Brown { 2826deb2cd25SJed Brown PetscErrorCode ierr; 2827d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2828deb2cd25SJed Brown 2829deb2cd25SJed Brown PetscFunctionBegin; 2830deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2831deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2832deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2833deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2834bbd56ea5SKarl Rupp 2835deb2cd25SJed Brown ts->snes = snes; 2836bbd56ea5SKarl Rupp 28370298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 28380298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2839740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 28400298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2841740132f1SEmil Constantinescu } 2842deb2cd25SJed Brown PetscFunctionReturn(0); 2843deb2cd25SJed Brown } 2844deb2cd25SJed Brown 2845d8e5e3e6SSatish Balay /*@ 284694b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2847d763cef2SBarry Smith a TS (timestepper) context. 2848d763cef2SBarry Smith 284994b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2850d763cef2SBarry Smith 2851d763cef2SBarry Smith Input Parameter: 2852d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2853d763cef2SBarry Smith 2854d763cef2SBarry Smith Output Parameter: 285594b7f48cSBarry Smith . ksp - the nonlinear solver context 2856d763cef2SBarry Smith 2857d763cef2SBarry Smith Notes: 285894b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2859d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2860d763cef2SBarry Smith KSP and PC contexts as well. 2861d763cef2SBarry Smith 286294b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 28630298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2864d763cef2SBarry Smith 2865d763cef2SBarry Smith Level: beginner 2866d763cef2SBarry Smith 286794b7f48cSBarry Smith .keywords: timestep, get, KSP 2868d763cef2SBarry Smith @*/ 28697087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2870d763cef2SBarry Smith { 2871d372ba47SLisandro Dalcin PetscErrorCode ierr; 2872089b2837SJed Brown SNES snes; 2873d372ba47SLisandro Dalcin 2874d763cef2SBarry Smith PetscFunctionBegin; 28750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28764482741eSBarry Smith PetscValidPointer(ksp,2); 287717186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2878e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2879089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2880089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2881d763cef2SBarry Smith PetscFunctionReturn(0); 2882d763cef2SBarry Smith } 2883d763cef2SBarry Smith 2884d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2885d763cef2SBarry Smith 2886adb62b0dSMatthew Knepley /*@ 2887618ce8baSLisandro Dalcin TSSetMaxSteps - Sets the maximum number of steps to use. 2888618ce8baSLisandro Dalcin 2889618ce8baSLisandro Dalcin Logically Collective on TS 2890618ce8baSLisandro Dalcin 2891618ce8baSLisandro Dalcin Input Parameters: 2892618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2893618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use 2894618ce8baSLisandro Dalcin 2895618ce8baSLisandro Dalcin Options Database Keys: 2896618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps 2897618ce8baSLisandro Dalcin 2898618ce8baSLisandro Dalcin Notes: 2899618ce8baSLisandro Dalcin The default maximum number of steps is 5000 2900618ce8baSLisandro Dalcin 2901618ce8baSLisandro Dalcin Level: intermediate 2902618ce8baSLisandro Dalcin 2903618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps 2904618ce8baSLisandro Dalcin 2905618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime() 2906618ce8baSLisandro Dalcin @*/ 2907618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps) 2908618ce8baSLisandro Dalcin { 2909618ce8baSLisandro Dalcin PetscFunctionBegin; 2910618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2911618ce8baSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,maxsteps,2); 2912618ce8baSLisandro Dalcin if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative"); 2913618ce8baSLisandro Dalcin ts->max_steps = maxsteps; 2914618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2915618ce8baSLisandro Dalcin } 2916618ce8baSLisandro Dalcin 2917618ce8baSLisandro Dalcin /*@ 2918618ce8baSLisandro Dalcin TSGetMaxSteps - Gets the maximum number of steps to use. 2919618ce8baSLisandro Dalcin 2920618ce8baSLisandro Dalcin Not Collective 2921618ce8baSLisandro Dalcin 2922618ce8baSLisandro Dalcin Input Parameters: 2923618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2924618ce8baSLisandro Dalcin 2925618ce8baSLisandro Dalcin Output Parameter: 2926618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use 2927618ce8baSLisandro Dalcin 2928618ce8baSLisandro Dalcin Level: advanced 2929618ce8baSLisandro Dalcin 2930618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps 2931618ce8baSLisandro Dalcin 2932618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime() 2933618ce8baSLisandro Dalcin @*/ 2934618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps) 2935618ce8baSLisandro Dalcin { 2936618ce8baSLisandro Dalcin PetscFunctionBegin; 2937618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2938618ce8baSLisandro Dalcin PetscValidIntPointer(maxsteps,2); 2939618ce8baSLisandro Dalcin *maxsteps = ts->max_steps; 2940618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2941618ce8baSLisandro Dalcin } 2942618ce8baSLisandro Dalcin 2943618ce8baSLisandro Dalcin /*@ 2944618ce8baSLisandro Dalcin TSSetMaxTime - Sets the maximum (or final) time for timestepping. 2945618ce8baSLisandro Dalcin 2946618ce8baSLisandro Dalcin Logically Collective on TS 2947618ce8baSLisandro Dalcin 2948618ce8baSLisandro Dalcin Input Parameters: 2949618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2950618ce8baSLisandro Dalcin - maxtime - final time to step to 2951618ce8baSLisandro Dalcin 2952618ce8baSLisandro Dalcin Options Database Keys: 2953ef85077eSLisandro Dalcin . -ts_max_time <maxtime> - Sets maxtime 2954618ce8baSLisandro Dalcin 2955618ce8baSLisandro Dalcin Notes: 2956618ce8baSLisandro Dalcin The default maximum time is 5.0 2957618ce8baSLisandro Dalcin 2958618ce8baSLisandro Dalcin Level: intermediate 2959618ce8baSLisandro Dalcin 2960618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time 2961618ce8baSLisandro Dalcin 2962618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime() 2963618ce8baSLisandro Dalcin @*/ 2964618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime) 2965618ce8baSLisandro Dalcin { 2966618ce8baSLisandro Dalcin PetscFunctionBegin; 2967618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2968618ce8baSLisandro Dalcin PetscValidLogicalCollectiveReal(ts,maxtime,2); 2969618ce8baSLisandro Dalcin ts->max_time = maxtime; 2970618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2971618ce8baSLisandro Dalcin } 2972618ce8baSLisandro Dalcin 2973618ce8baSLisandro Dalcin /*@ 2974618ce8baSLisandro Dalcin TSGetMaxTime - Gets the maximum (or final) time for timestepping. 2975618ce8baSLisandro Dalcin 2976618ce8baSLisandro Dalcin Not Collective 2977618ce8baSLisandro Dalcin 2978618ce8baSLisandro Dalcin Input Parameters: 2979618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 2980618ce8baSLisandro Dalcin 2981618ce8baSLisandro Dalcin Output Parameter: 2982618ce8baSLisandro Dalcin . maxtime - final time to step to 2983618ce8baSLisandro Dalcin 2984618ce8baSLisandro Dalcin Level: advanced 2985618ce8baSLisandro Dalcin 2986618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time 2987618ce8baSLisandro Dalcin 2988618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps() 2989618ce8baSLisandro Dalcin @*/ 2990618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime) 2991618ce8baSLisandro Dalcin { 2992618ce8baSLisandro Dalcin PetscFunctionBegin; 2993618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2994618ce8baSLisandro Dalcin PetscValidRealPointer(maxtime,2); 2995618ce8baSLisandro Dalcin *maxtime = ts->max_time; 2996618ce8baSLisandro Dalcin PetscFunctionReturn(0); 2997618ce8baSLisandro Dalcin } 2998618ce8baSLisandro Dalcin 2999618ce8baSLisandro Dalcin /*@ 3000aaa6c58dSLisandro Dalcin TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep(). 3001edc382c3SSatish Balay 3002edc382c3SSatish Balay Level: deprecated 3003edc382c3SSatish Balay 3004aaa6c58dSLisandro Dalcin @*/ 3005aaa6c58dSLisandro Dalcin PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 3006aaa6c58dSLisandro Dalcin { 3007aaa6c58dSLisandro Dalcin PetscErrorCode ierr; 3008aaa6c58dSLisandro Dalcin PetscFunctionBegin; 3009aaa6c58dSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3010aaa6c58dSLisandro Dalcin ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 3011aaa6c58dSLisandro Dalcin ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 3012aaa6c58dSLisandro Dalcin PetscFunctionReturn(0); 3013aaa6c58dSLisandro Dalcin } 3014aaa6c58dSLisandro Dalcin 3015aaa6c58dSLisandro Dalcin /*@ 301619eac22cSLisandro Dalcin TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime(). 3017edc382c3SSatish Balay 3018edc382c3SSatish Balay Level: deprecated 3019edc382c3SSatish Balay 3020adb62b0dSMatthew Knepley @*/ 30217087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 3022adb62b0dSMatthew Knepley { 3023adb62b0dSMatthew Knepley PetscFunctionBegin; 30240700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3025abc0a331SBarry Smith if (maxsteps) { 30264482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 3027adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 3028adb62b0dSMatthew Knepley } 3029abc0a331SBarry Smith if (maxtime) { 30304482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 3031adb62b0dSMatthew Knepley *maxtime = ts->max_time; 3032adb62b0dSMatthew Knepley } 3033adb62b0dSMatthew Knepley PetscFunctionReturn(0); 3034adb62b0dSMatthew Knepley } 3035adb62b0dSMatthew Knepley 3036d763cef2SBarry Smith /*@ 303719eac22cSLisandro Dalcin TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime(). 3038edc382c3SSatish Balay 3039edc382c3SSatish Balay Level: deprecated 3040edc382c3SSatish Balay 3041d763cef2SBarry Smith @*/ 30427087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 3043d763cef2SBarry Smith { 3044d763cef2SBarry Smith PetscFunctionBegin; 30450700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3046c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3047c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 304839b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 304939b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 3050d763cef2SBarry Smith PetscFunctionReturn(0); 3051d763cef2SBarry Smith } 3052d763cef2SBarry Smith 3053d763cef2SBarry Smith /*@ 30545c5f5948SLisandro Dalcin TSGetTimeStepNumber - Deprecated, use TSGetStepNumber(). 3055edc382c3SSatish Balay 3056edc382c3SSatish Balay Level: deprecated 3057edc382c3SSatish Balay 30585c5f5948SLisandro Dalcin @*/ 3059e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 30605c5f5948SLisandro Dalcin 306119eac22cSLisandro Dalcin /*@ 30624f4e0956SLisandro Dalcin TSGetTotalSteps - Deprecated, use TSGetStepNumber(). 3063edc382c3SSatish Balay 3064edc382c3SSatish Balay Level: deprecated 3065edc382c3SSatish Balay 30664f4e0956SLisandro Dalcin @*/ 30674f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 30684f4e0956SLisandro Dalcin 30694f4e0956SLisandro Dalcin /*@ 3070d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 3071d763cef2SBarry Smith for use by the TS routines. 3072d763cef2SBarry Smith 30733f9fe445SBarry Smith Logically Collective on TS and Vec 3074d763cef2SBarry Smith 3075d763cef2SBarry Smith Input Parameters: 3076d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 30770910c330SBarry Smith - u - the solution vector 3078d763cef2SBarry Smith 3079d763cef2SBarry Smith Level: beginner 3080d763cef2SBarry Smith 3081715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values 30820ed3bfb6SBarry Smith 30830ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate() 3084d763cef2SBarry Smith @*/ 30850910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 3086d763cef2SBarry Smith { 30878737fe31SLisandro Dalcin PetscErrorCode ierr; 3088496e6a7aSJed Brown DM dm; 30898737fe31SLisandro Dalcin 3090d763cef2SBarry Smith PetscFunctionBegin; 30910700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 30920910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 30930910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 30946bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 30950910c330SBarry Smith ts->vec_sol = u; 3096bbd56ea5SKarl Rupp 3097496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 30980910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 3099d763cef2SBarry Smith PetscFunctionReturn(0); 3100d763cef2SBarry Smith } 3101d763cef2SBarry Smith 3102ac226902SBarry Smith /*@C 3103000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 31043f2090d5SJed Brown called once at the beginning of each time step. 3105000e7ae3SMatthew Knepley 31063f9fe445SBarry Smith Logically Collective on TS 3107000e7ae3SMatthew Knepley 3108000e7ae3SMatthew Knepley Input Parameters: 3109000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3110000e7ae3SMatthew Knepley - func - The function 3111000e7ae3SMatthew Knepley 3112000e7ae3SMatthew Knepley Calling sequence of func: 3113000e7ae3SMatthew Knepley . func (TS ts); 3114000e7ae3SMatthew Knepley 3115000e7ae3SMatthew Knepley Level: intermediate 3116000e7ae3SMatthew Knepley 3117000e7ae3SMatthew Knepley .keywords: TS, timestep 3118dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep() 3119000e7ae3SMatthew Knepley @*/ 31207087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3121000e7ae3SMatthew Knepley { 3122000e7ae3SMatthew Knepley PetscFunctionBegin; 31230700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3124ae60f76fSBarry Smith ts->prestep = func; 3125000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3126000e7ae3SMatthew Knepley } 3127000e7ae3SMatthew Knepley 312809ee8438SJed Brown /*@ 31293f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 31303f2090d5SJed Brown 31313f2090d5SJed Brown Collective on TS 31323f2090d5SJed Brown 31333f2090d5SJed Brown Input Parameters: 31343f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 31353f2090d5SJed Brown 31363f2090d5SJed Brown Notes: 31373f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 31383f2090d5SJed Brown so most users would not generally call this routine themselves. 31393f2090d5SJed Brown 31403f2090d5SJed Brown Level: developer 31413f2090d5SJed Brown 31423f2090d5SJed Brown .keywords: TS, timestep 31439be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 31443f2090d5SJed Brown @*/ 31457087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 31463f2090d5SJed Brown { 31473f2090d5SJed Brown PetscErrorCode ierr; 31483f2090d5SJed Brown 31493f2090d5SJed Brown PetscFunctionBegin; 31500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3151ae60f76fSBarry Smith if (ts->prestep) { 31525efd42a4SStefano Zampini Vec U; 31535efd42a4SStefano Zampini PetscObjectState sprev,spost; 31545efd42a4SStefano Zampini 31555efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 31565efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3157ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 31585efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3159dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3160312ce896SJed Brown } 31613f2090d5SJed Brown PetscFunctionReturn(0); 31623f2090d5SJed Brown } 31633f2090d5SJed Brown 3164b8123daeSJed Brown /*@C 3165b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3166b8123daeSJed Brown called once at the beginning of each stage. 3167b8123daeSJed Brown 3168b8123daeSJed Brown Logically Collective on TS 3169b8123daeSJed Brown 3170b8123daeSJed Brown Input Parameters: 3171b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3172b8123daeSJed Brown - func - The function 3173b8123daeSJed Brown 3174b8123daeSJed Brown Calling sequence of func: 3175b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3176b8123daeSJed Brown 3177b8123daeSJed Brown Level: intermediate 3178b8123daeSJed Brown 3179b8123daeSJed Brown Note: 3180b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 318180275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 3182b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3183b8123daeSJed Brown 3184b8123daeSJed Brown .keywords: TS, timestep 31859be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3186b8123daeSJed Brown @*/ 3187b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3188b8123daeSJed Brown { 3189b8123daeSJed Brown PetscFunctionBegin; 3190b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3191ae60f76fSBarry Smith ts->prestage = func; 3192b8123daeSJed Brown PetscFunctionReturn(0); 3193b8123daeSJed Brown } 3194b8123daeSJed Brown 31959be3e283SDebojyoti Ghosh /*@C 31969be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 31979be3e283SDebojyoti Ghosh called once at the end of each stage. 31989be3e283SDebojyoti Ghosh 31999be3e283SDebojyoti Ghosh Logically Collective on TS 32009be3e283SDebojyoti Ghosh 32019be3e283SDebojyoti Ghosh Input Parameters: 32029be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 32039be3e283SDebojyoti Ghosh - func - The function 32049be3e283SDebojyoti Ghosh 32059be3e283SDebojyoti Ghosh Calling sequence of func: 32069be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 32079be3e283SDebojyoti Ghosh 32089be3e283SDebojyoti Ghosh Level: intermediate 32099be3e283SDebojyoti Ghosh 32109be3e283SDebojyoti Ghosh Note: 32119be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 321280275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 32139be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 32149be3e283SDebojyoti Ghosh 32159be3e283SDebojyoti Ghosh .keywords: TS, timestep 32169be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 32179be3e283SDebojyoti Ghosh @*/ 32189be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 32199be3e283SDebojyoti Ghosh { 32209be3e283SDebojyoti Ghosh PetscFunctionBegin; 32219be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 32229be3e283SDebojyoti Ghosh ts->poststage = func; 32239be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 32249be3e283SDebojyoti Ghosh } 32259be3e283SDebojyoti Ghosh 3226c688d042SShri Abhyankar /*@C 3227c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3228c688d042SShri Abhyankar called once at the end of each step evaluation. 3229c688d042SShri Abhyankar 3230c688d042SShri Abhyankar Logically Collective on TS 3231c688d042SShri Abhyankar 3232c688d042SShri Abhyankar Input Parameters: 3233c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3234c688d042SShri Abhyankar - func - The function 3235c688d042SShri Abhyankar 3236c688d042SShri Abhyankar Calling sequence of func: 3237c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3238c688d042SShri Abhyankar 3239c688d042SShri Abhyankar Level: intermediate 3240c688d042SShri Abhyankar 3241c688d042SShri Abhyankar Note: 32421785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 32431785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3244e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3245e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3246e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3247c688d042SShri Abhyankar 3248c688d042SShri Abhyankar .keywords: TS, timestep 3249c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3250c688d042SShri Abhyankar @*/ 3251c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3252c688d042SShri Abhyankar { 3253c688d042SShri Abhyankar PetscFunctionBegin; 3254c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3255c688d042SShri Abhyankar ts->postevaluate = func; 3256c688d042SShri Abhyankar PetscFunctionReturn(0); 3257c688d042SShri Abhyankar } 3258c688d042SShri Abhyankar 3259b8123daeSJed Brown /*@ 3260b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3261b8123daeSJed Brown 3262b8123daeSJed Brown Collective on TS 3263b8123daeSJed Brown 3264b8123daeSJed Brown Input Parameters: 3265b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 32669be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3267b8123daeSJed Brown 3268b8123daeSJed Brown Notes: 3269b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3270b8123daeSJed Brown most users would not generally call this routine themselves. 3271b8123daeSJed Brown 3272b8123daeSJed Brown Level: developer 3273b8123daeSJed Brown 3274b8123daeSJed Brown .keywords: TS, timestep 32759be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3276b8123daeSJed Brown @*/ 3277b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3278b8123daeSJed Brown { 3279b8123daeSJed Brown PetscFunctionBegin; 3280b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3281ae60f76fSBarry Smith if (ts->prestage) { 3282ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3283b8123daeSJed Brown } 3284b8123daeSJed Brown PetscFunctionReturn(0); 3285b8123daeSJed Brown } 3286b8123daeSJed Brown 32879be3e283SDebojyoti Ghosh /*@ 32889be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 32899be3e283SDebojyoti Ghosh 32909be3e283SDebojyoti Ghosh Collective on TS 32919be3e283SDebojyoti Ghosh 32929be3e283SDebojyoti Ghosh Input Parameters: 32939be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 32949be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 32959be3e283SDebojyoti Ghosh stageindex - Stage number 32969be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 32979be3e283SDebojyoti Ghosh of stages) with the stage solutions 32989be3e283SDebojyoti Ghosh 32999be3e283SDebojyoti Ghosh Notes: 33009be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 33019be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 33029be3e283SDebojyoti Ghosh 33039be3e283SDebojyoti Ghosh Level: developer 33049be3e283SDebojyoti Ghosh 33059be3e283SDebojyoti Ghosh .keywords: TS, timestep 33069be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 33079be3e283SDebojyoti Ghosh @*/ 33089be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 33099be3e283SDebojyoti Ghosh { 33109be3e283SDebojyoti Ghosh PetscFunctionBegin; 33119be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33124beae5d8SLisandro Dalcin if (ts->poststage) { 33139be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 33149be3e283SDebojyoti Ghosh } 33159be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33169be3e283SDebojyoti Ghosh } 33179be3e283SDebojyoti Ghosh 3318c688d042SShri Abhyankar /*@ 3319c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3320c688d042SShri Abhyankar 3321c688d042SShri Abhyankar Collective on TS 3322c688d042SShri Abhyankar 3323c688d042SShri Abhyankar Input Parameters: 3324c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3325c688d042SShri Abhyankar 3326c688d042SShri Abhyankar Notes: 3327c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3328c688d042SShri Abhyankar most users would not generally call this routine themselves. 3329c688d042SShri Abhyankar 3330c688d042SShri Abhyankar Level: developer 3331c688d042SShri Abhyankar 3332c688d042SShri Abhyankar .keywords: TS, timestep 3333c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3334c688d042SShri Abhyankar @*/ 3335c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3336c688d042SShri Abhyankar { 3337c688d042SShri Abhyankar PetscErrorCode ierr; 3338c688d042SShri Abhyankar 3339c688d042SShri Abhyankar PetscFunctionBegin; 3340c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3341c688d042SShri Abhyankar if (ts->postevaluate) { 3342dcb233daSLisandro Dalcin Vec U; 3343dcb233daSLisandro Dalcin PetscObjectState sprev,spost; 3344dcb233daSLisandro Dalcin 3345dcb233daSLisandro Dalcin ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 3346dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3347c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3348dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3349dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3350c688d042SShri Abhyankar } 3351c688d042SShri Abhyankar PetscFunctionReturn(0); 3352c688d042SShri Abhyankar } 3353c688d042SShri Abhyankar 3354ac226902SBarry Smith /*@C 3355000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 33563f2090d5SJed Brown called once at the end of each time step. 3357000e7ae3SMatthew Knepley 33583f9fe445SBarry Smith Logically Collective on TS 3359000e7ae3SMatthew Knepley 3360000e7ae3SMatthew Knepley Input Parameters: 3361000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3362000e7ae3SMatthew Knepley - func - The function 3363000e7ae3SMatthew Knepley 3364000e7ae3SMatthew Knepley Calling sequence of func: 3365b8123daeSJed Brown $ func (TS ts); 3366000e7ae3SMatthew Knepley 33671785ff2aSShri Abhyankar Notes: 33681785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 33691785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 33701785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 33711785ff2aSShri Abhyankar 3372000e7ae3SMatthew Knepley Level: intermediate 3373000e7ae3SMatthew Knepley 3374000e7ae3SMatthew Knepley .keywords: TS, timestep 3375dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep() 3376000e7ae3SMatthew Knepley @*/ 33777087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3378000e7ae3SMatthew Knepley { 3379000e7ae3SMatthew Knepley PetscFunctionBegin; 33800700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3381ae60f76fSBarry Smith ts->poststep = func; 3382000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3383000e7ae3SMatthew Knepley } 3384000e7ae3SMatthew Knepley 338509ee8438SJed Brown /*@ 33863f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 33873f2090d5SJed Brown 33883f2090d5SJed Brown Collective on TS 33893f2090d5SJed Brown 33903f2090d5SJed Brown Input Parameters: 33913f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 33923f2090d5SJed Brown 33933f2090d5SJed Brown Notes: 33943f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 33953f2090d5SJed Brown so most users would not generally call this routine themselves. 33963f2090d5SJed Brown 33973f2090d5SJed Brown Level: developer 33983f2090d5SJed Brown 33993f2090d5SJed Brown .keywords: TS, timestep 34003f2090d5SJed Brown @*/ 34017087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 34023f2090d5SJed Brown { 34033f2090d5SJed Brown PetscErrorCode ierr; 34043f2090d5SJed Brown 34053f2090d5SJed Brown PetscFunctionBegin; 34060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3407ae60f76fSBarry Smith if (ts->poststep) { 34085efd42a4SStefano Zampini Vec U; 34095efd42a4SStefano Zampini PetscObjectState sprev,spost; 34105efd42a4SStefano Zampini 34115efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 34125efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3413ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 34145efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3415dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 341672ac3e02SJed Brown } 34173f2090d5SJed Brown PetscFunctionReturn(0); 34183f2090d5SJed Brown } 34193f2090d5SJed Brown 3420d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3421d763cef2SBarry Smith 3422d763cef2SBarry Smith /*@C 3423a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3424d763cef2SBarry Smith timestep to display the iteration's progress. 3425d763cef2SBarry Smith 34263f9fe445SBarry Smith Logically Collective on TS 3427d763cef2SBarry Smith 3428d763cef2SBarry Smith Input Parameters: 3429d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3430e213d8f1SJed Brown . monitor - monitoring routine 3431329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 34320298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3433b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 34340298fd71SBarry Smith (may be NULL) 3435d763cef2SBarry Smith 3436e213d8f1SJed Brown Calling sequence of monitor: 3437dcb233daSLisandro Dalcin $ PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3438d763cef2SBarry Smith 3439d763cef2SBarry Smith + ts - the TS context 344063e21af5SBarry 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) 34411f06c33eSBarry Smith . time - current time 34420910c330SBarry Smith . u - current iterate 3443d763cef2SBarry Smith - mctx - [optional] monitoring context 3444d763cef2SBarry Smith 3445d763cef2SBarry Smith Notes: 3446d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3447d763cef2SBarry Smith already has been loaded. 3448d763cef2SBarry Smith 344995452b02SPatrick Sanan Fortran Notes: 345095452b02SPatrick Sanan Only a single monitor function can be set for each TS object 3451025f1a04SBarry Smith 3452d763cef2SBarry Smith Level: intermediate 3453d763cef2SBarry Smith 3454d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3455d763cef2SBarry Smith 3456a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3457d763cef2SBarry Smith @*/ 3458c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3459d763cef2SBarry Smith { 346078064530SBarry Smith PetscErrorCode ierr; 346178064530SBarry Smith PetscInt i; 346278064530SBarry Smith PetscBool identical; 346378064530SBarry Smith 3464d763cef2SBarry Smith PetscFunctionBegin; 34650700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 346678064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 346778064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 346878064530SBarry Smith if (identical) PetscFunctionReturn(0); 346978064530SBarry Smith } 347017186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3471d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 34728704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3473d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3474d763cef2SBarry Smith PetscFunctionReturn(0); 3475d763cef2SBarry Smith } 3476d763cef2SBarry Smith 3477d763cef2SBarry Smith /*@C 3478a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3479d763cef2SBarry Smith 34803f9fe445SBarry Smith Logically Collective on TS 3481d763cef2SBarry Smith 3482d763cef2SBarry Smith Input Parameters: 3483d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3484d763cef2SBarry Smith 3485d763cef2SBarry Smith Notes: 3486d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3487d763cef2SBarry Smith 3488d763cef2SBarry Smith Level: intermediate 3489d763cef2SBarry Smith 3490d763cef2SBarry Smith .keywords: TS, timestep, set, monitor 3491d763cef2SBarry Smith 3492a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3493d763cef2SBarry Smith @*/ 34947087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3495d763cef2SBarry Smith { 3496d952e501SBarry Smith PetscErrorCode ierr; 3497d952e501SBarry Smith PetscInt i; 3498d952e501SBarry Smith 3499d763cef2SBarry Smith PetscFunctionBegin; 35000700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3501d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 35028704b422SBarry Smith if (ts->monitordestroy[i]) { 35038704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3504d952e501SBarry Smith } 3505d952e501SBarry Smith } 3506d763cef2SBarry Smith ts->numbermonitors = 0; 3507d763cef2SBarry Smith PetscFunctionReturn(0); 3508d763cef2SBarry Smith } 3509d763cef2SBarry Smith 3510721cd6eeSBarry Smith /*@C 3511721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 35125516499fSSatish Balay 35135516499fSSatish Balay Level: intermediate 351441251cbbSSatish Balay 35155516499fSSatish Balay .keywords: TS, set, monitor 35165516499fSSatish Balay 351763e21af5SBarry Smith .seealso: TSMonitorSet() 351841251cbbSSatish Balay @*/ 3519721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3520d763cef2SBarry Smith { 3521dfbe8321SBarry Smith PetscErrorCode ierr; 3522721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 352341aca3d6SBarry Smith PetscBool iascii,ibinary; 3524d132466eSBarry Smith 3525d763cef2SBarry Smith PetscFunctionBegin; 35264d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 352741aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 352841aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3529721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 353041aca3d6SBarry Smith if (iascii) { 3531649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 353263e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 353363e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 353463e21af5SBarry Smith } else { 35358392e04aSShri 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); 353663e21af5SBarry Smith } 3537649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 353841aca3d6SBarry Smith } else if (ibinary) { 353941aca3d6SBarry Smith PetscMPIInt rank; 354041aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 354141aca3d6SBarry Smith if (!rank) { 3542450a797fSBarry Smith PetscBool skipHeader; 3543450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3544450a797fSBarry Smith 3545450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3546450a797fSBarry Smith if (!skipHeader) { 3547450a797fSBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 3548450a797fSBarry Smith } 354941aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 355041aca3d6SBarry Smith } else { 355141aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 355241aca3d6SBarry Smith } 355341aca3d6SBarry Smith } 3554721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3555d763cef2SBarry Smith PetscFunctionReturn(0); 3556d763cef2SBarry Smith } 3557d763cef2SBarry Smith 3558cc9c3a59SBarry Smith /*@C 3559cc9c3a59SBarry Smith TSMonitorExtreme - Prints the extreme values of the solution at each timestep 3560cc9c3a59SBarry Smith 3561cc9c3a59SBarry Smith Level: intermediate 3562cc9c3a59SBarry Smith 3563cc9c3a59SBarry Smith .keywords: TS, set, monitor 3564cc9c3a59SBarry Smith 3565cc9c3a59SBarry Smith .seealso: TSMonitorSet() 3566cc9c3a59SBarry Smith @*/ 3567cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3568cc9c3a59SBarry Smith { 3569cc9c3a59SBarry Smith PetscErrorCode ierr; 3570cc9c3a59SBarry Smith PetscViewer viewer = vf->viewer; 3571cc9c3a59SBarry Smith PetscBool iascii; 3572cc9c3a59SBarry Smith PetscReal max,min; 3573cc9c3a59SBarry Smith 3574cc9c3a59SBarry Smith 3575cc9c3a59SBarry Smith PetscFunctionBegin; 3576cc9c3a59SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3577cc9c3a59SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 3578cc9c3a59SBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3579cc9c3a59SBarry Smith if (iascii) { 3580cc9c3a59SBarry Smith ierr = VecMax(v,NULL,&max);CHKERRQ(ierr); 3581cc9c3a59SBarry Smith ierr = VecMin(v,NULL,&min);CHKERRQ(ierr); 3582cc9c3a59SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 35835132926bSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s max %g min %g\n",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)" : "",(double)max,(double)min);CHKERRQ(ierr); 3584cc9c3a59SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3585cc9c3a59SBarry Smith } 3586cc9c3a59SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3587cc9c3a59SBarry Smith PetscFunctionReturn(0); 3588cc9c3a59SBarry Smith } 3589cc9c3a59SBarry Smith 3590cd652676SJed Brown /*@ 3591cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3592cd652676SJed Brown 3593cd652676SJed Brown Collective on TS 3594cd652676SJed Brown 3595cd652676SJed Brown Input Argument: 3596cd652676SJed Brown + ts - time stepping context 3597cd652676SJed Brown - t - time to interpolate to 3598cd652676SJed Brown 3599cd652676SJed Brown Output Argument: 36000910c330SBarry Smith . U - state at given time 3601cd652676SJed Brown 3602cd652676SJed Brown Level: intermediate 3603cd652676SJed Brown 3604cd652676SJed Brown Developer Notes: 3605cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3606cd652676SJed Brown 3607cd652676SJed Brown .keywords: TS, set 3608cd652676SJed Brown 3609874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3610cd652676SJed Brown @*/ 36110910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3612cd652676SJed Brown { 3613cd652676SJed Brown PetscErrorCode ierr; 3614cd652676SJed Brown 3615cd652676SJed Brown PetscFunctionBegin; 3616cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3617b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3618be5899b3SLisandro 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); 3619ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 36200910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3621cd652676SJed Brown PetscFunctionReturn(0); 3622cd652676SJed Brown } 3623cd652676SJed Brown 3624d763cef2SBarry Smith /*@ 36256d9e5789SSean Farley TSStep - Steps one time step 3626d763cef2SBarry Smith 3627d763cef2SBarry Smith Collective on TS 3628d763cef2SBarry Smith 3629d763cef2SBarry Smith Input Parameter: 3630d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3631d763cef2SBarry Smith 363227829d71SBarry Smith Level: developer 3633d763cef2SBarry Smith 3634b8123daeSJed Brown Notes: 363527829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 363627829d71SBarry Smith 3637b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3638b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3639b8123daeSJed Brown 364019eac22cSLisandro Dalcin This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the 364119eac22cSLisandro Dalcin time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 364225cb2221SBarry Smith 3643d763cef2SBarry Smith .keywords: TS, timestep, solve 3644d763cef2SBarry Smith 36459be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3646d763cef2SBarry Smith @*/ 3647193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3648d763cef2SBarry Smith { 3649dfbe8321SBarry Smith PetscErrorCode ierr; 3650fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3651be5899b3SLisandro Dalcin PetscReal ptime; 3652d763cef2SBarry Smith 3653d763cef2SBarry Smith PetscFunctionBegin; 36540700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3655fffbeea8SBarry Smith ierr = PetscCitationsRegister("@techreport{tspaper,\n" 3656fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3657fffbeea8SBarry Smith " author = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n" 3658fffbeea8SBarry Smith " type = {Preprint},\n" 3659fffbeea8SBarry Smith " number = {ANL/MCS-P5061-0114},\n" 3660fffbeea8SBarry Smith " institution = {Argonne National Laboratory},\n" 3661302440fdSBarry Smith " year = {2014}\n}\n",&cite);CHKERRQ(ierr); 3662fffbeea8SBarry Smith 3663d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 366468bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3665d405a339SMatthew Knepley 3666ef85077eSLisandro 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>"); 3667a6772fa2SLisandro 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()"); 3668be5899b3SLisandro 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"); 3669a6772fa2SLisandro Dalcin 3670be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3671be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 36722808aa04SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3673e04979a6SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3674d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3675193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3676d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3677be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 36782808aa04SLisandro Dalcin ts->steps++; 3679be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 368028d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3681362cd11cSLisandro Dalcin 3682362cd11cSLisandro Dalcin if (ts->reason < 0) { 3683cef5090cSJed Brown if (ts->errorifstepfailed) { 368408c7845fSBarry 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]); 368508c7845fSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 3686d2daff3dSHong Zhang } 368708c7845fSBarry Smith } else if (!ts->reason) { 368808c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 368908c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 369008c7845fSBarry Smith } 369108c7845fSBarry Smith PetscFunctionReturn(0); 369208c7845fSBarry Smith } 369308c7845fSBarry Smith 369408c7845fSBarry Smith /*@ 36957cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 36967cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 36977cbde773SLisandro Dalcin 36987cbde773SLisandro Dalcin Collective on TS 36997cbde773SLisandro Dalcin 37007cbde773SLisandro Dalcin Input Arguments: 37017cbde773SLisandro Dalcin + ts - time stepping context 37027cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 37037cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 37047cbde773SLisandro Dalcin 37057cbde773SLisandro Dalcin Output Arguments: 37067cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 37077cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 37087cbde773SLisandro Dalcin 37097cbde773SLisandro Dalcin Level: advanced 37107cbde773SLisandro Dalcin 37117cbde773SLisandro Dalcin Notes: 37127cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 37137cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 37147cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 37157cbde773SLisandro Dalcin 37167cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 37177cbde773SLisandro Dalcin @*/ 37187cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 37197cbde773SLisandro Dalcin { 37207cbde773SLisandro Dalcin PetscErrorCode ierr; 37217cbde773SLisandro Dalcin 37227cbde773SLisandro Dalcin PetscFunctionBegin; 37237cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37247cbde773SLisandro Dalcin PetscValidType(ts,1); 37257cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 37267cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 37277cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 37287cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 37297cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 37307cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 37317cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 37327cbde773SLisandro Dalcin PetscFunctionReturn(0); 37337cbde773SLisandro Dalcin } 37347cbde773SLisandro Dalcin 373505175c85SJed Brown /*@ 373605175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 373705175c85SJed Brown 37381c3436cfSJed Brown Collective on TS 373905175c85SJed Brown 374005175c85SJed Brown Input Arguments: 37411c3436cfSJed Brown + ts - time stepping context 37421c3436cfSJed Brown . order - desired order of accuracy 37430298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 374405175c85SJed Brown 374505175c85SJed Brown Output Arguments: 37460910c330SBarry Smith . U - state at the end of the current step 374705175c85SJed Brown 374805175c85SJed Brown Level: advanced 374905175c85SJed Brown 3750108c343cSJed Brown Notes: 3751108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3752108c343cSJed 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. 3753108c343cSJed Brown 37541c3436cfSJed Brown .seealso: TSStep(), TSAdapt 375505175c85SJed Brown @*/ 37560910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 375705175c85SJed Brown { 375805175c85SJed Brown PetscErrorCode ierr; 375905175c85SJed Brown 376005175c85SJed Brown PetscFunctionBegin; 376105175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 376205175c85SJed Brown PetscValidType(ts,1); 37630910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3764ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 37650910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 376605175c85SJed Brown PetscFunctionReturn(0); 376705175c85SJed Brown } 376805175c85SJed Brown 3769b1cb36f3SHong Zhang /*@ 37706a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 37716a4d4014SLisandro Dalcin 37726a4d4014SLisandro Dalcin Collective on TS 37736a4d4014SLisandro Dalcin 37746a4d4014SLisandro Dalcin Input Parameter: 37756a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 377663e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 377763e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 37785a3a76d0SJed Brown 37796a4d4014SLisandro Dalcin Level: beginner 37806a4d4014SLisandro Dalcin 37815a3a76d0SJed Brown Notes: 37825a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 37835a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 37845a3a76d0SJed Brown stepped over the final time. 37855a3a76d0SJed Brown 37866a4d4014SLisandro Dalcin .keywords: TS, timestep, solve 37876a4d4014SLisandro Dalcin 378863e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 37896a4d4014SLisandro Dalcin @*/ 3790cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 37916a4d4014SLisandro Dalcin { 3792b06615a5SLisandro Dalcin Vec solution; 37936a4d4014SLisandro Dalcin PetscErrorCode ierr; 3794f22f69f0SBarry Smith 37956a4d4014SLisandro Dalcin PetscFunctionBegin; 37960700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3797f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 3798feed9e9dSBarry Smith 3799ee41a567SStefano 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 */ 38000910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 3801b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 3802b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 3803b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 38045a3a76d0SJed Brown } 38050910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 3806715f1b00SHong Zhang if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 3807bbd56ea5SKarl Rupp } else if (u) { 38080910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 38095a3a76d0SJed Brown } 3810b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 381168bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3812a6772fa2SLisandro Dalcin 3813ef85077eSLisandro 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>"); 3814a6772fa2SLisandro 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()"); 3815a6772fa2SLisandro 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"); 3816a6772fa2SLisandro Dalcin 3817715f1b00SHong Zhang if (ts->forward_solve) { 3818715f1b00SHong Zhang ierr = TSForwardSetUp(ts);CHKERRQ(ierr); 3819715f1b00SHong Zhang } 3820715f1b00SHong Zhang 3821e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 3822715f1b00SHong Zhang restarts the step after an event. Resetting these counters in such case causes 3823e7069c78SShri TSTrajectory to incorrectly save the output files 3824e7069c78SShri */ 3825715f1b00SHong Zhang /* reset time step and iteration counters */ 38262808aa04SLisandro Dalcin if (!ts->steps) { 38275ef26d82SJed Brown ts->ksp_its = 0; 38285ef26d82SJed Brown ts->snes_its = 0; 3829c610991cSLisandro Dalcin ts->num_snes_failures = 0; 3830c610991cSLisandro Dalcin ts->reject = 0; 38312808aa04SLisandro Dalcin ts->steprestart = PETSC_TRUE; 38322808aa04SLisandro Dalcin ts->steprollback = PETSC_FALSE; 38332808aa04SLisandro Dalcin } 383410bc0e4dSStefano 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; 3835193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 3836193ac0bcSJed Brown 3837ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 3838f05ece33SBarry Smith 3839193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 3840193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 3841a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3842cc708dedSBarry Smith ts->solvetime = ts->ptime; 3843a6772fa2SLisandro Dalcin solution = ts->vec_sol; 3844be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 3845db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3846db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3847e7069c78SShri 38482808aa04SLisandro Dalcin if (!ts->steps) { 38492808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 38506427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 38512808aa04SLisandro Dalcin } 38526427ac75SLisandro Dalcin 3853e1a7a14fSJed Brown while (!ts->reason) { 38542808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 38559687d888SLisandro Dalcin if (!ts->steprollback) { 38569687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 38579687d888SLisandro Dalcin } 3858193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 3859f3b1f45cSBarry Smith if (ts->testjacobian) { 3860f3b1f45cSBarry Smith ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr); 3861f3b1f45cSBarry Smith } 3862f3b1f45cSBarry Smith if (ts->testjacobiantranspose) { 3863f3b1f45cSBarry Smith ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr); 3864f3b1f45cSBarry Smith } 3865*cd4cee2dSHong Zhang if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 3866b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 3867b1cb36f3SHong Zhang } 386858818c2dSLisandro Dalcin if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 3869715f1b00SHong Zhang ierr = TSForwardStep(ts);CHKERRQ(ierr); 3870715f1b00SHong Zhang } 387110b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 3872e783b05fSHong 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. */ 387358818c2dSLisandro Dalcin if (ts->steprollback) { 387458818c2dSLisandro Dalcin ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 387558818c2dSLisandro Dalcin } 3876e783b05fSHong Zhang if (!ts->steprollback) { 38772808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 38781eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 3879aeb4809dSShri Abhyankar } 3880193ac0bcSJed Brown } 38812808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 38826427ac75SLisandro Dalcin 388349354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 38840910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 3885cc708dedSBarry Smith ts->solvetime = ts->max_time; 3886b06615a5SLisandro Dalcin solution = u; 388763e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 38880574a7fbSJed Brown } else { 3889ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 3890cc708dedSBarry Smith ts->solvetime = ts->ptime; 3891b06615a5SLisandro Dalcin solution = ts->vec_sol; 38920574a7fbSJed Brown } 3893193ac0bcSJed Brown } 3894d2daff3dSHong Zhang 3895ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 389663e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 389756f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 3898ef222394SBarry Smith if (ts->adjoint_solve) { 3899ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 39002b0a91c0SBarry Smith } 39016a4d4014SLisandro Dalcin PetscFunctionReturn(0); 39026a4d4014SLisandro Dalcin } 39036a4d4014SLisandro Dalcin 39047db568b7SBarry Smith /*@C 3905228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 3906228d79bcSJed Brown 3907228d79bcSJed Brown Collective on TS 3908228d79bcSJed Brown 3909228d79bcSJed Brown Input Parameters: 3910228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 3911228d79bcSJed Brown . step - step number that has just completed 3912228d79bcSJed Brown . ptime - model time of the state 39130910c330SBarry Smith - u - state at the current model time 3914228d79bcSJed Brown 3915228d79bcSJed Brown Notes: 39167db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 39177db568b7SBarry Smith Users would almost never call this routine directly. 3918228d79bcSJed Brown 391963e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 392063e21af5SBarry Smith 39217db568b7SBarry Smith Level: developer 3922228d79bcSJed Brown 3923228d79bcSJed Brown .keywords: TS, timestep 3924228d79bcSJed Brown @*/ 39250910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 3926d763cef2SBarry Smith { 3927d6152f81SLisandro Dalcin DM dm; 3928a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 3929d6152f81SLisandro Dalcin PetscErrorCode ierr; 3930d763cef2SBarry Smith 3931d763cef2SBarry Smith PetscFunctionBegin; 3932b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3933b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 3934d6152f81SLisandro Dalcin 3935d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 3936d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 3937d6152f81SLisandro Dalcin 39388860a134SJunchao Zhang ierr = VecLockReadPush(u);CHKERRQ(ierr); 3939d763cef2SBarry Smith for (i=0; i<n; i++) { 39400910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 3941d763cef2SBarry Smith } 39428860a134SJunchao Zhang ierr = VecLockReadPop(u);CHKERRQ(ierr); 3943d763cef2SBarry Smith PetscFunctionReturn(0); 3944d763cef2SBarry Smith } 3945d763cef2SBarry Smith 3946d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 3947d763cef2SBarry Smith /*@C 39487db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 3949a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 3950d763cef2SBarry Smith 3951d763cef2SBarry Smith Collective on TS 3952d763cef2SBarry Smith 3953d763cef2SBarry Smith Input Parameters: 3954d763cef2SBarry Smith + host - the X display to open, or null for the local machine 3955d763cef2SBarry Smith . label - the title to put in the title bar 39567c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 3957a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 3958a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 3959d763cef2SBarry Smith 3960d763cef2SBarry Smith Output Parameter: 39610b039ecaSBarry Smith . ctx - the context 3962d763cef2SBarry Smith 3963d763cef2SBarry Smith Options Database Key: 39644f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 39658b668821SLisandro Dalcin + -ts_monitor_lg_timestep_log - automatically sets line graph monitor 39667db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 39677db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 39687db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 39697db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 3970b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 3971d763cef2SBarry Smith 3972d763cef2SBarry Smith Notes: 3973a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 3974d763cef2SBarry Smith 39757db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 39767db568b7SBarry Smith 39777db568b7SBarry 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 39787db568b7SBarry 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 39797db568b7SBarry Smith as the first argument. 39807db568b7SBarry Smith 39817db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 39827db568b7SBarry Smith 3983d763cef2SBarry Smith Level: intermediate 3984d763cef2SBarry Smith 39857db568b7SBarry Smith .keywords: TS, monitor, line graph, residual 3986d763cef2SBarry Smith 39877db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 39887db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 39897db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 39907db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 39917db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 39927c922b88SBarry Smith 3993d763cef2SBarry Smith @*/ 3994a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 3995d763cef2SBarry Smith { 39967f52daa2SLisandro Dalcin PetscDraw draw; 3997dfbe8321SBarry Smith PetscErrorCode ierr; 3998d763cef2SBarry Smith 3999d763cef2SBarry Smith PetscFunctionBegin; 4000b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 40017f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 40027f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 40037f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4004287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 40057f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4006a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4007d763cef2SBarry Smith PetscFunctionReturn(0); 4008d763cef2SBarry Smith } 4009d763cef2SBarry Smith 4010b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4011d763cef2SBarry Smith { 40120b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4013c32365f1SBarry Smith PetscReal x = ptime,y; 4014dfbe8321SBarry Smith PetscErrorCode ierr; 4015d763cef2SBarry Smith 4016d763cef2SBarry Smith PetscFunctionBegin; 401763e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4018b06615a5SLisandro Dalcin if (!step) { 4019a9f9c1f6SBarry Smith PetscDrawAxis axis; 40208b668821SLisandro Dalcin const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step"; 4021a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 40228b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr); 4023a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4024a9f9c1f6SBarry Smith } 4025c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 40268b668821SLisandro Dalcin if (ctx->semilogy) y = PetscLog10Real(y); 40270b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4028b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 40290b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 40306934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 40313923b477SBarry Smith } 4032d763cef2SBarry Smith PetscFunctionReturn(0); 4033d763cef2SBarry Smith } 4034d763cef2SBarry Smith 4035d763cef2SBarry Smith /*@C 4036a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4037a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4038d763cef2SBarry Smith 40390b039ecaSBarry Smith Collective on TSMonitorLGCtx 4040d763cef2SBarry Smith 4041d763cef2SBarry Smith Input Parameter: 40420b039ecaSBarry Smith . ctx - the monitor context 4043d763cef2SBarry Smith 4044d763cef2SBarry Smith Level: intermediate 4045d763cef2SBarry Smith 4046d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy 4047d763cef2SBarry Smith 40484f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4049d763cef2SBarry Smith @*/ 4050a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4051d763cef2SBarry Smith { 4052dfbe8321SBarry Smith PetscErrorCode ierr; 4053d763cef2SBarry Smith 4054d763cef2SBarry Smith PetscFunctionBegin; 40557684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 40567684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 40577684fa3eSBarry Smith } 40580b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 405931152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4060387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4061387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4062387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 40630b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4064d763cef2SBarry Smith PetscFunctionReturn(0); 4065d763cef2SBarry Smith } 4066d763cef2SBarry Smith 40671b575b74SJoseph Pusztay /* 40681b575b74SJoseph Pusztay 40691b575b74SJoseph Pusztay Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations 40701b575b74SJoseph Pusztay 40711b575b74SJoseph Pusztay */ 40721b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx) 40731b575b74SJoseph Pusztay { 40741b575b74SJoseph Pusztay PetscDraw draw; 40751b575b74SJoseph Pusztay PetscErrorCode ierr; 40761b575b74SJoseph Pusztay 40771b575b74SJoseph Pusztay PetscFunctionBegin; 40781b575b74SJoseph Pusztay ierr = PetscNew(ctx);CHKERRQ(ierr); 40791b575b74SJoseph Pusztay ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 40801b575b74SJoseph Pusztay ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 40811b575b74SJoseph Pusztay ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr); 40821b575b74SJoseph Pusztay ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 40831b575b74SJoseph Pusztay (*ctx)->howoften = howoften; 40841b575b74SJoseph Pusztay PetscFunctionReturn(0); 40851b575b74SJoseph Pusztay 40861b575b74SJoseph Pusztay } 40871b575b74SJoseph Pusztay 40881b575b74SJoseph Pusztay /* 40891b575b74SJoseph Pusztay Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate 40901b575b74SJoseph Pusztay */ 40911b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx) 40921b575b74SJoseph Pusztay { 40931b575b74SJoseph Pusztay PetscErrorCode ierr; 40941b575b74SJoseph Pusztay 40951b575b74SJoseph Pusztay PetscFunctionBegin; 40961b575b74SJoseph Pusztay 40971b575b74SJoseph Pusztay ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr); 40981b575b74SJoseph Pusztay ierr = PetscFree(*ctx);CHKERRQ(ierr); 40991b575b74SJoseph Pusztay 41001b575b74SJoseph Pusztay PetscFunctionReturn(0); 41011b575b74SJoseph Pusztay 41021b575b74SJoseph Pusztay } 41031b575b74SJoseph Pusztay 4104d763cef2SBarry Smith /*@ 4105b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4106d763cef2SBarry Smith 4107d763cef2SBarry Smith Not Collective 4108d763cef2SBarry Smith 4109d763cef2SBarry Smith Input Parameter: 4110d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4111d763cef2SBarry Smith 4112d763cef2SBarry Smith Output Parameter: 411319eac22cSLisandro Dalcin . t - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime(). 4114d763cef2SBarry Smith 4115d763cef2SBarry Smith Level: beginner 4116d763cef2SBarry Smith 4117b8123daeSJed Brown Note: 4118b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 41199be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4120b8123daeSJed Brown 4121aaa6c58dSLisandro Dalcin .seealso: TSGetSolveTime(), TSSetTime(), TSGetTimeStep() 4122d763cef2SBarry Smith 4123d763cef2SBarry Smith .keywords: TS, get, time 4124d763cef2SBarry Smith @*/ 41257087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4126d763cef2SBarry Smith { 4127d763cef2SBarry Smith PetscFunctionBegin; 41280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4129f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4130d763cef2SBarry Smith *t = ts->ptime; 4131d763cef2SBarry Smith PetscFunctionReturn(0); 4132d763cef2SBarry Smith } 4133d763cef2SBarry Smith 4134e5e524a1SHong Zhang /*@ 4135e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4136e5e524a1SHong Zhang 4137e5e524a1SHong Zhang Not Collective 4138e5e524a1SHong Zhang 4139e5e524a1SHong Zhang Input Parameter: 4140e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4141e5e524a1SHong Zhang 4142e5e524a1SHong Zhang Output Parameter: 4143e5e524a1SHong Zhang . t - the previous time 4144e5e524a1SHong Zhang 4145e5e524a1SHong Zhang Level: beginner 4146e5e524a1SHong Zhang 4147aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep() 4148e5e524a1SHong Zhang 4149e5e524a1SHong Zhang .keywords: TS, get, time 4150e5e524a1SHong Zhang @*/ 4151e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4152e5e524a1SHong Zhang { 4153e5e524a1SHong Zhang PetscFunctionBegin; 4154e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4155e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4156e5e524a1SHong Zhang *t = ts->ptime_prev; 4157e5e524a1SHong Zhang PetscFunctionReturn(0); 4158e5e524a1SHong Zhang } 4159e5e524a1SHong Zhang 41606a4d4014SLisandro Dalcin /*@ 41616a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 41626a4d4014SLisandro Dalcin 41633f9fe445SBarry Smith Logically Collective on TS 41646a4d4014SLisandro Dalcin 41656a4d4014SLisandro Dalcin Input Parameters: 41666a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 41676a4d4014SLisandro Dalcin - time - the time 41686a4d4014SLisandro Dalcin 41696a4d4014SLisandro Dalcin Level: intermediate 41706a4d4014SLisandro Dalcin 417119eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps() 41726a4d4014SLisandro Dalcin 41736a4d4014SLisandro Dalcin .keywords: TS, set, time 41746a4d4014SLisandro Dalcin @*/ 41757087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 41766a4d4014SLisandro Dalcin { 41776a4d4014SLisandro Dalcin PetscFunctionBegin; 41780700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4179c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 41806a4d4014SLisandro Dalcin ts->ptime = t; 41816a4d4014SLisandro Dalcin PetscFunctionReturn(0); 41826a4d4014SLisandro Dalcin } 41836a4d4014SLisandro Dalcin 4184d763cef2SBarry Smith /*@C 4185d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4186d763cef2SBarry Smith TS options in the database. 4187d763cef2SBarry Smith 41883f9fe445SBarry Smith Logically Collective on TS 4189d763cef2SBarry Smith 4190d763cef2SBarry Smith Input Parameter: 4191d763cef2SBarry Smith + ts - The TS context 4192d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4193d763cef2SBarry Smith 4194d763cef2SBarry Smith Notes: 4195d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4196d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4197d763cef2SBarry Smith hyphen. 4198d763cef2SBarry Smith 4199d763cef2SBarry Smith Level: advanced 4200d763cef2SBarry Smith 4201d763cef2SBarry Smith .keywords: TS, set, options, prefix, database 4202d763cef2SBarry Smith 4203d763cef2SBarry Smith .seealso: TSSetFromOptions() 4204d763cef2SBarry Smith 4205d763cef2SBarry Smith @*/ 42067087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4207d763cef2SBarry Smith { 4208dfbe8321SBarry Smith PetscErrorCode ierr; 4209089b2837SJed Brown SNES snes; 4210d763cef2SBarry Smith 4211d763cef2SBarry Smith PetscFunctionBegin; 42120700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4213d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4214089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4215089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4216d763cef2SBarry Smith PetscFunctionReturn(0); 4217d763cef2SBarry Smith } 4218d763cef2SBarry Smith 4219d763cef2SBarry Smith /*@C 4220d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4221d763cef2SBarry Smith TS options in the database. 4222d763cef2SBarry Smith 42233f9fe445SBarry Smith Logically Collective on TS 4224d763cef2SBarry Smith 4225d763cef2SBarry Smith Input Parameter: 4226d763cef2SBarry Smith + ts - The TS context 4227d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4228d763cef2SBarry Smith 4229d763cef2SBarry Smith Notes: 4230d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4231d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4232d763cef2SBarry Smith hyphen. 4233d763cef2SBarry Smith 4234d763cef2SBarry Smith Level: advanced 4235d763cef2SBarry Smith 4236d763cef2SBarry Smith .keywords: TS, append, options, prefix, database 4237d763cef2SBarry Smith 4238d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4239d763cef2SBarry Smith 4240d763cef2SBarry Smith @*/ 42417087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4242d763cef2SBarry Smith { 4243dfbe8321SBarry Smith PetscErrorCode ierr; 4244089b2837SJed Brown SNES snes; 4245d763cef2SBarry Smith 4246d763cef2SBarry Smith PetscFunctionBegin; 42470700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4248d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4249089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4250089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4251d763cef2SBarry Smith PetscFunctionReturn(0); 4252d763cef2SBarry Smith } 4253d763cef2SBarry Smith 4254d763cef2SBarry Smith /*@C 4255d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4256d763cef2SBarry Smith TS options in the database. 4257d763cef2SBarry Smith 4258d763cef2SBarry Smith Not Collective 4259d763cef2SBarry Smith 4260d763cef2SBarry Smith Input Parameter: 4261d763cef2SBarry Smith . ts - The TS context 4262d763cef2SBarry Smith 4263d763cef2SBarry Smith Output Parameter: 4264d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4265d763cef2SBarry Smith 426695452b02SPatrick Sanan Notes: 426795452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prifix' of 4268d763cef2SBarry Smith sufficient length to hold the prefix. 4269d763cef2SBarry Smith 4270d763cef2SBarry Smith Level: intermediate 4271d763cef2SBarry Smith 4272d763cef2SBarry Smith .keywords: TS, get, options, prefix, database 4273d763cef2SBarry Smith 4274d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4275d763cef2SBarry Smith @*/ 42767087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4277d763cef2SBarry Smith { 4278dfbe8321SBarry Smith PetscErrorCode ierr; 4279d763cef2SBarry Smith 4280d763cef2SBarry Smith PetscFunctionBegin; 42810700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 42824482741eSBarry Smith PetscValidPointer(prefix,2); 4283d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4284d763cef2SBarry Smith PetscFunctionReturn(0); 4285d763cef2SBarry Smith } 4286d763cef2SBarry Smith 4287d763cef2SBarry Smith /*@C 4288d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4289d763cef2SBarry Smith 4290d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4291d763cef2SBarry Smith 4292d763cef2SBarry Smith Input Parameter: 4293d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4294d763cef2SBarry Smith 4295d763cef2SBarry Smith Output Parameters: 4296e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4297e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4298e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4299e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4300d763cef2SBarry Smith 430195452b02SPatrick Sanan Notes: 430295452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 4303d763cef2SBarry Smith 4304d763cef2SBarry Smith Level: intermediate 4305d763cef2SBarry Smith 430680275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 4307d763cef2SBarry Smith 4308d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian 4309d763cef2SBarry Smith @*/ 4310e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4311d763cef2SBarry Smith { 4312089b2837SJed Brown PetscErrorCode ierr; 431324989b8cSPeter Brune DM dm; 4314089b2837SJed Brown 4315d763cef2SBarry Smith PetscFunctionBegin; 431623a57915SBarry Smith if (Amat || Pmat) { 431723a57915SBarry Smith SNES snes; 4318089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 431923a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4320e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 432123a57915SBarry Smith } 432224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 432324989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4324d763cef2SBarry Smith PetscFunctionReturn(0); 4325d763cef2SBarry Smith } 4326d763cef2SBarry Smith 43272eca1d9cSJed Brown /*@C 43282eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 43292eca1d9cSJed Brown 43302eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 43312eca1d9cSJed Brown 43322eca1d9cSJed Brown Input Parameter: 43332eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 43342eca1d9cSJed Brown 43352eca1d9cSJed Brown Output Parameters: 4336e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4337e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 43382eca1d9cSJed Brown . f - The function to compute the matrices 43392eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 43402eca1d9cSJed Brown 434195452b02SPatrick Sanan Notes: 434295452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 43432eca1d9cSJed Brown 43442eca1d9cSJed Brown Level: advanced 43452eca1d9cSJed Brown 434680275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 43472eca1d9cSJed Brown 43482eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian 43492eca1d9cSJed Brown @*/ 4350e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 43512eca1d9cSJed Brown { 4352089b2837SJed Brown PetscErrorCode ierr; 435324989b8cSPeter Brune DM dm; 43540910c330SBarry Smith 43552eca1d9cSJed Brown PetscFunctionBegin; 4356c0aab802Sstefano_zampini if (Amat || Pmat) { 4357c0aab802Sstefano_zampini SNES snes; 4358089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4359f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4360e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4361c0aab802Sstefano_zampini } 436224989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 436324989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 43642eca1d9cSJed Brown PetscFunctionReturn(0); 43652eca1d9cSJed Brown } 43662eca1d9cSJed Brown 43671713a123SBarry Smith /*@C 436883a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 43691713a123SBarry Smith VecView() for the solution at each timestep 43701713a123SBarry Smith 43711713a123SBarry Smith Collective on TS 43721713a123SBarry Smith 43731713a123SBarry Smith Input Parameters: 43741713a123SBarry Smith + ts - the TS context 43751713a123SBarry Smith . step - current time-step 4376142b95e3SSatish Balay . ptime - current time 43770298fd71SBarry Smith - dummy - either a viewer or NULL 43781713a123SBarry Smith 437999fdda47SBarry Smith Options Database: 438099fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 438199fdda47SBarry Smith 438295452b02SPatrick Sanan Notes: 438395452b02SPatrick Sanan the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 438499fdda47SBarry Smith will look bad 438599fdda47SBarry Smith 43861713a123SBarry Smith Level: intermediate 43871713a123SBarry Smith 43881713a123SBarry Smith .keywords: TS, vector, monitor, view 43891713a123SBarry Smith 4390a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 43911713a123SBarry Smith @*/ 43920910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 43931713a123SBarry Smith { 4394dfbe8321SBarry Smith PetscErrorCode ierr; 439583a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4396473a3ab2SBarry Smith PetscDraw draw; 43971713a123SBarry Smith 43981713a123SBarry Smith PetscFunctionBegin; 43996083293cSBarry Smith if (!step && ictx->showinitial) { 44006083293cSBarry Smith if (!ictx->initialsolution) { 44010910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 44021713a123SBarry Smith } 44030910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 44046083293cSBarry Smith } 4405b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 44060dcf80beSBarry Smith 44076083293cSBarry Smith if (ictx->showinitial) { 44086083293cSBarry Smith PetscReal pause; 44096083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 44106083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 44116083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 44126083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 44136083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 44146083293cSBarry Smith } 44150910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4416473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 441751fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4418473a3ab2SBarry Smith char time[32]; 4419473a3ab2SBarry Smith 4420473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 442185b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4422473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4423473a3ab2SBarry Smith h = yl + .95*(yr - yl); 442451fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4425473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4426473a3ab2SBarry Smith } 4427473a3ab2SBarry Smith 44286083293cSBarry Smith if (ictx->showinitial) { 44296083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 44306083293cSBarry Smith } 44311713a123SBarry Smith PetscFunctionReturn(0); 44321713a123SBarry Smith } 44331713a123SBarry Smith 44349110b2e7SHong Zhang /*@C 44352d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 44362d5ee99bSBarry Smith 44372d5ee99bSBarry Smith Collective on TS 44382d5ee99bSBarry Smith 44392d5ee99bSBarry Smith Input Parameters: 44402d5ee99bSBarry Smith + ts - the TS context 44412d5ee99bSBarry Smith . step - current time-step 44422d5ee99bSBarry Smith . ptime - current time 44432d5ee99bSBarry Smith - dummy - either a viewer or NULL 44442d5ee99bSBarry Smith 44452d5ee99bSBarry Smith Level: intermediate 44462d5ee99bSBarry Smith 44472d5ee99bSBarry Smith .keywords: TS, vector, monitor, view 44482d5ee99bSBarry Smith 44492d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 44502d5ee99bSBarry Smith @*/ 44512d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 44522d5ee99bSBarry Smith { 44532d5ee99bSBarry Smith PetscErrorCode ierr; 44542d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 44552d5ee99bSBarry Smith PetscDraw draw; 44566934998bSLisandro Dalcin PetscDrawAxis axis; 44572d5ee99bSBarry Smith PetscInt n; 44582d5ee99bSBarry Smith PetscMPIInt size; 44596934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 44602d5ee99bSBarry Smith char time[32]; 44612d5ee99bSBarry Smith const PetscScalar *U; 44622d5ee99bSBarry Smith 44632d5ee99bSBarry Smith PetscFunctionBegin; 44646934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 44656934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 44662d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 44676934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 44682d5ee99bSBarry Smith 44692d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 44706934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 44716934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 44726934998bSLisandro Dalcin if (!step) { 44736934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 44746934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 44756934998bSLisandro Dalcin } 44762d5ee99bSBarry Smith 44772d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 44786934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 44796934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4480a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 44816934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 44822d5ee99bSBarry Smith 44836934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 44846934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 44852d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 44864b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 448785b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 44882d5ee99bSBarry Smith h = yl + .95*(yr - yl); 448951fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 44902d5ee99bSBarry Smith } 44916934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 44922d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 449356d62c8fSLisandro Dalcin ierr = PetscDrawPause(draw);CHKERRQ(ierr); 44946934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 44952d5ee99bSBarry Smith PetscFunctionReturn(0); 44962d5ee99bSBarry Smith } 44972d5ee99bSBarry Smith 44986083293cSBarry Smith /*@C 449983a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 45006083293cSBarry Smith 45016083293cSBarry Smith Collective on TS 45026083293cSBarry Smith 45036083293cSBarry Smith Input Parameters: 45046083293cSBarry Smith . ctx - the monitor context 45056083293cSBarry Smith 45066083293cSBarry Smith Level: intermediate 45076083293cSBarry Smith 45086083293cSBarry Smith .keywords: TS, vector, monitor, view 45096083293cSBarry Smith 451083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 45116083293cSBarry Smith @*/ 451283a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 45136083293cSBarry Smith { 45146083293cSBarry Smith PetscErrorCode ierr; 45156083293cSBarry Smith 45166083293cSBarry Smith PetscFunctionBegin; 451783a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 451883a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 451983a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 45206083293cSBarry Smith PetscFunctionReturn(0); 45216083293cSBarry Smith } 45226083293cSBarry Smith 45236083293cSBarry Smith /*@C 452483a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 45256083293cSBarry Smith 45266083293cSBarry Smith Collective on TS 45276083293cSBarry Smith 45286083293cSBarry Smith Input Parameter: 45296083293cSBarry Smith . ts - time-step context 45306083293cSBarry Smith 45316083293cSBarry Smith Output Patameter: 45326083293cSBarry Smith . ctx - the monitor context 45336083293cSBarry Smith 453499fdda47SBarry Smith Options Database: 453599fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 453699fdda47SBarry Smith 45376083293cSBarry Smith Level: intermediate 45386083293cSBarry Smith 45396083293cSBarry Smith .keywords: TS, vector, monitor, view 45406083293cSBarry Smith 454183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 45426083293cSBarry Smith @*/ 454383a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 45446083293cSBarry Smith { 45456083293cSBarry Smith PetscErrorCode ierr; 45466083293cSBarry Smith 45476083293cSBarry Smith PetscFunctionBegin; 4548b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 454983a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4550e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4551bbd56ea5SKarl Rupp 455283a4ac43SBarry Smith (*ctx)->howoften = howoften; 4553473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4554c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4555473a3ab2SBarry Smith 4556473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4557c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 45586083293cSBarry Smith PetscFunctionReturn(0); 45596083293cSBarry Smith } 45606083293cSBarry Smith 45613a471f94SBarry Smith /*@C 45620ed3bfb6SBarry Smith TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling 45630ed3bfb6SBarry Smith VecView() for the solution provided by TSSetSolutionFunction() at each timestep 45640ed3bfb6SBarry Smith 45650ed3bfb6SBarry Smith Collective on TS 45660ed3bfb6SBarry Smith 45670ed3bfb6SBarry Smith Input Parameters: 45680ed3bfb6SBarry Smith + ts - the TS context 45690ed3bfb6SBarry Smith . step - current time-step 45700ed3bfb6SBarry Smith . ptime - current time 45710ed3bfb6SBarry Smith - dummy - either a viewer or NULL 45720ed3bfb6SBarry Smith 45730ed3bfb6SBarry Smith Options Database: 45740ed3bfb6SBarry Smith . -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 45750ed3bfb6SBarry Smith 45760ed3bfb6SBarry Smith Level: intermediate 45770ed3bfb6SBarry Smith 45780ed3bfb6SBarry Smith .keywords: TS, vector, monitor, view 45790ed3bfb6SBarry Smith 45800ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 45810ed3bfb6SBarry Smith @*/ 45820ed3bfb6SBarry Smith PetscErrorCode TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 45830ed3bfb6SBarry Smith { 45840ed3bfb6SBarry Smith PetscErrorCode ierr; 45850ed3bfb6SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 45860ed3bfb6SBarry Smith PetscViewer viewer = ctx->viewer; 45870ed3bfb6SBarry Smith Vec work; 45880ed3bfb6SBarry Smith 45890ed3bfb6SBarry Smith PetscFunctionBegin; 45900ed3bfb6SBarry Smith if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 45910ed3bfb6SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 45920ed3bfb6SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 45930ed3bfb6SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 45940ed3bfb6SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 45950ed3bfb6SBarry Smith PetscFunctionReturn(0); 45960ed3bfb6SBarry Smith } 45970ed3bfb6SBarry Smith 45980ed3bfb6SBarry Smith /*@C 459983a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 46003a471f94SBarry Smith VecView() for the error at each timestep 46013a471f94SBarry Smith 46023a471f94SBarry Smith Collective on TS 46033a471f94SBarry Smith 46043a471f94SBarry Smith Input Parameters: 46053a471f94SBarry Smith + ts - the TS context 46063a471f94SBarry Smith . step - current time-step 46073a471f94SBarry Smith . ptime - current time 46080298fd71SBarry Smith - dummy - either a viewer or NULL 46093a471f94SBarry Smith 46100ed3bfb6SBarry Smith Options Database: 46110ed3bfb6SBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 46120ed3bfb6SBarry Smith 46133a471f94SBarry Smith Level: intermediate 46143a471f94SBarry Smith 46153a471f94SBarry Smith .keywords: TS, vector, monitor, view 46163a471f94SBarry Smith 46170ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 46183a471f94SBarry Smith @*/ 46190910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 46203a471f94SBarry Smith { 46213a471f94SBarry Smith PetscErrorCode ierr; 462283a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 462383a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 46243a471f94SBarry Smith Vec work; 46253a471f94SBarry Smith 46263a471f94SBarry Smith PetscFunctionBegin; 4627b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 46280910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 46293a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 46300910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 46313a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 46323a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 46333a471f94SBarry Smith PetscFunctionReturn(0); 46343a471f94SBarry Smith } 46353a471f94SBarry Smith 4636af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 46376c699258SBarry Smith /*@ 46382a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 46396c699258SBarry Smith 46403f9fe445SBarry Smith Logically Collective on TS and DM 46416c699258SBarry Smith 46426c699258SBarry Smith Input Parameters: 46432a808120SBarry Smith + ts - the ODE integrator object 46442a808120SBarry Smith - dm - the dm, cannot be NULL 46456c699258SBarry Smith 4646e03a659cSJed Brown Notes: 4647e03a659cSJed Brown A DM can only be used for solving one problem at a time because information about the problem is stored on the DM, 4648e03a659cSJed Brown even when not using interfaces like DMTSSetIFunction(). Use DMClone() to get a distinct DM when solving 4649e03a659cSJed Brown different problems using the same function space. 4650e03a659cSJed Brown 46516c699258SBarry Smith Level: intermediate 46526c699258SBarry Smith 46536c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 46546c699258SBarry Smith @*/ 46557087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 46566c699258SBarry Smith { 46576c699258SBarry Smith PetscErrorCode ierr; 4658089b2837SJed Brown SNES snes; 4659942e3340SBarry Smith DMTS tsdm; 46606c699258SBarry Smith 46616c699258SBarry Smith PetscFunctionBegin; 46620700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46632a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 466470663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4665942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 46662a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4667942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4668942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 466924989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 467024989b8cSPeter Brune tsdm->originaldm = dm; 467124989b8cSPeter Brune } 467224989b8cSPeter Brune } 46736bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 467424989b8cSPeter Brune } 46756c699258SBarry Smith ts->dm = dm; 4676bbd56ea5SKarl Rupp 4677089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4678089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 46796c699258SBarry Smith PetscFunctionReturn(0); 46806c699258SBarry Smith } 46816c699258SBarry Smith 46826c699258SBarry Smith /*@ 46836c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 46846c699258SBarry Smith 46853f9fe445SBarry Smith Not Collective 46866c699258SBarry Smith 46876c699258SBarry Smith Input Parameter: 46886c699258SBarry Smith . ts - the preconditioner context 46896c699258SBarry Smith 46906c699258SBarry Smith Output Parameter: 46916c699258SBarry Smith . dm - the dm 46926c699258SBarry Smith 46936c699258SBarry Smith Level: intermediate 46946c699258SBarry Smith 46956c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 46966c699258SBarry Smith @*/ 46977087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 46986c699258SBarry Smith { 4699496e6a7aSJed Brown PetscErrorCode ierr; 4700496e6a7aSJed Brown 47016c699258SBarry Smith PetscFunctionBegin; 47020700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4703496e6a7aSJed Brown if (!ts->dm) { 4704ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4705496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4706496e6a7aSJed Brown } 47076c699258SBarry Smith *dm = ts->dm; 47086c699258SBarry Smith PetscFunctionReturn(0); 47096c699258SBarry Smith } 47101713a123SBarry Smith 47110f5c6efeSJed Brown /*@ 47120f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 47130f5c6efeSJed Brown 47143f9fe445SBarry Smith Logically Collective on SNES 47150f5c6efeSJed Brown 47160f5c6efeSJed Brown Input Parameter: 4717d42a1c89SJed Brown + snes - nonlinear solver 47180910c330SBarry Smith . U - the current state at which to evaluate the residual 4719d42a1c89SJed Brown - ctx - user context, must be a TS 47200f5c6efeSJed Brown 47210f5c6efeSJed Brown Output Parameter: 47220f5c6efeSJed Brown . F - the nonlinear residual 47230f5c6efeSJed Brown 47240f5c6efeSJed Brown Notes: 47250f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 47260f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 47270f5c6efeSJed Brown 47280f5c6efeSJed Brown Level: advanced 47290f5c6efeSJed Brown 47300f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 47310f5c6efeSJed Brown @*/ 47320910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 47330f5c6efeSJed Brown { 47340f5c6efeSJed Brown TS ts = (TS)ctx; 47350f5c6efeSJed Brown PetscErrorCode ierr; 47360f5c6efeSJed Brown 47370f5c6efeSJed Brown PetscFunctionBegin; 47380f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 47390910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 47400f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 47410f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 47420910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 47430f5c6efeSJed Brown PetscFunctionReturn(0); 47440f5c6efeSJed Brown } 47450f5c6efeSJed Brown 47460f5c6efeSJed Brown /*@ 47470f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 47480f5c6efeSJed Brown 47490f5c6efeSJed Brown Collective on SNES 47500f5c6efeSJed Brown 47510f5c6efeSJed Brown Input Parameter: 47520f5c6efeSJed Brown + snes - nonlinear solver 47530910c330SBarry Smith . U - the current state at which to evaluate the residual 47540f5c6efeSJed Brown - ctx - user context, must be a TS 47550f5c6efeSJed Brown 47560f5c6efeSJed Brown Output Parameter: 47570f5c6efeSJed Brown + A - the Jacobian 47580f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 47590f5c6efeSJed Brown - flag - indicates any structure change in the matrix 47600f5c6efeSJed Brown 47610f5c6efeSJed Brown Notes: 47620f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 47630f5c6efeSJed Brown 47640f5c6efeSJed Brown Level: developer 47650f5c6efeSJed Brown 47660f5c6efeSJed Brown .seealso: SNESSetJacobian() 47670f5c6efeSJed Brown @*/ 4768d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 47690f5c6efeSJed Brown { 47700f5c6efeSJed Brown TS ts = (TS)ctx; 47710f5c6efeSJed Brown PetscErrorCode ierr; 47720f5c6efeSJed Brown 47730f5c6efeSJed Brown PetscFunctionBegin; 47740f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 47750910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 47760f5c6efeSJed Brown PetscValidPointer(A,3); 477794ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 47780f5c6efeSJed Brown PetscValidPointer(B,4); 477994ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 47800f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 4781d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 47820f5c6efeSJed Brown PetscFunctionReturn(0); 47830f5c6efeSJed Brown } 4784325fc9f4SBarry Smith 47850e4ef248SJed Brown /*@C 47869ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 47870e4ef248SJed Brown 47880e4ef248SJed Brown Collective on TS 47890e4ef248SJed Brown 47900e4ef248SJed Brown Input Arguments: 47910e4ef248SJed Brown + ts - time stepping context 47920e4ef248SJed Brown . t - time at which to evaluate 47930910c330SBarry Smith . U - state at which to evaluate 47940e4ef248SJed Brown - ctx - context 47950e4ef248SJed Brown 47960e4ef248SJed Brown Output Arguments: 47970e4ef248SJed Brown . F - right hand side 47980e4ef248SJed Brown 47990e4ef248SJed Brown Level: intermediate 48000e4ef248SJed Brown 48010e4ef248SJed Brown Notes: 48020e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 48030e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 48040e4ef248SJed Brown 48050e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 48060e4ef248SJed Brown @*/ 48070910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 48080e4ef248SJed Brown { 48090e4ef248SJed Brown PetscErrorCode ierr; 48100e4ef248SJed Brown Mat Arhs,Brhs; 48110e4ef248SJed Brown 48120e4ef248SJed Brown PetscFunctionBegin; 48130e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 4814d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 48150910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 48160e4ef248SJed Brown PetscFunctionReturn(0); 48170e4ef248SJed Brown } 48180e4ef248SJed Brown 48190e4ef248SJed Brown /*@C 48200e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 48210e4ef248SJed Brown 48220e4ef248SJed Brown Collective on TS 48230e4ef248SJed Brown 48240e4ef248SJed Brown Input Arguments: 48250e4ef248SJed Brown + ts - time stepping context 48260e4ef248SJed Brown . t - time at which to evaluate 48270910c330SBarry Smith . U - state at which to evaluate 48280e4ef248SJed Brown - ctx - context 48290e4ef248SJed Brown 48300e4ef248SJed Brown Output Arguments: 48310e4ef248SJed Brown + A - pointer to operator 48320e4ef248SJed Brown . B - pointer to preconditioning matrix 48330e4ef248SJed Brown - flg - matrix structure flag 48340e4ef248SJed Brown 48350e4ef248SJed Brown Level: intermediate 48360e4ef248SJed Brown 48370e4ef248SJed Brown Notes: 48380e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 48390e4ef248SJed Brown 48400e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 48410e4ef248SJed Brown @*/ 4842d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 48430e4ef248SJed Brown { 48440e4ef248SJed Brown PetscFunctionBegin; 48450e4ef248SJed Brown PetscFunctionReturn(0); 48460e4ef248SJed Brown } 48470e4ef248SJed Brown 48480026cea9SSean Farley /*@C 48490026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 48500026cea9SSean Farley 48510026cea9SSean Farley Collective on TS 48520026cea9SSean Farley 48530026cea9SSean Farley Input Arguments: 48540026cea9SSean Farley + ts - time stepping context 48550026cea9SSean Farley . t - time at which to evaluate 48560910c330SBarry Smith . U - state at which to evaluate 48570910c330SBarry Smith . Udot - time derivative of state vector 48580026cea9SSean Farley - ctx - context 48590026cea9SSean Farley 48600026cea9SSean Farley Output Arguments: 48610026cea9SSean Farley . F - left hand side 48620026cea9SSean Farley 48630026cea9SSean Farley Level: intermediate 48640026cea9SSean Farley 48650026cea9SSean Farley Notes: 48660910c330SBarry 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 48670026cea9SSean Farley user is required to write their own TSComputeIFunction. 48680026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 48690026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 48700026cea9SSean Farley 48719ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 48729ae8fd06SBarry Smith 48739ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 48740026cea9SSean Farley @*/ 48750910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 48760026cea9SSean Farley { 48770026cea9SSean Farley PetscErrorCode ierr; 48780026cea9SSean Farley Mat A,B; 48790026cea9SSean Farley 48800026cea9SSean Farley PetscFunctionBegin; 48810298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 4882d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 48830910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 48840026cea9SSean Farley PetscFunctionReturn(0); 48850026cea9SSean Farley } 48860026cea9SSean Farley 48870026cea9SSean Farley /*@C 4888b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 48890026cea9SSean Farley 48900026cea9SSean Farley Collective on TS 48910026cea9SSean Farley 48920026cea9SSean Farley Input Arguments: 48930026cea9SSean Farley + ts - time stepping context 48940026cea9SSean Farley . t - time at which to evaluate 48950910c330SBarry Smith . U - state at which to evaluate 48960910c330SBarry Smith . Udot - time derivative of state vector 48970026cea9SSean Farley . shift - shift to apply 48980026cea9SSean Farley - ctx - context 48990026cea9SSean Farley 49000026cea9SSean Farley Output Arguments: 49010026cea9SSean Farley + A - pointer to operator 49020026cea9SSean Farley . B - pointer to preconditioning matrix 49030026cea9SSean Farley - flg - matrix structure flag 49040026cea9SSean Farley 4905b41af12eSJed Brown Level: advanced 49060026cea9SSean Farley 49070026cea9SSean Farley Notes: 49080026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 49090026cea9SSean Farley 4910b41af12eSJed Brown It is only appropriate for problems of the form 4911b41af12eSJed Brown 4912b41af12eSJed Brown $ M Udot = F(U,t) 4913b41af12eSJed Brown 4914b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 4915b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 4916b41af12eSJed Brown an implicit operator of the form 4917b41af12eSJed Brown 4918b41af12eSJed Brown $ shift*M + J 4919b41af12eSJed Brown 4920b41af12eSJed 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 4921b41af12eSJed Brown a copy of M or reassemble it when requested. 4922b41af12eSJed Brown 49230026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 49240026cea9SSean Farley @*/ 4925d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 49260026cea9SSean Farley { 4927b41af12eSJed Brown PetscErrorCode ierr; 4928b41af12eSJed Brown 49290026cea9SSean Farley PetscFunctionBegin; 493094ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 4931b41af12eSJed Brown ts->ijacobian.shift = shift; 49320026cea9SSean Farley PetscFunctionReturn(0); 49330026cea9SSean Farley } 4934b41af12eSJed Brown 4935e817cc15SEmil Constantinescu /*@ 4936e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 4937e817cc15SEmil Constantinescu 4938e817cc15SEmil Constantinescu Not Collective 4939e817cc15SEmil Constantinescu 4940e817cc15SEmil Constantinescu Input Parameter: 4941e817cc15SEmil Constantinescu . ts - the TS context 4942e817cc15SEmil Constantinescu 4943e817cc15SEmil Constantinescu Output Parameter: 49444e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 4945e817cc15SEmil Constantinescu 4946e817cc15SEmil Constantinescu Level: beginner 4947e817cc15SEmil Constantinescu 4948e817cc15SEmil Constantinescu .keywords: TS, equation type 4949e817cc15SEmil Constantinescu 4950e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 4951e817cc15SEmil Constantinescu @*/ 4952e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 4953e817cc15SEmil Constantinescu { 4954e817cc15SEmil Constantinescu PetscFunctionBegin; 4955e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4956e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 4957e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 4958e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4959e817cc15SEmil Constantinescu } 4960e817cc15SEmil Constantinescu 4961e817cc15SEmil Constantinescu /*@ 4962e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 4963e817cc15SEmil Constantinescu 4964e817cc15SEmil Constantinescu Not Collective 4965e817cc15SEmil Constantinescu 4966e817cc15SEmil Constantinescu Input Parameter: 4967e817cc15SEmil Constantinescu + ts - the TS context 49681297b224SEmil Constantinescu - equation_type - see TSEquationType 4969e817cc15SEmil Constantinescu 4970e817cc15SEmil Constantinescu Level: advanced 4971e817cc15SEmil Constantinescu 4972e817cc15SEmil Constantinescu .keywords: TS, equation type 4973e817cc15SEmil Constantinescu 4974e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 4975e817cc15SEmil Constantinescu @*/ 4976e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 4977e817cc15SEmil Constantinescu { 4978e817cc15SEmil Constantinescu PetscFunctionBegin; 4979e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4980e817cc15SEmil Constantinescu ts->equation_type = equation_type; 4981e817cc15SEmil Constantinescu PetscFunctionReturn(0); 4982e817cc15SEmil Constantinescu } 49830026cea9SSean Farley 49844af1b03aSJed Brown /*@ 49854af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 49864af1b03aSJed Brown 49874af1b03aSJed Brown Not Collective 49884af1b03aSJed Brown 49894af1b03aSJed Brown Input Parameter: 49904af1b03aSJed Brown . ts - the TS context 49914af1b03aSJed Brown 49924af1b03aSJed Brown Output Parameter: 49934af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 49944af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 49954af1b03aSJed Brown 4996487e0bb9SJed Brown Level: beginner 49974af1b03aSJed Brown 4998cd652676SJed Brown Notes: 4999cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 50004af1b03aSJed Brown 50014af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test 50024af1b03aSJed Brown 50034af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 50044af1b03aSJed Brown @*/ 50054af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 50064af1b03aSJed Brown { 50074af1b03aSJed Brown PetscFunctionBegin; 50084af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 50094af1b03aSJed Brown PetscValidPointer(reason,2); 50104af1b03aSJed Brown *reason = ts->reason; 50114af1b03aSJed Brown PetscFunctionReturn(0); 50124af1b03aSJed Brown } 50134af1b03aSJed Brown 5014d6ad946cSShri Abhyankar /*@ 5015d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5016d6ad946cSShri Abhyankar 5017d6ad946cSShri Abhyankar Not Collective 5018d6ad946cSShri Abhyankar 5019d6ad946cSShri Abhyankar Input Parameter: 5020d6ad946cSShri Abhyankar + ts - the TS context 5021d6ad946cSShri Abhyankar . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5022d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5023d6ad946cSShri Abhyankar 5024f5abba47SShri Abhyankar Level: advanced 5025d6ad946cSShri Abhyankar 5026d6ad946cSShri Abhyankar Notes: 5027d6ad946cSShri Abhyankar Can only be called during TSSolve() is active. 5028d6ad946cSShri Abhyankar 5029d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test 5030d6ad946cSShri Abhyankar 5031d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5032d6ad946cSShri Abhyankar @*/ 5033d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5034d6ad946cSShri Abhyankar { 5035d6ad946cSShri Abhyankar PetscFunctionBegin; 5036d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5037d6ad946cSShri Abhyankar ts->reason = reason; 5038d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5039d6ad946cSShri Abhyankar } 5040d6ad946cSShri Abhyankar 5041cc708dedSBarry Smith /*@ 5042cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5043cc708dedSBarry Smith 5044cc708dedSBarry Smith Not Collective 5045cc708dedSBarry Smith 5046cc708dedSBarry Smith Input Parameter: 5047cc708dedSBarry Smith . ts - the TS context 5048cc708dedSBarry Smith 5049cc708dedSBarry Smith Output Parameter: 505019eac22cSLisandro Dalcin . ftime - the final time. This time corresponds to the final time set with TSSetMaxTime() 5051cc708dedSBarry Smith 5052487e0bb9SJed Brown Level: beginner 5053cc708dedSBarry Smith 5054cc708dedSBarry Smith Notes: 5055cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5056cc708dedSBarry Smith 5057cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test 5058cc708dedSBarry Smith 5059cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5060cc708dedSBarry Smith @*/ 5061cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5062cc708dedSBarry Smith { 5063cc708dedSBarry Smith PetscFunctionBegin; 5064cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5065cc708dedSBarry Smith PetscValidPointer(ftime,2); 5066cc708dedSBarry Smith *ftime = ts->solvetime; 5067cc708dedSBarry Smith PetscFunctionReturn(0); 5068cc708dedSBarry Smith } 5069cc708dedSBarry Smith 50702c18e0fdSBarry Smith /*@ 50715ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 50729f67acb7SJed Brown used by the time integrator. 50739f67acb7SJed Brown 50749f67acb7SJed Brown Not Collective 50759f67acb7SJed Brown 50769f67acb7SJed Brown Input Parameter: 50779f67acb7SJed Brown . ts - TS context 50789f67acb7SJed Brown 50799f67acb7SJed Brown Output Parameter: 50809f67acb7SJed Brown . nits - number of nonlinear iterations 50819f67acb7SJed Brown 50829f67acb7SJed Brown Notes: 50839f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 50849f67acb7SJed Brown 50859f67acb7SJed Brown Level: intermediate 50869f67acb7SJed Brown 50879f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations 50889f67acb7SJed Brown 50895ef26d82SJed Brown .seealso: TSGetKSPIterations() 50909f67acb7SJed Brown @*/ 50915ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 50929f67acb7SJed Brown { 50939f67acb7SJed Brown PetscFunctionBegin; 50949f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 50959f67acb7SJed Brown PetscValidIntPointer(nits,2); 50965ef26d82SJed Brown *nits = ts->snes_its; 50979f67acb7SJed Brown PetscFunctionReturn(0); 50989f67acb7SJed Brown } 50999f67acb7SJed Brown 51009f67acb7SJed Brown /*@ 51015ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 51029f67acb7SJed Brown used by the time integrator. 51039f67acb7SJed Brown 51049f67acb7SJed Brown Not Collective 51059f67acb7SJed Brown 51069f67acb7SJed Brown Input Parameter: 51079f67acb7SJed Brown . ts - TS context 51089f67acb7SJed Brown 51099f67acb7SJed Brown Output Parameter: 51109f67acb7SJed Brown . lits - number of linear iterations 51119f67acb7SJed Brown 51129f67acb7SJed Brown Notes: 51139f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 51149f67acb7SJed Brown 51159f67acb7SJed Brown Level: intermediate 51169f67acb7SJed Brown 51179f67acb7SJed Brown .keywords: TS, get, number, linear, iterations 51189f67acb7SJed Brown 51195ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 51209f67acb7SJed Brown @*/ 51215ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 51229f67acb7SJed Brown { 51239f67acb7SJed Brown PetscFunctionBegin; 51249f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 51259f67acb7SJed Brown PetscValidIntPointer(lits,2); 51265ef26d82SJed Brown *lits = ts->ksp_its; 51279f67acb7SJed Brown PetscFunctionReturn(0); 51289f67acb7SJed Brown } 51299f67acb7SJed Brown 5130cef5090cSJed Brown /*@ 5131cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5132cef5090cSJed Brown 5133cef5090cSJed Brown Not Collective 5134cef5090cSJed Brown 5135cef5090cSJed Brown Input Parameter: 5136cef5090cSJed Brown . ts - TS context 5137cef5090cSJed Brown 5138cef5090cSJed Brown Output Parameter: 5139cef5090cSJed Brown . rejects - number of steps rejected 5140cef5090cSJed Brown 5141cef5090cSJed Brown Notes: 5142cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5143cef5090cSJed Brown 5144cef5090cSJed Brown Level: intermediate 5145cef5090cSJed Brown 5146cef5090cSJed Brown .keywords: TS, get, number 5147cef5090cSJed Brown 51485ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5149cef5090cSJed Brown @*/ 5150cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5151cef5090cSJed Brown { 5152cef5090cSJed Brown PetscFunctionBegin; 5153cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5154cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5155cef5090cSJed Brown *rejects = ts->reject; 5156cef5090cSJed Brown PetscFunctionReturn(0); 5157cef5090cSJed Brown } 5158cef5090cSJed Brown 5159cef5090cSJed Brown /*@ 5160cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5161cef5090cSJed Brown 5162cef5090cSJed Brown Not Collective 5163cef5090cSJed Brown 5164cef5090cSJed Brown Input Parameter: 5165cef5090cSJed Brown . ts - TS context 5166cef5090cSJed Brown 5167cef5090cSJed Brown Output Parameter: 5168cef5090cSJed Brown . fails - number of failed nonlinear solves 5169cef5090cSJed Brown 5170cef5090cSJed Brown Notes: 5171cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5172cef5090cSJed Brown 5173cef5090cSJed Brown Level: intermediate 5174cef5090cSJed Brown 5175cef5090cSJed Brown .keywords: TS, get, number 5176cef5090cSJed Brown 51775ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5178cef5090cSJed Brown @*/ 5179cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5180cef5090cSJed Brown { 5181cef5090cSJed Brown PetscFunctionBegin; 5182cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5183cef5090cSJed Brown PetscValidIntPointer(fails,2); 5184cef5090cSJed Brown *fails = ts->num_snes_failures; 5185cef5090cSJed Brown PetscFunctionReturn(0); 5186cef5090cSJed Brown } 5187cef5090cSJed Brown 5188cef5090cSJed Brown /*@ 5189cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5190cef5090cSJed Brown 5191cef5090cSJed Brown Not Collective 5192cef5090cSJed Brown 5193cef5090cSJed Brown Input Parameter: 5194cef5090cSJed Brown + ts - TS context 5195cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5196cef5090cSJed Brown 5197cef5090cSJed Brown Notes: 5198cef5090cSJed Brown The counter is reset to zero for each step 5199cef5090cSJed Brown 5200cef5090cSJed Brown Options Database Key: 5201cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5202cef5090cSJed Brown 5203cef5090cSJed Brown Level: intermediate 5204cef5090cSJed Brown 5205cef5090cSJed Brown .keywords: TS, set, maximum, number 5206cef5090cSJed Brown 52075ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5208cef5090cSJed Brown @*/ 5209cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5210cef5090cSJed Brown { 5211cef5090cSJed Brown PetscFunctionBegin; 5212cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5213cef5090cSJed Brown ts->max_reject = rejects; 5214cef5090cSJed Brown PetscFunctionReturn(0); 5215cef5090cSJed Brown } 5216cef5090cSJed Brown 5217cef5090cSJed Brown /*@ 5218cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5219cef5090cSJed Brown 5220cef5090cSJed Brown Not Collective 5221cef5090cSJed Brown 5222cef5090cSJed Brown Input Parameter: 5223cef5090cSJed Brown + ts - TS context 5224cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5225cef5090cSJed Brown 5226cef5090cSJed Brown Notes: 5227cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5228cef5090cSJed Brown 5229cef5090cSJed Brown Options Database Key: 5230cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5231cef5090cSJed Brown 5232cef5090cSJed Brown Level: intermediate 5233cef5090cSJed Brown 5234cef5090cSJed Brown .keywords: TS, set, maximum, number 5235cef5090cSJed Brown 52365ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5237cef5090cSJed Brown @*/ 5238cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5239cef5090cSJed Brown { 5240cef5090cSJed Brown PetscFunctionBegin; 5241cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5242cef5090cSJed Brown ts->max_snes_failures = fails; 5243cef5090cSJed Brown PetscFunctionReturn(0); 5244cef5090cSJed Brown } 5245cef5090cSJed Brown 5246cef5090cSJed Brown /*@ 5247cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5248cef5090cSJed Brown 5249cef5090cSJed Brown Not Collective 5250cef5090cSJed Brown 5251cef5090cSJed Brown Input Parameter: 5252cef5090cSJed Brown + ts - TS context 5253cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5254cef5090cSJed Brown 5255cef5090cSJed Brown Options Database Key: 5256cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5257cef5090cSJed Brown 5258cef5090cSJed Brown Level: intermediate 5259cef5090cSJed Brown 5260cef5090cSJed Brown .keywords: TS, set, error 5261cef5090cSJed Brown 52625ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5263cef5090cSJed Brown @*/ 5264cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5265cef5090cSJed Brown { 5266cef5090cSJed Brown PetscFunctionBegin; 5267cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5268cef5090cSJed Brown ts->errorifstepfailed = err; 5269cef5090cSJed Brown PetscFunctionReturn(0); 5270cef5090cSJed Brown } 5271cef5090cSJed Brown 5272fb1732b5SBarry Smith /*@C 5273fde5950dSBarry 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 5274fb1732b5SBarry Smith 5275fb1732b5SBarry Smith Collective on TS 5276fb1732b5SBarry Smith 5277fb1732b5SBarry Smith Input Parameters: 5278fb1732b5SBarry Smith + ts - the TS context 5279fb1732b5SBarry Smith . step - current time-step 5280fb1732b5SBarry Smith . ptime - current time 52810910c330SBarry Smith . u - current state 5282721cd6eeSBarry Smith - vf - viewer and its format 5283fb1732b5SBarry Smith 5284fb1732b5SBarry Smith Level: intermediate 5285fb1732b5SBarry Smith 5286fb1732b5SBarry Smith .keywords: TS, vector, monitor, view 5287fb1732b5SBarry Smith 5288fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5289fb1732b5SBarry Smith @*/ 5290721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5291fb1732b5SBarry Smith { 5292fb1732b5SBarry Smith PetscErrorCode ierr; 5293fb1732b5SBarry Smith 5294fb1732b5SBarry Smith PetscFunctionBegin; 5295721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5296721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5297721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5298ed81e22dSJed Brown PetscFunctionReturn(0); 5299ed81e22dSJed Brown } 5300ed81e22dSJed Brown 5301ed81e22dSJed Brown /*@C 5302ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5303ed81e22dSJed Brown 5304ed81e22dSJed Brown Collective on TS 5305ed81e22dSJed Brown 5306ed81e22dSJed Brown Input Parameters: 5307ed81e22dSJed Brown + ts - the TS context 5308ed81e22dSJed Brown . step - current time-step 5309ed81e22dSJed Brown . ptime - current time 53100910c330SBarry Smith . u - current state 5311ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5312ed81e22dSJed Brown 5313ed81e22dSJed Brown Level: intermediate 5314ed81e22dSJed Brown 5315ed81e22dSJed Brown Notes: 5316ed81e22dSJed 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. 5317ed81e22dSJed Brown These are named according to the file name template. 5318ed81e22dSJed Brown 5319ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5320ed81e22dSJed Brown 5321ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5322ed81e22dSJed Brown 5323ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5324ed81e22dSJed Brown @*/ 53250910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5326ed81e22dSJed Brown { 5327ed81e22dSJed Brown PetscErrorCode ierr; 5328ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5329ed81e22dSJed Brown PetscViewer viewer; 5330ed81e22dSJed Brown 5331ed81e22dSJed Brown PetscFunctionBegin; 533263e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 53338caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5334ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 53350910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5336ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5337ed81e22dSJed Brown PetscFunctionReturn(0); 5338ed81e22dSJed Brown } 5339ed81e22dSJed Brown 5340ed81e22dSJed Brown /*@C 5341ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5342ed81e22dSJed Brown 5343ed81e22dSJed Brown Collective on TS 5344ed81e22dSJed Brown 5345ed81e22dSJed Brown Input Parameters: 5346ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5347ed81e22dSJed Brown 5348ed81e22dSJed Brown Level: intermediate 5349ed81e22dSJed Brown 5350ed81e22dSJed Brown Note: 5351ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5352ed81e22dSJed Brown 5353ed81e22dSJed Brown .keywords: TS, vector, monitor, view 5354ed81e22dSJed Brown 5355ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5356ed81e22dSJed Brown @*/ 5357ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5358ed81e22dSJed Brown { 5359ed81e22dSJed Brown PetscErrorCode ierr; 5360ed81e22dSJed Brown 5361ed81e22dSJed Brown PetscFunctionBegin; 5362ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5363fb1732b5SBarry Smith PetscFunctionReturn(0); 5364fb1732b5SBarry Smith } 5365fb1732b5SBarry Smith 536684df9cb4SJed Brown /*@ 5367552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 536884df9cb4SJed Brown 5369ed81e22dSJed Brown Collective on TS if controller has not been created yet 537084df9cb4SJed Brown 537184df9cb4SJed Brown Input Arguments: 5372ed81e22dSJed Brown . ts - time stepping context 537384df9cb4SJed Brown 537484df9cb4SJed Brown Output Arguments: 5375ed81e22dSJed Brown . adapt - adaptive controller 537684df9cb4SJed Brown 537784df9cb4SJed Brown Level: intermediate 537884df9cb4SJed Brown 5379ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 538084df9cb4SJed Brown @*/ 5381552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 538284df9cb4SJed Brown { 538384df9cb4SJed Brown PetscErrorCode ierr; 538484df9cb4SJed Brown 538584df9cb4SJed Brown PetscFunctionBegin; 538684df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5387bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 538884df9cb4SJed Brown if (!ts->adapt) { 5389ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 53903bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 53911c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 539284df9cb4SJed Brown } 5393bec58848SLisandro Dalcin *adapt = ts->adapt; 539484df9cb4SJed Brown PetscFunctionReturn(0); 539584df9cb4SJed Brown } 5396d6ebe24aSShri Abhyankar 53971c3436cfSJed Brown /*@ 53981c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 53991c3436cfSJed Brown 54001c3436cfSJed Brown Logically Collective 54011c3436cfSJed Brown 54021c3436cfSJed Brown Input Arguments: 54031c3436cfSJed Brown + ts - time integration context 54041c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 54050298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 54061c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 54070298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 54081c3436cfSJed Brown 5409a3cdaa26SBarry Smith Options Database keys: 5410a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5411a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5412a3cdaa26SBarry Smith 54133ff766beSShri Abhyankar Notes: 54143ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 54153ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 54163ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 54173ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 54183ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 54193ff766beSShri Abhyankar differential variables. 54203ff766beSShri Abhyankar 54211c3436cfSJed Brown Level: beginner 54221c3436cfSJed Brown 5423c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances() 54241c3436cfSJed Brown @*/ 54251c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 54261c3436cfSJed Brown { 54271c3436cfSJed Brown PetscErrorCode ierr; 54281c3436cfSJed Brown 54291c3436cfSJed Brown PetscFunctionBegin; 5430c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 54311c3436cfSJed Brown if (vatol) { 54321c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 54331c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 54341c3436cfSJed Brown ts->vatol = vatol; 54351c3436cfSJed Brown } 5436c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 54371c3436cfSJed Brown if (vrtol) { 54381c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 54391c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 54401c3436cfSJed Brown ts->vrtol = vrtol; 54411c3436cfSJed Brown } 54421c3436cfSJed Brown PetscFunctionReturn(0); 54431c3436cfSJed Brown } 54441c3436cfSJed Brown 5445c5033834SJed Brown /*@ 5446c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5447c5033834SJed Brown 5448c5033834SJed Brown Logically Collective 5449c5033834SJed Brown 5450c5033834SJed Brown Input Arguments: 5451c5033834SJed Brown . ts - time integration context 5452c5033834SJed Brown 5453c5033834SJed Brown Output Arguments: 54540298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 54550298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 54560298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 54570298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5458c5033834SJed Brown 5459c5033834SJed Brown Level: beginner 5460c5033834SJed Brown 5461c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances() 5462c5033834SJed Brown @*/ 5463c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5464c5033834SJed Brown { 5465c5033834SJed Brown PetscFunctionBegin; 5466c5033834SJed Brown if (atol) *atol = ts->atol; 5467c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5468c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5469c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5470c5033834SJed Brown PetscFunctionReturn(0); 5471c5033834SJed Brown } 5472c5033834SJed Brown 54739c6b16b5SShri Abhyankar /*@ 5474a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 54759c6b16b5SShri Abhyankar 54769c6b16b5SShri Abhyankar Collective on TS 54779c6b16b5SShri Abhyankar 54789c6b16b5SShri Abhyankar Input Arguments: 54799c6b16b5SShri Abhyankar + ts - time stepping context 5480a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5481a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 54829c6b16b5SShri Abhyankar 54839c6b16b5SShri Abhyankar Output Arguments: 54847453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 54857453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 54867453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 54879c6b16b5SShri Abhyankar 54889c6b16b5SShri Abhyankar Level: developer 54899c6b16b5SShri Abhyankar 5490deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 54919c6b16b5SShri Abhyankar @*/ 54927453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 54939c6b16b5SShri Abhyankar { 54949c6b16b5SShri Abhyankar PetscErrorCode ierr; 54959c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 54967453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 54977453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 54989c6b16b5SShri Abhyankar const PetscScalar *u,*y; 54997453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 55007453f775SEmil Constantinescu PetscReal tol,tola,tolr; 55017453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 55029c6b16b5SShri Abhyankar 55039c6b16b5SShri Abhyankar PetscFunctionBegin; 55049c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5505a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5506a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5507a4868fbcSLisandro Dalcin PetscValidType(U,2); 5508a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5509a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5510a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 55118a175baeSEmil Constantinescu PetscValidPointer(norma,5); 55128a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5513a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 55149c6b16b5SShri Abhyankar 55159c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 55169c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 55179c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 55189c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 55199c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 55207453f775SEmil Constantinescu sum = 0.; n_loc = 0; 55217453f775SEmil Constantinescu suma = 0.; na_loc = 0; 55227453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 55239c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 55249c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 55259c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55269c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55279c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 55287453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55297453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 55307453f775SEmil Constantinescu if(tola>0.){ 55317453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 55327453f775SEmil Constantinescu na_loc++; 55337453f775SEmil Constantinescu } 55347453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55357453f775SEmil Constantinescu if(tolr>0.){ 55367453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 55377453f775SEmil Constantinescu nr_loc++; 55387453f775SEmil Constantinescu } 55397453f775SEmil Constantinescu tol=tola+tolr; 55407453f775SEmil Constantinescu if(tol>0.){ 55417453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 55427453f775SEmil Constantinescu n_loc++; 55437453f775SEmil Constantinescu } 55449c6b16b5SShri Abhyankar } 55459c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55469c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55479c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 55489c6b16b5SShri Abhyankar const PetscScalar *atol; 55499c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55509c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 55517453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55527453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 55537453f775SEmil Constantinescu if(tola>0.){ 55547453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 55557453f775SEmil Constantinescu na_loc++; 55567453f775SEmil Constantinescu } 55577453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55587453f775SEmil Constantinescu if(tolr>0.){ 55597453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 55607453f775SEmil Constantinescu nr_loc++; 55617453f775SEmil Constantinescu } 55627453f775SEmil Constantinescu tol=tola+tolr; 55637453f775SEmil Constantinescu if(tol>0.){ 55647453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 55657453f775SEmil Constantinescu n_loc++; 55667453f775SEmil Constantinescu } 55679c6b16b5SShri Abhyankar } 55689c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 55699c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 55709c6b16b5SShri Abhyankar const PetscScalar *rtol; 55719c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55729c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 55737453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55747453f775SEmil Constantinescu tola = ts->atol; 55757453f775SEmil Constantinescu if(tola>0.){ 55767453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 55777453f775SEmil Constantinescu na_loc++; 55787453f775SEmil Constantinescu } 55797453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 55807453f775SEmil Constantinescu if(tolr>0.){ 55817453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 55827453f775SEmil Constantinescu nr_loc++; 55837453f775SEmil Constantinescu } 55847453f775SEmil Constantinescu tol=tola+tolr; 55857453f775SEmil Constantinescu if(tol>0.){ 55867453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 55877453f775SEmil Constantinescu n_loc++; 55887453f775SEmil Constantinescu } 55899c6b16b5SShri Abhyankar } 55909c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 55919c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 55929c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 55937453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 55947453f775SEmil Constantinescu tola = ts->atol; 55957453f775SEmil Constantinescu if(tola>0.){ 55967453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 55977453f775SEmil Constantinescu na_loc++; 55987453f775SEmil Constantinescu } 55997453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 56007453f775SEmil Constantinescu if(tolr>0.){ 56017453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 56027453f775SEmil Constantinescu nr_loc++; 56037453f775SEmil Constantinescu } 56047453f775SEmil Constantinescu tol=tola+tolr; 56057453f775SEmil Constantinescu if(tol>0.){ 56067453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 56077453f775SEmil Constantinescu n_loc++; 56087453f775SEmil Constantinescu } 56099c6b16b5SShri Abhyankar } 56109c6b16b5SShri Abhyankar } 56119c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 56129c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 56139c6b16b5SShri Abhyankar 56147453f775SEmil Constantinescu err_loc[0] = sum; 56157453f775SEmil Constantinescu err_loc[1] = suma; 56167453f775SEmil Constantinescu err_loc[2] = sumr; 56177453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 56187453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 56197453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 56207453f775SEmil Constantinescu 5621a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 56227453f775SEmil Constantinescu 56237453f775SEmil Constantinescu gsum = err_glb[0]; 56247453f775SEmil Constantinescu gsuma = err_glb[1]; 56257453f775SEmil Constantinescu gsumr = err_glb[2]; 56267453f775SEmil Constantinescu n_glb = err_glb[3]; 56277453f775SEmil Constantinescu na_glb = err_glb[4]; 56287453f775SEmil Constantinescu nr_glb = err_glb[5]; 56297453f775SEmil Constantinescu 5630b1316ef9SEmil Constantinescu *norm = 0.; 5631b1316ef9SEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 5632b1316ef9SEmil Constantinescu *norma = 0.; 5633b1316ef9SEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5634b1316ef9SEmil Constantinescu *normr = 0.; 5635b1316ef9SEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 56369c6b16b5SShri Abhyankar 56379c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 56387453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 56397453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 56409c6b16b5SShri Abhyankar PetscFunctionReturn(0); 56419c6b16b5SShri Abhyankar } 56429c6b16b5SShri Abhyankar 56439c6b16b5SShri Abhyankar /*@ 5644a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 56459c6b16b5SShri Abhyankar 56469c6b16b5SShri Abhyankar Collective on TS 56479c6b16b5SShri Abhyankar 56489c6b16b5SShri Abhyankar Input Arguments: 56499c6b16b5SShri Abhyankar + ts - time stepping context 5650a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5651a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 56529c6b16b5SShri Abhyankar 56539c6b16b5SShri Abhyankar Output Arguments: 56547453f775SEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 56557453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 56567453f775SEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 56579c6b16b5SShri Abhyankar 56589c6b16b5SShri Abhyankar Level: developer 56599c6b16b5SShri Abhyankar 5660deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 56619c6b16b5SShri Abhyankar @*/ 56627453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 56639c6b16b5SShri Abhyankar { 56649c6b16b5SShri Abhyankar PetscErrorCode ierr; 56657453f775SEmil Constantinescu PetscInt i,n,N,rstart; 56669c6b16b5SShri Abhyankar const PetscScalar *u,*y; 56677453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 56687453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 56697453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 56709c6b16b5SShri Abhyankar 56719c6b16b5SShri Abhyankar PetscFunctionBegin; 56729c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5673a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5674a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5675a4868fbcSLisandro Dalcin PetscValidType(U,2); 5676a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5677a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5678a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 56798a175baeSEmil Constantinescu PetscValidPointer(norma,5); 56808a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5681a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 56829c6b16b5SShri Abhyankar 56839c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 56849c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 56859c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 56869c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 56879c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 56887453f775SEmil Constantinescu 56897453f775SEmil Constantinescu max=0.; 56907453f775SEmil Constantinescu maxa=0.; 56917453f775SEmil Constantinescu maxr=0.; 56927453f775SEmil Constantinescu 56937453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 56949c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 56959c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 56969c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 56977453f775SEmil Constantinescu 56987453f775SEmil Constantinescu for (i=0; i<n; i++) { 56997453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57007453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 57017453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57027453f775SEmil Constantinescu tol = tola+tolr; 57037453f775SEmil Constantinescu if(tola>0.){ 57047453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 57057453f775SEmil Constantinescu } 57067453f775SEmil Constantinescu if(tolr>0.){ 57077453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 57087453f775SEmil Constantinescu } 57097453f775SEmil Constantinescu if(tol>0.){ 57107453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 57117453f775SEmil Constantinescu } 57129c6b16b5SShri Abhyankar } 57139c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57149c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57159c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 57169c6b16b5SShri Abhyankar const PetscScalar *atol; 57179c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57187453f775SEmil Constantinescu for (i=0; i<n; i++) { 57197453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57207453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 57217453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57227453f775SEmil Constantinescu tol = tola+tolr; 57237453f775SEmil Constantinescu if(tola>0.){ 57247453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 57257453f775SEmil Constantinescu } 57267453f775SEmil Constantinescu if(tolr>0.){ 57277453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 57287453f775SEmil Constantinescu } 57297453f775SEmil Constantinescu if(tol>0.){ 57307453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 57317453f775SEmil Constantinescu } 57329c6b16b5SShri Abhyankar } 57339c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57349c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 57359c6b16b5SShri Abhyankar const PetscScalar *rtol; 57369c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57377453f775SEmil Constantinescu 57387453f775SEmil Constantinescu for (i=0; i<n; i++) { 57397453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57407453f775SEmil Constantinescu tola = ts->atol; 57417453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57427453f775SEmil Constantinescu tol = tola+tolr; 57437453f775SEmil Constantinescu if(tola>0.){ 57447453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 57457453f775SEmil Constantinescu } 57467453f775SEmil Constantinescu if(tolr>0.){ 57477453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 57487453f775SEmil Constantinescu } 57497453f775SEmil Constantinescu if(tol>0.){ 57507453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 57517453f775SEmil Constantinescu } 57529c6b16b5SShri Abhyankar } 57539c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57549c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 57557453f775SEmil Constantinescu 57567453f775SEmil Constantinescu for (i=0; i<n; i++) { 57577453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57587453f775SEmil Constantinescu tola = ts->atol; 57597453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57607453f775SEmil Constantinescu tol = tola+tolr; 57617453f775SEmil Constantinescu if(tola>0.){ 57627453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 57637453f775SEmil Constantinescu } 57647453f775SEmil Constantinescu if(tolr>0.){ 57657453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 57667453f775SEmil Constantinescu } 57677453f775SEmil Constantinescu if(tol>0.){ 57687453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 57697453f775SEmil Constantinescu } 57709c6b16b5SShri Abhyankar } 57719c6b16b5SShri Abhyankar } 57729c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 57739c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 57747453f775SEmil Constantinescu err_loc[0] = max; 57757453f775SEmil Constantinescu err_loc[1] = maxa; 57767453f775SEmil Constantinescu err_loc[2] = maxr; 5777a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 57787453f775SEmil Constantinescu gmax = err_glb[0]; 57797453f775SEmil Constantinescu gmaxa = err_glb[1]; 57807453f775SEmil Constantinescu gmaxr = err_glb[2]; 57819c6b16b5SShri Abhyankar 57829c6b16b5SShri Abhyankar *norm = gmax; 57837453f775SEmil Constantinescu *norma = gmaxa; 57847453f775SEmil Constantinescu *normr = gmaxr; 57859c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 57867453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 57877453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 57889c6b16b5SShri Abhyankar PetscFunctionReturn(0); 57899c6b16b5SShri Abhyankar } 57909c6b16b5SShri Abhyankar 57911c3436cfSJed Brown /*@ 57928a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 57931c3436cfSJed Brown 57941c3436cfSJed Brown Collective on TS 57951c3436cfSJed Brown 57961c3436cfSJed Brown Input Arguments: 57971c3436cfSJed Brown + ts - time stepping context 5798a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5799a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 5800a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 58017619abb3SShri 58021c3436cfSJed Brown Output Arguments: 58038a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 58048a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 58058a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 5806a4868fbcSLisandro Dalcin 5807a4868fbcSLisandro Dalcin Options Database Keys: 5808a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5809a4868fbcSLisandro Dalcin 58101c3436cfSJed Brown Level: developer 58111c3436cfSJed Brown 58128a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 58131c3436cfSJed Brown @*/ 58147453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58151c3436cfSJed Brown { 58168beabaa1SBarry Smith PetscErrorCode ierr; 58171c3436cfSJed Brown 58181c3436cfSJed Brown PetscFunctionBegin; 5819a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 58207453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5821a4868fbcSLisandro Dalcin } else if(wnormtype == NORM_INFINITY) { 58227453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 5823a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 58241c3436cfSJed Brown PetscFunctionReturn(0); 58251c3436cfSJed Brown } 58261c3436cfSJed Brown 58278a175baeSEmil Constantinescu 58288a175baeSEmil Constantinescu /*@ 58298a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 58308a175baeSEmil Constantinescu 58318a175baeSEmil Constantinescu Collective on TS 58328a175baeSEmil Constantinescu 58338a175baeSEmil Constantinescu Input Arguments: 58348a175baeSEmil Constantinescu + ts - time stepping context 58358a175baeSEmil Constantinescu . E - error vector 58368a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 58378a175baeSEmil Constantinescu - Y - state vector, previous time step 58388a175baeSEmil Constantinescu 58398a175baeSEmil Constantinescu Output Arguments: 58408a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58418a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 58428a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58438a175baeSEmil Constantinescu 58448a175baeSEmil Constantinescu Level: developer 58458a175baeSEmil Constantinescu 58468a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 58478a175baeSEmil Constantinescu @*/ 58488a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58498a175baeSEmil Constantinescu { 58508a175baeSEmil Constantinescu PetscErrorCode ierr; 58518a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 58528a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 58538a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 58548a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 58558a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 58568a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 58578a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 58588a175baeSEmil Constantinescu 58598a175baeSEmil Constantinescu PetscFunctionBegin; 58608a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 58618a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 58628a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 58638a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 58648a175baeSEmil Constantinescu PetscValidType(E,2); 58658a175baeSEmil Constantinescu PetscValidType(U,3); 58668a175baeSEmil Constantinescu PetscValidType(Y,4); 58678a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 58688a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 58698a175baeSEmil Constantinescu PetscValidPointer(norm,5); 58708a175baeSEmil Constantinescu PetscValidPointer(norma,6); 58718a175baeSEmil Constantinescu PetscValidPointer(normr,7); 58728a175baeSEmil Constantinescu 58738a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 58748a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 58758a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 58768a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 58778a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 58788a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 58798a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 58808a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 58818a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 58828a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 58838a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 58848a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 58858a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58868a175baeSEmil Constantinescu for (i=0; i<n; i++) { 58878a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 58888a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 58898a175baeSEmil Constantinescu if(tola>0.){ 58908a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 58918a175baeSEmil Constantinescu na_loc++; 58928a175baeSEmil Constantinescu } 58938a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58948a175baeSEmil Constantinescu if(tolr>0.){ 58958a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 58968a175baeSEmil Constantinescu nr_loc++; 58978a175baeSEmil Constantinescu } 58988a175baeSEmil Constantinescu tol=tola+tolr; 58998a175baeSEmil Constantinescu if(tol>0.){ 59008a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 59018a175baeSEmil Constantinescu n_loc++; 59028a175baeSEmil Constantinescu } 59038a175baeSEmil Constantinescu } 59048a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59058a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59068a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 59078a175baeSEmil Constantinescu const PetscScalar *atol; 59088a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59098a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59108a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59118a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 59128a175baeSEmil Constantinescu if(tola>0.){ 59138a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 59148a175baeSEmil Constantinescu na_loc++; 59158a175baeSEmil Constantinescu } 59168a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59178a175baeSEmil Constantinescu if(tolr>0.){ 59188a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 59198a175baeSEmil Constantinescu nr_loc++; 59208a175baeSEmil Constantinescu } 59218a175baeSEmil Constantinescu tol=tola+tolr; 59228a175baeSEmil Constantinescu if(tol>0.){ 59238a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 59248a175baeSEmil Constantinescu n_loc++; 59258a175baeSEmil Constantinescu } 59268a175baeSEmil Constantinescu } 59278a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59288a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 59298a175baeSEmil Constantinescu const PetscScalar *rtol; 59308a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59318a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59328a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59338a175baeSEmil Constantinescu tola = ts->atol; 59348a175baeSEmil Constantinescu if(tola>0.){ 59358a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 59368a175baeSEmil Constantinescu na_loc++; 59378a175baeSEmil Constantinescu } 59388a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59398a175baeSEmil Constantinescu if(tolr>0.){ 59408a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 59418a175baeSEmil Constantinescu nr_loc++; 59428a175baeSEmil Constantinescu } 59438a175baeSEmil Constantinescu tol=tola+tolr; 59448a175baeSEmil Constantinescu if(tol>0.){ 59458a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 59468a175baeSEmil Constantinescu n_loc++; 59478a175baeSEmil Constantinescu } 59488a175baeSEmil Constantinescu } 59498a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59508a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 59518a175baeSEmil Constantinescu for (i=0; i<n; i++) { 59528a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 59538a175baeSEmil Constantinescu tola = ts->atol; 59548a175baeSEmil Constantinescu if(tola>0.){ 59558a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 59568a175baeSEmil Constantinescu na_loc++; 59578a175baeSEmil Constantinescu } 59588a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59598a175baeSEmil Constantinescu if(tolr>0.){ 59608a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 59618a175baeSEmil Constantinescu nr_loc++; 59628a175baeSEmil Constantinescu } 59638a175baeSEmil Constantinescu tol=tola+tolr; 59648a175baeSEmil Constantinescu if(tol>0.){ 59658a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 59668a175baeSEmil Constantinescu n_loc++; 59678a175baeSEmil Constantinescu } 59688a175baeSEmil Constantinescu } 59698a175baeSEmil Constantinescu } 59708a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 59718a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 59728a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 59738a175baeSEmil Constantinescu 59748a175baeSEmil Constantinescu err_loc[0] = sum; 59758a175baeSEmil Constantinescu err_loc[1] = suma; 59768a175baeSEmil Constantinescu err_loc[2] = sumr; 59778a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 59788a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 59798a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 59808a175baeSEmil Constantinescu 5981a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 59828a175baeSEmil Constantinescu 59838a175baeSEmil Constantinescu gsum = err_glb[0]; 59848a175baeSEmil Constantinescu gsuma = err_glb[1]; 59858a175baeSEmil Constantinescu gsumr = err_glb[2]; 59868a175baeSEmil Constantinescu n_glb = err_glb[3]; 59878a175baeSEmil Constantinescu na_glb = err_glb[4]; 59888a175baeSEmil Constantinescu nr_glb = err_glb[5]; 59898a175baeSEmil Constantinescu 59908a175baeSEmil Constantinescu *norm = 0.; 59918a175baeSEmil Constantinescu if(n_glb>0. ){*norm = PetscSqrtReal(gsum / n_glb );} 59928a175baeSEmil Constantinescu *norma = 0.; 59938a175baeSEmil Constantinescu if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 59948a175baeSEmil Constantinescu *normr = 0.; 59958a175baeSEmil Constantinescu if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 59968a175baeSEmil Constantinescu 59978a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 59988a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 59998a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 60008a175baeSEmil Constantinescu PetscFunctionReturn(0); 60018a175baeSEmil Constantinescu } 60028a175baeSEmil Constantinescu 60038a175baeSEmil Constantinescu /*@ 60048a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 60058a175baeSEmil Constantinescu Collective on TS 60068a175baeSEmil Constantinescu 60078a175baeSEmil Constantinescu Input Arguments: 60088a175baeSEmil Constantinescu + ts - time stepping context 60098a175baeSEmil Constantinescu . E - error vector 60108a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 60118a175baeSEmil Constantinescu - Y - state vector, previous time step 60128a175baeSEmil Constantinescu 60138a175baeSEmil Constantinescu Output Arguments: 60148a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 means that the error matches the tolerances 60158a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 60168a175baeSEmil Constantinescu . normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 60178a175baeSEmil Constantinescu 60188a175baeSEmil Constantinescu Level: developer 60198a175baeSEmil Constantinescu 60208a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 60218a175baeSEmil Constantinescu @*/ 60228a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60238a175baeSEmil Constantinescu { 60248a175baeSEmil Constantinescu PetscErrorCode ierr; 60258a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 60268a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 60278a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 60288a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 60298a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 60308a175baeSEmil Constantinescu 60318a175baeSEmil Constantinescu PetscFunctionBegin; 60328a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 60338a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 60348a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 60358a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 60368a175baeSEmil Constantinescu PetscValidType(E,2); 60378a175baeSEmil Constantinescu PetscValidType(U,3); 60388a175baeSEmil Constantinescu PetscValidType(Y,4); 60398a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 60408a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 60418a175baeSEmil Constantinescu PetscValidPointer(norm,5); 60428a175baeSEmil Constantinescu PetscValidPointer(norma,6); 60438a175baeSEmil Constantinescu PetscValidPointer(normr,7); 60448a175baeSEmil Constantinescu 60458a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 60468a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 60478a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 60488a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 60498a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 60508a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 60518a175baeSEmil Constantinescu 60528a175baeSEmil Constantinescu max=0.; 60538a175baeSEmil Constantinescu maxa=0.; 60548a175baeSEmil Constantinescu maxr=0.; 60558a175baeSEmil Constantinescu 60568a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 60578a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 60588a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60598a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60608a175baeSEmil Constantinescu 60618a175baeSEmil Constantinescu for (i=0; i<n; i++) { 60628a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 60638a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 60648a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60658a175baeSEmil Constantinescu tol = tola+tolr; 60668a175baeSEmil Constantinescu if(tola>0.){ 60678a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 60688a175baeSEmil Constantinescu } 60698a175baeSEmil Constantinescu if(tolr>0.){ 60708a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 60718a175baeSEmil Constantinescu } 60728a175baeSEmil Constantinescu if(tol>0.){ 60738a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 60748a175baeSEmil Constantinescu } 60758a175baeSEmil Constantinescu } 60768a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60778a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 60788a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 60798a175baeSEmil Constantinescu const PetscScalar *atol; 60808a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60818a175baeSEmil Constantinescu for (i=0; i<n; i++) { 60828a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 60838a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 60848a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 60858a175baeSEmil Constantinescu tol = tola+tolr; 60868a175baeSEmil Constantinescu if(tola>0.){ 60878a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 60888a175baeSEmil Constantinescu } 60898a175baeSEmil Constantinescu if(tolr>0.){ 60908a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 60918a175baeSEmil Constantinescu } 60928a175baeSEmil Constantinescu if(tol>0.){ 60938a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 60948a175baeSEmil Constantinescu } 60958a175baeSEmil Constantinescu } 60968a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 60978a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 60988a175baeSEmil Constantinescu const PetscScalar *rtol; 60998a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61008a175baeSEmil Constantinescu 61018a175baeSEmil Constantinescu for (i=0; i<n; i++) { 61028a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61038a175baeSEmil Constantinescu tola = ts->atol; 61048a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61058a175baeSEmil Constantinescu tol = tola+tolr; 61068a175baeSEmil Constantinescu if(tola>0.){ 61078a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 61088a175baeSEmil Constantinescu } 61098a175baeSEmil Constantinescu if(tolr>0.){ 61108a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 61118a175baeSEmil Constantinescu } 61128a175baeSEmil Constantinescu if(tol>0.){ 61138a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 61148a175baeSEmil Constantinescu } 61158a175baeSEmil Constantinescu } 61168a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61178a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 61188a175baeSEmil Constantinescu 61198a175baeSEmil Constantinescu for (i=0; i<n; i++) { 61208a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61218a175baeSEmil Constantinescu tola = ts->atol; 61228a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61238a175baeSEmil Constantinescu tol = tola+tolr; 61248a175baeSEmil Constantinescu if(tola>0.){ 61258a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 61268a175baeSEmil Constantinescu } 61278a175baeSEmil Constantinescu if(tolr>0.){ 61288a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 61298a175baeSEmil Constantinescu } 61308a175baeSEmil Constantinescu if(tol>0.){ 61318a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 61328a175baeSEmil Constantinescu } 61338a175baeSEmil Constantinescu } 61348a175baeSEmil Constantinescu } 61358a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 61368a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 61378a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 61388a175baeSEmil Constantinescu err_loc[0] = max; 61398a175baeSEmil Constantinescu err_loc[1] = maxa; 61408a175baeSEmil Constantinescu err_loc[2] = maxr; 6141a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 61428a175baeSEmil Constantinescu gmax = err_glb[0]; 61438a175baeSEmil Constantinescu gmaxa = err_glb[1]; 61448a175baeSEmil Constantinescu gmaxr = err_glb[2]; 61458a175baeSEmil Constantinescu 61468a175baeSEmil Constantinescu *norm = gmax; 61478a175baeSEmil Constantinescu *norma = gmaxa; 61488a175baeSEmil Constantinescu *normr = gmaxr; 61498a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 61508a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 61518a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 61528a175baeSEmil Constantinescu PetscFunctionReturn(0); 61538a175baeSEmil Constantinescu } 61548a175baeSEmil Constantinescu 61558a175baeSEmil Constantinescu /*@ 61568a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 61578a175baeSEmil Constantinescu 61588a175baeSEmil Constantinescu Collective on TS 61598a175baeSEmil Constantinescu 61608a175baeSEmil Constantinescu Input Arguments: 61618a175baeSEmil Constantinescu + ts - time stepping context 61628a175baeSEmil Constantinescu . E - error vector 61638a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 61648a175baeSEmil Constantinescu . Y - state vector, previous time step 61658a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 61668a175baeSEmil Constantinescu 61678a175baeSEmil Constantinescu Output Arguments: 61688a175baeSEmil Constantinescu . norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 61698a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 61708a175baeSEmil Constantinescu . normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 61718a175baeSEmil Constantinescu 61728a175baeSEmil Constantinescu Options Database Keys: 61738a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 61748a175baeSEmil Constantinescu 61758a175baeSEmil Constantinescu Level: developer 61768a175baeSEmil Constantinescu 61778a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 61788a175baeSEmil Constantinescu @*/ 61798a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 61808a175baeSEmil Constantinescu { 61818a175baeSEmil Constantinescu PetscErrorCode ierr; 61828a175baeSEmil Constantinescu 61838a175baeSEmil Constantinescu PetscFunctionBegin; 61848a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 61858a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 61868a175baeSEmil Constantinescu } else if(wnormtype == NORM_INFINITY) { 61878a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 61888a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 61898a175baeSEmil Constantinescu PetscFunctionReturn(0); 61908a175baeSEmil Constantinescu } 61918a175baeSEmil Constantinescu 61928a175baeSEmil Constantinescu 61938d59e960SJed Brown /*@ 61948d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 61958d59e960SJed Brown 61968d59e960SJed Brown Logically Collective on TS 61978d59e960SJed Brown 61988d59e960SJed Brown Input Arguments: 61998d59e960SJed Brown + ts - time stepping context 62008d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 62018d59e960SJed Brown 62028d59e960SJed Brown Note: 62038d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 62048d59e960SJed Brown 62058d59e960SJed Brown Level: intermediate 62068d59e960SJed Brown 62078d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 62088d59e960SJed Brown @*/ 62098d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 62108d59e960SJed Brown { 62118d59e960SJed Brown PetscFunctionBegin; 62128d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62138d59e960SJed Brown ts->cfltime_local = cfltime; 62148d59e960SJed Brown ts->cfltime = -1.; 62158d59e960SJed Brown PetscFunctionReturn(0); 62168d59e960SJed Brown } 62178d59e960SJed Brown 62188d59e960SJed Brown /*@ 62198d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 62208d59e960SJed Brown 62218d59e960SJed Brown Collective on TS 62228d59e960SJed Brown 62238d59e960SJed Brown Input Arguments: 62248d59e960SJed Brown . ts - time stepping context 62258d59e960SJed Brown 62268d59e960SJed Brown Output Arguments: 62278d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 62288d59e960SJed Brown 62298d59e960SJed Brown Level: advanced 62308d59e960SJed Brown 62318d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 62328d59e960SJed Brown @*/ 62338d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 62348d59e960SJed Brown { 62358d59e960SJed Brown PetscErrorCode ierr; 62368d59e960SJed Brown 62378d59e960SJed Brown PetscFunctionBegin; 62388d59e960SJed Brown if (ts->cfltime < 0) { 6239b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 62408d59e960SJed Brown } 62418d59e960SJed Brown *cfltime = ts->cfltime; 62428d59e960SJed Brown PetscFunctionReturn(0); 62438d59e960SJed Brown } 62448d59e960SJed Brown 6245d6ebe24aSShri Abhyankar /*@ 6246d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6247d6ebe24aSShri Abhyankar 6248d6ebe24aSShri Abhyankar Input Parameters: 6249d6ebe24aSShri Abhyankar . ts - the TS context. 6250d6ebe24aSShri Abhyankar . xl - lower bound. 6251d6ebe24aSShri Abhyankar . xu - upper bound. 6252d6ebe24aSShri Abhyankar 6253d6ebe24aSShri Abhyankar Notes: 6254d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6255e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6256d6ebe24aSShri Abhyankar 62572bd2b0e6SSatish Balay Level: advanced 62582bd2b0e6SSatish Balay 6259d6ebe24aSShri Abhyankar @*/ 6260d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6261d6ebe24aSShri Abhyankar { 6262d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6263d6ebe24aSShri Abhyankar SNES snes; 6264d6ebe24aSShri Abhyankar 6265d6ebe24aSShri Abhyankar PetscFunctionBegin; 6266d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6267d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6268d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6269d6ebe24aSShri Abhyankar } 6270d6ebe24aSShri Abhyankar 6271325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 6272c6db04a5SJed Brown #include <mex.h> 6273325fc9f4SBarry Smith 6274325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext; 6275325fc9f4SBarry Smith 6276325fc9f4SBarry Smith /* 6277325fc9f4SBarry Smith TSComputeFunction_Matlab - Calls the function that has been set with 6278325fc9f4SBarry Smith TSSetFunctionMatlab(). 6279325fc9f4SBarry Smith 6280325fc9f4SBarry Smith Collective on TS 6281325fc9f4SBarry Smith 6282325fc9f4SBarry Smith Input Parameters: 6283325fc9f4SBarry Smith + snes - the TS context 62840910c330SBarry Smith - u - input vector 6285325fc9f4SBarry Smith 6286325fc9f4SBarry Smith Output Parameter: 6287325fc9f4SBarry Smith . y - function vector, as set by TSSetFunction() 6288325fc9f4SBarry Smith 6289325fc9f4SBarry Smith Notes: 6290325fc9f4SBarry Smith TSComputeFunction() is typically used within nonlinear solvers 6291325fc9f4SBarry Smith implementations, so most users would not generally call this routine 6292325fc9f4SBarry Smith themselves. 6293325fc9f4SBarry Smith 6294325fc9f4SBarry Smith Level: developer 6295325fc9f4SBarry Smith 6296325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6297325fc9f4SBarry Smith 6298325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6299325fc9f4SBarry Smith */ 63000910c330SBarry Smith PetscErrorCode TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx) 6301325fc9f4SBarry Smith { 6302325fc9f4SBarry Smith PetscErrorCode ierr; 6303325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6304325fc9f4SBarry Smith int nlhs = 1,nrhs = 7; 6305325fc9f4SBarry Smith mxArray *plhs[1],*prhs[7]; 6306325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,ly = 0,ls = 0; 6307325fc9f4SBarry Smith 6308325fc9f4SBarry Smith PetscFunctionBegin; 6309325fc9f4SBarry Smith PetscValidHeaderSpecific(snes,TS_CLASSID,1); 63100910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 63110910c330SBarry Smith PetscValidHeaderSpecific(udot,VEC_CLASSID,4); 6312325fc9f4SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,5); 63130910c330SBarry Smith PetscCheckSameComm(snes,1,u,3); 6314325fc9f4SBarry Smith PetscCheckSameComm(snes,1,y,5); 6315325fc9f4SBarry Smith 6316325fc9f4SBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 63170910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 63180910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr); 63190910c330SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr); 6320bbd56ea5SKarl Rupp 6321325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6322325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar(time); 6323325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6324325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6325325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)ly); 6326325fc9f4SBarry Smith prhs[5] = mxCreateString(sctx->funcname); 6327325fc9f4SBarry Smith prhs[6] = sctx->ctx; 6328325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr); 6329325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6330325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6331325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6332325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6333325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6334325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6335325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6336325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6337325fc9f4SBarry Smith PetscFunctionReturn(0); 6338325fc9f4SBarry Smith } 6339325fc9f4SBarry Smith 6340325fc9f4SBarry Smith /* 6341325fc9f4SBarry Smith TSSetFunctionMatlab - Sets the function evaluation routine and function 6342325fc9f4SBarry Smith vector for use by the TS routines in solving ODEs 6343e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 6344325fc9f4SBarry Smith 6345325fc9f4SBarry Smith Logically Collective on TS 6346325fc9f4SBarry Smith 6347325fc9f4SBarry Smith Input Parameters: 6348325fc9f4SBarry Smith + ts - the TS context 6349325fc9f4SBarry Smith - func - function evaluation routine 6350325fc9f4SBarry Smith 6351325fc9f4SBarry Smith Calling sequence of func: 63520910c330SBarry Smith $ func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx); 6353325fc9f4SBarry Smith 6354325fc9f4SBarry Smith Level: beginner 6355325fc9f4SBarry Smith 6356325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6357325fc9f4SBarry Smith 6358325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6359325fc9f4SBarry Smith */ 6360cdcf91faSSean Farley PetscErrorCode TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx) 6361325fc9f4SBarry Smith { 6362325fc9f4SBarry Smith PetscErrorCode ierr; 6363325fc9f4SBarry Smith TSMatlabContext *sctx; 6364325fc9f4SBarry Smith 6365325fc9f4SBarry Smith PetscFunctionBegin; 6366325fc9f4SBarry Smith /* currently sctx is memory bleed */ 636795dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6368325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6369325fc9f4SBarry Smith /* 6370325fc9f4SBarry Smith This should work, but it doesn't 6371325fc9f4SBarry Smith sctx->ctx = ctx; 6372325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6373325fc9f4SBarry Smith */ 6374325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6375bbd56ea5SKarl Rupp 63760298fd71SBarry Smith ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr); 6377325fc9f4SBarry Smith PetscFunctionReturn(0); 6378325fc9f4SBarry Smith } 6379325fc9f4SBarry Smith 6380325fc9f4SBarry Smith /* 6381325fc9f4SBarry Smith TSComputeJacobian_Matlab - Calls the function that has been set with 6382325fc9f4SBarry Smith TSSetJacobianMatlab(). 6383325fc9f4SBarry Smith 6384325fc9f4SBarry Smith Collective on TS 6385325fc9f4SBarry Smith 6386325fc9f4SBarry Smith Input Parameters: 6387cdcf91faSSean Farley + ts - the TS context 63880910c330SBarry Smith . u - input vector 6389325fc9f4SBarry Smith . A, B - the matrices 6390325fc9f4SBarry Smith - ctx - user context 6391325fc9f4SBarry Smith 6392325fc9f4SBarry Smith Level: developer 6393325fc9f4SBarry Smith 6394325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function 6395325fc9f4SBarry Smith 6396325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6397325fc9f4SBarry Smith @*/ 6398f3229a78SSatish Balay PetscErrorCode TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx) 6399325fc9f4SBarry Smith { 6400325fc9f4SBarry Smith PetscErrorCode ierr; 6401325fc9f4SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6402325fc9f4SBarry Smith int nlhs = 2,nrhs = 9; 6403325fc9f4SBarry Smith mxArray *plhs[2],*prhs[9]; 6404325fc9f4SBarry Smith long long int lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0; 6405325fc9f4SBarry Smith 6406325fc9f4SBarry Smith PetscFunctionBegin; 6407cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 64080910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,3); 6409325fc9f4SBarry Smith 64100910c330SBarry Smith /* call Matlab function in ctx with arguments u and y */ 6411325fc9f4SBarry Smith 6412cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 64130910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 64140910c330SBarry Smith ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr); 64150910c330SBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr); 64160910c330SBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr); 6417bbd56ea5SKarl Rupp 6418325fc9f4SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6419325fc9f4SBarry Smith prhs[1] = mxCreateDoubleScalar((double)time); 6420325fc9f4SBarry Smith prhs[2] = mxCreateDoubleScalar((double)lx); 6421325fc9f4SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lxdot); 6422325fc9f4SBarry Smith prhs[4] = mxCreateDoubleScalar((double)shift); 6423325fc9f4SBarry Smith prhs[5] = mxCreateDoubleScalar((double)lA); 6424325fc9f4SBarry Smith prhs[6] = mxCreateDoubleScalar((double)lB); 6425325fc9f4SBarry Smith prhs[7] = mxCreateString(sctx->funcname); 6426325fc9f4SBarry Smith prhs[8] = sctx->ctx; 6427325fc9f4SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr); 6428325fc9f4SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6429325fc9f4SBarry Smith mxDestroyArray(prhs[0]); 6430325fc9f4SBarry Smith mxDestroyArray(prhs[1]); 6431325fc9f4SBarry Smith mxDestroyArray(prhs[2]); 6432325fc9f4SBarry Smith mxDestroyArray(prhs[3]); 6433325fc9f4SBarry Smith mxDestroyArray(prhs[4]); 6434325fc9f4SBarry Smith mxDestroyArray(prhs[5]); 6435325fc9f4SBarry Smith mxDestroyArray(prhs[6]); 6436325fc9f4SBarry Smith mxDestroyArray(prhs[7]); 6437325fc9f4SBarry Smith mxDestroyArray(plhs[0]); 6438325fc9f4SBarry Smith mxDestroyArray(plhs[1]); 6439325fc9f4SBarry Smith PetscFunctionReturn(0); 6440325fc9f4SBarry Smith } 6441325fc9f4SBarry Smith 6442325fc9f4SBarry Smith /* 6443325fc9f4SBarry Smith TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 6444e3c5b3baSBarry 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 6445325fc9f4SBarry Smith 6446325fc9f4SBarry Smith Logically Collective on TS 6447325fc9f4SBarry Smith 6448325fc9f4SBarry Smith Input Parameters: 6449cdcf91faSSean Farley + ts - the TS context 6450325fc9f4SBarry Smith . A,B - Jacobian matrices 6451325fc9f4SBarry Smith . func - function evaluation routine 6452325fc9f4SBarry Smith - ctx - user context 6453325fc9f4SBarry Smith 6454325fc9f4SBarry Smith Calling sequence of func: 64550910c330SBarry Smith $ flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx); 6456325fc9f4SBarry Smith 6457325fc9f4SBarry Smith Level: developer 6458325fc9f4SBarry Smith 6459325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function 6460325fc9f4SBarry Smith 6461325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6462325fc9f4SBarry Smith */ 6463cdcf91faSSean Farley PetscErrorCode TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx) 6464325fc9f4SBarry Smith { 6465325fc9f4SBarry Smith PetscErrorCode ierr; 6466325fc9f4SBarry Smith TSMatlabContext *sctx; 6467325fc9f4SBarry Smith 6468325fc9f4SBarry Smith PetscFunctionBegin; 6469325fc9f4SBarry Smith /* currently sctx is memory bleed */ 647095dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6471325fc9f4SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6472325fc9f4SBarry Smith /* 6473325fc9f4SBarry Smith This should work, but it doesn't 6474325fc9f4SBarry Smith sctx->ctx = ctx; 6475325fc9f4SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6476325fc9f4SBarry Smith */ 6477325fc9f4SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6478bbd56ea5SKarl Rupp 6479cdcf91faSSean Farley ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 6480325fc9f4SBarry Smith PetscFunctionReturn(0); 6481325fc9f4SBarry Smith } 6482325fc9f4SBarry Smith 6483b5b1a830SBarry Smith /* 6484b5b1a830SBarry Smith TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab(). 6485b5b1a830SBarry Smith 6486b5b1a830SBarry Smith Collective on TS 6487b5b1a830SBarry Smith 6488b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction() 6489b5b1a830SBarry Smith @*/ 64900910c330SBarry Smith PetscErrorCode TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx) 6491b5b1a830SBarry Smith { 6492b5b1a830SBarry Smith PetscErrorCode ierr; 6493b5b1a830SBarry Smith TSMatlabContext *sctx = (TSMatlabContext*)ctx; 6494a530c242SBarry Smith int nlhs = 1,nrhs = 6; 6495b5b1a830SBarry Smith mxArray *plhs[1],*prhs[6]; 6496b5b1a830SBarry Smith long long int lx = 0,ls = 0; 6497b5b1a830SBarry Smith 6498b5b1a830SBarry Smith PetscFunctionBegin; 6499cdcf91faSSean Farley PetscValidHeaderSpecific(ts,TS_CLASSID,1); 65000910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,4); 6501b5b1a830SBarry Smith 6502cdcf91faSSean Farley ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr); 65030910c330SBarry Smith ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr); 6504bbd56ea5SKarl Rupp 6505b5b1a830SBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 6506b5b1a830SBarry Smith prhs[1] = mxCreateDoubleScalar((double)it); 6507b5b1a830SBarry Smith prhs[2] = mxCreateDoubleScalar((double)time); 6508b5b1a830SBarry Smith prhs[3] = mxCreateDoubleScalar((double)lx); 6509b5b1a830SBarry Smith prhs[4] = mxCreateString(sctx->funcname); 6510b5b1a830SBarry Smith prhs[5] = sctx->ctx; 6511b5b1a830SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr); 6512b5b1a830SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 6513b5b1a830SBarry Smith mxDestroyArray(prhs[0]); 6514b5b1a830SBarry Smith mxDestroyArray(prhs[1]); 6515b5b1a830SBarry Smith mxDestroyArray(prhs[2]); 6516b5b1a830SBarry Smith mxDestroyArray(prhs[3]); 6517b5b1a830SBarry Smith mxDestroyArray(prhs[4]); 6518b5b1a830SBarry Smith mxDestroyArray(plhs[0]); 6519b5b1a830SBarry Smith PetscFunctionReturn(0); 6520b5b1a830SBarry Smith } 6521b5b1a830SBarry Smith 6522b5b1a830SBarry Smith /* 6523b5b1a830SBarry Smith TSMonitorSetMatlab - Sets the monitor function from Matlab 6524b5b1a830SBarry Smith 6525b5b1a830SBarry Smith Level: developer 6526b5b1a830SBarry Smith 6527b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function 6528b5b1a830SBarry Smith 6529b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction() 6530b5b1a830SBarry Smith */ 6531cdcf91faSSean Farley PetscErrorCode TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx) 6532b5b1a830SBarry Smith { 6533b5b1a830SBarry Smith PetscErrorCode ierr; 6534b5b1a830SBarry Smith TSMatlabContext *sctx; 6535b5b1a830SBarry Smith 6536b5b1a830SBarry Smith PetscFunctionBegin; 6537b5b1a830SBarry Smith /* currently sctx is memory bleed */ 653895dccacaSBarry Smith ierr = PetscNew(&sctx);CHKERRQ(ierr); 6539b5b1a830SBarry Smith ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 6540b5b1a830SBarry Smith /* 6541b5b1a830SBarry Smith This should work, but it doesn't 6542b5b1a830SBarry Smith sctx->ctx = ctx; 6543b5b1a830SBarry Smith mexMakeArrayPersistent(sctx->ctx); 6544b5b1a830SBarry Smith */ 6545b5b1a830SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 6546bbd56ea5SKarl Rupp 65470298fd71SBarry Smith ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 6548b5b1a830SBarry Smith PetscFunctionReturn(0); 6549b5b1a830SBarry Smith } 6550325fc9f4SBarry Smith #endif 6551b3603a34SBarry Smith 6552b3603a34SBarry Smith /*@C 65534f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6554b3603a34SBarry Smith in a time based line graph 6555b3603a34SBarry Smith 6556b3603a34SBarry Smith Collective on TS 6557b3603a34SBarry Smith 6558b3603a34SBarry Smith Input Parameters: 6559b3603a34SBarry Smith + ts - the TS context 6560b3603a34SBarry Smith . step - current time-step 6561b3603a34SBarry Smith . ptime - current time 65627db568b7SBarry Smith . u - current solution 65637db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6564b3603a34SBarry Smith 6565b3d3934dSBarry Smith Options Database: 65669ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6567b3d3934dSBarry Smith 6568b3603a34SBarry Smith Level: intermediate 6569b3603a34SBarry Smith 657095452b02SPatrick Sanan Notes: 657195452b02SPatrick Sanan Each process in a parallel run displays its component solutions in a separate window 6572b3603a34SBarry Smith 6573b3603a34SBarry Smith .keywords: TS, vector, monitor, view 6574b3603a34SBarry Smith 65757db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 65767db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 65777db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 65787db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6579b3603a34SBarry Smith @*/ 65807db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6581b3603a34SBarry Smith { 6582b3603a34SBarry Smith PetscErrorCode ierr; 65837db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6584b3603a34SBarry Smith const PetscScalar *yy; 658580666b62SBarry Smith Vec v; 6586b3603a34SBarry Smith 6587b3603a34SBarry Smith PetscFunctionBegin; 658863e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 658958ff32f7SBarry Smith if (!step) { 6590a9f9c1f6SBarry Smith PetscDrawAxis axis; 65916934998bSLisandro Dalcin PetscInt dim; 6592a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 65930ec8ee2bSJoseph Pusztay ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6594bab0a581SBarry Smith if (!ctx->names) { 6595bab0a581SBarry Smith PetscBool flg; 6596bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6597bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6598bab0a581SBarry Smith if (flg) { 6599bab0a581SBarry Smith PetscInt i,n; 6600bab0a581SBarry Smith char **names; 6601bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6602bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6603bab0a581SBarry Smith for (i=0; i<n; i++) { 6604bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6605bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6606bab0a581SBarry Smith } 6607bab0a581SBarry Smith names[n] = NULL; 6608bab0a581SBarry Smith ctx->names = names; 6609bab0a581SBarry Smith } 6610bab0a581SBarry Smith } 6611387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6612387f4636SBarry Smith char **displaynames; 6613387f4636SBarry Smith PetscBool flg; 6614387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 661595dccacaSBarry Smith ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6616387f4636SBarry Smith ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr); 6617c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6618387f4636SBarry Smith if (flg) { 6619a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6620387f4636SBarry Smith } 6621387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6622387f4636SBarry Smith } 6623387f4636SBarry Smith if (ctx->displaynames) { 6624387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6625387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6626387f4636SBarry Smith } else if (ctx->names) { 66270910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 66280b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6629387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6630b0bc92c6SBarry Smith } else { 6631b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6632b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6633387f4636SBarry Smith } 66340b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 663558ff32f7SBarry Smith } 66366934998bSLisandro Dalcin 66376934998bSLisandro Dalcin if (!ctx->transform) v = u; 66386934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 663980666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 66406934998bSLisandro Dalcin if (ctx->displaynames) { 66416934998bSLisandro Dalcin PetscInt i; 66426934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 66436934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 66446934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 66456934998bSLisandro Dalcin } else { 6646e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6647e3efe391SJed Brown PetscInt i,n; 66486934998bSLisandro Dalcin PetscReal *yreal; 664980666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6650785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6651e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 66520b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6653e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6654e3efe391SJed Brown #else 66550b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6656e3efe391SJed Brown #endif 665780666b62SBarry Smith } 66586934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 66596934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 66606934998bSLisandro Dalcin 6661b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 66620b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 66636934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 66643923b477SBarry Smith } 6665b3603a34SBarry Smith PetscFunctionReturn(0); 6666b3603a34SBarry Smith } 6667b3603a34SBarry Smith 6668b037adc7SBarry Smith /*@C 666931152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6670b037adc7SBarry Smith 6671b037adc7SBarry Smith Collective on TS 6672b037adc7SBarry Smith 6673b037adc7SBarry Smith Input Parameters: 6674b037adc7SBarry Smith + ts - the TS context 6675b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 6676b037adc7SBarry Smith 6677b037adc7SBarry Smith Level: intermediate 6678b037adc7SBarry Smith 667995452b02SPatrick Sanan Notes: 668095452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 66817db568b7SBarry Smith 6682b037adc7SBarry Smith .keywords: TS, vector, monitor, view 6683b037adc7SBarry Smith 6684a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 6685b037adc7SBarry Smith @*/ 668631152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 6687b037adc7SBarry Smith { 6688b037adc7SBarry Smith PetscErrorCode ierr; 6689b037adc7SBarry Smith PetscInt i; 6690b037adc7SBarry Smith 6691b037adc7SBarry Smith PetscFunctionBegin; 6692b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6693b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 66945537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 6695b3d3934dSBarry Smith break; 6696b3d3934dSBarry Smith } 6697b3d3934dSBarry Smith } 6698b3d3934dSBarry Smith PetscFunctionReturn(0); 6699b3d3934dSBarry Smith } 6700b3d3934dSBarry Smith 6701e673d494SBarry Smith /*@C 6702e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6703e673d494SBarry Smith 6704e673d494SBarry Smith Collective on TS 6705e673d494SBarry Smith 6706e673d494SBarry Smith Input Parameters: 6707e673d494SBarry Smith + ts - the TS context 6708e673d494SBarry Smith - names - the names of the components, final string must be NULL 6709e673d494SBarry Smith 6710e673d494SBarry Smith Level: intermediate 6711e673d494SBarry Smith 6712e673d494SBarry Smith .keywords: TS, vector, monitor, view 6713e673d494SBarry Smith 6714a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 6715e673d494SBarry Smith @*/ 6716e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 6717e673d494SBarry Smith { 6718e673d494SBarry Smith PetscErrorCode ierr; 6719e673d494SBarry Smith 6720e673d494SBarry Smith PetscFunctionBegin; 6721e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 6722e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 6723e673d494SBarry Smith PetscFunctionReturn(0); 6724e673d494SBarry Smith } 6725e673d494SBarry Smith 6726b3d3934dSBarry Smith /*@C 6727b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 6728b3d3934dSBarry Smith 6729b3d3934dSBarry Smith Collective on TS 6730b3d3934dSBarry Smith 6731b3d3934dSBarry Smith Input Parameter: 6732b3d3934dSBarry Smith . ts - the TS context 6733b3d3934dSBarry Smith 6734b3d3934dSBarry Smith Output Parameter: 6735b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 6736b3d3934dSBarry Smith 6737b3d3934dSBarry Smith Level: intermediate 6738b3d3934dSBarry Smith 673995452b02SPatrick Sanan Notes: 674095452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 67417db568b7SBarry Smith 6742b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 6743b3d3934dSBarry Smith 6744b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6745b3d3934dSBarry Smith @*/ 6746b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 6747b3d3934dSBarry Smith { 6748b3d3934dSBarry Smith PetscInt i; 6749b3d3934dSBarry Smith 6750b3d3934dSBarry Smith PetscFunctionBegin; 6751b3d3934dSBarry Smith *names = NULL; 6752b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6753b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 67545537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 6755b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 6756b3d3934dSBarry Smith break; 6757387f4636SBarry Smith } 6758387f4636SBarry Smith } 6759387f4636SBarry Smith PetscFunctionReturn(0); 6760387f4636SBarry Smith } 6761387f4636SBarry Smith 6762a66092f1SBarry Smith /*@C 6763a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 6764a66092f1SBarry Smith 6765a66092f1SBarry Smith Collective on TS 6766a66092f1SBarry Smith 6767a66092f1SBarry Smith Input Parameters: 6768a66092f1SBarry Smith + ctx - the TSMonitorLG context 6769a66092f1SBarry Smith . displaynames - the names of the components, final string must be NULL 6770a66092f1SBarry Smith 6771a66092f1SBarry Smith Level: intermediate 6772a66092f1SBarry Smith 6773a66092f1SBarry Smith .keywords: TS, vector, monitor, view 6774a66092f1SBarry Smith 6775a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6776a66092f1SBarry Smith @*/ 6777a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 6778a66092f1SBarry Smith { 6779a66092f1SBarry Smith PetscInt j = 0,k; 6780a66092f1SBarry Smith PetscErrorCode ierr; 6781a66092f1SBarry Smith 6782a66092f1SBarry Smith PetscFunctionBegin; 6783a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 6784a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6785a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6786a66092f1SBarry Smith while (displaynames[j]) j++; 6787a66092f1SBarry Smith ctx->ndisplayvariables = j; 6788a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6789a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6790a66092f1SBarry Smith j = 0; 6791a66092f1SBarry Smith while (displaynames[j]) { 6792a66092f1SBarry Smith k = 0; 6793a66092f1SBarry Smith while (ctx->names[k]) { 6794a66092f1SBarry Smith PetscBool flg; 6795a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6796a66092f1SBarry Smith if (flg) { 6797a66092f1SBarry Smith ctx->displayvariables[j] = k; 6798a66092f1SBarry Smith break; 6799a66092f1SBarry Smith } 6800a66092f1SBarry Smith k++; 6801a66092f1SBarry Smith } 6802a66092f1SBarry Smith j++; 6803a66092f1SBarry Smith } 6804a66092f1SBarry Smith PetscFunctionReturn(0); 6805a66092f1SBarry Smith } 6806a66092f1SBarry Smith 6807387f4636SBarry Smith /*@C 6808387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6809387f4636SBarry Smith 6810387f4636SBarry Smith Collective on TS 6811387f4636SBarry Smith 6812387f4636SBarry Smith Input Parameters: 6813387f4636SBarry Smith + ts - the TS context 6814387f4636SBarry Smith . displaynames - the names of the components, final string must be NULL 6815387f4636SBarry Smith 681695452b02SPatrick Sanan Notes: 681795452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 68187db568b7SBarry Smith 6819387f4636SBarry Smith Level: intermediate 6820387f4636SBarry Smith 6821387f4636SBarry Smith .keywords: TS, vector, monitor, view 6822387f4636SBarry Smith 6823387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6824387f4636SBarry Smith @*/ 6825387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6826387f4636SBarry Smith { 6827a66092f1SBarry Smith PetscInt i; 6828387f4636SBarry Smith PetscErrorCode ierr; 6829387f4636SBarry Smith 6830387f4636SBarry Smith PetscFunctionBegin; 6831387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6832387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 68335537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6834b3d3934dSBarry Smith break; 6835b037adc7SBarry Smith } 6836b037adc7SBarry Smith } 6837b037adc7SBarry Smith PetscFunctionReturn(0); 6838b037adc7SBarry Smith } 6839b037adc7SBarry Smith 684080666b62SBarry Smith /*@C 684180666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 684280666b62SBarry Smith 684380666b62SBarry Smith Collective on TS 684480666b62SBarry Smith 684580666b62SBarry Smith Input Parameters: 684680666b62SBarry Smith + ts - the TS context 684780666b62SBarry Smith . transform - the transform function 68487684fa3eSBarry Smith . destroy - function to destroy the optional context 684980666b62SBarry Smith - ctx - optional context used by transform function 685080666b62SBarry Smith 685195452b02SPatrick Sanan Notes: 685295452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 68537db568b7SBarry Smith 685480666b62SBarry Smith Level: intermediate 685580666b62SBarry Smith 685680666b62SBarry Smith .keywords: TS, vector, monitor, view 685780666b62SBarry Smith 6858a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 685980666b62SBarry Smith @*/ 68607684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 686180666b62SBarry Smith { 686280666b62SBarry Smith PetscInt i; 6863a66092f1SBarry Smith PetscErrorCode ierr; 686480666b62SBarry Smith 686580666b62SBarry Smith PetscFunctionBegin; 686680666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 686780666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 68685537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 686980666b62SBarry Smith } 687080666b62SBarry Smith } 687180666b62SBarry Smith PetscFunctionReturn(0); 687280666b62SBarry Smith } 687380666b62SBarry Smith 6874e673d494SBarry Smith /*@C 6875e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6876e673d494SBarry Smith 6877e673d494SBarry Smith Collective on TSLGCtx 6878e673d494SBarry Smith 6879e673d494SBarry Smith Input Parameters: 6880e673d494SBarry Smith + ts - the TS context 6881e673d494SBarry Smith . transform - the transform function 68827684fa3eSBarry Smith . destroy - function to destroy the optional context 6883e673d494SBarry Smith - ctx - optional context used by transform function 6884e673d494SBarry Smith 6885e673d494SBarry Smith Level: intermediate 6886e673d494SBarry Smith 6887e673d494SBarry Smith .keywords: TS, vector, monitor, view 6888e673d494SBarry Smith 6889a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6890e673d494SBarry Smith @*/ 68917684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6892e673d494SBarry Smith { 6893e673d494SBarry Smith PetscFunctionBegin; 6894e673d494SBarry Smith ctx->transform = transform; 68957684fa3eSBarry Smith ctx->transformdestroy = destroy; 6896e673d494SBarry Smith ctx->transformctx = tctx; 6897e673d494SBarry Smith PetscFunctionReturn(0); 6898e673d494SBarry Smith } 6899e673d494SBarry Smith 6900ef20d060SBarry Smith /*@C 69018b668821SLisandro Dalcin TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error 6902ef20d060SBarry Smith in a time based line graph 6903ef20d060SBarry Smith 6904ef20d060SBarry Smith Collective on TS 6905ef20d060SBarry Smith 6906ef20d060SBarry Smith Input Parameters: 6907ef20d060SBarry Smith + ts - the TS context 6908ef20d060SBarry Smith . step - current time-step 6909ef20d060SBarry Smith . ptime - current time 69107db568b7SBarry Smith . u - current solution 69117db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6912ef20d060SBarry Smith 6913ef20d060SBarry Smith Level: intermediate 6914ef20d060SBarry Smith 691595452b02SPatrick Sanan Notes: 691695452b02SPatrick Sanan Each process in a parallel run displays its component errors in a separate window 6917abd5a294SJed Brown 6918abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6919abd5a294SJed Brown 6920abd5a294SJed Brown Options Database Keys: 69214f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 6922ef20d060SBarry Smith 6923ef20d060SBarry Smith .keywords: TS, vector, monitor, view 6924ef20d060SBarry Smith 6925abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6926ef20d060SBarry Smith @*/ 69270910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6928ef20d060SBarry Smith { 6929ef20d060SBarry Smith PetscErrorCode ierr; 69300b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6931ef20d060SBarry Smith const PetscScalar *yy; 6932ef20d060SBarry Smith Vec y; 6933ef20d060SBarry Smith 6934ef20d060SBarry Smith PetscFunctionBegin; 6935a9f9c1f6SBarry Smith if (!step) { 6936a9f9c1f6SBarry Smith PetscDrawAxis axis; 69376934998bSLisandro Dalcin PetscInt dim; 6938a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 69398b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr); 69400910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6941a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6942a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6943a9f9c1f6SBarry Smith } 69440910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6945ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 69460910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6947ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6948e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6949e3efe391SJed Brown { 6950e3efe391SJed Brown PetscReal *yreal; 6951e3efe391SJed Brown PetscInt i,n; 6952e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6953785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6954e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 69550b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6956e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6957e3efe391SJed Brown } 6958e3efe391SJed Brown #else 69590b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6960e3efe391SJed Brown #endif 6961ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6962ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 6963b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 69640b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 69656934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 69663923b477SBarry Smith } 6967ef20d060SBarry Smith PetscFunctionReturn(0); 6968ef20d060SBarry Smith } 6969ef20d060SBarry Smith 69705e3b7effSJoseph Pusztay /*@C 69715e3b7effSJoseph Pusztay TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot 69725e3b7effSJoseph Pusztay 69735e3b7effSJoseph Pusztay Input Parameters: 69745e3b7effSJoseph Pusztay + ts - the TS context 69755e3b7effSJoseph Pusztay . step - current time-step 69765e3b7effSJoseph Pusztay . ptime - current time 69775e3b7effSJoseph Pusztay . u - current solution 69785e3b7effSJoseph Pusztay - dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate() 69795e3b7effSJoseph Pusztay 69805e3b7effSJoseph Pusztay Options Database: 6981918b1d10SJoseph Pusztay . -ts_monitor_sp_swarm 69825e3b7effSJoseph Pusztay 69835e3b7effSJoseph Pusztay Level: intermediate 69845e3b7effSJoseph Pusztay 69855e3b7effSJoseph Pusztay .keywords: TS, vector, monitor, view, swarm 69865e3b7effSJoseph Pusztay @*/ 69870ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 69881b575b74SJoseph Pusztay { 69891b575b74SJoseph Pusztay PetscErrorCode ierr; 69901b575b74SJoseph Pusztay TSMonitorSPCtx ctx = (TSMonitorSPCtx)dctx; 69911b575b74SJoseph Pusztay const PetscScalar *yy; 6992b1670a61SJoseph Pusztay PetscReal *y,*x; 69931b575b74SJoseph Pusztay PetscInt Np, p, dim=2; 69941b575b74SJoseph Pusztay DM dm; 69951b575b74SJoseph Pusztay 69961b575b74SJoseph Pusztay PetscFunctionBegin; 69971b575b74SJoseph Pusztay 69981b575b74SJoseph Pusztay if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 69991b575b74SJoseph Pusztay if (!step) { 70001b575b74SJoseph Pusztay PetscDrawAxis axis; 70011b575b74SJoseph Pusztay ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr); 70021b575b74SJoseph Pusztay ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr); 7003895f37d5SJoseph Pusztay ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr); 7004895f37d5SJoseph Pusztay ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr); 70051b575b74SJoseph Pusztay ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 70061b575b74SJoseph Pusztay ierr = DMGetDimension(dm, &dim); 70071b575b74SJoseph Pusztay if(dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr); 70081b575b74SJoseph Pusztay ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr); 70091b575b74SJoseph Pusztay Np /= 2*dim; 70101b575b74SJoseph Pusztay ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr); 70111b575b74SJoseph Pusztay ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr); 70121b575b74SJoseph Pusztay } 70131b575b74SJoseph Pusztay 70141b575b74SJoseph Pusztay ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr); 70151b575b74SJoseph Pusztay Np /= 2*dim; 70161b575b74SJoseph Pusztay ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 7017895f37d5SJoseph Pusztay ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr); 70181b575b74SJoseph Pusztay /* get points from solution vector */ 70191b575b74SJoseph Pusztay for (p=0; p<Np; ++p){ 7020b1670a61SJoseph Pusztay x[p] = PetscRealPart(yy[2*dim*p]); 7021b1670a61SJoseph Pusztay y[p] = PetscRealPart(yy[2*dim*p+1]); 7022895f37d5SJoseph Pusztay } 70231b575b74SJoseph Pusztay ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 70241b575b74SJoseph Pusztay 70251b575b74SJoseph Pusztay if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 70261b575b74SJoseph Pusztay ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr); 70271b575b74SJoseph Pusztay ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr); 70281b575b74SJoseph Pusztay ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr); 70291b575b74SJoseph Pusztay } 70301b575b74SJoseph Pusztay 7031918b1d10SJoseph Pusztay ierr = PetscFree2(x, y);CHKERRQ(ierr); 7032918b1d10SJoseph Pusztay 70331b575b74SJoseph Pusztay PetscFunctionReturn(0); 70341b575b74SJoseph Pusztay } 70351b575b74SJoseph Pusztay 70361b575b74SJoseph Pusztay 70371b575b74SJoseph Pusztay 70387cf37e64SBarry Smith /*@C 70397cf37e64SBarry Smith TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep 70407cf37e64SBarry Smith 70417cf37e64SBarry Smith Collective on TS 70427cf37e64SBarry Smith 70437cf37e64SBarry Smith Input Parameters: 70447cf37e64SBarry Smith + ts - the TS context 70457cf37e64SBarry Smith . step - current time-step 70467cf37e64SBarry Smith . ptime - current time 70477cf37e64SBarry Smith . u - current solution 70487cf37e64SBarry Smith - dctx - unused context 70497cf37e64SBarry Smith 70507cf37e64SBarry Smith Level: intermediate 70517cf37e64SBarry Smith 70527cf37e64SBarry Smith The user must provide the solution using TSSetSolutionFunction() to use this monitor. 70537cf37e64SBarry Smith 70547cf37e64SBarry Smith Options Database Keys: 70557cf37e64SBarry Smith . -ts_monitor_error - create a graphical monitor of error history 70567cf37e64SBarry Smith 70577cf37e64SBarry Smith .keywords: TS, vector, monitor, view 70587cf37e64SBarry Smith 70597cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 70607cf37e64SBarry Smith @*/ 7061edbaebb3SBarry Smith PetscErrorCode TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 70627cf37e64SBarry Smith { 70637cf37e64SBarry Smith PetscErrorCode ierr; 70647cf37e64SBarry Smith Vec y; 70657cf37e64SBarry Smith PetscReal nrm; 7066edbaebb3SBarry Smith PetscBool flg; 70677cf37e64SBarry Smith 70687cf37e64SBarry Smith PetscFunctionBegin; 70697cf37e64SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 70707cf37e64SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 70717cf37e64SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7072edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr); 7073edbaebb3SBarry Smith if (flg) { 70747cf37e64SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 7075edbaebb3SBarry Smith ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr); 7076edbaebb3SBarry Smith } 7077edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr); 7078edbaebb3SBarry Smith if (flg) { 7079edbaebb3SBarry Smith ierr = VecView(y,vf->viewer);CHKERRQ(ierr); 7080edbaebb3SBarry Smith } 7081edbaebb3SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 70827cf37e64SBarry Smith PetscFunctionReturn(0); 70837cf37e64SBarry Smith } 70847cf37e64SBarry Smith 7085201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7086201da799SBarry Smith { 7087201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7088201da799SBarry Smith PetscReal x = ptime,y; 7089201da799SBarry Smith PetscErrorCode ierr; 7090201da799SBarry Smith PetscInt its; 7091201da799SBarry Smith 7092201da799SBarry Smith PetscFunctionBegin; 709363e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7094201da799SBarry Smith if (!n) { 7095201da799SBarry Smith PetscDrawAxis axis; 7096201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7097201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7098201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7099201da799SBarry Smith ctx->snes_its = 0; 7100201da799SBarry Smith } 7101201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7102201da799SBarry Smith y = its - ctx->snes_its; 7103201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 71043fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7105201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 71066934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7107201da799SBarry Smith } 7108201da799SBarry Smith ctx->snes_its = its; 7109201da799SBarry Smith PetscFunctionReturn(0); 7110201da799SBarry Smith } 7111201da799SBarry Smith 7112201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7113201da799SBarry Smith { 7114201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7115201da799SBarry Smith PetscReal x = ptime,y; 7116201da799SBarry Smith PetscErrorCode ierr; 7117201da799SBarry Smith PetscInt its; 7118201da799SBarry Smith 7119201da799SBarry Smith PetscFunctionBegin; 712063e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7121201da799SBarry Smith if (!n) { 7122201da799SBarry Smith PetscDrawAxis axis; 7123201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7124201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7125201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7126201da799SBarry Smith ctx->ksp_its = 0; 7127201da799SBarry Smith } 7128201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7129201da799SBarry Smith y = its - ctx->ksp_its; 7130201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 713199fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7132201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 71336934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7134201da799SBarry Smith } 7135201da799SBarry Smith ctx->ksp_its = its; 7136201da799SBarry Smith PetscFunctionReturn(0); 7137201da799SBarry Smith } 7138f9c1d6abSBarry Smith 7139f9c1d6abSBarry Smith /*@ 7140f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7141f9c1d6abSBarry Smith 7142f9c1d6abSBarry Smith Collective on TS and Vec 7143f9c1d6abSBarry Smith 7144f9c1d6abSBarry Smith Input Parameters: 7145f9c1d6abSBarry Smith + ts - the TS context 7146f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7147f9c1d6abSBarry Smith 7148f9c1d6abSBarry Smith Output Parameters: 7149f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7150f9c1d6abSBarry Smith 7151f9c1d6abSBarry Smith Level: developer 7152f9c1d6abSBarry Smith 7153f9c1d6abSBarry Smith .keywords: TS, compute 7154f9c1d6abSBarry Smith 7155f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7156f9c1d6abSBarry Smith @*/ 7157f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7158f9c1d6abSBarry Smith { 7159f9c1d6abSBarry Smith PetscErrorCode ierr; 7160f9c1d6abSBarry Smith 7161f9c1d6abSBarry Smith PetscFunctionBegin; 7162f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7163ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7164f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7165f9c1d6abSBarry Smith PetscFunctionReturn(0); 7166f9c1d6abSBarry Smith } 716724655328SShri 7168b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7169b3d3934dSBarry Smith /*@C 7170b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7171b3d3934dSBarry Smith 7172b3d3934dSBarry Smith Collective on TS 7173b3d3934dSBarry Smith 7174b3d3934dSBarry Smith Input Parameters: 7175b3d3934dSBarry Smith . ts - the ODE solver object 7176b3d3934dSBarry Smith 7177b3d3934dSBarry Smith Output Parameter: 7178b3d3934dSBarry Smith . ctx - the context 7179b3d3934dSBarry Smith 7180b3d3934dSBarry Smith Level: intermediate 7181b3d3934dSBarry Smith 7182b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso 7183b3d3934dSBarry Smith 7184b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7185b3d3934dSBarry Smith 7186b3d3934dSBarry Smith @*/ 7187b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7188b3d3934dSBarry Smith { 7189b3d3934dSBarry Smith PetscErrorCode ierr; 7190b3d3934dSBarry Smith 7191b3d3934dSBarry Smith PetscFunctionBegin; 7192a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7193b3d3934dSBarry Smith PetscFunctionReturn(0); 7194b3d3934dSBarry Smith } 7195b3d3934dSBarry Smith 7196b3d3934dSBarry Smith /*@C 7197b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7198b3d3934dSBarry Smith 7199b3d3934dSBarry Smith Collective on TS 7200b3d3934dSBarry Smith 7201b3d3934dSBarry Smith Input Parameters: 7202b3d3934dSBarry Smith + ts - the TS context 7203b3d3934dSBarry Smith . step - current time-step 7204b3d3934dSBarry Smith . ptime - current time 72057db568b7SBarry Smith . u - current solution 72067db568b7SBarry Smith - dctx - the envelope context 7207b3d3934dSBarry Smith 7208b3d3934dSBarry Smith Options Database: 7209b3d3934dSBarry Smith . -ts_monitor_envelope 7210b3d3934dSBarry Smith 7211b3d3934dSBarry Smith Level: intermediate 7212b3d3934dSBarry Smith 721395452b02SPatrick Sanan Notes: 721495452b02SPatrick Sanan after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7215b3d3934dSBarry Smith 7216b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7217b3d3934dSBarry Smith 72187db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7219b3d3934dSBarry Smith @*/ 72207db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7221b3d3934dSBarry Smith { 7222b3d3934dSBarry Smith PetscErrorCode ierr; 72237db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7224b3d3934dSBarry Smith 7225b3d3934dSBarry Smith PetscFunctionBegin; 7226b3d3934dSBarry Smith if (!ctx->max) { 7227b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7228b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7229b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7230b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7231b3d3934dSBarry Smith } else { 7232b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7233b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7234b3d3934dSBarry Smith } 7235b3d3934dSBarry Smith PetscFunctionReturn(0); 7236b3d3934dSBarry Smith } 7237b3d3934dSBarry Smith 7238b3d3934dSBarry Smith /*@C 7239b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7240b3d3934dSBarry Smith 7241b3d3934dSBarry Smith Collective on TS 7242b3d3934dSBarry Smith 7243b3d3934dSBarry Smith Input Parameter: 7244b3d3934dSBarry Smith . ts - the TS context 7245b3d3934dSBarry Smith 7246b3d3934dSBarry Smith Output Parameter: 7247b3d3934dSBarry Smith + max - the maximum values 7248b3d3934dSBarry Smith - min - the minimum values 7249b3d3934dSBarry Smith 725095452b02SPatrick Sanan Notes: 725195452b02SPatrick Sanan If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 72527db568b7SBarry Smith 7253b3d3934dSBarry Smith Level: intermediate 7254b3d3934dSBarry Smith 7255b3d3934dSBarry Smith .keywords: TS, vector, monitor, view 7256b3d3934dSBarry Smith 7257b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7258b3d3934dSBarry Smith @*/ 7259b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7260b3d3934dSBarry Smith { 7261b3d3934dSBarry Smith PetscInt i; 7262b3d3934dSBarry Smith 7263b3d3934dSBarry Smith PetscFunctionBegin; 7264b3d3934dSBarry Smith if (max) *max = NULL; 7265b3d3934dSBarry Smith if (min) *min = NULL; 7266b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7267b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 72685537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7269b3d3934dSBarry Smith if (max) *max = ctx->max; 7270b3d3934dSBarry Smith if (min) *min = ctx->min; 7271b3d3934dSBarry Smith break; 7272b3d3934dSBarry Smith } 7273b3d3934dSBarry Smith } 7274b3d3934dSBarry Smith PetscFunctionReturn(0); 7275b3d3934dSBarry Smith } 7276b3d3934dSBarry Smith 7277b3d3934dSBarry Smith /*@C 7278b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7279b3d3934dSBarry Smith 7280b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7281b3d3934dSBarry Smith 7282b3d3934dSBarry Smith Input Parameter: 7283b3d3934dSBarry Smith . ctx - the monitor context 7284b3d3934dSBarry Smith 7285b3d3934dSBarry Smith Level: intermediate 7286b3d3934dSBarry Smith 7287b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy 7288b3d3934dSBarry Smith 72897db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7290b3d3934dSBarry Smith @*/ 7291b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7292b3d3934dSBarry Smith { 7293b3d3934dSBarry Smith PetscErrorCode ierr; 7294b3d3934dSBarry Smith 7295b3d3934dSBarry Smith PetscFunctionBegin; 7296b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7297b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7298b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7299b3d3934dSBarry Smith PetscFunctionReturn(0); 7300b3d3934dSBarry Smith } 7301f2dee214SBarry Smith 730224655328SShri /*@ 7303dcb233daSLisandro Dalcin TSRestartStep - Flags the solver to restart the next step 7304dcb233daSLisandro Dalcin 7305dcb233daSLisandro Dalcin Collective on TS 7306dcb233daSLisandro Dalcin 7307dcb233daSLisandro Dalcin Input Parameter: 7308dcb233daSLisandro Dalcin . ts - the TS context obtained from TSCreate() 7309dcb233daSLisandro Dalcin 7310dcb233daSLisandro Dalcin Level: advanced 7311dcb233daSLisandro Dalcin 7312dcb233daSLisandro Dalcin Notes: 7313dcb233daSLisandro Dalcin Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of 7314dcb233daSLisandro Dalcin discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution 7315dcb233daSLisandro Dalcin vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For 7316dcb233daSLisandro Dalcin the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce 7317dcb233daSLisandro Dalcin discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with 7318dcb233daSLisandro Dalcin discontinuous source terms). 7319dcb233daSLisandro Dalcin 7320dcb233daSLisandro Dalcin .keywords: TS, timestep, restart 7321dcb233daSLisandro Dalcin 7322dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep() 7323dcb233daSLisandro Dalcin @*/ 7324dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts) 7325dcb233daSLisandro Dalcin { 7326dcb233daSLisandro Dalcin PetscFunctionBegin; 7327dcb233daSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7328dcb233daSLisandro Dalcin ts->steprestart = PETSC_TRUE; 7329dcb233daSLisandro Dalcin PetscFunctionReturn(0); 7330dcb233daSLisandro Dalcin } 7331dcb233daSLisandro Dalcin 7332dcb233daSLisandro Dalcin /*@ 733324655328SShri TSRollBack - Rolls back one time step 733424655328SShri 733524655328SShri Collective on TS 733624655328SShri 733724655328SShri Input Parameter: 733824655328SShri . ts - the TS context obtained from TSCreate() 733924655328SShri 734024655328SShri Level: advanced 734124655328SShri 734224655328SShri .keywords: TS, timestep, rollback 734324655328SShri 734424655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 734524655328SShri @*/ 734624655328SShri PetscErrorCode TSRollBack(TS ts) 734724655328SShri { 734824655328SShri PetscErrorCode ierr; 734924655328SShri 735024655328SShri PetscFunctionBegin; 735124655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7352b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 735324655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 735424655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 735524655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 735624655328SShri ts->ptime = ts->ptime_prev; 7357be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 73582808aa04SLisandro Dalcin ts->steps--; 7359b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 736024655328SShri PetscFunctionReturn(0); 736124655328SShri } 7362aeb4809dSShri Abhyankar 7363ff22ae23SHong Zhang /*@ 7364ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7365ff22ae23SHong Zhang 7366ff22ae23SHong Zhang Input Parameter: 7367ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7368ff22ae23SHong Zhang 73690429704eSStefano Zampini Output Parameters: 73700429704eSStefano Zampini + ns - the number of stages 73710429704eSStefano Zampini - Y - the current stage vectors 73720429704eSStefano Zampini 7373ff22ae23SHong Zhang Level: advanced 7374ff22ae23SHong Zhang 73750429704eSStefano Zampini Notes: Both ns and Y can be NULL. 73760429704eSStefano Zampini 7377ff22ae23SHong Zhang .keywords: TS, getstages 7378ff22ae23SHong Zhang 7379ff22ae23SHong Zhang .seealso: TSCreate() 7380ff22ae23SHong Zhang @*/ 7381ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7382ff22ae23SHong Zhang { 7383ff22ae23SHong Zhang PetscErrorCode ierr; 7384ff22ae23SHong Zhang 7385ff22ae23SHong Zhang PetscFunctionBegin; 7386ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 73870429704eSStefano Zampini if (ns) PetscValidPointer(ns,2); 73880429704eSStefano Zampini if (Y) PetscValidPointer(Y,3); 73890429704eSStefano Zampini if (!ts->ops->getstages) { 73900429704eSStefano Zampini if (ns) *ns = 0; 73910429704eSStefano Zampini if (Y) *Y = NULL; 73920429704eSStefano Zampini } else { 7393ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7394ff22ae23SHong Zhang } 7395ff22ae23SHong Zhang PetscFunctionReturn(0); 7396ff22ae23SHong Zhang } 7397ff22ae23SHong Zhang 7398847ff0e1SMatthew G. Knepley /*@C 7399847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7400847ff0e1SMatthew G. Knepley 7401847ff0e1SMatthew G. Knepley Collective on SNES 7402847ff0e1SMatthew G. Knepley 7403847ff0e1SMatthew G. Knepley Input Parameters: 7404847ff0e1SMatthew G. Knepley + ts - the TS context 7405847ff0e1SMatthew G. Knepley . t - current timestep 7406847ff0e1SMatthew G. Knepley . U - state vector 7407847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7408847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7409847ff0e1SMatthew G. Knepley - ctx - an optional user context 7410847ff0e1SMatthew G. Knepley 7411847ff0e1SMatthew G. Knepley Output Parameters: 7412847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7413847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7414847ff0e1SMatthew G. Knepley 7415847ff0e1SMatthew G. Knepley Level: intermediate 7416847ff0e1SMatthew G. Knepley 7417847ff0e1SMatthew G. Knepley Notes: 7418847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7419847ff0e1SMatthew G. Knepley 7420847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7421847ff0e1SMatthew G. Knepley 7422847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7423847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7424847ff0e1SMatthew G. Knepley 7425847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7426847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7427847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7428847ff0e1SMatthew G. Knepley 7429847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse 7430847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7431847ff0e1SMatthew G. Knepley @*/ 7432847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7433847ff0e1SMatthew G. Knepley { 7434847ff0e1SMatthew G. Knepley SNES snes; 7435847ff0e1SMatthew G. Knepley MatFDColoring color; 7436847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7437847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7438847ff0e1SMatthew G. Knepley 7439847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7440c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7441847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7442847ff0e1SMatthew G. Knepley if (!color) { 7443847ff0e1SMatthew G. Knepley DM dm; 7444847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7445847ff0e1SMatthew G. Knepley 7446847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7447847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7448847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7449847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7450847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7451847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7452847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7453847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7454847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7455847ff0e1SMatthew G. Knepley } else { 7456847ff0e1SMatthew G. Knepley MatColoring mc; 7457847ff0e1SMatthew G. Knepley 7458847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7459847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7460847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7461847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7462847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7463847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7464847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7465847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7466847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7467847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7468847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7469847ff0e1SMatthew G. Knepley } 7470847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7471847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7472847ff0e1SMatthew G. Knepley } 7473847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7474847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7475847ff0e1SMatthew G. Knepley if (J != B) { 7476847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7477847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7478847ff0e1SMatthew G. Knepley } 7479847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7480847ff0e1SMatthew G. Knepley } 748193b34091SDebojyoti Ghosh 7482cb9d8021SPierre Barbier de Reuille /*@ 7483cb9d8021SPierre Barbier de Reuille TSSetFunctionDomainError - Set the function testing if the current state vector is valid 7484cb9d8021SPierre Barbier de Reuille 7485cb9d8021SPierre Barbier de Reuille Input Parameters: 7486cb9d8021SPierre Barbier de Reuille ts - the TS context 7487cb9d8021SPierre Barbier de Reuille func - function called within TSFunctionDomainError 7488cb9d8021SPierre Barbier de Reuille 7489cb9d8021SPierre Barbier de Reuille Level: intermediate 7490cb9d8021SPierre Barbier de Reuille 7491cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain 7492cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError() 7493cb9d8021SPierre Barbier de Reuille @*/ 7494cb9d8021SPierre Barbier de Reuille 7495d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7496cb9d8021SPierre Barbier de Reuille { 7497cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7498cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7499cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7500cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7501cb9d8021SPierre Barbier de Reuille } 7502cb9d8021SPierre Barbier de Reuille 7503cb9d8021SPierre Barbier de Reuille /*@ 7504cb9d8021SPierre Barbier de Reuille TSFunctionDomainError - Check if the current state is valid 7505cb9d8021SPierre Barbier de Reuille 7506cb9d8021SPierre Barbier de Reuille Input Parameters: 7507cb9d8021SPierre Barbier de Reuille ts - the TS context 7508cb9d8021SPierre Barbier de Reuille stagetime - time of the simulation 7509d183316bSPierre Barbier de Reuille Y - state vector to check. 7510cb9d8021SPierre Barbier de Reuille 7511cb9d8021SPierre Barbier de Reuille Output Parameter: 7512cb9d8021SPierre Barbier de Reuille accept - Set to PETSC_FALSE if the current state vector is valid. 7513cb9d8021SPierre Barbier de Reuille 7514cb9d8021SPierre Barbier de Reuille Note: 7515cb9d8021SPierre Barbier de Reuille This function should be used to ensure the state is in a valid part of the space. 7516cb9d8021SPierre Barbier de Reuille For example, one can ensure here all values are positive. 751796a0c994SBarry Smith 751896a0c994SBarry Smith Level: advanced 7519cb9d8021SPierre Barbier de Reuille @*/ 7520d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7521cb9d8021SPierre Barbier de Reuille { 7522cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7523cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7524cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7525cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7526d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7527cb9d8021SPierre Barbier de Reuille } 7528cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7529cb9d8021SPierre Barbier de Reuille } 75301ceb14c0SBarry Smith 753193b34091SDebojyoti Ghosh /*@C 7532e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 753393b34091SDebojyoti Ghosh 753493b34091SDebojyoti Ghosh Collective on MPI_Comm 753593b34091SDebojyoti Ghosh 753693b34091SDebojyoti Ghosh Input Parameter: 753793b34091SDebojyoti Ghosh . tsin - The input TS 753893b34091SDebojyoti Ghosh 753993b34091SDebojyoti Ghosh Output Parameter: 7540e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 754193b34091SDebojyoti Ghosh 75425eca1a21SEmil Constantinescu Notes: 75435eca1a21SEmil 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. 75445eca1a21SEmil Constantinescu 7545928bb9adSStefano Zampini 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); TSSetSNES(ts,snes_dup); 75465eca1a21SEmil Constantinescu 75475eca1a21SEmil Constantinescu Level: developer 754893b34091SDebojyoti Ghosh 7549e5168f73SEmil Constantinescu .keywords: TS, clone 7550e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 755193b34091SDebojyoti Ghosh @*/ 7552baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 755393b34091SDebojyoti Ghosh { 755493b34091SDebojyoti Ghosh TS t; 755593b34091SDebojyoti Ghosh PetscErrorCode ierr; 7556dc846ba4SSatish Balay SNES snes_start; 7557dc846ba4SSatish Balay DM dm; 7558dc846ba4SSatish Balay TSType type; 755993b34091SDebojyoti Ghosh 756093b34091SDebojyoti Ghosh PetscFunctionBegin; 756193b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 756293b34091SDebojyoti Ghosh *tsout = NULL; 756393b34091SDebojyoti Ghosh 75647a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 756593b34091SDebojyoti Ghosh 756693b34091SDebojyoti Ghosh /* General TS description */ 756793b34091SDebojyoti Ghosh t->numbermonitors = 0; 756893b34091SDebojyoti Ghosh t->setupcalled = 0; 756993b34091SDebojyoti Ghosh t->ksp_its = 0; 757093b34091SDebojyoti Ghosh t->snes_its = 0; 757193b34091SDebojyoti Ghosh t->nwork = 0; 757293b34091SDebojyoti Ghosh t->rhsjacobian.time = -1e20; 757393b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 757493b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 757593b34091SDebojyoti Ghosh 757634561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 757734561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7578d15a3a53SEmil Constantinescu 757993b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 758093b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 758193b34091SDebojyoti Ghosh 758293b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 758351699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 758493b34091SDebojyoti Ghosh 7585e7069c78SShri t->trajectory = tsin->trajectory; 7586e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7587e7069c78SShri 7588e7069c78SShri t->event = tsin->event; 75896b10a48eSSatish Balay if (t->event) t->event->refct++; 7590e7069c78SShri 759193b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 759293b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7593e7069c78SShri t->ptime_prev = tsin->ptime_prev; 759493b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 759593b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 759693b34091SDebojyoti Ghosh t->steps = tsin->steps; 759793b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 759893b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 759993b34091SDebojyoti Ghosh t->atol = tsin->atol; 760093b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 760193b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 760293b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 760393b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 760493b34091SDebojyoti Ghosh 760593b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 760693b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 760793b34091SDebojyoti Ghosh 760893b34091SDebojyoti Ghosh t->vec_sol = NULL; 760993b34091SDebojyoti Ghosh 761093b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 761193b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 761293b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 761393b34091SDebojyoti Ghosh 761493b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 761593b34091SDebojyoti Ghosh 76160d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 76170d4fed19SBarry Smith PetscInt i; 76180d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 76190d4fed19SBarry Smith for (i=0; i<10; i++) { 76200d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 76210d4fed19SBarry Smith } 76220d4fed19SBarry Smith } 762393b34091SDebojyoti Ghosh *tsout = t; 762493b34091SDebojyoti Ghosh PetscFunctionReturn(0); 762593b34091SDebojyoti Ghosh } 7626f3b1f45cSBarry Smith 7627f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y) 7628f3b1f45cSBarry Smith { 7629f3b1f45cSBarry Smith PetscErrorCode ierr; 7630f3b1f45cSBarry Smith TS ts = (TS) ctx; 7631f3b1f45cSBarry Smith 7632f3b1f45cSBarry Smith PetscFunctionBegin; 7633f3b1f45cSBarry Smith ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr); 7634f3b1f45cSBarry Smith PetscFunctionReturn(0); 7635f3b1f45cSBarry Smith } 7636f3b1f45cSBarry Smith 7637f3b1f45cSBarry Smith /*@ 7638f3b1f45cSBarry Smith TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function. 7639f3b1f45cSBarry Smith 7640f3b1f45cSBarry Smith Logically Collective on TS and Mat 7641f3b1f45cSBarry Smith 7642f3b1f45cSBarry Smith Input Parameters: 7643f3b1f45cSBarry Smith TS - the time stepping routine 7644f3b1f45cSBarry Smith 7645f3b1f45cSBarry Smith Output Parameter: 7646f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7647f3b1f45cSBarry Smith 7648f3b1f45cSBarry Smith Options Database: 7649f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator 7650f3b1f45cSBarry Smith 7651f3b1f45cSBarry Smith Level: advanced 7652f3b1f45cSBarry Smith 765395452b02SPatrick Sanan Notes: 765495452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7655f3b1f45cSBarry Smith 7656f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose() 7657f3b1f45cSBarry Smith @*/ 7658f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTest(TS ts,PetscBool *flg) 7659f3b1f45cSBarry Smith { 7660f3b1f45cSBarry Smith Mat J,B; 7661f3b1f45cSBarry Smith PetscErrorCode ierr; 7662f3b1f45cSBarry Smith TSRHSJacobian func; 7663f3b1f45cSBarry Smith void* ctx; 7664f3b1f45cSBarry Smith 7665f3b1f45cSBarry Smith PetscFunctionBegin; 7666f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7667f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7668f3b1f45cSBarry Smith ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7669f3b1f45cSBarry Smith PetscFunctionReturn(0); 7670f3b1f45cSBarry Smith } 7671f3b1f45cSBarry Smith 7672f3b1f45cSBarry Smith /*@C 7673f3b1f45cSBarry Smith TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function. 7674f3b1f45cSBarry Smith 7675f3b1f45cSBarry Smith Logically Collective on TS and Mat 7676f3b1f45cSBarry Smith 7677f3b1f45cSBarry Smith Input Parameters: 7678f3b1f45cSBarry Smith TS - the time stepping routine 7679f3b1f45cSBarry Smith 7680f3b1f45cSBarry Smith Output Parameter: 7681f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7682f3b1f45cSBarry Smith 7683f3b1f45cSBarry Smith Options Database: 7684f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator 7685f3b1f45cSBarry Smith 768695452b02SPatrick Sanan Notes: 768795452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7688f3b1f45cSBarry Smith 7689f3b1f45cSBarry Smith Level: advanced 7690f3b1f45cSBarry Smith 7691f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest() 7692f3b1f45cSBarry Smith @*/ 7693f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTestTranspose(TS ts,PetscBool *flg) 7694f3b1f45cSBarry Smith { 7695f3b1f45cSBarry Smith Mat J,B; 7696f3b1f45cSBarry Smith PetscErrorCode ierr; 7697f3b1f45cSBarry Smith void *ctx; 7698f3b1f45cSBarry Smith TSRHSJacobian func; 7699f3b1f45cSBarry Smith 7700f3b1f45cSBarry Smith PetscFunctionBegin; 7701f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7702f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7703f3b1f45cSBarry Smith ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7704f3b1f45cSBarry Smith PetscFunctionReturn(0); 7705f3b1f45cSBarry Smith } 77060fe4d17eSHong Zhang 77070fe4d17eSHong Zhang /*@ 77080fe4d17eSHong Zhang TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used. 77090fe4d17eSHong Zhang 77100fe4d17eSHong Zhang Logically collective 77110fe4d17eSHong Zhang 77120fe4d17eSHong Zhang Input Parameter: 77130fe4d17eSHong Zhang + ts - timestepping context 77140fe4d17eSHong Zhang - use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 77150fe4d17eSHong Zhang 77160fe4d17eSHong Zhang Options Database: 77170fe4d17eSHong Zhang . -ts_use_splitrhsfunction - <true,false> 77180fe4d17eSHong Zhang 77190fe4d17eSHong Zhang Notes: 77200fe4d17eSHong Zhang This is only useful for multirate methods 77210fe4d17eSHong Zhang 77220fe4d17eSHong Zhang Level: intermediate 77230fe4d17eSHong Zhang 77240fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction() 77250fe4d17eSHong Zhang @*/ 77260fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction) 77270fe4d17eSHong Zhang { 77280fe4d17eSHong Zhang PetscFunctionBegin; 77290fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 77300fe4d17eSHong Zhang ts->use_splitrhsfunction = use_splitrhsfunction; 77310fe4d17eSHong Zhang PetscFunctionReturn(0); 77320fe4d17eSHong Zhang } 77330fe4d17eSHong Zhang 77340fe4d17eSHong Zhang /*@ 77350fe4d17eSHong Zhang TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used. 77360fe4d17eSHong Zhang 77370fe4d17eSHong Zhang Not collective 77380fe4d17eSHong Zhang 77390fe4d17eSHong Zhang Input Parameter: 77400fe4d17eSHong Zhang . ts - timestepping context 77410fe4d17eSHong Zhang 77420fe4d17eSHong Zhang Output Parameter: 77430fe4d17eSHong Zhang . use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 77440fe4d17eSHong Zhang 77450fe4d17eSHong Zhang Level: intermediate 77460fe4d17eSHong Zhang 77470fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction() 77480fe4d17eSHong Zhang @*/ 77490fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction) 77500fe4d17eSHong Zhang { 77510fe4d17eSHong Zhang PetscFunctionBegin; 77520fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 77530fe4d17eSHong Zhang *use_splitrhsfunction = ts->use_splitrhsfunction; 77540fe4d17eSHong Zhang PetscFunctionReturn(0); 77550fe4d17eSHong Zhang } 7756