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> 6900f6b5bSMatthew G. Knepley #include <petscconvest.h> 7d763cef2SBarry Smith 81c167fc2SEmil Constantinescu #define SkipSmallValue(a,b,tol) if (PetscAbsScalar(a)< tol || PetscAbsScalar(b)< tol) continue; 91c167fc2SEmil Constantinescu 10d5ba7fb7SMatthew Knepley /* Logging support */ 11d74926cbSBarry Smith PetscClassId TS_CLASSID, DMTS_CLASSID; 12a05bf03eSHong Zhang PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 13d405a339SMatthew Knepley 14c793f718SLisandro Dalcin const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED","STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",NULL}; 1549354f04SShri Abhyankar 161c167fc2SEmil Constantinescu 17fde5950dSBarry Smith /*@C 18fde5950dSBarry Smith TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user 19fde5950dSBarry Smith 20fde5950dSBarry Smith Collective on TS 21fde5950dSBarry Smith 22fde5950dSBarry Smith Input Parameters: 23fde5950dSBarry Smith + ts - TS object you wish to monitor 24fde5950dSBarry Smith . name - the monitor type one is seeking 25fde5950dSBarry Smith . help - message indicating what monitoring is done 26fde5950dSBarry Smith . manual - manual page for the monitor 27fde5950dSBarry Smith . monitor - the monitor function 28fde5950dSBarry 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 29fde5950dSBarry Smith 30fde5950dSBarry Smith Level: developer 31fde5950dSBarry Smith 32fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), 33fde5950dSBarry Smith PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 34fde5950dSBarry Smith PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), 35fde5950dSBarry Smith PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), 36fde5950dSBarry Smith PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), 37fde5950dSBarry Smith PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), 38fde5950dSBarry Smith PetscOptionsFList(), PetscOptionsEList() 39fde5950dSBarry Smith @*/ 40721cd6eeSBarry 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*)) 41fde5950dSBarry Smith { 42fde5950dSBarry Smith PetscErrorCode ierr; 43fde5950dSBarry Smith PetscViewer viewer; 44fde5950dSBarry Smith PetscViewerFormat format; 45fde5950dSBarry Smith PetscBool flg; 46fde5950dSBarry Smith 47fde5950dSBarry Smith PetscFunctionBegin; 4816413a6aSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject) ts)->options,((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr); 49fde5950dSBarry Smith if (flg) { 50721cd6eeSBarry Smith PetscViewerAndFormat *vf; 51721cd6eeSBarry Smith ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr); 52721cd6eeSBarry Smith ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr); 53fde5950dSBarry Smith if (monitorsetup) { 54721cd6eeSBarry Smith ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr); 55fde5950dSBarry Smith } 56721cd6eeSBarry Smith ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr); 57fde5950dSBarry Smith } 58fde5950dSBarry Smith PetscFunctionReturn(0); 59fde5950dSBarry Smith } 60fde5950dSBarry Smith 612ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type) 622ffb9264SLisandro Dalcin { 632ffb9264SLisandro Dalcin PetscErrorCode ierr; 642ffb9264SLisandro Dalcin 652ffb9264SLisandro Dalcin PetscFunctionBegin; 66b92453a8SLisandro Dalcin PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1); 67b92453a8SLisandro Dalcin PetscValidCharPointer(default_type,2); 682ffb9264SLisandro Dalcin if (!((PetscObject)adapt)->type_name) { 692ffb9264SLisandro Dalcin ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr); 702ffb9264SLisandro Dalcin } 712ffb9264SLisandro Dalcin PetscFunctionReturn(0); 722ffb9264SLisandro Dalcin } 732ffb9264SLisandro Dalcin 74bdad233fSMatthew Knepley /*@ 75bdad233fSMatthew Knepley TSSetFromOptions - Sets various TS parameters from user options. 76bdad233fSMatthew Knepley 77bdad233fSMatthew Knepley Collective on TS 78bdad233fSMatthew Knepley 79bdad233fSMatthew Knepley Input Parameter: 80bdad233fSMatthew Knepley . ts - the TS context obtained from TSCreate() 81bdad233fSMatthew Knepley 82bdad233fSMatthew Knepley Options Database Keys: 83e49d4f37SHong Zhang + -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP 84ef222394SBarry Smith . -ts_save_trajectory - checkpoint the solution at each time-step 85ef85077eSLisandro Dalcin . -ts_max_time <time> - maximum time to compute to 86ef85077eSLisandro Dalcin . -ts_max_steps <steps> - maximum number of time-steps to take 87ef85077eSLisandro Dalcin . -ts_init_time <time> - initial time to start computation 884dc72f7fSBarry Smith . -ts_final_time <time> - final time to compute to (deprecated: use -ts_max_time) 893e4cdcaaSBarry Smith . -ts_dt <dt> - initial time step 906c51df0eSBarry 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 91a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 92a3cdaa26SBarry Smith . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 93a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false> - Error if no step succeeds 94a3cdaa26SBarry Smith . -ts_rtol <rtol> - relative tolerance for local truncation error 95a3cdaa26SBarry Smith . -ts_atol <atol> Absolute tolerance for local truncation error 96f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function 97f3b1f45cSBarry 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 98ef222394SBarry Smith . -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory) 99847ff0e1SMatthew G. Knepley . -ts_fd_color - Use finite differences with coloring to compute IJacobian 100bdad233fSMatthew Knepley . -ts_monitor - print information at each timestep 101de06c3feSJed Brown . -ts_monitor_lg_solution - Monitor solution graphically 102de06c3feSJed Brown . -ts_monitor_lg_error - Monitor error graphically 1037cf37e64SBarry Smith . -ts_monitor_error - Monitors norm of error 1046934998bSLisandro Dalcin . -ts_monitor_lg_timestep - Monitor timestep size graphically 1058b668821SLisandro Dalcin . -ts_monitor_lg_timestep_log - Monitor log timestep size graphically 106de06c3feSJed Brown . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 107de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 108de06c3feSJed Brown . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 109de06c3feSJed Brown . -ts_monitor_draw_solution - Monitor solution graphically 1103e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 1113e4cdcaaSBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 112fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 113e4160dc7SJulian Andrej . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu) 1149e336e28SPatrick Sanan - -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 11553ea634cSHong Zhang 1163d5a8a6aSBarry Smith Notes: 1173d5a8a6aSBarry Smith See SNESSetFromOptions() and KSPSetFromOptions() for how to control the nonlinear and linear solves used by the time-stepper. 1183d5a8a6aSBarry Smith 1193d5a8a6aSBarry Smith Certain SNES options get reset for each new nonlinear solver, for example -snes_lag_jacobian <its> and -snes_lag_preconditioner <its>, in order 1203d5a8a6aSBarry Smith to retain them over the multiple nonlinear solves that TS uses you mush also provide -snes_lag_jacobian_persists true and 1213d5a8a6aSBarry Smith -snes_lag_preconditioner_persists true 1223d5a8a6aSBarry Smith 1239e336e28SPatrick Sanan Developer Note: 1249e336e28SPatrick Sanan We should unify all the -ts_monitor options in the way that -xxx_view has been unified 125bdad233fSMatthew Knepley 126bdad233fSMatthew Knepley Level: beginner 127bdad233fSMatthew Knepley 128a313700dSBarry Smith .seealso: TSGetType() 129bdad233fSMatthew Knepley @*/ 1307087cfbeSBarry Smith PetscErrorCode TSSetFromOptions(TS ts) 131bdad233fSMatthew Knepley { 132bc952696SBarry Smith PetscBool opt,flg,tflg; 133dfbe8321SBarry Smith PetscErrorCode ierr; 134eabae89aSBarry Smith char monfilename[PETSC_MAX_PATH_LEN]; 13531748224SBarry Smith PetscReal time_step; 13649354f04SShri Abhyankar TSExactFinalTimeOption eftopt; 137d1212d36SBarry Smith char dir[16]; 138cd11d68dSLisandro Dalcin TSIFunction ifun; 1396991f827SBarry Smith const char *defaultType; 1406991f827SBarry Smith char typeName[256]; 141bdad233fSMatthew Knepley 142bdad233fSMatthew Knepley PetscFunctionBegin; 1430700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 1446991f827SBarry Smith 1456991f827SBarry Smith ierr = TSRegisterAll();CHKERRQ(ierr); 146cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 147cd11d68dSLisandro Dalcin 148cd11d68dSLisandro Dalcin ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr); 1491ef27442SStefano Zampini if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 1501ef27442SStefano Zampini else defaultType = ifun ? TSBEULER : TSEULER; 1516991f827SBarry Smith ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr); 1526991f827SBarry Smith if (opt) { 1536991f827SBarry Smith ierr = TSSetType(ts,typeName);CHKERRQ(ierr); 1546991f827SBarry Smith } else { 1556991f827SBarry Smith ierr = TSSetType(ts,defaultType);CHKERRQ(ierr); 1566991f827SBarry Smith } 157bdad233fSMatthew Knepley 158bdad233fSMatthew Knepley /* Handle generic TS options */ 1594dc72f7fSBarry Smith ierr = PetscOptionsDeprecated("-ts_final_time","-ts_max_time","3.10",NULL);CHKERRQ(ierr); 160ef85077eSLisandro Dalcin ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr); 16119eac22cSLisandro Dalcin ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr); 1620298fd71SBarry Smith ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr); 16331748224SBarry Smith ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr); 164cd11d68dSLisandro Dalcin if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);} 16549354f04SShri 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); 16649354f04SShri Abhyankar if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);} 1670298fd71SBarry 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); 1680298fd71SBarry Smith ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr); 1690298fd71SBarry Smith ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr); 1700298fd71SBarry Smith ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr); 1710298fd71SBarry Smith ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr); 172bdad233fSMatthew Knepley 173f3b1f45cSBarry 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); 174f3b1f45cSBarry 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); 1750fe4d17eSHong Zhang ierr = PetscOptionsBool("-ts_use_splitrhsfunction","Use the split RHS function for multirate solvers ","TSSetUseSplitRHSFunction",ts->use_splitrhsfunction,&ts->use_splitrhsfunction,NULL);CHKERRQ(ierr); 17656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS) 17756f85f32SBarry Smith { 17856f85f32SBarry Smith PetscBool set; 17956f85f32SBarry Smith flg = PETSC_FALSE; 18056f85f32SBarry Smith ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr); 18156f85f32SBarry Smith if (set) { 18256f85f32SBarry Smith ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr); 18356f85f32SBarry Smith } 18456f85f32SBarry Smith } 18556f85f32SBarry Smith #endif 18656f85f32SBarry Smith 187bdad233fSMatthew Knepley /* Monitor options */ 188cd11d68dSLisandro Dalcin ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr); 189cc9c3a59SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL);CHKERRQ(ierr); 190fde5950dSBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr); 191fde5950dSBarry Smith 192589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr); 1935180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);} 1945180491cSLisandro Dalcin 1954f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr); 196b3603a34SBarry Smith if (opt) { 1970b039ecaSBarry Smith TSMonitorLGCtx ctx; 1983923b477SBarry Smith PetscInt howoften = 1; 199b3603a34SBarry Smith 2000298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 201c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2024f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 203bdad233fSMatthew Knepley } 2046ba87a44SLisandro Dalcin 2054f09c107SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr); 206ef20d060SBarry Smith if (opt) { 2070b039ecaSBarry Smith TSMonitorLGCtx ctx; 2083923b477SBarry Smith PetscInt howoften = 1; 209ef20d060SBarry Smith 2100298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr); 211c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2124f09c107SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 213ef20d060SBarry Smith } 214edbaebb3SBarry Smith ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr); 2157cf37e64SBarry Smith 2166934998bSLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2176934998bSLisandro Dalcin if (opt) { 2186934998bSLisandro Dalcin TSMonitorLGCtx ctx; 2196934998bSLisandro Dalcin PetscInt howoften = 1; 2206934998bSLisandro Dalcin 2216934998bSLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2226ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2236934998bSLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2246934998bSLisandro Dalcin } 2258b668821SLisandro Dalcin ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr); 2268b668821SLisandro Dalcin if (opt) { 2278b668821SLisandro Dalcin TSMonitorLGCtx ctx; 2288b668821SLisandro Dalcin PetscInt howoften = 1; 2298b668821SLisandro Dalcin 2308b668821SLisandro Dalcin ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr); 2318b668821SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 2328b668821SLisandro Dalcin ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 2338b668821SLisandro Dalcin ctx->semilogy = PETSC_TRUE; 2348b668821SLisandro Dalcin } 2358b668821SLisandro Dalcin 236201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr); 237201da799SBarry Smith if (opt) { 238201da799SBarry Smith TSMonitorLGCtx ctx; 239201da799SBarry Smith PetscInt howoften = 1; 240201da799SBarry Smith 2410298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2426ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 243201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 244201da799SBarry Smith } 245201da799SBarry Smith ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr); 246201da799SBarry Smith if (opt) { 247201da799SBarry Smith TSMonitorLGCtx ctx; 248201da799SBarry Smith PetscInt howoften = 1; 249201da799SBarry Smith 2500298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr); 2516ba87a44SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr); 252201da799SBarry Smith ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr); 253201da799SBarry Smith } 2548189c53fSBarry Smith ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr); 2558189c53fSBarry Smith if (opt) { 2568189c53fSBarry Smith TSMonitorSPEigCtx ctx; 2578189c53fSBarry Smith PetscInt howoften = 1; 2588189c53fSBarry Smith 2590298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr); 260c793f718SLisandro Dalcin ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 2618189c53fSBarry Smith ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr); 2628189c53fSBarry Smith } 2630ec8ee2bSJoseph Pusztay ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr); 2641b575b74SJoseph Pusztay if (opt) { 2651b575b74SJoseph Pusztay TSMonitorSPCtx ctx; 2661b575b74SJoseph Pusztay PetscInt howoften = 1; 2670ec8ee2bSJoseph Pusztay ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr); 2681b575b74SJoseph Pusztay ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr); 2690ec8ee2bSJoseph Pusztay ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr); 2701b575b74SJoseph Pusztay } 271ef20d060SBarry Smith opt = PETSC_FALSE; 2720dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr); 273a7cc72afSBarry Smith if (opt) { 27483a4ac43SBarry Smith TSMonitorDrawCtx ctx; 27583a4ac43SBarry Smith PetscInt howoften = 1; 276a80ad3e0SBarry Smith 2770298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr); 278c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 27983a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 280bdad233fSMatthew Knepley } 281fb1732b5SBarry Smith opt = PETSC_FALSE; 2822d5ee99bSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr); 2832d5ee99bSBarry Smith if (opt) { 2842d5ee99bSBarry Smith TSMonitorDrawCtx ctx; 2852d5ee99bSBarry Smith PetscReal bounds[4]; 2862d5ee99bSBarry Smith PetscInt n = 4; 2872d5ee99bSBarry Smith PetscDraw draw; 2886934998bSLisandro Dalcin PetscDrawAxis axis; 2892d5ee99bSBarry Smith 2902d5ee99bSBarry Smith ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr); 2912d5ee99bSBarry Smith if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field"); 292c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr); 2932d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr); 2946934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr); 2956934998bSLisandro Dalcin ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr); 2966934998bSLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr); 2972d5ee99bSBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 2982d5ee99bSBarry Smith } 2992d5ee99bSBarry Smith opt = PETSC_FALSE; 3000dcf80beSBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr); 3013a471f94SBarry Smith if (opt) { 30283a4ac43SBarry Smith TSMonitorDrawCtx ctx; 30383a4ac43SBarry Smith PetscInt howoften = 1; 3043a471f94SBarry Smith 3050298fd71SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr); 306c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 30783a4ac43SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3083a471f94SBarry Smith } 3090ed3bfb6SBarry Smith opt = PETSC_FALSE; 3100ed3bfb6SBarry Smith ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr); 3110ed3bfb6SBarry Smith if (opt) { 3120ed3bfb6SBarry Smith TSMonitorDrawCtx ctx; 3130ed3bfb6SBarry Smith PetscInt howoften = 1; 3140ed3bfb6SBarry Smith 3150ed3bfb6SBarry Smith ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr); 316c793f718SLisandro Dalcin ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),NULL,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr); 3170ed3bfb6SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr); 3180ed3bfb6SBarry Smith } 319fde5950dSBarry Smith 320ed81e22dSJed Brown opt = PETSC_FALSE; 321589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_solution_vtk","Save each time step to a binary file, use filename-%%03D.vts","TSMonitorSolutionVTK",NULL,monfilename,sizeof(monfilename),&flg);CHKERRQ(ierr); 322ed81e22dSJed Brown if (flg) { 323ed81e22dSJed Brown const char *ptr,*ptr2; 324ed81e22dSJed Brown char *filetemplate; 325ce94432eSBarry Smith if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 326ed81e22dSJed Brown /* Do some cursory validation of the input. */ 327ed81e22dSJed Brown ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr); 328ce94432eSBarry Smith if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts"); 329ed81e22dSJed Brown for (ptr++; ptr && *ptr; ptr++) { 330ed81e22dSJed Brown ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr); 331ce94432eSBarry 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"); 332ed81e22dSJed Brown if (ptr2) break; 333ed81e22dSJed Brown } 334ed81e22dSJed Brown ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr); 335ed81e22dSJed Brown ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr); 336ed81e22dSJed Brown } 337bdad233fSMatthew Knepley 338589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,sizeof(dir),&flg);CHKERRQ(ierr); 339d1212d36SBarry Smith if (flg) { 340d1212d36SBarry Smith TSMonitorDMDARayCtx *rayctx; 341d1212d36SBarry Smith int ray = 0; 3423ee9839eSMatthew G. Knepley DMDirection ddir; 343d1212d36SBarry Smith DM da; 344d1212d36SBarry Smith PetscMPIInt rank; 345d1212d36SBarry Smith 346ce94432eSBarry Smith if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 3473ee9839eSMatthew G. Knepley if (dir[0] == 'x') ddir = DM_X; 3483ee9839eSMatthew G. Knepley else if (dir[0] == 'y') ddir = DM_Y; 349ce94432eSBarry Smith else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir); 350d1212d36SBarry Smith sscanf(dir+2,"%d",&ray); 351d1212d36SBarry Smith 3525bd1e576SStefano Zampini ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %d\n",dir[0],ray);CHKERRQ(ierr); 353b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 354d1212d36SBarry Smith ierr = TSGetDM(ts,&da);CHKERRQ(ierr); 355d1212d36SBarry Smith ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr); 356ce94432eSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr); 357d1212d36SBarry Smith if (!rank) { 358c793f718SLisandro Dalcin ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,NULL,NULL,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr); 359d1212d36SBarry Smith } 36051b4a12fSMatthew G. Knepley rayctx->lgctx = NULL; 361d1212d36SBarry Smith ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr); 362d1212d36SBarry Smith } 363589a23caSBarry Smith ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,sizeof(dir),&flg);CHKERRQ(ierr); 36451b4a12fSMatthew G. Knepley if (flg) { 36551b4a12fSMatthew G. Knepley TSMonitorDMDARayCtx *rayctx; 36651b4a12fSMatthew G. Knepley int ray = 0; 3673ee9839eSMatthew G. Knepley DMDirection ddir; 36851b4a12fSMatthew G. Knepley DM da; 36951b4a12fSMatthew G. Knepley PetscInt howoften = 1; 370d1212d36SBarry Smith 37151b4a12fSMatthew G. Knepley if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 3723ee9839eSMatthew G. Knepley if (dir[0] == 'x') ddir = DM_X; 3733ee9839eSMatthew G. Knepley else if (dir[0] == 'y') ddir = DM_Y; 37451b4a12fSMatthew G. Knepley else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 37551b4a12fSMatthew G. Knepley sscanf(dir+2, "%d", &ray); 3761c3436cfSJed Brown 3775bd1e576SStefano Zampini ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %d\n", dir[0], ray);CHKERRQ(ierr); 378b00a9115SJed Brown ierr = PetscNew(&rayctx);CHKERRQ(ierr); 37951b4a12fSMatthew G. Knepley ierr = TSGetDM(ts, &da);CHKERRQ(ierr); 38051b4a12fSMatthew G. Knepley ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr); 381c793f718SLisandro Dalcin ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr); 38251b4a12fSMatthew G. Knepley ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr); 38351b4a12fSMatthew G. Knepley } 384a7a1495cSBarry Smith 385b3d3934dSBarry Smith ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr); 386b3d3934dSBarry Smith if (opt) { 387b3d3934dSBarry Smith TSMonitorEnvelopeCtx ctx; 388b3d3934dSBarry Smith 389b3d3934dSBarry Smith ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr); 390b3d3934dSBarry Smith ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr); 391b3d3934dSBarry Smith } 392b3d3934dSBarry Smith 393847ff0e1SMatthew G. Knepley flg = PETSC_FALSE; 394847ff0e1SMatthew G. Knepley ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr); 395847ff0e1SMatthew G. Knepley if (flg) { 396847ff0e1SMatthew G. Knepley DM dm; 397847ff0e1SMatthew G. Knepley DMTS tdm; 398847ff0e1SMatthew G. Knepley 399847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 400847ff0e1SMatthew G. Knepley ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr); 401847ff0e1SMatthew G. Knepley tdm->ijacobianctx = NULL; 402c793f718SLisandro Dalcin ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL);CHKERRQ(ierr); 403847ff0e1SMatthew G. Knepley ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 404847ff0e1SMatthew G. Knepley } 405847ff0e1SMatthew G. Knepley 406d763cef2SBarry Smith /* Handle specific TS options */ 407d763cef2SBarry Smith if (ts->ops->setfromoptions) { 4086991f827SBarry Smith ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr); 409d763cef2SBarry Smith } 410fbc52257SHong Zhang 411a7bdc993SLisandro Dalcin /* Handle TSAdapt options */ 412a7bdc993SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 413a7bdc993SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 414a7bdc993SLisandro Dalcin ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr); 415a7bdc993SLisandro Dalcin 41668bece0bSHong Zhang /* TS trajectory must be set after TS, since it may use some TS options above */ 4174f122a70SLisandro Dalcin tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 41868bece0bSHong Zhang ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr); 41968bece0bSHong Zhang if (tflg) { 42068bece0bSHong Zhang ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr); 42168bece0bSHong Zhang } 422a05bf03eSHong Zhang 423a05bf03eSHong Zhang ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr); 424d763cef2SBarry Smith 425d763cef2SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 4260633abcbSJed Brown ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr); 427fbc52257SHong Zhang ierr = PetscOptionsEnd();CHKERRQ(ierr); 428d763cef2SBarry Smith 4294f122a70SLisandro Dalcin if (ts->trajectory) { 4304f122a70SLisandro Dalcin ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr); 431d763cef2SBarry Smith } 43268bece0bSHong Zhang 4331ef27442SStefano Zampini /* why do we have to do this here and not during TSSetUp? */ 4344f122a70SLisandro Dalcin ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr); 4351ef27442SStefano Zampini if (ts->problem_type == TS_LINEAR) { 4361ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&flg,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 4371ef27442SStefano Zampini if (!flg) { ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); } 4381ef27442SStefano Zampini } 4394f122a70SLisandro Dalcin ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr); 440d763cef2SBarry Smith PetscFunctionReturn(0); 441d763cef2SBarry Smith } 442d763cef2SBarry Smith 443d2daff3dSHong Zhang /*@ 44478fbdcc8SBarry Smith TSGetTrajectory - Gets the trajectory from a TS if it exists 44578fbdcc8SBarry Smith 44678fbdcc8SBarry Smith Collective on TS 44778fbdcc8SBarry Smith 44878fbdcc8SBarry Smith Input Parameters: 44978fbdcc8SBarry Smith . ts - the TS context obtained from TSCreate() 45078fbdcc8SBarry Smith 4517a7aea1fSJed Brown Output Parameters: 45278fbdcc8SBarry Smith . tr - the TSTrajectory object, if it exists 45378fbdcc8SBarry Smith 45478fbdcc8SBarry Smith Note: This routine should be called after all TS options have been set 45578fbdcc8SBarry Smith 45678fbdcc8SBarry Smith Level: advanced 45778fbdcc8SBarry Smith 45878fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate() 45978fbdcc8SBarry Smith 46078fbdcc8SBarry Smith @*/ 46178fbdcc8SBarry Smith PetscErrorCode TSGetTrajectory(TS ts,TSTrajectory *tr) 46278fbdcc8SBarry Smith { 46378fbdcc8SBarry Smith PetscFunctionBegin; 46478fbdcc8SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 46578fbdcc8SBarry Smith *tr = ts->trajectory; 46678fbdcc8SBarry Smith PetscFunctionReturn(0); 46778fbdcc8SBarry Smith } 46878fbdcc8SBarry Smith 46978fbdcc8SBarry Smith /*@ 470bc952696SBarry Smith TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object 471d2daff3dSHong Zhang 472d2daff3dSHong Zhang Collective on TS 473d2daff3dSHong Zhang 474d2daff3dSHong Zhang Input Parameters: 475bc952696SBarry Smith . ts - the TS context obtained from TSCreate() 476bc952696SBarry Smith 47778fbdcc8SBarry Smith Options Database: 47878fbdcc8SBarry Smith + -ts_save_trajectory - saves the trajectory to a file 47978fbdcc8SBarry Smith - -ts_trajectory_type type 48078fbdcc8SBarry Smith 48168bece0bSHong Zhang Note: This routine should be called after all TS options have been set 482d2daff3dSHong Zhang 483c3a89c15SBarry Smith The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and 48478fbdcc8SBarry Smith MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 48578fbdcc8SBarry Smith 486d2daff3dSHong Zhang Level: intermediate 487d2daff3dSHong Zhang 4882d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 489d2daff3dSHong Zhang 490d2daff3dSHong Zhang @*/ 491bc952696SBarry Smith PetscErrorCode TSSetSaveTrajectory(TS ts) 492d2daff3dSHong Zhang { 493bc952696SBarry Smith PetscErrorCode ierr; 494bc952696SBarry Smith 495d2daff3dSHong Zhang PetscFunctionBegin; 496d2daff3dSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 497bc952696SBarry Smith if (!ts->trajectory) { 498bc952696SBarry Smith ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 499bc952696SBarry Smith } 500d2daff3dSHong Zhang PetscFunctionReturn(0); 501d2daff3dSHong Zhang } 502d2daff3dSHong Zhang 503a7a1495cSBarry Smith /*@ 5042d29f1f2SStefano Zampini TSResetTrajectory - Destroys and recreates the internal TSTrajectory object 5052d29f1f2SStefano Zampini 5062d29f1f2SStefano Zampini Collective on TS 5072d29f1f2SStefano Zampini 5082d29f1f2SStefano Zampini Input Parameters: 5092d29f1f2SStefano Zampini . ts - the TS context obtained from TSCreate() 5102d29f1f2SStefano Zampini 5112d29f1f2SStefano Zampini Level: intermediate 5122d29f1f2SStefano Zampini 5132d29f1f2SStefano Zampini .seealso: TSGetTrajectory(), TSAdjointSolve() 5142d29f1f2SStefano Zampini 5152d29f1f2SStefano Zampini @*/ 5162d29f1f2SStefano Zampini PetscErrorCode TSResetTrajectory(TS ts) 5172d29f1f2SStefano Zampini { 5182d29f1f2SStefano Zampini PetscErrorCode ierr; 5192d29f1f2SStefano Zampini 5202d29f1f2SStefano Zampini PetscFunctionBegin; 5212d29f1f2SStefano Zampini PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5222d29f1f2SStefano Zampini if (ts->trajectory) { 5232d29f1f2SStefano Zampini ierr = TSTrajectoryDestroy(&ts->trajectory);CHKERRQ(ierr); 5242d29f1f2SStefano Zampini ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr); 5252d29f1f2SStefano Zampini } 5262d29f1f2SStefano Zampini PetscFunctionReturn(0); 5272d29f1f2SStefano Zampini } 5282d29f1f2SStefano Zampini 5292d29f1f2SStefano Zampini /*@ 530a7a1495cSBarry Smith TSComputeRHSJacobian - Computes the Jacobian matrix that has been 531a7a1495cSBarry Smith set with TSSetRHSJacobian(). 532a7a1495cSBarry Smith 533d083f849SBarry Smith Collective on TS 534a7a1495cSBarry Smith 535a7a1495cSBarry Smith Input Parameters: 536316643e7SJed Brown + ts - the TS context 537a7a1495cSBarry Smith . t - current timestep 5380910c330SBarry Smith - U - input vector 539a7a1495cSBarry Smith 540a7a1495cSBarry Smith Output Parameters: 541a7a1495cSBarry Smith + A - Jacobian matrix 542a7a1495cSBarry Smith . B - optional preconditioning matrix 543a7a1495cSBarry Smith - flag - flag indicating matrix structure 544a7a1495cSBarry Smith 545a7a1495cSBarry Smith Notes: 546a7a1495cSBarry Smith Most users should not need to explicitly call this routine, as it 547a7a1495cSBarry Smith is used internally within the nonlinear solvers. 548a7a1495cSBarry Smith 54994b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 550a7a1495cSBarry Smith flag parameter. 551a7a1495cSBarry Smith 552a7a1495cSBarry Smith Level: developer 553a7a1495cSBarry Smith 55494b7f48cSBarry Smith .seealso: TSSetRHSJacobian(), KSPSetOperators() 555a7a1495cSBarry Smith @*/ 556d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B) 557a7a1495cSBarry Smith { 558dfbe8321SBarry Smith PetscErrorCode ierr; 559270bf2e7SJed Brown PetscObjectState Ustate; 5606c1e1eecSBarry Smith PetscObjectId Uid; 56124989b8cSPeter Brune DM dm; 562942e3340SBarry Smith DMTS tsdm; 56324989b8cSPeter Brune TSRHSJacobian rhsjacobianfunc; 56424989b8cSPeter Brune void *ctx; 565b2df71adSDebojyoti Ghosh TSRHSFunction rhsfunction; 566a7a1495cSBarry Smith 567a7a1495cSBarry Smith PetscFunctionBegin; 5680700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5690910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 5700910c330SBarry Smith PetscCheckSameComm(ts,1,U,3); 57124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 572942e3340SBarry Smith ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr); 5736374d434SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 5742663174eSHong Zhang ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr); 57559e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 5766c1e1eecSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 577971015bcSStefano Zampini 5782663174eSHong Zhang if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(0); 579e1244c69SJed Brown 58024989b8cSPeter Brune if (rhsjacobianfunc) { 58194ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 582a7a1495cSBarry Smith PetscStackPush("TS user Jacobian function"); 583d1e9a80fSBarry Smith ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr); 584a7a1495cSBarry Smith PetscStackPop; 58594ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 586ef66eb69SBarry Smith } else { 58794ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 588971015bcSStefano Zampini if (B && A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);} 589ef66eb69SBarry Smith } 5900e4ef248SJed Brown ts->rhsjacobian.time = t; 591971015bcSStefano Zampini ts->rhsjacobian.shift = 0; 592971015bcSStefano Zampini ts->rhsjacobian.scale = 1.; 5937f79407eSBarry Smith ierr = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr); 59459e4f3c8SBarry Smith ierr = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr); 595a7a1495cSBarry Smith PetscFunctionReturn(0); 596a7a1495cSBarry Smith } 597a7a1495cSBarry Smith 598316643e7SJed Brown /*@ 599d763cef2SBarry Smith TSComputeRHSFunction - Evaluates the right-hand-side function. 600d763cef2SBarry Smith 601d083f849SBarry Smith Collective on TS 602316643e7SJed Brown 603316643e7SJed Brown Input Parameters: 604316643e7SJed Brown + ts - the TS context 605316643e7SJed Brown . t - current time 6060910c330SBarry Smith - U - state vector 607316643e7SJed Brown 608316643e7SJed Brown Output Parameter: 609316643e7SJed Brown . y - right hand side 610316643e7SJed Brown 611316643e7SJed Brown Note: 612316643e7SJed Brown Most users should not need to explicitly call this routine, as it 613316643e7SJed Brown is used internally within the nonlinear solvers. 614316643e7SJed Brown 615316643e7SJed Brown Level: developer 616316643e7SJed Brown 617316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction() 618316643e7SJed Brown @*/ 6190910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y) 620d763cef2SBarry Smith { 621dfbe8321SBarry Smith PetscErrorCode ierr; 62224989b8cSPeter Brune TSRHSFunction rhsfunction; 62324989b8cSPeter Brune TSIFunction ifunction; 62424989b8cSPeter Brune void *ctx; 62524989b8cSPeter Brune DM dm; 62624989b8cSPeter Brune 627d763cef2SBarry Smith PetscFunctionBegin; 6280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6290910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 6300700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,4); 63124989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 63224989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr); 6330298fd71SBarry Smith ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr); 634d763cef2SBarry Smith 635ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 636d763cef2SBarry Smith 6370910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 63824989b8cSPeter Brune if (rhsfunction) { 6391be370b1SHong Zhang ierr = VecLockReadPush(U);CHKERRQ(ierr); 640d763cef2SBarry Smith PetscStackPush("TS user right-hand-side function"); 6410910c330SBarry Smith ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr); 642d763cef2SBarry Smith PetscStackPop; 6431be370b1SHong Zhang ierr = VecLockReadPop(U);CHKERRQ(ierr); 644214bc6a2SJed Brown } else { 645214bc6a2SJed Brown ierr = VecZeroEntries(y);CHKERRQ(ierr); 646b2cd27e8SJed Brown } 64744a41b28SSean Farley 6480910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr); 649d763cef2SBarry Smith PetscFunctionReturn(0); 650d763cef2SBarry Smith } 651d763cef2SBarry Smith 652ef20d060SBarry Smith /*@ 653ef20d060SBarry Smith TSComputeSolutionFunction - Evaluates the solution function. 654ef20d060SBarry Smith 655d083f849SBarry Smith Collective on TS 656ef20d060SBarry Smith 657ef20d060SBarry Smith Input Parameters: 658ef20d060SBarry Smith + ts - the TS context 659ef20d060SBarry Smith - t - current time 660ef20d060SBarry Smith 661ef20d060SBarry Smith Output Parameter: 6620910c330SBarry Smith . U - the solution 663ef20d060SBarry Smith 664ef20d060SBarry Smith Note: 665ef20d060SBarry Smith Most users should not need to explicitly call this routine, as it 666ef20d060SBarry Smith is used internally within the nonlinear solvers. 667ef20d060SBarry Smith 668ef20d060SBarry Smith Level: developer 669ef20d060SBarry Smith 670abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 671ef20d060SBarry Smith @*/ 6720910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U) 673ef20d060SBarry Smith { 674ef20d060SBarry Smith PetscErrorCode ierr; 675ef20d060SBarry Smith TSSolutionFunction solutionfunction; 676ef20d060SBarry Smith void *ctx; 677ef20d060SBarry Smith DM dm; 678ef20d060SBarry Smith 679ef20d060SBarry Smith PetscFunctionBegin; 680ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 6810910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 682ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 683ef20d060SBarry Smith ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr); 684ef20d060SBarry Smith 685ef20d060SBarry Smith if (solutionfunction) { 6869b7cd975SBarry Smith PetscStackPush("TS user solution function"); 6870910c330SBarry Smith ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr); 688ef20d060SBarry Smith PetscStackPop; 689ef20d060SBarry Smith } 690ef20d060SBarry Smith PetscFunctionReturn(0); 691ef20d060SBarry Smith } 6929b7cd975SBarry Smith /*@ 6939b7cd975SBarry Smith TSComputeForcingFunction - Evaluates the forcing function. 6949b7cd975SBarry Smith 695d083f849SBarry Smith Collective on TS 6969b7cd975SBarry Smith 6979b7cd975SBarry Smith Input Parameters: 6989b7cd975SBarry Smith + ts - the TS context 6999b7cd975SBarry Smith - t - current time 7009b7cd975SBarry Smith 7019b7cd975SBarry Smith Output Parameter: 7029b7cd975SBarry Smith . U - the function value 7039b7cd975SBarry Smith 7049b7cd975SBarry Smith Note: 7059b7cd975SBarry Smith Most users should not need to explicitly call this routine, as it 7069b7cd975SBarry Smith is used internally within the nonlinear solvers. 7079b7cd975SBarry Smith 7089b7cd975SBarry Smith Level: developer 7099b7cd975SBarry Smith 7109b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction() 7119b7cd975SBarry Smith @*/ 7129b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U) 7139b7cd975SBarry Smith { 7149b7cd975SBarry Smith PetscErrorCode ierr, (*forcing)(TS,PetscReal,Vec,void*); 7159b7cd975SBarry Smith void *ctx; 7169b7cd975SBarry Smith DM dm; 7179b7cd975SBarry Smith 7189b7cd975SBarry Smith PetscFunctionBegin; 7199b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7209b7cd975SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 7219b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 7229b7cd975SBarry Smith ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr); 7239b7cd975SBarry Smith 7249b7cd975SBarry Smith if (forcing) { 7259b7cd975SBarry Smith PetscStackPush("TS user forcing function"); 7269b7cd975SBarry Smith ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr); 7279b7cd975SBarry Smith PetscStackPop; 7289b7cd975SBarry Smith } 7299b7cd975SBarry Smith PetscFunctionReturn(0); 7309b7cd975SBarry Smith } 731ef20d060SBarry Smith 732214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs) 733214bc6a2SJed Brown { 7342dd45cf8SJed Brown Vec F; 735214bc6a2SJed Brown PetscErrorCode ierr; 736214bc6a2SJed Brown 737214bc6a2SJed Brown PetscFunctionBegin; 7380298fd71SBarry Smith *Frhs = NULL; 7390298fd71SBarry Smith ierr = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr); 740214bc6a2SJed Brown if (!ts->Frhs) { 7412dd45cf8SJed Brown ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr); 742214bc6a2SJed Brown } 743214bc6a2SJed Brown *Frhs = ts->Frhs; 744214bc6a2SJed Brown PetscFunctionReturn(0); 745214bc6a2SJed Brown } 746214bc6a2SJed Brown 747971015bcSStefano Zampini PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs) 748214bc6a2SJed Brown { 749214bc6a2SJed Brown Mat A,B; 7502dd45cf8SJed Brown PetscErrorCode ierr; 75141a1d4d2SBarry Smith TSIJacobian ijacobian; 752214bc6a2SJed Brown 753214bc6a2SJed Brown PetscFunctionBegin; 754c0cd0301SJed Brown if (Arhs) *Arhs = NULL; 755c0cd0301SJed Brown if (Brhs) *Brhs = NULL; 75641a1d4d2SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr); 757214bc6a2SJed Brown if (Arhs) { 758214bc6a2SJed Brown if (!ts->Arhs) { 75941a1d4d2SBarry Smith if (ijacobian) { 760214bc6a2SJed Brown ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr); 76141a1d4d2SBarry Smith } else { 76241a1d4d2SBarry Smith ts->Arhs = A; 76341a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 76441a1d4d2SBarry Smith } 7653565c898SBarry Smith } else { 7663565c898SBarry Smith PetscBool flg; 7673565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 7683565c898SBarry Smith /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 7693565c898SBarry Smith if (flg && !ijacobian && ts->Arhs == ts->Brhs){ 7703565c898SBarry Smith ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr); 7713565c898SBarry Smith ts->Arhs = A; 7723565c898SBarry Smith ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 7733565c898SBarry Smith } 774214bc6a2SJed Brown } 775214bc6a2SJed Brown *Arhs = ts->Arhs; 776214bc6a2SJed Brown } 777214bc6a2SJed Brown if (Brhs) { 778214bc6a2SJed Brown if (!ts->Brhs) { 779bdb70873SJed Brown if (A != B) { 78041a1d4d2SBarry Smith if (ijacobian) { 781214bc6a2SJed Brown ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr); 782bdb70873SJed Brown } else { 78341a1d4d2SBarry Smith ts->Brhs = B; 78441a1d4d2SBarry Smith ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 78541a1d4d2SBarry Smith } 78641a1d4d2SBarry Smith } else { 787bdb70873SJed Brown ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr); 78851699248SLisandro Dalcin ts->Brhs = ts->Arhs; 789bdb70873SJed Brown } 790214bc6a2SJed Brown } 791214bc6a2SJed Brown *Brhs = ts->Brhs; 792214bc6a2SJed Brown } 793214bc6a2SJed Brown PetscFunctionReturn(0); 794214bc6a2SJed Brown } 795214bc6a2SJed Brown 796316643e7SJed Brown /*@ 7970910c330SBarry Smith TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0 798316643e7SJed Brown 799d083f849SBarry Smith Collective on TS 800316643e7SJed Brown 801316643e7SJed Brown Input Parameters: 802316643e7SJed Brown + ts - the TS context 803316643e7SJed Brown . t - current time 8040910c330SBarry Smith . U - state vector 8050910c330SBarry Smith . Udot - time derivative of state vector 806214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate 807316643e7SJed Brown 808316643e7SJed Brown Output Parameter: 809316643e7SJed Brown . Y - right hand side 810316643e7SJed Brown 811316643e7SJed Brown Note: 812316643e7SJed Brown Most users should not need to explicitly call this routine, as it 813316643e7SJed Brown is used internally within the nonlinear solvers. 814316643e7SJed Brown 815316643e7SJed Brown If the user did did not write their equations in implicit form, this 816316643e7SJed Brown function recasts them in implicit form. 817316643e7SJed Brown 818316643e7SJed Brown Level: developer 819316643e7SJed Brown 820316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction() 821316643e7SJed Brown @*/ 8220910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex) 823316643e7SJed Brown { 824316643e7SJed Brown PetscErrorCode ierr; 82524989b8cSPeter Brune TSIFunction ifunction; 82624989b8cSPeter Brune TSRHSFunction rhsfunction; 82724989b8cSPeter Brune void *ctx; 82824989b8cSPeter Brune DM dm; 829316643e7SJed Brown 830316643e7SJed Brown PetscFunctionBegin; 8310700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 8320910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 8330910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 8340700a824SBarry Smith PetscValidHeaderSpecific(Y,VEC_CLASSID,5); 835316643e7SJed Brown 83624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 83724989b8cSPeter Brune ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr); 8380298fd71SBarry Smith ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 83924989b8cSPeter Brune 840ce94432eSBarry Smith if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()"); 841d90be118SSean Farley 8420910c330SBarry Smith ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 84324989b8cSPeter Brune if (ifunction) { 844316643e7SJed Brown PetscStackPush("TS user implicit function"); 8450910c330SBarry Smith ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr); 846316643e7SJed Brown PetscStackPop; 847214bc6a2SJed Brown } 848214bc6a2SJed Brown if (imex) { 84924989b8cSPeter Brune if (!ifunction) { 8500910c330SBarry Smith ierr = VecCopy(Udot,Y);CHKERRQ(ierr); 8512dd45cf8SJed Brown } 85224989b8cSPeter Brune } else if (rhsfunction) { 85324989b8cSPeter Brune if (ifunction) { 854214bc6a2SJed Brown Vec Frhs; 855214bc6a2SJed Brown ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 8560910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 857214bc6a2SJed Brown ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr); 8582dd45cf8SJed Brown } else { 8590910c330SBarry Smith ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr); 8600910c330SBarry Smith ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr); 861316643e7SJed Brown } 8624a6899ffSJed Brown } 8630910c330SBarry Smith ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr); 864316643e7SJed Brown PetscFunctionReturn(0); 865316643e7SJed Brown } 866316643e7SJed Brown 867*cfa8a9a2SHong Zhang /* 868*cfa8a9a2SHong Zhang TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call TSComputeRHSJacobian() on it. 869*cfa8a9a2SHong Zhang 870*cfa8a9a2SHong Zhang Note: 871*cfa8a9a2SHong Zhang This routine is needed when one switches from TSComputeIJacobian() to TSComputeRHSJacobian() because the Jacobian matrix may be shifted or scaled in TSComputeIJacobian(). 872*cfa8a9a2SHong Zhang 873*cfa8a9a2SHong Zhang */ 874*cfa8a9a2SHong Zhang static PetscErrorCode TSRecoverRHSJacobian(TS ts,Mat A,Mat B) 875*cfa8a9a2SHong Zhang { 876*cfa8a9a2SHong Zhang PetscErrorCode ierr; 877*cfa8a9a2SHong Zhang 878*cfa8a9a2SHong Zhang PetscFunctionBegin; 879*cfa8a9a2SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 880*cfa8a9a2SHong Zhang 881*cfa8a9a2SHong Zhang if (ts->rhsjacobian.shift) { 882*cfa8a9a2SHong Zhang ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr); 883*cfa8a9a2SHong Zhang } 884*cfa8a9a2SHong Zhang if (ts->rhsjacobian.scale == -1.) { 885*cfa8a9a2SHong Zhang ierr = MatScale(A,-1);CHKERRQ(ierr); 886*cfa8a9a2SHong Zhang } 887*cfa8a9a2SHong Zhang if (B && B == ts->Brhs && A != B) { 888*cfa8a9a2SHong Zhang if (ts->rhsjacobian.shift) { 889*cfa8a9a2SHong Zhang ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr); 890*cfa8a9a2SHong Zhang } 891*cfa8a9a2SHong Zhang if (ts->rhsjacobian.scale == -1.) { 892*cfa8a9a2SHong Zhang ierr = MatScale(B,-1);CHKERRQ(ierr); 893*cfa8a9a2SHong Zhang } 894*cfa8a9a2SHong Zhang } 895*cfa8a9a2SHong Zhang ts->rhsjacobian.shift = 0; 896*cfa8a9a2SHong Zhang ts->rhsjacobian.scale = 1.; 897*cfa8a9a2SHong Zhang PetscFunctionReturn(0); 898*cfa8a9a2SHong Zhang } 899*cfa8a9a2SHong Zhang 900316643e7SJed Brown /*@ 901316643e7SJed Brown TSComputeIJacobian - Evaluates the Jacobian of the DAE 902316643e7SJed Brown 903d083f849SBarry Smith Collective on TS 904316643e7SJed Brown 905316643e7SJed Brown Input 906316643e7SJed Brown Input Parameters: 907316643e7SJed Brown + ts - the TS context 908316643e7SJed Brown . t - current timestep 9090910c330SBarry Smith . U - state vector 9100910c330SBarry Smith . Udot - time derivative of state vector 911214bc6a2SJed Brown . shift - shift to apply, see note below 912214bc6a2SJed Brown - imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate 913316643e7SJed Brown 914316643e7SJed Brown Output Parameters: 915316643e7SJed Brown + A - Jacobian matrix 9163565c898SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as A 917316643e7SJed Brown 918316643e7SJed Brown Notes: 9190910c330SBarry Smith If F(t,U,Udot)=0 is the DAE, the required Jacobian is 920316643e7SJed Brown 9210910c330SBarry Smith dF/dU + shift*dF/dUdot 922316643e7SJed Brown 923316643e7SJed Brown Most users should not need to explicitly call this routine, as it 924316643e7SJed Brown is used internally within the nonlinear solvers. 925316643e7SJed Brown 926316643e7SJed Brown Level: developer 927316643e7SJed Brown 928316643e7SJed Brown .seealso: TSSetIJacobian() 92963495f91SJed Brown @*/ 930d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex) 931316643e7SJed Brown { 932316643e7SJed Brown PetscErrorCode ierr; 93324989b8cSPeter Brune TSIJacobian ijacobian; 93424989b8cSPeter Brune TSRHSJacobian rhsjacobian; 93524989b8cSPeter Brune DM dm; 93624989b8cSPeter Brune void *ctx; 937316643e7SJed Brown 938316643e7SJed Brown PetscFunctionBegin; 9390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 9400910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 9410910c330SBarry Smith PetscValidHeaderSpecific(Udot,VEC_CLASSID,4); 942316643e7SJed Brown PetscValidPointer(A,6); 94394ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,6); 944316643e7SJed Brown PetscValidPointer(B,7); 94594ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,7); 94624989b8cSPeter Brune 94724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 94824989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr); 9490298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 95024989b8cSPeter Brune 951ce94432eSBarry Smith if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 952316643e7SJed Brown 95394ab13aaSBarry Smith ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 95424989b8cSPeter Brune if (ijacobian) { 955316643e7SJed Brown PetscStackPush("TS user implicit Jacobian"); 956d1e9a80fSBarry Smith ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr); 957316643e7SJed Brown PetscStackPop; 9584a6899ffSJed Brown } 959214bc6a2SJed Brown if (imex) { 960b5abc632SBarry Smith if (!ijacobian) { /* system was written as Udot = G(t,U) */ 9614c26be97Sstefano_zampini PetscBool assembled; 962971015bcSStefano Zampini if (rhsjacobian) { 963971015bcSStefano Zampini Mat Arhs = NULL; 964971015bcSStefano Zampini ierr = TSGetRHSMats_Private(ts,&Arhs,NULL);CHKERRQ(ierr); 965971015bcSStefano Zampini if (A == Arhs) { 966e8b1e424SHong Zhang if (rhsjacobian == TSComputeRHSJacobianConstant) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Unsupported operation! cannot use TSComputeRHSJacobianConstant"); /* there is no way to reconstruct shift*M-J since J cannot be reevaluated */ 967971015bcSStefano Zampini ts->rhsjacobian.time = PETSC_MIN_REAL; 968971015bcSStefano Zampini } 969971015bcSStefano Zampini } 97094ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 9714c26be97Sstefano_zampini ierr = MatAssembled(A,&assembled);CHKERRQ(ierr); 9724c26be97Sstefano_zampini if (!assembled) { 9734c26be97Sstefano_zampini ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9744c26be97Sstefano_zampini ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9754c26be97Sstefano_zampini } 97694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 97794ab13aaSBarry Smith if (A != B) { 97894ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 9794c26be97Sstefano_zampini ierr = MatAssembled(B,&assembled);CHKERRQ(ierr); 9804c26be97Sstefano_zampini if (!assembled) { 9814c26be97Sstefano_zampini ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9824c26be97Sstefano_zampini ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 9834c26be97Sstefano_zampini } 98494ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 985214bc6a2SJed Brown } 986214bc6a2SJed Brown } 987214bc6a2SJed Brown } else { 988e1244c69SJed Brown Mat Arhs = NULL,Brhs = NULL; 989e8b1e424SHong Zhang if (rhsjacobian) { /* RHSJacobian needs to be converted to part of IJacobian if exists */ 990214bc6a2SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 991e1244c69SJed Brown } 992e8b1e424SHong Zhang if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */ 993e8b1e424SHong Zhang PetscObjectState Ustate; 994e8b1e424SHong Zhang PetscObjectId Uid; 995e8b1e424SHong Zhang TSRHSFunction rhsfunction; 996e8b1e424SHong Zhang 997e8b1e424SHong Zhang ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 998e8b1e424SHong Zhang ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr); 999e8b1e424SHong Zhang ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr); 1000097a96a2SHong Zhang if ((rhsjacobian == TSComputeRHSJacobianConstant || (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && rhsfunction != TSComputeRHSFunctionLinear)) && ts->rhsjacobian.scale == -1.) { /* No need to recompute RHSJacobian */ 1001e8b1e424SHong Zhang ierr = MatShift(A,shift-ts->rhsjacobian.shift);CHKERRQ(ierr); /* revert the old shift and add the new shift with a single call to MatShift */ 1002e8b1e424SHong Zhang } else { 10033565c898SBarry Smith PetscBool flg; 1004e8b1e424SHong Zhang 1005e8b1e424SHong Zhang if (ts->rhsjacobian.reuse) { /* Undo the damage */ 1006e8b1e424SHong Zhang /* MatScale has a short path for this case. 1007e8b1e424SHong Zhang However, this code path is taken the first time TSComputeRHSJacobian is called 1008e8b1e424SHong Zhang and the matrices have not been assembled yet */ 1009*cfa8a9a2SHong Zhang ierr = TSRecoverRHSJacobian(ts,A,B);CHKERRQ(ierr); 1010e8b1e424SHong Zhang } 1011e8b1e424SHong Zhang ierr = TSComputeRHSJacobian(ts,t,U,A,B);CHKERRQ(ierr); 10123565c898SBarry Smith ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr); 10133565c898SBarry Smith /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 10143565c898SBarry Smith if (!flg) { 101594ab13aaSBarry Smith ierr = MatScale(A,-1);CHKERRQ(ierr); 101694ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 10173565c898SBarry Smith } 101894ab13aaSBarry Smith if (A != B) { 101994ab13aaSBarry Smith ierr = MatScale(B,-1);CHKERRQ(ierr); 102094ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1021316643e7SJed Brown } 1022e8b1e424SHong Zhang } 1023e8b1e424SHong Zhang ts->rhsjacobian.scale = -1; 1024e8b1e424SHong Zhang ts->rhsjacobian.shift = shift; 1025e8b1e424SHong Zhang } else if (Arhs) { /* Both IJacobian and RHSJacobian exist or the RHS matrix provided (A) is different from the internal RHS matrix (Arhs) */ 1026e1244c69SJed Brown MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1027e8b1e424SHong Zhang 1028e1244c69SJed Brown if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 102994ab13aaSBarry Smith ierr = MatZeroEntries(A);CHKERRQ(ierr); 103094ab13aaSBarry Smith ierr = MatShift(A,shift);CHKERRQ(ierr); 103194ab13aaSBarry Smith if (A != B) { 103294ab13aaSBarry Smith ierr = MatZeroEntries(B);CHKERRQ(ierr); 103394ab13aaSBarry Smith ierr = MatShift(B,shift);CHKERRQ(ierr); 1034214bc6a2SJed Brown } 1035316643e7SJed Brown } 1036e8b1e424SHong Zhang ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 103794ab13aaSBarry Smith ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr); 103894ab13aaSBarry Smith if (A != B) { 103994ab13aaSBarry Smith ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr); 1040316643e7SJed Brown } 1041316643e7SJed Brown } 1042316643e7SJed Brown } 104394ab13aaSBarry Smith ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr); 1044316643e7SJed Brown PetscFunctionReturn(0); 1045316643e7SJed Brown } 1046316643e7SJed Brown 1047d763cef2SBarry Smith /*@C 1048d763cef2SBarry Smith TSSetRHSFunction - Sets the routine for evaluating the function, 1049b5abc632SBarry Smith where U_t = G(t,u). 1050d763cef2SBarry Smith 10513f9fe445SBarry Smith Logically Collective on TS 1052d763cef2SBarry Smith 1053d763cef2SBarry Smith Input Parameters: 1054d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 10550298fd71SBarry Smith . r - vector to put the computed right hand side (or NULL to have it created) 1056d763cef2SBarry Smith . f - routine for evaluating the right-hand-side function 1057d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 10580298fd71SBarry Smith function evaluation routine (may be NULL) 1059d763cef2SBarry Smith 1060a96d6ef6SBarry Smith Calling sequence of f: 1061a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec F,void *ctx); 1062d763cef2SBarry Smith 1063a96d6ef6SBarry Smith + ts - timestep context 1064a96d6ef6SBarry Smith . t - current timestep 1065d763cef2SBarry Smith . u - input vector 1066d763cef2SBarry Smith . F - function vector 1067d763cef2SBarry Smith - ctx - [optional] user-defined function context 1068d763cef2SBarry Smith 1069d763cef2SBarry Smith Level: beginner 1070d763cef2SBarry Smith 107195452b02SPatrick Sanan Notes: 107295452b02SPatrick Sanan You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE. 10732bbac0d3SBarry Smith 1074ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction() 1075d763cef2SBarry Smith @*/ 1076089b2837SJed Brown PetscErrorCode TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx) 1077d763cef2SBarry Smith { 1078089b2837SJed Brown PetscErrorCode ierr; 1079089b2837SJed Brown SNES snes; 10800298fd71SBarry Smith Vec ralloc = NULL; 108124989b8cSPeter Brune DM dm; 1082d763cef2SBarry Smith 1083089b2837SJed Brown PetscFunctionBegin; 10840700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1085ca94891dSJed Brown if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 108624989b8cSPeter Brune 108724989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 108824989b8cSPeter Brune ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr); 1089089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1090e856ceecSJed Brown if (!r && !ts->dm && ts->vec_sol) { 1091e856ceecSJed Brown ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 1092e856ceecSJed Brown r = ralloc; 1093e856ceecSJed Brown } 1094089b2837SJed Brown ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 1095e856ceecSJed Brown ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1096d763cef2SBarry Smith PetscFunctionReturn(0); 1097d763cef2SBarry Smith } 1098d763cef2SBarry Smith 1099ef20d060SBarry Smith /*@C 1100abd5a294SJed Brown TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1101ef20d060SBarry Smith 1102ef20d060SBarry Smith Logically Collective on TS 1103ef20d060SBarry Smith 1104ef20d060SBarry Smith Input Parameters: 1105ef20d060SBarry Smith + ts - the TS context obtained from TSCreate() 1106ef20d060SBarry Smith . f - routine for evaluating the solution 1107ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the 11080298fd71SBarry Smith function evaluation routine (may be NULL) 1109ef20d060SBarry Smith 1110a96d6ef6SBarry Smith Calling sequence of f: 1111a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,void *ctx); 1112ef20d060SBarry Smith 1113ef20d060SBarry Smith + t - current timestep 1114ef20d060SBarry Smith . u - output vector 1115ef20d060SBarry Smith - ctx - [optional] user-defined function context 1116ef20d060SBarry Smith 11170ed3bfb6SBarry Smith Options Database: 11180ed3bfb6SBarry Smith + -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction() 11190ed3bfb6SBarry Smith - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 11200ed3bfb6SBarry Smith 1121abd5a294SJed Brown Notes: 1122abd5a294SJed Brown This routine is used for testing accuracy of time integration schemes when you already know the solution. 1123abd5a294SJed Brown If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1124abd5a294SJed Brown create closed-form solutions with non-physical forcing terms. 1125abd5a294SJed Brown 11264f09c107SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 1127abd5a294SJed Brown 1128ef20d060SBarry Smith Level: beginner 1129ef20d060SBarry Smith 11300ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError() 1131ef20d060SBarry Smith @*/ 1132ef20d060SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx) 1133ef20d060SBarry Smith { 1134ef20d060SBarry Smith PetscErrorCode ierr; 1135ef20d060SBarry Smith DM dm; 1136ef20d060SBarry Smith 1137ef20d060SBarry Smith PetscFunctionBegin; 1138ef20d060SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1139ef20d060SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1140ef20d060SBarry Smith ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr); 1141ef20d060SBarry Smith PetscFunctionReturn(0); 1142ef20d060SBarry Smith } 1143ef20d060SBarry Smith 11449b7cd975SBarry Smith /*@C 11459b7cd975SBarry Smith TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 11469b7cd975SBarry Smith 11479b7cd975SBarry Smith Logically Collective on TS 11489b7cd975SBarry Smith 11499b7cd975SBarry Smith Input Parameters: 11509b7cd975SBarry Smith + ts - the TS context obtained from TSCreate() 1151e162b725SBarry Smith . func - routine for evaluating the forcing function 11529b7cd975SBarry Smith - ctx - [optional] user-defined context for private data for the 11530298fd71SBarry Smith function evaluation routine (may be NULL) 11549b7cd975SBarry Smith 11559b7cd975SBarry Smith Calling sequence of func: 11566bc98fa9SBarry Smith $ PetscErrorCode func (TS ts,PetscReal t,Vec f,void *ctx); 11579b7cd975SBarry Smith 11589b7cd975SBarry Smith + t - current timestep 1159e162b725SBarry Smith . f - output vector 11609b7cd975SBarry Smith - ctx - [optional] user-defined function context 11619b7cd975SBarry Smith 11629b7cd975SBarry Smith Notes: 11639b7cd975SBarry Smith This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1164e162b725SBarry 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 1165e162b725SBarry Smith definition of the problem you are solving and hence possibly introducing bugs. 1166e162b725SBarry Smith 1167e162b725SBarry Smith This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0 1168e162b725SBarry Smith 1169e162b725SBarry 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 1170e162b725SBarry Smith parameters can be passed in the ctx variable. 11719b7cd975SBarry Smith 11729b7cd975SBarry Smith For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history. 11739b7cd975SBarry Smith 11749b7cd975SBarry Smith Level: beginner 11759b7cd975SBarry Smith 11769b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction() 11779b7cd975SBarry Smith @*/ 1178e162b725SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx) 11799b7cd975SBarry Smith { 11809b7cd975SBarry Smith PetscErrorCode ierr; 11819b7cd975SBarry Smith DM dm; 11829b7cd975SBarry Smith 11839b7cd975SBarry Smith PetscFunctionBegin; 11849b7cd975SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 11859b7cd975SBarry Smith ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1186e162b725SBarry Smith ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr); 11879b7cd975SBarry Smith PetscFunctionReturn(0); 11889b7cd975SBarry Smith } 11899b7cd975SBarry Smith 1190d763cef2SBarry Smith /*@C 1191f7ab8db6SBarry Smith TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1192b5abc632SBarry Smith where U_t = G(U,t), as well as the location to store the matrix. 1193d763cef2SBarry Smith 11943f9fe445SBarry Smith Logically Collective on TS 1195d763cef2SBarry Smith 1196d763cef2SBarry Smith Input Parameters: 1197d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 1198e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1199e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1200d763cef2SBarry Smith . f - the Jacobian evaluation routine 1201d763cef2SBarry Smith - ctx - [optional] user-defined context for private data for the 12020298fd71SBarry Smith Jacobian evaluation routine (may be NULL) 1203d763cef2SBarry Smith 1204f7ab8db6SBarry Smith Calling sequence of f: 1205a96d6ef6SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx); 1206d763cef2SBarry Smith 1207d763cef2SBarry Smith + t - current timestep 1208d763cef2SBarry Smith . u - input vector 1209e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1210e5d3d808SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat) 1211d763cef2SBarry Smith - ctx - [optional] user-defined context for matrix evaluation routine 1212d763cef2SBarry Smith 12136cd88445SBarry Smith Notes: 12146cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 12156cd88445SBarry Smith 12166cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1217ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1218d763cef2SBarry Smith 1219d763cef2SBarry Smith Level: beginner 1220d763cef2SBarry Smith 1221ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian() 1222d763cef2SBarry Smith 1223d763cef2SBarry Smith @*/ 1224e5d3d808SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx) 1225d763cef2SBarry Smith { 1226277b19d0SLisandro Dalcin PetscErrorCode ierr; 1227089b2837SJed Brown SNES snes; 122824989b8cSPeter Brune DM dm; 122924989b8cSPeter Brune TSIJacobian ijacobian; 1230277b19d0SLisandro Dalcin 1231d763cef2SBarry Smith PetscFunctionBegin; 12320700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1233e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1234e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1235e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1236e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 1237d763cef2SBarry Smith 123824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 123924989b8cSPeter Brune ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr); 12400298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr); 1241089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 12425f659677SPeter Brune if (!ijacobian) { 1243e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 12440e4ef248SJed Brown } 1245e5d3d808SBarry Smith if (Amat) { 1246e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr); 12470e4ef248SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 1248e5d3d808SBarry Smith ts->Arhs = Amat; 12490e4ef248SJed Brown } 1250e5d3d808SBarry Smith if (Pmat) { 1251e5d3d808SBarry Smith ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr); 12520e4ef248SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 1253e5d3d808SBarry Smith ts->Brhs = Pmat; 12540e4ef248SJed Brown } 1255d763cef2SBarry Smith PetscFunctionReturn(0); 1256d763cef2SBarry Smith } 1257d763cef2SBarry Smith 1258316643e7SJed Brown /*@C 1259b5abc632SBarry Smith TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1260316643e7SJed Brown 12613f9fe445SBarry Smith Logically Collective on TS 1262316643e7SJed Brown 1263316643e7SJed Brown Input Parameters: 1264316643e7SJed Brown + ts - the TS context obtained from TSCreate() 12650298fd71SBarry Smith . r - vector to hold the residual (or NULL to have it created internally) 1266316643e7SJed Brown . f - the function evaluation routine 12670298fd71SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1268316643e7SJed Brown 1269316643e7SJed Brown Calling sequence of f: 12706bc98fa9SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx); 1271316643e7SJed Brown 1272316643e7SJed Brown + t - time at step/stage being solved 1273316643e7SJed Brown . u - state vector 1274316643e7SJed Brown . u_t - time derivative of state vector 1275316643e7SJed Brown . F - function vector 1276316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1277316643e7SJed Brown 1278316643e7SJed Brown Important: 12792bbac0d3SBarry Smith The user MUST call either this routine or TSSetRHSFunction() to define the ODE. When solving DAEs you must use this function. 1280316643e7SJed Brown 1281316643e7SJed Brown Level: beginner 1282316643e7SJed Brown 1283d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian() 1284316643e7SJed Brown @*/ 128551699248SLisandro Dalcin PetscErrorCode TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx) 1286316643e7SJed Brown { 1287089b2837SJed Brown PetscErrorCode ierr; 1288089b2837SJed Brown SNES snes; 128951699248SLisandro Dalcin Vec ralloc = NULL; 129024989b8cSPeter Brune DM dm; 1291316643e7SJed Brown 1292316643e7SJed Brown PetscFunctionBegin; 12930700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 129451699248SLisandro Dalcin if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2); 129524989b8cSPeter Brune 129624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 129724989b8cSPeter Brune ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr); 129824989b8cSPeter Brune 1299089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 130051699248SLisandro Dalcin if (!r && !ts->dm && ts->vec_sol) { 130151699248SLisandro Dalcin ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr); 130251699248SLisandro Dalcin r = ralloc; 1303e856ceecSJed Brown } 130451699248SLisandro Dalcin ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr); 130551699248SLisandro Dalcin ierr = VecDestroy(&ralloc);CHKERRQ(ierr); 1306089b2837SJed Brown PetscFunctionReturn(0); 1307089b2837SJed Brown } 1308089b2837SJed Brown 1309089b2837SJed Brown /*@C 1310089b2837SJed Brown TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1311089b2837SJed Brown 1312089b2837SJed Brown Not Collective 1313089b2837SJed Brown 1314089b2837SJed Brown Input Parameter: 1315089b2837SJed Brown . ts - the TS context 1316089b2837SJed Brown 1317089b2837SJed Brown Output Parameter: 13180298fd71SBarry Smith + r - vector to hold residual (or NULL) 13190298fd71SBarry Smith . func - the function to compute residual (or NULL) 13200298fd71SBarry Smith - ctx - the function context (or NULL) 1321089b2837SJed Brown 1322089b2837SJed Brown Level: advanced 1323089b2837SJed Brown 1324089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction() 1325089b2837SJed Brown @*/ 1326089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx) 1327089b2837SJed Brown { 1328089b2837SJed Brown PetscErrorCode ierr; 1329089b2837SJed Brown SNES snes; 133024989b8cSPeter Brune DM dm; 1331089b2837SJed Brown 1332089b2837SJed Brown PetscFunctionBegin; 1333089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1334089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13350298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 133624989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 133724989b8cSPeter Brune ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr); 1338089b2837SJed Brown PetscFunctionReturn(0); 1339089b2837SJed Brown } 1340089b2837SJed Brown 1341089b2837SJed Brown /*@C 1342089b2837SJed Brown TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1343089b2837SJed Brown 1344089b2837SJed Brown Not Collective 1345089b2837SJed Brown 1346089b2837SJed Brown Input Parameter: 1347089b2837SJed Brown . ts - the TS context 1348089b2837SJed Brown 1349089b2837SJed Brown Output Parameter: 13500298fd71SBarry Smith + r - vector to hold computed right hand side (or NULL) 13510298fd71SBarry Smith . func - the function to compute right hand side (or NULL) 13520298fd71SBarry Smith - ctx - the function context (or NULL) 1353089b2837SJed Brown 1354089b2837SJed Brown Level: advanced 1355089b2837SJed Brown 13562bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction() 1357089b2837SJed Brown @*/ 1358089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx) 1359089b2837SJed Brown { 1360089b2837SJed Brown PetscErrorCode ierr; 1361089b2837SJed Brown SNES snes; 136224989b8cSPeter Brune DM dm; 1363089b2837SJed Brown 1364089b2837SJed Brown PetscFunctionBegin; 1365089b2837SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1366089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 13670298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 136824989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 136924989b8cSPeter Brune ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr); 1370316643e7SJed Brown PetscFunctionReturn(0); 1371316643e7SJed Brown } 1372316643e7SJed Brown 1373316643e7SJed Brown /*@C 1374a4f0a591SBarry Smith TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1375ae8867d6SBarry Smith provided with TSSetIFunction(). 1376316643e7SJed Brown 13773f9fe445SBarry Smith Logically Collective on TS 1378316643e7SJed Brown 1379316643e7SJed Brown Input Parameters: 1380316643e7SJed Brown + ts - the TS context obtained from TSCreate() 1381e5d3d808SBarry Smith . Amat - (approximate) Jacobian matrix 1382e5d3d808SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as Amat) 1383316643e7SJed Brown . f - the Jacobian evaluation routine 13840298fd71SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1385316643e7SJed Brown 1386316643e7SJed Brown Calling sequence of f: 13876bc98fa9SBarry Smith $ PetscErrorCode f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx); 1388316643e7SJed Brown 1389316643e7SJed Brown + t - time at step/stage being solved 13901b4a444bSJed Brown . U - state vector 13911b4a444bSJed Brown . U_t - time derivative of state vector 1392316643e7SJed Brown . a - shift 1393e5d3d808SBarry Smith . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 1394e5d3d808SBarry Smith . Pmat - matrix used for constructing preconditioner, usually the same as Amat 1395316643e7SJed Brown - ctx - [optional] user-defined context for matrix evaluation routine 1396316643e7SJed Brown 1397316643e7SJed Brown Notes: 1398e5d3d808SBarry Smith The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve. 1399316643e7SJed Brown 1400895c21f2SBarry Smith If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null 1401895c21f2SBarry Smith space to Amat and the KSP solvers will automatically use that null space as needed during the solution process. 1402895c21f2SBarry Smith 1403a4f0a591SBarry Smith The matrix dF/dU + a*dF/dU_t you provide turns out to be 1404b5abc632SBarry Smith the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1405a4f0a591SBarry Smith The time integrator internally approximates U_t by W+a*U where the positive "shift" 1406a4f0a591SBarry Smith a and vector W depend on the integration method, step size, and past states. For example with 1407a4f0a591SBarry Smith the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1408a4f0a591SBarry Smith W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1409a4f0a591SBarry Smith 14106cd88445SBarry Smith You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 14116cd88445SBarry Smith 14126cd88445SBarry Smith The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f() 1413ca5f011dSBarry Smith You should not assume the values are the same in the next call to f() as you set them in the previous call. 1414ca5f011dSBarry Smith 1415316643e7SJed Brown Level: beginner 1416316643e7SJed Brown 1417ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction() 1418316643e7SJed Brown 1419316643e7SJed Brown @*/ 1420e5d3d808SBarry Smith PetscErrorCode TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx) 1421316643e7SJed Brown { 1422316643e7SJed Brown PetscErrorCode ierr; 1423089b2837SJed Brown SNES snes; 142424989b8cSPeter Brune DM dm; 1425316643e7SJed Brown 1426316643e7SJed Brown PetscFunctionBegin; 14270700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1428e5d3d808SBarry Smith if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2); 1429e5d3d808SBarry Smith if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3); 1430e5d3d808SBarry Smith if (Amat) PetscCheckSameComm(ts,1,Amat,2); 1431e5d3d808SBarry Smith if (Pmat) PetscCheckSameComm(ts,1,Pmat,3); 143224989b8cSPeter Brune 143324989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 143424989b8cSPeter Brune ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr); 143524989b8cSPeter Brune 1436089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1437e5d3d808SBarry Smith ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr); 1438316643e7SJed Brown PetscFunctionReturn(0); 1439316643e7SJed Brown } 1440316643e7SJed Brown 1441e1244c69SJed Brown /*@ 1442e1244c69SJed Brown TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating. Without this flag, TS will change the sign and 1443e1244c69SJed Brown shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute 1444e1244c69SJed Brown the entire Jacobian. The reuse flag must be set if the evaluation function will assume that the matrix entries have 1445e1244c69SJed Brown not been changed by the TS. 1446e1244c69SJed Brown 1447e1244c69SJed Brown Logically Collective 1448e1244c69SJed Brown 1449e1244c69SJed Brown Input Arguments: 1450e1244c69SJed Brown + ts - TS context obtained from TSCreate() 1451e1244c69SJed Brown - reuse - PETSC_TRUE if the RHS Jacobian 1452e1244c69SJed Brown 1453e1244c69SJed Brown Level: intermediate 1454e1244c69SJed Brown 1455e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 1456e1244c69SJed Brown @*/ 1457e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse) 1458e1244c69SJed Brown { 1459e1244c69SJed Brown PetscFunctionBegin; 1460e1244c69SJed Brown ts->rhsjacobian.reuse = reuse; 1461e1244c69SJed Brown PetscFunctionReturn(0); 1462e1244c69SJed Brown } 1463e1244c69SJed Brown 1464efe9872eSLisandro Dalcin /*@C 1465efe9872eSLisandro Dalcin TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1466efe9872eSLisandro Dalcin 1467efe9872eSLisandro Dalcin Logically Collective on TS 1468efe9872eSLisandro Dalcin 1469efe9872eSLisandro Dalcin Input Parameters: 1470efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1471efe9872eSLisandro Dalcin . F - vector to hold the residual (or NULL to have it created internally) 1472efe9872eSLisandro Dalcin . fun - the function evaluation routine 1473efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the function evaluation routine (may be NULL) 1474efe9872eSLisandro Dalcin 1475efe9872eSLisandro Dalcin Calling sequence of fun: 14766bc98fa9SBarry Smith $ PetscErrorCode fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx); 1477efe9872eSLisandro Dalcin 1478efe9872eSLisandro Dalcin + t - time at step/stage being solved 1479efe9872eSLisandro Dalcin . U - state vector 1480efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1481efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1482efe9872eSLisandro Dalcin . F - function vector 1483efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine (may be NULL) 1484efe9872eSLisandro Dalcin 1485efe9872eSLisandro Dalcin Level: beginner 1486efe9872eSLisandro Dalcin 1487a96d6ef6SBarry Smith .seealso: TSSetI2Jacobian(), TSSetIFunction(), TSCreate(), TSSetRHSFunction() 1488efe9872eSLisandro Dalcin @*/ 1489efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx) 1490efe9872eSLisandro Dalcin { 1491efe9872eSLisandro Dalcin DM dm; 1492efe9872eSLisandro Dalcin PetscErrorCode ierr; 1493efe9872eSLisandro Dalcin 1494efe9872eSLisandro Dalcin PetscFunctionBegin; 1495efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1496efe9872eSLisandro Dalcin if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2); 1497efe9872eSLisandro Dalcin ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr); 1498efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1499efe9872eSLisandro Dalcin ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1500efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1501efe9872eSLisandro Dalcin } 1502efe9872eSLisandro Dalcin 1503efe9872eSLisandro Dalcin /*@C 1504efe9872eSLisandro Dalcin TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it. 1505efe9872eSLisandro Dalcin 1506efe9872eSLisandro Dalcin Not Collective 1507efe9872eSLisandro Dalcin 1508efe9872eSLisandro Dalcin Input Parameter: 1509efe9872eSLisandro Dalcin . ts - the TS context 1510efe9872eSLisandro Dalcin 1511efe9872eSLisandro Dalcin Output Parameter: 1512efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL) 1513efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL) 1514efe9872eSLisandro Dalcin - ctx - the function context (or NULL) 1515efe9872eSLisandro Dalcin 1516efe9872eSLisandro Dalcin Level: advanced 1517efe9872eSLisandro Dalcin 1518a96d6ef6SBarry Smith .seealso: TSSetIFunction(), SNESGetFunction(), TSCreate() 1519efe9872eSLisandro Dalcin @*/ 1520efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx) 1521efe9872eSLisandro Dalcin { 1522efe9872eSLisandro Dalcin PetscErrorCode ierr; 1523efe9872eSLisandro Dalcin SNES snes; 1524efe9872eSLisandro Dalcin DM dm; 1525efe9872eSLisandro Dalcin 1526efe9872eSLisandro Dalcin PetscFunctionBegin; 1527efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1528efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1529efe9872eSLisandro Dalcin ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 1530efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1531efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr); 1532efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1533efe9872eSLisandro Dalcin } 1534efe9872eSLisandro Dalcin 1535efe9872eSLisandro Dalcin /*@C 1536bc77d74cSLisandro Dalcin TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1537efe9872eSLisandro Dalcin where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function(). 1538efe9872eSLisandro Dalcin 1539efe9872eSLisandro Dalcin Logically Collective on TS 1540efe9872eSLisandro Dalcin 1541efe9872eSLisandro Dalcin Input Parameters: 1542efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1543efe9872eSLisandro Dalcin . J - Jacobian matrix 1544efe9872eSLisandro Dalcin . P - preconditioning matrix for J (may be same as J) 1545efe9872eSLisandro Dalcin . jac - the Jacobian evaluation routine 1546efe9872eSLisandro Dalcin - ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL) 1547efe9872eSLisandro Dalcin 1548efe9872eSLisandro Dalcin Calling sequence of jac: 15496bc98fa9SBarry Smith $ PetscErrorCode jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx); 1550efe9872eSLisandro Dalcin 1551efe9872eSLisandro Dalcin + t - time at step/stage being solved 1552efe9872eSLisandro Dalcin . U - state vector 1553efe9872eSLisandro Dalcin . U_t - time derivative of state vector 1554efe9872eSLisandro Dalcin . U_tt - second time derivative of state vector 1555efe9872eSLisandro Dalcin . v - shift for U_t 1556efe9872eSLisandro Dalcin . a - shift for U_tt 1557efe9872eSLisandro 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 1558efe9872eSLisandro Dalcin . P - preconditioning matrix for J, may be same as J 1559efe9872eSLisandro Dalcin - ctx - [optional] user-defined context for matrix evaluation routine 1560efe9872eSLisandro Dalcin 1561efe9872eSLisandro Dalcin Notes: 1562efe9872eSLisandro Dalcin The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve. 1563efe9872eSLisandro Dalcin 1564efe9872eSLisandro Dalcin The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1565efe9872eSLisandro 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. 1566efe9872eSLisandro Dalcin The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1567bc77d74cSLisandro Dalcin parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1568efe9872eSLisandro Dalcin 1569efe9872eSLisandro Dalcin Level: beginner 1570efe9872eSLisandro Dalcin 1571a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Jacobian() 1572efe9872eSLisandro Dalcin @*/ 1573efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx) 1574efe9872eSLisandro Dalcin { 1575efe9872eSLisandro Dalcin DM dm; 1576efe9872eSLisandro Dalcin PetscErrorCode ierr; 1577efe9872eSLisandro Dalcin 1578efe9872eSLisandro Dalcin PetscFunctionBegin; 1579efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1580efe9872eSLisandro Dalcin if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2); 1581efe9872eSLisandro Dalcin if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3); 1582efe9872eSLisandro Dalcin ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr); 1583efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1584efe9872eSLisandro Dalcin ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1585efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1586efe9872eSLisandro Dalcin } 1587efe9872eSLisandro Dalcin 1588efe9872eSLisandro Dalcin /*@C 1589efe9872eSLisandro Dalcin TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1590efe9872eSLisandro Dalcin 1591efe9872eSLisandro Dalcin Not Collective, but parallel objects are returned if TS is parallel 1592efe9872eSLisandro Dalcin 1593efe9872eSLisandro Dalcin Input Parameter: 1594efe9872eSLisandro Dalcin . ts - The TS context obtained from TSCreate() 1595efe9872eSLisandro Dalcin 1596efe9872eSLisandro Dalcin Output Parameters: 1597efe9872eSLisandro Dalcin + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1598efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J 1599efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices 1600efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine 1601efe9872eSLisandro Dalcin 160295452b02SPatrick Sanan Notes: 160395452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 1604efe9872eSLisandro Dalcin 1605efe9872eSLisandro Dalcin Level: advanced 1606efe9872eSLisandro Dalcin 1607a96d6ef6SBarry Smith .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber(), TSSetI2Jacobian(), TSGetI2Function(), TSCreate() 1608efe9872eSLisandro Dalcin 1609efe9872eSLisandro Dalcin @*/ 1610efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx) 1611efe9872eSLisandro Dalcin { 1612efe9872eSLisandro Dalcin PetscErrorCode ierr; 1613efe9872eSLisandro Dalcin SNES snes; 1614efe9872eSLisandro Dalcin DM dm; 1615efe9872eSLisandro Dalcin 1616efe9872eSLisandro Dalcin PetscFunctionBegin; 1617efe9872eSLisandro Dalcin ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 1618efe9872eSLisandro Dalcin ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 1619efe9872eSLisandro Dalcin ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr); 1620efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1621efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr); 1622efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1623efe9872eSLisandro Dalcin } 1624efe9872eSLisandro Dalcin 1625efe9872eSLisandro Dalcin /*@ 1626efe9872eSLisandro Dalcin TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1627efe9872eSLisandro Dalcin 1628d083f849SBarry Smith Collective on TS 1629efe9872eSLisandro Dalcin 1630efe9872eSLisandro Dalcin Input Parameters: 1631efe9872eSLisandro Dalcin + ts - the TS context 1632efe9872eSLisandro Dalcin . t - current time 1633efe9872eSLisandro Dalcin . U - state vector 1634efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t) 1635efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt) 1636efe9872eSLisandro Dalcin 1637efe9872eSLisandro Dalcin Output Parameter: 1638efe9872eSLisandro Dalcin . F - the residual vector 1639efe9872eSLisandro Dalcin 1640efe9872eSLisandro Dalcin Note: 1641efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1642efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1643efe9872eSLisandro Dalcin 1644efe9872eSLisandro Dalcin Level: developer 1645efe9872eSLisandro Dalcin 1646a96d6ef6SBarry Smith .seealso: TSSetI2Function(), TSGetI2Function() 1647efe9872eSLisandro Dalcin @*/ 1648efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F) 1649efe9872eSLisandro Dalcin { 1650efe9872eSLisandro Dalcin DM dm; 1651efe9872eSLisandro Dalcin TSI2Function I2Function; 1652efe9872eSLisandro Dalcin void *ctx; 1653efe9872eSLisandro Dalcin TSRHSFunction rhsfunction; 1654efe9872eSLisandro Dalcin PetscErrorCode ierr; 1655efe9872eSLisandro Dalcin 1656efe9872eSLisandro Dalcin PetscFunctionBegin; 1657efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1658efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1659efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1660efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1661efe9872eSLisandro Dalcin PetscValidHeaderSpecific(F,VEC_CLASSID,6); 1662efe9872eSLisandro Dalcin 1663efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1664efe9872eSLisandro Dalcin ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr); 1665efe9872eSLisandro Dalcin ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr); 1666efe9872eSLisandro Dalcin 1667efe9872eSLisandro Dalcin if (!I2Function) { 1668efe9872eSLisandro Dalcin ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr); 1669efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1670efe9872eSLisandro Dalcin } 1671efe9872eSLisandro Dalcin 1672efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1673efe9872eSLisandro Dalcin 1674efe9872eSLisandro Dalcin PetscStackPush("TS user implicit function"); 1675efe9872eSLisandro Dalcin ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr); 1676efe9872eSLisandro Dalcin PetscStackPop; 1677efe9872eSLisandro Dalcin 1678efe9872eSLisandro Dalcin if (rhsfunction) { 1679efe9872eSLisandro Dalcin Vec Frhs; 1680efe9872eSLisandro Dalcin ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr); 1681efe9872eSLisandro Dalcin ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr); 1682efe9872eSLisandro Dalcin ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr); 1683efe9872eSLisandro Dalcin } 1684efe9872eSLisandro Dalcin 1685efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr); 1686efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1687efe9872eSLisandro Dalcin } 1688efe9872eSLisandro Dalcin 1689efe9872eSLisandro Dalcin /*@ 1690efe9872eSLisandro Dalcin TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1691efe9872eSLisandro Dalcin 1692d083f849SBarry Smith Collective on TS 1693efe9872eSLisandro Dalcin 1694efe9872eSLisandro Dalcin Input Parameters: 1695efe9872eSLisandro Dalcin + ts - the TS context 1696efe9872eSLisandro Dalcin . t - current timestep 1697efe9872eSLisandro Dalcin . U - state vector 1698efe9872eSLisandro Dalcin . V - time derivative of state vector 1699efe9872eSLisandro Dalcin . A - second time derivative of state vector 1700efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below 1701efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below 1702efe9872eSLisandro Dalcin 1703efe9872eSLisandro Dalcin Output Parameters: 1704efe9872eSLisandro Dalcin + J - Jacobian matrix 1705efe9872eSLisandro Dalcin - P - optional preconditioning matrix 1706efe9872eSLisandro Dalcin 1707efe9872eSLisandro Dalcin Notes: 1708efe9872eSLisandro Dalcin If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1709efe9872eSLisandro Dalcin 1710efe9872eSLisandro Dalcin dF/dU + shiftV*dF/dV + shiftA*dF/dA 1711efe9872eSLisandro Dalcin 1712efe9872eSLisandro Dalcin Most users should not need to explicitly call this routine, as it 1713efe9872eSLisandro Dalcin is used internally within the nonlinear solvers. 1714efe9872eSLisandro Dalcin 1715efe9872eSLisandro Dalcin Level: developer 1716efe9872eSLisandro Dalcin 1717efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian() 1718efe9872eSLisandro Dalcin @*/ 1719efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P) 1720efe9872eSLisandro Dalcin { 1721efe9872eSLisandro Dalcin DM dm; 1722efe9872eSLisandro Dalcin TSI2Jacobian I2Jacobian; 1723efe9872eSLisandro Dalcin void *ctx; 1724efe9872eSLisandro Dalcin TSRHSJacobian rhsjacobian; 1725efe9872eSLisandro Dalcin PetscErrorCode ierr; 1726efe9872eSLisandro Dalcin 1727efe9872eSLisandro Dalcin PetscFunctionBegin; 1728efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1729efe9872eSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 1730efe9872eSLisandro Dalcin PetscValidHeaderSpecific(V,VEC_CLASSID,4); 1731efe9872eSLisandro Dalcin PetscValidHeaderSpecific(A,VEC_CLASSID,5); 1732efe9872eSLisandro Dalcin PetscValidHeaderSpecific(J,MAT_CLASSID,8); 1733efe9872eSLisandro Dalcin PetscValidHeaderSpecific(P,MAT_CLASSID,9); 1734efe9872eSLisandro Dalcin 1735efe9872eSLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1736efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr); 1737efe9872eSLisandro Dalcin ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr); 1738efe9872eSLisandro Dalcin 1739efe9872eSLisandro Dalcin if (!I2Jacobian) { 1740efe9872eSLisandro Dalcin ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr); 1741efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1742efe9872eSLisandro Dalcin } 1743efe9872eSLisandro Dalcin 1744efe9872eSLisandro Dalcin ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1745efe9872eSLisandro Dalcin 1746efe9872eSLisandro Dalcin PetscStackPush("TS user implicit Jacobian"); 1747efe9872eSLisandro Dalcin ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr); 1748efe9872eSLisandro Dalcin PetscStackPop; 1749efe9872eSLisandro Dalcin 1750efe9872eSLisandro Dalcin if (rhsjacobian) { 1751efe9872eSLisandro Dalcin Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN; 1752efe9872eSLisandro Dalcin ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr); 1753efe9872eSLisandro Dalcin ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr); 1754efe9872eSLisandro Dalcin ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr); 1755efe9872eSLisandro Dalcin if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);} 1756efe9872eSLisandro Dalcin } 1757efe9872eSLisandro Dalcin 1758efe9872eSLisandro Dalcin ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr); 1759efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1760efe9872eSLisandro Dalcin } 1761efe9872eSLisandro Dalcin 1762438f35afSJed Brown /*@C 1763438f35afSJed Brown TSSetTransientVariable - sets function to transform from state to transient variables 1764438f35afSJed Brown 1765438f35afSJed Brown Logically Collective 1766438f35afSJed Brown 1767438f35afSJed Brown Input Arguments: 1768438f35afSJed Brown + ts - time stepping context on which to change the transient variable 1769a96d6ef6SBarry Smith . tvar - a function that transforms to transient variables 1770438f35afSJed Brown - ctx - a context for tvar 1771438f35afSJed Brown 1772a96d6ef6SBarry Smith Calling sequence of tvar: 1773a96d6ef6SBarry Smith $ PetscErrorCode tvar(TS ts,Vec p,Vec c,void *ctx); 1774a96d6ef6SBarry Smith 1775a96d6ef6SBarry Smith + ts - timestep context 1776a96d6ef6SBarry Smith . p - input vector (primative form) 1777a96d6ef6SBarry Smith . c - output vector, transient variables (conservative form) 1778a96d6ef6SBarry Smith - ctx - [optional] user-defined function context 1779a96d6ef6SBarry Smith 1780438f35afSJed Brown Level: advanced 1781438f35afSJed Brown 1782438f35afSJed Brown Notes: 1783438f35afSJed Brown This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., TSBDF) 1784438f35afSJed Brown can be conservative. In this context, primitive variables P are used to model the state (e.g., because they lead to 1785438f35afSJed Brown well-conditioned formulations even in limiting cases such as low-Mach or zero porosity). The transient variable is 1786438f35afSJed Brown C(P), specified by calling this function. An IFunction thus receives arguments (P, Cdot) and the IJacobian must be 1787438f35afSJed Brown evaluated via the chain rule, as in 1788438f35afSJed Brown 1789438f35afSJed Brown dF/dP + shift * dF/dCdot dC/dP. 1790438f35afSJed Brown 1791438f35afSJed Brown .seealso: DMTSSetTransientVariable(), DMTSGetTransientVariable(), TSSetIFunction(), TSSetIJacobian() 1792438f35afSJed Brown @*/ 1793438f35afSJed Brown PetscErrorCode TSSetTransientVariable(TS ts,TSTransientVariable tvar,void *ctx) 1794438f35afSJed Brown { 1795438f35afSJed Brown PetscErrorCode ierr; 1796438f35afSJed Brown DM dm; 1797438f35afSJed Brown 1798438f35afSJed Brown PetscFunctionBegin; 1799438f35afSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1800438f35afSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1801438f35afSJed Brown ierr = DMTSSetTransientVariable(dm,tvar,ctx);CHKERRQ(ierr); 1802438f35afSJed Brown PetscFunctionReturn(0); 1803438f35afSJed Brown } 1804438f35afSJed Brown 1805efe9872eSLisandro Dalcin /*@ 1806e3c11fc1SJed Brown TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables 1807e3c11fc1SJed Brown 1808e3c11fc1SJed Brown Logically Collective 1809e3c11fc1SJed Brown 1810e3c11fc1SJed Brown Input Parameters: 1811e3c11fc1SJed Brown + ts - TS on which to compute 1812e3c11fc1SJed Brown - U - state vector to be transformed to transient variables 1813e3c11fc1SJed Brown 1814e3c11fc1SJed Brown Output Parameters: 1815e3c11fc1SJed Brown . C - transient (conservative) variable 1816e3c11fc1SJed Brown 1817e3c11fc1SJed Brown Developer Notes: 1818e3c11fc1SJed Brown If DMTSSetTransientVariable() has not been called, then C is not modified in this routine and C=NULL is allowed. 1819e3c11fc1SJed Brown This makes it safe to call without a guard. One can use TSHasTransientVariable() to check if transient variables are 1820e3c11fc1SJed Brown being used. 1821e3c11fc1SJed Brown 1822e3c11fc1SJed Brown Level: developer 1823e3c11fc1SJed Brown 1824e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeIFunction(), TSComputeIJacobian() 1825e3c11fc1SJed Brown @*/ 1826e3c11fc1SJed Brown PetscErrorCode TSComputeTransientVariable(TS ts,Vec U,Vec C) 1827e3c11fc1SJed Brown { 1828e3c11fc1SJed Brown PetscErrorCode ierr; 1829e3c11fc1SJed Brown DM dm; 1830e3c11fc1SJed Brown DMTS dmts; 1831e3c11fc1SJed Brown 1832e3c11fc1SJed Brown PetscFunctionBegin; 1833e3c11fc1SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1834e3c11fc1SJed Brown PetscValidHeaderSpecific(U,VEC_CLASSID,2); 1835e3c11fc1SJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1836e3c11fc1SJed Brown ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr); 1837e3c11fc1SJed Brown if (dmts->ops->transientvar) { 1838e3c11fc1SJed Brown PetscValidHeaderSpecific(C,VEC_CLASSID,3); 1839e3c11fc1SJed Brown ierr = (*dmts->ops->transientvar)(ts,U,C,dmts->transientvarctx);CHKERRQ(ierr); 1840e3c11fc1SJed Brown } 1841e3c11fc1SJed Brown PetscFunctionReturn(0); 1842e3c11fc1SJed Brown } 1843e3c11fc1SJed Brown 1844e3c11fc1SJed Brown /*@ 1845e3c11fc1SJed Brown TSHasTransientVariable - determine whether transient variables have been set 1846e3c11fc1SJed Brown 1847e3c11fc1SJed Brown Logically Collective 1848e3c11fc1SJed Brown 1849e3c11fc1SJed Brown Input Parameters: 1850e3c11fc1SJed Brown . ts - TS on which to compute 1851e3c11fc1SJed Brown 1852e3c11fc1SJed Brown Output Parameters: 1853e3c11fc1SJed Brown . has - PETSC_TRUE if transient variables have been set 1854e3c11fc1SJed Brown 1855e3c11fc1SJed Brown Level: developer 1856e3c11fc1SJed Brown 1857e3c11fc1SJed Brown .seealso: DMTSSetTransientVariable(), TSComputeTransientVariable() 1858e3c11fc1SJed Brown @*/ 1859e3c11fc1SJed Brown PetscErrorCode TSHasTransientVariable(TS ts,PetscBool *has) 1860e3c11fc1SJed Brown { 1861e3c11fc1SJed Brown PetscErrorCode ierr; 1862e3c11fc1SJed Brown DM dm; 1863e3c11fc1SJed Brown DMTS dmts; 1864e3c11fc1SJed Brown 1865e3c11fc1SJed Brown PetscFunctionBegin; 1866e3c11fc1SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1867e3c11fc1SJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 1868e3c11fc1SJed Brown ierr = DMGetDMTS(dm,&dmts);CHKERRQ(ierr); 1869e3c11fc1SJed Brown *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE; 1870e3c11fc1SJed Brown PetscFunctionReturn(0); 1871e3c11fc1SJed Brown } 1872e3c11fc1SJed Brown 1873e3c11fc1SJed Brown /*@ 1874efe9872eSLisandro Dalcin TS2SetSolution - Sets the initial solution and time derivative vectors 1875efe9872eSLisandro Dalcin for use by the TS routines handling second order equations. 1876efe9872eSLisandro Dalcin 1877d083f849SBarry Smith Logically Collective on TS 1878efe9872eSLisandro Dalcin 1879efe9872eSLisandro Dalcin Input Parameters: 1880efe9872eSLisandro Dalcin + ts - the TS context obtained from TSCreate() 1881efe9872eSLisandro Dalcin . u - the solution vector 1882efe9872eSLisandro Dalcin - v - the time derivative vector 1883efe9872eSLisandro Dalcin 1884efe9872eSLisandro Dalcin Level: beginner 1885efe9872eSLisandro Dalcin 1886efe9872eSLisandro Dalcin @*/ 1887efe9872eSLisandro Dalcin PetscErrorCode TS2SetSolution(TS ts,Vec u,Vec v) 1888efe9872eSLisandro Dalcin { 1889efe9872eSLisandro Dalcin PetscErrorCode ierr; 1890efe9872eSLisandro Dalcin 1891efe9872eSLisandro Dalcin PetscFunctionBegin; 1892efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1893efe9872eSLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,2); 1894efe9872eSLisandro Dalcin PetscValidHeaderSpecific(v,VEC_CLASSID,3); 1895efe9872eSLisandro Dalcin ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 1896efe9872eSLisandro Dalcin ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr); 1897efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 1898efe9872eSLisandro Dalcin ts->vec_dot = v; 1899efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1900efe9872eSLisandro Dalcin } 1901efe9872eSLisandro Dalcin 1902efe9872eSLisandro Dalcin /*@ 1903efe9872eSLisandro Dalcin TS2GetSolution - Returns the solution and time derivative at the present timestep 1904efe9872eSLisandro Dalcin for second order equations. It is valid to call this routine inside the function 1905efe9872eSLisandro Dalcin that you are evaluating in order to move to the new timestep. This vector not 1906efe9872eSLisandro Dalcin changed until the solution at the next timestep has been calculated. 1907efe9872eSLisandro Dalcin 1908efe9872eSLisandro Dalcin Not Collective, but Vec returned is parallel if TS is parallel 1909efe9872eSLisandro Dalcin 1910efe9872eSLisandro Dalcin Input Parameter: 1911efe9872eSLisandro Dalcin . ts - the TS context obtained from TSCreate() 1912efe9872eSLisandro Dalcin 1913efe9872eSLisandro Dalcin Output Parameter: 1914efe9872eSLisandro Dalcin + u - the vector containing the solution 1915efe9872eSLisandro Dalcin - v - the vector containing the time derivative 1916efe9872eSLisandro Dalcin 1917efe9872eSLisandro Dalcin Level: intermediate 1918efe9872eSLisandro Dalcin 1919efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime() 1920efe9872eSLisandro Dalcin 1921efe9872eSLisandro Dalcin @*/ 1922efe9872eSLisandro Dalcin PetscErrorCode TS2GetSolution(TS ts,Vec *u,Vec *v) 1923efe9872eSLisandro Dalcin { 1924efe9872eSLisandro Dalcin PetscFunctionBegin; 1925efe9872eSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 1926efe9872eSLisandro Dalcin if (u) PetscValidPointer(u,2); 1927efe9872eSLisandro Dalcin if (v) PetscValidPointer(v,3); 1928efe9872eSLisandro Dalcin if (u) *u = ts->vec_sol; 1929efe9872eSLisandro Dalcin if (v) *v = ts->vec_dot; 1930efe9872eSLisandro Dalcin PetscFunctionReturn(0); 1931efe9872eSLisandro Dalcin } 1932efe9872eSLisandro Dalcin 193355849f57SBarry Smith /*@C 193455849f57SBarry Smith TSLoad - Loads a KSP that has been stored in binary with KSPView(). 193555849f57SBarry Smith 193655849f57SBarry Smith Collective on PetscViewer 193755849f57SBarry Smith 193855849f57SBarry Smith Input Parameters: 193955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or 194055849f57SBarry Smith some related function before a call to TSLoad(). 194155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 194255849f57SBarry Smith 194355849f57SBarry Smith Level: intermediate 194455849f57SBarry Smith 194555849f57SBarry Smith Notes: 194655849f57SBarry Smith The type is determined by the data in the file, any type set into the TS before this call is ignored. 194755849f57SBarry Smith 194855849f57SBarry Smith Notes for advanced users: 194955849f57SBarry Smith Most users should not need to know the details of the binary storage 195055849f57SBarry Smith format, since TSLoad() and TSView() completely hide these details. 195155849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 195255849f57SBarry Smith format is 195355849f57SBarry Smith .vb 195455849f57SBarry Smith has not yet been determined 195555849f57SBarry Smith .ve 195655849f57SBarry Smith 195755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad() 195855849f57SBarry Smith @*/ 1959f2c2a1b9SBarry Smith PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 196055849f57SBarry Smith { 196155849f57SBarry Smith PetscErrorCode ierr; 196255849f57SBarry Smith PetscBool isbinary; 196355849f57SBarry Smith PetscInt classid; 196455849f57SBarry Smith char type[256]; 19652d53ad75SBarry Smith DMTS sdm; 1966ad6bc421SBarry Smith DM dm; 196755849f57SBarry Smith 196855849f57SBarry Smith PetscFunctionBegin; 1969f2c2a1b9SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 197055849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 197155849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 197255849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 197355849f57SBarry Smith 1974060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr); 1975ce94432eSBarry Smith if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file"); 1976060da220SMatthew G. Knepley ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr); 1977f2c2a1b9SBarry Smith ierr = TSSetType(ts, type);CHKERRQ(ierr); 1978f2c2a1b9SBarry Smith if (ts->ops->load) { 1979f2c2a1b9SBarry Smith ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr); 1980f2c2a1b9SBarry Smith } 1981ce94432eSBarry Smith ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr); 1982ad6bc421SBarry Smith ierr = DMLoad(dm,viewer);CHKERRQ(ierr); 1983ad6bc421SBarry Smith ierr = TSSetDM(ts,dm);CHKERRQ(ierr); 1984f2c2a1b9SBarry Smith ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 1985f2c2a1b9SBarry Smith ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr); 19862d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 19872d53ad75SBarry Smith ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr); 198855849f57SBarry Smith PetscFunctionReturn(0); 198955849f57SBarry Smith } 199055849f57SBarry Smith 19919804daf3SBarry Smith #include <petscdraw.h> 1992e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 1993e04113cfSBarry Smith #include <petscviewersaws.h> 1994f05ece33SBarry Smith #endif 1995fe2efc57SMark 1996fe2efc57SMark /*@C 1997fe2efc57SMark TSViewFromOptions - View from Options 1998fe2efc57SMark 1999fe2efc57SMark Collective on TS 2000fe2efc57SMark 2001fe2efc57SMark Input Parameters: 2002fe2efc57SMark + A - the application ordering context 2003736c3998SJose E. Roman . obj - Optional object 2004736c3998SJose E. Roman - name - command line option 2005fe2efc57SMark 2006fe2efc57SMark Level: intermediate 2007fe2efc57SMark .seealso: TS, TSView, PetscObjectViewFromOptions(), TSCreate() 2008fe2efc57SMark @*/ 2009fe2efc57SMark PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) 2010fe2efc57SMark { 2011fe2efc57SMark PetscErrorCode ierr; 2012fe2efc57SMark 2013fe2efc57SMark PetscFunctionBegin; 2014fe2efc57SMark PetscValidHeaderSpecific(A,TS_CLASSID,1); 2015fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr); 2016fe2efc57SMark PetscFunctionReturn(0); 2017fe2efc57SMark } 2018fe2efc57SMark 20197e2c5f70SBarry Smith /*@C 2020d763cef2SBarry Smith TSView - Prints the TS data structure. 2021d763cef2SBarry Smith 20224c49b128SBarry Smith Collective on TS 2023d763cef2SBarry Smith 2024d763cef2SBarry Smith Input Parameters: 2025d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2026d763cef2SBarry Smith - viewer - visualization context 2027d763cef2SBarry Smith 2028d763cef2SBarry Smith Options Database Key: 2029d763cef2SBarry Smith . -ts_view - calls TSView() at end of TSStep() 2030d763cef2SBarry Smith 2031d763cef2SBarry Smith Notes: 2032d763cef2SBarry Smith The available visualization contexts include 2033b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 2034b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 2035d763cef2SBarry Smith output where only the first processor opens 2036d763cef2SBarry Smith the file. All other processors send their 2037d763cef2SBarry Smith data to the first processor to print. 2038d763cef2SBarry Smith 2039d763cef2SBarry Smith The user can open an alternative visualization context with 2040b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 2041d763cef2SBarry Smith 2042d763cef2SBarry Smith Level: beginner 2043d763cef2SBarry Smith 2044b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 2045d763cef2SBarry Smith @*/ 20467087cfbeSBarry Smith PetscErrorCode TSView(TS ts,PetscViewer viewer) 2047d763cef2SBarry Smith { 2048dfbe8321SBarry Smith PetscErrorCode ierr; 204919fd82e9SBarry Smith TSType type; 20502b0a91c0SBarry Smith PetscBool iascii,isstring,isundials,isbinary,isdraw; 20512d53ad75SBarry Smith DMTS sdm; 2052e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2053536b137fSBarry Smith PetscBool issaws; 2054f05ece33SBarry Smith #endif 2055d763cef2SBarry Smith 2056d763cef2SBarry Smith PetscFunctionBegin; 20570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 20583050cee2SBarry Smith if (!viewer) { 2059ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr); 20603050cee2SBarry Smith } 20610700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 2062c9780b6fSBarry Smith PetscCheckSameComm(ts,1,viewer,2); 2063fd16b177SBarry Smith 2064251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 2065251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 206655849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 20672b0a91c0SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 2068e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2069536b137fSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr); 2070f05ece33SBarry Smith #endif 207132077d6dSBarry Smith if (iascii) { 2072dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr); 2073efd4aadfSBarry Smith if (ts->ops->view) { 2074efd4aadfSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2075efd4aadfSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 2076efd4aadfSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2077efd4aadfSBarry Smith } 2078ef85077eSLisandro Dalcin if (ts->max_steps < PETSC_MAX_INT) { 207977431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr); 2080ef85077eSLisandro Dalcin } 2081ef85077eSLisandro Dalcin if (ts->max_time < PETSC_MAX_REAL) { 20827c8652ddSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr); 2083ef85077eSLisandro Dalcin } 2084efd4aadfSBarry Smith if (ts->usessnes) { 2085efd4aadfSBarry Smith PetscBool lin; 2086d763cef2SBarry Smith if (ts->problem_type == TS_NONLINEAR) { 20875ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr); 2088d763cef2SBarry Smith } 20895ef26d82SJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr); 20901ef27442SStefano Zampini ierr = PetscObjectTypeCompareAny((PetscObject)ts->snes,&lin,SNESKSPONLY,SNESKSPTRANSPOSEONLY,"");CHKERRQ(ierr); 2091efd4aadfSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr); 2092efd4aadfSBarry Smith } 2093193ac0bcSJed Brown ierr = PetscViewerASCIIPrintf(viewer," total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr); 2094a0af407cSBarry Smith if (ts->vrtol) { 2095a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of relative error tolerances, ");CHKERRQ(ierr); 2096a0af407cSBarry Smith } else { 2097a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr); 2098a0af407cSBarry Smith } 2099a0af407cSBarry Smith if (ts->vatol) { 2100a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using vector of absolute error tolerances\n");CHKERRQ(ierr); 2101a0af407cSBarry Smith } else { 2102a0af407cSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr); 2103a0af407cSBarry Smith } 2104825ab935SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2105efd4aadfSBarry Smith ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr); 2106825ab935SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 21070f5bd95cSBarry Smith } else if (isstring) { 2108a313700dSBarry Smith ierr = TSGetType(ts,&type);CHKERRQ(ierr); 210936a9e3b9SBarry Smith ierr = PetscViewerStringSPrintf(viewer," TSType: %-7.7s",type);CHKERRQ(ierr); 211036a9e3b9SBarry Smith if (ts->ops->view) {ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);} 211155849f57SBarry Smith } else if (isbinary) { 211255849f57SBarry Smith PetscInt classid = TS_FILE_CLASSID; 211355849f57SBarry Smith MPI_Comm comm; 211455849f57SBarry Smith PetscMPIInt rank; 211555849f57SBarry Smith char type[256]; 211655849f57SBarry Smith 211755849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr); 211855849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 211955849f57SBarry Smith if (!rank) { 2120f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 212155849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr); 2122f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 212355849f57SBarry Smith } 212455849f57SBarry Smith if (ts->ops->view) { 212555849f57SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 212655849f57SBarry Smith } 2127efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2128f2c2a1b9SBarry Smith ierr = DMView(ts->dm,viewer);CHKERRQ(ierr); 2129f2c2a1b9SBarry Smith ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr); 21302d53ad75SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 21312d53ad75SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 21322b0a91c0SBarry Smith } else if (isdraw) { 21332b0a91c0SBarry Smith PetscDraw draw; 21342b0a91c0SBarry Smith char str[36]; 213589fd9fafSBarry Smith PetscReal x,y,bottom,h; 21362b0a91c0SBarry Smith 21372b0a91c0SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 21382b0a91c0SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 21392b0a91c0SBarry Smith ierr = PetscStrcpy(str,"TS: ");CHKERRQ(ierr); 21402b0a91c0SBarry Smith ierr = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr); 214151fa3d41SBarry Smith ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 214289fd9fafSBarry Smith bottom = y - h; 21432b0a91c0SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 21442b0a91c0SBarry Smith if (ts->ops->view) { 21452b0a91c0SBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 21462b0a91c0SBarry Smith } 2147efd4aadfSBarry Smith if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);} 2148efd4aadfSBarry Smith if (ts->snes) {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);} 21492b0a91c0SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 2150e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS) 2151536b137fSBarry Smith } else if (issaws) { 2152d45a07a7SBarry Smith PetscMPIInt rank; 21532657e9d9SBarry Smith const char *name; 21542657e9d9SBarry Smith 21552657e9d9SBarry Smith ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr); 2156d45a07a7SBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 2157d45a07a7SBarry Smith if (!((PetscObject)ts)->amsmem && !rank) { 2158d45a07a7SBarry Smith char dir[1024]; 2159d45a07a7SBarry Smith 2160e04113cfSBarry Smith ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr); 2161a0931e03SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr); 21622657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT)); 21632657e9d9SBarry Smith ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr); 21642657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE)); 2165d763cef2SBarry Smith } 21660acecf5bSBarry Smith if (ts->ops->view) { 21670acecf5bSBarry Smith ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr); 21680acecf5bSBarry Smith } 2169f05ece33SBarry Smith #endif 2170f05ece33SBarry Smith } 217136a9e3b9SBarry Smith if (ts->snes && ts->usessnes) { 217236a9e3b9SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 217336a9e3b9SBarry Smith ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr); 217436a9e3b9SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 217536a9e3b9SBarry Smith } 217636a9e3b9SBarry Smith ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr); 217736a9e3b9SBarry Smith ierr = DMTSView(sdm,viewer);CHKERRQ(ierr); 2178f05ece33SBarry Smith 2179b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 2180251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr); 2181b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2182d763cef2SBarry Smith PetscFunctionReturn(0); 2183d763cef2SBarry Smith } 2184d763cef2SBarry Smith 2185b07ff414SBarry Smith /*@ 2186d763cef2SBarry Smith TSSetApplicationContext - Sets an optional user-defined context for 2187d763cef2SBarry Smith the timesteppers. 2188d763cef2SBarry Smith 21893f9fe445SBarry Smith Logically Collective on TS 2190d763cef2SBarry Smith 2191d763cef2SBarry Smith Input Parameters: 2192d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2193d763cef2SBarry Smith - usrP - optional user context 2194d763cef2SBarry Smith 219595452b02SPatrick Sanan Fortran Notes: 219695452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2197daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2198daf670e6SBarry Smith 2199d763cef2SBarry Smith Level: intermediate 2200d763cef2SBarry Smith 2201d763cef2SBarry Smith .seealso: TSGetApplicationContext() 2202d763cef2SBarry Smith @*/ 22037087cfbeSBarry Smith PetscErrorCode TSSetApplicationContext(TS ts,void *usrP) 2204d763cef2SBarry Smith { 2205d763cef2SBarry Smith PetscFunctionBegin; 22060700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2207d763cef2SBarry Smith ts->user = usrP; 2208d763cef2SBarry Smith PetscFunctionReturn(0); 2209d763cef2SBarry Smith } 2210d763cef2SBarry Smith 2211b07ff414SBarry Smith /*@ 2212d763cef2SBarry Smith TSGetApplicationContext - Gets the user-defined context for the 2213d763cef2SBarry Smith timestepper. 2214d763cef2SBarry Smith 2215d763cef2SBarry Smith Not Collective 2216d763cef2SBarry Smith 2217d763cef2SBarry Smith Input Parameter: 2218d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2219d763cef2SBarry Smith 2220d763cef2SBarry Smith Output Parameter: 2221d763cef2SBarry Smith . usrP - user context 2222d763cef2SBarry Smith 222395452b02SPatrick Sanan Fortran Notes: 222495452b02SPatrick Sanan To use this from Fortran you must write a Fortran interface definition for this 2225daf670e6SBarry Smith function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument. 2226daf670e6SBarry Smith 2227d763cef2SBarry Smith Level: intermediate 2228d763cef2SBarry Smith 2229d763cef2SBarry Smith .seealso: TSSetApplicationContext() 2230d763cef2SBarry Smith @*/ 2231e71120c6SJed Brown PetscErrorCode TSGetApplicationContext(TS ts,void *usrP) 2232d763cef2SBarry Smith { 2233d763cef2SBarry Smith PetscFunctionBegin; 22340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2235e71120c6SJed Brown *(void**)usrP = ts->user; 2236d763cef2SBarry Smith PetscFunctionReturn(0); 2237d763cef2SBarry Smith } 2238d763cef2SBarry Smith 2239d763cef2SBarry Smith /*@ 224080275a0aSLisandro Dalcin TSGetStepNumber - Gets the number of steps completed. 2241d763cef2SBarry Smith 2242d763cef2SBarry Smith Not Collective 2243d763cef2SBarry Smith 2244d763cef2SBarry Smith Input Parameter: 2245d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2246d763cef2SBarry Smith 2247d763cef2SBarry Smith Output Parameter: 224880275a0aSLisandro Dalcin . steps - number of steps completed so far 2249d763cef2SBarry Smith 2250d763cef2SBarry Smith Level: intermediate 2251d763cef2SBarry Smith 22529be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep() 2253d763cef2SBarry Smith @*/ 225480275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps) 2255d763cef2SBarry Smith { 2256d763cef2SBarry Smith PetscFunctionBegin; 22570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 225880275a0aSLisandro Dalcin PetscValidIntPointer(steps,2); 225980275a0aSLisandro Dalcin *steps = ts->steps; 226080275a0aSLisandro Dalcin PetscFunctionReturn(0); 226180275a0aSLisandro Dalcin } 226280275a0aSLisandro Dalcin 226380275a0aSLisandro Dalcin /*@ 226480275a0aSLisandro Dalcin TSSetStepNumber - Sets the number of steps completed. 226580275a0aSLisandro Dalcin 226680275a0aSLisandro Dalcin Logically Collective on TS 226780275a0aSLisandro Dalcin 226880275a0aSLisandro Dalcin Input Parameters: 226980275a0aSLisandro Dalcin + ts - the TS context 227080275a0aSLisandro Dalcin - steps - number of steps completed so far 227180275a0aSLisandro Dalcin 227280275a0aSLisandro Dalcin Notes: 227380275a0aSLisandro Dalcin For most uses of the TS solvers the user need not explicitly call 227480275a0aSLisandro Dalcin TSSetStepNumber(), as the step counter is appropriately updated in 227580275a0aSLisandro Dalcin TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to 227680275a0aSLisandro Dalcin reinitialize timestepping by setting the step counter to zero (and time 227780275a0aSLisandro Dalcin to the initial time) to solve a similar problem with different initial 227880275a0aSLisandro Dalcin conditions or parameters. Other possible use case is to continue 227980275a0aSLisandro Dalcin timestepping from a previously interrupted run in such a way that TS 228080275a0aSLisandro Dalcin monitors will be called with a initial nonzero step counter. 228180275a0aSLisandro Dalcin 228280275a0aSLisandro Dalcin Level: advanced 228380275a0aSLisandro Dalcin 228480275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution() 228580275a0aSLisandro Dalcin @*/ 228680275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps) 228780275a0aSLisandro Dalcin { 228880275a0aSLisandro Dalcin PetscFunctionBegin; 228980275a0aSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 229080275a0aSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,steps,2); 229180275a0aSLisandro Dalcin if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative"); 229280275a0aSLisandro Dalcin ts->steps = steps; 2293d763cef2SBarry Smith PetscFunctionReturn(0); 2294d763cef2SBarry Smith } 2295d763cef2SBarry Smith 2296d763cef2SBarry Smith /*@ 2297d763cef2SBarry Smith TSSetTimeStep - Allows one to reset the timestep at any time, 2298d763cef2SBarry Smith useful for simple pseudo-timestepping codes. 2299d763cef2SBarry Smith 23003f9fe445SBarry Smith Logically Collective on TS 2301d763cef2SBarry Smith 2302d763cef2SBarry Smith Input Parameters: 2303d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 2304d763cef2SBarry Smith - time_step - the size of the timestep 2305d763cef2SBarry Smith 2306d763cef2SBarry Smith Level: intermediate 2307d763cef2SBarry Smith 2308aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime() 2309d763cef2SBarry Smith 2310d763cef2SBarry Smith @*/ 23117087cfbeSBarry Smith PetscErrorCode TSSetTimeStep(TS ts,PetscReal time_step) 2312d763cef2SBarry Smith { 2313d763cef2SBarry Smith PetscFunctionBegin; 23140700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2315c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,time_step,2); 2316d763cef2SBarry Smith ts->time_step = time_step; 2317d763cef2SBarry Smith PetscFunctionReturn(0); 2318d763cef2SBarry Smith } 2319d763cef2SBarry Smith 2320a43b19c4SJed Brown /*@ 232149354f04SShri Abhyankar TSSetExactFinalTime - Determines whether to adapt the final time step to 232249354f04SShri Abhyankar match the exact final time, interpolate solution to the exact final time, 232349354f04SShri Abhyankar or just return at the final time TS computed. 2324a43b19c4SJed Brown 2325a43b19c4SJed Brown Logically Collective on TS 2326a43b19c4SJed Brown 2327a43b19c4SJed Brown Input Parameter: 2328a43b19c4SJed Brown + ts - the time-step context 232949354f04SShri Abhyankar - eftopt - exact final time option 2330a43b19c4SJed Brown 2331feed9e9dSBarry Smith $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2332feed9e9dSBarry Smith $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2333feed9e9dSBarry Smith $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2334feed9e9dSBarry Smith 2335feed9e9dSBarry Smith Options Database: 2336feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2337feed9e9dSBarry Smith 2338ee346746SBarry Smith Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time 2339ee346746SBarry Smith then the final time you selected. 2340ee346746SBarry Smith 2341a43b19c4SJed Brown Level: beginner 2342a43b19c4SJed Brown 2343f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime() 2344a43b19c4SJed Brown @*/ 234549354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt) 2346a43b19c4SJed Brown { 2347a43b19c4SJed Brown PetscFunctionBegin; 2348a43b19c4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 234949354f04SShri Abhyankar PetscValidLogicalCollectiveEnum(ts,eftopt,2); 235049354f04SShri Abhyankar ts->exact_final_time = eftopt; 2351a43b19c4SJed Brown PetscFunctionReturn(0); 2352a43b19c4SJed Brown } 2353a43b19c4SJed Brown 2354d763cef2SBarry Smith /*@ 2355f6953c82SLisandro Dalcin TSGetExactFinalTime - Gets the exact final time option. 2356f6953c82SLisandro Dalcin 2357f6953c82SLisandro Dalcin Not Collective 2358f6953c82SLisandro Dalcin 2359f6953c82SLisandro Dalcin Input Parameter: 2360f6953c82SLisandro Dalcin . ts - the TS context 2361f6953c82SLisandro Dalcin 2362f6953c82SLisandro Dalcin Output Parameter: 2363f6953c82SLisandro Dalcin . eftopt - exact final time option 2364f6953c82SLisandro Dalcin 2365f6953c82SLisandro Dalcin Level: beginner 2366f6953c82SLisandro Dalcin 2367f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime() 2368f6953c82SLisandro Dalcin @*/ 2369f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt) 2370f6953c82SLisandro Dalcin { 2371f6953c82SLisandro Dalcin PetscFunctionBegin; 2372f6953c82SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2373f6953c82SLisandro Dalcin PetscValidPointer(eftopt,2); 2374f6953c82SLisandro Dalcin *eftopt = ts->exact_final_time; 2375f6953c82SLisandro Dalcin PetscFunctionReturn(0); 2376f6953c82SLisandro Dalcin } 2377f6953c82SLisandro Dalcin 2378f6953c82SLisandro Dalcin /*@ 2379d763cef2SBarry Smith TSGetTimeStep - Gets the current timestep size. 2380d763cef2SBarry Smith 2381d763cef2SBarry Smith Not Collective 2382d763cef2SBarry Smith 2383d763cef2SBarry Smith Input Parameter: 2384d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2385d763cef2SBarry Smith 2386d763cef2SBarry Smith Output Parameter: 2387d763cef2SBarry Smith . dt - the current timestep size 2388d763cef2SBarry Smith 2389d763cef2SBarry Smith Level: intermediate 2390d763cef2SBarry Smith 2391aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime() 2392d763cef2SBarry Smith 2393d763cef2SBarry Smith @*/ 23947087cfbeSBarry Smith PetscErrorCode TSGetTimeStep(TS ts,PetscReal *dt) 2395d763cef2SBarry Smith { 2396d763cef2SBarry Smith PetscFunctionBegin; 23970700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2398f7cf8827SBarry Smith PetscValidRealPointer(dt,2); 2399d763cef2SBarry Smith *dt = ts->time_step; 2400d763cef2SBarry Smith PetscFunctionReturn(0); 2401d763cef2SBarry Smith } 2402d763cef2SBarry Smith 2403d8e5e3e6SSatish Balay /*@ 2404d763cef2SBarry Smith TSGetSolution - Returns the solution at the present timestep. It 2405d763cef2SBarry Smith is valid to call this routine inside the function that you are evaluating 2406d763cef2SBarry Smith in order to move to the new timestep. This vector not changed until 2407d763cef2SBarry Smith the solution at the next timestep has been calculated. 2408d763cef2SBarry Smith 2409d763cef2SBarry Smith Not Collective, but Vec returned is parallel if TS is parallel 2410d763cef2SBarry Smith 2411d763cef2SBarry Smith Input Parameter: 2412d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2413d763cef2SBarry Smith 2414d763cef2SBarry Smith Output Parameter: 2415d763cef2SBarry Smith . v - the vector containing the solution 2416d763cef2SBarry Smith 241763e21af5SBarry Smith Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested 241863e21af5SBarry Smith final time. It returns the solution at the next timestep. 241963e21af5SBarry Smith 2420d763cef2SBarry Smith Level: intermediate 2421d763cef2SBarry Smith 24220ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction() 2423d763cef2SBarry Smith 2424d763cef2SBarry Smith @*/ 24257087cfbeSBarry Smith PetscErrorCode TSGetSolution(TS ts,Vec *v) 2426d763cef2SBarry Smith { 2427d763cef2SBarry Smith PetscFunctionBegin; 24280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 24294482741eSBarry Smith PetscValidPointer(v,2); 24308737fe31SLisandro Dalcin *v = ts->vec_sol; 2431d763cef2SBarry Smith PetscFunctionReturn(0); 2432d763cef2SBarry Smith } 2433d763cef2SBarry Smith 243403fe5f5eSDebojyoti Ghosh /*@ 2435b2bf4f3aSDebojyoti Ghosh TSGetSolutionComponents - Returns any solution components at the present 243603fe5f5eSDebojyoti Ghosh timestep, if available for the time integration method being used. 2437b2bf4f3aSDebojyoti Ghosh Solution components are quantities that share the same size and 243803fe5f5eSDebojyoti Ghosh structure as the solution vector. 243903fe5f5eSDebojyoti Ghosh 244003fe5f5eSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 244103fe5f5eSDebojyoti Ghosh 244203fe5f5eSDebojyoti Ghosh Parameters : 2443a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2444b2bf4f3aSDebojyoti Ghosh . n - If v is PETSC_NULL, then the number of solution components is 2445b2bf4f3aSDebojyoti Ghosh returned through n, else the n-th solution component is 244603fe5f5eSDebojyoti Ghosh returned in v. 2447a2b725a8SWilliam Gropp - v - the vector containing the n-th solution component 244803fe5f5eSDebojyoti Ghosh (may be PETSC_NULL to use this function to find out 2449b2bf4f3aSDebojyoti Ghosh the number of solutions components). 245003fe5f5eSDebojyoti Ghosh 24514cdd57e5SDebojyoti Ghosh Level: advanced 245203fe5f5eSDebojyoti Ghosh 245303fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution() 245403fe5f5eSDebojyoti Ghosh 245503fe5f5eSDebojyoti Ghosh @*/ 2456b2bf4f3aSDebojyoti Ghosh PetscErrorCode TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v) 245703fe5f5eSDebojyoti Ghosh { 245803fe5f5eSDebojyoti Ghosh PetscErrorCode ierr; 245903fe5f5eSDebojyoti Ghosh 246003fe5f5eSDebojyoti Ghosh PetscFunctionBegin; 246103fe5f5eSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2462b2bf4f3aSDebojyoti Ghosh if (!ts->ops->getsolutioncomponents) *n = 0; 246303fe5f5eSDebojyoti Ghosh else { 2464b2bf4f3aSDebojyoti Ghosh ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr); 246503fe5f5eSDebojyoti Ghosh } 246603fe5f5eSDebojyoti Ghosh PetscFunctionReturn(0); 246703fe5f5eSDebojyoti Ghosh } 246803fe5f5eSDebojyoti Ghosh 24694cdd57e5SDebojyoti Ghosh /*@ 24704cdd57e5SDebojyoti Ghosh TSGetAuxSolution - Returns an auxiliary solution at the present 24714cdd57e5SDebojyoti Ghosh timestep, if available for the time integration method being used. 24724cdd57e5SDebojyoti Ghosh 24734cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 24744cdd57e5SDebojyoti Ghosh 24754cdd57e5SDebojyoti Ghosh Parameters : 2476a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2477a2b725a8SWilliam Gropp - v - the vector containing the auxiliary solution 24784cdd57e5SDebojyoti Ghosh 24794cdd57e5SDebojyoti Ghosh Level: intermediate 24804cdd57e5SDebojyoti Ghosh 24814cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution() 24824cdd57e5SDebojyoti Ghosh 24834cdd57e5SDebojyoti Ghosh @*/ 24844cdd57e5SDebojyoti Ghosh PetscErrorCode TSGetAuxSolution(TS ts,Vec *v) 24854cdd57e5SDebojyoti Ghosh { 24864cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 24874cdd57e5SDebojyoti Ghosh 24884cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 24894cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2490f6356ec7SDebojyoti Ghosh if (ts->ops->getauxsolution) { 24914cdd57e5SDebojyoti Ghosh ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr); 2492f6356ec7SDebojyoti Ghosh } else { 2493f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2494f6356ec7SDebojyoti Ghosh } 24954cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 24964cdd57e5SDebojyoti Ghosh } 24974cdd57e5SDebojyoti Ghosh 24984cdd57e5SDebojyoti Ghosh /*@ 24994cdd57e5SDebojyoti Ghosh TSGetTimeError - Returns the estimated error vector, if the chosen 25004cdd57e5SDebojyoti Ghosh TSType has an error estimation functionality. 25014cdd57e5SDebojyoti Ghosh 25024cdd57e5SDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 25034cdd57e5SDebojyoti Ghosh 25049657682dSDebojyoti Ghosh Note: MUST call after TSSetUp() 25059657682dSDebojyoti Ghosh 25064cdd57e5SDebojyoti Ghosh Parameters : 2507a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2508657c1e31SEmil Constantinescu . n - current estimate (n=0) or previous one (n=-1) 2509a2b725a8SWilliam Gropp - v - the vector containing the error (same size as the solution). 25104cdd57e5SDebojyoti Ghosh 25114cdd57e5SDebojyoti Ghosh Level: intermediate 25124cdd57e5SDebojyoti Ghosh 251357df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError() 25144cdd57e5SDebojyoti Ghosh 25154cdd57e5SDebojyoti Ghosh @*/ 25160a01e1b2SEmil Constantinescu PetscErrorCode TSGetTimeError(TS ts,PetscInt n,Vec *v) 25174cdd57e5SDebojyoti Ghosh { 25184cdd57e5SDebojyoti Ghosh PetscErrorCode ierr; 25194cdd57e5SDebojyoti Ghosh 25204cdd57e5SDebojyoti Ghosh PetscFunctionBegin; 25214cdd57e5SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2522f6356ec7SDebojyoti Ghosh if (ts->ops->gettimeerror) { 25230a01e1b2SEmil Constantinescu ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr); 2524f6356ec7SDebojyoti Ghosh } else { 2525f6356ec7SDebojyoti Ghosh ierr = VecZeroEntries(*v);CHKERRQ(ierr); 2526f6356ec7SDebojyoti Ghosh } 25274cdd57e5SDebojyoti Ghosh PetscFunctionReturn(0); 25284cdd57e5SDebojyoti Ghosh } 25294cdd57e5SDebojyoti Ghosh 253057df6a1bSDebojyoti Ghosh /*@ 253157df6a1bSDebojyoti Ghosh TSSetTimeError - Sets the estimated error vector, if the chosen 253257df6a1bSDebojyoti Ghosh TSType has an error estimation functionality. This can be used 253357df6a1bSDebojyoti Ghosh to restart such a time integrator with a given error vector. 253457df6a1bSDebojyoti Ghosh 253557df6a1bSDebojyoti Ghosh Not Collective, but Vec returned is parallel if TS is parallel 253657df6a1bSDebojyoti Ghosh 253757df6a1bSDebojyoti Ghosh Parameters : 2538a2b725a8SWilliam Gropp + ts - the TS context obtained from TSCreate() (input parameter). 2539a2b725a8SWilliam Gropp - v - the vector containing the error (same size as the solution). 254057df6a1bSDebojyoti Ghosh 254157df6a1bSDebojyoti Ghosh Level: intermediate 254257df6a1bSDebojyoti Ghosh 254357df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError) 254457df6a1bSDebojyoti Ghosh 254557df6a1bSDebojyoti Ghosh @*/ 254657df6a1bSDebojyoti Ghosh PetscErrorCode TSSetTimeError(TS ts,Vec v) 254757df6a1bSDebojyoti Ghosh { 254857df6a1bSDebojyoti Ghosh PetscErrorCode ierr; 254957df6a1bSDebojyoti Ghosh 255057df6a1bSDebojyoti Ghosh PetscFunctionBegin; 255157df6a1bSDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 25529657682dSDebojyoti Ghosh if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first"); 255357df6a1bSDebojyoti Ghosh if (ts->ops->settimeerror) { 255457df6a1bSDebojyoti Ghosh ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr); 255557df6a1bSDebojyoti Ghosh } 255657df6a1bSDebojyoti Ghosh PetscFunctionReturn(0); 255757df6a1bSDebojyoti Ghosh } 255857df6a1bSDebojyoti Ghosh 2559bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */ 2560d8e5e3e6SSatish Balay /*@ 2561bdad233fSMatthew Knepley TSSetProblemType - Sets the type of problem to be solved. 2562d763cef2SBarry Smith 2563bdad233fSMatthew Knepley Not collective 2564d763cef2SBarry Smith 2565bdad233fSMatthew Knepley Input Parameters: 2566bdad233fSMatthew Knepley + ts - The TS 2567bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2568d763cef2SBarry Smith .vb 25690910c330SBarry Smith U_t - A U = 0 (linear) 25700910c330SBarry Smith U_t - A(t) U = 0 (linear) 25710910c330SBarry Smith F(t,U,U_t) = 0 (nonlinear) 2572d763cef2SBarry Smith .ve 2573d763cef2SBarry Smith 2574d763cef2SBarry Smith Level: beginner 2575d763cef2SBarry Smith 2576bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2577d763cef2SBarry Smith @*/ 25787087cfbeSBarry Smith PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2579a7cc72afSBarry Smith { 25809e2a6581SJed Brown PetscErrorCode ierr; 25819e2a6581SJed Brown 2582d763cef2SBarry Smith PetscFunctionBegin; 25830700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 2584bdad233fSMatthew Knepley ts->problem_type = type; 25859e2a6581SJed Brown if (type == TS_LINEAR) { 25869e2a6581SJed Brown SNES snes; 25879e2a6581SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 25889e2a6581SJed Brown ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr); 25899e2a6581SJed Brown } 2590d763cef2SBarry Smith PetscFunctionReturn(0); 2591d763cef2SBarry Smith } 2592d763cef2SBarry Smith 2593bdad233fSMatthew Knepley /*@C 2594bdad233fSMatthew Knepley TSGetProblemType - Gets the type of problem to be solved. 2595bdad233fSMatthew Knepley 2596bdad233fSMatthew Knepley Not collective 2597bdad233fSMatthew Knepley 2598bdad233fSMatthew Knepley Input Parameter: 2599bdad233fSMatthew Knepley . ts - The TS 2600bdad233fSMatthew Knepley 2601bdad233fSMatthew Knepley Output Parameter: 2602bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms 2603bdad233fSMatthew Knepley .vb 2604089b2837SJed Brown M U_t = A U 2605089b2837SJed Brown M(t) U_t = A(t) U 2606b5abc632SBarry Smith F(t,U,U_t) 2607bdad233fSMatthew Knepley .ve 2608bdad233fSMatthew Knepley 2609bdad233fSMatthew Knepley Level: beginner 2610bdad233fSMatthew Knepley 2611bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS 2612bdad233fSMatthew Knepley @*/ 26137087cfbeSBarry Smith PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2614a7cc72afSBarry Smith { 2615bdad233fSMatthew Knepley PetscFunctionBegin; 26160700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 26174482741eSBarry Smith PetscValidIntPointer(type,2); 2618bdad233fSMatthew Knepley *type = ts->problem_type; 2619bdad233fSMatthew Knepley PetscFunctionReturn(0); 2620bdad233fSMatthew Knepley } 2621d763cef2SBarry Smith 2622303a5415SBarry Smith /* 2623303a5415SBarry Smith Attempt to check/preset a default value for the exact final time option. This is needed at the beginning of TSSolve() and in TSSetUp() 2624303a5415SBarry Smith */ 2625303a5415SBarry Smith static PetscErrorCode TSSetExactFinalTimeDefault(TS ts) 2626303a5415SBarry Smith { 2627303a5415SBarry Smith PetscErrorCode ierr; 2628303a5415SBarry Smith PetscBool isnone; 2629303a5415SBarry Smith 2630303a5415SBarry Smith PetscFunctionBegin; 2631303a5415SBarry Smith ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 2632303a5415SBarry Smith ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 2633303a5415SBarry Smith 2634303a5415SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr); 2635303a5415SBarry Smith if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) { 2636303a5415SBarry Smith ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 2637303a5415SBarry Smith } else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) { 2638303a5415SBarry Smith ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE; 2639303a5415SBarry Smith } 2640303a5415SBarry Smith PetscFunctionReturn(0); 2641303a5415SBarry Smith } 2642303a5415SBarry Smith 2643303a5415SBarry Smith 2644d763cef2SBarry Smith /*@ 2645303a5415SBarry Smith TSSetUp - Sets up the internal data structures for the later use of a timestepper. 2646d763cef2SBarry Smith 2647d763cef2SBarry Smith Collective on TS 2648d763cef2SBarry Smith 2649d763cef2SBarry Smith Input Parameter: 2650d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2651d763cef2SBarry Smith 2652d763cef2SBarry Smith Notes: 2653d763cef2SBarry Smith For basic use of the TS solvers the user need not explicitly call 2654d763cef2SBarry Smith TSSetUp(), since these actions will automatically occur during 2655141bd67dSStefano Zampini the call to TSStep() or TSSolve(). However, if one wishes to control this 2656d763cef2SBarry Smith phase separately, TSSetUp() should be called after TSCreate() 2657141bd67dSStefano Zampini and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve(). 2658d763cef2SBarry Smith 2659d763cef2SBarry Smith Level: advanced 2660d763cef2SBarry Smith 2661141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve() 2662d763cef2SBarry Smith @*/ 26637087cfbeSBarry Smith PetscErrorCode TSSetUp(TS ts) 2664d763cef2SBarry Smith { 2665dfbe8321SBarry Smith PetscErrorCode ierr; 26666c6b9e74SPeter Brune DM dm; 26676c6b9e74SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 2668d1e9a80fSBarry Smith PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*); 2669cd11d68dSLisandro Dalcin TSIFunction ifun; 26706c6b9e74SPeter Brune TSIJacobian ijac; 2671efe9872eSLisandro Dalcin TSI2Jacobian i2jac; 26726c6b9e74SPeter Brune TSRHSJacobian rhsjac; 2673d763cef2SBarry Smith 2674d763cef2SBarry Smith PetscFunctionBegin; 26750700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2676277b19d0SLisandro Dalcin if (ts->setupcalled) PetscFunctionReturn(0); 2677277b19d0SLisandro Dalcin 26787adad957SLisandro Dalcin if (!((PetscObject)ts)->type_name) { 2679cd11d68dSLisandro Dalcin ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr); 2680cd11d68dSLisandro Dalcin ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr); 2681d763cef2SBarry Smith } 2682277b19d0SLisandro Dalcin 26831a638600SStefano Zampini if (!ts->vec_sol) { 26841a638600SStefano Zampini if (ts->dm) { 26851a638600SStefano Zampini ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr); 26861a638600SStefano Zampini } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first"); 26871a638600SStefano Zampini } 2688277b19d0SLisandro Dalcin 2689298bade4SHong Zhang if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */ 2690298bade4SHong Zhang ierr = PetscObjectReference((PetscObject)ts->Jacprhs);CHKERRQ(ierr); 2691298bade4SHong Zhang ts->Jacp = ts->Jacprhs; 2692298bade4SHong Zhang } 2693298bade4SHong Zhang 2694cd4cee2dSHong Zhang if (ts->quadraturets) { 2695cd4cee2dSHong Zhang ierr = TSSetUp(ts->quadraturets);CHKERRQ(ierr); 2696ecf68647SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2697cd4cee2dSHong Zhang ierr = VecDuplicate(ts->quadraturets->vec_sol,&ts->vec_costintegrand);CHKERRQ(ierr); 2698cd4cee2dSHong Zhang } 2699cd4cee2dSHong Zhang 2700971015bcSStefano Zampini ierr = TSGetRHSJacobian(ts,NULL,NULL,&rhsjac,NULL);CHKERRQ(ierr); 2701f23ba4b3SHong Zhang if (rhsjac == TSComputeRHSJacobianConstant) { 2702e1244c69SJed Brown Mat Amat,Pmat; 2703e1244c69SJed Brown SNES snes; 2704e1244c69SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2705e1244c69SJed Brown ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr); 2706e1244c69SJed Brown /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2707e1244c69SJed Brown * have displaced the RHS matrix */ 2708971015bcSStefano Zampini if (Amat && Amat == ts->Arhs) { 2709abc0d4abSBarry 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 */ 2710abc0d4abSBarry Smith ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr); 2711e1244c69SJed Brown ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr); 2712e1244c69SJed Brown ierr = MatDestroy(&Amat);CHKERRQ(ierr); 2713e1244c69SJed Brown } 2714971015bcSStefano Zampini if (Pmat && Pmat == ts->Brhs) { 2715abc0d4abSBarry Smith ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr); 2716e1244c69SJed Brown ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr); 2717e1244c69SJed Brown ierr = MatDestroy(&Pmat);CHKERRQ(ierr); 2718e1244c69SJed Brown } 2719e1244c69SJed Brown } 27202ffb9264SLisandro Dalcin 27212ffb9264SLisandro Dalcin ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr); 27222ffb9264SLisandro Dalcin ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr); 27232ffb9264SLisandro Dalcin 2724277b19d0SLisandro Dalcin if (ts->ops->setup) { 2725000e7ae3SMatthew Knepley ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr); 2726277b19d0SLisandro Dalcin } 2727277b19d0SLisandro Dalcin 2728303a5415SBarry Smith ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr); 27292ffb9264SLisandro Dalcin 2730a6772fa2SLisandro Dalcin /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 27316c6b9e74SPeter Brune to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 27326c6b9e74SPeter Brune */ 27336c6b9e74SPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 27340298fd71SBarry Smith ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr); 27356c6b9e74SPeter Brune if (!func) { 27366c6b9e74SPeter Brune ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr); 27376c6b9e74SPeter Brune } 2738a6772fa2SLisandro 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. 27396c6b9e74SPeter Brune Otherwise, the SNES will use coloring internally to form the Jacobian. 27406c6b9e74SPeter Brune */ 27410298fd71SBarry Smith ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr); 27420298fd71SBarry Smith ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr); 2743efe9872eSLisandro Dalcin ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr); 27440298fd71SBarry Smith ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr); 2745efe9872eSLisandro Dalcin if (!jac && (ijac || i2jac || rhsjac)) { 27466c6b9e74SPeter Brune ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr); 27476c6b9e74SPeter Brune } 2748c0517034SDebojyoti Ghosh 2749c0517034SDebojyoti Ghosh /* if time integration scheme has a starting method, call it */ 2750c0517034SDebojyoti Ghosh if (ts->ops->startingmethod) { 2751c0517034SDebojyoti Ghosh ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr); 2752c0517034SDebojyoti Ghosh } 2753c0517034SDebojyoti Ghosh 2754277b19d0SLisandro Dalcin ts->setupcalled = PETSC_TRUE; 2755277b19d0SLisandro Dalcin PetscFunctionReturn(0); 2756277b19d0SLisandro Dalcin } 2757277b19d0SLisandro Dalcin 2758f6a906c0SBarry Smith /*@ 2759277b19d0SLisandro Dalcin TSReset - Resets a TS context and removes any allocated Vecs and Mats. 2760277b19d0SLisandro Dalcin 2761277b19d0SLisandro Dalcin Collective on TS 2762277b19d0SLisandro Dalcin 2763277b19d0SLisandro Dalcin Input Parameter: 2764277b19d0SLisandro Dalcin . ts - the TS context obtained from TSCreate() 2765277b19d0SLisandro Dalcin 2766277b19d0SLisandro Dalcin Level: beginner 2767277b19d0SLisandro Dalcin 2768277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy() 2769277b19d0SLisandro Dalcin @*/ 2770277b19d0SLisandro Dalcin PetscErrorCode TSReset(TS ts) 2771277b19d0SLisandro Dalcin { 27721d06f6b3SHong Zhang TS_RHSSplitLink ilink = ts->tsrhssplit,next; 2773277b19d0SLisandro Dalcin PetscErrorCode ierr; 2774277b19d0SLisandro Dalcin 2775277b19d0SLisandro Dalcin PetscFunctionBegin; 2776277b19d0SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2777b18ea86cSHong Zhang 2778277b19d0SLisandro Dalcin if (ts->ops->reset) { 2779277b19d0SLisandro Dalcin ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr); 2780277b19d0SLisandro Dalcin } 2781277b19d0SLisandro Dalcin if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);} 2782e27a82bcSLisandro Dalcin if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);} 2783bbd56ea5SKarl Rupp 27844e684422SJed Brown ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr); 27854e684422SJed Brown ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr); 2786214bc6a2SJed Brown ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr); 27876bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 2788efe9872eSLisandro Dalcin ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr); 2789e3d84a46SJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 2790e3d84a46SJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 279138637c2eSJed Brown ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr); 2792bbd56ea5SKarl Rupp 2793cd4cee2dSHong Zhang ierr = MatDestroy(&ts->Jacprhs);CHKERRQ(ierr); 2794ad8e2604SHong Zhang ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr); 2795ecf68647SHong Zhang if (ts->forward_solve) { 2796ecf68647SHong Zhang ierr = TSForwardReset(ts);CHKERRQ(ierr); 2797ecf68647SHong Zhang } 2798cd4cee2dSHong Zhang if (ts->quadraturets) { 2799cd4cee2dSHong Zhang ierr = TSReset(ts->quadraturets);CHKERRQ(ierr); 280036eaed60SHong Zhang ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr); 2801cd4cee2dSHong Zhang } 28021d06f6b3SHong Zhang while (ilink) { 28031d06f6b3SHong Zhang next = ilink->next; 28041d06f6b3SHong Zhang ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr); 28051d06f6b3SHong Zhang ierr = PetscFree(ilink->splitname);CHKERRQ(ierr); 28061d06f6b3SHong Zhang ierr = ISDestroy(&ilink->is);CHKERRQ(ierr); 28071d06f6b3SHong Zhang ierr = PetscFree(ilink);CHKERRQ(ierr); 28081d06f6b3SHong Zhang ilink = next; 280987f4e208SHong Zhang } 2810545aaa6fSHong Zhang ts->num_rhs_splits = 0; 2811277b19d0SLisandro Dalcin ts->setupcalled = PETSC_FALSE; 2812d763cef2SBarry Smith PetscFunctionReturn(0); 2813d763cef2SBarry Smith } 2814d763cef2SBarry Smith 2815d8e5e3e6SSatish Balay /*@ 2816d763cef2SBarry Smith TSDestroy - Destroys the timestepper context that was created 2817d763cef2SBarry Smith with TSCreate(). 2818d763cef2SBarry Smith 2819d763cef2SBarry Smith Collective on TS 2820d763cef2SBarry Smith 2821d763cef2SBarry Smith Input Parameter: 2822d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2823d763cef2SBarry Smith 2824d763cef2SBarry Smith Level: beginner 2825d763cef2SBarry Smith 2826d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve() 2827d763cef2SBarry Smith @*/ 28286bf464f9SBarry Smith PetscErrorCode TSDestroy(TS *ts) 2829d763cef2SBarry Smith { 28306849ba73SBarry Smith PetscErrorCode ierr; 2831d763cef2SBarry Smith 2832d763cef2SBarry Smith PetscFunctionBegin; 28336bf464f9SBarry Smith if (!*ts) PetscFunctionReturn(0); 2834ecf68647SHong Zhang PetscValidHeaderSpecific(*ts,TS_CLASSID,1); 2835c793f718SLisandro Dalcin if (--((PetscObject)(*ts))->refct > 0) {*ts = NULL; PetscFunctionReturn(0);} 2836d763cef2SBarry Smith 2837ecf68647SHong Zhang ierr = TSReset(*ts);CHKERRQ(ierr); 2838ecf68647SHong Zhang ierr = TSAdjointReset(*ts);CHKERRQ(ierr); 2839ecf68647SHong Zhang if ((*ts)->forward_solve) { 2840ecf68647SHong Zhang ierr = TSForwardReset(*ts);CHKERRQ(ierr); 2841ecf68647SHong Zhang } 2842e04113cfSBarry Smith /* if memory was published with SAWs then destroy it */ 2843e04113cfSBarry Smith ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr); 28446bf464f9SBarry Smith if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);} 28456d4c513bSLisandro Dalcin 2846bc952696SBarry Smith ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr); 2847bc952696SBarry Smith 284884df9cb4SJed Brown ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr); 28496427ac75SLisandro Dalcin ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr); 28506427ac75SLisandro Dalcin 28516bf464f9SBarry Smith ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr); 28526bf464f9SBarry Smith ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr); 28536bf464f9SBarry Smith ierr = TSMonitorCancel((*ts));CHKERRQ(ierr); 28540dd9f2efSHong Zhang ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr); 28556d4c513bSLisandro Dalcin 2856cd4cee2dSHong Zhang ierr = TSDestroy(&(*ts)->quadraturets);CHKERRQ(ierr); 2857a79aaaedSSatish Balay ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr); 2858d763cef2SBarry Smith PetscFunctionReturn(0); 2859d763cef2SBarry Smith } 2860d763cef2SBarry Smith 2861d8e5e3e6SSatish Balay /*@ 2862d763cef2SBarry Smith TSGetSNES - Returns the SNES (nonlinear solver) associated with 2863d763cef2SBarry Smith a TS (timestepper) context. Valid only for nonlinear problems. 2864d763cef2SBarry Smith 2865d763cef2SBarry Smith Not Collective, but SNES is parallel if TS is parallel 2866d763cef2SBarry Smith 2867d763cef2SBarry Smith Input Parameter: 2868d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2869d763cef2SBarry Smith 2870d763cef2SBarry Smith Output Parameter: 2871d763cef2SBarry Smith . snes - the nonlinear solver context 2872d763cef2SBarry Smith 2873d763cef2SBarry Smith Notes: 2874d763cef2SBarry Smith The user can then directly manipulate the SNES context to set various 2875d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 287694b7f48cSBarry Smith KSP, KSP, and PC contexts as well. 2877d763cef2SBarry Smith 2878d763cef2SBarry Smith TSGetSNES() does not work for integrators that do not use SNES; in 28790298fd71SBarry Smith this case TSGetSNES() returns NULL in snes. 2880d763cef2SBarry Smith 2881d763cef2SBarry Smith Level: beginner 2882d763cef2SBarry Smith 2883d763cef2SBarry Smith @*/ 28847087cfbeSBarry Smith PetscErrorCode TSGetSNES(TS ts,SNES *snes) 2885d763cef2SBarry Smith { 2886d372ba47SLisandro Dalcin PetscErrorCode ierr; 2887d372ba47SLisandro Dalcin 2888d763cef2SBarry Smith PetscFunctionBegin; 28890700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 28904482741eSBarry Smith PetscValidPointer(snes,2); 2891d372ba47SLisandro Dalcin if (!ts->snes) { 2892ce94432eSBarry Smith ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr); 289316413a6aSBarry Smith ierr = PetscObjectSetOptions((PetscObject)ts->snes,((PetscObject)ts)->options);CHKERRQ(ierr); 28940298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 28953bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr); 2896d372ba47SLisandro Dalcin ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr); 2897496e6a7aSJed Brown if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 28989e2a6581SJed Brown if (ts->problem_type == TS_LINEAR) { 28999e2a6581SJed Brown ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr); 29009e2a6581SJed Brown } 2901d372ba47SLisandro Dalcin } 2902d763cef2SBarry Smith *snes = ts->snes; 2903d763cef2SBarry Smith PetscFunctionReturn(0); 2904d763cef2SBarry Smith } 2905d763cef2SBarry Smith 2906deb2cd25SJed Brown /*@ 2907deb2cd25SJed Brown TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context 2908deb2cd25SJed Brown 2909deb2cd25SJed Brown Collective 2910deb2cd25SJed Brown 2911deb2cd25SJed Brown Input Parameter: 2912deb2cd25SJed Brown + ts - the TS context obtained from TSCreate() 2913deb2cd25SJed Brown - snes - the nonlinear solver context 2914deb2cd25SJed Brown 2915deb2cd25SJed Brown Notes: 2916deb2cd25SJed Brown Most users should have the TS created by calling TSGetSNES() 2917deb2cd25SJed Brown 2918deb2cd25SJed Brown Level: developer 2919deb2cd25SJed Brown 2920deb2cd25SJed Brown @*/ 2921deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes) 2922deb2cd25SJed Brown { 2923deb2cd25SJed Brown PetscErrorCode ierr; 2924d1e9a80fSBarry Smith PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*); 2925deb2cd25SJed Brown 2926deb2cd25SJed Brown PetscFunctionBegin; 2927deb2cd25SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 2928deb2cd25SJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,2); 2929deb2cd25SJed Brown ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr); 2930deb2cd25SJed Brown ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr); 2931bbd56ea5SKarl Rupp 2932deb2cd25SJed Brown ts->snes = snes; 2933bbd56ea5SKarl Rupp 29340298fd71SBarry Smith ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr); 29350298fd71SBarry Smith ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr); 2936740132f1SEmil Constantinescu if (func == SNESTSFormJacobian) { 29370298fd71SBarry Smith ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr); 2938740132f1SEmil Constantinescu } 2939deb2cd25SJed Brown PetscFunctionReturn(0); 2940deb2cd25SJed Brown } 2941deb2cd25SJed Brown 2942d8e5e3e6SSatish Balay /*@ 294394b7f48cSBarry Smith TSGetKSP - Returns the KSP (linear solver) associated with 2944d763cef2SBarry Smith a TS (timestepper) context. 2945d763cef2SBarry Smith 294694b7f48cSBarry Smith Not Collective, but KSP is parallel if TS is parallel 2947d763cef2SBarry Smith 2948d763cef2SBarry Smith Input Parameter: 2949d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 2950d763cef2SBarry Smith 2951d763cef2SBarry Smith Output Parameter: 295294b7f48cSBarry Smith . ksp - the nonlinear solver context 2953d763cef2SBarry Smith 2954d763cef2SBarry Smith Notes: 295594b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 2956d763cef2SBarry Smith options, etc. Likewise, the user can then extract and manipulate the 2957d763cef2SBarry Smith KSP and PC contexts as well. 2958d763cef2SBarry Smith 295994b7f48cSBarry Smith TSGetKSP() does not work for integrators that do not use KSP; 29600298fd71SBarry Smith in this case TSGetKSP() returns NULL in ksp. 2961d763cef2SBarry Smith 2962d763cef2SBarry Smith Level: beginner 2963d763cef2SBarry Smith 2964d763cef2SBarry Smith @*/ 29657087cfbeSBarry Smith PetscErrorCode TSGetKSP(TS ts,KSP *ksp) 2966d763cef2SBarry Smith { 2967d372ba47SLisandro Dalcin PetscErrorCode ierr; 2968089b2837SJed Brown SNES snes; 2969d372ba47SLisandro Dalcin 2970d763cef2SBarry Smith PetscFunctionBegin; 29710700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 29724482741eSBarry Smith PetscValidPointer(ksp,2); 297317186662SBarry Smith if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first"); 2974e32f2f54SBarry Smith if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()"); 2975089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 2976089b2837SJed Brown ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr); 2977d763cef2SBarry Smith PetscFunctionReturn(0); 2978d763cef2SBarry Smith } 2979d763cef2SBarry Smith 2980d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */ 2981d763cef2SBarry Smith 2982adb62b0dSMatthew Knepley /*@ 2983618ce8baSLisandro Dalcin TSSetMaxSteps - Sets the maximum number of steps to use. 2984618ce8baSLisandro Dalcin 2985618ce8baSLisandro Dalcin Logically Collective on TS 2986618ce8baSLisandro Dalcin 2987618ce8baSLisandro Dalcin Input Parameters: 2988618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 2989618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use 2990618ce8baSLisandro Dalcin 2991618ce8baSLisandro Dalcin Options Database Keys: 2992618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps 2993618ce8baSLisandro Dalcin 2994618ce8baSLisandro Dalcin Notes: 2995618ce8baSLisandro Dalcin The default maximum number of steps is 5000 2996618ce8baSLisandro Dalcin 2997618ce8baSLisandro Dalcin Level: intermediate 2998618ce8baSLisandro Dalcin 2999618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime() 3000618ce8baSLisandro Dalcin @*/ 3001618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps) 3002618ce8baSLisandro Dalcin { 3003618ce8baSLisandro Dalcin PetscFunctionBegin; 3004618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3005618ce8baSLisandro Dalcin PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3006618ce8baSLisandro Dalcin if (maxsteps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative"); 3007618ce8baSLisandro Dalcin ts->max_steps = maxsteps; 3008618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3009618ce8baSLisandro Dalcin } 3010618ce8baSLisandro Dalcin 3011618ce8baSLisandro Dalcin /*@ 3012618ce8baSLisandro Dalcin TSGetMaxSteps - Gets the maximum number of steps to use. 3013618ce8baSLisandro Dalcin 3014618ce8baSLisandro Dalcin Not Collective 3015618ce8baSLisandro Dalcin 3016618ce8baSLisandro Dalcin Input Parameters: 3017618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 3018618ce8baSLisandro Dalcin 3019618ce8baSLisandro Dalcin Output Parameter: 3020618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use 3021618ce8baSLisandro Dalcin 3022618ce8baSLisandro Dalcin Level: advanced 3023618ce8baSLisandro Dalcin 3024618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime() 3025618ce8baSLisandro Dalcin @*/ 3026618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps) 3027618ce8baSLisandro Dalcin { 3028618ce8baSLisandro Dalcin PetscFunctionBegin; 3029618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3030618ce8baSLisandro Dalcin PetscValidIntPointer(maxsteps,2); 3031618ce8baSLisandro Dalcin *maxsteps = ts->max_steps; 3032618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3033618ce8baSLisandro Dalcin } 3034618ce8baSLisandro Dalcin 3035618ce8baSLisandro Dalcin /*@ 3036618ce8baSLisandro Dalcin TSSetMaxTime - Sets the maximum (or final) time for timestepping. 3037618ce8baSLisandro Dalcin 3038618ce8baSLisandro Dalcin Logically Collective on TS 3039618ce8baSLisandro Dalcin 3040618ce8baSLisandro Dalcin Input Parameters: 3041618ce8baSLisandro Dalcin + ts - the TS context obtained from TSCreate() 3042618ce8baSLisandro Dalcin - maxtime - final time to step to 3043618ce8baSLisandro Dalcin 3044618ce8baSLisandro Dalcin Options Database Keys: 3045ef85077eSLisandro Dalcin . -ts_max_time <maxtime> - Sets maxtime 3046618ce8baSLisandro Dalcin 3047618ce8baSLisandro Dalcin Notes: 3048618ce8baSLisandro Dalcin The default maximum time is 5.0 3049618ce8baSLisandro Dalcin 3050618ce8baSLisandro Dalcin Level: intermediate 3051618ce8baSLisandro Dalcin 3052618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime() 3053618ce8baSLisandro Dalcin @*/ 3054618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime) 3055618ce8baSLisandro Dalcin { 3056618ce8baSLisandro Dalcin PetscFunctionBegin; 3057618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3058618ce8baSLisandro Dalcin PetscValidLogicalCollectiveReal(ts,maxtime,2); 3059618ce8baSLisandro Dalcin ts->max_time = maxtime; 3060618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3061618ce8baSLisandro Dalcin } 3062618ce8baSLisandro Dalcin 3063618ce8baSLisandro Dalcin /*@ 3064618ce8baSLisandro Dalcin TSGetMaxTime - Gets the maximum (or final) time for timestepping. 3065618ce8baSLisandro Dalcin 3066618ce8baSLisandro Dalcin Not Collective 3067618ce8baSLisandro Dalcin 3068618ce8baSLisandro Dalcin Input Parameters: 3069618ce8baSLisandro Dalcin . ts - the TS context obtained from TSCreate() 3070618ce8baSLisandro Dalcin 3071618ce8baSLisandro Dalcin Output Parameter: 3072618ce8baSLisandro Dalcin . maxtime - final time to step to 3073618ce8baSLisandro Dalcin 3074618ce8baSLisandro Dalcin Level: advanced 3075618ce8baSLisandro Dalcin 3076618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps() 3077618ce8baSLisandro Dalcin @*/ 3078618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime) 3079618ce8baSLisandro Dalcin { 3080618ce8baSLisandro Dalcin PetscFunctionBegin; 3081618ce8baSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3082618ce8baSLisandro Dalcin PetscValidRealPointer(maxtime,2); 3083618ce8baSLisandro Dalcin *maxtime = ts->max_time; 3084618ce8baSLisandro Dalcin PetscFunctionReturn(0); 3085618ce8baSLisandro Dalcin } 3086618ce8baSLisandro Dalcin 3087618ce8baSLisandro Dalcin /*@ 3088aaa6c58dSLisandro Dalcin TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep(). 3089edc382c3SSatish Balay 3090edc382c3SSatish Balay Level: deprecated 3091edc382c3SSatish Balay 3092aaa6c58dSLisandro Dalcin @*/ 3093aaa6c58dSLisandro Dalcin PetscErrorCode TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step) 3094aaa6c58dSLisandro Dalcin { 3095aaa6c58dSLisandro Dalcin PetscErrorCode ierr; 3096aaa6c58dSLisandro Dalcin PetscFunctionBegin; 3097aaa6c58dSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3098aaa6c58dSLisandro Dalcin ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr); 3099aaa6c58dSLisandro Dalcin ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr); 3100aaa6c58dSLisandro Dalcin PetscFunctionReturn(0); 3101aaa6c58dSLisandro Dalcin } 3102aaa6c58dSLisandro Dalcin 3103aaa6c58dSLisandro Dalcin /*@ 310419eac22cSLisandro Dalcin TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime(). 3105edc382c3SSatish Balay 3106edc382c3SSatish Balay Level: deprecated 3107edc382c3SSatish Balay 3108adb62b0dSMatthew Knepley @*/ 31097087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 3110adb62b0dSMatthew Knepley { 3111adb62b0dSMatthew Knepley PetscFunctionBegin; 31120700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3113abc0a331SBarry Smith if (maxsteps) { 31144482741eSBarry Smith PetscValidIntPointer(maxsteps,2); 3115adb62b0dSMatthew Knepley *maxsteps = ts->max_steps; 3116adb62b0dSMatthew Knepley } 3117abc0a331SBarry Smith if (maxtime) { 31184482741eSBarry Smith PetscValidScalarPointer(maxtime,3); 3119adb62b0dSMatthew Knepley *maxtime = ts->max_time; 3120adb62b0dSMatthew Knepley } 3121adb62b0dSMatthew Knepley PetscFunctionReturn(0); 3122adb62b0dSMatthew Knepley } 3123adb62b0dSMatthew Knepley 3124d763cef2SBarry Smith /*@ 312519eac22cSLisandro Dalcin TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime(). 3126edc382c3SSatish Balay 3127edc382c3SSatish Balay Level: deprecated 3128edc382c3SSatish Balay 3129d763cef2SBarry Smith @*/ 31307087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime) 3131d763cef2SBarry Smith { 3132d763cef2SBarry Smith PetscFunctionBegin; 31330700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3134c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(ts,maxsteps,2); 3135c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,maxtime,2); 313639b7ec4bSSean Farley if (maxsteps >= 0) ts->max_steps = maxsteps; 313739b7ec4bSSean Farley if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime; 3138d763cef2SBarry Smith PetscFunctionReturn(0); 3139d763cef2SBarry Smith } 3140d763cef2SBarry Smith 3141d763cef2SBarry Smith /*@ 31425c5f5948SLisandro Dalcin TSGetTimeStepNumber - Deprecated, use TSGetStepNumber(). 3143edc382c3SSatish Balay 3144edc382c3SSatish Balay Level: deprecated 3145edc382c3SSatish Balay 31465c5f5948SLisandro Dalcin @*/ 3147e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 31485c5f5948SLisandro Dalcin 314919eac22cSLisandro Dalcin /*@ 31504f4e0956SLisandro Dalcin TSGetTotalSteps - Deprecated, use TSGetStepNumber(). 3151edc382c3SSatish Balay 3152edc382c3SSatish Balay Level: deprecated 3153edc382c3SSatish Balay 31544f4e0956SLisandro Dalcin @*/ 31554f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); } 31564f4e0956SLisandro Dalcin 31574f4e0956SLisandro Dalcin /*@ 3158d763cef2SBarry Smith TSSetSolution - Sets the initial solution vector 3159d763cef2SBarry Smith for use by the TS routines. 3160d763cef2SBarry Smith 3161d083f849SBarry Smith Logically Collective on TS 3162d763cef2SBarry Smith 3163d763cef2SBarry Smith Input Parameters: 3164d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 31650910c330SBarry Smith - u - the solution vector 3166d763cef2SBarry Smith 3167d763cef2SBarry Smith Level: beginner 3168d763cef2SBarry Smith 31690ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate() 3170d763cef2SBarry Smith @*/ 31710910c330SBarry Smith PetscErrorCode TSSetSolution(TS ts,Vec u) 3172d763cef2SBarry Smith { 31738737fe31SLisandro Dalcin PetscErrorCode ierr; 3174496e6a7aSJed Brown DM dm; 31758737fe31SLisandro Dalcin 3176d763cef2SBarry Smith PetscFunctionBegin; 31770700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 31780910c330SBarry Smith PetscValidHeaderSpecific(u,VEC_CLASSID,2); 31790910c330SBarry Smith ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr); 31806bf464f9SBarry Smith ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr); 31810910c330SBarry Smith ts->vec_sol = u; 3182bbd56ea5SKarl Rupp 3183496e6a7aSJed Brown ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 31840910c330SBarry Smith ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr); 3185d763cef2SBarry Smith PetscFunctionReturn(0); 3186d763cef2SBarry Smith } 3187d763cef2SBarry Smith 3188ac226902SBarry Smith /*@C 3189000e7ae3SMatthew Knepley TSSetPreStep - Sets the general-purpose function 31903f2090d5SJed Brown called once at the beginning of each time step. 3191000e7ae3SMatthew Knepley 31923f9fe445SBarry Smith Logically Collective on TS 3193000e7ae3SMatthew Knepley 3194000e7ae3SMatthew Knepley Input Parameters: 3195000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3196000e7ae3SMatthew Knepley - func - The function 3197000e7ae3SMatthew Knepley 3198000e7ae3SMatthew Knepley Calling sequence of func: 31996bc98fa9SBarry Smith . PetscErrorCode func (TS ts); 3200000e7ae3SMatthew Knepley 3201000e7ae3SMatthew Knepley Level: intermediate 3202000e7ae3SMatthew Knepley 3203dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep() 3204000e7ae3SMatthew Knepley @*/ 32057087cfbeSBarry Smith PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS)) 3206000e7ae3SMatthew Knepley { 3207000e7ae3SMatthew Knepley PetscFunctionBegin; 32080700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3209ae60f76fSBarry Smith ts->prestep = func; 3210000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3211000e7ae3SMatthew Knepley } 3212000e7ae3SMatthew Knepley 321309ee8438SJed Brown /*@ 32143f2090d5SJed Brown TSPreStep - Runs the user-defined pre-step function. 32153f2090d5SJed Brown 32163f2090d5SJed Brown Collective on TS 32173f2090d5SJed Brown 32183f2090d5SJed Brown Input Parameters: 32193f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 32203f2090d5SJed Brown 32213f2090d5SJed Brown Notes: 32223f2090d5SJed Brown TSPreStep() is typically used within time stepping implementations, 32233f2090d5SJed Brown so most users would not generally call this routine themselves. 32243f2090d5SJed Brown 32253f2090d5SJed Brown Level: developer 32263f2090d5SJed Brown 32279be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep() 32283f2090d5SJed Brown @*/ 32297087cfbeSBarry Smith PetscErrorCode TSPreStep(TS ts) 32303f2090d5SJed Brown { 32313f2090d5SJed Brown PetscErrorCode ierr; 32323f2090d5SJed Brown 32333f2090d5SJed Brown PetscFunctionBegin; 32340700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3235ae60f76fSBarry Smith if (ts->prestep) { 32365efd42a4SStefano Zampini Vec U; 32375efd42a4SStefano Zampini PetscObjectState sprev,spost; 32385efd42a4SStefano Zampini 32395efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 32405efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3241ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestep),(ts)); 32425efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3243dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3244312ce896SJed Brown } 32453f2090d5SJed Brown PetscFunctionReturn(0); 32463f2090d5SJed Brown } 32473f2090d5SJed Brown 3248b8123daeSJed Brown /*@C 3249b8123daeSJed Brown TSSetPreStage - Sets the general-purpose function 3250b8123daeSJed Brown called once at the beginning of each stage. 3251b8123daeSJed Brown 3252b8123daeSJed Brown Logically Collective on TS 3253b8123daeSJed Brown 3254b8123daeSJed Brown Input Parameters: 3255b8123daeSJed Brown + ts - The TS context obtained from TSCreate() 3256b8123daeSJed Brown - func - The function 3257b8123daeSJed Brown 3258b8123daeSJed Brown Calling sequence of func: 3259b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime); 3260b8123daeSJed Brown 3261b8123daeSJed Brown Level: intermediate 3262b8123daeSJed Brown 3263b8123daeSJed Brown Note: 3264b8123daeSJed Brown There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 326580275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 3266b8123daeSJed Brown attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 3267b8123daeSJed Brown 32689be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3269b8123daeSJed Brown @*/ 3270b8123daeSJed Brown PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal)) 3271b8123daeSJed Brown { 3272b8123daeSJed Brown PetscFunctionBegin; 3273b8123daeSJed Brown PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3274ae60f76fSBarry Smith ts->prestage = func; 3275b8123daeSJed Brown PetscFunctionReturn(0); 3276b8123daeSJed Brown } 3277b8123daeSJed Brown 32789be3e283SDebojyoti Ghosh /*@C 32799be3e283SDebojyoti Ghosh TSSetPostStage - Sets the general-purpose function 32809be3e283SDebojyoti Ghosh called once at the end of each stage. 32819be3e283SDebojyoti Ghosh 32829be3e283SDebojyoti Ghosh Logically Collective on TS 32839be3e283SDebojyoti Ghosh 32849be3e283SDebojyoti Ghosh Input Parameters: 32859be3e283SDebojyoti Ghosh + ts - The TS context obtained from TSCreate() 32869be3e283SDebojyoti Ghosh - func - The function 32879be3e283SDebojyoti Ghosh 32889be3e283SDebojyoti Ghosh Calling sequence of func: 32899be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y); 32909be3e283SDebojyoti Ghosh 32919be3e283SDebojyoti Ghosh Level: intermediate 32929be3e283SDebojyoti Ghosh 32939be3e283SDebojyoti Ghosh Note: 32949be3e283SDebojyoti Ghosh There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 329580275a0aSLisandro Dalcin The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being 32969be3e283SDebojyoti Ghosh attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime(). 32979be3e283SDebojyoti Ghosh 32989be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 32999be3e283SDebojyoti Ghosh @*/ 33009be3e283SDebojyoti Ghosh PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*)) 33019be3e283SDebojyoti Ghosh { 33029be3e283SDebojyoti Ghosh PetscFunctionBegin; 33039be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts, TS_CLASSID,1); 33049be3e283SDebojyoti Ghosh ts->poststage = func; 33059be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33069be3e283SDebojyoti Ghosh } 33079be3e283SDebojyoti Ghosh 3308c688d042SShri Abhyankar /*@C 3309c688d042SShri Abhyankar TSSetPostEvaluate - Sets the general-purpose function 3310c688d042SShri Abhyankar called once at the end of each step evaluation. 3311c688d042SShri Abhyankar 3312c688d042SShri Abhyankar Logically Collective on TS 3313c688d042SShri Abhyankar 3314c688d042SShri Abhyankar Input Parameters: 3315c688d042SShri Abhyankar + ts - The TS context obtained from TSCreate() 3316c688d042SShri Abhyankar - func - The function 3317c688d042SShri Abhyankar 3318c688d042SShri Abhyankar Calling sequence of func: 3319c688d042SShri Abhyankar . PetscErrorCode func(TS ts); 3320c688d042SShri Abhyankar 3321c688d042SShri Abhyankar Level: intermediate 3322c688d042SShri Abhyankar 3323c688d042SShri Abhyankar Note: 33241785ff2aSShri Abhyankar Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling 33251785ff2aSShri Abhyankar thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep() 3326e7e94ed4SShri Abhyankar may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step 3327e7e94ed4SShri Abhyankar solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step 3328e7e94ed4SShri Abhyankar with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime() 3329c688d042SShri Abhyankar 3330c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext() 3331c688d042SShri Abhyankar @*/ 3332c688d042SShri Abhyankar PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS)) 3333c688d042SShri Abhyankar { 3334c688d042SShri Abhyankar PetscFunctionBegin; 3335c688d042SShri Abhyankar PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3336c688d042SShri Abhyankar ts->postevaluate = func; 3337c688d042SShri Abhyankar PetscFunctionReturn(0); 3338c688d042SShri Abhyankar } 3339c688d042SShri Abhyankar 3340b8123daeSJed Brown /*@ 3341b8123daeSJed Brown TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage() 3342b8123daeSJed Brown 3343b8123daeSJed Brown Collective on TS 3344b8123daeSJed Brown 3345b8123daeSJed Brown Input Parameters: 3346b8123daeSJed Brown . ts - The TS context obtained from TSCreate() 33479be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 3348b8123daeSJed Brown 3349b8123daeSJed Brown Notes: 3350b8123daeSJed Brown TSPreStage() is typically used within time stepping implementations, 3351b8123daeSJed Brown most users would not generally call this routine themselves. 3352b8123daeSJed Brown 3353b8123daeSJed Brown Level: developer 3354b8123daeSJed Brown 33559be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 3356b8123daeSJed Brown @*/ 3357b8123daeSJed Brown PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3358b8123daeSJed Brown { 3359b8123daeSJed Brown PetscFunctionBegin; 3360b8123daeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3361ae60f76fSBarry Smith if (ts->prestage) { 3362ae60f76fSBarry Smith PetscStackCallStandard((*ts->prestage),(ts,stagetime)); 3363b8123daeSJed Brown } 3364b8123daeSJed Brown PetscFunctionReturn(0); 3365b8123daeSJed Brown } 3366b8123daeSJed Brown 33679be3e283SDebojyoti Ghosh /*@ 33689be3e283SDebojyoti Ghosh TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage() 33699be3e283SDebojyoti Ghosh 33709be3e283SDebojyoti Ghosh Collective on TS 33719be3e283SDebojyoti Ghosh 33729be3e283SDebojyoti Ghosh Input Parameters: 33739be3e283SDebojyoti Ghosh . ts - The TS context obtained from TSCreate() 33749be3e283SDebojyoti Ghosh stagetime - The absolute time of the current stage 33759be3e283SDebojyoti Ghosh stageindex - Stage number 33769be3e283SDebojyoti Ghosh Y - Array of vectors (of size = total number 33779be3e283SDebojyoti Ghosh of stages) with the stage solutions 33789be3e283SDebojyoti Ghosh 33799be3e283SDebojyoti Ghosh Notes: 33809be3e283SDebojyoti Ghosh TSPostStage() is typically used within time stepping implementations, 33819be3e283SDebojyoti Ghosh most users would not generally call this routine themselves. 33829be3e283SDebojyoti Ghosh 33839be3e283SDebojyoti Ghosh Level: developer 33849be3e283SDebojyoti Ghosh 33859be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep() 33869be3e283SDebojyoti Ghosh @*/ 33879be3e283SDebojyoti Ghosh PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 33889be3e283SDebojyoti Ghosh { 33899be3e283SDebojyoti Ghosh PetscFunctionBegin; 33909be3e283SDebojyoti Ghosh PetscValidHeaderSpecific(ts,TS_CLASSID,1); 33914beae5d8SLisandro Dalcin if (ts->poststage) { 33929be3e283SDebojyoti Ghosh PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y)); 33939be3e283SDebojyoti Ghosh } 33949be3e283SDebojyoti Ghosh PetscFunctionReturn(0); 33959be3e283SDebojyoti Ghosh } 33969be3e283SDebojyoti Ghosh 3397c688d042SShri Abhyankar /*@ 3398c688d042SShri Abhyankar TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate() 3399c688d042SShri Abhyankar 3400c688d042SShri Abhyankar Collective on TS 3401c688d042SShri Abhyankar 3402c688d042SShri Abhyankar Input Parameters: 3403c688d042SShri Abhyankar . ts - The TS context obtained from TSCreate() 3404c688d042SShri Abhyankar 3405c688d042SShri Abhyankar Notes: 3406c688d042SShri Abhyankar TSPostEvaluate() is typically used within time stepping implementations, 3407c688d042SShri Abhyankar most users would not generally call this routine themselves. 3408c688d042SShri Abhyankar 3409c688d042SShri Abhyankar Level: developer 3410c688d042SShri Abhyankar 3411c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep() 3412c688d042SShri Abhyankar @*/ 3413c688d042SShri Abhyankar PetscErrorCode TSPostEvaluate(TS ts) 3414c688d042SShri Abhyankar { 3415c688d042SShri Abhyankar PetscErrorCode ierr; 3416c688d042SShri Abhyankar 3417c688d042SShri Abhyankar PetscFunctionBegin; 3418c688d042SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3419c688d042SShri Abhyankar if (ts->postevaluate) { 3420dcb233daSLisandro Dalcin Vec U; 3421dcb233daSLisandro Dalcin PetscObjectState sprev,spost; 3422dcb233daSLisandro Dalcin 3423dcb233daSLisandro Dalcin ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 3424dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3425c688d042SShri Abhyankar PetscStackCallStandard((*ts->postevaluate),(ts)); 3426dcb233daSLisandro Dalcin ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3427dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 3428c688d042SShri Abhyankar } 3429c688d042SShri Abhyankar PetscFunctionReturn(0); 3430c688d042SShri Abhyankar } 3431c688d042SShri Abhyankar 3432ac226902SBarry Smith /*@C 3433000e7ae3SMatthew Knepley TSSetPostStep - Sets the general-purpose function 34343f2090d5SJed Brown called once at the end of each time step. 3435000e7ae3SMatthew Knepley 34363f9fe445SBarry Smith Logically Collective on TS 3437000e7ae3SMatthew Knepley 3438000e7ae3SMatthew Knepley Input Parameters: 3439000e7ae3SMatthew Knepley + ts - The TS context obtained from TSCreate() 3440000e7ae3SMatthew Knepley - func - The function 3441000e7ae3SMatthew Knepley 3442000e7ae3SMatthew Knepley Calling sequence of func: 3443b8123daeSJed Brown $ func (TS ts); 3444000e7ae3SMatthew Knepley 34451785ff2aSShri Abhyankar Notes: 34461785ff2aSShri Abhyankar The function set by TSSetPostStep() is called after each successful step. The solution vector X 34471785ff2aSShri Abhyankar obtained by TSGetSolution() may be different than that computed at the step end if the event handler 34481785ff2aSShri Abhyankar locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead. 34491785ff2aSShri Abhyankar 3450000e7ae3SMatthew Knepley Level: intermediate 3451000e7ae3SMatthew Knepley 3452dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep() 3453000e7ae3SMatthew Knepley @*/ 34547087cfbeSBarry Smith PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS)) 3455000e7ae3SMatthew Knepley { 3456000e7ae3SMatthew Knepley PetscFunctionBegin; 34570700a824SBarry Smith PetscValidHeaderSpecific(ts, TS_CLASSID,1); 3458ae60f76fSBarry Smith ts->poststep = func; 3459000e7ae3SMatthew Knepley PetscFunctionReturn(0); 3460000e7ae3SMatthew Knepley } 3461000e7ae3SMatthew Knepley 346209ee8438SJed Brown /*@ 34633f2090d5SJed Brown TSPostStep - Runs the user-defined post-step function. 34643f2090d5SJed Brown 34653f2090d5SJed Brown Collective on TS 34663f2090d5SJed Brown 34673f2090d5SJed Brown Input Parameters: 34683f2090d5SJed Brown . ts - The TS context obtained from TSCreate() 34693f2090d5SJed Brown 34703f2090d5SJed Brown Notes: 34713f2090d5SJed Brown TSPostStep() is typically used within time stepping implementations, 34723f2090d5SJed Brown so most users would not generally call this routine themselves. 34733f2090d5SJed Brown 34743f2090d5SJed Brown Level: developer 34753f2090d5SJed Brown 34763f2090d5SJed Brown @*/ 34777087cfbeSBarry Smith PetscErrorCode TSPostStep(TS ts) 34783f2090d5SJed Brown { 34793f2090d5SJed Brown PetscErrorCode ierr; 34803f2090d5SJed Brown 34813f2090d5SJed Brown PetscFunctionBegin; 34820700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3483ae60f76fSBarry Smith if (ts->poststep) { 34845efd42a4SStefano Zampini Vec U; 34855efd42a4SStefano Zampini PetscObjectState sprev,spost; 34865efd42a4SStefano Zampini 34875efd42a4SStefano Zampini ierr = TSGetSolution(ts,&U);CHKERRQ(ierr); 34885efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr); 3489ae60f76fSBarry Smith PetscStackCallStandard((*ts->poststep),(ts)); 34905efd42a4SStefano Zampini ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr); 3491dcb233daSLisandro Dalcin if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);} 349272ac3e02SJed Brown } 34933f2090d5SJed Brown PetscFunctionReturn(0); 34943f2090d5SJed Brown } 34953f2090d5SJed Brown 3496d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 3497d763cef2SBarry Smith 3498d763cef2SBarry Smith /*@C 3499a6570f20SBarry Smith TSMonitorSet - Sets an ADDITIONAL function that is to be used at every 3500d763cef2SBarry Smith timestep to display the iteration's progress. 3501d763cef2SBarry Smith 35023f9fe445SBarry Smith Logically Collective on TS 3503d763cef2SBarry Smith 3504d763cef2SBarry Smith Input Parameters: 3505d763cef2SBarry Smith + ts - the TS context obtained from TSCreate() 3506e213d8f1SJed Brown . monitor - monitoring routine 3507329f5518SBarry Smith . mctx - [optional] user-defined context for private data for the 35080298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3509b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 35100298fd71SBarry Smith (may be NULL) 3511d763cef2SBarry Smith 3512e213d8f1SJed Brown Calling sequence of monitor: 3513dcb233daSLisandro Dalcin $ PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx) 3514d763cef2SBarry Smith 3515d763cef2SBarry Smith + ts - the TS context 351663e21af5SBarry 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) 35171f06c33eSBarry Smith . time - current time 35180910c330SBarry Smith . u - current iterate 3519d763cef2SBarry Smith - mctx - [optional] monitoring context 3520d763cef2SBarry Smith 3521d763cef2SBarry Smith Notes: 3522d763cef2SBarry Smith This routine adds an additional monitor to the list of monitors that 3523d763cef2SBarry Smith already has been loaded. 3524d763cef2SBarry Smith 352595452b02SPatrick Sanan Fortran Notes: 352695452b02SPatrick Sanan Only a single monitor function can be set for each TS object 3527025f1a04SBarry Smith 3528d763cef2SBarry Smith Level: intermediate 3529d763cef2SBarry Smith 3530a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel() 3531d763cef2SBarry Smith @*/ 3532c2efdce3SBarry Smith PetscErrorCode TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**)) 3533d763cef2SBarry Smith { 353478064530SBarry Smith PetscErrorCode ierr; 353578064530SBarry Smith PetscInt i; 353678064530SBarry Smith PetscBool identical; 353778064530SBarry Smith 3538d763cef2SBarry Smith PetscFunctionBegin; 35390700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 354078064530SBarry Smith for (i=0; i<ts->numbermonitors;i++) { 354178064530SBarry Smith ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr); 354278064530SBarry Smith if (identical) PetscFunctionReturn(0); 354378064530SBarry Smith } 354417186662SBarry Smith if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3545d763cef2SBarry Smith ts->monitor[ts->numbermonitors] = monitor; 35468704b422SBarry Smith ts->monitordestroy[ts->numbermonitors] = mdestroy; 3547d763cef2SBarry Smith ts->monitorcontext[ts->numbermonitors++] = (void*)mctx; 3548d763cef2SBarry Smith PetscFunctionReturn(0); 3549d763cef2SBarry Smith } 3550d763cef2SBarry Smith 3551d763cef2SBarry Smith /*@C 3552a6570f20SBarry Smith TSMonitorCancel - Clears all the monitors that have been set on a time-step object. 3553d763cef2SBarry Smith 35543f9fe445SBarry Smith Logically Collective on TS 3555d763cef2SBarry Smith 3556d763cef2SBarry Smith Input Parameters: 3557d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3558d763cef2SBarry Smith 3559d763cef2SBarry Smith Notes: 3560d763cef2SBarry Smith There is no way to remove a single, specific monitor. 3561d763cef2SBarry Smith 3562d763cef2SBarry Smith Level: intermediate 3563d763cef2SBarry Smith 3564a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet() 3565d763cef2SBarry Smith @*/ 35667087cfbeSBarry Smith PetscErrorCode TSMonitorCancel(TS ts) 3567d763cef2SBarry Smith { 3568d952e501SBarry Smith PetscErrorCode ierr; 3569d952e501SBarry Smith PetscInt i; 3570d952e501SBarry Smith 3571d763cef2SBarry Smith PetscFunctionBegin; 35720700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3573d952e501SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 35748704b422SBarry Smith if (ts->monitordestroy[i]) { 35758704b422SBarry Smith ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr); 3576d952e501SBarry Smith } 3577d952e501SBarry Smith } 3578d763cef2SBarry Smith ts->numbermonitors = 0; 3579d763cef2SBarry Smith PetscFunctionReturn(0); 3580d763cef2SBarry Smith } 3581d763cef2SBarry Smith 3582721cd6eeSBarry Smith /*@C 3583721cd6eeSBarry Smith TSMonitorDefault - The Default monitor, prints the timestep and time for each step 35845516499fSSatish Balay 35855516499fSSatish Balay Level: intermediate 358641251cbbSSatish Balay 358763e21af5SBarry Smith .seealso: TSMonitorSet() 358841251cbbSSatish Balay @*/ 3589721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3590d763cef2SBarry Smith { 3591dfbe8321SBarry Smith PetscErrorCode ierr; 3592721cd6eeSBarry Smith PetscViewer viewer = vf->viewer; 359341aca3d6SBarry Smith PetscBool iascii,ibinary; 3594d132466eSBarry Smith 3595d763cef2SBarry Smith PetscFunctionBegin; 35964d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 359741aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 359841aca3d6SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr); 3599721cd6eeSBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 360041aca3d6SBarry Smith if (iascii) { 3601649052a6SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 360263e21af5SBarry Smith if (step == -1){ /* this indicates it is an interpolated solution */ 360363e21af5SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr); 360463e21af5SBarry Smith } else { 36058392e04aSShri 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); 360663e21af5SBarry Smith } 3607649052a6SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 360841aca3d6SBarry Smith } else if (ibinary) { 360941aca3d6SBarry Smith PetscMPIInt rank; 361041aca3d6SBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr); 361141aca3d6SBarry Smith if (!rank) { 3612450a797fSBarry Smith PetscBool skipHeader; 3613450a797fSBarry Smith PetscInt classid = REAL_FILE_CLASSID; 3614450a797fSBarry Smith 3615450a797fSBarry Smith ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr); 3616450a797fSBarry Smith if (!skipHeader) { 3617f253e43cSLisandro Dalcin ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 3618450a797fSBarry Smith } 361941aca3d6SBarry Smith ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr); 362041aca3d6SBarry Smith } else { 362141aca3d6SBarry Smith ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr); 362241aca3d6SBarry Smith } 362341aca3d6SBarry Smith } 3624721cd6eeSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3625d763cef2SBarry Smith PetscFunctionReturn(0); 3626d763cef2SBarry Smith } 3627d763cef2SBarry Smith 3628cc9c3a59SBarry Smith /*@C 3629cc9c3a59SBarry Smith TSMonitorExtreme - Prints the extreme values of the solution at each timestep 3630cc9c3a59SBarry Smith 3631cc9c3a59SBarry Smith Level: intermediate 3632cc9c3a59SBarry Smith 3633cc9c3a59SBarry Smith .seealso: TSMonitorSet() 3634cc9c3a59SBarry Smith @*/ 3635cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf) 3636cc9c3a59SBarry Smith { 3637cc9c3a59SBarry Smith PetscErrorCode ierr; 3638cc9c3a59SBarry Smith PetscViewer viewer = vf->viewer; 3639cc9c3a59SBarry Smith PetscBool iascii; 3640cc9c3a59SBarry Smith PetscReal max,min; 3641cc9c3a59SBarry Smith 3642cc9c3a59SBarry Smith 3643cc9c3a59SBarry Smith PetscFunctionBegin; 3644cc9c3a59SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4); 3645cc9c3a59SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 3646cc9c3a59SBarry Smith ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr); 3647cc9c3a59SBarry Smith if (iascii) { 3648cc9c3a59SBarry Smith ierr = VecMax(v,NULL,&max);CHKERRQ(ierr); 3649cc9c3a59SBarry Smith ierr = VecMin(v,NULL,&min);CHKERRQ(ierr); 3650cc9c3a59SBarry Smith ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 36515132926bSBarry 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); 3652cc9c3a59SBarry Smith ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr); 3653cc9c3a59SBarry Smith } 3654cc9c3a59SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3655cc9c3a59SBarry Smith PetscFunctionReturn(0); 3656cc9c3a59SBarry Smith } 3657cc9c3a59SBarry Smith 3658cd652676SJed Brown /*@ 3659cd652676SJed Brown TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3660cd652676SJed Brown 3661cd652676SJed Brown Collective on TS 3662cd652676SJed Brown 3663cd652676SJed Brown Input Argument: 3664cd652676SJed Brown + ts - time stepping context 3665cd652676SJed Brown - t - time to interpolate to 3666cd652676SJed Brown 3667cd652676SJed Brown Output Argument: 36680910c330SBarry Smith . U - state at given time 3669cd652676SJed Brown 3670cd652676SJed Brown Level: intermediate 3671cd652676SJed Brown 3672cd652676SJed Brown Developer Notes: 3673cd652676SJed Brown TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3674cd652676SJed Brown 3675874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve() 3676cd652676SJed Brown @*/ 36770910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U) 3678cd652676SJed Brown { 3679cd652676SJed Brown PetscErrorCode ierr; 3680cd652676SJed Brown 3681cd652676SJed Brown PetscFunctionBegin; 3682cd652676SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3683b06615a5SLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3684be5899b3SLisandro 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); 3685ce94432eSBarry Smith if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name); 36860910c330SBarry Smith ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr); 3687cd652676SJed Brown PetscFunctionReturn(0); 3688cd652676SJed Brown } 3689cd652676SJed Brown 3690d763cef2SBarry Smith /*@ 36916d9e5789SSean Farley TSStep - Steps one time step 3692d763cef2SBarry Smith 3693d763cef2SBarry Smith Collective on TS 3694d763cef2SBarry Smith 3695d763cef2SBarry Smith Input Parameter: 3696d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 3697d763cef2SBarry Smith 369827829d71SBarry Smith Level: developer 3699d763cef2SBarry Smith 3700b8123daeSJed Brown Notes: 370127829d71SBarry Smith The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine. 370227829d71SBarry Smith 3703b8123daeSJed Brown The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may 3704b8123daeSJed Brown be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3705b8123daeSJed Brown 370619eac22cSLisandro Dalcin This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the 370719eac22cSLisandro Dalcin time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep. 370825cb2221SBarry Smith 37099be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate() 3710d763cef2SBarry Smith @*/ 3711193ac0bcSJed Brown PetscErrorCode TSStep(TS ts) 3712d763cef2SBarry Smith { 3713dfbe8321SBarry Smith PetscErrorCode ierr; 3714fffbeea8SBarry Smith static PetscBool cite = PETSC_FALSE; 3715be5899b3SLisandro Dalcin PetscReal ptime; 3716d763cef2SBarry Smith 3717d763cef2SBarry Smith PetscFunctionBegin; 37180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 3719f1d62c27SHong Zhang ierr = PetscCitationsRegister("@article{tspaper,\n" 3720fffbeea8SBarry Smith " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3721f1d62c27SHong Zhang " author = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n" 3722f1d62c27SHong Zhang " journal = {arXiv e-preprints},\n" 3723f1d62c27SHong Zhang " eprint = {1806.01437},\n" 3724f1d62c27SHong Zhang " archivePrefix = {arXiv},\n" 3725f1d62c27SHong Zhang " year = {2018}\n}\n",&cite);CHKERRQ(ierr); 3726fffbeea8SBarry Smith 3727d405a339SMatthew Knepley ierr = TSSetUp(ts);CHKERRQ(ierr); 372868bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 3729d405a339SMatthew Knepley 3730fc8dbba5SLisandro Dalcin if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name); 3731ef85077eSLisandro 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>"); 3732a6772fa2SLisandro 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()"); 3733be5899b3SLisandro 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"); 3734a6772fa2SLisandro Dalcin 3735be5899b3SLisandro Dalcin if (!ts->steps) ts->ptime_prev = ts->ptime; 3736be5899b3SLisandro Dalcin ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev; 37372808aa04SLisandro Dalcin ts->reason = TS_CONVERGED_ITERATING; 3738fc8dbba5SLisandro Dalcin 3739d5ba7fb7SMatthew Knepley ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3740193ac0bcSJed Brown ierr = (*ts->ops->step)(ts);CHKERRQ(ierr); 3741d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr); 3742fc8dbba5SLisandro Dalcin 3743fc8dbba5SLisandro Dalcin if (ts->reason >= 0) { 3744be5899b3SLisandro Dalcin ts->ptime_prev = ptime; 37452808aa04SLisandro Dalcin ts->steps++; 3746be5899b3SLisandro Dalcin ts->steprollback = PETSC_FALSE; 374728d5b5d6SLisandro Dalcin ts->steprestart = PETSC_FALSE; 3748d2daff3dSHong Zhang } 3749fc8dbba5SLisandro Dalcin 3750fc8dbba5SLisandro Dalcin if (!ts->reason) { 375108c7845fSBarry Smith if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 375208c7845fSBarry Smith else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 375308c7845fSBarry Smith } 3754fc8dbba5SLisandro Dalcin 3755fc8dbba5SLisandro Dalcin if (ts->reason < 0 && ts->errorifstepfailed && 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]); 3756fc8dbba5SLisandro Dalcin if (ts->reason < 0 && ts->errorifstepfailed) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]); 375708c7845fSBarry Smith PetscFunctionReturn(0); 375808c7845fSBarry Smith } 375908c7845fSBarry Smith 376008c7845fSBarry Smith /*@ 37617cbde773SLisandro Dalcin TSEvaluateWLTE - Evaluate the weighted local truncation error norm 37627cbde773SLisandro Dalcin at the end of a time step with a given order of accuracy. 37637cbde773SLisandro Dalcin 37647cbde773SLisandro Dalcin Collective on TS 37657cbde773SLisandro Dalcin 37667cbde773SLisandro Dalcin Input Arguments: 37677cbde773SLisandro Dalcin + ts - time stepping context 37687cbde773SLisandro Dalcin . wnormtype - norm type, either NORM_2 or NORM_INFINITY 37697cbde773SLisandro Dalcin - order - optional, desired order for the error evaluation or PETSC_DECIDE 37707cbde773SLisandro Dalcin 37717cbde773SLisandro Dalcin Output Arguments: 37727cbde773SLisandro Dalcin + order - optional, the actual order of the error evaluation 37737cbde773SLisandro Dalcin - wlte - the weighted local truncation error norm 37747cbde773SLisandro Dalcin 37757cbde773SLisandro Dalcin Level: advanced 37767cbde773SLisandro Dalcin 37777cbde773SLisandro Dalcin Notes: 37787cbde773SLisandro Dalcin If the timestepper cannot evaluate the error in a particular step 37797cbde773SLisandro Dalcin (eg. in the first step or restart steps after event handling), 37807cbde773SLisandro Dalcin this routine returns wlte=-1.0 . 37817cbde773SLisandro Dalcin 37827cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm() 37837cbde773SLisandro Dalcin @*/ 37847cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte) 37857cbde773SLisandro Dalcin { 37867cbde773SLisandro Dalcin PetscErrorCode ierr; 37877cbde773SLisandro Dalcin 37887cbde773SLisandro Dalcin PetscFunctionBegin; 37897cbde773SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 37907cbde773SLisandro Dalcin PetscValidType(ts,1); 37917cbde773SLisandro Dalcin PetscValidLogicalCollectiveEnum(ts,wnormtype,4); 37927cbde773SLisandro Dalcin if (order) PetscValidIntPointer(order,3); 37937cbde773SLisandro Dalcin if (order) PetscValidLogicalCollectiveInt(ts,*order,3); 37947cbde773SLisandro Dalcin PetscValidRealPointer(wlte,4); 37957cbde773SLisandro Dalcin if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 37967cbde773SLisandro Dalcin if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name); 37977cbde773SLisandro Dalcin ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr); 37987cbde773SLisandro Dalcin PetscFunctionReturn(0); 37997cbde773SLisandro Dalcin } 38007cbde773SLisandro Dalcin 380105175c85SJed Brown /*@ 380205175c85SJed Brown TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 380305175c85SJed Brown 38041c3436cfSJed Brown Collective on TS 380505175c85SJed Brown 380605175c85SJed Brown Input Arguments: 38071c3436cfSJed Brown + ts - time stepping context 38081c3436cfSJed Brown . order - desired order of accuracy 38090298fd71SBarry Smith - done - whether the step was evaluated at this order (pass NULL to generate an error if not available) 381005175c85SJed Brown 381105175c85SJed Brown Output Arguments: 38120910c330SBarry Smith . U - state at the end of the current step 381305175c85SJed Brown 381405175c85SJed Brown Level: advanced 381505175c85SJed Brown 3816108c343cSJed Brown Notes: 3817108c343cSJed Brown This function cannot be called until all stages have been evaluated. 3818108c343cSJed 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. 3819108c343cSJed Brown 38201c3436cfSJed Brown .seealso: TSStep(), TSAdapt 382105175c85SJed Brown @*/ 38220910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done) 382305175c85SJed Brown { 382405175c85SJed Brown PetscErrorCode ierr; 382505175c85SJed Brown 382605175c85SJed Brown PetscFunctionBegin; 382705175c85SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 382805175c85SJed Brown PetscValidType(ts,1); 38290910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,3); 3830ce94432eSBarry Smith if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name); 38310910c330SBarry Smith ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr); 383205175c85SJed Brown PetscFunctionReturn(0); 383305175c85SJed Brown } 383405175c85SJed Brown 3835aad739acSMatthew G. Knepley /*@C 38362e61be88SMatthew G. Knepley TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping. 3837aad739acSMatthew G. Knepley 3838aad739acSMatthew G. Knepley Not collective 3839aad739acSMatthew G. Knepley 3840aad739acSMatthew G. Knepley Input Argument: 3841aad739acSMatthew G. Knepley . ts - time stepping context 3842aad739acSMatthew G. Knepley 3843aad739acSMatthew G. Knepley Output Argument: 38442e61be88SMatthew G. Knepley . initConditions - The function which computes an initial condition 3845aad739acSMatthew G. Knepley 3846aad739acSMatthew G. Knepley Level: advanced 3847aad739acSMatthew G. Knepley 3848aad739acSMatthew G. Knepley Notes: 3849aad739acSMatthew G. Knepley The calling sequence for the function is 38502e61be88SMatthew G. Knepley $ initCondition(TS ts, Vec u) 3851aad739acSMatthew G. Knepley $ ts - The timestepping context 38522e61be88SMatthew G. Knepley $ u - The input vector in which the initial condition is stored 3853aad739acSMatthew G. Knepley 38542e61be88SMatthew G. Knepley .seealso: TSSetComputeInitialCondition(), TSComputeInitialCondition() 3855aad739acSMatthew G. Knepley @*/ 38562e61be88SMatthew G. Knepley PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS, Vec)) 3857aad739acSMatthew G. Knepley { 3858aad739acSMatthew G. Knepley PetscFunctionBegin; 3859aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 38602e61be88SMatthew G. Knepley PetscValidPointer(initCondition, 2); 38612e61be88SMatthew G. Knepley *initCondition = ts->ops->initcondition; 3862aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3863aad739acSMatthew G. Knepley } 3864aad739acSMatthew G. Knepley 3865aad739acSMatthew G. Knepley /*@C 38662e61be88SMatthew G. Knepley TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping. 3867aad739acSMatthew G. Knepley 3868aad739acSMatthew G. Knepley Logically collective on ts 3869aad739acSMatthew G. Knepley 3870aad739acSMatthew G. Knepley Input Arguments: 3871aad739acSMatthew G. Knepley + ts - time stepping context 38722e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition 3873aad739acSMatthew G. Knepley 3874aad739acSMatthew G. Knepley Level: advanced 3875aad739acSMatthew G. Knepley 3876a96d6ef6SBarry Smith Calling sequence for initCondition: 3877a96d6ef6SBarry Smith $ PetscErrorCode initCondition(TS ts, Vec u) 3878a96d6ef6SBarry Smith 3879a96d6ef6SBarry Smith + ts - The timestepping context 3880a96d6ef6SBarry Smith - u - The input vector in which the initial condition is to be stored 3881aad739acSMatthew G. Knepley 38822e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSComputeInitialCondition() 3883aad739acSMatthew G. Knepley @*/ 38842e61be88SMatthew G. Knepley PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS, Vec)) 3885aad739acSMatthew G. Knepley { 3886aad739acSMatthew G. Knepley PetscFunctionBegin; 3887aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 38882e61be88SMatthew G. Knepley PetscValidFunction(initCondition, 2); 38892e61be88SMatthew G. Knepley ts->ops->initcondition = initCondition; 3890aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3891aad739acSMatthew G. Knepley } 3892aad739acSMatthew G. Knepley 3893aad739acSMatthew G. Knepley /*@ 38942e61be88SMatthew G. Knepley TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set. 3895aad739acSMatthew G. Knepley 3896aad739acSMatthew G. Knepley Collective on ts 3897aad739acSMatthew G. Knepley 3898aad739acSMatthew G. Knepley Input Arguments: 3899aad739acSMatthew G. Knepley + ts - time stepping context 39002e61be88SMatthew G. Knepley - u - The Vec to store the condition in which will be used in TSSolve() 3901aad739acSMatthew G. Knepley 3902aad739acSMatthew G. Knepley Level: advanced 3903aad739acSMatthew G. Knepley 39042e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve() 3905aad739acSMatthew G. Knepley @*/ 39062e61be88SMatthew G. Knepley PetscErrorCode TSComputeInitialCondition(TS ts, Vec u) 3907aad739acSMatthew G. Knepley { 3908aad739acSMatthew G. Knepley PetscErrorCode ierr; 3909aad739acSMatthew G. Knepley 3910aad739acSMatthew G. Knepley PetscFunctionBegin; 3911aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3912aad739acSMatthew G. Knepley PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 39132e61be88SMatthew G. Knepley if (ts->ops->initcondition) {ierr = (*ts->ops->initcondition)(ts, u);CHKERRQ(ierr);} 3914aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3915aad739acSMatthew G. Knepley } 3916aad739acSMatthew G. Knepley 3917aad739acSMatthew G. Knepley /*@C 3918aad739acSMatthew G. Knepley TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping. 3919aad739acSMatthew G. Knepley 3920aad739acSMatthew G. Knepley Not collective 3921aad739acSMatthew G. Knepley 3922aad739acSMatthew G. Knepley Input Argument: 3923aad739acSMatthew G. Knepley . ts - time stepping context 3924aad739acSMatthew G. Knepley 3925aad739acSMatthew G. Knepley Output Argument: 3926aad739acSMatthew G. Knepley . exactError - The function which computes the solution error 3927aad739acSMatthew G. Knepley 3928aad739acSMatthew G. Knepley Level: advanced 3929aad739acSMatthew G. Knepley 3930a96d6ef6SBarry Smith Calling sequence for exactError: 3931a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u) 3932a96d6ef6SBarry Smith 3933a96d6ef6SBarry Smith + ts - The timestepping context 3934a96d6ef6SBarry Smith . u - The approximate solution vector 3935a96d6ef6SBarry Smith - e - The input vector in which the error is stored 3936aad739acSMatthew G. Knepley 3937aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError() 3938aad739acSMatthew G. Knepley @*/ 3939aad739acSMatthew G. Knepley PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS, Vec, Vec)) 3940aad739acSMatthew G. Knepley { 3941aad739acSMatthew G. Knepley PetscFunctionBegin; 3942aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3943aad739acSMatthew G. Knepley PetscValidPointer(exactError, 2); 3944aad739acSMatthew G. Knepley *exactError = ts->ops->exacterror; 3945aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3946aad739acSMatthew G. Knepley } 3947aad739acSMatthew G. Knepley 3948aad739acSMatthew G. Knepley /*@C 3949aad739acSMatthew G. Knepley TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping. 3950aad739acSMatthew G. Knepley 3951aad739acSMatthew G. Knepley Logically collective on ts 3952aad739acSMatthew G. Knepley 3953aad739acSMatthew G. Knepley Input Arguments: 3954aad739acSMatthew G. Knepley + ts - time stepping context 3955aad739acSMatthew G. Knepley - exactError - The function which computes the solution error 3956aad739acSMatthew G. Knepley 3957aad739acSMatthew G. Knepley Level: advanced 3958aad739acSMatthew G. Knepley 3959a96d6ef6SBarry Smith Calling sequence for exactError: 3960a96d6ef6SBarry Smith $ PetscErrorCode exactError(TS ts, Vec u) 3961a96d6ef6SBarry Smith 3962a96d6ef6SBarry Smith + ts - The timestepping context 3963a96d6ef6SBarry Smith . u - The approximate solution vector 3964a96d6ef6SBarry Smith - e - The input vector in which the error is stored 3965aad739acSMatthew G. Knepley 3966aad739acSMatthew G. Knepley .seealso: TSGetComputeExactError(), TSComputeExactError() 3967aad739acSMatthew G. Knepley @*/ 3968aad739acSMatthew G. Knepley PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS, Vec, Vec)) 3969aad739acSMatthew G. Knepley { 3970aad739acSMatthew G. Knepley PetscFunctionBegin; 3971aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3972f907fdbfSMatthew G. Knepley PetscValidFunction(exactError, 2); 3973aad739acSMatthew G. Knepley ts->ops->exacterror = exactError; 3974aad739acSMatthew G. Knepley PetscFunctionReturn(0); 3975aad739acSMatthew G. Knepley } 3976aad739acSMatthew G. Knepley 3977aad739acSMatthew G. Knepley /*@ 3978aad739acSMatthew G. Knepley TSComputeExactError - Compute the solution error for the timestepping using the function previously set. 3979aad739acSMatthew G. Knepley 3980aad739acSMatthew G. Knepley Collective on ts 3981aad739acSMatthew G. Knepley 3982aad739acSMatthew G. Knepley Input Arguments: 3983aad739acSMatthew G. Knepley + ts - time stepping context 3984aad739acSMatthew G. Knepley . u - The approximate solution 3985aad739acSMatthew G. Knepley - e - The Vec used to store the error 3986aad739acSMatthew G. Knepley 3987aad739acSMatthew G. Knepley Level: advanced 3988aad739acSMatthew G. Knepley 39892e61be88SMatthew G. Knepley .seealso: TSGetComputeInitialCondition(), TSSetComputeInitialCondition(), TSSolve() 3990aad739acSMatthew G. Knepley @*/ 3991aad739acSMatthew G. Knepley PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e) 3992aad739acSMatthew G. Knepley { 3993aad739acSMatthew G. Knepley PetscErrorCode ierr; 3994aad739acSMatthew G. Knepley 3995aad739acSMatthew G. Knepley PetscFunctionBegin; 3996aad739acSMatthew G. Knepley PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3997aad739acSMatthew G. Knepley PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 3998aad739acSMatthew G. Knepley PetscValidHeaderSpecific(e, VEC_CLASSID, 3); 3999aad739acSMatthew G. Knepley if (ts->ops->exacterror) {ierr = (*ts->ops->exacterror)(ts, u, e);CHKERRQ(ierr);} 4000aad739acSMatthew G. Knepley PetscFunctionReturn(0); 4001aad739acSMatthew G. Knepley } 4002aad739acSMatthew G. Knepley 4003b1cb36f3SHong Zhang /*@ 40046a4d4014SLisandro Dalcin TSSolve - Steps the requested number of timesteps. 40056a4d4014SLisandro Dalcin 40066a4d4014SLisandro Dalcin Collective on TS 40076a4d4014SLisandro Dalcin 40086a4d4014SLisandro Dalcin Input Parameter: 40096a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 401063e21af5SBarry Smith - u - the solution vector (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used, 401163e21af5SBarry Smith otherwise must contain the initial conditions and will contain the solution at the final requested time 40125a3a76d0SJed Brown 40136a4d4014SLisandro Dalcin Level: beginner 40146a4d4014SLisandro Dalcin 40155a3a76d0SJed Brown Notes: 40165a3a76d0SJed Brown The final time returned by this function may be different from the time of the internally 40175a3a76d0SJed Brown held state accessible by TSGetSolution() and TSGetTime() because the method may have 40185a3a76d0SJed Brown stepped over the final time. 40195a3a76d0SJed Brown 402063e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime() 40216a4d4014SLisandro Dalcin @*/ 4022cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u) 40236a4d4014SLisandro Dalcin { 4024b06615a5SLisandro Dalcin Vec solution; 40256a4d4014SLisandro Dalcin PetscErrorCode ierr; 4026f22f69f0SBarry Smith 40276a4d4014SLisandro Dalcin PetscFunctionBegin; 40280700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4029f2c2a1b9SBarry Smith if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2); 4030303a5415SBarry Smith 4031303a5415SBarry Smith ierr = TSSetExactFinalTimeDefault(ts);CHKERRQ(ierr); 4032ee41a567SStefano 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 */ 40330910c330SBarry Smith if (!ts->vec_sol || u == ts->vec_sol) { 4034b06615a5SLisandro Dalcin ierr = VecDuplicate(u,&solution);CHKERRQ(ierr); 4035b06615a5SLisandro Dalcin ierr = TSSetSolution(ts,solution);CHKERRQ(ierr); 4036b06615a5SLisandro Dalcin ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */ 40375a3a76d0SJed Brown } 40380910c330SBarry Smith ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr); 4039715f1b00SHong Zhang if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 4040bbd56ea5SKarl Rupp } else if (u) { 40410910c330SBarry Smith ierr = TSSetSolution(ts,u);CHKERRQ(ierr); 40425a3a76d0SJed Brown } 4043b5d403baSSean Farley ierr = TSSetUp(ts);CHKERRQ(ierr); 404468bece0bSHong Zhang ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr); 4045a6772fa2SLisandro Dalcin 4046ef85077eSLisandro 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>"); 4047a6772fa2SLisandro 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()"); 4048a6772fa2SLisandro 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"); 4049a6772fa2SLisandro Dalcin 4050715f1b00SHong Zhang if (ts->forward_solve) { 4051715f1b00SHong Zhang ierr = TSForwardSetUp(ts);CHKERRQ(ierr); 4052715f1b00SHong Zhang } 4053715f1b00SHong Zhang 4054e7069c78SShri /* reset number of steps only when the step is not restarted. ARKIMEX 4055715f1b00SHong Zhang restarts the step after an event. Resetting these counters in such case causes 4056e7069c78SShri TSTrajectory to incorrectly save the output files 4057e7069c78SShri */ 4058715f1b00SHong Zhang /* reset time step and iteration counters */ 40592808aa04SLisandro Dalcin if (!ts->steps) { 40605ef26d82SJed Brown ts->ksp_its = 0; 40615ef26d82SJed Brown ts->snes_its = 0; 4062c610991cSLisandro Dalcin ts->num_snes_failures = 0; 4063c610991cSLisandro Dalcin ts->reject = 0; 40642808aa04SLisandro Dalcin ts->steprestart = PETSC_TRUE; 40652808aa04SLisandro Dalcin ts->steprollback = PETSC_FALSE; 40667d51462cSStefano Zampini ts->rhsjacobian.time = PETSC_MIN_REAL; 40672808aa04SLisandro Dalcin } 4068e97c63d7SStefano Zampini 4069e97c63d7SStefano Zampini /* make sure initial time step does not overshoot final time */ 4070e97c63d7SStefano Zampini if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) { 4071e97c63d7SStefano Zampini PetscReal maxdt = ts->max_time-ts->ptime; 4072e97c63d7SStefano Zampini PetscReal dt = ts->time_step; 4073e97c63d7SStefano Zampini 4074e97c63d7SStefano Zampini ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt,maxdt,10*PETSC_MACHINE_EPSILON,0) ? maxdt : dt); 4075e97c63d7SStefano Zampini } 4076193ac0bcSJed Brown ts->reason = TS_CONVERGED_ITERATING; 4077193ac0bcSJed Brown 4078900f6b5bSMatthew G. Knepley { 4079900f6b5bSMatthew G. Knepley PetscViewer viewer; 4080900f6b5bSMatthew G. Knepley PetscViewerFormat format; 4081900f6b5bSMatthew G. Knepley PetscBool flg; 4082900f6b5bSMatthew G. Knepley static PetscBool incall = PETSC_FALSE; 4083900f6b5bSMatthew G. Knepley 4084900f6b5bSMatthew G. Knepley if (!incall) { 4085900f6b5bSMatthew G. Knepley /* Estimate the convergence rate of the time discretization */ 4086900f6b5bSMatthew G. Knepley ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) ts),((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg);CHKERRQ(ierr); 4087900f6b5bSMatthew G. Knepley if (flg) { 4088900f6b5bSMatthew G. Knepley PetscConvEst conv; 4089900f6b5bSMatthew G. Knepley DM dm; 4090900f6b5bSMatthew G. Knepley PetscReal *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */ 4091900f6b5bSMatthew G. Knepley PetscInt Nf; 4092f2ed2dc7SMatthew G. Knepley PetscBool checkTemporal = PETSC_TRUE; 4093900f6b5bSMatthew G. Knepley 4094900f6b5bSMatthew G. Knepley incall = PETSC_TRUE; 4095f2ed2dc7SMatthew G. Knepley ierr = PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject) ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg);CHKERRQ(ierr); 4096900f6b5bSMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 4097900f6b5bSMatthew G. Knepley ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr); 4098900f6b5bSMatthew G. Knepley ierr = PetscCalloc1(PetscMax(Nf, 1), &alpha);CHKERRQ(ierr); 4099900f6b5bSMatthew G. Knepley ierr = PetscConvEstCreate(PetscObjectComm((PetscObject) ts), &conv);CHKERRQ(ierr); 4100f2ed2dc7SMatthew G. Knepley ierr = PetscConvEstUseTS(conv, checkTemporal);CHKERRQ(ierr); 4101900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetSolver(conv, (PetscObject) ts);CHKERRQ(ierr); 4102900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetFromOptions(conv);CHKERRQ(ierr); 4103900f6b5bSMatthew G. Knepley ierr = PetscConvEstSetUp(conv);CHKERRQ(ierr); 4104900f6b5bSMatthew G. Knepley ierr = PetscConvEstGetConvRate(conv, alpha);CHKERRQ(ierr); 4105900f6b5bSMatthew G. Knepley ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr); 4106900f6b5bSMatthew G. Knepley ierr = PetscConvEstRateView(conv, alpha, viewer);CHKERRQ(ierr); 4107900f6b5bSMatthew G. Knepley ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 4108900f6b5bSMatthew G. Knepley ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 4109900f6b5bSMatthew G. Knepley ierr = PetscConvEstDestroy(&conv);CHKERRQ(ierr); 4110900f6b5bSMatthew G. Knepley ierr = PetscFree(alpha);CHKERRQ(ierr); 4111900f6b5bSMatthew G. Knepley incall = PETSC_FALSE; 4112900f6b5bSMatthew G. Knepley } 4113900f6b5bSMatthew G. Knepley } 4114900f6b5bSMatthew G. Knepley } 4115900f6b5bSMatthew G. Knepley 4116ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr); 4117f05ece33SBarry Smith 4118193ac0bcSJed Brown if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4119193ac0bcSJed Brown ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr); 4120a6772fa2SLisandro Dalcin if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4121cc708dedSBarry Smith ts->solvetime = ts->ptime; 4122a6772fa2SLisandro Dalcin solution = ts->vec_sol; 4123be5899b3SLisandro Dalcin } else { /* Step the requested number of timesteps. */ 4124db4deed7SKarl Rupp if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4125db4deed7SKarl Rupp else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4126e7069c78SShri 41272808aa04SLisandro Dalcin if (!ts->steps) { 41282808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41296427ac75SLisandro Dalcin ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41302808aa04SLisandro Dalcin } 41316427ac75SLisandro Dalcin 4132e1a7a14fSJed Brown while (!ts->reason) { 41332808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41349687d888SLisandro Dalcin if (!ts->steprollback) { 41359687d888SLisandro Dalcin ierr = TSPreStep(ts);CHKERRQ(ierr); 41369687d888SLisandro Dalcin } 4137193ac0bcSJed Brown ierr = TSStep(ts);CHKERRQ(ierr); 4138f3b1f45cSBarry Smith if (ts->testjacobian) { 4139f3b1f45cSBarry Smith ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr); 4140f3b1f45cSBarry Smith } 4141f3b1f45cSBarry Smith if (ts->testjacobiantranspose) { 4142f3b1f45cSBarry Smith ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr); 4143f3b1f45cSBarry Smith } 4144cd4cee2dSHong Zhang if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 41457b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 4146b1cb36f3SHong Zhang ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr); 41477b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps++; 4148b1cb36f3SHong Zhang } 414958818c2dSLisandro Dalcin if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 41507b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 4151715f1b00SHong Zhang ierr = TSForwardStep(ts);CHKERRQ(ierr); 41527b0e2f17SHong Zhang if (ts->reason >= 0) ts->steps++; 4153715f1b00SHong Zhang } 415410b82f12SShri Abhyankar ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 4155e783b05fSHong 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. */ 415658818c2dSLisandro Dalcin if (ts->steprollback) { 415758818c2dSLisandro Dalcin ierr = TSPostEvaluate(ts);CHKERRQ(ierr); 415858818c2dSLisandro Dalcin } 4159e783b05fSHong Zhang if (!ts->steprollback) { 41602808aa04SLisandro Dalcin ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41611eda64f1SShri Abhyankar ierr = TSPostStep(ts);CHKERRQ(ierr); 4162aeb4809dSShri Abhyankar } 4163193ac0bcSJed Brown } 41642808aa04SLisandro Dalcin ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr); 41656427ac75SLisandro Dalcin 416649354f04SShri Abhyankar if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 41670910c330SBarry Smith ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr); 4168cc708dedSBarry Smith ts->solvetime = ts->max_time; 4169b06615a5SLisandro Dalcin solution = u; 417063e21af5SBarry Smith ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr); 41710574a7fbSJed Brown } else { 4172ad6bc421SBarry Smith if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);} 4173cc708dedSBarry Smith ts->solvetime = ts->ptime; 4174b06615a5SLisandro Dalcin solution = ts->vec_sol; 41750574a7fbSJed Brown } 4176193ac0bcSJed Brown } 4177d2daff3dSHong Zhang 4178ce1779c8SBarry Smith ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr); 417963e21af5SBarry Smith ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr); 418056f85f32SBarry Smith ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr); 4181ef222394SBarry Smith if (ts->adjoint_solve) { 4182ef222394SBarry Smith ierr = TSAdjointSolve(ts);CHKERRQ(ierr); 41832b0a91c0SBarry Smith } 41846a4d4014SLisandro Dalcin PetscFunctionReturn(0); 41856a4d4014SLisandro Dalcin } 41866a4d4014SLisandro Dalcin 41877db568b7SBarry Smith /*@C 4188228d79bcSJed Brown TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet() 4189228d79bcSJed Brown 4190228d79bcSJed Brown Collective on TS 4191228d79bcSJed Brown 4192228d79bcSJed Brown Input Parameters: 4193228d79bcSJed Brown + ts - time stepping context obtained from TSCreate() 4194228d79bcSJed Brown . step - step number that has just completed 4195228d79bcSJed Brown . ptime - model time of the state 41960910c330SBarry Smith - u - state at the current model time 4197228d79bcSJed Brown 4198228d79bcSJed Brown Notes: 41997db568b7SBarry Smith TSMonitor() is typically used automatically within the time stepping implementations. 42007db568b7SBarry Smith Users would almost never call this routine directly. 4201228d79bcSJed Brown 420263e21af5SBarry Smith A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions 420363e21af5SBarry Smith 42047db568b7SBarry Smith Level: developer 4205228d79bcSJed Brown 4206228d79bcSJed Brown @*/ 42070910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u) 4208d763cef2SBarry Smith { 4209d6152f81SLisandro Dalcin DM dm; 4210a7cc72afSBarry Smith PetscInt i,n = ts->numbermonitors; 4211d6152f81SLisandro Dalcin PetscErrorCode ierr; 4212d763cef2SBarry Smith 4213d763cef2SBarry Smith PetscFunctionBegin; 4214b06615a5SLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4215b06615a5SLisandro Dalcin PetscValidHeaderSpecific(u,VEC_CLASSID,4); 4216d6152f81SLisandro Dalcin 4217d6152f81SLisandro Dalcin ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 4218d6152f81SLisandro Dalcin ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr); 4219d6152f81SLisandro Dalcin 42208860a134SJunchao Zhang ierr = VecLockReadPush(u);CHKERRQ(ierr); 4221d763cef2SBarry Smith for (i=0; i<n; i++) { 42220910c330SBarry Smith ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr); 4223d763cef2SBarry Smith } 42248860a134SJunchao Zhang ierr = VecLockReadPop(u);CHKERRQ(ierr); 4225d763cef2SBarry Smith PetscFunctionReturn(0); 4226d763cef2SBarry Smith } 4227d763cef2SBarry Smith 4228d763cef2SBarry Smith /* ------------------------------------------------------------------------*/ 4229d763cef2SBarry Smith /*@C 42307db568b7SBarry Smith TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with 4231a9f9c1f6SBarry Smith TS to monitor the solution process graphically in various ways 4232d763cef2SBarry Smith 4233d763cef2SBarry Smith Collective on TS 4234d763cef2SBarry Smith 4235d763cef2SBarry Smith Input Parameters: 4236d763cef2SBarry Smith + host - the X display to open, or null for the local machine 4237d763cef2SBarry Smith . label - the title to put in the title bar 42387c922b88SBarry Smith . x, y - the screen coordinates of the upper left coordinate of the window 4239a9f9c1f6SBarry Smith . m, n - the screen width and height in pixels 4240a9f9c1f6SBarry Smith - howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time 4241d763cef2SBarry Smith 4242d763cef2SBarry Smith Output Parameter: 42430b039ecaSBarry Smith . ctx - the context 4244d763cef2SBarry Smith 4245d763cef2SBarry Smith Options Database Key: 42464f09c107SBarry Smith + -ts_monitor_lg_timestep - automatically sets line graph monitor 42478b668821SLisandro Dalcin + -ts_monitor_lg_timestep_log - automatically sets line graph monitor 42487db568b7SBarry Smith . -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables()) 42497db568b7SBarry Smith . -ts_monitor_lg_error - monitor the error 42507db568b7SBarry Smith . -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep 42517db568b7SBarry Smith . -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep 4252b6fe0379SLisandro Dalcin - -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true 4253d763cef2SBarry Smith 4254d763cef2SBarry Smith Notes: 4255a9f9c1f6SBarry Smith Use TSMonitorLGCtxDestroy() to destroy. 4256d763cef2SBarry Smith 42577db568b7SBarry Smith One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform() 42587db568b7SBarry Smith 42597db568b7SBarry 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 42607db568b7SBarry 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 42617db568b7SBarry Smith as the first argument. 42627db568b7SBarry Smith 42637db568b7SBarry Smith One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames() 42647db568b7SBarry Smith 4265d763cef2SBarry Smith Level: intermediate 4266d763cef2SBarry Smith 42677db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(), 42687db568b7SBarry Smith TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 42697db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 42707db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 42717db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 42727c922b88SBarry Smith 4273d763cef2SBarry Smith @*/ 4274a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx) 4275d763cef2SBarry Smith { 42767f52daa2SLisandro Dalcin PetscDraw draw; 4277dfbe8321SBarry Smith PetscErrorCode ierr; 4278d763cef2SBarry Smith 4279d763cef2SBarry Smith PetscFunctionBegin; 4280b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 42817f52daa2SLisandro Dalcin ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 42827f52daa2SLisandro Dalcin ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 42837f52daa2SLisandro Dalcin ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr); 4284287de1a7SBarry Smith ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr); 42857f52daa2SLisandro Dalcin ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 4286a9f9c1f6SBarry Smith (*ctx)->howoften = howoften; 4287d763cef2SBarry Smith PetscFunctionReturn(0); 4288d763cef2SBarry Smith } 4289d763cef2SBarry Smith 4290b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx) 4291d763cef2SBarry Smith { 42920b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 4293c32365f1SBarry Smith PetscReal x = ptime,y; 4294dfbe8321SBarry Smith PetscErrorCode ierr; 4295d763cef2SBarry Smith 4296d763cef2SBarry Smith PetscFunctionBegin; 429763e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */ 4298b06615a5SLisandro Dalcin if (!step) { 4299a9f9c1f6SBarry Smith PetscDrawAxis axis; 43008b668821SLisandro Dalcin const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step"; 4301a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 43028b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr); 4303a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 4304a9f9c1f6SBarry Smith } 4305c32365f1SBarry Smith ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr); 43068b668821SLisandro Dalcin if (ctx->semilogy) y = PetscLog10Real(y); 43070b039ecaSBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 4308b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 43090b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 43106934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 43113923b477SBarry Smith } 4312d763cef2SBarry Smith PetscFunctionReturn(0); 4313d763cef2SBarry Smith } 4314d763cef2SBarry Smith 4315d763cef2SBarry Smith /*@C 4316a9f9c1f6SBarry Smith TSMonitorLGCtxDestroy - Destroys a line graph context that was created 4317a9f9c1f6SBarry Smith with TSMonitorLGCtxCreate(). 4318d763cef2SBarry Smith 43190b039ecaSBarry Smith Collective on TSMonitorLGCtx 4320d763cef2SBarry Smith 4321d763cef2SBarry Smith Input Parameter: 43220b039ecaSBarry Smith . ctx - the monitor context 4323d763cef2SBarry Smith 4324d763cef2SBarry Smith Level: intermediate 4325d763cef2SBarry Smith 43264f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep(); 4327d763cef2SBarry Smith @*/ 4328a9f9c1f6SBarry Smith PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx) 4329d763cef2SBarry Smith { 4330dfbe8321SBarry Smith PetscErrorCode ierr; 4331d763cef2SBarry Smith 4332d763cef2SBarry Smith PetscFunctionBegin; 43337684fa3eSBarry Smith if ((*ctx)->transformdestroy) { 43347684fa3eSBarry Smith ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr); 43357684fa3eSBarry Smith } 43360b039ecaSBarry Smith ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr); 433731152f8aSBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr); 4338387f4636SBarry Smith ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr); 4339387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr); 4340387f4636SBarry Smith ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr); 43410b039ecaSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 4342d763cef2SBarry Smith PetscFunctionReturn(0); 4343d763cef2SBarry Smith } 4344d763cef2SBarry Smith 43451b575b74SJoseph Pusztay /* 43461b575b74SJoseph Pusztay 43471b575b74SJoseph Pusztay Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations 43481b575b74SJoseph Pusztay 43491b575b74SJoseph Pusztay */ 43501b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx) 43511b575b74SJoseph Pusztay { 43521b575b74SJoseph Pusztay PetscDraw draw; 43531b575b74SJoseph Pusztay PetscErrorCode ierr; 43541b575b74SJoseph Pusztay 43551b575b74SJoseph Pusztay PetscFunctionBegin; 43561b575b74SJoseph Pusztay ierr = PetscNew(ctx);CHKERRQ(ierr); 43571b575b74SJoseph Pusztay ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr); 43581b575b74SJoseph Pusztay ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr); 43591b575b74SJoseph Pusztay ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr); 43601b575b74SJoseph Pusztay ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr); 43611b575b74SJoseph Pusztay (*ctx)->howoften = howoften; 43621b575b74SJoseph Pusztay PetscFunctionReturn(0); 43631b575b74SJoseph Pusztay 43641b575b74SJoseph Pusztay } 43651b575b74SJoseph Pusztay 43661b575b74SJoseph Pusztay /* 43671b575b74SJoseph Pusztay Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate 43681b575b74SJoseph Pusztay */ 43691b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx) 43701b575b74SJoseph Pusztay { 43711b575b74SJoseph Pusztay PetscErrorCode ierr; 43721b575b74SJoseph Pusztay 43731b575b74SJoseph Pusztay PetscFunctionBegin; 43741b575b74SJoseph Pusztay 43751b575b74SJoseph Pusztay ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr); 43761b575b74SJoseph Pusztay ierr = PetscFree(*ctx);CHKERRQ(ierr); 43771b575b74SJoseph Pusztay 43781b575b74SJoseph Pusztay PetscFunctionReturn(0); 43791b575b74SJoseph Pusztay 43801b575b74SJoseph Pusztay } 43811b575b74SJoseph Pusztay 4382d763cef2SBarry Smith /*@ 4383b8123daeSJed Brown TSGetTime - Gets the time of the most recently completed step. 4384d763cef2SBarry Smith 4385d763cef2SBarry Smith Not Collective 4386d763cef2SBarry Smith 4387d763cef2SBarry Smith Input Parameter: 4388d763cef2SBarry Smith . ts - the TS context obtained from TSCreate() 4389d763cef2SBarry Smith 4390d763cef2SBarry Smith Output Parameter: 439119eac22cSLisandro Dalcin . t - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime(). 4392d763cef2SBarry Smith 4393d763cef2SBarry Smith Level: beginner 4394d763cef2SBarry Smith 4395b8123daeSJed Brown Note: 4396b8123daeSJed Brown When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(), 43979be3e283SDebojyoti Ghosh TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated. 4398b8123daeSJed Brown 43998f199f4dSPatrick Sanan .seealso: TSGetSolveTime(), TSSetTime(), TSGetTimeStep(), TSGetStepNumber() 4400d763cef2SBarry Smith 4401d763cef2SBarry Smith @*/ 44027087cfbeSBarry Smith PetscErrorCode TSGetTime(TS ts,PetscReal *t) 4403d763cef2SBarry Smith { 4404d763cef2SBarry Smith PetscFunctionBegin; 44050700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4406f7cf8827SBarry Smith PetscValidRealPointer(t,2); 4407d763cef2SBarry Smith *t = ts->ptime; 4408d763cef2SBarry Smith PetscFunctionReturn(0); 4409d763cef2SBarry Smith } 4410d763cef2SBarry Smith 4411e5e524a1SHong Zhang /*@ 4412e5e524a1SHong Zhang TSGetPrevTime - Gets the starting time of the previously completed step. 4413e5e524a1SHong Zhang 4414e5e524a1SHong Zhang Not Collective 4415e5e524a1SHong Zhang 4416e5e524a1SHong Zhang Input Parameter: 4417e5e524a1SHong Zhang . ts - the TS context obtained from TSCreate() 4418e5e524a1SHong Zhang 4419e5e524a1SHong Zhang Output Parameter: 4420e5e524a1SHong Zhang . t - the previous time 4421e5e524a1SHong Zhang 4422e5e524a1SHong Zhang Level: beginner 4423e5e524a1SHong Zhang 4424aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep() 4425e5e524a1SHong Zhang 4426e5e524a1SHong Zhang @*/ 4427e5e524a1SHong Zhang PetscErrorCode TSGetPrevTime(TS ts,PetscReal *t) 4428e5e524a1SHong Zhang { 4429e5e524a1SHong Zhang PetscFunctionBegin; 4430e5e524a1SHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4431e5e524a1SHong Zhang PetscValidRealPointer(t,2); 4432e5e524a1SHong Zhang *t = ts->ptime_prev; 4433e5e524a1SHong Zhang PetscFunctionReturn(0); 4434e5e524a1SHong Zhang } 4435e5e524a1SHong Zhang 44366a4d4014SLisandro Dalcin /*@ 44376a4d4014SLisandro Dalcin TSSetTime - Allows one to reset the time. 44386a4d4014SLisandro Dalcin 44393f9fe445SBarry Smith Logically Collective on TS 44406a4d4014SLisandro Dalcin 44416a4d4014SLisandro Dalcin Input Parameters: 44426a4d4014SLisandro Dalcin + ts - the TS context obtained from TSCreate() 44436a4d4014SLisandro Dalcin - time - the time 44446a4d4014SLisandro Dalcin 44456a4d4014SLisandro Dalcin Level: intermediate 44466a4d4014SLisandro Dalcin 444719eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps() 44486a4d4014SLisandro Dalcin 44496a4d4014SLisandro Dalcin @*/ 44507087cfbeSBarry Smith PetscErrorCode TSSetTime(TS ts, PetscReal t) 44516a4d4014SLisandro Dalcin { 44526a4d4014SLisandro Dalcin PetscFunctionBegin; 44530700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4454c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(ts,t,2); 44556a4d4014SLisandro Dalcin ts->ptime = t; 44566a4d4014SLisandro Dalcin PetscFunctionReturn(0); 44576a4d4014SLisandro Dalcin } 44586a4d4014SLisandro Dalcin 4459d763cef2SBarry Smith /*@C 4460d763cef2SBarry Smith TSSetOptionsPrefix - Sets the prefix used for searching for all 4461d763cef2SBarry Smith TS options in the database. 4462d763cef2SBarry Smith 44633f9fe445SBarry Smith Logically Collective on TS 4464d763cef2SBarry Smith 4465d763cef2SBarry Smith Input Parameter: 4466d763cef2SBarry Smith + ts - The TS context 4467d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4468d763cef2SBarry Smith 4469d763cef2SBarry Smith Notes: 4470d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4471d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4472d763cef2SBarry Smith hyphen. 4473d763cef2SBarry Smith 4474d763cef2SBarry Smith Level: advanced 4475d763cef2SBarry Smith 4476d763cef2SBarry Smith .seealso: TSSetFromOptions() 4477d763cef2SBarry Smith 4478d763cef2SBarry Smith @*/ 44797087cfbeSBarry Smith PetscErrorCode TSSetOptionsPrefix(TS ts,const char prefix[]) 4480d763cef2SBarry Smith { 4481dfbe8321SBarry Smith PetscErrorCode ierr; 4482089b2837SJed Brown SNES snes; 4483d763cef2SBarry Smith 4484d763cef2SBarry Smith PetscFunctionBegin; 44850700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4486d763cef2SBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4487089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4488089b2837SJed Brown ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4489d763cef2SBarry Smith PetscFunctionReturn(0); 4490d763cef2SBarry Smith } 4491d763cef2SBarry Smith 4492d763cef2SBarry Smith /*@C 4493d763cef2SBarry Smith TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4494d763cef2SBarry Smith TS options in the database. 4495d763cef2SBarry Smith 44963f9fe445SBarry Smith Logically Collective on TS 4497d763cef2SBarry Smith 4498d763cef2SBarry Smith Input Parameter: 4499d763cef2SBarry Smith + ts - The TS context 4500d763cef2SBarry Smith - prefix - The prefix to prepend to all option names 4501d763cef2SBarry Smith 4502d763cef2SBarry Smith Notes: 4503d763cef2SBarry Smith A hyphen (-) must NOT be given at the beginning of the prefix name. 4504d763cef2SBarry Smith The first character of all runtime options is AUTOMATICALLY the 4505d763cef2SBarry Smith hyphen. 4506d763cef2SBarry Smith 4507d763cef2SBarry Smith Level: advanced 4508d763cef2SBarry Smith 4509d763cef2SBarry Smith .seealso: TSGetOptionsPrefix() 4510d763cef2SBarry Smith 4511d763cef2SBarry Smith @*/ 45127087cfbeSBarry Smith PetscErrorCode TSAppendOptionsPrefix(TS ts,const char prefix[]) 4513d763cef2SBarry Smith { 4514dfbe8321SBarry Smith PetscErrorCode ierr; 4515089b2837SJed Brown SNES snes; 4516d763cef2SBarry Smith 4517d763cef2SBarry Smith PetscFunctionBegin; 45180700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4519d763cef2SBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4520089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4521089b2837SJed Brown ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr); 4522d763cef2SBarry Smith PetscFunctionReturn(0); 4523d763cef2SBarry Smith } 4524d763cef2SBarry Smith 4525d763cef2SBarry Smith /*@C 4526d763cef2SBarry Smith TSGetOptionsPrefix - Sets the prefix used for searching for all 4527d763cef2SBarry Smith TS options in the database. 4528d763cef2SBarry Smith 4529d763cef2SBarry Smith Not Collective 4530d763cef2SBarry Smith 4531d763cef2SBarry Smith Input Parameter: 4532d763cef2SBarry Smith . ts - The TS context 4533d763cef2SBarry Smith 4534d763cef2SBarry Smith Output Parameter: 4535d763cef2SBarry Smith . prefix - A pointer to the prefix string used 4536d763cef2SBarry Smith 453795452b02SPatrick Sanan Notes: 453895452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prifix' of 4539d763cef2SBarry Smith sufficient length to hold the prefix. 4540d763cef2SBarry Smith 4541d763cef2SBarry Smith Level: intermediate 4542d763cef2SBarry Smith 4543d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix() 4544d763cef2SBarry Smith @*/ 45457087cfbeSBarry Smith PetscErrorCode TSGetOptionsPrefix(TS ts,const char *prefix[]) 4546d763cef2SBarry Smith { 4547dfbe8321SBarry Smith PetscErrorCode ierr; 4548d763cef2SBarry Smith 4549d763cef2SBarry Smith PetscFunctionBegin; 45500700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 45514482741eSBarry Smith PetscValidPointer(prefix,2); 4552d763cef2SBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr); 4553d763cef2SBarry Smith PetscFunctionReturn(0); 4554d763cef2SBarry Smith } 4555d763cef2SBarry Smith 4556d763cef2SBarry Smith /*@C 4557d763cef2SBarry Smith TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4558d763cef2SBarry Smith 4559d763cef2SBarry Smith Not Collective, but parallel objects are returned if TS is parallel 4560d763cef2SBarry Smith 4561d763cef2SBarry Smith Input Parameter: 4562d763cef2SBarry Smith . ts - The TS context obtained from TSCreate() 4563d763cef2SBarry Smith 4564d763cef2SBarry Smith Output Parameters: 4565e4357dc4SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or NULL) 4566e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat (or NULL) 4567e4357dc4SBarry Smith . func - Function to compute the Jacobian of the RHS (or NULL) 4568e4357dc4SBarry Smith - ctx - User-defined context for Jacobian evaluation routine (or NULL) 4569d763cef2SBarry Smith 457095452b02SPatrick Sanan Notes: 457195452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 4572d763cef2SBarry Smith 4573d763cef2SBarry Smith Level: intermediate 4574d763cef2SBarry Smith 457580275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 4576d763cef2SBarry Smith 4577d763cef2SBarry Smith @*/ 4578e4357dc4SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx) 4579d763cef2SBarry Smith { 4580089b2837SJed Brown PetscErrorCode ierr; 458124989b8cSPeter Brune DM dm; 4582089b2837SJed Brown 4583d763cef2SBarry Smith PetscFunctionBegin; 458423a57915SBarry Smith if (Amat || Pmat) { 458523a57915SBarry Smith SNES snes; 4586089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 458723a57915SBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4588e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 458923a57915SBarry Smith } 459024989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 459124989b8cSPeter Brune ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr); 4592d763cef2SBarry Smith PetscFunctionReturn(0); 4593d763cef2SBarry Smith } 4594d763cef2SBarry Smith 45952eca1d9cSJed Brown /*@C 45962eca1d9cSJed Brown TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 45972eca1d9cSJed Brown 45982eca1d9cSJed Brown Not Collective, but parallel objects are returned if TS is parallel 45992eca1d9cSJed Brown 46002eca1d9cSJed Brown Input Parameter: 46012eca1d9cSJed Brown . ts - The TS context obtained from TSCreate() 46022eca1d9cSJed Brown 46032eca1d9cSJed Brown Output Parameters: 4604e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t) 4605e4357dc4SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as Amat 46062eca1d9cSJed Brown . f - The function to compute the matrices 46072eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine 46082eca1d9cSJed Brown 460995452b02SPatrick Sanan Notes: 461095452b02SPatrick Sanan You can pass in NULL for any return argument you do not need. 46112eca1d9cSJed Brown 46122eca1d9cSJed Brown Level: advanced 46132eca1d9cSJed Brown 461480275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber() 46152eca1d9cSJed Brown 46162eca1d9cSJed Brown @*/ 4617e4357dc4SBarry Smith PetscErrorCode TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx) 46182eca1d9cSJed Brown { 4619089b2837SJed Brown PetscErrorCode ierr; 462024989b8cSPeter Brune DM dm; 46210910c330SBarry Smith 46222eca1d9cSJed Brown PetscFunctionBegin; 4623c0aab802Sstefano_zampini if (Amat || Pmat) { 4624c0aab802Sstefano_zampini SNES snes; 4625089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4626f7d39f7aSBarry Smith ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr); 4627e4357dc4SBarry Smith ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr); 4628c0aab802Sstefano_zampini } 462924989b8cSPeter Brune ierr = TSGetDM(ts,&dm);CHKERRQ(ierr); 463024989b8cSPeter Brune ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr); 46312eca1d9cSJed Brown PetscFunctionReturn(0); 46322eca1d9cSJed Brown } 46332eca1d9cSJed Brown 46341713a123SBarry Smith /*@C 463583a4ac43SBarry Smith TSMonitorDrawSolution - Monitors progress of the TS solvers by calling 46361713a123SBarry Smith VecView() for the solution at each timestep 46371713a123SBarry Smith 46381713a123SBarry Smith Collective on TS 46391713a123SBarry Smith 46401713a123SBarry Smith Input Parameters: 46411713a123SBarry Smith + ts - the TS context 46421713a123SBarry Smith . step - current time-step 4643142b95e3SSatish Balay . ptime - current time 46440298fd71SBarry Smith - dummy - either a viewer or NULL 46451713a123SBarry Smith 464699fdda47SBarry Smith Options Database: 464799fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 464899fdda47SBarry Smith 464995452b02SPatrick Sanan Notes: 465095452b02SPatrick Sanan the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial 465199fdda47SBarry Smith will look bad 465299fdda47SBarry Smith 46531713a123SBarry Smith Level: intermediate 46541713a123SBarry Smith 4655a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 46561713a123SBarry Smith @*/ 46570910c330SBarry Smith PetscErrorCode TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 46581713a123SBarry Smith { 4659dfbe8321SBarry Smith PetscErrorCode ierr; 466083a4ac43SBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 4661473a3ab2SBarry Smith PetscDraw draw; 46621713a123SBarry Smith 46631713a123SBarry Smith PetscFunctionBegin; 46646083293cSBarry Smith if (!step && ictx->showinitial) { 46656083293cSBarry Smith if (!ictx->initialsolution) { 46660910c330SBarry Smith ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr); 46671713a123SBarry Smith } 46680910c330SBarry Smith ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr); 46696083293cSBarry Smith } 4670b06615a5SLisandro Dalcin if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 46710dcf80beSBarry Smith 46726083293cSBarry Smith if (ictx->showinitial) { 46736083293cSBarry Smith PetscReal pause; 46746083293cSBarry Smith ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr); 46756083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr); 46766083293cSBarry Smith ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr); 46776083293cSBarry Smith ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr); 46786083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr); 46796083293cSBarry Smith } 46800910c330SBarry Smith ierr = VecView(u,ictx->viewer);CHKERRQ(ierr); 4681473a3ab2SBarry Smith if (ictx->showtimestepandtime) { 468251fa3d41SBarry Smith PetscReal xl,yl,xr,yr,h; 4683473a3ab2SBarry Smith char time[32]; 4684473a3ab2SBarry Smith 4685473a3ab2SBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 468685b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 4687473a3ab2SBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 4688473a3ab2SBarry Smith h = yl + .95*(yr - yl); 468951fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 4690473a3ab2SBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 4691473a3ab2SBarry Smith } 4692473a3ab2SBarry Smith 46936083293cSBarry Smith if (ictx->showinitial) { 46946083293cSBarry Smith ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr); 46956083293cSBarry Smith } 46961713a123SBarry Smith PetscFunctionReturn(0); 46971713a123SBarry Smith } 46981713a123SBarry Smith 46999110b2e7SHong Zhang /*@C 47002d5ee99bSBarry Smith TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram 47012d5ee99bSBarry Smith 47022d5ee99bSBarry Smith Collective on TS 47032d5ee99bSBarry Smith 47042d5ee99bSBarry Smith Input Parameters: 47052d5ee99bSBarry Smith + ts - the TS context 47062d5ee99bSBarry Smith . step - current time-step 47072d5ee99bSBarry Smith . ptime - current time 47082d5ee99bSBarry Smith - dummy - either a viewer or NULL 47092d5ee99bSBarry Smith 47102d5ee99bSBarry Smith Level: intermediate 47112d5ee99bSBarry Smith 47122d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 47132d5ee99bSBarry Smith @*/ 47142d5ee99bSBarry Smith PetscErrorCode TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 47152d5ee99bSBarry Smith { 47162d5ee99bSBarry Smith PetscErrorCode ierr; 47172d5ee99bSBarry Smith TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy; 47182d5ee99bSBarry Smith PetscDraw draw; 47196934998bSLisandro Dalcin PetscDrawAxis axis; 47202d5ee99bSBarry Smith PetscInt n; 47212d5ee99bSBarry Smith PetscMPIInt size; 47226934998bSLisandro Dalcin PetscReal U0,U1,xl,yl,xr,yr,h; 47232d5ee99bSBarry Smith char time[32]; 47242d5ee99bSBarry Smith const PetscScalar *U; 47252d5ee99bSBarry Smith 47262d5ee99bSBarry Smith PetscFunctionBegin; 47276934998bSLisandro Dalcin ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr); 47286934998bSLisandro Dalcin if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs"); 47292d5ee99bSBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 47306934998bSLisandro Dalcin if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns"); 47312d5ee99bSBarry Smith 47322d5ee99bSBarry Smith ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr); 47336934998bSLisandro Dalcin ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr); 47346934998bSLisandro Dalcin ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr); 47356934998bSLisandro Dalcin if (!step) { 47366934998bSLisandro Dalcin ierr = PetscDrawClear(draw);CHKERRQ(ierr); 47376934998bSLisandro Dalcin ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr); 47386934998bSLisandro Dalcin } 47392d5ee99bSBarry Smith 47402d5ee99bSBarry Smith ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr); 47416934998bSLisandro Dalcin U0 = PetscRealPart(U[0]); 47426934998bSLisandro Dalcin U1 = PetscRealPart(U[1]); 4743a4494fc1SBarry Smith ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr); 47446934998bSLisandro Dalcin if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0); 47452d5ee99bSBarry Smith 47466934998bSLisandro Dalcin ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr); 47476934998bSLisandro Dalcin ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr); 47482d5ee99bSBarry Smith if (ictx->showtimestepandtime) { 47494b363babSBarry Smith ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr); 475085b1acf9SLisandro Dalcin ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr); 47512d5ee99bSBarry Smith h = yl + .95*(yr - yl); 475251fa3d41SBarry Smith ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr); 47532d5ee99bSBarry Smith } 47546934998bSLisandro Dalcin ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr); 47552d5ee99bSBarry Smith ierr = PetscDrawFlush(draw);CHKERRQ(ierr); 475656d62c8fSLisandro Dalcin ierr = PetscDrawPause(draw);CHKERRQ(ierr); 47576934998bSLisandro Dalcin ierr = PetscDrawSave(draw);CHKERRQ(ierr); 47582d5ee99bSBarry Smith PetscFunctionReturn(0); 47592d5ee99bSBarry Smith } 47602d5ee99bSBarry Smith 47616083293cSBarry Smith /*@C 476283a4ac43SBarry Smith TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution() 47636083293cSBarry Smith 47646083293cSBarry Smith Collective on TS 47656083293cSBarry Smith 47666083293cSBarry Smith Input Parameters: 47676083293cSBarry Smith . ctx - the monitor context 47686083293cSBarry Smith 47696083293cSBarry Smith Level: intermediate 47706083293cSBarry Smith 477183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError() 47726083293cSBarry Smith @*/ 477383a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx) 47746083293cSBarry Smith { 47756083293cSBarry Smith PetscErrorCode ierr; 47766083293cSBarry Smith 47776083293cSBarry Smith PetscFunctionBegin; 477883a4ac43SBarry Smith ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 477983a4ac43SBarry Smith ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr); 478083a4ac43SBarry Smith ierr = PetscFree(*ictx);CHKERRQ(ierr); 47816083293cSBarry Smith PetscFunctionReturn(0); 47826083293cSBarry Smith } 47836083293cSBarry Smith 47846083293cSBarry Smith /*@C 478583a4ac43SBarry Smith TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx 47866083293cSBarry Smith 47876083293cSBarry Smith Collective on TS 47886083293cSBarry Smith 47896083293cSBarry Smith Input Parameter: 47906083293cSBarry Smith . ts - time-step context 47916083293cSBarry Smith 47926083293cSBarry Smith Output Patameter: 47936083293cSBarry Smith . ctx - the monitor context 47946083293cSBarry Smith 479599fdda47SBarry Smith Options Database: 479699fdda47SBarry Smith . -ts_monitor_draw_solution_initial - show initial solution as well as current solution 479799fdda47SBarry Smith 47986083293cSBarry Smith Level: intermediate 47996083293cSBarry Smith 480083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx() 48016083293cSBarry Smith @*/ 480283a4ac43SBarry Smith PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx) 48036083293cSBarry Smith { 48046083293cSBarry Smith PetscErrorCode ierr; 48056083293cSBarry Smith 48066083293cSBarry Smith PetscFunctionBegin; 4807b00a9115SJed Brown ierr = PetscNew(ctx);CHKERRQ(ierr); 480883a4ac43SBarry Smith ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 4809e9457bf7SBarry Smith ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 4810bbd56ea5SKarl Rupp 481183a4ac43SBarry Smith (*ctx)->howoften = howoften; 4812473a3ab2SBarry Smith (*ctx)->showinitial = PETSC_FALSE; 4813c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr); 4814473a3ab2SBarry Smith 4815473a3ab2SBarry Smith (*ctx)->showtimestepandtime = PETSC_FALSE; 4816c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr); 48176083293cSBarry Smith PetscFunctionReturn(0); 48186083293cSBarry Smith } 48196083293cSBarry Smith 48203a471f94SBarry Smith /*@C 48210ed3bfb6SBarry Smith TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling 48220ed3bfb6SBarry Smith VecView() for the solution provided by TSSetSolutionFunction() at each timestep 48230ed3bfb6SBarry Smith 48240ed3bfb6SBarry Smith Collective on TS 48250ed3bfb6SBarry Smith 48260ed3bfb6SBarry Smith Input Parameters: 48270ed3bfb6SBarry Smith + ts - the TS context 48280ed3bfb6SBarry Smith . step - current time-step 48290ed3bfb6SBarry Smith . ptime - current time 48300ed3bfb6SBarry Smith - dummy - either a viewer or NULL 48310ed3bfb6SBarry Smith 48320ed3bfb6SBarry Smith Options Database: 48330ed3bfb6SBarry Smith . -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 48340ed3bfb6SBarry Smith 48350ed3bfb6SBarry Smith Level: intermediate 48360ed3bfb6SBarry Smith 48370ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 48380ed3bfb6SBarry Smith @*/ 48390ed3bfb6SBarry Smith PetscErrorCode TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 48400ed3bfb6SBarry Smith { 48410ed3bfb6SBarry Smith PetscErrorCode ierr; 48420ed3bfb6SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 48430ed3bfb6SBarry Smith PetscViewer viewer = ctx->viewer; 48440ed3bfb6SBarry Smith Vec work; 48450ed3bfb6SBarry Smith 48460ed3bfb6SBarry Smith PetscFunctionBegin; 48470ed3bfb6SBarry Smith if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 48480ed3bfb6SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 48490ed3bfb6SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 48500ed3bfb6SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 48510ed3bfb6SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 48520ed3bfb6SBarry Smith PetscFunctionReturn(0); 48530ed3bfb6SBarry Smith } 48540ed3bfb6SBarry Smith 48550ed3bfb6SBarry Smith /*@C 485683a4ac43SBarry Smith TSMonitorDrawError - Monitors progress of the TS solvers by calling 48573a471f94SBarry Smith VecView() for the error at each timestep 48583a471f94SBarry Smith 48593a471f94SBarry Smith Collective on TS 48603a471f94SBarry Smith 48613a471f94SBarry Smith Input Parameters: 48623a471f94SBarry Smith + ts - the TS context 48633a471f94SBarry Smith . step - current time-step 48643a471f94SBarry Smith . ptime - current time 48650298fd71SBarry Smith - dummy - either a viewer or NULL 48663a471f94SBarry Smith 48670ed3bfb6SBarry Smith Options Database: 48680ed3bfb6SBarry Smith . -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction() 48690ed3bfb6SBarry Smith 48703a471f94SBarry Smith Level: intermediate 48713a471f94SBarry Smith 48720ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 48733a471f94SBarry Smith @*/ 48740910c330SBarry Smith PetscErrorCode TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 48753a471f94SBarry Smith { 48763a471f94SBarry Smith PetscErrorCode ierr; 487783a4ac43SBarry Smith TSMonitorDrawCtx ctx = (TSMonitorDrawCtx)dummy; 487883a4ac43SBarry Smith PetscViewer viewer = ctx->viewer; 48793a471f94SBarry Smith Vec work; 48803a471f94SBarry Smith 48813a471f94SBarry Smith PetscFunctionBegin; 4882b06615a5SLisandro Dalcin if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0); 48830910c330SBarry Smith ierr = VecDuplicate(u,&work);CHKERRQ(ierr); 48843a471f94SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr); 48850910c330SBarry Smith ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr); 48863a471f94SBarry Smith ierr = VecView(work,viewer);CHKERRQ(ierr); 48873a471f94SBarry Smith ierr = VecDestroy(&work);CHKERRQ(ierr); 48883a471f94SBarry Smith PetscFunctionReturn(0); 48893a471f94SBarry Smith } 48903a471f94SBarry Smith 4891af0996ceSBarry Smith #include <petsc/private/dmimpl.h> 48926c699258SBarry Smith /*@ 48932a808120SBarry Smith TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS 48946c699258SBarry Smith 4895d083f849SBarry Smith Logically Collective on ts 48966c699258SBarry Smith 48976c699258SBarry Smith Input Parameters: 48982a808120SBarry Smith + ts - the ODE integrator object 48992a808120SBarry Smith - dm - the dm, cannot be NULL 49006c699258SBarry Smith 4901e03a659cSJed Brown Notes: 4902e03a659cSJed Brown A DM can only be used for solving one problem at a time because information about the problem is stored on the DM, 4903e03a659cSJed Brown even when not using interfaces like DMTSSetIFunction(). Use DMClone() to get a distinct DM when solving 4904e03a659cSJed Brown different problems using the same function space. 4905e03a659cSJed Brown 49066c699258SBarry Smith Level: intermediate 49076c699258SBarry Smith 49086c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM() 49096c699258SBarry Smith @*/ 49107087cfbeSBarry Smith PetscErrorCode TSSetDM(TS ts,DM dm) 49116c699258SBarry Smith { 49126c699258SBarry Smith PetscErrorCode ierr; 4913089b2837SJed Brown SNES snes; 4914942e3340SBarry Smith DMTS tsdm; 49156c699258SBarry Smith 49166c699258SBarry Smith PetscFunctionBegin; 49170700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 49182a808120SBarry Smith PetscValidHeaderSpecific(dm,DM_CLASSID,2); 491970663e4aSLisandro Dalcin ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr); 4920942e3340SBarry Smith if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 49212a34c10cSBarry Smith if (ts->dm->dmts && !dm->dmts) { 4922942e3340SBarry Smith ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr); 4923942e3340SBarry Smith ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr); 492424989b8cSPeter Brune if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */ 492524989b8cSPeter Brune tsdm->originaldm = dm; 492624989b8cSPeter Brune } 492724989b8cSPeter Brune } 49286bf464f9SBarry Smith ierr = DMDestroy(&ts->dm);CHKERRQ(ierr); 492924989b8cSPeter Brune } 49306c699258SBarry Smith ts->dm = dm; 4931bbd56ea5SKarl Rupp 4932089b2837SJed Brown ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 4933089b2837SJed Brown ierr = SNESSetDM(snes,dm);CHKERRQ(ierr); 49346c699258SBarry Smith PetscFunctionReturn(0); 49356c699258SBarry Smith } 49366c699258SBarry Smith 49376c699258SBarry Smith /*@ 49386c699258SBarry Smith TSGetDM - Gets the DM that may be used by some preconditioners 49396c699258SBarry Smith 49403f9fe445SBarry Smith Not Collective 49416c699258SBarry Smith 49426c699258SBarry Smith Input Parameter: 49436c699258SBarry Smith . ts - the preconditioner context 49446c699258SBarry Smith 49456c699258SBarry Smith Output Parameter: 49466c699258SBarry Smith . dm - the dm 49476c699258SBarry Smith 49486c699258SBarry Smith Level: intermediate 49496c699258SBarry Smith 49506c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM() 49516c699258SBarry Smith @*/ 49527087cfbeSBarry Smith PetscErrorCode TSGetDM(TS ts,DM *dm) 49536c699258SBarry Smith { 4954496e6a7aSJed Brown PetscErrorCode ierr; 4955496e6a7aSJed Brown 49566c699258SBarry Smith PetscFunctionBegin; 49570700a824SBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 4958496e6a7aSJed Brown if (!ts->dm) { 4959ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr); 4960496e6a7aSJed Brown if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);} 4961496e6a7aSJed Brown } 49626c699258SBarry Smith *dm = ts->dm; 49636c699258SBarry Smith PetscFunctionReturn(0); 49646c699258SBarry Smith } 49651713a123SBarry Smith 49660f5c6efeSJed Brown /*@ 49670f5c6efeSJed Brown SNESTSFormFunction - Function to evaluate nonlinear residual 49680f5c6efeSJed Brown 49693f9fe445SBarry Smith Logically Collective on SNES 49700f5c6efeSJed Brown 49710f5c6efeSJed Brown Input Parameter: 4972d42a1c89SJed Brown + snes - nonlinear solver 49730910c330SBarry Smith . U - the current state at which to evaluate the residual 4974d42a1c89SJed Brown - ctx - user context, must be a TS 49750f5c6efeSJed Brown 49760f5c6efeSJed Brown Output Parameter: 49770f5c6efeSJed Brown . F - the nonlinear residual 49780f5c6efeSJed Brown 49790f5c6efeSJed Brown Notes: 49800f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 49810f5c6efeSJed Brown It is most frequently passed to MatFDColoringSetFunction(). 49820f5c6efeSJed Brown 49830f5c6efeSJed Brown Level: advanced 49840f5c6efeSJed Brown 49850f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction() 49860f5c6efeSJed Brown @*/ 49870910c330SBarry Smith PetscErrorCode SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx) 49880f5c6efeSJed Brown { 49890f5c6efeSJed Brown TS ts = (TS)ctx; 49900f5c6efeSJed Brown PetscErrorCode ierr; 49910f5c6efeSJed Brown 49920f5c6efeSJed Brown PetscFunctionBegin; 49930f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 49940910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 49950f5c6efeSJed Brown PetscValidHeaderSpecific(F,VEC_CLASSID,3); 49960f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,4); 49970910c330SBarry Smith ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr); 49980f5c6efeSJed Brown PetscFunctionReturn(0); 49990f5c6efeSJed Brown } 50000f5c6efeSJed Brown 50010f5c6efeSJed Brown /*@ 50020f5c6efeSJed Brown SNESTSFormJacobian - Function to evaluate the Jacobian 50030f5c6efeSJed Brown 50040f5c6efeSJed Brown Collective on SNES 50050f5c6efeSJed Brown 50060f5c6efeSJed Brown Input Parameter: 50070f5c6efeSJed Brown + snes - nonlinear solver 50080910c330SBarry Smith . U - the current state at which to evaluate the residual 50090f5c6efeSJed Brown - ctx - user context, must be a TS 50100f5c6efeSJed Brown 50110f5c6efeSJed Brown Output Parameter: 50120f5c6efeSJed Brown + A - the Jacobian 50130f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A) 50140f5c6efeSJed Brown - flag - indicates any structure change in the matrix 50150f5c6efeSJed Brown 50160f5c6efeSJed Brown Notes: 50170f5c6efeSJed Brown This function is not normally called by users and is automatically registered with the SNES used by TS. 50180f5c6efeSJed Brown 50190f5c6efeSJed Brown Level: developer 50200f5c6efeSJed Brown 50210f5c6efeSJed Brown .seealso: SNESSetJacobian() 50220f5c6efeSJed Brown @*/ 5023d1e9a80fSBarry Smith PetscErrorCode SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx) 50240f5c6efeSJed Brown { 50250f5c6efeSJed Brown TS ts = (TS)ctx; 50260f5c6efeSJed Brown PetscErrorCode ierr; 50270f5c6efeSJed Brown 50280f5c6efeSJed Brown PetscFunctionBegin; 50290f5c6efeSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 50300910c330SBarry Smith PetscValidHeaderSpecific(U,VEC_CLASSID,2); 50310f5c6efeSJed Brown PetscValidPointer(A,3); 503294ab13aaSBarry Smith PetscValidHeaderSpecific(A,MAT_CLASSID,3); 50330f5c6efeSJed Brown PetscValidPointer(B,4); 503494ab13aaSBarry Smith PetscValidHeaderSpecific(B,MAT_CLASSID,4); 50350f5c6efeSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,6); 5036d1e9a80fSBarry Smith ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr); 50370f5c6efeSJed Brown PetscFunctionReturn(0); 50380f5c6efeSJed Brown } 5039325fc9f4SBarry Smith 50400e4ef248SJed Brown /*@C 50419ae8fd06SBarry Smith TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 50420e4ef248SJed Brown 50430e4ef248SJed Brown Collective on TS 50440e4ef248SJed Brown 50450e4ef248SJed Brown Input Arguments: 50460e4ef248SJed Brown + ts - time stepping context 50470e4ef248SJed Brown . t - time at which to evaluate 50480910c330SBarry Smith . U - state at which to evaluate 50490e4ef248SJed Brown - ctx - context 50500e4ef248SJed Brown 50510e4ef248SJed Brown Output Arguments: 50520e4ef248SJed Brown . F - right hand side 50530e4ef248SJed Brown 50540e4ef248SJed Brown Level: intermediate 50550e4ef248SJed Brown 50560e4ef248SJed Brown Notes: 50570e4ef248SJed Brown This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems. 50580e4ef248SJed Brown The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian(). 50590e4ef248SJed Brown 50600e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant() 50610e4ef248SJed Brown @*/ 50620910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx) 50630e4ef248SJed Brown { 50640e4ef248SJed Brown PetscErrorCode ierr; 50650e4ef248SJed Brown Mat Arhs,Brhs; 50660e4ef248SJed Brown 50670e4ef248SJed Brown PetscFunctionBegin; 50680e4ef248SJed Brown ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr); 50692663174eSHong Zhang /* undo the damage caused by shifting */ 5070*cfa8a9a2SHong Zhang ierr = TSRecoverRHSJacobian(ts,Arhs,Brhs);CHKERRQ(ierr); 5071d1e9a80fSBarry Smith ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr); 50720910c330SBarry Smith ierr = MatMult(Arhs,U,F);CHKERRQ(ierr); 50730e4ef248SJed Brown PetscFunctionReturn(0); 50740e4ef248SJed Brown } 50750e4ef248SJed Brown 50760e4ef248SJed Brown /*@C 50770e4ef248SJed Brown TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 50780e4ef248SJed Brown 50790e4ef248SJed Brown Collective on TS 50800e4ef248SJed Brown 50810e4ef248SJed Brown Input Arguments: 50820e4ef248SJed Brown + ts - time stepping context 50830e4ef248SJed Brown . t - time at which to evaluate 50840910c330SBarry Smith . U - state at which to evaluate 50850e4ef248SJed Brown - ctx - context 50860e4ef248SJed Brown 50870e4ef248SJed Brown Output Arguments: 50880e4ef248SJed Brown + A - pointer to operator 50890e4ef248SJed Brown . B - pointer to preconditioning matrix 50900e4ef248SJed Brown - flg - matrix structure flag 50910e4ef248SJed Brown 50920e4ef248SJed Brown Level: intermediate 50930e4ef248SJed Brown 50940e4ef248SJed Brown Notes: 50950e4ef248SJed Brown This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems. 50960e4ef248SJed Brown 50970e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear() 50980e4ef248SJed Brown @*/ 5099d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx) 51000e4ef248SJed Brown { 51010e4ef248SJed Brown PetscFunctionBegin; 51020e4ef248SJed Brown PetscFunctionReturn(0); 51030e4ef248SJed Brown } 51040e4ef248SJed Brown 51050026cea9SSean Farley /*@C 51060026cea9SSean Farley TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 51070026cea9SSean Farley 51080026cea9SSean Farley Collective on TS 51090026cea9SSean Farley 51100026cea9SSean Farley Input Arguments: 51110026cea9SSean Farley + ts - time stepping context 51120026cea9SSean Farley . t - time at which to evaluate 51130910c330SBarry Smith . U - state at which to evaluate 51140910c330SBarry Smith . Udot - time derivative of state vector 51150026cea9SSean Farley - ctx - context 51160026cea9SSean Farley 51170026cea9SSean Farley Output Arguments: 51180026cea9SSean Farley . F - left hand side 51190026cea9SSean Farley 51200026cea9SSean Farley Level: intermediate 51210026cea9SSean Farley 51220026cea9SSean Farley Notes: 51230910c330SBarry 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 51240026cea9SSean Farley user is required to write their own TSComputeIFunction. 51250026cea9SSean Farley This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems. 51260026cea9SSean Farley The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian(). 51270026cea9SSean Farley 51289ae8fd06SBarry Smith Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U 51299ae8fd06SBarry Smith 51309ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear() 51310026cea9SSean Farley @*/ 51320910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx) 51330026cea9SSean Farley { 51340026cea9SSean Farley PetscErrorCode ierr; 51350026cea9SSean Farley Mat A,B; 51360026cea9SSean Farley 51370026cea9SSean Farley PetscFunctionBegin; 51380298fd71SBarry Smith ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr); 5139d1e9a80fSBarry Smith ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr); 51400910c330SBarry Smith ierr = MatMult(A,Udot,F);CHKERRQ(ierr); 51410026cea9SSean Farley PetscFunctionReturn(0); 51420026cea9SSean Farley } 51430026cea9SSean Farley 51440026cea9SSean Farley /*@C 5145b41af12eSJed Brown TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE 51460026cea9SSean Farley 51470026cea9SSean Farley Collective on TS 51480026cea9SSean Farley 51490026cea9SSean Farley Input Arguments: 51500026cea9SSean Farley + ts - time stepping context 51510026cea9SSean Farley . t - time at which to evaluate 51520910c330SBarry Smith . U - state at which to evaluate 51530910c330SBarry Smith . Udot - time derivative of state vector 51540026cea9SSean Farley . shift - shift to apply 51550026cea9SSean Farley - ctx - context 51560026cea9SSean Farley 51570026cea9SSean Farley Output Arguments: 51580026cea9SSean Farley + A - pointer to operator 51590026cea9SSean Farley . B - pointer to preconditioning matrix 51600026cea9SSean Farley - flg - matrix structure flag 51610026cea9SSean Farley 5162b41af12eSJed Brown Level: advanced 51630026cea9SSean Farley 51640026cea9SSean Farley Notes: 51650026cea9SSean Farley This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems. 51660026cea9SSean Farley 5167b41af12eSJed Brown It is only appropriate for problems of the form 5168b41af12eSJed Brown 5169b41af12eSJed Brown $ M Udot = F(U,t) 5170b41af12eSJed Brown 5171b41af12eSJed Brown where M is constant and F is non-stiff. The user must pass M to TSSetIJacobian(). The current implementation only 5172b41af12eSJed Brown works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing 5173b41af12eSJed Brown an implicit operator of the form 5174b41af12eSJed Brown 5175b41af12eSJed Brown $ shift*M + J 5176b41af12eSJed Brown 5177b41af12eSJed 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 5178b41af12eSJed Brown a copy of M or reassemble it when requested. 5179b41af12eSJed Brown 51800026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear() 51810026cea9SSean Farley @*/ 5182d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx) 51830026cea9SSean Farley { 5184b41af12eSJed Brown PetscErrorCode ierr; 5185b41af12eSJed Brown 51860026cea9SSean Farley PetscFunctionBegin; 518794ab13aaSBarry Smith ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr); 5188b41af12eSJed Brown ts->ijacobian.shift = shift; 51890026cea9SSean Farley PetscFunctionReturn(0); 51900026cea9SSean Farley } 5191b41af12eSJed Brown 5192e817cc15SEmil Constantinescu /*@ 5193e817cc15SEmil Constantinescu TSGetEquationType - Gets the type of the equation that TS is solving. 5194e817cc15SEmil Constantinescu 5195e817cc15SEmil Constantinescu Not Collective 5196e817cc15SEmil Constantinescu 5197e817cc15SEmil Constantinescu Input Parameter: 5198e817cc15SEmil Constantinescu . ts - the TS context 5199e817cc15SEmil Constantinescu 5200e817cc15SEmil Constantinescu Output Parameter: 52014e6b9ce4SEmil Constantinescu . equation_type - see TSEquationType 5202e817cc15SEmil Constantinescu 5203e817cc15SEmil Constantinescu Level: beginner 5204e817cc15SEmil Constantinescu 5205e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType 5206e817cc15SEmil Constantinescu @*/ 5207e817cc15SEmil Constantinescu PetscErrorCode TSGetEquationType(TS ts,TSEquationType *equation_type) 5208e817cc15SEmil Constantinescu { 5209e817cc15SEmil Constantinescu PetscFunctionBegin; 5210e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5211e817cc15SEmil Constantinescu PetscValidPointer(equation_type,2); 5212e817cc15SEmil Constantinescu *equation_type = ts->equation_type; 5213e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5214e817cc15SEmil Constantinescu } 5215e817cc15SEmil Constantinescu 5216e817cc15SEmil Constantinescu /*@ 5217e817cc15SEmil Constantinescu TSSetEquationType - Sets the type of the equation that TS is solving. 5218e817cc15SEmil Constantinescu 5219e817cc15SEmil Constantinescu Not Collective 5220e817cc15SEmil Constantinescu 5221e817cc15SEmil Constantinescu Input Parameter: 5222e817cc15SEmil Constantinescu + ts - the TS context 52231297b224SEmil Constantinescu - equation_type - see TSEquationType 5224e817cc15SEmil Constantinescu 5225e817cc15SEmil Constantinescu Level: advanced 5226e817cc15SEmil Constantinescu 5227e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType 5228e817cc15SEmil Constantinescu @*/ 5229e817cc15SEmil Constantinescu PetscErrorCode TSSetEquationType(TS ts,TSEquationType equation_type) 5230e817cc15SEmil Constantinescu { 5231e817cc15SEmil Constantinescu PetscFunctionBegin; 5232e817cc15SEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5233e817cc15SEmil Constantinescu ts->equation_type = equation_type; 5234e817cc15SEmil Constantinescu PetscFunctionReturn(0); 5235e817cc15SEmil Constantinescu } 52360026cea9SSean Farley 52374af1b03aSJed Brown /*@ 52384af1b03aSJed Brown TSGetConvergedReason - Gets the reason the TS iteration was stopped. 52394af1b03aSJed Brown 52404af1b03aSJed Brown Not Collective 52414af1b03aSJed Brown 52424af1b03aSJed Brown Input Parameter: 52434af1b03aSJed Brown . ts - the TS context 52444af1b03aSJed Brown 52454af1b03aSJed Brown Output Parameter: 52464af1b03aSJed Brown . reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 52474af1b03aSJed Brown manual pages for the individual convergence tests for complete lists 52484af1b03aSJed Brown 5249487e0bb9SJed Brown Level: beginner 52504af1b03aSJed Brown 5251cd652676SJed Brown Notes: 5252cd652676SJed Brown Can only be called after the call to TSSolve() is complete. 52534af1b03aSJed Brown 52544af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason 52554af1b03aSJed Brown @*/ 52564af1b03aSJed Brown PetscErrorCode TSGetConvergedReason(TS ts,TSConvergedReason *reason) 52574af1b03aSJed Brown { 52584af1b03aSJed Brown PetscFunctionBegin; 52594af1b03aSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 52604af1b03aSJed Brown PetscValidPointer(reason,2); 52614af1b03aSJed Brown *reason = ts->reason; 52624af1b03aSJed Brown PetscFunctionReturn(0); 52634af1b03aSJed Brown } 52644af1b03aSJed Brown 5265d6ad946cSShri Abhyankar /*@ 5266d6ad946cSShri Abhyankar TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve. 5267d6ad946cSShri Abhyankar 52686b221cbeSPatrick Sanan Logically Collective; reason must contain common value 5269d6ad946cSShri Abhyankar 52706b221cbeSPatrick Sanan Input Parameters: 5271d6ad946cSShri Abhyankar + ts - the TS context 52726b221cbeSPatrick Sanan - reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the 5273d6ad946cSShri Abhyankar manual pages for the individual convergence tests for complete lists 5274d6ad946cSShri Abhyankar 5275f5abba47SShri Abhyankar Level: advanced 5276d6ad946cSShri Abhyankar 5277d6ad946cSShri Abhyankar Notes: 52786b221cbeSPatrick Sanan Can only be called while TSSolve() is active. 5279d6ad946cSShri Abhyankar 5280d6ad946cSShri Abhyankar .seealso: TSConvergedReason 5281d6ad946cSShri Abhyankar @*/ 5282d6ad946cSShri Abhyankar PetscErrorCode TSSetConvergedReason(TS ts,TSConvergedReason reason) 5283d6ad946cSShri Abhyankar { 5284d6ad946cSShri Abhyankar PetscFunctionBegin; 5285d6ad946cSShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5286d6ad946cSShri Abhyankar ts->reason = reason; 5287d6ad946cSShri Abhyankar PetscFunctionReturn(0); 5288d6ad946cSShri Abhyankar } 5289d6ad946cSShri Abhyankar 5290cc708dedSBarry Smith /*@ 5291cc708dedSBarry Smith TSGetSolveTime - Gets the time after a call to TSSolve() 5292cc708dedSBarry Smith 5293cc708dedSBarry Smith Not Collective 5294cc708dedSBarry Smith 5295cc708dedSBarry Smith Input Parameter: 5296cc708dedSBarry Smith . ts - the TS context 5297cc708dedSBarry Smith 5298cc708dedSBarry Smith Output Parameter: 529919eac22cSLisandro Dalcin . ftime - the final time. This time corresponds to the final time set with TSSetMaxTime() 5300cc708dedSBarry Smith 5301487e0bb9SJed Brown Level: beginner 5302cc708dedSBarry Smith 5303cc708dedSBarry Smith Notes: 5304cc708dedSBarry Smith Can only be called after the call to TSSolve() is complete. 5305cc708dedSBarry Smith 5306cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason 5307cc708dedSBarry Smith @*/ 5308cc708dedSBarry Smith PetscErrorCode TSGetSolveTime(TS ts,PetscReal *ftime) 5309cc708dedSBarry Smith { 5310cc708dedSBarry Smith PetscFunctionBegin; 5311cc708dedSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5312cc708dedSBarry Smith PetscValidPointer(ftime,2); 5313cc708dedSBarry Smith *ftime = ts->solvetime; 5314cc708dedSBarry Smith PetscFunctionReturn(0); 5315cc708dedSBarry Smith } 5316cc708dedSBarry Smith 53172c18e0fdSBarry Smith /*@ 53185ef26d82SJed Brown TSGetSNESIterations - Gets the total number of nonlinear iterations 53199f67acb7SJed Brown used by the time integrator. 53209f67acb7SJed Brown 53219f67acb7SJed Brown Not Collective 53229f67acb7SJed Brown 53239f67acb7SJed Brown Input Parameter: 53249f67acb7SJed Brown . ts - TS context 53259f67acb7SJed Brown 53269f67acb7SJed Brown Output Parameter: 53279f67acb7SJed Brown . nits - number of nonlinear iterations 53289f67acb7SJed Brown 53299f67acb7SJed Brown Notes: 53309f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 53319f67acb7SJed Brown 53329f67acb7SJed Brown Level: intermediate 53339f67acb7SJed Brown 53345ef26d82SJed Brown .seealso: TSGetKSPIterations() 53359f67acb7SJed Brown @*/ 53365ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits) 53379f67acb7SJed Brown { 53389f67acb7SJed Brown PetscFunctionBegin; 53399f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53409f67acb7SJed Brown PetscValidIntPointer(nits,2); 53415ef26d82SJed Brown *nits = ts->snes_its; 53429f67acb7SJed Brown PetscFunctionReturn(0); 53439f67acb7SJed Brown } 53449f67acb7SJed Brown 53459f67acb7SJed Brown /*@ 53465ef26d82SJed Brown TSGetKSPIterations - Gets the total number of linear iterations 53479f67acb7SJed Brown used by the time integrator. 53489f67acb7SJed Brown 53499f67acb7SJed Brown Not Collective 53509f67acb7SJed Brown 53519f67acb7SJed Brown Input Parameter: 53529f67acb7SJed Brown . ts - TS context 53539f67acb7SJed Brown 53549f67acb7SJed Brown Output Parameter: 53559f67acb7SJed Brown . lits - number of linear iterations 53569f67acb7SJed Brown 53579f67acb7SJed Brown Notes: 53589f67acb7SJed Brown This counter is reset to zero for each successive call to TSSolve(). 53599f67acb7SJed Brown 53609f67acb7SJed Brown Level: intermediate 53619f67acb7SJed Brown 53625ef26d82SJed Brown .seealso: TSGetSNESIterations(), SNESGetKSPIterations() 53639f67acb7SJed Brown @*/ 53645ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits) 53659f67acb7SJed Brown { 53669f67acb7SJed Brown PetscFunctionBegin; 53679f67acb7SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 53689f67acb7SJed Brown PetscValidIntPointer(lits,2); 53695ef26d82SJed Brown *lits = ts->ksp_its; 53709f67acb7SJed Brown PetscFunctionReturn(0); 53719f67acb7SJed Brown } 53729f67acb7SJed Brown 5373cef5090cSJed Brown /*@ 5374cef5090cSJed Brown TSGetStepRejections - Gets the total number of rejected steps. 5375cef5090cSJed Brown 5376cef5090cSJed Brown Not Collective 5377cef5090cSJed Brown 5378cef5090cSJed Brown Input Parameter: 5379cef5090cSJed Brown . ts - TS context 5380cef5090cSJed Brown 5381cef5090cSJed Brown Output Parameter: 5382cef5090cSJed Brown . rejects - number of steps rejected 5383cef5090cSJed Brown 5384cef5090cSJed Brown Notes: 5385cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5386cef5090cSJed Brown 5387cef5090cSJed Brown Level: intermediate 5388cef5090cSJed Brown 53895ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails() 5390cef5090cSJed Brown @*/ 5391cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects) 5392cef5090cSJed Brown { 5393cef5090cSJed Brown PetscFunctionBegin; 5394cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5395cef5090cSJed Brown PetscValidIntPointer(rejects,2); 5396cef5090cSJed Brown *rejects = ts->reject; 5397cef5090cSJed Brown PetscFunctionReturn(0); 5398cef5090cSJed Brown } 5399cef5090cSJed Brown 5400cef5090cSJed Brown /*@ 5401cef5090cSJed Brown TSGetSNESFailures - Gets the total number of failed SNES solves 5402cef5090cSJed Brown 5403cef5090cSJed Brown Not Collective 5404cef5090cSJed Brown 5405cef5090cSJed Brown Input Parameter: 5406cef5090cSJed Brown . ts - TS context 5407cef5090cSJed Brown 5408cef5090cSJed Brown Output Parameter: 5409cef5090cSJed Brown . fails - number of failed nonlinear solves 5410cef5090cSJed Brown 5411cef5090cSJed Brown Notes: 5412cef5090cSJed Brown This counter is reset to zero for each successive call to TSSolve(). 5413cef5090cSJed Brown 5414cef5090cSJed Brown Level: intermediate 5415cef5090cSJed Brown 54165ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures() 5417cef5090cSJed Brown @*/ 5418cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails) 5419cef5090cSJed Brown { 5420cef5090cSJed Brown PetscFunctionBegin; 5421cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5422cef5090cSJed Brown PetscValidIntPointer(fails,2); 5423cef5090cSJed Brown *fails = ts->num_snes_failures; 5424cef5090cSJed Brown PetscFunctionReturn(0); 5425cef5090cSJed Brown } 5426cef5090cSJed Brown 5427cef5090cSJed Brown /*@ 5428cef5090cSJed Brown TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails 5429cef5090cSJed Brown 5430cef5090cSJed Brown Not Collective 5431cef5090cSJed Brown 5432cef5090cSJed Brown Input Parameter: 5433cef5090cSJed Brown + ts - TS context 5434cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited 5435cef5090cSJed Brown 5436cef5090cSJed Brown Notes: 5437cef5090cSJed Brown The counter is reset to zero for each step 5438cef5090cSJed Brown 5439cef5090cSJed Brown Options Database Key: 5440cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails 5441cef5090cSJed Brown 5442cef5090cSJed Brown Level: intermediate 5443cef5090cSJed Brown 54445ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5445cef5090cSJed Brown @*/ 5446cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects) 5447cef5090cSJed Brown { 5448cef5090cSJed Brown PetscFunctionBegin; 5449cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5450cef5090cSJed Brown ts->max_reject = rejects; 5451cef5090cSJed Brown PetscFunctionReturn(0); 5452cef5090cSJed Brown } 5453cef5090cSJed Brown 5454cef5090cSJed Brown /*@ 5455cef5090cSJed Brown TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves 5456cef5090cSJed Brown 5457cef5090cSJed Brown Not Collective 5458cef5090cSJed Brown 5459cef5090cSJed Brown Input Parameter: 5460cef5090cSJed Brown + ts - TS context 5461cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 5462cef5090cSJed Brown 5463cef5090cSJed Brown Notes: 5464cef5090cSJed Brown The counter is reset to zero for each successive call to TSSolve(). 5465cef5090cSJed Brown 5466cef5090cSJed Brown Options Database Key: 5467cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures 5468cef5090cSJed Brown 5469cef5090cSJed Brown Level: intermediate 5470cef5090cSJed Brown 54715ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason() 5472cef5090cSJed Brown @*/ 5473cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails) 5474cef5090cSJed Brown { 5475cef5090cSJed Brown PetscFunctionBegin; 5476cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5477cef5090cSJed Brown ts->max_snes_failures = fails; 5478cef5090cSJed Brown PetscFunctionReturn(0); 5479cef5090cSJed Brown } 5480cef5090cSJed Brown 5481cef5090cSJed Brown /*@ 5482cef5090cSJed Brown TSSetErrorIfStepFails - Error if no step succeeds 5483cef5090cSJed Brown 5484cef5090cSJed Brown Not Collective 5485cef5090cSJed Brown 5486cef5090cSJed Brown Input Parameter: 5487cef5090cSJed Brown + ts - TS context 5488cef5090cSJed Brown - err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure 5489cef5090cSJed Brown 5490cef5090cSJed Brown Options Database Key: 5491cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds 5492cef5090cSJed Brown 5493cef5090cSJed Brown Level: intermediate 5494cef5090cSJed Brown 54955ef26d82SJed Brown .seealso: TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason() 5496cef5090cSJed Brown @*/ 5497cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err) 5498cef5090cSJed Brown { 5499cef5090cSJed Brown PetscFunctionBegin; 5500cef5090cSJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5501cef5090cSJed Brown ts->errorifstepfailed = err; 5502cef5090cSJed Brown PetscFunctionReturn(0); 5503cef5090cSJed Brown } 5504cef5090cSJed Brown 5505fb1732b5SBarry Smith /*@C 5506fde5950dSBarry 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 5507fb1732b5SBarry Smith 5508fb1732b5SBarry Smith Collective on TS 5509fb1732b5SBarry Smith 5510fb1732b5SBarry Smith Input Parameters: 5511fb1732b5SBarry Smith + ts - the TS context 5512fb1732b5SBarry Smith . step - current time-step 5513fb1732b5SBarry Smith . ptime - current time 55140910c330SBarry Smith . u - current state 5515721cd6eeSBarry Smith - vf - viewer and its format 5516fb1732b5SBarry Smith 5517fb1732b5SBarry Smith Level: intermediate 5518fb1732b5SBarry Smith 5519fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5520fb1732b5SBarry Smith @*/ 5521721cd6eeSBarry Smith PetscErrorCode TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 5522fb1732b5SBarry Smith { 5523fb1732b5SBarry Smith PetscErrorCode ierr; 5524fb1732b5SBarry Smith 5525fb1732b5SBarry Smith PetscFunctionBegin; 5526721cd6eeSBarry Smith ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr); 5527721cd6eeSBarry Smith ierr = VecView(u,vf->viewer);CHKERRQ(ierr); 5528721cd6eeSBarry Smith ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr); 5529ed81e22dSJed Brown PetscFunctionReturn(0); 5530ed81e22dSJed Brown } 5531ed81e22dSJed Brown 5532ed81e22dSJed Brown /*@C 5533ed81e22dSJed Brown TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep. 5534ed81e22dSJed Brown 5535ed81e22dSJed Brown Collective on TS 5536ed81e22dSJed Brown 5537ed81e22dSJed Brown Input Parameters: 5538ed81e22dSJed Brown + ts - the TS context 5539ed81e22dSJed Brown . step - current time-step 5540ed81e22dSJed Brown . ptime - current time 55410910c330SBarry Smith . u - current state 5542ed81e22dSJed Brown - filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5543ed81e22dSJed Brown 5544ed81e22dSJed Brown Level: intermediate 5545ed81e22dSJed Brown 5546ed81e22dSJed Brown Notes: 5547ed81e22dSJed 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. 5548ed81e22dSJed Brown These are named according to the file name template. 5549ed81e22dSJed Brown 5550ed81e22dSJed Brown This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy(). 5551ed81e22dSJed Brown 5552ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView() 5553ed81e22dSJed Brown @*/ 55540910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate) 5555ed81e22dSJed Brown { 5556ed81e22dSJed Brown PetscErrorCode ierr; 5557ed81e22dSJed Brown char filename[PETSC_MAX_PATH_LEN]; 5558ed81e22dSJed Brown PetscViewer viewer; 5559ed81e22dSJed Brown 5560ed81e22dSJed Brown PetscFunctionBegin; 556163e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 55628caf3d72SBarry Smith ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr); 5563ce94432eSBarry Smith ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr); 55640910c330SBarry Smith ierr = VecView(u,viewer);CHKERRQ(ierr); 5565ed81e22dSJed Brown ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 5566ed81e22dSJed Brown PetscFunctionReturn(0); 5567ed81e22dSJed Brown } 5568ed81e22dSJed Brown 5569ed81e22dSJed Brown /*@C 5570ed81e22dSJed Brown TSMonitorSolutionVTKDestroy - Destroy context for monitoring 5571ed81e22dSJed Brown 5572ed81e22dSJed Brown Collective on TS 5573ed81e22dSJed Brown 5574ed81e22dSJed Brown Input Parameters: 5575ed81e22dSJed Brown . filenametemplate - string containing a format specifier for the integer time step (e.g. %03D) 5576ed81e22dSJed Brown 5577ed81e22dSJed Brown Level: intermediate 5578ed81e22dSJed Brown 5579ed81e22dSJed Brown Note: 5580ed81e22dSJed Brown This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK(). 5581ed81e22dSJed Brown 5582ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK() 5583ed81e22dSJed Brown @*/ 5584ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate) 5585ed81e22dSJed Brown { 5586ed81e22dSJed Brown PetscErrorCode ierr; 5587ed81e22dSJed Brown 5588ed81e22dSJed Brown PetscFunctionBegin; 5589ed81e22dSJed Brown ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr); 5590fb1732b5SBarry Smith PetscFunctionReturn(0); 5591fb1732b5SBarry Smith } 5592fb1732b5SBarry Smith 559384df9cb4SJed Brown /*@ 5594552698daSJed Brown TSGetAdapt - Get the adaptive controller context for the current method 559584df9cb4SJed Brown 5596ed81e22dSJed Brown Collective on TS if controller has not been created yet 559784df9cb4SJed Brown 559884df9cb4SJed Brown Input Arguments: 5599ed81e22dSJed Brown . ts - time stepping context 560084df9cb4SJed Brown 560184df9cb4SJed Brown Output Arguments: 5602ed81e22dSJed Brown . adapt - adaptive controller 560384df9cb4SJed Brown 560484df9cb4SJed Brown Level: intermediate 560584df9cb4SJed Brown 5606ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose() 560784df9cb4SJed Brown @*/ 5608552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt) 560984df9cb4SJed Brown { 561084df9cb4SJed Brown PetscErrorCode ierr; 561184df9cb4SJed Brown 561284df9cb4SJed Brown PetscFunctionBegin; 561384df9cb4SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5614bec58848SLisandro Dalcin PetscValidPointer(adapt,2); 561584df9cb4SJed Brown if (!ts->adapt) { 5616ce94432eSBarry Smith ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr); 56173bb1ff40SBarry Smith ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr); 56181c3436cfSJed Brown ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr); 561984df9cb4SJed Brown } 5620bec58848SLisandro Dalcin *adapt = ts->adapt; 562184df9cb4SJed Brown PetscFunctionReturn(0); 562284df9cb4SJed Brown } 5623d6ebe24aSShri Abhyankar 56241c3436cfSJed Brown /*@ 56251c3436cfSJed Brown TSSetTolerances - Set tolerances for local truncation error when using adaptive controller 56261c3436cfSJed Brown 56271c3436cfSJed Brown Logically Collective 56281c3436cfSJed Brown 56291c3436cfSJed Brown Input Arguments: 56301c3436cfSJed Brown + ts - time integration context 56311c3436cfSJed Brown . atol - scalar absolute tolerances, PETSC_DECIDE to leave current value 56320298fd71SBarry Smith . vatol - vector of absolute tolerances or NULL, used in preference to atol if present 56331c3436cfSJed Brown . rtol - scalar relative tolerances, PETSC_DECIDE to leave current value 56340298fd71SBarry Smith - vrtol - vector of relative tolerances or NULL, used in preference to atol if present 56351c3436cfSJed Brown 5636a3cdaa26SBarry Smith Options Database keys: 5637a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error 5638a3cdaa26SBarry Smith - -ts_atol <atol> Absolute tolerance for local truncation error 5639a3cdaa26SBarry Smith 56403ff766beSShri Abhyankar Notes: 56413ff766beSShri Abhyankar With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 56423ff766beSShri Abhyankar (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 56433ff766beSShri Abhyankar computed only for the differential or the algebraic part then this can be done using the vector of 56443ff766beSShri Abhyankar tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 56453ff766beSShri Abhyankar differential part and infinity for the algebraic part, the LTE calculation will include only the 56463ff766beSShri Abhyankar differential variables. 56473ff766beSShri Abhyankar 56481c3436cfSJed Brown Level: beginner 56491c3436cfSJed Brown 56505c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSGetTolerances() 56511c3436cfSJed Brown @*/ 56521c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol) 56531c3436cfSJed Brown { 56541c3436cfSJed Brown PetscErrorCode ierr; 56551c3436cfSJed Brown 56561c3436cfSJed Brown PetscFunctionBegin; 5657c5033834SJed Brown if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol; 56581c3436cfSJed Brown if (vatol) { 56591c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr); 56601c3436cfSJed Brown ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr); 56611c3436cfSJed Brown ts->vatol = vatol; 56621c3436cfSJed Brown } 5663c5033834SJed Brown if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol; 56641c3436cfSJed Brown if (vrtol) { 56651c3436cfSJed Brown ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr); 56661c3436cfSJed Brown ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr); 56671c3436cfSJed Brown ts->vrtol = vrtol; 56681c3436cfSJed Brown } 56691c3436cfSJed Brown PetscFunctionReturn(0); 56701c3436cfSJed Brown } 56711c3436cfSJed Brown 5672c5033834SJed Brown /*@ 5673c5033834SJed Brown TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 5674c5033834SJed Brown 5675c5033834SJed Brown Logically Collective 5676c5033834SJed Brown 5677c5033834SJed Brown Input Arguments: 5678c5033834SJed Brown . ts - time integration context 5679c5033834SJed Brown 5680c5033834SJed Brown Output Arguments: 56810298fd71SBarry Smith + atol - scalar absolute tolerances, NULL to ignore 56820298fd71SBarry Smith . vatol - vector of absolute tolerances, NULL to ignore 56830298fd71SBarry Smith . rtol - scalar relative tolerances, NULL to ignore 56840298fd71SBarry Smith - vrtol - vector of relative tolerances, NULL to ignore 5685c5033834SJed Brown 5686c5033834SJed Brown Level: beginner 5687c5033834SJed Brown 56885c01a8f1SJed Brown .seealso: TS, TSAdapt, TSErrorWeightedNorm(), TSSetTolerances() 5689c5033834SJed Brown @*/ 5690c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol) 5691c5033834SJed Brown { 5692c5033834SJed Brown PetscFunctionBegin; 5693c5033834SJed Brown if (atol) *atol = ts->atol; 5694c5033834SJed Brown if (vatol) *vatol = ts->vatol; 5695c5033834SJed Brown if (rtol) *rtol = ts->rtol; 5696c5033834SJed Brown if (vrtol) *vrtol = ts->vrtol; 5697c5033834SJed Brown PetscFunctionReturn(0); 5698c5033834SJed Brown } 5699c5033834SJed Brown 57009c6b16b5SShri Abhyankar /*@ 5701a4868fbcSLisandro Dalcin TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors 57029c6b16b5SShri Abhyankar 57039c6b16b5SShri Abhyankar Collective on TS 57049c6b16b5SShri Abhyankar 57059c6b16b5SShri Abhyankar Input Arguments: 57069c6b16b5SShri Abhyankar + ts - time stepping context 5707a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5708a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 57099c6b16b5SShri Abhyankar 57109c6b16b5SShri Abhyankar Output Arguments: 5711a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 57127453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5713a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 57149c6b16b5SShri Abhyankar 57159c6b16b5SShri Abhyankar Level: developer 57169c6b16b5SShri Abhyankar 5717deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity() 57189c6b16b5SShri Abhyankar @*/ 57197453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 57209c6b16b5SShri Abhyankar { 57219c6b16b5SShri Abhyankar PetscErrorCode ierr; 57229c6b16b5SShri Abhyankar PetscInt i,n,N,rstart; 57237453f775SEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 57247453f775SEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 57259c6b16b5SShri Abhyankar const PetscScalar *u,*y; 57267453f775SEmil Constantinescu PetscReal sum,suma,sumr,gsum,gsuma,gsumr,diff; 57277453f775SEmil Constantinescu PetscReal tol,tola,tolr; 57287453f775SEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 57299c6b16b5SShri Abhyankar 57309c6b16b5SShri Abhyankar PetscFunctionBegin; 57319c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5732a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5733a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5734a4868fbcSLisandro Dalcin PetscValidType(U,2); 5735a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5736a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5737a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 57388a175baeSEmil Constantinescu PetscValidPointer(norma,5); 57398a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5740a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 57419c6b16b5SShri Abhyankar 57429c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 57439c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 57449c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 57459c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 57469c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 57477453f775SEmil Constantinescu sum = 0.; n_loc = 0; 57487453f775SEmil Constantinescu suma = 0.; na_loc = 0; 57497453f775SEmil Constantinescu sumr = 0.; nr_loc = 0; 57509c6b16b5SShri Abhyankar if (ts->vatol && ts->vrtol) { 57519c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 57529c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57539c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57549c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 575576cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 57567453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57577453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 57587453f775SEmil Constantinescu if (tola>0.){ 57597453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 57607453f775SEmil Constantinescu na_loc++; 57617453f775SEmil Constantinescu } 57627453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57637453f775SEmil Constantinescu if (tolr>0.){ 57647453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 57657453f775SEmil Constantinescu nr_loc++; 57667453f775SEmil Constantinescu } 57677453f775SEmil Constantinescu tol=tola+tolr; 57687453f775SEmil Constantinescu if (tol>0.){ 57697453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 57707453f775SEmil Constantinescu n_loc++; 57717453f775SEmil Constantinescu } 57729c6b16b5SShri Abhyankar } 57739c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57749c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 57759c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 57769c6b16b5SShri Abhyankar const PetscScalar *atol; 57779c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57789c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 577976cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 57807453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 57817453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 57827453f775SEmil Constantinescu if (tola>0.){ 57837453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 57847453f775SEmil Constantinescu na_loc++; 57857453f775SEmil Constantinescu } 57867453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 57877453f775SEmil Constantinescu if (tolr>0.){ 57887453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 57897453f775SEmil Constantinescu nr_loc++; 57907453f775SEmil Constantinescu } 57917453f775SEmil Constantinescu tol=tola+tolr; 57927453f775SEmil Constantinescu if (tol>0.){ 57937453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 57947453f775SEmil Constantinescu n_loc++; 57957453f775SEmil Constantinescu } 57969c6b16b5SShri Abhyankar } 57979c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 57989c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 57999c6b16b5SShri Abhyankar const PetscScalar *rtol; 58009c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58019c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 580276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 58037453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58047453f775SEmil Constantinescu tola = ts->atol; 58057453f775SEmil Constantinescu if (tola>0.){ 58067453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58077453f775SEmil Constantinescu na_loc++; 58087453f775SEmil Constantinescu } 58097453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58107453f775SEmil Constantinescu if (tolr>0.){ 58117453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58127453f775SEmil Constantinescu nr_loc++; 58137453f775SEmil Constantinescu } 58147453f775SEmil Constantinescu tol=tola+tolr; 58157453f775SEmil Constantinescu if (tol>0.){ 58167453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58177453f775SEmil Constantinescu n_loc++; 58187453f775SEmil Constantinescu } 58199c6b16b5SShri Abhyankar } 58209c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 58219c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 58229c6b16b5SShri Abhyankar for (i=0; i<n; i++) { 582376cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 58247453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 58257453f775SEmil Constantinescu tola = ts->atol; 58267453f775SEmil Constantinescu if (tola>0.){ 58277453f775SEmil Constantinescu suma += PetscSqr(diff/tola); 58287453f775SEmil Constantinescu na_loc++; 58297453f775SEmil Constantinescu } 58307453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 58317453f775SEmil Constantinescu if (tolr>0.){ 58327453f775SEmil Constantinescu sumr += PetscSqr(diff/tolr); 58337453f775SEmil Constantinescu nr_loc++; 58347453f775SEmil Constantinescu } 58357453f775SEmil Constantinescu tol=tola+tolr; 58367453f775SEmil Constantinescu if (tol>0.){ 58377453f775SEmil Constantinescu sum += PetscSqr(diff/tol); 58387453f775SEmil Constantinescu n_loc++; 58397453f775SEmil Constantinescu } 58409c6b16b5SShri Abhyankar } 58419c6b16b5SShri Abhyankar } 58429c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 58439c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 58449c6b16b5SShri Abhyankar 58457453f775SEmil Constantinescu err_loc[0] = sum; 58467453f775SEmil Constantinescu err_loc[1] = suma; 58477453f775SEmil Constantinescu err_loc[2] = sumr; 58487453f775SEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 58497453f775SEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 58507453f775SEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 58517453f775SEmil Constantinescu 5852a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 58537453f775SEmil Constantinescu 58547453f775SEmil Constantinescu gsum = err_glb[0]; 58557453f775SEmil Constantinescu gsuma = err_glb[1]; 58567453f775SEmil Constantinescu gsumr = err_glb[2]; 58577453f775SEmil Constantinescu n_glb = err_glb[3]; 58587453f775SEmil Constantinescu na_glb = err_glb[4]; 58597453f775SEmil Constantinescu nr_glb = err_glb[5]; 58607453f775SEmil Constantinescu 5861b1316ef9SEmil Constantinescu *norm = 0.; 5862b1316ef9SEmil Constantinescu if (n_glb>0.){*norm = PetscSqrtReal(gsum / n_glb);} 5863b1316ef9SEmil Constantinescu *norma = 0.; 5864b1316ef9SEmil Constantinescu if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 5865b1316ef9SEmil Constantinescu *normr = 0.; 5866b1316ef9SEmil Constantinescu if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 58679c6b16b5SShri Abhyankar 58689c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 58697453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 58707453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 58719c6b16b5SShri Abhyankar PetscFunctionReturn(0); 58729c6b16b5SShri Abhyankar } 58739c6b16b5SShri Abhyankar 58749c6b16b5SShri Abhyankar /*@ 5875a4868fbcSLisandro Dalcin TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors 58769c6b16b5SShri Abhyankar 58779c6b16b5SShri Abhyankar Collective on TS 58789c6b16b5SShri Abhyankar 58799c6b16b5SShri Abhyankar Input Arguments: 58809c6b16b5SShri Abhyankar + ts - time stepping context 5881a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 5882a4868fbcSLisandro Dalcin - Y - state vector to be compared to U 58839c6b16b5SShri Abhyankar 58849c6b16b5SShri Abhyankar Output Arguments: 5885a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 58867453f775SEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 5887a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 58889c6b16b5SShri Abhyankar 58899c6b16b5SShri Abhyankar Level: developer 58909c6b16b5SShri Abhyankar 5891deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2() 58929c6b16b5SShri Abhyankar @*/ 58937453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 58949c6b16b5SShri Abhyankar { 58959c6b16b5SShri Abhyankar PetscErrorCode ierr; 58967453f775SEmil Constantinescu PetscInt i,n,N,rstart; 58979c6b16b5SShri Abhyankar const PetscScalar *u,*y; 58987453f775SEmil Constantinescu PetscReal max,gmax,maxa,gmaxa,maxr,gmaxr; 58997453f775SEmil Constantinescu PetscReal tol,tola,tolr,diff; 59007453f775SEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 59019c6b16b5SShri Abhyankar 59029c6b16b5SShri Abhyankar PetscFunctionBegin; 59039c6b16b5SShri Abhyankar PetscValidHeaderSpecific(ts,TS_CLASSID,1); 5904a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(U,VEC_CLASSID,2); 5905a4868fbcSLisandro Dalcin PetscValidHeaderSpecific(Y,VEC_CLASSID,3); 5906a4868fbcSLisandro Dalcin PetscValidType(U,2); 5907a4868fbcSLisandro Dalcin PetscValidType(Y,3); 5908a4868fbcSLisandro Dalcin PetscCheckSameComm(U,2,Y,3); 5909a4868fbcSLisandro Dalcin PetscValidPointer(norm,4); 59108a175baeSEmil Constantinescu PetscValidPointer(norma,5); 59118a175baeSEmil Constantinescu PetscValidPointer(normr,6); 5912a4868fbcSLisandro Dalcin if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector"); 59139c6b16b5SShri Abhyankar 59149c6b16b5SShri Abhyankar ierr = VecGetSize(U,&N);CHKERRQ(ierr); 59159c6b16b5SShri Abhyankar ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr); 59169c6b16b5SShri Abhyankar ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr); 59179c6b16b5SShri Abhyankar ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 59189c6b16b5SShri Abhyankar ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 59197453f775SEmil Constantinescu 59207453f775SEmil Constantinescu max=0.; 59217453f775SEmil Constantinescu maxa=0.; 59227453f775SEmil Constantinescu maxr=0.; 59237453f775SEmil Constantinescu 59247453f775SEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 59259c6b16b5SShri Abhyankar const PetscScalar *atol,*rtol; 59269c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59279c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59287453f775SEmil Constantinescu 59297453f775SEmil Constantinescu for (i=0; i<n; i++) { 593076cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 59317453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59327453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 59337453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59347453f775SEmil Constantinescu tol = tola+tolr; 59357453f775SEmil Constantinescu if (tola>0.){ 59367453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 59377453f775SEmil Constantinescu } 59387453f775SEmil Constantinescu if (tolr>0.){ 59397453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 59407453f775SEmil Constantinescu } 59417453f775SEmil Constantinescu if (tol>0.){ 59427453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 59437453f775SEmil Constantinescu } 59449c6b16b5SShri Abhyankar } 59459c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59469c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59479c6b16b5SShri Abhyankar } else if (ts->vatol) { /* vector atol, scalar rtol */ 59489c6b16b5SShri Abhyankar const PetscScalar *atol; 59499c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59507453f775SEmil Constantinescu for (i=0; i<n; i++) { 595176cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 59527453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59537453f775SEmil Constantinescu tola = PetscRealPart(atol[i]); 59547453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59557453f775SEmil Constantinescu tol = tola+tolr; 59567453f775SEmil Constantinescu if (tola>0.){ 59577453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 59587453f775SEmil Constantinescu } 59597453f775SEmil Constantinescu if (tolr>0.){ 59607453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 59617453f775SEmil Constantinescu } 59627453f775SEmil Constantinescu if (tol>0.){ 59637453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 59647453f775SEmil Constantinescu } 59659c6b16b5SShri Abhyankar } 59669c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 59679c6b16b5SShri Abhyankar } else if (ts->vrtol) { /* scalar atol, vector rtol */ 59689c6b16b5SShri Abhyankar const PetscScalar *rtol; 59699c6b16b5SShri Abhyankar ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59707453f775SEmil Constantinescu 59717453f775SEmil Constantinescu for (i=0; i<n; i++) { 597276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 59737453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59747453f775SEmil Constantinescu tola = ts->atol; 59757453f775SEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59767453f775SEmil Constantinescu tol = tola+tolr; 59777453f775SEmil Constantinescu if (tola>0.){ 59787453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 59797453f775SEmil Constantinescu } 59807453f775SEmil Constantinescu if (tolr>0.){ 59817453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 59827453f775SEmil Constantinescu } 59837453f775SEmil Constantinescu if (tol>0.){ 59847453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 59857453f775SEmil Constantinescu } 59869c6b16b5SShri Abhyankar } 59879c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 59889c6b16b5SShri Abhyankar } else { /* scalar atol, scalar rtol */ 59897453f775SEmil Constantinescu 59907453f775SEmil Constantinescu for (i=0; i<n; i++) { 599176cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 59927453f775SEmil Constantinescu diff = PetscAbsScalar(y[i] - u[i]); 59937453f775SEmil Constantinescu tola = ts->atol; 59947453f775SEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 59957453f775SEmil Constantinescu tol = tola+tolr; 59967453f775SEmil Constantinescu if (tola>0.){ 59977453f775SEmil Constantinescu maxa = PetscMax(maxa,diff / tola); 59987453f775SEmil Constantinescu } 59997453f775SEmil Constantinescu if (tolr>0.){ 60007453f775SEmil Constantinescu maxr = PetscMax(maxr,diff / tolr); 60017453f775SEmil Constantinescu } 60027453f775SEmil Constantinescu if (tol>0.){ 60037453f775SEmil Constantinescu max = PetscMax(max,diff / tol); 60047453f775SEmil Constantinescu } 60059c6b16b5SShri Abhyankar } 60069c6b16b5SShri Abhyankar } 60079c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 60089c6b16b5SShri Abhyankar ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 60097453f775SEmil Constantinescu err_loc[0] = max; 60107453f775SEmil Constantinescu err_loc[1] = maxa; 60117453f775SEmil Constantinescu err_loc[2] = maxr; 6012a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 60137453f775SEmil Constantinescu gmax = err_glb[0]; 60147453f775SEmil Constantinescu gmaxa = err_glb[1]; 60157453f775SEmil Constantinescu gmaxr = err_glb[2]; 60169c6b16b5SShri Abhyankar 60179c6b16b5SShri Abhyankar *norm = gmax; 60187453f775SEmil Constantinescu *norma = gmaxa; 60197453f775SEmil Constantinescu *normr = gmaxr; 60209c6b16b5SShri Abhyankar if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 60217453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 60227453f775SEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 60239c6b16b5SShri Abhyankar PetscFunctionReturn(0); 60249c6b16b5SShri Abhyankar } 60259c6b16b5SShri Abhyankar 60261c3436cfSJed Brown /*@ 60278a175baeSEmil Constantinescu TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 60281c3436cfSJed Brown 60291c3436cfSJed Brown Collective on TS 60301c3436cfSJed Brown 60311c3436cfSJed Brown Input Arguments: 60321c3436cfSJed Brown + ts - time stepping context 6033a4868fbcSLisandro Dalcin . U - state vector, usually ts->vec_sol 6034a4868fbcSLisandro Dalcin . Y - state vector to be compared to U 6035a4868fbcSLisandro Dalcin - wnormtype - norm type, either NORM_2 or NORM_INFINITY 60367619abb3SShri 60371c3436cfSJed Brown Output Arguments: 6038a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 60398a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 6040a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 6041a4868fbcSLisandro Dalcin 6042a4868fbcSLisandro Dalcin Options Database Keys: 6043a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 6044a4868fbcSLisandro Dalcin 60451c3436cfSJed Brown Level: developer 60461c3436cfSJed Brown 60478a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm 60481c3436cfSJed Brown @*/ 60497453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60501c3436cfSJed Brown { 60518beabaa1SBarry Smith PetscErrorCode ierr; 60521c3436cfSJed Brown 60531c3436cfSJed Brown PetscFunctionBegin; 6054a4868fbcSLisandro Dalcin if (wnormtype == NORM_2) { 60557453f775SEmil Constantinescu ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6056a4868fbcSLisandro Dalcin } else if (wnormtype == NORM_INFINITY) { 60577453f775SEmil Constantinescu ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr); 6058a4868fbcSLisandro Dalcin } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 60591c3436cfSJed Brown PetscFunctionReturn(0); 60601c3436cfSJed Brown } 60611c3436cfSJed Brown 60628a175baeSEmil Constantinescu 60638a175baeSEmil Constantinescu /*@ 60648a175baeSEmil Constantinescu TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances 60658a175baeSEmil Constantinescu 60668a175baeSEmil Constantinescu Collective on TS 60678a175baeSEmil Constantinescu 60688a175baeSEmil Constantinescu Input Arguments: 60698a175baeSEmil Constantinescu + ts - time stepping context 60708a175baeSEmil Constantinescu . E - error vector 60718a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 60728a175baeSEmil Constantinescu - Y - state vector, previous time step 60738a175baeSEmil Constantinescu 60748a175baeSEmil Constantinescu Output Arguments: 6075a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 60768a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 6077a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 60788a175baeSEmil Constantinescu 60798a175baeSEmil Constantinescu Level: developer 60808a175baeSEmil Constantinescu 60818a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity() 60828a175baeSEmil Constantinescu @*/ 60838a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 60848a175baeSEmil Constantinescu { 60858a175baeSEmil Constantinescu PetscErrorCode ierr; 60868a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 60878a175baeSEmil Constantinescu PetscInt n_loc,na_loc,nr_loc; 60888a175baeSEmil Constantinescu PetscReal n_glb,na_glb,nr_glb; 60898a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 60908a175baeSEmil Constantinescu PetscReal err,sum,suma,sumr,gsum,gsuma,gsumr; 60918a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 60928a175baeSEmil Constantinescu PetscReal err_loc[6],err_glb[6]; 60938a175baeSEmil Constantinescu 60948a175baeSEmil Constantinescu PetscFunctionBegin; 60958a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 60968a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 60978a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 60988a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 60998a175baeSEmil Constantinescu PetscValidType(E,2); 61008a175baeSEmil Constantinescu PetscValidType(U,3); 61018a175baeSEmil Constantinescu PetscValidType(Y,4); 61028a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 61038a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 61048a175baeSEmil Constantinescu PetscValidPointer(norm,5); 61058a175baeSEmil Constantinescu PetscValidPointer(norma,6); 61068a175baeSEmil Constantinescu PetscValidPointer(normr,7); 61078a175baeSEmil Constantinescu 61088a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 61098a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 61108a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 61118a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 61128a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 61138a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 61148a175baeSEmil Constantinescu sum = 0.; n_loc = 0; 61158a175baeSEmil Constantinescu suma = 0.; na_loc = 0; 61168a175baeSEmil Constantinescu sumr = 0.; nr_loc = 0; 61178a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { 61188a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 61198a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 61208a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61218a175baeSEmil Constantinescu for (i=0; i<n; i++) { 612276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 61238a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61248a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 61258a175baeSEmil Constantinescu if (tola>0.){ 61268a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 61278a175baeSEmil Constantinescu na_loc++; 61288a175baeSEmil Constantinescu } 61298a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61308a175baeSEmil Constantinescu if (tolr>0.){ 61318a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 61328a175baeSEmil Constantinescu nr_loc++; 61338a175baeSEmil Constantinescu } 61348a175baeSEmil Constantinescu tol=tola+tolr; 61358a175baeSEmil Constantinescu if (tol>0.){ 61368a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 61378a175baeSEmil Constantinescu n_loc++; 61388a175baeSEmil Constantinescu } 61398a175baeSEmil Constantinescu } 61408a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 61418a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61428a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 61438a175baeSEmil Constantinescu const PetscScalar *atol; 61448a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 61458a175baeSEmil Constantinescu for (i=0; i<n; i++) { 614676cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 61478a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61488a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 61498a175baeSEmil Constantinescu if (tola>0.){ 61508a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 61518a175baeSEmil Constantinescu na_loc++; 61528a175baeSEmil Constantinescu } 61538a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61548a175baeSEmil Constantinescu if (tolr>0.){ 61558a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 61568a175baeSEmil Constantinescu nr_loc++; 61578a175baeSEmil Constantinescu } 61588a175baeSEmil Constantinescu tol=tola+tolr; 61598a175baeSEmil Constantinescu if (tol>0.){ 61608a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 61618a175baeSEmil Constantinescu n_loc++; 61628a175baeSEmil Constantinescu } 61638a175baeSEmil Constantinescu } 61648a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 61658a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 61668a175baeSEmil Constantinescu const PetscScalar *rtol; 61678a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61688a175baeSEmil Constantinescu for (i=0; i<n; i++) { 616976cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 61708a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61718a175baeSEmil Constantinescu tola = ts->atol; 61728a175baeSEmil Constantinescu if (tola>0.){ 61738a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 61748a175baeSEmil Constantinescu na_loc++; 61758a175baeSEmil Constantinescu } 61768a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61778a175baeSEmil Constantinescu if (tolr>0.){ 61788a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 61798a175baeSEmil Constantinescu nr_loc++; 61808a175baeSEmil Constantinescu } 61818a175baeSEmil Constantinescu tol=tola+tolr; 61828a175baeSEmil Constantinescu if (tol>0.){ 61838a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 61848a175baeSEmil Constantinescu n_loc++; 61858a175baeSEmil Constantinescu } 61868a175baeSEmil Constantinescu } 61878a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 61888a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 61898a175baeSEmil Constantinescu for (i=0; i<n; i++) { 619076cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 61918a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 61928a175baeSEmil Constantinescu tola = ts->atol; 61938a175baeSEmil Constantinescu if (tola>0.){ 61948a175baeSEmil Constantinescu suma += PetscSqr(err/tola); 61958a175baeSEmil Constantinescu na_loc++; 61968a175baeSEmil Constantinescu } 61978a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 61988a175baeSEmil Constantinescu if (tolr>0.){ 61998a175baeSEmil Constantinescu sumr += PetscSqr(err/tolr); 62008a175baeSEmil Constantinescu nr_loc++; 62018a175baeSEmil Constantinescu } 62028a175baeSEmil Constantinescu tol=tola+tolr; 62038a175baeSEmil Constantinescu if (tol>0.){ 62048a175baeSEmil Constantinescu sum += PetscSqr(err/tol); 62058a175baeSEmil Constantinescu n_loc++; 62068a175baeSEmil Constantinescu } 62078a175baeSEmil Constantinescu } 62088a175baeSEmil Constantinescu } 62098a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 62108a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 62118a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 62128a175baeSEmil Constantinescu 62138a175baeSEmil Constantinescu err_loc[0] = sum; 62148a175baeSEmil Constantinescu err_loc[1] = suma; 62158a175baeSEmil Constantinescu err_loc[2] = sumr; 62168a175baeSEmil Constantinescu err_loc[3] = (PetscReal)n_loc; 62178a175baeSEmil Constantinescu err_loc[4] = (PetscReal)na_loc; 62188a175baeSEmil Constantinescu err_loc[5] = (PetscReal)nr_loc; 62198a175baeSEmil Constantinescu 6220a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 62218a175baeSEmil Constantinescu 62228a175baeSEmil Constantinescu gsum = err_glb[0]; 62238a175baeSEmil Constantinescu gsuma = err_glb[1]; 62248a175baeSEmil Constantinescu gsumr = err_glb[2]; 62258a175baeSEmil Constantinescu n_glb = err_glb[3]; 62268a175baeSEmil Constantinescu na_glb = err_glb[4]; 62278a175baeSEmil Constantinescu nr_glb = err_glb[5]; 62288a175baeSEmil Constantinescu 62298a175baeSEmil Constantinescu *norm = 0.; 62308a175baeSEmil Constantinescu if (n_glb>0.){*norm = PetscSqrtReal(gsum / n_glb);} 62318a175baeSEmil Constantinescu *norma = 0.; 62328a175baeSEmil Constantinescu if (na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);} 62338a175baeSEmil Constantinescu *normr = 0.; 62348a175baeSEmil Constantinescu if (nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);} 62358a175baeSEmil Constantinescu 62368a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 62378a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 62388a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 62398a175baeSEmil Constantinescu PetscFunctionReturn(0); 62408a175baeSEmil Constantinescu } 62418a175baeSEmil Constantinescu 62428a175baeSEmil Constantinescu /*@ 62438a175baeSEmil Constantinescu TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances 62448a175baeSEmil Constantinescu Collective on TS 62458a175baeSEmil Constantinescu 62468a175baeSEmil Constantinescu Input Arguments: 62478a175baeSEmil Constantinescu + ts - time stepping context 62488a175baeSEmil Constantinescu . E - error vector 62498a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 62508a175baeSEmil Constantinescu - Y - state vector, previous time step 62518a175baeSEmil Constantinescu 62528a175baeSEmil Constantinescu Output Arguments: 6253a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 means that the error matches the tolerances 62548a175baeSEmil Constantinescu . norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances 6255a2b725a8SWilliam Gropp - normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances 62568a175baeSEmil Constantinescu 62578a175baeSEmil Constantinescu Level: developer 62588a175baeSEmil Constantinescu 62598a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2() 62608a175baeSEmil Constantinescu @*/ 62618a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr) 62628a175baeSEmil Constantinescu { 62638a175baeSEmil Constantinescu PetscErrorCode ierr; 62648a175baeSEmil Constantinescu PetscInt i,n,N,rstart; 62658a175baeSEmil Constantinescu const PetscScalar *e,*u,*y; 62668a175baeSEmil Constantinescu PetscReal err,max,gmax,maxa,gmaxa,maxr,gmaxr; 62678a175baeSEmil Constantinescu PetscReal tol,tola,tolr; 62688a175baeSEmil Constantinescu PetscReal err_loc[3],err_glb[3]; 62698a175baeSEmil Constantinescu 62708a175baeSEmil Constantinescu PetscFunctionBegin; 62718a175baeSEmil Constantinescu PetscValidHeaderSpecific(ts,TS_CLASSID,1); 62728a175baeSEmil Constantinescu PetscValidHeaderSpecific(E,VEC_CLASSID,2); 62738a175baeSEmil Constantinescu PetscValidHeaderSpecific(U,VEC_CLASSID,3); 62748a175baeSEmil Constantinescu PetscValidHeaderSpecific(Y,VEC_CLASSID,4); 62758a175baeSEmil Constantinescu PetscValidType(E,2); 62768a175baeSEmil Constantinescu PetscValidType(U,3); 62778a175baeSEmil Constantinescu PetscValidType(Y,4); 62788a175baeSEmil Constantinescu PetscCheckSameComm(E,2,U,3); 62798a175baeSEmil Constantinescu PetscCheckSameComm(U,2,Y,3); 62808a175baeSEmil Constantinescu PetscValidPointer(norm,5); 62818a175baeSEmil Constantinescu PetscValidPointer(norma,6); 62828a175baeSEmil Constantinescu PetscValidPointer(normr,7); 62838a175baeSEmil Constantinescu 62848a175baeSEmil Constantinescu ierr = VecGetSize(E,&N);CHKERRQ(ierr); 62858a175baeSEmil Constantinescu ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr); 62868a175baeSEmil Constantinescu ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr); 62878a175baeSEmil Constantinescu ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr); 62888a175baeSEmil Constantinescu ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr); 62898a175baeSEmil Constantinescu ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr); 62908a175baeSEmil Constantinescu 62918a175baeSEmil Constantinescu max=0.; 62928a175baeSEmil Constantinescu maxa=0.; 62938a175baeSEmil Constantinescu maxr=0.; 62948a175baeSEmil Constantinescu 62958a175baeSEmil Constantinescu if (ts->vatol && ts->vrtol) { /* vector atol, vector rtol */ 62968a175baeSEmil Constantinescu const PetscScalar *atol,*rtol; 62978a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 62988a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 62998a175baeSEmil Constantinescu 63008a175baeSEmil Constantinescu for (i=0; i<n; i++) { 630176cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 63028a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63038a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 63048a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63058a175baeSEmil Constantinescu tol = tola+tolr; 63068a175baeSEmil Constantinescu if (tola>0.){ 63078a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 63088a175baeSEmil Constantinescu } 63098a175baeSEmil Constantinescu if (tolr>0.){ 63108a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 63118a175baeSEmil Constantinescu } 63128a175baeSEmil Constantinescu if (tol>0.){ 63138a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 63148a175baeSEmil Constantinescu } 63158a175baeSEmil Constantinescu } 63168a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 63178a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 63188a175baeSEmil Constantinescu } else if (ts->vatol) { /* vector atol, scalar rtol */ 63198a175baeSEmil Constantinescu const PetscScalar *atol; 63208a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 63218a175baeSEmil Constantinescu for (i=0; i<n; i++) { 632276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 63238a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63248a175baeSEmil Constantinescu tola = PetscRealPart(atol[i]); 63258a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63268a175baeSEmil Constantinescu tol = tola+tolr; 63278a175baeSEmil Constantinescu if (tola>0.){ 63288a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 63298a175baeSEmil Constantinescu } 63308a175baeSEmil Constantinescu if (tolr>0.){ 63318a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 63328a175baeSEmil Constantinescu } 63338a175baeSEmil Constantinescu if (tol>0.){ 63348a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 63358a175baeSEmil Constantinescu } 63368a175baeSEmil Constantinescu } 63378a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr); 63388a175baeSEmil Constantinescu } else if (ts->vrtol) { /* scalar atol, vector rtol */ 63398a175baeSEmil Constantinescu const PetscScalar *rtol; 63408a175baeSEmil Constantinescu ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 63418a175baeSEmil Constantinescu 63428a175baeSEmil Constantinescu for (i=0; i<n; i++) { 634376cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 63448a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63458a175baeSEmil Constantinescu tola = ts->atol; 63468a175baeSEmil Constantinescu tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63478a175baeSEmil Constantinescu tol = tola+tolr; 63488a175baeSEmil Constantinescu if (tola>0.){ 63498a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 63508a175baeSEmil Constantinescu } 63518a175baeSEmil Constantinescu if (tolr>0.){ 63528a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 63538a175baeSEmil Constantinescu } 63548a175baeSEmil Constantinescu if (tol>0.){ 63558a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 63568a175baeSEmil Constantinescu } 63578a175baeSEmil Constantinescu } 63588a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr); 63598a175baeSEmil Constantinescu } else { /* scalar atol, scalar rtol */ 63608a175baeSEmil Constantinescu 63618a175baeSEmil Constantinescu for (i=0; i<n; i++) { 636276cddca1SEmil Constantinescu SkipSmallValue(y[i],u[i],ts->adapt->ignore_max); 63638a175baeSEmil Constantinescu err = PetscAbsScalar(e[i]); 63648a175baeSEmil Constantinescu tola = ts->atol; 63658a175baeSEmil Constantinescu tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i])); 63668a175baeSEmil Constantinescu tol = tola+tolr; 63678a175baeSEmil Constantinescu if (tola>0.){ 63688a175baeSEmil Constantinescu maxa = PetscMax(maxa,err / tola); 63698a175baeSEmil Constantinescu } 63708a175baeSEmil Constantinescu if (tolr>0.){ 63718a175baeSEmil Constantinescu maxr = PetscMax(maxr,err / tolr); 63728a175baeSEmil Constantinescu } 63738a175baeSEmil Constantinescu if (tol>0.){ 63748a175baeSEmil Constantinescu max = PetscMax(max,err / tol); 63758a175baeSEmil Constantinescu } 63768a175baeSEmil Constantinescu } 63778a175baeSEmil Constantinescu } 63788a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr); 63798a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr); 63808a175baeSEmil Constantinescu ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr); 63818a175baeSEmil Constantinescu err_loc[0] = max; 63828a175baeSEmil Constantinescu err_loc[1] = maxa; 63838a175baeSEmil Constantinescu err_loc[2] = maxr; 6384a88a9d1dSSatish Balay ierr = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 63858a175baeSEmil Constantinescu gmax = err_glb[0]; 63868a175baeSEmil Constantinescu gmaxa = err_glb[1]; 63878a175baeSEmil Constantinescu gmaxr = err_glb[2]; 63888a175baeSEmil Constantinescu 63898a175baeSEmil Constantinescu *norm = gmax; 63908a175baeSEmil Constantinescu *norma = gmaxa; 63918a175baeSEmil Constantinescu *normr = gmaxr; 63928a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 63938a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma"); 63948a175baeSEmil Constantinescu if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr"); 63958a175baeSEmil Constantinescu PetscFunctionReturn(0); 63968a175baeSEmil Constantinescu } 63978a175baeSEmil Constantinescu 63988a175baeSEmil Constantinescu /*@ 63998a175baeSEmil Constantinescu TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 64008a175baeSEmil Constantinescu 64018a175baeSEmil Constantinescu Collective on TS 64028a175baeSEmil Constantinescu 64038a175baeSEmil Constantinescu Input Arguments: 64048a175baeSEmil Constantinescu + ts - time stepping context 64058a175baeSEmil Constantinescu . E - error vector 64068a175baeSEmil Constantinescu . U - state vector, usually ts->vec_sol 64078a175baeSEmil Constantinescu . Y - state vector, previous time step 64088a175baeSEmil Constantinescu - wnormtype - norm type, either NORM_2 or NORM_INFINITY 64098a175baeSEmil Constantinescu 64108a175baeSEmil Constantinescu Output Arguments: 6411a2b725a8SWilliam Gropp + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 64128a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 6413a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 64148a175baeSEmil Constantinescu 64158a175baeSEmil Constantinescu Options Database Keys: 64168a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 64178a175baeSEmil Constantinescu 64188a175baeSEmil Constantinescu Level: developer 64198a175baeSEmil Constantinescu 64208a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2() 64218a175baeSEmil Constantinescu @*/ 64228a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr) 64238a175baeSEmil Constantinescu { 64248a175baeSEmil Constantinescu PetscErrorCode ierr; 64258a175baeSEmil Constantinescu 64268a175baeSEmil Constantinescu PetscFunctionBegin; 64278a175baeSEmil Constantinescu if (wnormtype == NORM_2) { 64288a175baeSEmil Constantinescu ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 64298a175baeSEmil Constantinescu } else if (wnormtype == NORM_INFINITY) { 64308a175baeSEmil Constantinescu ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr); 64318a175baeSEmil Constantinescu } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]); 64328a175baeSEmil Constantinescu PetscFunctionReturn(0); 64338a175baeSEmil Constantinescu } 64348a175baeSEmil Constantinescu 64358a175baeSEmil Constantinescu 64368d59e960SJed Brown /*@ 64378d59e960SJed Brown TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 64388d59e960SJed Brown 64398d59e960SJed Brown Logically Collective on TS 64408d59e960SJed Brown 64418d59e960SJed Brown Input Arguments: 64428d59e960SJed Brown + ts - time stepping context 64438d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 64448d59e960SJed Brown 64458d59e960SJed Brown Note: 64468d59e960SJed Brown After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 64478d59e960SJed Brown 64488d59e960SJed Brown Level: intermediate 64498d59e960SJed Brown 64508d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL 64518d59e960SJed Brown @*/ 64528d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime) 64538d59e960SJed Brown { 64548d59e960SJed Brown PetscFunctionBegin; 64558d59e960SJed Brown PetscValidHeaderSpecific(ts,TS_CLASSID,1); 64568d59e960SJed Brown ts->cfltime_local = cfltime; 64578d59e960SJed Brown ts->cfltime = -1.; 64588d59e960SJed Brown PetscFunctionReturn(0); 64598d59e960SJed Brown } 64608d59e960SJed Brown 64618d59e960SJed Brown /*@ 64628d59e960SJed Brown TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 64638d59e960SJed Brown 64648d59e960SJed Brown Collective on TS 64658d59e960SJed Brown 64668d59e960SJed Brown Input Arguments: 64678d59e960SJed Brown . ts - time stepping context 64688d59e960SJed Brown 64698d59e960SJed Brown Output Arguments: 64708d59e960SJed Brown . cfltime - maximum stable time step for forward Euler 64718d59e960SJed Brown 64728d59e960SJed Brown Level: advanced 64738d59e960SJed Brown 64748d59e960SJed Brown .seealso: TSSetCFLTimeLocal() 64758d59e960SJed Brown @*/ 64768d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime) 64778d59e960SJed Brown { 64788d59e960SJed Brown PetscErrorCode ierr; 64798d59e960SJed Brown 64808d59e960SJed Brown PetscFunctionBegin; 64818d59e960SJed Brown if (ts->cfltime < 0) { 6482b2566f29SBarry Smith ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr); 64838d59e960SJed Brown } 64848d59e960SJed Brown *cfltime = ts->cfltime; 64858d59e960SJed Brown PetscFunctionReturn(0); 64868d59e960SJed Brown } 64878d59e960SJed Brown 6488d6ebe24aSShri Abhyankar /*@ 6489d6ebe24aSShri Abhyankar TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 6490d6ebe24aSShri Abhyankar 6491d6ebe24aSShri Abhyankar Input Parameters: 6492a2b725a8SWilliam Gropp + ts - the TS context. 6493d6ebe24aSShri Abhyankar . xl - lower bound. 6494a2b725a8SWilliam Gropp - xu - upper bound. 6495d6ebe24aSShri Abhyankar 6496d6ebe24aSShri Abhyankar Notes: 6497d6ebe24aSShri Abhyankar If this routine is not called then the lower and upper bounds are set to 6498e270355aSBarry Smith PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp(). 6499d6ebe24aSShri Abhyankar 65002bd2b0e6SSatish Balay Level: advanced 65012bd2b0e6SSatish Balay 6502d6ebe24aSShri Abhyankar @*/ 6503d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 6504d6ebe24aSShri Abhyankar { 6505d6ebe24aSShri Abhyankar PetscErrorCode ierr; 6506d6ebe24aSShri Abhyankar SNES snes; 6507d6ebe24aSShri Abhyankar 6508d6ebe24aSShri Abhyankar PetscFunctionBegin; 6509d6ebe24aSShri Abhyankar ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr); 6510d6ebe24aSShri Abhyankar ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr); 6511d6ebe24aSShri Abhyankar PetscFunctionReturn(0); 6512d6ebe24aSShri Abhyankar } 6513d6ebe24aSShri Abhyankar 6514b3603a34SBarry Smith /*@C 65154f09c107SBarry Smith TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector 6516b3603a34SBarry Smith in a time based line graph 6517b3603a34SBarry Smith 6518b3603a34SBarry Smith Collective on TS 6519b3603a34SBarry Smith 6520b3603a34SBarry Smith Input Parameters: 6521b3603a34SBarry Smith + ts - the TS context 6522b3603a34SBarry Smith . step - current time-step 6523b3603a34SBarry Smith . ptime - current time 65247db568b7SBarry Smith . u - current solution 65257db568b7SBarry Smith - dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate() 6526b3603a34SBarry Smith 6527b3d3934dSBarry Smith Options Database: 65289ae14b6eSBarry Smith . -ts_monitor_lg_solution_variables 6529b3d3934dSBarry Smith 6530b3603a34SBarry Smith Level: intermediate 6531b3603a34SBarry Smith 653295452b02SPatrick Sanan Notes: 653395452b02SPatrick Sanan Each process in a parallel run displays its component solutions in a separate window 6534b3603a34SBarry Smith 65357db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(), 65367db568b7SBarry Smith TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(), 65377db568b7SBarry Smith TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(), 65387db568b7SBarry Smith TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop() 6539b3603a34SBarry Smith @*/ 65407db568b7SBarry Smith PetscErrorCode TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 6541b3603a34SBarry Smith { 6542b3603a34SBarry Smith PetscErrorCode ierr; 65437db568b7SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dctx; 6544b3603a34SBarry Smith const PetscScalar *yy; 654580666b62SBarry Smith Vec v; 6546b3603a34SBarry Smith 6547b3603a34SBarry Smith PetscFunctionBegin; 654863e21af5SBarry Smith if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 654958ff32f7SBarry Smith if (!step) { 6550a9f9c1f6SBarry Smith PetscDrawAxis axis; 65516934998bSLisandro Dalcin PetscInt dim; 6552a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 65530ec8ee2bSJoseph Pusztay ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr); 6554bab0a581SBarry Smith if (!ctx->names) { 6555bab0a581SBarry Smith PetscBool flg; 6556bab0a581SBarry Smith /* user provides names of variables to plot but no names has been set so assume names are integer values */ 6557bab0a581SBarry Smith ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr); 6558bab0a581SBarry Smith if (flg) { 6559bab0a581SBarry Smith PetscInt i,n; 6560bab0a581SBarry Smith char **names; 6561bab0a581SBarry Smith ierr = VecGetSize(u,&n);CHKERRQ(ierr); 6562bab0a581SBarry Smith ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr); 6563bab0a581SBarry Smith for (i=0; i<n; i++) { 6564bab0a581SBarry Smith ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr); 6565bab0a581SBarry Smith ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr); 6566bab0a581SBarry Smith } 6567bab0a581SBarry Smith names[n] = NULL; 6568bab0a581SBarry Smith ctx->names = names; 6569bab0a581SBarry Smith } 6570bab0a581SBarry Smith } 6571387f4636SBarry Smith if (ctx->names && !ctx->displaynames) { 6572387f4636SBarry Smith char **displaynames; 6573387f4636SBarry Smith PetscBool flg; 6574387f4636SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6575580bdb30SBarry Smith ierr = PetscCalloc1(dim+1,&displaynames);CHKERRQ(ierr); 6576c5929fdfSBarry Smith ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr); 6577387f4636SBarry Smith if (flg) { 6578a66092f1SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr); 6579387f4636SBarry Smith } 6580387f4636SBarry Smith ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr); 6581387f4636SBarry Smith } 6582387f4636SBarry Smith if (ctx->displaynames) { 6583387f4636SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr); 6584387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr); 6585387f4636SBarry Smith } else if (ctx->names) { 65860910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 65870b039ecaSBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6588387f4636SBarry Smith ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr); 6589b0bc92c6SBarry Smith } else { 6590b0bc92c6SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6591b0bc92c6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6592387f4636SBarry Smith } 65930b039ecaSBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 659458ff32f7SBarry Smith } 65956934998bSLisandro Dalcin 65966934998bSLisandro Dalcin if (!ctx->transform) v = u; 65976934998bSLisandro Dalcin else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);} 659880666b62SBarry Smith ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr); 65996934998bSLisandro Dalcin if (ctx->displaynames) { 66006934998bSLisandro Dalcin PetscInt i; 66016934998bSLisandro Dalcin for (i=0; i<ctx->ndisplayvariables; i++) 66026934998bSLisandro Dalcin ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]); 66036934998bSLisandro Dalcin ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr); 66046934998bSLisandro Dalcin } else { 6605e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6606e3efe391SJed Brown PetscInt i,n; 66076934998bSLisandro Dalcin PetscReal *yreal; 660880666b62SBarry Smith ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr); 6609785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6610e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 66110b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6612e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6613e3efe391SJed Brown #else 66140b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6615e3efe391SJed Brown #endif 661680666b62SBarry Smith } 66176934998bSLisandro Dalcin ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr); 66186934998bSLisandro Dalcin if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);} 66196934998bSLisandro Dalcin 6620b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 66210b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 66226934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 66233923b477SBarry Smith } 6624b3603a34SBarry Smith PetscFunctionReturn(0); 6625b3603a34SBarry Smith } 6626b3603a34SBarry Smith 6627b037adc7SBarry Smith /*@C 662831152f8aSBarry Smith TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6629b037adc7SBarry Smith 6630b037adc7SBarry Smith Collective on TS 6631b037adc7SBarry Smith 6632b037adc7SBarry Smith Input Parameters: 6633b037adc7SBarry Smith + ts - the TS context 6634b3d3934dSBarry Smith - names - the names of the components, final string must be NULL 6635b037adc7SBarry Smith 6636b037adc7SBarry Smith Level: intermediate 6637b037adc7SBarry Smith 663895452b02SPatrick Sanan Notes: 663995452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 66407db568b7SBarry Smith 6641a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames() 6642b037adc7SBarry Smith @*/ 664331152f8aSBarry Smith PetscErrorCode TSMonitorLGSetVariableNames(TS ts,const char * const *names) 6644b037adc7SBarry Smith { 6645b037adc7SBarry Smith PetscErrorCode ierr; 6646b037adc7SBarry Smith PetscInt i; 6647b037adc7SBarry Smith 6648b037adc7SBarry Smith PetscFunctionBegin; 6649b037adc7SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6650b037adc7SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 66515537e223SBarry Smith ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr); 6652b3d3934dSBarry Smith break; 6653b3d3934dSBarry Smith } 6654b3d3934dSBarry Smith } 6655b3d3934dSBarry Smith PetscFunctionReturn(0); 6656b3d3934dSBarry Smith } 6657b3d3934dSBarry Smith 6658e673d494SBarry Smith /*@C 6659e673d494SBarry Smith TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot 6660e673d494SBarry Smith 6661e673d494SBarry Smith Collective on TS 6662e673d494SBarry Smith 6663e673d494SBarry Smith Input Parameters: 6664e673d494SBarry Smith + ts - the TS context 6665e673d494SBarry Smith - names - the names of the components, final string must be NULL 6666e673d494SBarry Smith 6667e673d494SBarry Smith Level: intermediate 6668e673d494SBarry Smith 6669a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames() 6670e673d494SBarry Smith @*/ 6671e673d494SBarry Smith PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names) 6672e673d494SBarry Smith { 6673e673d494SBarry Smith PetscErrorCode ierr; 6674e673d494SBarry Smith 6675e673d494SBarry Smith PetscFunctionBegin; 6676e673d494SBarry Smith ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr); 6677e673d494SBarry Smith ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr); 6678e673d494SBarry Smith PetscFunctionReturn(0); 6679e673d494SBarry Smith } 6680e673d494SBarry Smith 6681b3d3934dSBarry Smith /*@C 6682b3d3934dSBarry Smith TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot 6683b3d3934dSBarry Smith 6684b3d3934dSBarry Smith Collective on TS 6685b3d3934dSBarry Smith 6686b3d3934dSBarry Smith Input Parameter: 6687b3d3934dSBarry Smith . ts - the TS context 6688b3d3934dSBarry Smith 6689b3d3934dSBarry Smith Output Parameter: 6690b3d3934dSBarry Smith . names - the names of the components, final string must be NULL 6691b3d3934dSBarry Smith 6692b3d3934dSBarry Smith Level: intermediate 6693b3d3934dSBarry Smith 669495452b02SPatrick Sanan Notes: 669595452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 66967db568b7SBarry Smith 6697b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 6698b3d3934dSBarry Smith @*/ 6699b3d3934dSBarry Smith PetscErrorCode TSMonitorLGGetVariableNames(TS ts,const char *const **names) 6700b3d3934dSBarry Smith { 6701b3d3934dSBarry Smith PetscInt i; 6702b3d3934dSBarry Smith 6703b3d3934dSBarry Smith PetscFunctionBegin; 6704b3d3934dSBarry Smith *names = NULL; 6705b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6706b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 67075537e223SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) ts->monitorcontext[i]; 6708b3d3934dSBarry Smith *names = (const char *const *)ctx->names; 6709b3d3934dSBarry Smith break; 6710387f4636SBarry Smith } 6711387f4636SBarry Smith } 6712387f4636SBarry Smith PetscFunctionReturn(0); 6713387f4636SBarry Smith } 6714387f4636SBarry Smith 6715a66092f1SBarry Smith /*@C 6716a66092f1SBarry Smith TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor 6717a66092f1SBarry Smith 6718a66092f1SBarry Smith Collective on TS 6719a66092f1SBarry Smith 6720a66092f1SBarry Smith Input Parameters: 6721a66092f1SBarry Smith + ctx - the TSMonitorLG context 6722a2b725a8SWilliam Gropp - displaynames - the names of the components, final string must be NULL 6723a66092f1SBarry Smith 6724a66092f1SBarry Smith Level: intermediate 6725a66092f1SBarry Smith 6726a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6727a66092f1SBarry Smith @*/ 6728a66092f1SBarry Smith PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames) 6729a66092f1SBarry Smith { 6730a66092f1SBarry Smith PetscInt j = 0,k; 6731a66092f1SBarry Smith PetscErrorCode ierr; 6732a66092f1SBarry Smith 6733a66092f1SBarry Smith PetscFunctionBegin; 6734a66092f1SBarry Smith if (!ctx->names) PetscFunctionReturn(0); 6735a66092f1SBarry Smith ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr); 6736a66092f1SBarry Smith ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr); 6737a66092f1SBarry Smith while (displaynames[j]) j++; 6738a66092f1SBarry Smith ctx->ndisplayvariables = j; 6739a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr); 6740a66092f1SBarry Smith ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr); 6741a66092f1SBarry Smith j = 0; 6742a66092f1SBarry Smith while (displaynames[j]) { 6743a66092f1SBarry Smith k = 0; 6744a66092f1SBarry Smith while (ctx->names[k]) { 6745a66092f1SBarry Smith PetscBool flg; 6746a66092f1SBarry Smith ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr); 6747a66092f1SBarry Smith if (flg) { 6748a66092f1SBarry Smith ctx->displayvariables[j] = k; 6749a66092f1SBarry Smith break; 6750a66092f1SBarry Smith } 6751a66092f1SBarry Smith k++; 6752a66092f1SBarry Smith } 6753a66092f1SBarry Smith j++; 6754a66092f1SBarry Smith } 6755a66092f1SBarry Smith PetscFunctionReturn(0); 6756a66092f1SBarry Smith } 6757a66092f1SBarry Smith 6758387f4636SBarry Smith /*@C 6759387f4636SBarry Smith TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor 6760387f4636SBarry Smith 6761387f4636SBarry Smith Collective on TS 6762387f4636SBarry Smith 6763387f4636SBarry Smith Input Parameters: 6764387f4636SBarry Smith + ts - the TS context 6765a2b725a8SWilliam Gropp - displaynames - the names of the components, final string must be NULL 6766387f4636SBarry Smith 676795452b02SPatrick Sanan Notes: 676895452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 67697db568b7SBarry Smith 6770387f4636SBarry Smith Level: intermediate 6771387f4636SBarry Smith 6772387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames() 6773387f4636SBarry Smith @*/ 6774387f4636SBarry Smith PetscErrorCode TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames) 6775387f4636SBarry Smith { 6776a66092f1SBarry Smith PetscInt i; 6777387f4636SBarry Smith PetscErrorCode ierr; 6778387f4636SBarry Smith 6779387f4636SBarry Smith PetscFunctionBegin; 6780387f4636SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 6781387f4636SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 67825537e223SBarry Smith ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr); 6783b3d3934dSBarry Smith break; 6784b037adc7SBarry Smith } 6785b037adc7SBarry Smith } 6786b037adc7SBarry Smith PetscFunctionReturn(0); 6787b037adc7SBarry Smith } 6788b037adc7SBarry Smith 678980666b62SBarry Smith /*@C 679080666b62SBarry Smith TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed 679180666b62SBarry Smith 679280666b62SBarry Smith Collective on TS 679380666b62SBarry Smith 679480666b62SBarry Smith Input Parameters: 679580666b62SBarry Smith + ts - the TS context 679680666b62SBarry Smith . transform - the transform function 67977684fa3eSBarry Smith . destroy - function to destroy the optional context 679880666b62SBarry Smith - ctx - optional context used by transform function 679980666b62SBarry Smith 680095452b02SPatrick Sanan Notes: 680195452b02SPatrick Sanan If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored 68027db568b7SBarry Smith 680380666b62SBarry Smith Level: intermediate 680480666b62SBarry Smith 6805a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform() 680680666b62SBarry Smith @*/ 68077684fa3eSBarry Smith PetscErrorCode TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 680880666b62SBarry Smith { 680980666b62SBarry Smith PetscInt i; 6810a66092f1SBarry Smith PetscErrorCode ierr; 681180666b62SBarry Smith 681280666b62SBarry Smith PetscFunctionBegin; 681380666b62SBarry Smith for (i=0; i<ts->numbermonitors; i++) { 681480666b62SBarry Smith if (ts->monitor[i] == TSMonitorLGSolution) { 68155537e223SBarry Smith ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr); 681680666b62SBarry Smith } 681780666b62SBarry Smith } 681880666b62SBarry Smith PetscFunctionReturn(0); 681980666b62SBarry Smith } 682080666b62SBarry Smith 6821e673d494SBarry Smith /*@C 6822e673d494SBarry Smith TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed 6823e673d494SBarry Smith 6824e673d494SBarry Smith Collective on TSLGCtx 6825e673d494SBarry Smith 6826e673d494SBarry Smith Input Parameters: 6827e673d494SBarry Smith + ts - the TS context 6828e673d494SBarry Smith . transform - the transform function 68297684fa3eSBarry Smith . destroy - function to destroy the optional context 6830e673d494SBarry Smith - ctx - optional context used by transform function 6831e673d494SBarry Smith 6832e673d494SBarry Smith Level: intermediate 6833e673d494SBarry Smith 6834a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform() 6835e673d494SBarry Smith @*/ 68367684fa3eSBarry Smith PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx) 6837e673d494SBarry Smith { 6838e673d494SBarry Smith PetscFunctionBegin; 6839e673d494SBarry Smith ctx->transform = transform; 68407684fa3eSBarry Smith ctx->transformdestroy = destroy; 6841e673d494SBarry Smith ctx->transformctx = tctx; 6842e673d494SBarry Smith PetscFunctionReturn(0); 6843e673d494SBarry Smith } 6844e673d494SBarry Smith 6845ef20d060SBarry Smith /*@C 68468b668821SLisandro Dalcin TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error 6847ef20d060SBarry Smith in a time based line graph 6848ef20d060SBarry Smith 6849ef20d060SBarry Smith Collective on TS 6850ef20d060SBarry Smith 6851ef20d060SBarry Smith Input Parameters: 6852ef20d060SBarry Smith + ts - the TS context 6853ef20d060SBarry Smith . step - current time-step 6854ef20d060SBarry Smith . ptime - current time 68557db568b7SBarry Smith . u - current solution 68567db568b7SBarry Smith - dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate() 6857ef20d060SBarry Smith 6858ef20d060SBarry Smith Level: intermediate 6859ef20d060SBarry Smith 686095452b02SPatrick Sanan Notes: 686195452b02SPatrick Sanan Each process in a parallel run displays its component errors in a separate window 6862abd5a294SJed Brown 6863abd5a294SJed Brown The user must provide the solution using TSSetSolutionFunction() to use this monitor. 6864abd5a294SJed Brown 6865abd5a294SJed Brown Options Database Keys: 68664f09c107SBarry Smith . -ts_monitor_lg_error - create a graphical monitor of error history 6867ef20d060SBarry Smith 6868abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 6869ef20d060SBarry Smith @*/ 68700910c330SBarry Smith PetscErrorCode TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy) 6871ef20d060SBarry Smith { 6872ef20d060SBarry Smith PetscErrorCode ierr; 68730b039ecaSBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx)dummy; 6874ef20d060SBarry Smith const PetscScalar *yy; 6875ef20d060SBarry Smith Vec y; 6876ef20d060SBarry Smith 6877ef20d060SBarry Smith PetscFunctionBegin; 6878a9f9c1f6SBarry Smith if (!step) { 6879a9f9c1f6SBarry Smith PetscDrawAxis axis; 68806934998bSLisandro Dalcin PetscInt dim; 6881a9f9c1f6SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 68828b668821SLisandro Dalcin ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr); 68830910c330SBarry Smith ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr); 6884a9f9c1f6SBarry Smith ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr); 6885a9f9c1f6SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 6886a9f9c1f6SBarry Smith } 68870910c330SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 6888ef20d060SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 68890910c330SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 6890ef20d060SBarry Smith ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr); 6891e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX) 6892e3efe391SJed Brown { 6893e3efe391SJed Brown PetscReal *yreal; 6894e3efe391SJed Brown PetscInt i,n; 6895e3efe391SJed Brown ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr); 6896785e854fSJed Brown ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr); 6897e3efe391SJed Brown for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]); 68980b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr); 6899e3efe391SJed Brown ierr = PetscFree(yreal);CHKERRQ(ierr); 6900e3efe391SJed Brown } 6901e3efe391SJed Brown #else 69020b039ecaSBarry Smith ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr); 6903e3efe391SJed Brown #endif 6904ef20d060SBarry Smith ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr); 6905ef20d060SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 6906b06615a5SLisandro Dalcin if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 69070b039ecaSBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 69086934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 69093923b477SBarry Smith } 6910ef20d060SBarry Smith PetscFunctionReturn(0); 6911ef20d060SBarry Smith } 6912ef20d060SBarry Smith 69135e3b7effSJoseph Pusztay /*@C 69145e3b7effSJoseph Pusztay TSMonitorSPSwarmSolution - Graphically displays phase plots of DMSwarm particles on a scatter plot 69155e3b7effSJoseph Pusztay 69165e3b7effSJoseph Pusztay Input Parameters: 69175e3b7effSJoseph Pusztay + ts - the TS context 69185e3b7effSJoseph Pusztay . step - current time-step 69195e3b7effSJoseph Pusztay . ptime - current time 69205e3b7effSJoseph Pusztay . u - current solution 69215e3b7effSJoseph Pusztay - dctx - the TSMonitorSPCtx object that contains all the options for the monitoring, this is created with TSMonitorSPCtxCreate() 69225e3b7effSJoseph Pusztay 69235e3b7effSJoseph Pusztay Options Database: 6924918b1d10SJoseph Pusztay . -ts_monitor_sp_swarm 69255e3b7effSJoseph Pusztay 69265e3b7effSJoseph Pusztay Level: intermediate 69275e3b7effSJoseph Pusztay 69285e3b7effSJoseph Pusztay @*/ 69290ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 69301b575b74SJoseph Pusztay { 69311b575b74SJoseph Pusztay PetscErrorCode ierr; 69321b575b74SJoseph Pusztay TSMonitorSPCtx ctx = (TSMonitorSPCtx)dctx; 69331b575b74SJoseph Pusztay const PetscScalar *yy; 6934b1670a61SJoseph Pusztay PetscReal *y,*x; 69351b575b74SJoseph Pusztay PetscInt Np, p, dim=2; 69361b575b74SJoseph Pusztay DM dm; 69371b575b74SJoseph Pusztay 69381b575b74SJoseph Pusztay PetscFunctionBegin; 69391b575b74SJoseph Pusztay 69401b575b74SJoseph Pusztay if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 69411b575b74SJoseph Pusztay if (!step) { 69421b575b74SJoseph Pusztay PetscDrawAxis axis; 69431b575b74SJoseph Pusztay ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr); 69441b575b74SJoseph Pusztay ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr); 6945895f37d5SJoseph Pusztay ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr); 6946895f37d5SJoseph Pusztay ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr); 69471b575b74SJoseph Pusztay ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 69481b575b74SJoseph Pusztay ierr = DMGetDimension(dm, &dim); 69491b575b74SJoseph Pusztay if (dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr); 69501b575b74SJoseph Pusztay ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr); 69511b575b74SJoseph Pusztay Np /= 2*dim; 69521b575b74SJoseph Pusztay ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr); 69531b575b74SJoseph Pusztay ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr); 69541b575b74SJoseph Pusztay } 69551b575b74SJoseph Pusztay 69561b575b74SJoseph Pusztay ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr); 69571b575b74SJoseph Pusztay Np /= 2*dim; 69581b575b74SJoseph Pusztay ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr); 6959895f37d5SJoseph Pusztay ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr); 69601b575b74SJoseph Pusztay /* get points from solution vector */ 69611b575b74SJoseph Pusztay for (p=0; p<Np; ++p){ 6962b1670a61SJoseph Pusztay x[p] = PetscRealPart(yy[2*dim*p]); 6963b1670a61SJoseph Pusztay y[p] = PetscRealPart(yy[2*dim*p+1]); 6964895f37d5SJoseph Pusztay } 69651b575b74SJoseph Pusztay ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr); 69661b575b74SJoseph Pusztay 69671b575b74SJoseph Pusztay if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) { 69681b575b74SJoseph Pusztay ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr); 69691b575b74SJoseph Pusztay ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr); 69701b575b74SJoseph Pusztay ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr); 69711b575b74SJoseph Pusztay } 69721b575b74SJoseph Pusztay 6973918b1d10SJoseph Pusztay ierr = PetscFree2(x, y);CHKERRQ(ierr); 6974918b1d10SJoseph Pusztay 69751b575b74SJoseph Pusztay PetscFunctionReturn(0); 69761b575b74SJoseph Pusztay } 69771b575b74SJoseph Pusztay 69781b575b74SJoseph Pusztay 69791b575b74SJoseph Pusztay 69807cf37e64SBarry Smith /*@C 69817cf37e64SBarry Smith TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep 69827cf37e64SBarry Smith 69837cf37e64SBarry Smith Collective on TS 69847cf37e64SBarry Smith 69857cf37e64SBarry Smith Input Parameters: 69867cf37e64SBarry Smith + ts - the TS context 69877cf37e64SBarry Smith . step - current time-step 69887cf37e64SBarry Smith . ptime - current time 69897cf37e64SBarry Smith . u - current solution 69907cf37e64SBarry Smith - dctx - unused context 69917cf37e64SBarry Smith 69927cf37e64SBarry Smith Level: intermediate 69937cf37e64SBarry Smith 69947cf37e64SBarry Smith The user must provide the solution using TSSetSolutionFunction() to use this monitor. 69957cf37e64SBarry Smith 69967cf37e64SBarry Smith Options Database Keys: 69977cf37e64SBarry Smith . -ts_monitor_error - create a graphical monitor of error history 69987cf37e64SBarry Smith 69997cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction() 70007cf37e64SBarry Smith @*/ 7001edbaebb3SBarry Smith PetscErrorCode TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf) 70027cf37e64SBarry Smith { 70037cf37e64SBarry Smith PetscErrorCode ierr; 70047cf37e64SBarry Smith Vec y; 70057cf37e64SBarry Smith PetscReal nrm; 7006edbaebb3SBarry Smith PetscBool flg; 70077cf37e64SBarry Smith 70087cf37e64SBarry Smith PetscFunctionBegin; 70097cf37e64SBarry Smith ierr = VecDuplicate(u,&y);CHKERRQ(ierr); 70107cf37e64SBarry Smith ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr); 70117cf37e64SBarry Smith ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr); 7012edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr); 7013edbaebb3SBarry Smith if (flg) { 70147cf37e64SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 7015edbaebb3SBarry Smith ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr); 7016edbaebb3SBarry Smith } 7017edbaebb3SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr); 7018edbaebb3SBarry Smith if (flg) { 7019edbaebb3SBarry Smith ierr = VecView(y,vf->viewer);CHKERRQ(ierr); 7020edbaebb3SBarry Smith } 7021edbaebb3SBarry Smith ierr = VecDestroy(&y);CHKERRQ(ierr); 70227cf37e64SBarry Smith PetscFunctionReturn(0); 70237cf37e64SBarry Smith } 70247cf37e64SBarry Smith 7025201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7026201da799SBarry Smith { 7027201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7028201da799SBarry Smith PetscReal x = ptime,y; 7029201da799SBarry Smith PetscErrorCode ierr; 7030201da799SBarry Smith PetscInt its; 7031201da799SBarry Smith 7032201da799SBarry Smith PetscFunctionBegin; 703363e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7034201da799SBarry Smith if (!n) { 7035201da799SBarry Smith PetscDrawAxis axis; 7036201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7037201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr); 7038201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7039201da799SBarry Smith ctx->snes_its = 0; 7040201da799SBarry Smith } 7041201da799SBarry Smith ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr); 7042201da799SBarry Smith y = its - ctx->snes_its; 7043201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 70443fbbecb0SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7045201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 70466934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7047201da799SBarry Smith } 7048201da799SBarry Smith ctx->snes_its = its; 7049201da799SBarry Smith PetscFunctionReturn(0); 7050201da799SBarry Smith } 7051201da799SBarry Smith 7052201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx) 7053201da799SBarry Smith { 7054201da799SBarry Smith TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx; 7055201da799SBarry Smith PetscReal x = ptime,y; 7056201da799SBarry Smith PetscErrorCode ierr; 7057201da799SBarry Smith PetscInt its; 7058201da799SBarry Smith 7059201da799SBarry Smith PetscFunctionBegin; 706063e21af5SBarry Smith if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */ 7061201da799SBarry Smith if (!n) { 7062201da799SBarry Smith PetscDrawAxis axis; 7063201da799SBarry Smith ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr); 7064201da799SBarry Smith ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr); 7065201da799SBarry Smith ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr); 7066201da799SBarry Smith ctx->ksp_its = 0; 7067201da799SBarry Smith } 7068201da799SBarry Smith ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr); 7069201da799SBarry Smith y = its - ctx->ksp_its; 7070201da799SBarry Smith ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr); 707199fdda47SBarry Smith if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) { 7072201da799SBarry Smith ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr); 70736934998bSLisandro Dalcin ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr); 7074201da799SBarry Smith } 7075201da799SBarry Smith ctx->ksp_its = its; 7076201da799SBarry Smith PetscFunctionReturn(0); 7077201da799SBarry Smith } 7078f9c1d6abSBarry Smith 7079f9c1d6abSBarry Smith /*@ 7080f9c1d6abSBarry Smith TSComputeLinearStability - computes the linear stability function at a point 7081f9c1d6abSBarry Smith 7082d083f849SBarry Smith Collective on TS 7083f9c1d6abSBarry Smith 7084f9c1d6abSBarry Smith Input Parameters: 7085f9c1d6abSBarry Smith + ts - the TS context 7086f9c1d6abSBarry Smith - xr,xi - real and imaginary part of input arguments 7087f9c1d6abSBarry Smith 7088f9c1d6abSBarry Smith Output Parameters: 7089f9c1d6abSBarry Smith . yr,yi - real and imaginary part of function value 7090f9c1d6abSBarry Smith 7091f9c1d6abSBarry Smith Level: developer 7092f9c1d6abSBarry Smith 7093f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction() 7094f9c1d6abSBarry Smith @*/ 7095f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi) 7096f9c1d6abSBarry Smith { 7097f9c1d6abSBarry Smith PetscErrorCode ierr; 7098f9c1d6abSBarry Smith 7099f9c1d6abSBarry Smith PetscFunctionBegin; 7100f9c1d6abSBarry Smith PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7101ce94432eSBarry Smith if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method"); 7102f9c1d6abSBarry Smith ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr); 7103f9c1d6abSBarry Smith PetscFunctionReturn(0); 7104f9c1d6abSBarry Smith } 710524655328SShri 7106b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/ 7107b3d3934dSBarry Smith /*@C 7108b3d3934dSBarry Smith TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope() 7109b3d3934dSBarry Smith 7110b3d3934dSBarry Smith Collective on TS 7111b3d3934dSBarry Smith 7112b3d3934dSBarry Smith Input Parameters: 7113b3d3934dSBarry Smith . ts - the ODE solver object 7114b3d3934dSBarry Smith 7115b3d3934dSBarry Smith Output Parameter: 7116b3d3934dSBarry Smith . ctx - the context 7117b3d3934dSBarry Smith 7118b3d3934dSBarry Smith Level: intermediate 7119b3d3934dSBarry Smith 7120b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError() 7121b3d3934dSBarry Smith 7122b3d3934dSBarry Smith @*/ 7123b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx) 7124b3d3934dSBarry Smith { 7125b3d3934dSBarry Smith PetscErrorCode ierr; 7126b3d3934dSBarry Smith 7127b3d3934dSBarry Smith PetscFunctionBegin; 7128a74656a8SBarry Smith ierr = PetscNew(ctx);CHKERRQ(ierr); 7129b3d3934dSBarry Smith PetscFunctionReturn(0); 7130b3d3934dSBarry Smith } 7131b3d3934dSBarry Smith 7132b3d3934dSBarry Smith /*@C 7133b3d3934dSBarry Smith TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution 7134b3d3934dSBarry Smith 7135b3d3934dSBarry Smith Collective on TS 7136b3d3934dSBarry Smith 7137b3d3934dSBarry Smith Input Parameters: 7138b3d3934dSBarry Smith + ts - the TS context 7139b3d3934dSBarry Smith . step - current time-step 7140b3d3934dSBarry Smith . ptime - current time 71417db568b7SBarry Smith . u - current solution 71427db568b7SBarry Smith - dctx - the envelope context 7143b3d3934dSBarry Smith 7144b3d3934dSBarry Smith Options Database: 7145b3d3934dSBarry Smith . -ts_monitor_envelope 7146b3d3934dSBarry Smith 7147b3d3934dSBarry Smith Level: intermediate 7148b3d3934dSBarry Smith 714995452b02SPatrick Sanan Notes: 715095452b02SPatrick Sanan after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope 7151b3d3934dSBarry Smith 71527db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate() 7153b3d3934dSBarry Smith @*/ 71547db568b7SBarry Smith PetscErrorCode TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx) 7155b3d3934dSBarry Smith { 7156b3d3934dSBarry Smith PetscErrorCode ierr; 71577db568b7SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx; 7158b3d3934dSBarry Smith 7159b3d3934dSBarry Smith PetscFunctionBegin; 7160b3d3934dSBarry Smith if (!ctx->max) { 7161b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr); 7162b3d3934dSBarry Smith ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr); 7163b3d3934dSBarry Smith ierr = VecCopy(u,ctx->max);CHKERRQ(ierr); 7164b3d3934dSBarry Smith ierr = VecCopy(u,ctx->min);CHKERRQ(ierr); 7165b3d3934dSBarry Smith } else { 7166b3d3934dSBarry Smith ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr); 7167b3d3934dSBarry Smith ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr); 7168b3d3934dSBarry Smith } 7169b3d3934dSBarry Smith PetscFunctionReturn(0); 7170b3d3934dSBarry Smith } 7171b3d3934dSBarry Smith 7172b3d3934dSBarry Smith /*@C 7173b3d3934dSBarry Smith TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution 7174b3d3934dSBarry Smith 7175b3d3934dSBarry Smith Collective on TS 7176b3d3934dSBarry Smith 7177b3d3934dSBarry Smith Input Parameter: 7178b3d3934dSBarry Smith . ts - the TS context 7179b3d3934dSBarry Smith 7180b3d3934dSBarry Smith Output Parameter: 7181b3d3934dSBarry Smith + max - the maximum values 7182b3d3934dSBarry Smith - min - the minimum values 7183b3d3934dSBarry Smith 718495452b02SPatrick Sanan Notes: 718595452b02SPatrick Sanan If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored 71867db568b7SBarry Smith 7187b3d3934dSBarry Smith Level: intermediate 7188b3d3934dSBarry Smith 7189b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables() 7190b3d3934dSBarry Smith @*/ 7191b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min) 7192b3d3934dSBarry Smith { 7193b3d3934dSBarry Smith PetscInt i; 7194b3d3934dSBarry Smith 7195b3d3934dSBarry Smith PetscFunctionBegin; 7196b3d3934dSBarry Smith if (max) *max = NULL; 7197b3d3934dSBarry Smith if (min) *min = NULL; 7198b3d3934dSBarry Smith for (i=0; i<ts->numbermonitors; i++) { 7199b3d3934dSBarry Smith if (ts->monitor[i] == TSMonitorEnvelope) { 72005537e223SBarry Smith TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i]; 7201b3d3934dSBarry Smith if (max) *max = ctx->max; 7202b3d3934dSBarry Smith if (min) *min = ctx->min; 7203b3d3934dSBarry Smith break; 7204b3d3934dSBarry Smith } 7205b3d3934dSBarry Smith } 7206b3d3934dSBarry Smith PetscFunctionReturn(0); 7207b3d3934dSBarry Smith } 7208b3d3934dSBarry Smith 7209b3d3934dSBarry Smith /*@C 7210b3d3934dSBarry Smith TSMonitorEnvelopeCtxDestroy - Destroys a context that was created with TSMonitorEnvelopeCtxCreate(). 7211b3d3934dSBarry Smith 7212b3d3934dSBarry Smith Collective on TSMonitorEnvelopeCtx 7213b3d3934dSBarry Smith 7214b3d3934dSBarry Smith Input Parameter: 7215b3d3934dSBarry Smith . ctx - the monitor context 7216b3d3934dSBarry Smith 7217b3d3934dSBarry Smith Level: intermediate 7218b3d3934dSBarry Smith 72197db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(), TSMonitorSet(), TSMonitorLGTimeStep() 7220b3d3934dSBarry Smith @*/ 7221b3d3934dSBarry Smith PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx) 7222b3d3934dSBarry Smith { 7223b3d3934dSBarry Smith PetscErrorCode ierr; 7224b3d3934dSBarry Smith 7225b3d3934dSBarry Smith PetscFunctionBegin; 7226b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr); 7227b3d3934dSBarry Smith ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr); 7228b3d3934dSBarry Smith ierr = PetscFree(*ctx);CHKERRQ(ierr); 7229b3d3934dSBarry Smith PetscFunctionReturn(0); 7230b3d3934dSBarry Smith } 7231f2dee214SBarry Smith 723224655328SShri /*@ 7233dcb233daSLisandro Dalcin TSRestartStep - Flags the solver to restart the next step 7234dcb233daSLisandro Dalcin 7235dcb233daSLisandro Dalcin Collective on TS 7236dcb233daSLisandro Dalcin 7237dcb233daSLisandro Dalcin Input Parameter: 7238dcb233daSLisandro Dalcin . ts - the TS context obtained from TSCreate() 7239dcb233daSLisandro Dalcin 7240dcb233daSLisandro Dalcin Level: advanced 7241dcb233daSLisandro Dalcin 7242dcb233daSLisandro Dalcin Notes: 7243dcb233daSLisandro Dalcin Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of 7244dcb233daSLisandro Dalcin discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution 7245dcb233daSLisandro Dalcin vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For 7246dcb233daSLisandro Dalcin the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce 7247dcb233daSLisandro Dalcin discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with 7248dcb233daSLisandro Dalcin discontinuous source terms). 7249dcb233daSLisandro Dalcin 7250dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep() 7251dcb233daSLisandro Dalcin @*/ 7252dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts) 7253dcb233daSLisandro Dalcin { 7254dcb233daSLisandro Dalcin PetscFunctionBegin; 7255dcb233daSLisandro Dalcin PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7256dcb233daSLisandro Dalcin ts->steprestart = PETSC_TRUE; 7257dcb233daSLisandro Dalcin PetscFunctionReturn(0); 7258dcb233daSLisandro Dalcin } 7259dcb233daSLisandro Dalcin 7260dcb233daSLisandro Dalcin /*@ 726124655328SShri TSRollBack - Rolls back one time step 726224655328SShri 726324655328SShri Collective on TS 726424655328SShri 726524655328SShri Input Parameter: 726624655328SShri . ts - the TS context obtained from TSCreate() 726724655328SShri 726824655328SShri Level: advanced 726924655328SShri 727024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate() 727124655328SShri @*/ 727224655328SShri PetscErrorCode TSRollBack(TS ts) 727324655328SShri { 727424655328SShri PetscErrorCode ierr; 727524655328SShri 727624655328SShri PetscFunctionBegin; 727724655328SShri PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7278b3de5cdeSLisandro Dalcin if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called"); 727924655328SShri if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name); 728024655328SShri ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr); 728124655328SShri ts->time_step = ts->ptime - ts->ptime_prev; 728224655328SShri ts->ptime = ts->ptime_prev; 7283be5899b3SLisandro Dalcin ts->ptime_prev = ts->ptime_prev_rollback; 72842808aa04SLisandro Dalcin ts->steps--; 7285b3de5cdeSLisandro Dalcin ts->steprollback = PETSC_TRUE; 728624655328SShri PetscFunctionReturn(0); 728724655328SShri } 7288aeb4809dSShri Abhyankar 7289ff22ae23SHong Zhang /*@ 7290ff22ae23SHong Zhang TSGetStages - Get the number of stages and stage values 7291ff22ae23SHong Zhang 7292ff22ae23SHong Zhang Input Parameter: 7293ff22ae23SHong Zhang . ts - the TS context obtained from TSCreate() 7294ff22ae23SHong Zhang 72950429704eSStefano Zampini Output Parameters: 72960429704eSStefano Zampini + ns - the number of stages 72970429704eSStefano Zampini - Y - the current stage vectors 72980429704eSStefano Zampini 7299ff22ae23SHong Zhang Level: advanced 7300ff22ae23SHong Zhang 73010429704eSStefano Zampini Notes: Both ns and Y can be NULL. 73020429704eSStefano Zampini 7303ff22ae23SHong Zhang .seealso: TSCreate() 7304ff22ae23SHong Zhang @*/ 7305ff22ae23SHong Zhang PetscErrorCode TSGetStages(TS ts,PetscInt *ns,Vec **Y) 7306ff22ae23SHong Zhang { 7307ff22ae23SHong Zhang PetscErrorCode ierr; 7308ff22ae23SHong Zhang 7309ff22ae23SHong Zhang PetscFunctionBegin; 7310ff22ae23SHong Zhang PetscValidHeaderSpecific(ts, TS_CLASSID,1); 73110429704eSStefano Zampini if (ns) PetscValidPointer(ns,2); 73120429704eSStefano Zampini if (Y) PetscValidPointer(Y,3); 73130429704eSStefano Zampini if (!ts->ops->getstages) { 73140429704eSStefano Zampini if (ns) *ns = 0; 73150429704eSStefano Zampini if (Y) *Y = NULL; 73160429704eSStefano Zampini } else { 7317ff22ae23SHong Zhang ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr); 7318ff22ae23SHong Zhang } 7319ff22ae23SHong Zhang PetscFunctionReturn(0); 7320ff22ae23SHong Zhang } 7321ff22ae23SHong Zhang 7322847ff0e1SMatthew G. Knepley /*@C 7323847ff0e1SMatthew G. Knepley TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 7324847ff0e1SMatthew G. Knepley 7325847ff0e1SMatthew G. Knepley Collective on SNES 7326847ff0e1SMatthew G. Knepley 7327847ff0e1SMatthew G. Knepley Input Parameters: 7328847ff0e1SMatthew G. Knepley + ts - the TS context 7329847ff0e1SMatthew G. Knepley . t - current timestep 7330847ff0e1SMatthew G. Knepley . U - state vector 7331847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector 7332847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below 7333847ff0e1SMatthew G. Knepley - ctx - an optional user context 7334847ff0e1SMatthew G. Knepley 7335847ff0e1SMatthew G. Knepley Output Parameters: 7336847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine) 7337847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J) 7338847ff0e1SMatthew G. Knepley 7339847ff0e1SMatthew G. Knepley Level: intermediate 7340847ff0e1SMatthew G. Knepley 7341847ff0e1SMatthew G. Knepley Notes: 7342847ff0e1SMatthew G. Knepley If F(t,U,Udot)=0 is the DAE, the required Jacobian is 7343847ff0e1SMatthew G. Knepley 7344847ff0e1SMatthew G. Knepley dF/dU + shift*dF/dUdot 7345847ff0e1SMatthew G. Knepley 7346847ff0e1SMatthew G. Knepley Most users should not need to explicitly call this routine, as it 7347847ff0e1SMatthew G. Knepley is used internally within the nonlinear solvers. 7348847ff0e1SMatthew G. Knepley 7349847ff0e1SMatthew G. Knepley This will first try to get the coloring from the DM. If the DM type has no coloring 7350847ff0e1SMatthew G. Knepley routine, then it will try to get the coloring from the matrix. This requires that the 7351847ff0e1SMatthew G. Knepley matrix have nonzero entries precomputed. 7352847ff0e1SMatthew G. Knepley 7353847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction() 7354847ff0e1SMatthew G. Knepley @*/ 7355847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx) 7356847ff0e1SMatthew G. Knepley { 7357847ff0e1SMatthew G. Knepley SNES snes; 7358847ff0e1SMatthew G. Knepley MatFDColoring color; 7359847ff0e1SMatthew G. Knepley PetscBool hascolor, matcolor = PETSC_FALSE; 7360847ff0e1SMatthew G. Knepley PetscErrorCode ierr; 7361847ff0e1SMatthew G. Knepley 7362847ff0e1SMatthew G. Knepley PetscFunctionBegin; 7363c5929fdfSBarry Smith ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr); 7364847ff0e1SMatthew G. Knepley ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr); 7365847ff0e1SMatthew G. Knepley if (!color) { 7366847ff0e1SMatthew G. Knepley DM dm; 7367847ff0e1SMatthew G. Knepley ISColoring iscoloring; 7368847ff0e1SMatthew G. Knepley 7369847ff0e1SMatthew G. Knepley ierr = TSGetDM(ts, &dm);CHKERRQ(ierr); 7370847ff0e1SMatthew G. Knepley ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr); 7371847ff0e1SMatthew G. Knepley if (hascolor && !matcolor) { 7372847ff0e1SMatthew G. Knepley ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr); 7373847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7374847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7375847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7376847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7377847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7378847ff0e1SMatthew G. Knepley } else { 7379847ff0e1SMatthew G. Knepley MatColoring mc; 7380847ff0e1SMatthew G. Knepley 7381847ff0e1SMatthew G. Knepley ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr); 7382847ff0e1SMatthew G. Knepley ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr); 7383847ff0e1SMatthew G. Knepley ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr); 7384847ff0e1SMatthew G. Knepley ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr); 7385847ff0e1SMatthew G. Knepley ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr); 7386847ff0e1SMatthew G. Knepley ierr = MatColoringDestroy(&mc);CHKERRQ(ierr); 7387847ff0e1SMatthew G. Knepley ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr); 7388847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr); 7389847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr); 7390847ff0e1SMatthew G. Knepley ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr); 7391847ff0e1SMatthew G. Knepley ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 7392847ff0e1SMatthew G. Knepley } 7393847ff0e1SMatthew G. Knepley ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr); 7394847ff0e1SMatthew G. Knepley ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr); 7395847ff0e1SMatthew G. Knepley } 7396847ff0e1SMatthew G. Knepley ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr); 7397847ff0e1SMatthew G. Knepley ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr); 7398847ff0e1SMatthew G. Knepley if (J != B) { 7399847ff0e1SMatthew G. Knepley ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7400847ff0e1SMatthew G. Knepley ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 7401847ff0e1SMatthew G. Knepley } 7402847ff0e1SMatthew G. Knepley PetscFunctionReturn(0); 7403847ff0e1SMatthew G. Knepley } 740493b34091SDebojyoti Ghosh 7405cb9d8021SPierre Barbier de Reuille /*@ 74066bc98fa9SBarry Smith TSSetFunctionDomainError - Set a function that tests if the current state vector is valid 7407cb9d8021SPierre Barbier de Reuille 7408cb9d8021SPierre Barbier de Reuille Input Parameters: 74096bc98fa9SBarry Smith + ts - the TS context 74106bc98fa9SBarry Smith - func - function called within TSFunctionDomainError 74116bc98fa9SBarry Smith 74126bc98fa9SBarry Smith Calling sequence of func: 74136bc98fa9SBarry Smith $ PetscErrorCode func(TS ts,PetscReal time,Vec state,PetscBool reject) 74146bc98fa9SBarry Smith 74156bc98fa9SBarry Smith + ts - the TS context 74166bc98fa9SBarry Smith . time - the current time (of the stage) 74176bc98fa9SBarry Smith . state - the state to check if it is valid 74186bc98fa9SBarry Smith - reject - (output parameter) PETSC_FALSE if the state is acceptable, PETSC_TRUE if not acceptable 7419cb9d8021SPierre Barbier de Reuille 7420cb9d8021SPierre Barbier de Reuille Level: intermediate 7421cb9d8021SPierre Barbier de Reuille 74226bc98fa9SBarry Smith Notes: 74236bc98fa9SBarry Smith If an implicit ODE solver is being used then, in addition to providing this routine, the 74246bc98fa9SBarry Smith user's code should call SNESSetFunctionDomainError() when domain errors occur during 74256bc98fa9SBarry Smith function evaluations where the functions are provided by TSSetIFunction() or TSSetRHSFunction(). 74266bc98fa9SBarry Smith Use TSGetSNES() to obtain the SNES object 74276bc98fa9SBarry Smith 74286bc98fa9SBarry Smith Developer Notes: 74296bc98fa9SBarry Smith The naming of this function is inconsistent with the SNESSetFunctionDomainError() 74306bc98fa9SBarry Smith since one takes a function pointer and the other does not. 74316bc98fa9SBarry Smith 74326bc98fa9SBarry Smith .seealso: TSAdaptCheckStage(), TSFunctionDomainError(), SNESSetFunctionDomainError(), TSGetSNES() 7433cb9d8021SPierre Barbier de Reuille @*/ 7434cb9d8021SPierre Barbier de Reuille 7435d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*)) 7436cb9d8021SPierre Barbier de Reuille { 7437cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7438cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts, TS_CLASSID,1); 7439cb9d8021SPierre Barbier de Reuille ts->functiondomainerror = func; 7440cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7441cb9d8021SPierre Barbier de Reuille } 7442cb9d8021SPierre Barbier de Reuille 7443cb9d8021SPierre Barbier de Reuille /*@ 74446bc98fa9SBarry Smith TSFunctionDomainError - Checks if the current state is valid 7445cb9d8021SPierre Barbier de Reuille 7446cb9d8021SPierre Barbier de Reuille Input Parameters: 74476bc98fa9SBarry Smith + ts - the TS context 74486bc98fa9SBarry Smith . stagetime - time of the simulation 74496bc98fa9SBarry Smith - Y - state vector to check. 7450cb9d8021SPierre Barbier de Reuille 7451cb9d8021SPierre Barbier de Reuille Output Parameter: 74526bc98fa9SBarry Smith . accept - Set to PETSC_FALSE if the current state vector is valid. 7453cb9d8021SPierre Barbier de Reuille 7454cb9d8021SPierre Barbier de Reuille Note: 74556bc98fa9SBarry Smith This function is called by the TS integration routines and calls the user provided function (set with TSSetFunctionDomainError()) 74566bc98fa9SBarry Smith to check if the current state is valid. 745796a0c994SBarry Smith 74586bc98fa9SBarry Smith Level: developer 74596bc98fa9SBarry Smith 74606bc98fa9SBarry Smith .seealso: TSSetFunctionDomainError() 7461cb9d8021SPierre Barbier de Reuille @*/ 7462d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept) 7463cb9d8021SPierre Barbier de Reuille { 7464cb9d8021SPierre Barbier de Reuille PetscFunctionBegin; 7465cb9d8021SPierre Barbier de Reuille PetscValidHeaderSpecific(ts,TS_CLASSID,1); 7466cb9d8021SPierre Barbier de Reuille *accept = PETSC_TRUE; 7467cb9d8021SPierre Barbier de Reuille if (ts->functiondomainerror) { 7468d183316bSPierre Barbier de Reuille PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept)); 7469cb9d8021SPierre Barbier de Reuille } 7470cb9d8021SPierre Barbier de Reuille PetscFunctionReturn(0); 7471cb9d8021SPierre Barbier de Reuille } 74721ceb14c0SBarry Smith 747393b34091SDebojyoti Ghosh /*@C 7474e5168f73SEmil Constantinescu TSClone - This function clones a time step object. 747593b34091SDebojyoti Ghosh 7476d083f849SBarry Smith Collective 747793b34091SDebojyoti Ghosh 747893b34091SDebojyoti Ghosh Input Parameter: 747993b34091SDebojyoti Ghosh . tsin - The input TS 748093b34091SDebojyoti Ghosh 748193b34091SDebojyoti Ghosh Output Parameter: 7482e5168f73SEmil Constantinescu . tsout - The output TS (cloned) 748393b34091SDebojyoti Ghosh 74845eca1a21SEmil Constantinescu Notes: 74855eca1a21SEmil 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. 74865eca1a21SEmil Constantinescu 7487928bb9adSStefano 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); 74885eca1a21SEmil Constantinescu 74895eca1a21SEmil Constantinescu Level: developer 749093b34091SDebojyoti Ghosh 7491e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType() 749293b34091SDebojyoti Ghosh @*/ 7493baa10174SEmil Constantinescu PetscErrorCode TSClone(TS tsin, TS *tsout) 749493b34091SDebojyoti Ghosh { 749593b34091SDebojyoti Ghosh TS t; 749693b34091SDebojyoti Ghosh PetscErrorCode ierr; 7497dc846ba4SSatish Balay SNES snes_start; 7498dc846ba4SSatish Balay DM dm; 7499dc846ba4SSatish Balay TSType type; 750093b34091SDebojyoti Ghosh 750193b34091SDebojyoti Ghosh PetscFunctionBegin; 750293b34091SDebojyoti Ghosh PetscValidPointer(tsin,1); 750393b34091SDebojyoti Ghosh *tsout = NULL; 750493b34091SDebojyoti Ghosh 75057a37829fSSatish Balay ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr); 750693b34091SDebojyoti Ghosh 750793b34091SDebojyoti Ghosh /* General TS description */ 750893b34091SDebojyoti Ghosh t->numbermonitors = 0; 750993b34091SDebojyoti Ghosh t->setupcalled = 0; 751093b34091SDebojyoti Ghosh t->ksp_its = 0; 751193b34091SDebojyoti Ghosh t->snes_its = 0; 751293b34091SDebojyoti Ghosh t->nwork = 0; 75137d51462cSStefano Zampini t->rhsjacobian.time = PETSC_MIN_REAL; 751493b34091SDebojyoti Ghosh t->rhsjacobian.scale = 1.; 751593b34091SDebojyoti Ghosh t->ijacobian.shift = 1.; 751693b34091SDebojyoti Ghosh 751734561852SEmil Constantinescu ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr); 751834561852SEmil Constantinescu ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr); 7519d15a3a53SEmil Constantinescu 752093b34091SDebojyoti Ghosh ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr); 752193b34091SDebojyoti Ghosh ierr = TSSetDM(t,dm);CHKERRQ(ierr); 752293b34091SDebojyoti Ghosh 752393b34091SDebojyoti Ghosh t->adapt = tsin->adapt; 752451699248SLisandro Dalcin ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr); 752593b34091SDebojyoti Ghosh 7526e7069c78SShri t->trajectory = tsin->trajectory; 7527e7069c78SShri ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr); 7528e7069c78SShri 7529e7069c78SShri t->event = tsin->event; 75306b10a48eSSatish Balay if (t->event) t->event->refct++; 7531e7069c78SShri 753293b34091SDebojyoti Ghosh t->problem_type = tsin->problem_type; 753393b34091SDebojyoti Ghosh t->ptime = tsin->ptime; 7534e7069c78SShri t->ptime_prev = tsin->ptime_prev; 753593b34091SDebojyoti Ghosh t->time_step = tsin->time_step; 753693b34091SDebojyoti Ghosh t->max_time = tsin->max_time; 753793b34091SDebojyoti Ghosh t->steps = tsin->steps; 753893b34091SDebojyoti Ghosh t->max_steps = tsin->max_steps; 753993b34091SDebojyoti Ghosh t->equation_type = tsin->equation_type; 754093b34091SDebojyoti Ghosh t->atol = tsin->atol; 754193b34091SDebojyoti Ghosh t->rtol = tsin->rtol; 754293b34091SDebojyoti Ghosh t->max_snes_failures = tsin->max_snes_failures; 754393b34091SDebojyoti Ghosh t->max_reject = tsin->max_reject; 754493b34091SDebojyoti Ghosh t->errorifstepfailed = tsin->errorifstepfailed; 754593b34091SDebojyoti Ghosh 754693b34091SDebojyoti Ghosh ierr = TSGetType(tsin,&type);CHKERRQ(ierr); 754793b34091SDebojyoti Ghosh ierr = TSSetType(t,type);CHKERRQ(ierr); 754893b34091SDebojyoti Ghosh 754993b34091SDebojyoti Ghosh t->vec_sol = NULL; 755093b34091SDebojyoti Ghosh 755193b34091SDebojyoti Ghosh t->cfltime = tsin->cfltime; 755293b34091SDebojyoti Ghosh t->cfltime_local = tsin->cfltime_local; 755393b34091SDebojyoti Ghosh t->exact_final_time = tsin->exact_final_time; 755493b34091SDebojyoti Ghosh 755593b34091SDebojyoti Ghosh ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr); 755693b34091SDebojyoti Ghosh 75570d4fed19SBarry Smith if (((PetscObject)tsin)->fortran_func_pointers) { 75580d4fed19SBarry Smith PetscInt i; 75590d4fed19SBarry Smith ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr); 75600d4fed19SBarry Smith for (i=0; i<10; i++) { 75610d4fed19SBarry Smith ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 75620d4fed19SBarry Smith } 75630d4fed19SBarry Smith } 756493b34091SDebojyoti Ghosh *tsout = t; 756593b34091SDebojyoti Ghosh PetscFunctionReturn(0); 756693b34091SDebojyoti Ghosh } 7567f3b1f45cSBarry Smith 7568f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y) 7569f3b1f45cSBarry Smith { 7570f3b1f45cSBarry Smith PetscErrorCode ierr; 7571f3b1f45cSBarry Smith TS ts = (TS) ctx; 7572f3b1f45cSBarry Smith 7573f3b1f45cSBarry Smith PetscFunctionBegin; 7574f3b1f45cSBarry Smith ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr); 7575f3b1f45cSBarry Smith PetscFunctionReturn(0); 7576f3b1f45cSBarry Smith } 7577f3b1f45cSBarry Smith 7578f3b1f45cSBarry Smith /*@ 7579f3b1f45cSBarry Smith TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function. 7580f3b1f45cSBarry Smith 7581d083f849SBarry Smith Logically Collective on TS 7582f3b1f45cSBarry Smith 7583f3b1f45cSBarry Smith Input Parameters: 7584f3b1f45cSBarry Smith TS - the time stepping routine 7585f3b1f45cSBarry Smith 7586f3b1f45cSBarry Smith Output Parameter: 7587f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7588f3b1f45cSBarry Smith 7589f3b1f45cSBarry Smith Options Database: 7590f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator 7591f3b1f45cSBarry Smith 7592f3b1f45cSBarry Smith Level: advanced 7593f3b1f45cSBarry Smith 759495452b02SPatrick Sanan Notes: 759595452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7596f3b1f45cSBarry Smith 7597f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose() 7598f3b1f45cSBarry Smith @*/ 7599f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTest(TS ts,PetscBool *flg) 7600f3b1f45cSBarry Smith { 7601f3b1f45cSBarry Smith Mat J,B; 7602f3b1f45cSBarry Smith PetscErrorCode ierr; 7603f3b1f45cSBarry Smith TSRHSJacobian func; 7604f3b1f45cSBarry Smith void* ctx; 7605f3b1f45cSBarry Smith 7606f3b1f45cSBarry Smith PetscFunctionBegin; 7607f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7608f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7609f3b1f45cSBarry Smith ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7610f3b1f45cSBarry Smith PetscFunctionReturn(0); 7611f3b1f45cSBarry Smith } 7612f3b1f45cSBarry Smith 7613f3b1f45cSBarry Smith /*@C 7614f3b1f45cSBarry Smith TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function. 7615f3b1f45cSBarry Smith 7616d083f849SBarry Smith Logically Collective on TS 7617f3b1f45cSBarry Smith 7618f3b1f45cSBarry Smith Input Parameters: 7619f3b1f45cSBarry Smith TS - the time stepping routine 7620f3b1f45cSBarry Smith 7621f3b1f45cSBarry Smith Output Parameter: 7622f3b1f45cSBarry Smith . flg - PETSC_TRUE if the multiply is likely correct 7623f3b1f45cSBarry Smith 7624f3b1f45cSBarry Smith Options Database: 7625f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator 7626f3b1f45cSBarry Smith 762795452b02SPatrick Sanan Notes: 762895452b02SPatrick Sanan This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian 7629f3b1f45cSBarry Smith 7630f3b1f45cSBarry Smith Level: advanced 7631f3b1f45cSBarry Smith 7632f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest() 7633f3b1f45cSBarry Smith @*/ 7634f3b1f45cSBarry Smith PetscErrorCode TSRHSJacobianTestTranspose(TS ts,PetscBool *flg) 7635f3b1f45cSBarry Smith { 7636f3b1f45cSBarry Smith Mat J,B; 7637f3b1f45cSBarry Smith PetscErrorCode ierr; 7638f3b1f45cSBarry Smith void *ctx; 7639f3b1f45cSBarry Smith TSRHSJacobian func; 7640f3b1f45cSBarry Smith 7641f3b1f45cSBarry Smith PetscFunctionBegin; 7642f3b1f45cSBarry Smith ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr); 7643f3b1f45cSBarry Smith ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr); 7644f3b1f45cSBarry Smith ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr); 7645f3b1f45cSBarry Smith PetscFunctionReturn(0); 7646f3b1f45cSBarry Smith } 76470fe4d17eSHong Zhang 76480fe4d17eSHong Zhang /*@ 76490fe4d17eSHong Zhang TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used. 76500fe4d17eSHong Zhang 76510fe4d17eSHong Zhang Logically collective 76520fe4d17eSHong Zhang 76530fe4d17eSHong Zhang Input Parameter: 76540fe4d17eSHong Zhang + ts - timestepping context 76550fe4d17eSHong Zhang - use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 76560fe4d17eSHong Zhang 76570fe4d17eSHong Zhang Options Database: 76580fe4d17eSHong Zhang . -ts_use_splitrhsfunction - <true,false> 76590fe4d17eSHong Zhang 76600fe4d17eSHong Zhang Notes: 76610fe4d17eSHong Zhang This is only useful for multirate methods 76620fe4d17eSHong Zhang 76630fe4d17eSHong Zhang Level: intermediate 76640fe4d17eSHong Zhang 76650fe4d17eSHong Zhang .seealso: TSGetUseSplitRHSFunction() 76660fe4d17eSHong Zhang @*/ 76670fe4d17eSHong Zhang PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction) 76680fe4d17eSHong Zhang { 76690fe4d17eSHong Zhang PetscFunctionBegin; 76700fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 76710fe4d17eSHong Zhang ts->use_splitrhsfunction = use_splitrhsfunction; 76720fe4d17eSHong Zhang PetscFunctionReturn(0); 76730fe4d17eSHong Zhang } 76740fe4d17eSHong Zhang 76750fe4d17eSHong Zhang /*@ 76760fe4d17eSHong Zhang TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used. 76770fe4d17eSHong Zhang 76780fe4d17eSHong Zhang Not collective 76790fe4d17eSHong Zhang 76800fe4d17eSHong Zhang Input Parameter: 76810fe4d17eSHong Zhang . ts - timestepping context 76820fe4d17eSHong Zhang 76830fe4d17eSHong Zhang Output Parameter: 76840fe4d17eSHong Zhang . use_splitrhsfunction - PETSC_TRUE indicates that the split RHSFunction will be used 76850fe4d17eSHong Zhang 76860fe4d17eSHong Zhang Level: intermediate 76870fe4d17eSHong Zhang 76880fe4d17eSHong Zhang .seealso: TSSetUseSplitRHSFunction() 76890fe4d17eSHong Zhang @*/ 76900fe4d17eSHong Zhang PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction) 76910fe4d17eSHong Zhang { 76920fe4d17eSHong Zhang PetscFunctionBegin; 76930fe4d17eSHong Zhang PetscValidHeaderSpecific(ts,TS_CLASSID,1); 76940fe4d17eSHong Zhang *use_splitrhsfunction = ts->use_splitrhsfunction; 76950fe4d17eSHong Zhang PetscFunctionReturn(0); 76960fe4d17eSHong Zhang } 7697