1 #include <petsc/private/tsimpl.h> /*I "petscts.h" I*/ 2 #include <petscdmda.h> 3 #include <petscdmshell.h> 4 #include <petscdmplex.h> // For TSSetFromOptions() 5 #include <petscdmswarm.h> // For TSSetFromOptions() 6 #include <petscviewer.h> 7 #include <petscdraw.h> 8 #include <petscconvest.h> 9 10 /* Logging support */ 11 PetscClassId TS_CLASSID, DMTS_CLASSID; 12 PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 13 14 const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED", "STEPOVER", "INTERPOLATE", "MATCHSTEP", "TSExactFinalTimeOption", "TS_EXACTFINALTIME_", NULL}; 15 16 static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt, TSAdaptType default_type) 17 { 18 PetscFunctionBegin; 19 PetscValidHeaderSpecific(adapt, TSADAPT_CLASSID, 1); 20 PetscAssertPointer(default_type, 2); 21 if (!((PetscObject)adapt)->type_name) PetscCall(TSAdaptSetType(adapt, default_type)); 22 PetscFunctionReturn(PETSC_SUCCESS); 23 } 24 25 /*@ 26 TSSetFromOptions - Sets various `TS` parameters from the options database 27 28 Collective 29 30 Input Parameter: 31 . ts - the `TS` context obtained from `TSCreate()` 32 33 Options Database Keys: 34 + -ts_type <type> - EULER, BEULER, SUNDIALS, PSEUDO, CN, RK, THETA, ALPHA, GLLE, SSP, GLEE, BSYMP, IRK, see `TSType` 35 . -ts_save_trajectory - checkpoint the solution at each time-step 36 . -ts_max_time <time> - maximum time to compute to 37 . -ts_time_span <t0,...tf> - sets the time span, solutions are computed and stored for each indicated time 38 . -ts_max_steps <steps> - maximum number of time-steps to take 39 . -ts_init_time <time> - initial time to start computation 40 . -ts_final_time <time> - final time to compute to (deprecated: use `-ts_max_time`) 41 . -ts_dt <dt> - initial time step 42 . -ts_exact_final_time <stepover,interpolate,matchstep> - whether to stop at the exact given final time and how to compute the solution at that time 43 . -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed 44 . -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails 45 . -ts_error_if_step_fails <true,false> - Error if no step succeeds 46 . -ts_rtol <rtol> - relative tolerance for local truncation error 47 . -ts_atol <atol> - Absolute tolerance for local truncation error 48 . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function 49 . -ts_rhs_jacobian_test_mult_transpose - test the Jacobian at each iteration against finite difference with RHS function 50 . -ts_adjoint_solve <yes,no> - After solving the ODE/DAE solve the adjoint problem (requires `-ts_save_trajectory`) 51 . -ts_fd_color - Use finite differences with coloring to compute IJacobian 52 . -ts_monitor - print information at each timestep 53 . -ts_monitor_cancel - Cancel all monitors 54 . -ts_monitor_lg_solution - Monitor solution graphically 55 . -ts_monitor_lg_error - Monitor error graphically 56 . -ts_monitor_error - Monitors norm of error 57 . -ts_monitor_lg_timestep - Monitor timestep size graphically 58 . -ts_monitor_lg_timestep_log - Monitor log timestep size graphically 59 . -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically 60 . -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically 61 . -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically 62 . -ts_monitor_draw_solution - Monitor solution graphically 63 . -ts_monitor_draw_solution_phase <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom 64 . -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction() 65 . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep 66 . -ts_monitor_solution_interval <interval> - output once every interval (default=1) time steps 67 . -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03" PetscInt_FMT ".vts (filename-%%03" PetscInt_FMT ".vtu) 68 - -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time 69 70 Level: beginner 71 72 Notes: 73 See `SNESSetFromOptions()` and `KSPSetFromOptions()` for how to control the nonlinear and linear solves used by the time-stepper. 74 75 Certain `SNES` options get reset for each new nonlinear solver, for example `-snes_lag_jacobian its` and `-snes_lag_preconditioner its`, in order 76 to retain them over the multiple nonlinear solves that `TS` uses you mush also provide `-snes_lag_jacobian_persists true` and 77 `-snes_lag_preconditioner_persists true` 78 79 Developer Notes: 80 We should unify all the -ts_monitor options in the way that -xxx_view has been unified 81 82 .seealso: [](ch_ts), `TS`, `TSGetType()` 83 @*/ 84 PetscErrorCode TSSetFromOptions(TS ts) 85 { 86 PetscBool opt, flg, tflg; 87 char monfilename[PETSC_MAX_PATH_LEN]; 88 PetscReal time_step, tspan[100]; 89 PetscInt nt = PETSC_STATIC_ARRAY_LENGTH(tspan); 90 TSExactFinalTimeOption eftopt; 91 char dir[16]; 92 TSIFunctionFn *ifun; 93 const char *defaultType; 94 char typeName[256]; 95 96 PetscFunctionBegin; 97 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 98 99 PetscCall(TSRegisterAll()); 100 PetscCall(TSGetIFunction(ts, NULL, &ifun, NULL)); 101 102 PetscObjectOptionsBegin((PetscObject)ts); 103 if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name; 104 else defaultType = ifun ? TSBEULER : TSEULER; 105 PetscCall(PetscOptionsFList("-ts_type", "TS method", "TSSetType", TSList, defaultType, typeName, 256, &opt)); 106 if (opt) PetscCall(TSSetType(ts, typeName)); 107 else PetscCall(TSSetType(ts, defaultType)); 108 109 /* Handle generic TS options */ 110 PetscCall(PetscOptionsDeprecated("-ts_final_time", "-ts_max_time", "3.10", NULL)); 111 PetscCall(PetscOptionsReal("-ts_max_time", "Maximum time to run to", "TSSetMaxTime", ts->max_time, &ts->max_time, NULL)); 112 PetscCall(PetscOptionsRealArray("-ts_time_span", "Time span", "TSSetTimeSpan", tspan, &nt, &flg)); 113 if (flg) PetscCall(TSSetTimeSpan(ts, nt, tspan)); 114 PetscCall(PetscOptionsInt("-ts_max_steps", "Maximum number of time steps", "TSSetMaxSteps", ts->max_steps, &ts->max_steps, NULL)); 115 PetscCall(PetscOptionsReal("-ts_init_time", "Initial time", "TSSetTime", ts->ptime, &ts->ptime, NULL)); 116 PetscCall(PetscOptionsReal("-ts_dt", "Initial time step", "TSSetTimeStep", ts->time_step, &time_step, &flg)); 117 if (flg) PetscCall(TSSetTimeStep(ts, time_step)); 118 PetscCall(PetscOptionsEnum("-ts_exact_final_time", "Option for handling of final time step", "TSSetExactFinalTime", TSExactFinalTimeOptions, (PetscEnum)ts->exact_final_time, (PetscEnum *)&eftopt, &flg)); 119 if (flg) PetscCall(TSSetExactFinalTime(ts, eftopt)); 120 PetscCall(PetscOptionsInt("-ts_max_snes_failures", "Maximum number of nonlinear solve failures", "TSSetMaxSNESFailures", ts->max_snes_failures, &ts->max_snes_failures, NULL)); 121 PetscCall(PetscOptionsInt("-ts_max_reject", "Maximum number of step rejections before step fails", "TSSetMaxStepRejections", ts->max_reject, &ts->max_reject, NULL)); 122 PetscCall(PetscOptionsBool("-ts_error_if_step_fails", "Error if no step succeeds", "TSSetErrorIfStepFails", ts->errorifstepfailed, &ts->errorifstepfailed, NULL)); 123 PetscCall(PetscOptionsReal("-ts_rtol", "Relative tolerance for local truncation error", "TSSetTolerances", ts->rtol, &ts->rtol, NULL)); 124 PetscCall(PetscOptionsReal("-ts_atol", "Absolute tolerance for local truncation error", "TSSetTolerances", ts->atol, &ts->atol, NULL)); 125 126 PetscCall(PetscOptionsBool("-ts_rhs_jacobian_test_mult", "Test the RHS Jacobian for consistency with RHS at each solve ", "None", ts->testjacobian, &ts->testjacobian, NULL)); 127 PetscCall(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)); 128 PetscCall(PetscOptionsBool("-ts_use_splitrhsfunction", "Use the split RHS function for multirate solvers ", "TSSetUseSplitRHSFunction", ts->use_splitrhsfunction, &ts->use_splitrhsfunction, NULL)); 129 #if defined(PETSC_HAVE_SAWS) 130 { 131 PetscBool set; 132 flg = PETSC_FALSE; 133 PetscCall(PetscOptionsBool("-ts_saws_block", "Block for SAWs memory snooper at end of TSSolve", "PetscObjectSAWsBlock", ((PetscObject)ts)->amspublishblock, &flg, &set)); 134 if (set) PetscCall(PetscObjectSAWsSetBlock((PetscObject)ts, flg)); 135 } 136 #endif 137 138 /* Monitor options */ 139 PetscCall(PetscOptionsInt("-ts_monitor_frequency", "Number of time steps between monitor output", "TSMonitorSetFrequency", ts->monitorFrequency, &ts->monitorFrequency, NULL)); 140 PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor", "Monitor time and timestep size", "TSMonitorDefault", TSMonitorDefault, NULL)); 141 PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_extreme", "Monitor extreme values of the solution", "TSMonitorExtreme", TSMonitorExtreme, NULL)); 142 PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_solution", "View the solution at each timestep", "TSMonitorSolution", TSMonitorSolution, NULL)); 143 PetscCall(TSMonitorSetFromOptions(ts, "-ts_dmswarm_monitor_moments", "Monitor moments of particle distribution", "TSDMSwarmMonitorMoments", TSDMSwarmMonitorMoments, NULL)); 144 145 PetscCall(PetscOptionsString("-ts_monitor_python", "Use Python function", "TSMonitorSet", NULL, monfilename, sizeof(monfilename), &flg)); 146 if (flg) PetscCall(PetscPythonMonitorSet((PetscObject)ts, monfilename)); 147 148 PetscCall(PetscOptionsName("-ts_monitor_lg_solution", "Monitor solution graphically", "TSMonitorLGSolution", &opt)); 149 if (opt) { 150 PetscInt howoften = 1; 151 DM dm; 152 PetscBool net; 153 154 PetscCall(PetscOptionsInt("-ts_monitor_lg_solution", "Monitor solution graphically", "TSMonitorLGSolution", howoften, &howoften, NULL)); 155 PetscCall(TSGetDM(ts, &dm)); 156 PetscCall(PetscObjectTypeCompare((PetscObject)dm, DMNETWORK, &net)); 157 if (net) { 158 TSMonitorLGCtxNetwork ctx; 159 PetscCall(TSMonitorLGCtxNetworkCreate(ts, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 600, 400, howoften, &ctx)); 160 PetscCall(TSMonitorSet(ts, TSMonitorLGCtxNetworkSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxNetworkDestroy)); 161 PetscCall(PetscOptionsBool("-ts_monitor_lg_solution_semilogy", "Plot the solution with a semi-log axis", "", ctx->semilogy, &ctx->semilogy, NULL)); 162 } else { 163 TSMonitorLGCtx ctx; 164 PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 165 PetscCall(TSMonitorSet(ts, TSMonitorLGSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 166 } 167 } 168 169 PetscCall(PetscOptionsName("-ts_monitor_lg_error", "Monitor error graphically", "TSMonitorLGError", &opt)); 170 if (opt) { 171 TSMonitorLGCtx ctx; 172 PetscInt howoften = 1; 173 174 PetscCall(PetscOptionsInt("-ts_monitor_lg_error", "Monitor error graphically", "TSMonitorLGError", howoften, &howoften, NULL)); 175 PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 176 PetscCall(TSMonitorSet(ts, TSMonitorLGError, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 177 } 178 PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_error", "View the error at each timestep", "TSMonitorError", TSMonitorError, NULL)); 179 180 PetscCall(PetscOptionsName("-ts_monitor_lg_timestep", "Monitor timestep size graphically", "TSMonitorLGTimeStep", &opt)); 181 if (opt) { 182 TSMonitorLGCtx ctx; 183 PetscInt howoften = 1; 184 185 PetscCall(PetscOptionsInt("-ts_monitor_lg_timestep", "Monitor timestep size graphically", "TSMonitorLGTimeStep", howoften, &howoften, NULL)); 186 PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 187 PetscCall(TSMonitorSet(ts, TSMonitorLGTimeStep, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 188 } 189 PetscCall(PetscOptionsName("-ts_monitor_lg_timestep_log", "Monitor log timestep size graphically", "TSMonitorLGTimeStep", &opt)); 190 if (opt) { 191 TSMonitorLGCtx ctx; 192 PetscInt howoften = 1; 193 194 PetscCall(PetscOptionsInt("-ts_monitor_lg_timestep_log", "Monitor log timestep size graphically", "TSMonitorLGTimeStep", howoften, &howoften, NULL)); 195 PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 196 PetscCall(TSMonitorSet(ts, TSMonitorLGTimeStep, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 197 ctx->semilogy = PETSC_TRUE; 198 } 199 200 PetscCall(PetscOptionsName("-ts_monitor_lg_snes_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGSNESIterations", &opt)); 201 if (opt) { 202 TSMonitorLGCtx ctx; 203 PetscInt howoften = 1; 204 205 PetscCall(PetscOptionsInt("-ts_monitor_lg_snes_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGSNESIterations", howoften, &howoften, NULL)); 206 PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 207 PetscCall(TSMonitorSet(ts, TSMonitorLGSNESIterations, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 208 } 209 PetscCall(PetscOptionsName("-ts_monitor_lg_ksp_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGKSPIterations", &opt)); 210 if (opt) { 211 TSMonitorLGCtx ctx; 212 PetscInt howoften = 1; 213 214 PetscCall(PetscOptionsInt("-ts_monitor_lg_ksp_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGKSPIterations", howoften, &howoften, NULL)); 215 PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx)); 216 PetscCall(TSMonitorSet(ts, TSMonitorLGKSPIterations, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy)); 217 } 218 PetscCall(PetscOptionsName("-ts_monitor_sp_eig", "Monitor eigenvalues of linearized operator graphically", "TSMonitorSPEig", &opt)); 219 if (opt) { 220 TSMonitorSPEigCtx ctx; 221 PetscInt howoften = 1; 222 223 PetscCall(PetscOptionsInt("-ts_monitor_sp_eig", "Monitor eigenvalues of linearized operator graphically", "TSMonitorSPEig", howoften, &howoften, NULL)); 224 PetscCall(TSMonitorSPEigCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx)); 225 PetscCall(TSMonitorSet(ts, TSMonitorSPEig, ctx, (PetscErrorCode(*)(void **))TSMonitorSPEigCtxDestroy)); 226 } 227 PetscCall(PetscOptionsName("-ts_monitor_sp_swarm", "Display particle phase space from the DMSwarm", "TSMonitorSPSwarm", &opt)); 228 if (opt) { 229 TSMonitorSPCtx ctx; 230 PetscInt howoften = 1, retain = 0; 231 PetscBool phase = PETSC_TRUE, create = PETSC_TRUE, multispecies = PETSC_FALSE; 232 233 for (PetscInt i = 0; i < ts->numbermonitors; ++i) 234 if (ts->monitor[i] == TSMonitorSPSwarmSolution) { 235 create = PETSC_FALSE; 236 break; 237 } 238 if (create) { 239 PetscCall(PetscOptionsInt("-ts_monitor_sp_swarm", "Display particles phase space from the DMSwarm", "TSMonitorSPSwarm", howoften, &howoften, NULL)); 240 PetscCall(PetscOptionsInt("-ts_monitor_sp_swarm_retain", "Retain n points plotted to show trajectory, -1 for all points", "TSMonitorSPSwarm", retain, &retain, NULL)); 241 PetscCall(PetscOptionsBool("-ts_monitor_sp_swarm_phase", "Plot in phase space rather than coordinate space", "TSMonitorSPSwarm", phase, &phase, NULL)); 242 PetscCall(PetscOptionsBool("-ts_monitor_sp_swarm_multi_species", "Color particles by particle species", "TSMonitorSPSwarm", multispecies, &multispecies, NULL)); 243 PetscCall(TSMonitorSPCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, retain, phase, multispecies, &ctx)); 244 PetscCall(TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorSPCtxDestroy)); 245 } 246 } 247 PetscCall(PetscOptionsName("-ts_monitor_hg_swarm", "Display particle histogram from the DMSwarm", "TSMonitorHGSwarm", &opt)); 248 if (opt) { 249 TSMonitorHGCtx ctx; 250 PetscInt howoften = 1, Ns = 1; 251 PetscBool velocity = PETSC_FALSE, create = PETSC_TRUE; 252 253 for (PetscInt i = 0; i < ts->numbermonitors; ++i) 254 if (ts->monitor[i] == TSMonitorHGSwarmSolution) { 255 create = PETSC_FALSE; 256 break; 257 } 258 if (create) { 259 DM sw, dm; 260 PetscInt Nc, Nb; 261 262 PetscCall(TSGetDM(ts, &sw)); 263 PetscCall(DMSwarmGetCellDM(sw, &dm)); 264 PetscCall(DMPlexGetHeightStratum(dm, 0, NULL, &Nc)); 265 Nb = PetscMin(20, PetscMax(10, Nc)); 266 PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm", "Display particles histogram from the DMSwarm", "TSMonitorHGSwarm", howoften, &howoften, NULL)); 267 PetscCall(PetscOptionsBool("-ts_monitor_hg_swarm_velocity", "Plot in velocity space rather than coordinate space", "TSMonitorHGSwarm", velocity, &velocity, NULL)); 268 PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm_species", "Number of species to histogram", "TSMonitorHGSwarm", Ns, &Ns, NULL)); 269 PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm_bins", "Number of histogram bins", "TSMonitorHGSwarm", Nb, &Nb, NULL)); 270 PetscCall(TSMonitorHGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, Ns, Nb, velocity, &ctx)); 271 PetscCall(TSMonitorSet(ts, TSMonitorHGSwarmSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorHGCtxDestroy)); 272 } 273 } 274 opt = PETSC_FALSE; 275 PetscCall(PetscOptionsName("-ts_monitor_draw_solution", "Monitor solution graphically", "TSMonitorDrawSolution", &opt)); 276 if (opt) { 277 TSMonitorDrawCtx ctx; 278 PetscInt howoften = 1; 279 280 PetscCall(PetscOptionsInt("-ts_monitor_draw_solution", "Monitor solution graphically", "TSMonitorDrawSolution", howoften, &howoften, NULL)); 281 PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Computed Solution", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx)); 282 PetscCall(TSMonitorSet(ts, TSMonitorDrawSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy)); 283 } 284 opt = PETSC_FALSE; 285 PetscCall(PetscOptionsName("-ts_monitor_draw_solution_phase", "Monitor solution graphically", "TSMonitorDrawSolutionPhase", &opt)); 286 if (opt) { 287 TSMonitorDrawCtx ctx; 288 PetscReal bounds[4]; 289 PetscInt n = 4; 290 PetscDraw draw; 291 PetscDrawAxis axis; 292 293 PetscCall(PetscOptionsRealArray("-ts_monitor_draw_solution_phase", "Monitor solution graphically", "TSMonitorDrawSolutionPhase", bounds, &n, NULL)); 294 PetscCheck(n == 4, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Must provide bounding box of phase field"); 295 PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, 1, &ctx)); 296 PetscCall(PetscViewerDrawGetDraw(ctx->viewer, 0, &draw)); 297 PetscCall(PetscViewerDrawGetDrawAxis(ctx->viewer, 0, &axis)); 298 PetscCall(PetscDrawAxisSetLimits(axis, bounds[0], bounds[2], bounds[1], bounds[3])); 299 PetscCall(PetscDrawAxisSetLabels(axis, "Phase Diagram", "Variable 1", "Variable 2")); 300 PetscCall(TSMonitorSet(ts, TSMonitorDrawSolutionPhase, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy)); 301 } 302 opt = PETSC_FALSE; 303 PetscCall(PetscOptionsName("-ts_monitor_draw_error", "Monitor error graphically", "TSMonitorDrawError", &opt)); 304 if (opt) { 305 TSMonitorDrawCtx ctx; 306 PetscInt howoften = 1; 307 308 PetscCall(PetscOptionsInt("-ts_monitor_draw_error", "Monitor error graphically", "TSMonitorDrawError", howoften, &howoften, NULL)); 309 PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Error", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx)); 310 PetscCall(TSMonitorSet(ts, TSMonitorDrawError, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy)); 311 } 312 opt = PETSC_FALSE; 313 PetscCall(PetscOptionsName("-ts_monitor_draw_solution_function", "Monitor solution provided by TSMonitorSetSolutionFunction() graphically", "TSMonitorDrawSolutionFunction", &opt)); 314 if (opt) { 315 TSMonitorDrawCtx ctx; 316 PetscInt howoften = 1; 317 318 PetscCall(PetscOptionsInt("-ts_monitor_draw_solution_function", "Monitor solution provided by TSMonitorSetSolutionFunction() graphically", "TSMonitorDrawSolutionFunction", howoften, &howoften, NULL)); 319 PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Solution provided by user function", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx)); 320 PetscCall(TSMonitorSet(ts, TSMonitorDrawSolutionFunction, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy)); 321 } 322 323 opt = PETSC_FALSE; 324 PetscCall(PetscOptionsString("-ts_monitor_solution_vtk", "Save each time step to a binary file, use filename-%%03" PetscInt_FMT ".vts", "TSMonitorSolutionVTK", NULL, monfilename, sizeof(monfilename), &flg)); 325 if (flg) { 326 const char *ptr = NULL, *ptr2 = NULL; 327 char *filetemplate; 328 PetscCheck(monfilename[0], PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03" PetscInt_FMT ".vts"); 329 /* Do some cursory validation of the input. */ 330 PetscCall(PetscStrstr(monfilename, "%", (char **)&ptr)); 331 PetscCheck(ptr, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03" PetscInt_FMT ".vts"); 332 for (ptr++; ptr && *ptr; ptr++) { 333 PetscCall(PetscStrchr("DdiouxX", *ptr, (char **)&ptr2)); 334 PetscCheck(ptr2 || (*ptr >= '0' && *ptr <= '9'), PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03" PetscInt_FMT ".vts"); 335 if (ptr2) break; 336 } 337 PetscCall(PetscStrallocpy(monfilename, &filetemplate)); 338 PetscCall(TSMonitorSet(ts, TSMonitorSolutionVTK, filetemplate, (PetscErrorCode(*)(void **))TSMonitorSolutionVTKDestroy)); 339 } 340 341 PetscCall(PetscOptionsString("-ts_monitor_dmda_ray", "Display a ray of the solution", "None", "y=0", dir, sizeof(dir), &flg)); 342 if (flg) { 343 TSMonitorDMDARayCtx *rayctx; 344 int ray = 0; 345 DMDirection ddir; 346 DM da; 347 PetscMPIInt rank; 348 349 PetscCheck(dir[1] == '=', PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray %s", dir); 350 if (dir[0] == 'x') ddir = DM_X; 351 else if (dir[0] == 'y') ddir = DM_Y; 352 else SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray %s", dir); 353 sscanf(dir + 2, "%d", &ray); 354 355 PetscCall(PetscInfo(((PetscObject)ts), "Displaying DMDA ray %c = %d\n", dir[0], ray)); 356 PetscCall(PetscNew(&rayctx)); 357 PetscCall(TSGetDM(ts, &da)); 358 PetscCall(DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter)); 359 PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)ts), &rank)); 360 if (rank == 0) PetscCall(PetscViewerDrawOpen(PETSC_COMM_SELF, NULL, NULL, 0, 0, 600, 300, &rayctx->viewer)); 361 rayctx->lgctx = NULL; 362 PetscCall(TSMonitorSet(ts, TSMonitorDMDARay, rayctx, TSMonitorDMDARayDestroy)); 363 } 364 PetscCall(PetscOptionsString("-ts_monitor_lg_dmda_ray", "Display a ray of the solution", "None", "x=0", dir, sizeof(dir), &flg)); 365 if (flg) { 366 TSMonitorDMDARayCtx *rayctx; 367 int ray = 0; 368 DMDirection ddir; 369 DM da; 370 PetscInt howoften = 1; 371 372 PetscCheck(dir[1] == '=', PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir); 373 if (dir[0] == 'x') ddir = DM_X; 374 else if (dir[0] == 'y') ddir = DM_Y; 375 else SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir); 376 sscanf(dir + 2, "%d", &ray); 377 378 PetscCall(PetscInfo(((PetscObject)ts), "Displaying LG DMDA ray %c = %d\n", dir[0], ray)); 379 PetscCall(PetscNew(&rayctx)); 380 PetscCall(TSGetDM(ts, &da)); 381 PetscCall(DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter)); 382 PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 600, 400, howoften, &rayctx->lgctx)); 383 PetscCall(TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy)); 384 } 385 386 PetscCall(PetscOptionsName("-ts_monitor_envelope", "Monitor maximum and minimum value of each component of the solution", "TSMonitorEnvelope", &opt)); 387 if (opt) { 388 TSMonitorEnvelopeCtx ctx; 389 390 PetscCall(TSMonitorEnvelopeCtxCreate(ts, &ctx)); 391 PetscCall(TSMonitorSet(ts, TSMonitorEnvelope, ctx, (PetscErrorCode(*)(void **))TSMonitorEnvelopeCtxDestroy)); 392 } 393 flg = PETSC_FALSE; 394 PetscCall(PetscOptionsBool("-ts_monitor_cancel", "Remove all monitors", "TSMonitorCancel", flg, &flg, &opt)); 395 if (opt && flg) PetscCall(TSMonitorCancel(ts)); 396 397 flg = PETSC_FALSE; 398 PetscCall(PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeIJacobianDefaultColor", flg, &flg, NULL)); 399 if (flg) { 400 DM dm; 401 402 PetscCall(TSGetDM(ts, &dm)); 403 PetscCall(DMTSUnsetIJacobianContext_Internal(dm)); 404 PetscCall(TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL)); 405 PetscCall(PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n")); 406 } 407 408 /* Handle specific TS options */ 409 PetscTryTypeMethod(ts, setfromoptions, PetscOptionsObject); 410 411 /* Handle TSAdapt options */ 412 PetscCall(TSGetAdapt(ts, &ts->adapt)); 413 PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type)); 414 PetscCall(TSAdaptSetFromOptions(ts->adapt, PetscOptionsObject)); 415 416 /* TS trajectory must be set after TS, since it may use some TS options above */ 417 tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE; 418 PetscCall(PetscOptionsBool("-ts_save_trajectory", "Save the solution at each timestep", "TSSetSaveTrajectory", tflg, &tflg, NULL)); 419 if (tflg) PetscCall(TSSetSaveTrajectory(ts)); 420 421 PetscCall(TSAdjointSetFromOptions(ts, PetscOptionsObject)); 422 423 /* process any options handlers added with PetscObjectAddOptionsHandler() */ 424 PetscCall(PetscObjectProcessOptionsHandlers((PetscObject)ts, PetscOptionsObject)); 425 PetscOptionsEnd(); 426 427 if (ts->trajectory) PetscCall(TSTrajectorySetFromOptions(ts->trajectory, ts)); 428 429 /* why do we have to do this here and not during TSSetUp? */ 430 PetscCall(TSGetSNES(ts, &ts->snes)); 431 if (ts->problem_type == TS_LINEAR) { 432 PetscCall(PetscObjectTypeCompareAny((PetscObject)ts->snes, &flg, SNESKSPONLY, SNESKSPTRANSPOSEONLY, "")); 433 if (!flg) PetscCall(SNESSetType(ts->snes, SNESKSPONLY)); 434 } 435 PetscCall(SNESSetFromOptions(ts->snes)); 436 PetscFunctionReturn(PETSC_SUCCESS); 437 } 438 439 /*@ 440 TSGetTrajectory - Gets the trajectory from a `TS` if it exists 441 442 Collective 443 444 Input Parameter: 445 . ts - the `TS` context obtained from `TSCreate()` 446 447 Output Parameter: 448 . tr - the `TSTrajectory` object, if it exists 449 450 Level: advanced 451 452 Note: 453 This routine should be called after all `TS` options have been set 454 455 .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSAdjointSolve()`, `TSTrajectoryCreate()` 456 @*/ 457 PetscErrorCode TSGetTrajectory(TS ts, TSTrajectory *tr) 458 { 459 PetscFunctionBegin; 460 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 461 *tr = ts->trajectory; 462 PetscFunctionReturn(PETSC_SUCCESS); 463 } 464 465 /*@ 466 TSSetSaveTrajectory - Causes the `TS` to save its solutions as it iterates forward in time in a `TSTrajectory` object 467 468 Collective 469 470 Input Parameter: 471 . ts - the `TS` context obtained from `TSCreate()` 472 473 Options Database Keys: 474 + -ts_save_trajectory - saves the trajectory to a file 475 - -ts_trajectory_type type - set trajectory type 476 477 Level: intermediate 478 479 Notes: 480 This routine should be called after all `TS` options have been set 481 482 The `TSTRAJECTORYVISUALIZATION` files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and 483 MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m 484 485 .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSGetTrajectory()`, `TSAdjointSolve()` 486 @*/ 487 PetscErrorCode TSSetSaveTrajectory(TS ts) 488 { 489 PetscFunctionBegin; 490 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 491 if (!ts->trajectory) PetscCall(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts), &ts->trajectory)); 492 PetscFunctionReturn(PETSC_SUCCESS); 493 } 494 495 /*@ 496 TSResetTrajectory - Destroys and recreates the internal `TSTrajectory` object 497 498 Collective 499 500 Input Parameter: 501 . ts - the `TS` context obtained from `TSCreate()` 502 503 Level: intermediate 504 505 .seealso: [](ch_ts), `TSTrajectory`, `TSGetTrajectory()`, `TSAdjointSolve()`, `TSRemoveTrajectory()` 506 @*/ 507 PetscErrorCode TSResetTrajectory(TS ts) 508 { 509 PetscFunctionBegin; 510 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 511 if (ts->trajectory) { 512 PetscCall(TSTrajectoryDestroy(&ts->trajectory)); 513 PetscCall(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts), &ts->trajectory)); 514 } 515 PetscFunctionReturn(PETSC_SUCCESS); 516 } 517 518 /*@ 519 TSRemoveTrajectory - Destroys and removes the internal `TSTrajectory` object from a `TS` 520 521 Collective 522 523 Input Parameter: 524 . ts - the `TS` context obtained from `TSCreate()` 525 526 Level: intermediate 527 528 .seealso: [](ch_ts), `TSTrajectory`, `TSResetTrajectory()`, `TSAdjointSolve()` 529 @*/ 530 PetscErrorCode TSRemoveTrajectory(TS ts) 531 { 532 PetscFunctionBegin; 533 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 534 if (ts->trajectory) PetscCall(TSTrajectoryDestroy(&ts->trajectory)); 535 PetscFunctionReturn(PETSC_SUCCESS); 536 } 537 538 /*@ 539 TSComputeRHSJacobian - Computes the Jacobian matrix that has been 540 set with `TSSetRHSJacobian()`. 541 542 Collective 543 544 Input Parameters: 545 + ts - the `TS` context 546 . t - current timestep 547 - U - input vector 548 549 Output Parameters: 550 + A - Jacobian matrix 551 - B - optional preconditioning matrix 552 553 Level: developer 554 555 Note: 556 Most users should not need to explicitly call this routine, as it 557 is used internally within the nonlinear solvers. 558 559 .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `KSPSetOperators()` 560 @*/ 561 PetscErrorCode TSComputeRHSJacobian(TS ts, PetscReal t, Vec U, Mat A, Mat B) 562 { 563 PetscObjectState Ustate; 564 PetscObjectId Uid; 565 DM dm; 566 DMTS tsdm; 567 TSRHSJacobianFn *rhsjacobianfunc; 568 void *ctx; 569 TSRHSFunctionFn *rhsfunction; 570 571 PetscFunctionBegin; 572 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 573 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 574 PetscCheckSameComm(ts, 1, U, 3); 575 PetscCall(TSGetDM(ts, &dm)); 576 PetscCall(DMGetDMTS(dm, &tsdm)); 577 PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL)); 578 PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobianfunc, &ctx)); 579 PetscCall(PetscObjectStateGet((PetscObject)U, &Ustate)); 580 PetscCall(PetscObjectGetId((PetscObject)U, &Uid)); 581 582 if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(PETSC_SUCCESS); 583 584 PetscCheck(ts->rhsjacobian.shift == 0.0 || !ts->rhsjacobian.reuse, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Should not call TSComputeRHSJacobian() on a shifted matrix (shift=%lf) when RHSJacobian is reusable.", (double)ts->rhsjacobian.shift); 585 if (rhsjacobianfunc) { 586 PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, A, B)); 587 PetscCallBack("TS callback Jacobian", (*rhsjacobianfunc)(ts, t, U, A, B, ctx)); 588 ts->rhsjacs++; 589 PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, A, B)); 590 } else { 591 PetscCall(MatZeroEntries(A)); 592 if (B && A != B) PetscCall(MatZeroEntries(B)); 593 } 594 ts->rhsjacobian.time = t; 595 ts->rhsjacobian.shift = 0; 596 ts->rhsjacobian.scale = 1.; 597 PetscCall(PetscObjectGetId((PetscObject)U, &ts->rhsjacobian.Xid)); 598 PetscCall(PetscObjectStateGet((PetscObject)U, &ts->rhsjacobian.Xstate)); 599 PetscFunctionReturn(PETSC_SUCCESS); 600 } 601 602 /*@ 603 TSComputeRHSFunction - Evaluates the right-hand-side function for a `TS` 604 605 Collective 606 607 Input Parameters: 608 + ts - the `TS` context 609 . t - current time 610 - U - state vector 611 612 Output Parameter: 613 . y - right hand side 614 615 Level: developer 616 617 Note: 618 Most users should not need to explicitly call this routine, as it 619 is used internally within the nonlinear solvers. 620 621 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSComputeIFunction()` 622 @*/ 623 PetscErrorCode TSComputeRHSFunction(TS ts, PetscReal t, Vec U, Vec y) 624 { 625 TSRHSFunctionFn *rhsfunction; 626 TSIFunctionFn *ifunction; 627 void *ctx; 628 DM dm; 629 630 PetscFunctionBegin; 631 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 632 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 633 PetscValidHeaderSpecific(y, VEC_CLASSID, 4); 634 PetscCall(TSGetDM(ts, &dm)); 635 PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, &ctx)); 636 PetscCall(DMTSGetIFunction(dm, &ifunction, NULL)); 637 638 PetscCheck(rhsfunction || ifunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSFunction() and / or TSSetIFunction()"); 639 640 if (rhsfunction) { 641 PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, y, 0)); 642 PetscCall(VecLockReadPush(U)); 643 PetscCallBack("TS callback right-hand-side", (*rhsfunction)(ts, t, U, y, ctx)); 644 PetscCall(VecLockReadPop(U)); 645 ts->rhsfuncs++; 646 PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, y, 0)); 647 } else PetscCall(VecZeroEntries(y)); 648 PetscFunctionReturn(PETSC_SUCCESS); 649 } 650 651 /*@ 652 TSComputeSolutionFunction - Evaluates the solution function. 653 654 Collective 655 656 Input Parameters: 657 + ts - the `TS` context 658 - t - current time 659 660 Output Parameter: 661 . U - the solution 662 663 Level: developer 664 665 .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSSetRHSFunction()`, `TSComputeIFunction()` 666 @*/ 667 PetscErrorCode TSComputeSolutionFunction(TS ts, PetscReal t, Vec U) 668 { 669 TSSolutionFn *solutionfunction; 670 void *ctx; 671 DM dm; 672 673 PetscFunctionBegin; 674 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 675 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 676 PetscCall(TSGetDM(ts, &dm)); 677 PetscCall(DMTSGetSolutionFunction(dm, &solutionfunction, &ctx)); 678 if (solutionfunction) PetscCallBack("TS callback solution", (*solutionfunction)(ts, t, U, ctx)); 679 PetscFunctionReturn(PETSC_SUCCESS); 680 } 681 /*@ 682 TSComputeForcingFunction - Evaluates the forcing function. 683 684 Collective 685 686 Input Parameters: 687 + ts - the `TS` context 688 - t - current time 689 690 Output Parameter: 691 . U - the function value 692 693 Level: developer 694 695 .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSSetRHSFunction()`, `TSComputeIFunction()` 696 @*/ 697 PetscErrorCode TSComputeForcingFunction(TS ts, PetscReal t, Vec U) 698 { 699 void *ctx; 700 DM dm; 701 TSForcingFn *forcing; 702 703 PetscFunctionBegin; 704 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 705 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 706 PetscCall(TSGetDM(ts, &dm)); 707 PetscCall(DMTSGetForcingFunction(dm, &forcing, &ctx)); 708 709 if (forcing) PetscCallBack("TS callback forcing function", (*forcing)(ts, t, U, ctx)); 710 PetscFunctionReturn(PETSC_SUCCESS); 711 } 712 713 static PetscErrorCode TSGetRHSVec_Private(TS ts, Vec *Frhs) 714 { 715 Vec F; 716 717 PetscFunctionBegin; 718 *Frhs = NULL; 719 PetscCall(TSGetIFunction(ts, &F, NULL, NULL)); 720 if (!ts->Frhs) PetscCall(VecDuplicate(F, &ts->Frhs)); 721 *Frhs = ts->Frhs; 722 PetscFunctionReturn(PETSC_SUCCESS); 723 } 724 725 PetscErrorCode TSGetRHSMats_Private(TS ts, Mat *Arhs, Mat *Brhs) 726 { 727 Mat A, B; 728 TSIJacobianFn *ijacobian; 729 730 PetscFunctionBegin; 731 if (Arhs) *Arhs = NULL; 732 if (Brhs) *Brhs = NULL; 733 PetscCall(TSGetIJacobian(ts, &A, &B, &ijacobian, NULL)); 734 if (Arhs) { 735 if (!ts->Arhs) { 736 if (ijacobian) { 737 PetscCall(MatDuplicate(A, MAT_DO_NOT_COPY_VALUES, &ts->Arhs)); 738 PetscCall(TSSetMatStructure(ts, SAME_NONZERO_PATTERN)); 739 } else { 740 ts->Arhs = A; 741 PetscCall(PetscObjectReference((PetscObject)A)); 742 } 743 } else { 744 PetscBool flg; 745 PetscCall(SNESGetUseMatrixFree(ts->snes, NULL, &flg)); 746 /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */ 747 if (flg && !ijacobian && ts->Arhs == ts->Brhs) { 748 PetscCall(PetscObjectDereference((PetscObject)ts->Arhs)); 749 ts->Arhs = A; 750 PetscCall(PetscObjectReference((PetscObject)A)); 751 } 752 } 753 *Arhs = ts->Arhs; 754 } 755 if (Brhs) { 756 if (!ts->Brhs) { 757 if (A != B) { 758 if (ijacobian) { 759 PetscCall(MatDuplicate(B, MAT_DO_NOT_COPY_VALUES, &ts->Brhs)); 760 } else { 761 ts->Brhs = B; 762 PetscCall(PetscObjectReference((PetscObject)B)); 763 } 764 } else { 765 PetscCall(PetscObjectReference((PetscObject)ts->Arhs)); 766 ts->Brhs = ts->Arhs; 767 } 768 } 769 *Brhs = ts->Brhs; 770 } 771 PetscFunctionReturn(PETSC_SUCCESS); 772 } 773 774 /*@ 775 TSComputeIFunction - Evaluates the DAE residual written in the implicit form F(t,U,Udot)=0 776 777 Collective 778 779 Input Parameters: 780 + ts - the `TS` context 781 . t - current time 782 . U - state vector 783 . Udot - time derivative of state vector 784 - imex - flag indicates if the method is `TSIMEX` so that the RHSFunction should be kept separate 785 786 Output Parameter: 787 . Y - right hand side 788 789 Level: developer 790 791 Note: 792 Most users should not need to explicitly call this routine, as it 793 is used internally within the nonlinear solvers. 794 795 If the user did not write their equations in implicit form, this 796 function recasts them in implicit form. 797 798 .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `TSComputeRHSFunction()` 799 @*/ 800 PetscErrorCode TSComputeIFunction(TS ts, PetscReal t, Vec U, Vec Udot, Vec Y, PetscBool imex) 801 { 802 TSIFunctionFn *ifunction; 803 TSRHSFunctionFn *rhsfunction; 804 void *ctx; 805 DM dm; 806 807 PetscFunctionBegin; 808 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 809 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 810 PetscValidHeaderSpecific(Udot, VEC_CLASSID, 4); 811 PetscValidHeaderSpecific(Y, VEC_CLASSID, 5); 812 813 PetscCall(TSGetDM(ts, &dm)); 814 PetscCall(DMTSGetIFunction(dm, &ifunction, &ctx)); 815 PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL)); 816 817 PetscCheck(rhsfunction || ifunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSFunction() and / or TSSetIFunction()"); 818 819 PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, Udot, Y)); 820 if (ifunction) { 821 PetscCallBack("TS callback implicit function", (*ifunction)(ts, t, U, Udot, Y, ctx)); 822 ts->ifuncs++; 823 } 824 if (imex) { 825 if (!ifunction) PetscCall(VecCopy(Udot, Y)); 826 } else if (rhsfunction) { 827 if (ifunction) { 828 Vec Frhs; 829 PetscCall(TSGetRHSVec_Private(ts, &Frhs)); 830 PetscCall(TSComputeRHSFunction(ts, t, U, Frhs)); 831 PetscCall(VecAXPY(Y, -1, Frhs)); 832 } else { 833 PetscCall(TSComputeRHSFunction(ts, t, U, Y)); 834 PetscCall(VecAYPX(Y, -1, Udot)); 835 } 836 } 837 PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, Udot, Y)); 838 PetscFunctionReturn(PETSC_SUCCESS); 839 } 840 841 /* 842 TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call `TSComputeRHSJacobian()` on it. 843 844 Note: 845 This routine is needed when one switches from `TSComputeIJacobian()` to `TSComputeRHSJacobian()` because the Jacobian matrix may be shifted or scaled in `TSComputeIJacobian()`. 846 847 */ 848 static PetscErrorCode TSRecoverRHSJacobian(TS ts, Mat A, Mat B) 849 { 850 PetscFunctionBegin; 851 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 852 PetscCheck(A == ts->Arhs, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Invalid Amat"); 853 PetscCheck(B == ts->Brhs, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Invalid Bmat"); 854 855 if (ts->rhsjacobian.shift) PetscCall(MatShift(A, -ts->rhsjacobian.shift)); 856 if (ts->rhsjacobian.scale == -1.) PetscCall(MatScale(A, -1)); 857 if (B && B == ts->Brhs && A != B) { 858 if (ts->rhsjacobian.shift) PetscCall(MatShift(B, -ts->rhsjacobian.shift)); 859 if (ts->rhsjacobian.scale == -1.) PetscCall(MatScale(B, -1)); 860 } 861 ts->rhsjacobian.shift = 0; 862 ts->rhsjacobian.scale = 1.; 863 PetscFunctionReturn(PETSC_SUCCESS); 864 } 865 866 /*@ 867 TSComputeIJacobian - Evaluates the Jacobian of the DAE 868 869 Collective 870 871 Input Parameters: 872 + ts - the `TS` context 873 . t - current timestep 874 . U - state vector 875 . Udot - time derivative of state vector 876 . shift - shift to apply, see note below 877 - imex - flag indicates if the method is `TSIMEX` so that the RHSJacobian should be kept separate 878 879 Output Parameters: 880 + A - Jacobian matrix 881 - B - matrix from which the preconditioner is constructed; often the same as `A` 882 883 Level: developer 884 885 Notes: 886 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 887 .vb 888 dF/dU + shift*dF/dUdot 889 .ve 890 Most users should not need to explicitly call this routine, as it 891 is used internally within the nonlinear solvers. 892 893 .seealso: [](ch_ts), `TS`, `TSSetIJacobian()` 894 @*/ 895 PetscErrorCode TSComputeIJacobian(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat A, Mat B, PetscBool imex) 896 { 897 TSIJacobianFn *ijacobian; 898 TSRHSJacobianFn *rhsjacobian; 899 DM dm; 900 void *ctx; 901 902 PetscFunctionBegin; 903 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 904 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 905 PetscValidHeaderSpecific(Udot, VEC_CLASSID, 4); 906 PetscValidHeaderSpecific(A, MAT_CLASSID, 6); 907 PetscValidHeaderSpecific(B, MAT_CLASSID, 7); 908 909 PetscCall(TSGetDM(ts, &dm)); 910 PetscCall(DMTSGetIJacobian(dm, &ijacobian, &ctx)); 911 PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobian, NULL)); 912 913 PetscCheck(rhsjacobian || ijacobian, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSJacobian() and / or TSSetIJacobian()"); 914 915 PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, A, B)); 916 if (ijacobian) { 917 PetscCallBack("TS callback implicit Jacobian", (*ijacobian)(ts, t, U, Udot, shift, A, B, ctx)); 918 ts->ijacs++; 919 } 920 if (imex) { 921 if (!ijacobian) { /* system was written as Udot = G(t,U) */ 922 PetscBool assembled; 923 if (rhsjacobian) { 924 Mat Arhs = NULL; 925 PetscCall(TSGetRHSMats_Private(ts, &Arhs, NULL)); 926 if (A == Arhs) { 927 PetscCheck(rhsjacobian != TSComputeRHSJacobianConstant, 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 */ 928 ts->rhsjacobian.time = PETSC_MIN_REAL; 929 } 930 } 931 PetscCall(MatZeroEntries(A)); 932 PetscCall(MatAssembled(A, &assembled)); 933 if (!assembled) { 934 PetscCall(MatAssemblyBegin(A, MAT_FINAL_ASSEMBLY)); 935 PetscCall(MatAssemblyEnd(A, MAT_FINAL_ASSEMBLY)); 936 } 937 PetscCall(MatShift(A, shift)); 938 if (A != B) { 939 PetscCall(MatZeroEntries(B)); 940 PetscCall(MatAssembled(B, &assembled)); 941 if (!assembled) { 942 PetscCall(MatAssemblyBegin(B, MAT_FINAL_ASSEMBLY)); 943 PetscCall(MatAssemblyEnd(B, MAT_FINAL_ASSEMBLY)); 944 } 945 PetscCall(MatShift(B, shift)); 946 } 947 } 948 } else { 949 Mat Arhs = NULL, Brhs = NULL; 950 951 /* RHSJacobian needs to be converted to part of IJacobian if exists */ 952 if (rhsjacobian) PetscCall(TSGetRHSMats_Private(ts, &Arhs, &Brhs)); 953 if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */ 954 PetscObjectState Ustate; 955 PetscObjectId Uid; 956 TSRHSFunctionFn *rhsfunction; 957 958 PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL)); 959 PetscCall(PetscObjectStateGet((PetscObject)U, &Ustate)); 960 PetscCall(PetscObjectGetId((PetscObject)U, &Uid)); 961 if ((rhsjacobian == TSComputeRHSJacobianConstant || (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && rhsfunction != TSComputeRHSFunctionLinear)) && 962 ts->rhsjacobian.scale == -1.) { /* No need to recompute RHSJacobian */ 963 PetscCall(MatShift(A, shift - ts->rhsjacobian.shift)); /* revert the old shift and add the new shift with a single call to MatShift */ 964 if (A != B) PetscCall(MatShift(B, shift - ts->rhsjacobian.shift)); 965 } else { 966 PetscBool flg; 967 968 if (ts->rhsjacobian.reuse) { /* Undo the damage */ 969 /* MatScale has a short path for this case. 970 However, this code path is taken the first time TSComputeRHSJacobian is called 971 and the matrices have not been assembled yet */ 972 PetscCall(TSRecoverRHSJacobian(ts, A, B)); 973 } 974 PetscCall(TSComputeRHSJacobian(ts, t, U, A, B)); 975 PetscCall(SNESGetUseMatrixFree(ts->snes, NULL, &flg)); 976 /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */ 977 if (!flg) { 978 PetscCall(MatScale(A, -1)); 979 PetscCall(MatShift(A, shift)); 980 } 981 if (A != B) { 982 PetscCall(MatScale(B, -1)); 983 PetscCall(MatShift(B, shift)); 984 } 985 } 986 ts->rhsjacobian.scale = -1; 987 ts->rhsjacobian.shift = shift; 988 } else if (Arhs) { /* Both IJacobian and RHSJacobian */ 989 if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */ 990 PetscCall(MatZeroEntries(A)); 991 PetscCall(MatShift(A, shift)); 992 if (A != B) { 993 PetscCall(MatZeroEntries(B)); 994 PetscCall(MatShift(B, shift)); 995 } 996 } 997 PetscCall(TSComputeRHSJacobian(ts, t, U, Arhs, Brhs)); 998 PetscCall(MatAXPY(A, -1, Arhs, ts->axpy_pattern)); 999 if (A != B) PetscCall(MatAXPY(B, -1, Brhs, ts->axpy_pattern)); 1000 } 1001 } 1002 PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, A, B)); 1003 PetscFunctionReturn(PETSC_SUCCESS); 1004 } 1005 1006 /*@C 1007 TSSetRHSFunction - Sets the routine for evaluating the function, 1008 where U_t = G(t,u). 1009 1010 Logically Collective 1011 1012 Input Parameters: 1013 + ts - the `TS` context obtained from `TSCreate()` 1014 . r - vector to put the computed right hand side (or `NULL` to have it created) 1015 . f - routine for evaluating the right-hand-side function 1016 - ctx - [optional] user-defined context for private data for the function evaluation routine (may be `NULL`) 1017 1018 Level: beginner 1019 1020 Note: 1021 You must call this function or `TSSetIFunction()` to define your ODE. You cannot use this function when solving a DAE. 1022 1023 .seealso: [](ch_ts), `TS`, `TSRHSFunctionFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`, `TSSetIFunction()` 1024 @*/ 1025 PetscErrorCode TSSetRHSFunction(TS ts, Vec r, TSRHSFunctionFn *f, void *ctx) 1026 { 1027 SNES snes; 1028 Vec ralloc = NULL; 1029 DM dm; 1030 1031 PetscFunctionBegin; 1032 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1033 if (r) PetscValidHeaderSpecific(r, VEC_CLASSID, 2); 1034 1035 PetscCall(TSGetDM(ts, &dm)); 1036 PetscCall(DMTSSetRHSFunction(dm, f, ctx)); 1037 PetscCall(TSGetSNES(ts, &snes)); 1038 if (!r && !ts->dm && ts->vec_sol) { 1039 PetscCall(VecDuplicate(ts->vec_sol, &ralloc)); 1040 r = ralloc; 1041 } 1042 PetscCall(SNESSetFunction(snes, r, SNESTSFormFunction, ts)); 1043 PetscCall(VecDestroy(&ralloc)); 1044 PetscFunctionReturn(PETSC_SUCCESS); 1045 } 1046 1047 /*@C 1048 TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE 1049 1050 Logically Collective 1051 1052 Input Parameters: 1053 + ts - the `TS` context obtained from `TSCreate()` 1054 . f - routine for evaluating the solution 1055 - ctx - [optional] user-defined context for private data for the 1056 function evaluation routine (may be `NULL`) 1057 1058 Options Database Keys: 1059 + -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided `TSSetSolutionFunction()` 1060 - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided `TSSetSolutionFunction()` 1061 1062 Level: intermediate 1063 1064 Notes: 1065 This routine is used for testing accuracy of time integration schemes when you already know the solution. 1066 If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to 1067 create closed-form solutions with non-physical forcing terms. 1068 1069 For low-dimensional problems solved in serial, such as small discrete systems, `TSMonitorLGError()` can be used to monitor the error history. 1070 1071 .seealso: [](ch_ts), `TS`, `TSSolutionFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`, `TSComputeSolutionFunction()`, `TSSetForcingFunction()`, `TSSetSolution()`, `TSGetSolution()`, `TSMonitorLGError()`, `TSMonitorDrawError()` 1072 @*/ 1073 PetscErrorCode TSSetSolutionFunction(TS ts, TSSolutionFn *f, void *ctx) 1074 { 1075 DM dm; 1076 1077 PetscFunctionBegin; 1078 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1079 PetscCall(TSGetDM(ts, &dm)); 1080 PetscCall(DMTSSetSolutionFunction(dm, f, ctx)); 1081 PetscFunctionReturn(PETSC_SUCCESS); 1082 } 1083 1084 /*@C 1085 TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE 1086 1087 Logically Collective 1088 1089 Input Parameters: 1090 + ts - the `TS` context obtained from `TSCreate()` 1091 . func - routine for evaluating the forcing function 1092 - ctx - [optional] user-defined context for private data for the function evaluation routine 1093 (may be `NULL`) 1094 1095 Level: intermediate 1096 1097 Notes: 1098 This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to 1099 create closed-form solutions with a non-physical forcing term. It allows you to use the Method of Manufactored Solution without directly editing the 1100 definition of the problem you are solving and hence possibly introducing bugs. 1101 1102 This replaces the ODE F(u,u_t,t) = 0 the `TS` is solving with F(u,u_t,t) - func(t) = 0 1103 1104 This forcing function does not depend on the solution to the equations, it can only depend on spatial location, time, and possibly parameters, the 1105 parameters can be passed in the ctx variable. 1106 1107 For low-dimensional problems solved in serial, such as small discrete systems, `TSMonitorLGError()` can be used to monitor the error history. 1108 1109 .seealso: [](ch_ts), `TS`, `TSForcingFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`, 1110 `TSComputeSolutionFunction()`, `TSSetSolutionFunction()` 1111 @*/ 1112 PetscErrorCode TSSetForcingFunction(TS ts, TSForcingFn *func, void *ctx) 1113 { 1114 DM dm; 1115 1116 PetscFunctionBegin; 1117 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1118 PetscCall(TSGetDM(ts, &dm)); 1119 PetscCall(DMTSSetForcingFunction(dm, func, ctx)); 1120 PetscFunctionReturn(PETSC_SUCCESS); 1121 } 1122 1123 /*@C 1124 TSSetRHSJacobian - Sets the function to compute the Jacobian of G, 1125 where U_t = G(U,t), as well as the location to store the matrix. 1126 1127 Logically Collective 1128 1129 Input Parameters: 1130 + ts - the `TS` context obtained from `TSCreate()` 1131 . Amat - (approximate) location to store Jacobian matrix entries computed by `f` 1132 . Pmat - matrix from which preconditioner is to be constructed (usually the same as `Amat`) 1133 . f - the Jacobian evaluation routine 1134 - ctx - [optional] user-defined context for private data for the Jacobian evaluation routine (may be `NULL`) 1135 1136 Level: beginner 1137 1138 Notes: 1139 You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 1140 1141 The `TS` solver may modify the nonzero structure and the entries of the matrices `Amat` and `Pmat` between the calls to `f()` 1142 You should not assume the values are the same in the next call to f() as you set them in the previous call. 1143 1144 .seealso: [](ch_ts), `TS`, `TSRHSJacobianFn`, `SNESComputeJacobianDefaultColor()`, 1145 `TSSetRHSFunction()`, `TSRHSJacobianSetReuse()`, `TSSetIJacobian()`, `TSRHSFunctionFn`, `TSIFunctionFn` 1146 @*/ 1147 PetscErrorCode TSSetRHSJacobian(TS ts, Mat Amat, Mat Pmat, TSRHSJacobianFn *f, void *ctx) 1148 { 1149 SNES snes; 1150 DM dm; 1151 TSIJacobianFn *ijacobian; 1152 1153 PetscFunctionBegin; 1154 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1155 if (Amat) PetscValidHeaderSpecific(Amat, MAT_CLASSID, 2); 1156 if (Pmat) PetscValidHeaderSpecific(Pmat, MAT_CLASSID, 3); 1157 if (Amat) PetscCheckSameComm(ts, 1, Amat, 2); 1158 if (Pmat) PetscCheckSameComm(ts, 1, Pmat, 3); 1159 1160 PetscCall(TSGetDM(ts, &dm)); 1161 PetscCall(DMTSSetRHSJacobian(dm, f, ctx)); 1162 PetscCall(DMTSGetIJacobian(dm, &ijacobian, NULL)); 1163 PetscCall(TSGetSNES(ts, &snes)); 1164 if (!ijacobian) PetscCall(SNESSetJacobian(snes, Amat, Pmat, SNESTSFormJacobian, ts)); 1165 if (Amat) { 1166 PetscCall(PetscObjectReference((PetscObject)Amat)); 1167 PetscCall(MatDestroy(&ts->Arhs)); 1168 ts->Arhs = Amat; 1169 } 1170 if (Pmat) { 1171 PetscCall(PetscObjectReference((PetscObject)Pmat)); 1172 PetscCall(MatDestroy(&ts->Brhs)); 1173 ts->Brhs = Pmat; 1174 } 1175 PetscFunctionReturn(PETSC_SUCCESS); 1176 } 1177 1178 /*@C 1179 TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved. 1180 1181 Logically Collective 1182 1183 Input Parameters: 1184 + ts - the `TS` context obtained from `TSCreate()` 1185 . r - vector to hold the residual (or `NULL` to have it created internally) 1186 . f - the function evaluation routine 1187 - ctx - user-defined context for private data for the function evaluation routine (may be `NULL`) 1188 1189 Level: beginner 1190 1191 Note: 1192 The user MUST call either this routine or `TSSetRHSFunction()` to define the ODE. When solving DAEs you must use this function. 1193 1194 .seealso: [](ch_ts), `TS`, `TSIFunctionFn`, `TSSetRHSJacobian()`, `TSSetRHSFunction()`, 1195 `TSSetIJacobian()` 1196 @*/ 1197 PetscErrorCode TSSetIFunction(TS ts, Vec r, TSIFunctionFn *f, void *ctx) 1198 { 1199 SNES snes; 1200 Vec ralloc = NULL; 1201 DM dm; 1202 1203 PetscFunctionBegin; 1204 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1205 if (r) PetscValidHeaderSpecific(r, VEC_CLASSID, 2); 1206 1207 PetscCall(TSGetDM(ts, &dm)); 1208 PetscCall(DMTSSetIFunction(dm, f, ctx)); 1209 1210 PetscCall(TSGetSNES(ts, &snes)); 1211 if (!r && !ts->dm && ts->vec_sol) { 1212 PetscCall(VecDuplicate(ts->vec_sol, &ralloc)); 1213 r = ralloc; 1214 } 1215 PetscCall(SNESSetFunction(snes, r, SNESTSFormFunction, ts)); 1216 PetscCall(VecDestroy(&ralloc)); 1217 PetscFunctionReturn(PETSC_SUCCESS); 1218 } 1219 1220 /*@C 1221 TSGetIFunction - Returns the vector where the implicit residual is stored and the function/context to compute it. 1222 1223 Not Collective 1224 1225 Input Parameter: 1226 . ts - the `TS` context 1227 1228 Output Parameters: 1229 + r - vector to hold residual (or `NULL`) 1230 . func - the function to compute residual (or `NULL`) 1231 - ctx - the function context (or `NULL`) 1232 1233 Level: advanced 1234 1235 .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `SNESGetFunction()` 1236 @*/ 1237 PetscErrorCode TSGetIFunction(TS ts, Vec *r, TSIFunctionFn **func, void **ctx) 1238 { 1239 SNES snes; 1240 DM dm; 1241 1242 PetscFunctionBegin; 1243 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1244 PetscCall(TSGetSNES(ts, &snes)); 1245 PetscCall(SNESGetFunction(snes, r, NULL, NULL)); 1246 PetscCall(TSGetDM(ts, &dm)); 1247 PetscCall(DMTSGetIFunction(dm, func, ctx)); 1248 PetscFunctionReturn(PETSC_SUCCESS); 1249 } 1250 1251 /*@C 1252 TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it. 1253 1254 Not Collective 1255 1256 Input Parameter: 1257 . ts - the `TS` context 1258 1259 Output Parameters: 1260 + r - vector to hold computed right hand side (or `NULL`) 1261 . func - the function to compute right hand side (or `NULL`) 1262 - ctx - the function context (or `NULL`) 1263 1264 Level: advanced 1265 1266 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `SNESGetFunction()` 1267 @*/ 1268 PetscErrorCode TSGetRHSFunction(TS ts, Vec *r, TSRHSFunctionFn **func, void **ctx) 1269 { 1270 SNES snes; 1271 DM dm; 1272 1273 PetscFunctionBegin; 1274 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1275 PetscCall(TSGetSNES(ts, &snes)); 1276 PetscCall(SNESGetFunction(snes, r, NULL, NULL)); 1277 PetscCall(TSGetDM(ts, &dm)); 1278 PetscCall(DMTSGetRHSFunction(dm, func, ctx)); 1279 PetscFunctionReturn(PETSC_SUCCESS); 1280 } 1281 1282 /*@C 1283 TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function 1284 provided with `TSSetIFunction()`. 1285 1286 Logically Collective 1287 1288 Input Parameters: 1289 + ts - the `TS` context obtained from `TSCreate()` 1290 . Amat - (approximate) matrix to store Jacobian entries computed by `f` 1291 . Pmat - matrix used to compute preconditioner (usually the same as `Amat`) 1292 . f - the Jacobian evaluation routine 1293 - ctx - user-defined context for private data for the Jacobian evaluation routine (may be `NULL`) 1294 1295 Level: beginner 1296 1297 Notes: 1298 The matrices `Amat` and `Pmat` are exactly the matrices that are used by `SNES` for the nonlinear solve. 1299 1300 If you know the operator Amat has a null space you can use `MatSetNullSpace()` and `MatSetTransposeNullSpace()` to supply the null 1301 space to `Amat` and the `KSP` solvers will automatically use that null space as needed during the solution process. 1302 1303 The matrix dF/dU + a*dF/dU_t you provide turns out to be 1304 the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved. 1305 The time integrator internally approximates U_t by W+a*U where the positive "shift" 1306 a and vector W depend on the integration method, step size, and past states. For example with 1307 the backward Euler method a = 1/dt and W = -a*U(previous timestep) so 1308 W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt 1309 1310 You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value 1311 1312 The TS solver may modify the nonzero structure and the entries of the matrices `Amat` and `Pmat` between the calls to `f` 1313 You should not assume the values are the same in the next call to `f` as you set them in the previous call. 1314 1315 .seealso: [](ch_ts), `TS`, `TSIJacobianFn`, `TSSetIFunction()`, `TSSetRHSJacobian()`, 1316 `SNESComputeJacobianDefaultColor()`, `SNESComputeJacobianDefault()`, `TSSetRHSFunction()` 1317 @*/ 1318 PetscErrorCode TSSetIJacobian(TS ts, Mat Amat, Mat Pmat, TSIJacobianFn *f, void *ctx) 1319 { 1320 SNES snes; 1321 DM dm; 1322 1323 PetscFunctionBegin; 1324 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1325 if (Amat) PetscValidHeaderSpecific(Amat, MAT_CLASSID, 2); 1326 if (Pmat) PetscValidHeaderSpecific(Pmat, MAT_CLASSID, 3); 1327 if (Amat) PetscCheckSameComm(ts, 1, Amat, 2); 1328 if (Pmat) PetscCheckSameComm(ts, 1, Pmat, 3); 1329 1330 PetscCall(TSGetDM(ts, &dm)); 1331 PetscCall(DMTSSetIJacobian(dm, f, ctx)); 1332 1333 PetscCall(TSGetSNES(ts, &snes)); 1334 PetscCall(SNESSetJacobian(snes, Amat, Pmat, SNESTSFormJacobian, ts)); 1335 PetscFunctionReturn(PETSC_SUCCESS); 1336 } 1337 1338 /*@ 1339 TSRHSJacobianSetReuse - restore the RHS Jacobian before calling the user-provided `TSRHSJacobianFn` function again 1340 1341 Logically Collective 1342 1343 Input Parameters: 1344 + ts - `TS` context obtained from `TSCreate()` 1345 - reuse - `PETSC_TRUE` if the RHS Jacobian 1346 1347 Level: intermediate 1348 1349 Notes: 1350 Without this flag, `TS` will change the sign and shift the RHS Jacobian for a 1351 finite-time-step implicit solve, in which case the user function will need to recompute the 1352 entire Jacobian. The `reuse `flag must be set if the evaluation function assumes that the 1353 matrix entries have not been changed by the `TS`. 1354 1355 .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `TSComputeRHSJacobianConstant()` 1356 @*/ 1357 PetscErrorCode TSRHSJacobianSetReuse(TS ts, PetscBool reuse) 1358 { 1359 PetscFunctionBegin; 1360 ts->rhsjacobian.reuse = reuse; 1361 PetscFunctionReturn(PETSC_SUCCESS); 1362 } 1363 1364 /*@C 1365 TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved. 1366 1367 Logically Collective 1368 1369 Input Parameters: 1370 + ts - the `TS` context obtained from `TSCreate()` 1371 . F - vector to hold the residual (or `NULL` to have it created internally) 1372 . fun - the function evaluation routine 1373 - ctx - user-defined context for private data for the function evaluation routine (may be `NULL`) 1374 1375 Level: beginner 1376 1377 .seealso: [](ch_ts), `TS`, `TSI2FunctionFn`, `TSSetI2Jacobian()`, `TSSetIFunction()`, 1378 `TSCreate()`, `TSSetRHSFunction()` 1379 @*/ 1380 PetscErrorCode TSSetI2Function(TS ts, Vec F, TSI2FunctionFn *fun, void *ctx) 1381 { 1382 DM dm; 1383 1384 PetscFunctionBegin; 1385 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1386 if (F) PetscValidHeaderSpecific(F, VEC_CLASSID, 2); 1387 PetscCall(TSSetIFunction(ts, F, NULL, NULL)); 1388 PetscCall(TSGetDM(ts, &dm)); 1389 PetscCall(DMTSSetI2Function(dm, fun, ctx)); 1390 PetscFunctionReturn(PETSC_SUCCESS); 1391 } 1392 1393 /*@C 1394 TSGetI2Function - Returns the vector where the implicit residual is stored and the function/context to compute it. 1395 1396 Not Collective 1397 1398 Input Parameter: 1399 . ts - the `TS` context 1400 1401 Output Parameters: 1402 + r - vector to hold residual (or `NULL`) 1403 . fun - the function to compute residual (or `NULL`) 1404 - ctx - the function context (or `NULL`) 1405 1406 Level: advanced 1407 1408 .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `SNESGetFunction()`, `TSCreate()` 1409 @*/ 1410 PetscErrorCode TSGetI2Function(TS ts, Vec *r, TSI2FunctionFn **fun, void **ctx) 1411 { 1412 SNES snes; 1413 DM dm; 1414 1415 PetscFunctionBegin; 1416 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1417 PetscCall(TSGetSNES(ts, &snes)); 1418 PetscCall(SNESGetFunction(snes, r, NULL, NULL)); 1419 PetscCall(TSGetDM(ts, &dm)); 1420 PetscCall(DMTSGetI2Function(dm, fun, ctx)); 1421 PetscFunctionReturn(PETSC_SUCCESS); 1422 } 1423 1424 /*@C 1425 TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t + a*dF/dU_tt 1426 where F(t,U,U_t,U_tt) is the function you provided with `TSSetI2Function()`. 1427 1428 Logically Collective 1429 1430 Input Parameters: 1431 + ts - the `TS` context obtained from `TSCreate()` 1432 . J - matrix to hold the Jacobian values 1433 . P - matrix for constructing the preconditioner (may be same as `J`) 1434 . jac - the Jacobian evaluation routine, see `TSI2JacobianFn` for the calling sequence 1435 - ctx - user-defined context for private data for the Jacobian evaluation routine (may be `NULL`) 1436 1437 Level: beginner 1438 1439 Notes: 1440 The matrices `J` and `P` are exactly the matrices that are used by `SNES` for the nonlinear solve. 1441 1442 The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be 1443 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. 1444 The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U where the positive "shift" 1445 parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states. 1446 1447 .seealso: [](ch_ts), `TS`, `TSI2JacobianFn`, `TSSetI2Function()`, `TSGetI2Jacobian()` 1448 @*/ 1449 PetscErrorCode TSSetI2Jacobian(TS ts, Mat J, Mat P, TSI2JacobianFn *jac, void *ctx) 1450 { 1451 DM dm; 1452 1453 PetscFunctionBegin; 1454 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1455 if (J) PetscValidHeaderSpecific(J, MAT_CLASSID, 2); 1456 if (P) PetscValidHeaderSpecific(P, MAT_CLASSID, 3); 1457 PetscCall(TSSetIJacobian(ts, J, P, NULL, NULL)); 1458 PetscCall(TSGetDM(ts, &dm)); 1459 PetscCall(DMTSSetI2Jacobian(dm, jac, ctx)); 1460 PetscFunctionReturn(PETSC_SUCCESS); 1461 } 1462 1463 /*@C 1464 TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep. 1465 1466 Not Collective, but parallel objects are returned if `TS` is parallel 1467 1468 Input Parameter: 1469 . ts - The `TS` context obtained from `TSCreate()` 1470 1471 Output Parameters: 1472 + J - The (approximate) Jacobian of F(t,U,U_t,U_tt) 1473 . P - The matrix from which the preconditioner is constructed, often the same as `J` 1474 . jac - The function to compute the Jacobian matrices 1475 - ctx - User-defined context for Jacobian evaluation routine 1476 1477 Level: advanced 1478 1479 Note: 1480 You can pass in `NULL` for any return argument you do not need. 1481 1482 .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()`, `TSSetI2Jacobian()`, `TSGetI2Function()`, `TSCreate()` 1483 @*/ 1484 PetscErrorCode TSGetI2Jacobian(TS ts, Mat *J, Mat *P, TSI2JacobianFn **jac, void **ctx) 1485 { 1486 SNES snes; 1487 DM dm; 1488 1489 PetscFunctionBegin; 1490 PetscCall(TSGetSNES(ts, &snes)); 1491 PetscCall(SNESSetUpMatrices(snes)); 1492 PetscCall(SNESGetJacobian(snes, J, P, NULL, NULL)); 1493 PetscCall(TSGetDM(ts, &dm)); 1494 PetscCall(DMTSGetI2Jacobian(dm, jac, ctx)); 1495 PetscFunctionReturn(PETSC_SUCCESS); 1496 } 1497 1498 /*@ 1499 TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0 1500 1501 Collective 1502 1503 Input Parameters: 1504 + ts - the `TS` context 1505 . t - current time 1506 . U - state vector 1507 . V - time derivative of state vector (U_t) 1508 - A - second time derivative of state vector (U_tt) 1509 1510 Output Parameter: 1511 . F - the residual vector 1512 1513 Level: developer 1514 1515 Note: 1516 Most users should not need to explicitly call this routine, as it 1517 is used internally within the nonlinear solvers. 1518 1519 .seealso: [](ch_ts), `TS`, `TSSetI2Function()`, `TSGetI2Function()` 1520 @*/ 1521 PetscErrorCode TSComputeI2Function(TS ts, PetscReal t, Vec U, Vec V, Vec A, Vec F) 1522 { 1523 DM dm; 1524 TSI2FunctionFn *I2Function; 1525 void *ctx; 1526 TSRHSFunctionFn *rhsfunction; 1527 1528 PetscFunctionBegin; 1529 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1530 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 1531 PetscValidHeaderSpecific(V, VEC_CLASSID, 4); 1532 PetscValidHeaderSpecific(A, VEC_CLASSID, 5); 1533 PetscValidHeaderSpecific(F, VEC_CLASSID, 6); 1534 1535 PetscCall(TSGetDM(ts, &dm)); 1536 PetscCall(DMTSGetI2Function(dm, &I2Function, &ctx)); 1537 PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL)); 1538 1539 if (!I2Function) { 1540 PetscCall(TSComputeIFunction(ts, t, U, A, F, PETSC_FALSE)); 1541 PetscFunctionReturn(PETSC_SUCCESS); 1542 } 1543 1544 PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, V, F)); 1545 1546 PetscCallBack("TS callback implicit function", I2Function(ts, t, U, V, A, F, ctx)); 1547 1548 if (rhsfunction) { 1549 Vec Frhs; 1550 PetscCall(TSGetRHSVec_Private(ts, &Frhs)); 1551 PetscCall(TSComputeRHSFunction(ts, t, U, Frhs)); 1552 PetscCall(VecAXPY(F, -1, Frhs)); 1553 } 1554 1555 PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, V, F)); 1556 PetscFunctionReturn(PETSC_SUCCESS); 1557 } 1558 1559 /*@ 1560 TSComputeI2Jacobian - Evaluates the Jacobian of the DAE 1561 1562 Collective 1563 1564 Input Parameters: 1565 + ts - the `TS` context 1566 . t - current timestep 1567 . U - state vector 1568 . V - time derivative of state vector 1569 . A - second time derivative of state vector 1570 . shiftV - shift to apply, see note below 1571 - shiftA - shift to apply, see note below 1572 1573 Output Parameters: 1574 + J - Jacobian matrix 1575 - P - optional preconditioning matrix 1576 1577 Level: developer 1578 1579 Notes: 1580 If F(t,U,V,A)=0 is the DAE, the required Jacobian is 1581 1582 dF/dU + shiftV*dF/dV + shiftA*dF/dA 1583 1584 Most users should not need to explicitly call this routine, as it 1585 is used internally within the nonlinear solvers. 1586 1587 .seealso: [](ch_ts), `TS`, `TSSetI2Jacobian()` 1588 @*/ 1589 PetscErrorCode TSComputeI2Jacobian(TS ts, PetscReal t, Vec U, Vec V, Vec A, PetscReal shiftV, PetscReal shiftA, Mat J, Mat P) 1590 { 1591 DM dm; 1592 TSI2JacobianFn *I2Jacobian; 1593 void *ctx; 1594 TSRHSJacobianFn *rhsjacobian; 1595 1596 PetscFunctionBegin; 1597 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1598 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 1599 PetscValidHeaderSpecific(V, VEC_CLASSID, 4); 1600 PetscValidHeaderSpecific(A, VEC_CLASSID, 5); 1601 PetscValidHeaderSpecific(J, MAT_CLASSID, 8); 1602 PetscValidHeaderSpecific(P, MAT_CLASSID, 9); 1603 1604 PetscCall(TSGetDM(ts, &dm)); 1605 PetscCall(DMTSGetI2Jacobian(dm, &I2Jacobian, &ctx)); 1606 PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobian, NULL)); 1607 1608 if (!I2Jacobian) { 1609 PetscCall(TSComputeIJacobian(ts, t, U, A, shiftA, J, P, PETSC_FALSE)); 1610 PetscFunctionReturn(PETSC_SUCCESS); 1611 } 1612 1613 PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, J, P)); 1614 PetscCallBack("TS callback implicit Jacobian", I2Jacobian(ts, t, U, V, A, shiftV, shiftA, J, P, ctx)); 1615 if (rhsjacobian) { 1616 Mat Jrhs, Prhs; 1617 PetscCall(TSGetRHSMats_Private(ts, &Jrhs, &Prhs)); 1618 PetscCall(TSComputeRHSJacobian(ts, t, U, Jrhs, Prhs)); 1619 PetscCall(MatAXPY(J, -1, Jrhs, ts->axpy_pattern)); 1620 if (P != J) PetscCall(MatAXPY(P, -1, Prhs, ts->axpy_pattern)); 1621 } 1622 1623 PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, J, P)); 1624 PetscFunctionReturn(PETSC_SUCCESS); 1625 } 1626 1627 /*@C 1628 TSSetTransientVariable - sets function to transform from state to transient variables 1629 1630 Logically Collective 1631 1632 Input Parameters: 1633 + ts - time stepping context on which to change the transient variable 1634 . tvar - a function that transforms to transient variables, see `TSTransientVariableFn` for the calling sequence 1635 - ctx - a context for tvar 1636 1637 Level: advanced 1638 1639 Notes: 1640 This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., `TSBDF`) 1641 can be conservative. In this context, primitive variables P are used to model the state (e.g., because they lead to 1642 well-conditioned formulations even in limiting cases such as low-Mach or zero porosity). The transient variable is 1643 C(P), specified by calling this function. An IFunction thus receives arguments (P, Cdot) and the IJacobian must be 1644 evaluated via the chain rule, as in 1645 .vb 1646 dF/dP + shift * dF/dCdot dC/dP. 1647 .ve 1648 1649 .seealso: [](ch_ts), `TS`, `TSBDF`, `TSTransientVariableFn`, `DMTSSetTransientVariable()`, `DMTSGetTransientVariable()`, `TSSetIFunction()`, `TSSetIJacobian()` 1650 @*/ 1651 PetscErrorCode TSSetTransientVariable(TS ts, TSTransientVariableFn *tvar, void *ctx) 1652 { 1653 DM dm; 1654 1655 PetscFunctionBegin; 1656 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1657 PetscCall(TSGetDM(ts, &dm)); 1658 PetscCall(DMTSSetTransientVariable(dm, tvar, ctx)); 1659 PetscFunctionReturn(PETSC_SUCCESS); 1660 } 1661 1662 /*@ 1663 TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables 1664 1665 Logically Collective 1666 1667 Input Parameters: 1668 + ts - TS on which to compute 1669 - U - state vector to be transformed to transient variables 1670 1671 Output Parameter: 1672 . C - transient (conservative) variable 1673 1674 Level: developer 1675 1676 Developer Notes: 1677 If `DMTSSetTransientVariable()` has not been called, then C is not modified in this routine and C = `NULL` is allowed. 1678 This makes it safe to call without a guard. One can use `TSHasTransientVariable()` to check if transient variables are 1679 being used. 1680 1681 .seealso: [](ch_ts), `TS`, `TSBDF`, `DMTSSetTransientVariable()`, `TSComputeIFunction()`, `TSComputeIJacobian()` 1682 @*/ 1683 PetscErrorCode TSComputeTransientVariable(TS ts, Vec U, Vec C) 1684 { 1685 DM dm; 1686 DMTS dmts; 1687 1688 PetscFunctionBegin; 1689 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1690 PetscValidHeaderSpecific(U, VEC_CLASSID, 2); 1691 PetscCall(TSGetDM(ts, &dm)); 1692 PetscCall(DMGetDMTS(dm, &dmts)); 1693 if (dmts->ops->transientvar) { 1694 PetscValidHeaderSpecific(C, VEC_CLASSID, 3); 1695 PetscCall((*dmts->ops->transientvar)(ts, U, C, dmts->transientvarctx)); 1696 } 1697 PetscFunctionReturn(PETSC_SUCCESS); 1698 } 1699 1700 /*@ 1701 TSHasTransientVariable - determine whether transient variables have been set 1702 1703 Logically Collective 1704 1705 Input Parameter: 1706 . ts - `TS` on which to compute 1707 1708 Output Parameter: 1709 . has - `PETSC_TRUE` if transient variables have been set 1710 1711 Level: developer 1712 1713 .seealso: [](ch_ts), `TS`, `TSBDF`, `DMTSSetTransientVariable()`, `TSComputeTransientVariable()` 1714 @*/ 1715 PetscErrorCode TSHasTransientVariable(TS ts, PetscBool *has) 1716 { 1717 DM dm; 1718 DMTS dmts; 1719 1720 PetscFunctionBegin; 1721 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1722 PetscCall(TSGetDM(ts, &dm)); 1723 PetscCall(DMGetDMTS(dm, &dmts)); 1724 *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE; 1725 PetscFunctionReturn(PETSC_SUCCESS); 1726 } 1727 1728 /*@ 1729 TS2SetSolution - Sets the initial solution and time derivative vectors 1730 for use by the `TS` routines handling second order equations. 1731 1732 Logically Collective 1733 1734 Input Parameters: 1735 + ts - the `TS` context obtained from `TSCreate()` 1736 . u - the solution vector 1737 - v - the time derivative vector 1738 1739 Level: beginner 1740 1741 .seealso: [](ch_ts), `TS` 1742 @*/ 1743 PetscErrorCode TS2SetSolution(TS ts, Vec u, Vec v) 1744 { 1745 PetscFunctionBegin; 1746 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1747 PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 1748 PetscValidHeaderSpecific(v, VEC_CLASSID, 3); 1749 PetscCall(TSSetSolution(ts, u)); 1750 PetscCall(PetscObjectReference((PetscObject)v)); 1751 PetscCall(VecDestroy(&ts->vec_dot)); 1752 ts->vec_dot = v; 1753 PetscFunctionReturn(PETSC_SUCCESS); 1754 } 1755 1756 /*@ 1757 TS2GetSolution - Returns the solution and time derivative at the present timestep 1758 for second order equations. 1759 1760 Not Collective 1761 1762 Input Parameter: 1763 . ts - the `TS` context obtained from `TSCreate()` 1764 1765 Output Parameters: 1766 + u - the vector containing the solution 1767 - v - the vector containing the time derivative 1768 1769 Level: intermediate 1770 1771 Notes: 1772 It is valid to call this routine inside the function 1773 that you are evaluating in order to move to the new timestep. This vector not 1774 changed until the solution at the next timestep has been calculated. 1775 1776 .seealso: [](ch_ts), `TS`, `TS2SetSolution()`, `TSGetTimeStep()`, `TSGetTime()` 1777 @*/ 1778 PetscErrorCode TS2GetSolution(TS ts, Vec *u, Vec *v) 1779 { 1780 PetscFunctionBegin; 1781 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1782 if (u) PetscAssertPointer(u, 2); 1783 if (v) PetscAssertPointer(v, 3); 1784 if (u) *u = ts->vec_sol; 1785 if (v) *v = ts->vec_dot; 1786 PetscFunctionReturn(PETSC_SUCCESS); 1787 } 1788 1789 /*@C 1790 TSLoad - Loads a `TS` that has been stored in binary with `TSView()`. 1791 1792 Collective 1793 1794 Input Parameters: 1795 + ts - the newly loaded `TS`, this needs to have been created with `TSCreate()` or 1796 some related function before a call to `TSLoad()`. 1797 - viewer - binary file viewer, obtained from `PetscViewerBinaryOpen()` 1798 1799 Level: intermediate 1800 1801 Note: 1802 The type is determined by the data in the file, any type set into the `TS` before this call is ignored. 1803 1804 .seealso: [](ch_ts), `TS`, `PetscViewer`, `PetscViewerBinaryOpen()`, `TSView()`, `MatLoad()`, `VecLoad()` 1805 @*/ 1806 PetscErrorCode TSLoad(TS ts, PetscViewer viewer) 1807 { 1808 PetscBool isbinary; 1809 PetscInt classid; 1810 char type[256]; 1811 DMTS sdm; 1812 DM dm; 1813 1814 PetscFunctionBegin; 1815 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1816 PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2); 1817 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary)); 1818 PetscCheck(isbinary, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 1819 1820 PetscCall(PetscViewerBinaryRead(viewer, &classid, 1, NULL, PETSC_INT)); 1821 PetscCheck(classid == TS_FILE_CLASSID, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Not TS next in file"); 1822 PetscCall(PetscViewerBinaryRead(viewer, type, 256, NULL, PETSC_CHAR)); 1823 PetscCall(TSSetType(ts, type)); 1824 PetscTryTypeMethod(ts, load, viewer); 1825 PetscCall(DMCreate(PetscObjectComm((PetscObject)ts), &dm)); 1826 PetscCall(DMLoad(dm, viewer)); 1827 PetscCall(TSSetDM(ts, dm)); 1828 PetscCall(DMCreateGlobalVector(ts->dm, &ts->vec_sol)); 1829 PetscCall(VecLoad(ts->vec_sol, viewer)); 1830 PetscCall(DMGetDMTS(ts->dm, &sdm)); 1831 PetscCall(DMTSLoad(sdm, viewer)); 1832 PetscFunctionReturn(PETSC_SUCCESS); 1833 } 1834 1835 #include <petscdraw.h> 1836 #if defined(PETSC_HAVE_SAWS) 1837 #include <petscviewersaws.h> 1838 #endif 1839 1840 /*@C 1841 TSViewFromOptions - View a `TS` based on values in the options database 1842 1843 Collective 1844 1845 Input Parameters: 1846 + ts - the `TS` context 1847 . obj - Optional object that provides the prefix for the options database keys 1848 - name - command line option string to be passed by user 1849 1850 Level: intermediate 1851 1852 .seealso: [](ch_ts), `TS`, `TSView`, `PetscObjectViewFromOptions()`, `TSCreate()` 1853 @*/ 1854 PetscErrorCode TSViewFromOptions(TS ts, PetscObject obj, const char name[]) 1855 { 1856 PetscFunctionBegin; 1857 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1858 PetscCall(PetscObjectViewFromOptions((PetscObject)ts, obj, name)); 1859 PetscFunctionReturn(PETSC_SUCCESS); 1860 } 1861 1862 /*@C 1863 TSView - Prints the `TS` data structure. 1864 1865 Collective 1866 1867 Input Parameters: 1868 + ts - the `TS` context obtained from `TSCreate()` 1869 - viewer - visualization context 1870 1871 Options Database Key: 1872 . -ts_view - calls `TSView()` at end of `TSStep()` 1873 1874 Level: beginner 1875 1876 Notes: 1877 The available visualization contexts include 1878 + `PETSC_VIEWER_STDOUT_SELF` - standard output (default) 1879 - `PETSC_VIEWER_STDOUT_WORLD` - synchronized standard 1880 output where only the first processor opens 1881 the file. All other processors send their 1882 data to the first processor to print. 1883 1884 The user can open an alternative visualization context with 1885 `PetscViewerASCIIOpen()` - output to a specified file. 1886 1887 In the debugger you can do call `TSView`(ts,0) to display the `TS` solver. (The same holds for any PETSc object viewer). 1888 1889 .seealso: [](ch_ts), `TS`, `PetscViewer`, `PetscViewerASCIIOpen()` 1890 @*/ 1891 PetscErrorCode TSView(TS ts, PetscViewer viewer) 1892 { 1893 TSType type; 1894 PetscBool iascii, isstring, isundials, isbinary, isdraw; 1895 DMTS sdm; 1896 #if defined(PETSC_HAVE_SAWS) 1897 PetscBool issaws; 1898 #endif 1899 1900 PetscFunctionBegin; 1901 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 1902 if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts), &viewer)); 1903 PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2); 1904 PetscCheckSameComm(ts, 1, viewer, 2); 1905 1906 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii)); 1907 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERSTRING, &isstring)); 1908 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary)); 1909 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw)); 1910 #if defined(PETSC_HAVE_SAWS) 1911 PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERSAWS, &issaws)); 1912 #endif 1913 if (iascii) { 1914 PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)ts, viewer)); 1915 if (ts->ops->view) { 1916 PetscCall(PetscViewerASCIIPushTab(viewer)); 1917 PetscUseTypeMethod(ts, view, viewer); 1918 PetscCall(PetscViewerASCIIPopTab(viewer)); 1919 } 1920 if (ts->max_steps < PETSC_MAX_INT) PetscCall(PetscViewerASCIIPrintf(viewer, " maximum steps=%" PetscInt_FMT "\n", ts->max_steps)); 1921 if (ts->max_time < PETSC_MAX_REAL) PetscCall(PetscViewerASCIIPrintf(viewer, " maximum time=%g\n", (double)ts->max_time)); 1922 if (ts->ifuncs) PetscCall(PetscViewerASCIIPrintf(viewer, " total number of I function evaluations=%" PetscInt_FMT "\n", ts->ifuncs)); 1923 if (ts->ijacs) PetscCall(PetscViewerASCIIPrintf(viewer, " total number of I Jacobian evaluations=%" PetscInt_FMT "\n", ts->ijacs)); 1924 if (ts->rhsfuncs) PetscCall(PetscViewerASCIIPrintf(viewer, " total number of RHS function evaluations=%" PetscInt_FMT "\n", ts->rhsfuncs)); 1925 if (ts->rhsjacs) PetscCall(PetscViewerASCIIPrintf(viewer, " total number of RHS Jacobian evaluations=%" PetscInt_FMT "\n", ts->rhsjacs)); 1926 if (ts->usessnes) { 1927 PetscBool lin; 1928 if (ts->problem_type == TS_NONLINEAR) PetscCall(PetscViewerASCIIPrintf(viewer, " total number of nonlinear solver iterations=%" PetscInt_FMT "\n", ts->snes_its)); 1929 PetscCall(PetscViewerASCIIPrintf(viewer, " total number of linear solver iterations=%" PetscInt_FMT "\n", ts->ksp_its)); 1930 PetscCall(PetscObjectTypeCompareAny((PetscObject)ts->snes, &lin, SNESKSPONLY, SNESKSPTRANSPOSEONLY, "")); 1931 PetscCall(PetscViewerASCIIPrintf(viewer, " total number of %slinear solve failures=%" PetscInt_FMT "\n", lin ? "" : "non", ts->num_snes_failures)); 1932 } 1933 PetscCall(PetscViewerASCIIPrintf(viewer, " total number of rejected steps=%" PetscInt_FMT "\n", ts->reject)); 1934 if (ts->vrtol) PetscCall(PetscViewerASCIIPrintf(viewer, " using vector of relative error tolerances, ")); 1935 else PetscCall(PetscViewerASCIIPrintf(viewer, " using relative error tolerance of %g, ", (double)ts->rtol)); 1936 if (ts->vatol) PetscCall(PetscViewerASCIIPrintf(viewer, " using vector of absolute error tolerances\n")); 1937 else PetscCall(PetscViewerASCIIPrintf(viewer, " using absolute error tolerance of %g\n", (double)ts->atol)); 1938 PetscCall(PetscViewerASCIIPushTab(viewer)); 1939 PetscCall(TSAdaptView(ts->adapt, viewer)); 1940 PetscCall(PetscViewerASCIIPopTab(viewer)); 1941 } else if (isstring) { 1942 PetscCall(TSGetType(ts, &type)); 1943 PetscCall(PetscViewerStringSPrintf(viewer, " TSType: %-7.7s", type)); 1944 PetscTryTypeMethod(ts, view, viewer); 1945 } else if (isbinary) { 1946 PetscInt classid = TS_FILE_CLASSID; 1947 MPI_Comm comm; 1948 PetscMPIInt rank; 1949 char type[256]; 1950 1951 PetscCall(PetscObjectGetComm((PetscObject)ts, &comm)); 1952 PetscCallMPI(MPI_Comm_rank(comm, &rank)); 1953 if (rank == 0) { 1954 PetscCall(PetscViewerBinaryWrite(viewer, &classid, 1, PETSC_INT)); 1955 PetscCall(PetscStrncpy(type, ((PetscObject)ts)->type_name, 256)); 1956 PetscCall(PetscViewerBinaryWrite(viewer, type, 256, PETSC_CHAR)); 1957 } 1958 PetscTryTypeMethod(ts, view, viewer); 1959 if (ts->adapt) PetscCall(TSAdaptView(ts->adapt, viewer)); 1960 PetscCall(DMView(ts->dm, viewer)); 1961 PetscCall(VecView(ts->vec_sol, viewer)); 1962 PetscCall(DMGetDMTS(ts->dm, &sdm)); 1963 PetscCall(DMTSView(sdm, viewer)); 1964 } else if (isdraw) { 1965 PetscDraw draw; 1966 char str[36]; 1967 PetscReal x, y, bottom, h; 1968 1969 PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw)); 1970 PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y)); 1971 PetscCall(PetscStrncpy(str, "TS: ", sizeof(str))); 1972 PetscCall(PetscStrlcat(str, ((PetscObject)ts)->type_name, sizeof(str))); 1973 PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_BLACK, PETSC_DRAW_BLACK, str, NULL, &h)); 1974 bottom = y - h; 1975 PetscCall(PetscDrawPushCurrentPoint(draw, x, bottom)); 1976 PetscTryTypeMethod(ts, view, viewer); 1977 if (ts->adapt) PetscCall(TSAdaptView(ts->adapt, viewer)); 1978 if (ts->snes) PetscCall(SNESView(ts->snes, viewer)); 1979 PetscCall(PetscDrawPopCurrentPoint(draw)); 1980 #if defined(PETSC_HAVE_SAWS) 1981 } else if (issaws) { 1982 PetscMPIInt rank; 1983 const char *name; 1984 1985 PetscCall(PetscObjectGetName((PetscObject)ts, &name)); 1986 PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 1987 if (!((PetscObject)ts)->amsmem && rank == 0) { 1988 char dir[1024]; 1989 1990 PetscCall(PetscObjectViewSAWs((PetscObject)ts, viewer)); 1991 PetscCall(PetscSNPrintf(dir, 1024, "/PETSc/Objects/%s/time_step", name)); 1992 PetscCallSAWs(SAWs_Register, (dir, &ts->steps, 1, SAWs_READ, SAWs_INT)); 1993 PetscCall(PetscSNPrintf(dir, 1024, "/PETSc/Objects/%s/time", name)); 1994 PetscCallSAWs(SAWs_Register, (dir, &ts->ptime, 1, SAWs_READ, SAWs_DOUBLE)); 1995 } 1996 PetscTryTypeMethod(ts, view, viewer); 1997 #endif 1998 } 1999 if (ts->snes && ts->usessnes) { 2000 PetscCall(PetscViewerASCIIPushTab(viewer)); 2001 PetscCall(SNESView(ts->snes, viewer)); 2002 PetscCall(PetscViewerASCIIPopTab(viewer)); 2003 } 2004 PetscCall(DMGetDMTS(ts->dm, &sdm)); 2005 PetscCall(DMTSView(sdm, viewer)); 2006 2007 PetscCall(PetscViewerASCIIPushTab(viewer)); 2008 PetscCall(PetscObjectTypeCompare((PetscObject)ts, TSSUNDIALS, &isundials)); 2009 PetscCall(PetscViewerASCIIPopTab(viewer)); 2010 PetscFunctionReturn(PETSC_SUCCESS); 2011 } 2012 2013 /*@ 2014 TSSetApplicationContext - Sets an optional user-defined context for 2015 the timesteppers. 2016 2017 Logically Collective 2018 2019 Input Parameters: 2020 + ts - the `TS` context obtained from `TSCreate()` 2021 - usrP - user context 2022 2023 Level: intermediate 2024 2025 Fortran Notes: 2026 You must write a Fortran interface definition for this 2027 function that tells Fortran the Fortran derived data type that you are passing in as the `ctx` argument. 2028 2029 .seealso: [](ch_ts), `TS`, `TSGetApplicationContext()` 2030 @*/ 2031 PetscErrorCode TSSetApplicationContext(TS ts, void *usrP) 2032 { 2033 PetscFunctionBegin; 2034 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2035 ts->user = usrP; 2036 PetscFunctionReturn(PETSC_SUCCESS); 2037 } 2038 2039 /*@ 2040 TSGetApplicationContext - Gets the user-defined context for the 2041 timestepper that was set with `TSSetApplicationContext()` 2042 2043 Not Collective 2044 2045 Input Parameter: 2046 . ts - the `TS` context obtained from `TSCreate()` 2047 2048 Output Parameter: 2049 . usrP - user context 2050 2051 Level: intermediate 2052 2053 Fortran Notes: 2054 You must write a Fortran interface definition for this 2055 function that tells Fortran the Fortran derived data type that you are passing in as the `ctx` argument. 2056 2057 .seealso: [](ch_ts), `TS`, `TSSetApplicationContext()` 2058 @*/ 2059 PetscErrorCode TSGetApplicationContext(TS ts, void *usrP) 2060 { 2061 PetscFunctionBegin; 2062 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2063 *(void **)usrP = ts->user; 2064 PetscFunctionReturn(PETSC_SUCCESS); 2065 } 2066 2067 /*@ 2068 TSGetStepNumber - Gets the number of time steps completed. 2069 2070 Not Collective 2071 2072 Input Parameter: 2073 . ts - the `TS` context obtained from `TSCreate()` 2074 2075 Output Parameter: 2076 . steps - number of steps completed so far 2077 2078 Level: intermediate 2079 2080 .seealso: [](ch_ts), `TS`, `TSGetTime()`, `TSGetTimeStep()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostStage()`, `TSSetPostStep()` 2081 @*/ 2082 PetscErrorCode TSGetStepNumber(TS ts, PetscInt *steps) 2083 { 2084 PetscFunctionBegin; 2085 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2086 PetscAssertPointer(steps, 2); 2087 *steps = ts->steps; 2088 PetscFunctionReturn(PETSC_SUCCESS); 2089 } 2090 2091 /*@ 2092 TSSetStepNumber - Sets the number of steps completed. 2093 2094 Logically Collective 2095 2096 Input Parameters: 2097 + ts - the `TS` context 2098 - steps - number of steps completed so far 2099 2100 Level: developer 2101 2102 Note: 2103 For most uses of the `TS` solvers the user need not explicitly call 2104 `TSSetStepNumber()`, as the step counter is appropriately updated in 2105 `TSSolve()`/`TSStep()`/`TSRollBack()`. Power users may call this routine to 2106 reinitialize timestepping by setting the step counter to zero (and time 2107 to the initial time) to solve a similar problem with different initial 2108 conditions or parameters. Other possible use case is to continue 2109 timestepping from a previously interrupted run in such a way that `TS` 2110 monitors will be called with a initial nonzero step counter. 2111 2112 .seealso: [](ch_ts), `TS`, `TSGetStepNumber()`, `TSSetTime()`, `TSSetTimeStep()`, `TSSetSolution()` 2113 @*/ 2114 PetscErrorCode TSSetStepNumber(TS ts, PetscInt steps) 2115 { 2116 PetscFunctionBegin; 2117 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2118 PetscValidLogicalCollectiveInt(ts, steps, 2); 2119 PetscCheck(steps >= 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Step number must be non-negative"); 2120 ts->steps = steps; 2121 PetscFunctionReturn(PETSC_SUCCESS); 2122 } 2123 2124 /*@ 2125 TSSetTimeStep - Allows one to reset the timestep at any time, 2126 useful for simple pseudo-timestepping codes. 2127 2128 Logically Collective 2129 2130 Input Parameters: 2131 + ts - the `TS` context obtained from `TSCreate()` 2132 - time_step - the size of the timestep 2133 2134 Level: intermediate 2135 2136 .seealso: [](ch_ts), `TS`, `TSPSEUDO`, `TSGetTimeStep()`, `TSSetTime()` 2137 @*/ 2138 PetscErrorCode TSSetTimeStep(TS ts, PetscReal time_step) 2139 { 2140 PetscFunctionBegin; 2141 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2142 PetscValidLogicalCollectiveReal(ts, time_step, 2); 2143 ts->time_step = time_step; 2144 PetscFunctionReturn(PETSC_SUCCESS); 2145 } 2146 2147 /*@ 2148 TSSetExactFinalTime - Determines whether to adapt the final time step to 2149 match the exact final time, interpolate solution to the exact final time, 2150 or just return at the final time `TS` computed. 2151 2152 Logically Collective 2153 2154 Input Parameters: 2155 + ts - the time-step context 2156 - eftopt - exact final time option 2157 .vb 2158 TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 2159 TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 2160 TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 2161 .ve 2162 2163 Options Database Key: 2164 . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime 2165 2166 Level: beginner 2167 2168 Note: 2169 If you use the option `TS_EXACTFINALTIME_STEPOVER` the solution may be at a very different time 2170 then the final time you selected. 2171 2172 .seealso: [](ch_ts), `TS`, `TSExactFinalTimeOption`, `TSGetExactFinalTime()` 2173 @*/ 2174 PetscErrorCode TSSetExactFinalTime(TS ts, TSExactFinalTimeOption eftopt) 2175 { 2176 PetscFunctionBegin; 2177 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2178 PetscValidLogicalCollectiveEnum(ts, eftopt, 2); 2179 ts->exact_final_time = eftopt; 2180 PetscFunctionReturn(PETSC_SUCCESS); 2181 } 2182 2183 /*@ 2184 TSGetExactFinalTime - Gets the exact final time option set with `TSSetExactFinalTime()` 2185 2186 Not Collective 2187 2188 Input Parameter: 2189 . ts - the `TS` context 2190 2191 Output Parameter: 2192 . eftopt - exact final time option 2193 2194 Level: beginner 2195 2196 .seealso: [](ch_ts), `TS`, `TSExactFinalTimeOption`, `TSSetExactFinalTime()` 2197 @*/ 2198 PetscErrorCode TSGetExactFinalTime(TS ts, TSExactFinalTimeOption *eftopt) 2199 { 2200 PetscFunctionBegin; 2201 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2202 PetscAssertPointer(eftopt, 2); 2203 *eftopt = ts->exact_final_time; 2204 PetscFunctionReturn(PETSC_SUCCESS); 2205 } 2206 2207 /*@ 2208 TSGetTimeStep - Gets the current timestep size. 2209 2210 Not Collective 2211 2212 Input Parameter: 2213 . ts - the `TS` context obtained from `TSCreate()` 2214 2215 Output Parameter: 2216 . dt - the current timestep size 2217 2218 Level: intermediate 2219 2220 .seealso: [](ch_ts), `TS`, `TSSetTimeStep()`, `TSGetTime()` 2221 @*/ 2222 PetscErrorCode TSGetTimeStep(TS ts, PetscReal *dt) 2223 { 2224 PetscFunctionBegin; 2225 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2226 PetscAssertPointer(dt, 2); 2227 *dt = ts->time_step; 2228 PetscFunctionReturn(PETSC_SUCCESS); 2229 } 2230 2231 /*@ 2232 TSGetSolution - Returns the solution at the present timestep. It 2233 is valid to call this routine inside the function that you are evaluating 2234 in order to move to the new timestep. This vector not changed until 2235 the solution at the next timestep has been calculated. 2236 2237 Not Collective, but v returned is parallel if ts is parallel 2238 2239 Input Parameter: 2240 . ts - the `TS` context obtained from `TSCreate()` 2241 2242 Output Parameter: 2243 . v - the vector containing the solution 2244 2245 Level: intermediate 2246 2247 Note: 2248 If you used `TSSetExactFinalTime`(ts,`TS_EXACTFINALTIME_MATCHSTEP`); this does not return the solution at the requested 2249 final time. It returns the solution at the next timestep. 2250 2251 .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetTime()`, `TSGetSolveTime()`, `TSGetSolutionComponents()`, `TSSetSolutionFunction()` 2252 @*/ 2253 PetscErrorCode TSGetSolution(TS ts, Vec *v) 2254 { 2255 PetscFunctionBegin; 2256 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2257 PetscAssertPointer(v, 2); 2258 *v = ts->vec_sol; 2259 PetscFunctionReturn(PETSC_SUCCESS); 2260 } 2261 2262 /*@ 2263 TSGetSolutionComponents - Returns any solution components at the present 2264 timestep, if available for the time integration method being used. 2265 Solution components are quantities that share the same size and 2266 structure as the solution vector. 2267 2268 Not Collective, but v returned is parallel if ts is parallel 2269 2270 Input Parameters: 2271 + ts - the `TS` context obtained from `TSCreate()` (input parameter). 2272 . n - If v is `NULL`, then the number of solution components is 2273 returned through n, else the n-th solution component is 2274 returned in v. 2275 - v - the vector containing the n-th solution component 2276 (may be `NULL` to use this function to find out 2277 the number of solutions components). 2278 2279 Level: advanced 2280 2281 .seealso: [](ch_ts), `TS`, `TSGetSolution()` 2282 @*/ 2283 PetscErrorCode TSGetSolutionComponents(TS ts, PetscInt *n, Vec *v) 2284 { 2285 PetscFunctionBegin; 2286 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2287 if (!ts->ops->getsolutioncomponents) *n = 0; 2288 else PetscUseTypeMethod(ts, getsolutioncomponents, n, v); 2289 PetscFunctionReturn(PETSC_SUCCESS); 2290 } 2291 2292 /*@ 2293 TSGetAuxSolution - Returns an auxiliary solution at the present 2294 timestep, if available for the time integration method being used. 2295 2296 Not Collective, but v returned is parallel if ts is parallel 2297 2298 Input Parameters: 2299 + ts - the `TS` context obtained from `TSCreate()` (input parameter). 2300 - v - the vector containing the auxiliary solution 2301 2302 Level: intermediate 2303 2304 .seealso: [](ch_ts), `TS`, `TSGetSolution()` 2305 @*/ 2306 PetscErrorCode TSGetAuxSolution(TS ts, Vec *v) 2307 { 2308 PetscFunctionBegin; 2309 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2310 if (ts->ops->getauxsolution) PetscUseTypeMethod(ts, getauxsolution, v); 2311 else PetscCall(VecZeroEntries(*v)); 2312 PetscFunctionReturn(PETSC_SUCCESS); 2313 } 2314 2315 /*@ 2316 TSGetTimeError - Returns the estimated error vector, if the chosen 2317 `TSType` has an error estimation functionality and `TSSetTimeError()` was called 2318 2319 Not Collective, but v returned is parallel if ts is parallel 2320 2321 Input Parameters: 2322 + ts - the `TS` context obtained from `TSCreate()` (input parameter). 2323 . n - current estimate (n=0) or previous one (n=-1) 2324 - v - the vector containing the error (same size as the solution). 2325 2326 Level: intermediate 2327 2328 Note: 2329 MUST call after `TSSetUp()` 2330 2331 .seealso: [](ch_ts), `TSGetSolution()`, `TSSetTimeError()` 2332 @*/ 2333 PetscErrorCode TSGetTimeError(TS ts, PetscInt n, Vec *v) 2334 { 2335 PetscFunctionBegin; 2336 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2337 if (ts->ops->gettimeerror) PetscUseTypeMethod(ts, gettimeerror, n, v); 2338 else PetscCall(VecZeroEntries(*v)); 2339 PetscFunctionReturn(PETSC_SUCCESS); 2340 } 2341 2342 /*@ 2343 TSSetTimeError - Sets the estimated error vector, if the chosen 2344 `TSType` has an error estimation functionality. This can be used 2345 to restart such a time integrator with a given error vector. 2346 2347 Not Collective, but v returned is parallel if ts is parallel 2348 2349 Input Parameters: 2350 + ts - the `TS` context obtained from `TSCreate()` (input parameter). 2351 - v - the vector containing the error (same size as the solution). 2352 2353 Level: intermediate 2354 2355 .seealso: [](ch_ts), `TS`, `TSSetSolution()`, `TSGetTimeError()` 2356 @*/ 2357 PetscErrorCode TSSetTimeError(TS ts, Vec v) 2358 { 2359 PetscFunctionBegin; 2360 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2361 PetscCheck(ts->setupcalled, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call TSSetUp() first"); 2362 PetscTryTypeMethod(ts, settimeerror, v); 2363 PetscFunctionReturn(PETSC_SUCCESS); 2364 } 2365 2366 /* ----- Routines to initialize and destroy a timestepper ---- */ 2367 /*@ 2368 TSSetProblemType - Sets the type of problem to be solved. 2369 2370 Not collective 2371 2372 Input Parameters: 2373 + ts - The `TS` 2374 - type - One of `TS_LINEAR`, `TS_NONLINEAR` where these types refer to problems of the forms 2375 .vb 2376 U_t - A U = 0 (linear) 2377 U_t - A(t) U = 0 (linear) 2378 F(t,U,U_t) = 0 (nonlinear) 2379 .ve 2380 2381 Level: beginner 2382 2383 .seealso: [](ch_ts), `TSSetUp()`, `TSProblemType`, `TS` 2384 @*/ 2385 PetscErrorCode TSSetProblemType(TS ts, TSProblemType type) 2386 { 2387 PetscFunctionBegin; 2388 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2389 ts->problem_type = type; 2390 if (type == TS_LINEAR) { 2391 SNES snes; 2392 PetscCall(TSGetSNES(ts, &snes)); 2393 PetscCall(SNESSetType(snes, SNESKSPONLY)); 2394 } 2395 PetscFunctionReturn(PETSC_SUCCESS); 2396 } 2397 2398 /*@C 2399 TSGetProblemType - Gets the type of problem to be solved. 2400 2401 Not collective 2402 2403 Input Parameter: 2404 . ts - The `TS` 2405 2406 Output Parameter: 2407 . type - One of `TS_LINEAR`, `TS_NONLINEAR` where these types refer to problems of the forms 2408 .vb 2409 M U_t = A U 2410 M(t) U_t = A(t) U 2411 F(t,U,U_t) 2412 .ve 2413 2414 Level: beginner 2415 2416 .seealso: [](ch_ts), `TSSetUp()`, `TSProblemType`, `TS` 2417 @*/ 2418 PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type) 2419 { 2420 PetscFunctionBegin; 2421 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2422 PetscAssertPointer(type, 2); 2423 *type = ts->problem_type; 2424 PetscFunctionReturn(PETSC_SUCCESS); 2425 } 2426 2427 /* 2428 Attempt to check/preset a default value for the exact final time option. This is needed at the beginning of TSSolve() and in TSSetUp() 2429 */ 2430 static PetscErrorCode TSSetExactFinalTimeDefault(TS ts) 2431 { 2432 PetscBool isnone; 2433 2434 PetscFunctionBegin; 2435 PetscCall(TSGetAdapt(ts, &ts->adapt)); 2436 PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type)); 2437 2438 PetscCall(PetscObjectTypeCompare((PetscObject)ts->adapt, TSADAPTNONE, &isnone)); 2439 if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP; 2440 else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE; 2441 PetscFunctionReturn(PETSC_SUCCESS); 2442 } 2443 2444 /*@ 2445 TSSetUp - Sets up the internal data structures for the later use of a timestepper. 2446 2447 Collective 2448 2449 Input Parameter: 2450 . ts - the `TS` context obtained from `TSCreate()` 2451 2452 Level: advanced 2453 2454 Note: 2455 For basic use of the `TS` solvers the user need not explicitly call 2456 `TSSetUp()`, since these actions will automatically occur during 2457 the call to `TSStep()` or `TSSolve()`. However, if one wishes to control this 2458 phase separately, `TSSetUp()` should be called after `TSCreate()` 2459 and optional routines of the form TSSetXXX(), but before `TSStep()` and `TSSolve()`. 2460 2461 .seealso: [](ch_ts), `TSCreate()`, `TS`, `TSStep()`, `TSDestroy()`, `TSSolve()` 2462 @*/ 2463 PetscErrorCode TSSetUp(TS ts) 2464 { 2465 DM dm; 2466 PetscErrorCode (*func)(SNES, Vec, Vec, void *); 2467 PetscErrorCode (*jac)(SNES, Vec, Mat, Mat, void *); 2468 TSIFunctionFn *ifun; 2469 TSIJacobianFn *ijac; 2470 TSI2JacobianFn *i2jac; 2471 TSRHSJacobianFn *rhsjac; 2472 2473 PetscFunctionBegin; 2474 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2475 if (ts->setupcalled) PetscFunctionReturn(PETSC_SUCCESS); 2476 2477 if (!((PetscObject)ts)->type_name) { 2478 PetscCall(TSGetIFunction(ts, NULL, &ifun, NULL)); 2479 PetscCall(TSSetType(ts, ifun ? TSBEULER : TSEULER)); 2480 } 2481 2482 if (!ts->vec_sol) { 2483 PetscCheck(ts->dm, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call TSSetSolution() first"); 2484 PetscCall(DMCreateGlobalVector(ts->dm, &ts->vec_sol)); 2485 } 2486 2487 if (ts->tspan) { 2488 if (!ts->tspan->vecs_sol) PetscCall(VecDuplicateVecs(ts->vec_sol, ts->tspan->num_span_times, &ts->tspan->vecs_sol)); 2489 } 2490 if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */ 2491 PetscCall(PetscObjectReference((PetscObject)ts->Jacprhs)); 2492 ts->Jacp = ts->Jacprhs; 2493 } 2494 2495 if (ts->quadraturets) { 2496 PetscCall(TSSetUp(ts->quadraturets)); 2497 PetscCall(VecDestroy(&ts->vec_costintegrand)); 2498 PetscCall(VecDuplicate(ts->quadraturets->vec_sol, &ts->vec_costintegrand)); 2499 } 2500 2501 PetscCall(TSGetRHSJacobian(ts, NULL, NULL, &rhsjac, NULL)); 2502 if (rhsjac == TSComputeRHSJacobianConstant) { 2503 Mat Amat, Pmat; 2504 SNES snes; 2505 PetscCall(TSGetSNES(ts, &snes)); 2506 PetscCall(SNESGetJacobian(snes, &Amat, &Pmat, NULL, NULL)); 2507 /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would 2508 * have displaced the RHS matrix */ 2509 if (Amat && Amat == ts->Arhs) { 2510 /* 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 */ 2511 PetscCall(MatDuplicate(ts->Arhs, MAT_COPY_VALUES, &Amat)); 2512 PetscCall(SNESSetJacobian(snes, Amat, NULL, NULL, NULL)); 2513 PetscCall(MatDestroy(&Amat)); 2514 } 2515 if (Pmat && Pmat == ts->Brhs) { 2516 PetscCall(MatDuplicate(ts->Brhs, MAT_COPY_VALUES, &Pmat)); 2517 PetscCall(SNESSetJacobian(snes, NULL, Pmat, NULL, NULL)); 2518 PetscCall(MatDestroy(&Pmat)); 2519 } 2520 } 2521 2522 PetscCall(TSGetAdapt(ts, &ts->adapt)); 2523 PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type)); 2524 2525 PetscTryTypeMethod(ts, setup); 2526 2527 PetscCall(TSSetExactFinalTimeDefault(ts)); 2528 2529 /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction 2530 to be set right but can't do it elsewhere due to the overreliance on ctx=ts. 2531 */ 2532 PetscCall(TSGetDM(ts, &dm)); 2533 PetscCall(DMSNESGetFunction(dm, &func, NULL)); 2534 if (!func) PetscCall(DMSNESSetFunction(dm, SNESTSFormFunction, ts)); 2535 2536 /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it. 2537 Otherwise, the SNES will use coloring internally to form the Jacobian. 2538 */ 2539 PetscCall(DMSNESGetJacobian(dm, &jac, NULL)); 2540 PetscCall(DMTSGetIJacobian(dm, &ijac, NULL)); 2541 PetscCall(DMTSGetI2Jacobian(dm, &i2jac, NULL)); 2542 PetscCall(DMTSGetRHSJacobian(dm, &rhsjac, NULL)); 2543 if (!jac && (ijac || i2jac || rhsjac)) PetscCall(DMSNESSetJacobian(dm, SNESTSFormJacobian, ts)); 2544 2545 /* if time integration scheme has a starting method, call it */ 2546 PetscTryTypeMethod(ts, startingmethod); 2547 2548 ts->setupcalled = PETSC_TRUE; 2549 PetscFunctionReturn(PETSC_SUCCESS); 2550 } 2551 2552 /*@ 2553 TSReset - Resets a `TS` context and removes any allocated `Vec`s and `Mat`s. 2554 2555 Collective 2556 2557 Input Parameter: 2558 . ts - the `TS` context obtained from `TSCreate()` 2559 2560 Level: beginner 2561 2562 .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetup()`, `TSDestroy()` 2563 @*/ 2564 PetscErrorCode TSReset(TS ts) 2565 { 2566 TS_RHSSplitLink ilink = ts->tsrhssplit, next; 2567 2568 PetscFunctionBegin; 2569 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2570 2571 PetscTryTypeMethod(ts, reset); 2572 if (ts->snes) PetscCall(SNESReset(ts->snes)); 2573 if (ts->adapt) PetscCall(TSAdaptReset(ts->adapt)); 2574 2575 PetscCall(MatDestroy(&ts->Arhs)); 2576 PetscCall(MatDestroy(&ts->Brhs)); 2577 PetscCall(VecDestroy(&ts->Frhs)); 2578 PetscCall(VecDestroy(&ts->vec_sol)); 2579 PetscCall(VecDestroy(&ts->vec_dot)); 2580 PetscCall(VecDestroy(&ts->vatol)); 2581 PetscCall(VecDestroy(&ts->vrtol)); 2582 PetscCall(VecDestroyVecs(ts->nwork, &ts->work)); 2583 2584 PetscCall(MatDestroy(&ts->Jacprhs)); 2585 PetscCall(MatDestroy(&ts->Jacp)); 2586 if (ts->forward_solve) PetscCall(TSForwardReset(ts)); 2587 if (ts->quadraturets) { 2588 PetscCall(TSReset(ts->quadraturets)); 2589 PetscCall(VecDestroy(&ts->vec_costintegrand)); 2590 } 2591 while (ilink) { 2592 next = ilink->next; 2593 PetscCall(TSDestroy(&ilink->ts)); 2594 PetscCall(PetscFree(ilink->splitname)); 2595 PetscCall(ISDestroy(&ilink->is)); 2596 PetscCall(PetscFree(ilink)); 2597 ilink = next; 2598 } 2599 ts->tsrhssplit = NULL; 2600 ts->num_rhs_splits = 0; 2601 if (ts->tspan) { 2602 PetscCall(PetscFree(ts->tspan->span_times)); 2603 PetscCall(VecDestroyVecs(ts->tspan->num_span_times, &ts->tspan->vecs_sol)); 2604 PetscCall(PetscFree(ts->tspan)); 2605 } 2606 ts->rhsjacobian.time = PETSC_MIN_REAL; 2607 ts->rhsjacobian.scale = 1.0; 2608 ts->ijacobian.shift = 1.0; 2609 ts->setupcalled = PETSC_FALSE; 2610 PetscFunctionReturn(PETSC_SUCCESS); 2611 } 2612 2613 static PetscErrorCode TSResizeReset(TS); 2614 2615 /*@C 2616 TSDestroy - Destroys the timestepper context that was created 2617 with `TSCreate()`. 2618 2619 Collective 2620 2621 Input Parameter: 2622 . ts - the `TS` context obtained from `TSCreate()` 2623 2624 Level: beginner 2625 2626 .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetUp()`, `TSSolve()` 2627 @*/ 2628 PetscErrorCode TSDestroy(TS *ts) 2629 { 2630 PetscFunctionBegin; 2631 if (!*ts) PetscFunctionReturn(PETSC_SUCCESS); 2632 PetscValidHeaderSpecific(*ts, TS_CLASSID, 1); 2633 if (--((PetscObject)*ts)->refct > 0) { 2634 *ts = NULL; 2635 PetscFunctionReturn(PETSC_SUCCESS); 2636 } 2637 2638 PetscCall(TSReset(*ts)); 2639 PetscCall(TSAdjointReset(*ts)); 2640 if ((*ts)->forward_solve) PetscCall(TSForwardReset(*ts)); 2641 PetscCall(TSResizeReset(*ts)); 2642 2643 /* if memory was published with SAWs then destroy it */ 2644 PetscCall(PetscObjectSAWsViewOff((PetscObject)*ts)); 2645 PetscTryTypeMethod(*ts, destroy); 2646 2647 PetscCall(TSTrajectoryDestroy(&(*ts)->trajectory)); 2648 2649 PetscCall(TSAdaptDestroy(&(*ts)->adapt)); 2650 PetscCall(TSEventDestroy(&(*ts)->event)); 2651 2652 PetscCall(SNESDestroy(&(*ts)->snes)); 2653 PetscCall(DMDestroy(&(*ts)->dm)); 2654 PetscCall(TSMonitorCancel(*ts)); 2655 PetscCall(TSAdjointMonitorCancel(*ts)); 2656 2657 PetscCall(TSDestroy(&(*ts)->quadraturets)); 2658 PetscCall(PetscHeaderDestroy(ts)); 2659 PetscFunctionReturn(PETSC_SUCCESS); 2660 } 2661 2662 /*@ 2663 TSGetSNES - Returns the `SNES` (nonlinear solver) associated with 2664 a `TS` (timestepper) context. Valid only for nonlinear problems. 2665 2666 Not Collective, but snes is parallel if ts is parallel 2667 2668 Input Parameter: 2669 . ts - the `TS` context obtained from `TSCreate()` 2670 2671 Output Parameter: 2672 . snes - the nonlinear solver context 2673 2674 Level: beginner 2675 2676 Notes: 2677 The user can then directly manipulate the `SNES` context to set various 2678 options, etc. Likewise, the user can then extract and manipulate the 2679 `KSP`, and `PC` contexts as well. 2680 2681 `TSGetSNES()` does not work for integrators that do not use `SNES`; in 2682 this case `TSGetSNES()` returns `NULL` in `snes`. 2683 2684 .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetUp()`, `TSSolve()` 2685 @*/ 2686 PetscErrorCode TSGetSNES(TS ts, SNES *snes) 2687 { 2688 PetscFunctionBegin; 2689 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2690 PetscAssertPointer(snes, 2); 2691 if (!ts->snes) { 2692 PetscCall(SNESCreate(PetscObjectComm((PetscObject)ts), &ts->snes)); 2693 PetscCall(PetscObjectSetOptions((PetscObject)ts->snes, ((PetscObject)ts)->options)); 2694 PetscCall(SNESSetFunction(ts->snes, NULL, SNESTSFormFunction, ts)); 2695 PetscCall(PetscObjectIncrementTabLevel((PetscObject)ts->snes, (PetscObject)ts, 1)); 2696 if (ts->dm) PetscCall(SNESSetDM(ts->snes, ts->dm)); 2697 if (ts->problem_type == TS_LINEAR) PetscCall(SNESSetType(ts->snes, SNESKSPONLY)); 2698 } 2699 *snes = ts->snes; 2700 PetscFunctionReturn(PETSC_SUCCESS); 2701 } 2702 2703 /*@ 2704 TSSetSNES - Set the `SNES` (nonlinear solver) to be used by the timestepping context 2705 2706 Collective 2707 2708 Input Parameters: 2709 + ts - the `TS` context obtained from `TSCreate()` 2710 - snes - the nonlinear solver context 2711 2712 Level: developer 2713 2714 Note: 2715 Most users should have the `TS` created by calling `TSGetSNES()` 2716 2717 .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetUp()`, `TSSolve()`, `TSGetSNES()` 2718 @*/ 2719 PetscErrorCode TSSetSNES(TS ts, SNES snes) 2720 { 2721 PetscErrorCode (*func)(SNES, Vec, Mat, Mat, void *); 2722 2723 PetscFunctionBegin; 2724 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2725 PetscValidHeaderSpecific(snes, SNES_CLASSID, 2); 2726 PetscCall(PetscObjectReference((PetscObject)snes)); 2727 PetscCall(SNESDestroy(&ts->snes)); 2728 2729 ts->snes = snes; 2730 2731 PetscCall(SNESSetFunction(ts->snes, NULL, SNESTSFormFunction, ts)); 2732 PetscCall(SNESGetJacobian(ts->snes, NULL, NULL, &func, NULL)); 2733 if (func == SNESTSFormJacobian) PetscCall(SNESSetJacobian(ts->snes, NULL, NULL, SNESTSFormJacobian, ts)); 2734 PetscFunctionReturn(PETSC_SUCCESS); 2735 } 2736 2737 /*@ 2738 TSGetKSP - Returns the `KSP` (linear solver) associated with 2739 a `TS` (timestepper) context. 2740 2741 Not Collective, but `ksp` is parallel if `ts` is parallel 2742 2743 Input Parameter: 2744 . ts - the `TS` context obtained from `TSCreate()` 2745 2746 Output Parameter: 2747 . ksp - the nonlinear solver context 2748 2749 Level: beginner 2750 2751 Notes: 2752 The user can then directly manipulate the `KSP` context to set various 2753 options, etc. Likewise, the user can then extract and manipulate the 2754 `PC` context as well. 2755 2756 `TSGetKSP()` does not work for integrators that do not use `KSP`; 2757 in this case `TSGetKSP()` returns `NULL` in `ksp`. 2758 2759 .seealso: [](ch_ts), `TS`, `SNES`, `KSP`, `TSCreate()`, `TSSetUp()`, `TSSolve()`, `TSGetSNES()` 2760 @*/ 2761 PetscErrorCode TSGetKSP(TS ts, KSP *ksp) 2762 { 2763 SNES snes; 2764 2765 PetscFunctionBegin; 2766 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2767 PetscAssertPointer(ksp, 2); 2768 PetscCheck(((PetscObject)ts)->type_name, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "KSP is not created yet. Call TSSetType() first"); 2769 PetscCheck(ts->problem_type == TS_LINEAR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Linear only; use TSGetSNES()"); 2770 PetscCall(TSGetSNES(ts, &snes)); 2771 PetscCall(SNESGetKSP(snes, ksp)); 2772 PetscFunctionReturn(PETSC_SUCCESS); 2773 } 2774 2775 /* ----------- Routines to set solver parameters ---------- */ 2776 2777 /*@ 2778 TSSetMaxSteps - Sets the maximum number of steps to use. 2779 2780 Logically Collective 2781 2782 Input Parameters: 2783 + ts - the `TS` context obtained from `TSCreate()` 2784 - maxsteps - maximum number of steps to use 2785 2786 Options Database Key: 2787 . -ts_max_steps <maxsteps> - Sets maxsteps 2788 2789 Level: intermediate 2790 2791 Note: 2792 The default maximum number of steps is 5000 2793 2794 .seealso: [](ch_ts), `TS`, `TSGetMaxSteps()`, `TSSetMaxTime()`, `TSSetExactFinalTime()` 2795 @*/ 2796 PetscErrorCode TSSetMaxSteps(TS ts, PetscInt maxsteps) 2797 { 2798 PetscFunctionBegin; 2799 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2800 PetscValidLogicalCollectiveInt(ts, maxsteps, 2); 2801 PetscCheck(maxsteps >= 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Maximum number of steps must be non-negative"); 2802 ts->max_steps = maxsteps; 2803 PetscFunctionReturn(PETSC_SUCCESS); 2804 } 2805 2806 /*@ 2807 TSGetMaxSteps - Gets the maximum number of steps to use. 2808 2809 Not Collective 2810 2811 Input Parameter: 2812 . ts - the `TS` context obtained from `TSCreate()` 2813 2814 Output Parameter: 2815 . maxsteps - maximum number of steps to use 2816 2817 Level: advanced 2818 2819 .seealso: [](ch_ts), `TS`, `TSSetMaxSteps()`, `TSGetMaxTime()`, `TSSetMaxTime()` 2820 @*/ 2821 PetscErrorCode TSGetMaxSteps(TS ts, PetscInt *maxsteps) 2822 { 2823 PetscFunctionBegin; 2824 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2825 PetscAssertPointer(maxsteps, 2); 2826 *maxsteps = ts->max_steps; 2827 PetscFunctionReturn(PETSC_SUCCESS); 2828 } 2829 2830 /*@ 2831 TSSetMaxTime - Sets the maximum (or final) time for timestepping. 2832 2833 Logically Collective 2834 2835 Input Parameters: 2836 + ts - the `TS` context obtained from `TSCreate()` 2837 - maxtime - final time to step to 2838 2839 Options Database Key: 2840 . -ts_max_time <maxtime> - Sets maxtime 2841 2842 Level: intermediate 2843 2844 Notes: 2845 The default maximum time is 5.0 2846 2847 .seealso: [](ch_ts), `TS`, `TSGetMaxTime()`, `TSSetMaxSteps()`, `TSSetExactFinalTime()` 2848 @*/ 2849 PetscErrorCode TSSetMaxTime(TS ts, PetscReal maxtime) 2850 { 2851 PetscFunctionBegin; 2852 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2853 PetscValidLogicalCollectiveReal(ts, maxtime, 2); 2854 ts->max_time = maxtime; 2855 PetscFunctionReturn(PETSC_SUCCESS); 2856 } 2857 2858 /*@ 2859 TSGetMaxTime - Gets the maximum (or final) time for timestepping. 2860 2861 Not Collective 2862 2863 Input Parameter: 2864 . ts - the `TS` context obtained from `TSCreate()` 2865 2866 Output Parameter: 2867 . maxtime - final time to step to 2868 2869 Level: advanced 2870 2871 .seealso: [](ch_ts), `TS`, `TSSetMaxTime()`, `TSGetMaxSteps()`, `TSSetMaxSteps()` 2872 @*/ 2873 PetscErrorCode TSGetMaxTime(TS ts, PetscReal *maxtime) 2874 { 2875 PetscFunctionBegin; 2876 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2877 PetscAssertPointer(maxtime, 2); 2878 *maxtime = ts->max_time; 2879 PetscFunctionReturn(PETSC_SUCCESS); 2880 } 2881 2882 // PetscClangLinter pragma disable: -fdoc-* 2883 /*@ 2884 TSSetInitialTimeStep - Deprecated, use `TSSetTime()` and `TSSetTimeStep()`. 2885 2886 Level: deprecated 2887 2888 @*/ 2889 PetscErrorCode TSSetInitialTimeStep(TS ts, PetscReal initial_time, PetscReal time_step) 2890 { 2891 PetscFunctionBegin; 2892 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2893 PetscCall(TSSetTime(ts, initial_time)); 2894 PetscCall(TSSetTimeStep(ts, time_step)); 2895 PetscFunctionReturn(PETSC_SUCCESS); 2896 } 2897 2898 // PetscClangLinter pragma disable: -fdoc-* 2899 /*@ 2900 TSGetDuration - Deprecated, use `TSGetMaxSteps()` and `TSGetMaxTime()`. 2901 2902 Level: deprecated 2903 2904 @*/ 2905 PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime) 2906 { 2907 PetscFunctionBegin; 2908 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2909 if (maxsteps) { 2910 PetscAssertPointer(maxsteps, 2); 2911 *maxsteps = ts->max_steps; 2912 } 2913 if (maxtime) { 2914 PetscAssertPointer(maxtime, 3); 2915 *maxtime = ts->max_time; 2916 } 2917 PetscFunctionReturn(PETSC_SUCCESS); 2918 } 2919 2920 // PetscClangLinter pragma disable: -fdoc-* 2921 /*@ 2922 TSSetDuration - Deprecated, use `TSSetMaxSteps()` and `TSSetMaxTime()`. 2923 2924 Level: deprecated 2925 2926 @*/ 2927 PetscErrorCode TSSetDuration(TS ts, PetscInt maxsteps, PetscReal maxtime) 2928 { 2929 PetscFunctionBegin; 2930 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2931 PetscValidLogicalCollectiveInt(ts, maxsteps, 2); 2932 PetscValidLogicalCollectiveReal(ts, maxtime, 3); 2933 if (maxsteps >= 0) ts->max_steps = maxsteps; 2934 if (maxtime != (PetscReal)PETSC_DEFAULT) ts->max_time = maxtime; 2935 PetscFunctionReturn(PETSC_SUCCESS); 2936 } 2937 2938 // PetscClangLinter pragma disable: -fdoc-* 2939 /*@ 2940 TSGetTimeStepNumber - Deprecated, use `TSGetStepNumber()`. 2941 2942 Level: deprecated 2943 2944 @*/ 2945 PetscErrorCode TSGetTimeStepNumber(TS ts, PetscInt *steps) 2946 { 2947 return TSGetStepNumber(ts, steps); 2948 } 2949 2950 // PetscClangLinter pragma disable: -fdoc-* 2951 /*@ 2952 TSGetTotalSteps - Deprecated, use `TSGetStepNumber()`. 2953 2954 Level: deprecated 2955 2956 @*/ 2957 PetscErrorCode TSGetTotalSteps(TS ts, PetscInt *steps) 2958 { 2959 return TSGetStepNumber(ts, steps); 2960 } 2961 2962 /*@ 2963 TSSetSolution - Sets the initial solution vector 2964 for use by the `TS` routines. 2965 2966 Logically Collective 2967 2968 Input Parameters: 2969 + ts - the `TS` context obtained from `TSCreate()` 2970 - u - the solution vector 2971 2972 Level: beginner 2973 2974 .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSGetSolution()`, `TSCreate()` 2975 @*/ 2976 PetscErrorCode TSSetSolution(TS ts, Vec u) 2977 { 2978 DM dm; 2979 2980 PetscFunctionBegin; 2981 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 2982 PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 2983 PetscCall(PetscObjectReference((PetscObject)u)); 2984 PetscCall(VecDestroy(&ts->vec_sol)); 2985 ts->vec_sol = u; 2986 2987 PetscCall(TSGetDM(ts, &dm)); 2988 PetscCall(DMShellSetGlobalVector(dm, u)); 2989 PetscFunctionReturn(PETSC_SUCCESS); 2990 } 2991 2992 /*@C 2993 TSSetPreStep - Sets the general-purpose function 2994 called once at the beginning of each time step. 2995 2996 Logically Collective 2997 2998 Input Parameters: 2999 + ts - The `TS` context obtained from `TSCreate()` 3000 - func - The function 3001 3002 Calling sequence of `func`: 3003 . ts - the `TS` context 3004 3005 Level: intermediate 3006 3007 .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPostStage()`, `TSSetPostStep()`, `TSStep()`, `TSRestartStep()` 3008 @*/ 3009 PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS ts)) 3010 { 3011 PetscFunctionBegin; 3012 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3013 ts->prestep = func; 3014 PetscFunctionReturn(PETSC_SUCCESS); 3015 } 3016 3017 /*@ 3018 TSPreStep - Runs the user-defined pre-step function provided with `TSSetPreStep()` 3019 3020 Collective 3021 3022 Input Parameter: 3023 . ts - The `TS` context obtained from `TSCreate()` 3024 3025 Level: developer 3026 3027 Note: 3028 `TSPreStep()` is typically used within time stepping implementations, 3029 so most users would not generally call this routine themselves. 3030 3031 .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSPreStage()`, `TSPostStage()`, `TSPostStep()` 3032 @*/ 3033 PetscErrorCode TSPreStep(TS ts) 3034 { 3035 PetscFunctionBegin; 3036 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3037 if (ts->prestep) { 3038 Vec U; 3039 PetscObjectId idprev; 3040 PetscBool sameObject; 3041 PetscObjectState sprev, spost; 3042 3043 PetscCall(TSGetSolution(ts, &U)); 3044 PetscCall(PetscObjectGetId((PetscObject)U, &idprev)); 3045 PetscCall(PetscObjectStateGet((PetscObject)U, &sprev)); 3046 PetscCallBack("TS callback preset", (*ts->prestep)(ts)); 3047 PetscCall(TSGetSolution(ts, &U)); 3048 PetscCall(PetscObjectCompareId((PetscObject)U, idprev, &sameObject)); 3049 PetscCall(PetscObjectStateGet((PetscObject)U, &spost)); 3050 if (!sameObject || sprev != spost) PetscCall(TSRestartStep(ts)); 3051 } 3052 PetscFunctionReturn(PETSC_SUCCESS); 3053 } 3054 3055 /*@C 3056 TSSetPreStage - Sets the general-purpose function 3057 called once at the beginning of each stage. 3058 3059 Logically Collective 3060 3061 Input Parameters: 3062 + ts - The `TS` context obtained from `TSCreate()` 3063 - func - The function 3064 3065 Calling sequence of `func`: 3066 + ts - the `TS` context 3067 - stagetime - the stage time 3068 3069 Level: intermediate 3070 3071 Note: 3072 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3073 The time step number being computed can be queried using `TSGetStepNumber()` and the total size of the step being 3074 attempted can be obtained using `TSGetTimeStep()`. The time at the start of the step is available via `TSGetTime()`. 3075 3076 .seealso: [](ch_ts), `TS`, `TSSetPostStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()` 3077 @*/ 3078 PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS ts, PetscReal stagetime)) 3079 { 3080 PetscFunctionBegin; 3081 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3082 ts->prestage = func; 3083 PetscFunctionReturn(PETSC_SUCCESS); 3084 } 3085 3086 /*@C 3087 TSSetPostStage - Sets the general-purpose function, provided with `TSSetPostStep()`, 3088 called once at the end of each stage. 3089 3090 Logically Collective 3091 3092 Input Parameters: 3093 + ts - The `TS` context obtained from `TSCreate()` 3094 - func - The function 3095 3096 Calling sequence of `func`: 3097 + ts - the `TS` context 3098 . stagetime - the stage time 3099 . stageindex - the stage index 3100 - Y - Array of vectors (of size = total number of stages) with the stage solutions 3101 3102 Level: intermediate 3103 3104 Note: 3105 There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried. 3106 The time step number being computed can be queried using `TSGetStepNumber()` and the total size of the step being 3107 attempted can be obtained using `TSGetTimeStep()`. The time at the start of the step is available via `TSGetTime()`. 3108 3109 .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()` 3110 @*/ 3111 PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)) 3112 { 3113 PetscFunctionBegin; 3114 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3115 ts->poststage = func; 3116 PetscFunctionReturn(PETSC_SUCCESS); 3117 } 3118 3119 /*@C 3120 TSSetPostEvaluate - Sets the general-purpose function 3121 called once at the end of each step evaluation. 3122 3123 Logically Collective 3124 3125 Input Parameters: 3126 + ts - The `TS` context obtained from `TSCreate()` 3127 - func - The function 3128 3129 Calling sequence of `func`: 3130 . ts - the `TS` context 3131 3132 Level: intermediate 3133 3134 Note: 3135 Semantically, `TSSetPostEvaluate()` differs from `TSSetPostStep()` since the function it sets is called before event-handling 3136 thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, `TSPostStep()` 3137 may be passed a different solution, possibly changed by the event handler. `TSPostEvaluate()` is called after the next step 3138 solution is evaluated allowing to modify it, if need be. The solution can be obtained with `TSGetSolution()`, the time step 3139 with `TSGetTimeStep()`, and the time at the start of the step is available via `TSGetTime()` 3140 3141 .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()` 3142 @*/ 3143 PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS ts)) 3144 { 3145 PetscFunctionBegin; 3146 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3147 ts->postevaluate = func; 3148 PetscFunctionReturn(PETSC_SUCCESS); 3149 } 3150 3151 /*@ 3152 TSPreStage - Runs the user-defined pre-stage function set using `TSSetPreStage()` 3153 3154 Collective 3155 3156 Input Parameters: 3157 + ts - The `TS` context obtained from `TSCreate()` 3158 - stagetime - The absolute time of the current stage 3159 3160 Level: developer 3161 3162 Note: 3163 `TSPreStage()` is typically used within time stepping implementations, 3164 most users would not generally call this routine themselves. 3165 3166 .seealso: [](ch_ts), `TS`, `TSPostStage()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()` 3167 @*/ 3168 PetscErrorCode TSPreStage(TS ts, PetscReal stagetime) 3169 { 3170 PetscFunctionBegin; 3171 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3172 if (ts->prestage) PetscCallBack("TS callback prestage", (*ts->prestage)(ts, stagetime)); 3173 PetscFunctionReturn(PETSC_SUCCESS); 3174 } 3175 3176 /*@ 3177 TSPostStage - Runs the user-defined post-stage function set using `TSSetPostStage()` 3178 3179 Collective 3180 3181 Input Parameters: 3182 + ts - The `TS` context obtained from `TSCreate()` 3183 . stagetime - The absolute time of the current stage 3184 . stageindex - Stage number 3185 - Y - Array of vectors (of size = total number of stages) with the stage solutions 3186 3187 Level: developer 3188 3189 Note: 3190 `TSPostStage()` is typically used within time stepping implementations, 3191 most users would not generally call this routine themselves. 3192 3193 .seealso: [](ch_ts), `TS`, `TSPreStage()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()` 3194 @*/ 3195 PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y) 3196 { 3197 PetscFunctionBegin; 3198 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3199 if (ts->poststage) PetscCallBack("TS callback poststage", (*ts->poststage)(ts, stagetime, stageindex, Y)); 3200 PetscFunctionReturn(PETSC_SUCCESS); 3201 } 3202 3203 /*@ 3204 TSPostEvaluate - Runs the user-defined post-evaluate function set using `TSSetPostEvaluate()` 3205 3206 Collective 3207 3208 Input Parameter: 3209 . ts - The `TS` context obtained from `TSCreate()` 3210 3211 Level: developer 3212 3213 Note: 3214 `TSPostEvaluate()` is typically used within time stepping implementations, 3215 most users would not generally call this routine themselves. 3216 3217 .seealso: [](ch_ts), `TS`, `TSSetPostEvaluate()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()` 3218 @*/ 3219 PetscErrorCode TSPostEvaluate(TS ts) 3220 { 3221 PetscFunctionBegin; 3222 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3223 if (ts->postevaluate) { 3224 Vec U; 3225 PetscObjectState sprev, spost; 3226 3227 PetscCall(TSGetSolution(ts, &U)); 3228 PetscCall(PetscObjectStateGet((PetscObject)U, &sprev)); 3229 PetscCallBack("TS callback postevaluate", (*ts->postevaluate)(ts)); 3230 PetscCall(PetscObjectStateGet((PetscObject)U, &spost)); 3231 if (sprev != spost) PetscCall(TSRestartStep(ts)); 3232 } 3233 PetscFunctionReturn(PETSC_SUCCESS); 3234 } 3235 3236 /*@C 3237 TSSetPostStep - Sets the general-purpose function 3238 called once at the end of each time step. 3239 3240 Logically Collective 3241 3242 Input Parameters: 3243 + ts - The `TS` context obtained from `TSCreate()` 3244 - func - The function 3245 3246 Calling sequence of `func`: 3247 . ts - the `TS` context 3248 3249 Level: intermediate 3250 3251 Note: 3252 The function set by `TSSetPostStep()` is called after each successful step. The solution vector 3253 obtained by `TSGetSolution()` may be different than that computed at the step end if the event handler 3254 locates an event and `TSPostEvent()` modifies it. Use `TSSetPostEvaluate()` if an unmodified solution is needed instead. 3255 3256 .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostEvaluate()`, `TSGetTimeStep()`, `TSGetStepNumber()`, `TSGetTime()`, `TSRestartStep()` 3257 @*/ 3258 PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS ts)) 3259 { 3260 PetscFunctionBegin; 3261 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3262 ts->poststep = func; 3263 PetscFunctionReturn(PETSC_SUCCESS); 3264 } 3265 3266 /*@ 3267 TSPostStep - Runs the user-defined post-step function that was set with `TSSetPostStep()` 3268 3269 Collective 3270 3271 Input Parameter: 3272 . ts - The `TS` context obtained from `TSCreate()` 3273 3274 Note: 3275 `TSPostStep()` is typically used within time stepping implementations, 3276 so most users would not generally call this routine themselves. 3277 3278 Level: developer 3279 3280 .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostEvaluate()`, `TSGetTimeStep()`, `TSGetStepNumber()`, `TSGetTime()`, `TSSetPotsStep()` 3281 @*/ 3282 PetscErrorCode TSPostStep(TS ts) 3283 { 3284 PetscFunctionBegin; 3285 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3286 if (ts->poststep) { 3287 Vec U; 3288 PetscObjectId idprev; 3289 PetscBool sameObject; 3290 PetscObjectState sprev, spost; 3291 3292 PetscCall(TSGetSolution(ts, &U)); 3293 PetscCall(PetscObjectGetId((PetscObject)U, &idprev)); 3294 PetscCall(PetscObjectStateGet((PetscObject)U, &sprev)); 3295 PetscCallBack("TS callback poststep", (*ts->poststep)(ts)); 3296 PetscCall(TSGetSolution(ts, &U)); 3297 PetscCall(PetscObjectCompareId((PetscObject)U, idprev, &sameObject)); 3298 PetscCall(PetscObjectStateGet((PetscObject)U, &spost)); 3299 if (!sameObject || sprev != spost) PetscCall(TSRestartStep(ts)); 3300 } 3301 PetscFunctionReturn(PETSC_SUCCESS); 3302 } 3303 3304 /*@ 3305 TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval 3306 3307 Collective 3308 3309 Input Parameters: 3310 + ts - time stepping context 3311 - t - time to interpolate to 3312 3313 Output Parameter: 3314 . U - state at given time 3315 3316 Level: intermediate 3317 3318 Developer Notes: 3319 `TSInterpolate()` and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints. 3320 3321 .seealso: [](ch_ts), `TS`, `TSSetExactFinalTime()`, `TSSolve()` 3322 @*/ 3323 PetscErrorCode TSInterpolate(TS ts, PetscReal t, Vec U) 3324 { 3325 PetscFunctionBegin; 3326 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3327 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 3328 PetscCheck(t >= ts->ptime_prev && t <= ts->ptime, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Requested time %g not in last time steps [%g,%g]", (double)t, (double)ts->ptime_prev, (double)ts->ptime); 3329 PetscUseTypeMethod(ts, interpolate, t, U); 3330 PetscFunctionReturn(PETSC_SUCCESS); 3331 } 3332 3333 /*@ 3334 TSStep - Steps one time step 3335 3336 Collective 3337 3338 Input Parameter: 3339 . ts - the `TS` context obtained from `TSCreate()` 3340 3341 Level: developer 3342 3343 Notes: 3344 The public interface for the ODE/DAE solvers is `TSSolve()`, you should almost for sure be using that routine and not this routine. 3345 3346 The hook set using `TSSetPreStep()` is called before each attempt to take the step. In general, the time step size may 3347 be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages. 3348 3349 This may over-step the final time provided in `TSSetMaxTime()` depending on the time-step used. `TSSolve()` interpolates to exactly the 3350 time provided in `TSSetMaxTime()`. One can use `TSInterpolate()` to determine an interpolated solution within the final timestep. 3351 3352 .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetUp()`, `TSDestroy()`, `TSSolve()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostStage()`, `TSInterpolate()` 3353 @*/ 3354 PetscErrorCode TSStep(TS ts) 3355 { 3356 static PetscBool cite = PETSC_FALSE; 3357 PetscReal ptime; 3358 3359 PetscFunctionBegin; 3360 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3361 PetscCall(PetscCitationsRegister("@article{tspaper,\n" 3362 " title = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n" 3363 " author = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n" 3364 " journal = {arXiv e-preprints},\n" 3365 " eprint = {1806.01437},\n" 3366 " archivePrefix = {arXiv},\n" 3367 " year = {2018}\n}\n", 3368 &cite)); 3369 PetscCall(TSSetUp(ts)); 3370 PetscCall(TSTrajectorySetUp(ts->trajectory, ts)); 3371 if (ts->tspan) 3372 ts->tspan->worktol = 0; /* In each step of TSSolve() 'tspan->worktol' will be meaningfully defined (later) only once: 3373 in TSAdaptChoose() or TSEvent_dt_cap(), and then reused till the end of the step */ 3374 3375 PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3376 PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()"); 3377 PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3378 3379 if (!ts->steps) ts->ptime_prev = ts->ptime; 3380 ptime = ts->ptime; 3381 ts->ptime_prev_rollback = ts->ptime_prev; 3382 ts->reason = TS_CONVERGED_ITERATING; 3383 3384 PetscCall(PetscLogEventBegin(TS_Step, ts, 0, 0, 0)); 3385 PetscUseTypeMethod(ts, step); 3386 PetscCall(PetscLogEventEnd(TS_Step, ts, 0, 0, 0)); 3387 3388 if (ts->reason >= 0) { 3389 ts->ptime_prev = ptime; 3390 ts->steps++; 3391 ts->steprollback = PETSC_FALSE; 3392 ts->steprestart = PETSC_FALSE; 3393 } 3394 if (!ts->reason) { 3395 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 3396 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 3397 } 3398 3399 if (ts->reason < 0 && ts->errorifstepfailed) { 3400 PetscCall(TSMonitorCancel(ts)); 3401 PetscCheck(ts->reason != TS_DIVERGED_NONLINEAR_SOLVE, 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]); 3402 SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_NOT_CONVERGED, "TSStep has failed due to %s", TSConvergedReasons[ts->reason]); 3403 } 3404 PetscFunctionReturn(PETSC_SUCCESS); 3405 } 3406 3407 /*@ 3408 TSEvaluateWLTE - Evaluate the weighted local truncation error norm 3409 at the end of a time step with a given order of accuracy. 3410 3411 Collective 3412 3413 Input Parameters: 3414 + ts - time stepping context 3415 - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY` 3416 3417 Input/Output Parameter: 3418 . order - optional, desired order for the error evaluation or `PETSC_DECIDE`; 3419 on output, the actual order of the error evaluation 3420 3421 Output Parameter: 3422 . wlte - the weighted local truncation error norm 3423 3424 Level: advanced 3425 3426 Note: 3427 If the timestepper cannot evaluate the error in a particular step 3428 (eg. in the first step or restart steps after event handling), 3429 this routine returns wlte=-1.0 . 3430 3431 .seealso: [](ch_ts), `TS`, `TSStep()`, `TSAdapt`, `TSErrorWeightedNorm()` 3432 @*/ 3433 PetscErrorCode TSEvaluateWLTE(TS ts, NormType wnormtype, PetscInt *order, PetscReal *wlte) 3434 { 3435 PetscFunctionBegin; 3436 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3437 PetscValidType(ts, 1); 3438 PetscValidLogicalCollectiveEnum(ts, wnormtype, 2); 3439 if (order) PetscAssertPointer(order, 3); 3440 if (order) PetscValidLogicalCollectiveInt(ts, *order, 3); 3441 PetscAssertPointer(wlte, 4); 3442 PetscCheck(wnormtype == NORM_2 || wnormtype == NORM_INFINITY, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No support for norm type %s", NormTypes[wnormtype]); 3443 PetscUseTypeMethod(ts, evaluatewlte, wnormtype, order, wlte); 3444 PetscFunctionReturn(PETSC_SUCCESS); 3445 } 3446 3447 /*@ 3448 TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy. 3449 3450 Collective 3451 3452 Input Parameters: 3453 + ts - time stepping context 3454 . order - desired order of accuracy 3455 - done - whether the step was evaluated at this order (pass `NULL` to generate an error if not available) 3456 3457 Output Parameter: 3458 . U - state at the end of the current step 3459 3460 Level: advanced 3461 3462 Notes: 3463 This function cannot be called until all stages have been evaluated. 3464 3465 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. 3466 3467 .seealso: [](ch_ts), `TS`, `TSStep()`, `TSAdapt` 3468 @*/ 3469 PetscErrorCode TSEvaluateStep(TS ts, PetscInt order, Vec U, PetscBool *done) 3470 { 3471 PetscFunctionBegin; 3472 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3473 PetscValidType(ts, 1); 3474 PetscValidHeaderSpecific(U, VEC_CLASSID, 3); 3475 PetscUseTypeMethod(ts, evaluatestep, order, U, done); 3476 PetscFunctionReturn(PETSC_SUCCESS); 3477 } 3478 3479 /*@C 3480 TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping. 3481 3482 Not collective 3483 3484 Input Parameter: 3485 . ts - time stepping context 3486 3487 Output Parameter: 3488 . initCondition - The function which computes an initial condition 3489 3490 Calling sequence of `initCondition`: 3491 + ts - The timestepping context 3492 - u - The input vector in which the initial condition is stored 3493 3494 Level: advanced 3495 3496 .seealso: [](ch_ts), `TS`, `TSSetComputeInitialCondition()`, `TSComputeInitialCondition()` 3497 @*/ 3498 PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS ts, Vec u)) 3499 { 3500 PetscFunctionBegin; 3501 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3502 PetscAssertPointer(initCondition, 2); 3503 *initCondition = ts->ops->initcondition; 3504 PetscFunctionReturn(PETSC_SUCCESS); 3505 } 3506 3507 /*@C 3508 TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping. 3509 3510 Logically collective 3511 3512 Input Parameters: 3513 + ts - time stepping context 3514 - initCondition - The function which computes an initial condition 3515 3516 Calling sequence of `initCondition`: 3517 + ts - The timestepping context 3518 - e - The input vector in which the initial condition is to be stored 3519 3520 Level: advanced 3521 3522 .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSComputeInitialCondition()` 3523 @*/ 3524 PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS ts, Vec e)) 3525 { 3526 PetscFunctionBegin; 3527 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3528 PetscValidFunction(initCondition, 2); 3529 ts->ops->initcondition = initCondition; 3530 PetscFunctionReturn(PETSC_SUCCESS); 3531 } 3532 3533 /*@ 3534 TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set with `TSSetComputeInitialCondition()` 3535 3536 Collective 3537 3538 Input Parameters: 3539 + ts - time stepping context 3540 - u - The `Vec` to store the condition in which will be used in `TSSolve()` 3541 3542 Level: advanced 3543 3544 .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSSetComputeInitialCondition()`, `TSSolve()` 3545 @*/ 3546 PetscErrorCode TSComputeInitialCondition(TS ts, Vec u) 3547 { 3548 PetscFunctionBegin; 3549 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3550 PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 3551 PetscTryTypeMethod(ts, initcondition, u); 3552 PetscFunctionReturn(PETSC_SUCCESS); 3553 } 3554 3555 /*@C 3556 TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping. 3557 3558 Not collective 3559 3560 Input Parameter: 3561 . ts - time stepping context 3562 3563 Output Parameter: 3564 . exactError - The function which computes the solution error 3565 3566 Calling sequence of `exactError`: 3567 + ts - The timestepping context 3568 . u - The approximate solution vector 3569 - e - The vector in which the error is stored 3570 3571 Level: advanced 3572 3573 .seealso: [](ch_ts), `TS`, `TSComputeExactError()` 3574 @*/ 3575 PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS ts, Vec u, Vec e)) 3576 { 3577 PetscFunctionBegin; 3578 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3579 PetscAssertPointer(exactError, 2); 3580 *exactError = ts->ops->exacterror; 3581 PetscFunctionReturn(PETSC_SUCCESS); 3582 } 3583 3584 /*@C 3585 TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping. 3586 3587 Logically collective 3588 3589 Input Parameters: 3590 + ts - time stepping context 3591 - exactError - The function which computes the solution error 3592 3593 Calling sequence of `exactError`: 3594 + ts - The timestepping context 3595 . u - The approximate solution vector 3596 - e - The vector in which the error is stored 3597 3598 Level: advanced 3599 3600 .seealso: [](ch_ts), `TS`, `TSGetComputeExactError()`, `TSComputeExactError()` 3601 @*/ 3602 PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS ts, Vec u, Vec e)) 3603 { 3604 PetscFunctionBegin; 3605 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3606 PetscValidFunction(exactError, 2); 3607 ts->ops->exacterror = exactError; 3608 PetscFunctionReturn(PETSC_SUCCESS); 3609 } 3610 3611 /*@ 3612 TSComputeExactError - Compute the solution error for the timestepping using the function previously set with `TSSetComputeExactError()` 3613 3614 Collective 3615 3616 Input Parameters: 3617 + ts - time stepping context 3618 . u - The approximate solution 3619 - e - The `Vec` used to store the error 3620 3621 Level: advanced 3622 3623 .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSSetComputeInitialCondition()`, `TSSolve()` 3624 @*/ 3625 PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e) 3626 { 3627 PetscFunctionBegin; 3628 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3629 PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 3630 PetscValidHeaderSpecific(e, VEC_CLASSID, 3); 3631 PetscTryTypeMethod(ts, exacterror, u, e); 3632 PetscFunctionReturn(PETSC_SUCCESS); 3633 } 3634 3635 /*@C 3636 TSSetResize - Sets the resize callbacks. 3637 3638 Logically Collective 3639 3640 Input Parameters: 3641 + ts - The `TS` context obtained from `TSCreate()` 3642 . setup - The setup function 3643 . transfer - The transfer function 3644 - ctx - [optional] The user-defined context 3645 3646 Calling sequence of `setup`: 3647 + ts - the `TS` context 3648 . step - the current step 3649 . time - the current time 3650 . state - the current vector of state 3651 . resize - (output parameter) `PETSC_TRUE` if need resizing, `PETSC_FALSE` otherwise 3652 - ctx - user defined context 3653 3654 Calling sequence of `transfer`: 3655 + ts - the `TS` context 3656 . nv - the number of vectors to be transferred 3657 . vecsin - array of vectors to be transferred 3658 . vecsout - array of transferred vectors 3659 - ctx - user defined context 3660 3661 Notes: 3662 The `setup` function is called inside `TSSolve()` after `TSPostStep()` at the end of each time step 3663 to determine if the problem size has changed. 3664 If it is the case, the solver will collect the needed vectors that need to be 3665 transferred from the old to the new sizes using `transfer`. These vectors will include the current 3666 solution vector, and other vectors needed by the specific solver used. 3667 For example, `TSBDF` uses previous solutions vectors to solve for the next time step. 3668 Other application specific objects associated with the solver, i.e. Jacobian matrices and `DM`, 3669 will be automatically reset if the sizes are changed and they must be specified again by the user 3670 inside the `transfer` function. 3671 The input and output arrays passed to `transfer` are allocated by PETSc. 3672 Vectors in `vecsout` must be created by the user. 3673 Ownership of vectors in `vecsout` is transferred to PETSc. 3674 3675 Level: advanced 3676 3677 .seealso: [](ch_ts), `TS`, `TSSetDM()`, `TSSetIJacobian()`, `TSSetRHSJacobian()` 3678 @*/ 3679 PetscErrorCode TSSetResize(TS ts, PetscErrorCode (*setup)(TS ts, PetscInt step, PetscReal time, Vec state, PetscBool *resize, void *ctx), PetscErrorCode (*transfer)(TS ts, PetscInt nv, Vec vecsin[], Vec vecsout[], void *ctx), void *ctx) 3680 { 3681 PetscFunctionBegin; 3682 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3683 ts->resizesetup = setup; 3684 ts->resizetransfer = transfer; 3685 ts->resizectx = ctx; 3686 PetscFunctionReturn(PETSC_SUCCESS); 3687 } 3688 3689 /* 3690 TSResizeRegisterOrRetrieve - Register or import vectors transferred with `TSResize()`. 3691 3692 Collective 3693 3694 Input Parameters: 3695 + ts - The `TS` context obtained from `TSCreate()` 3696 - flg - If `PETSC_TRUE` each TS implementation (e.g. `TSBDF`) will register vectors to be transferred, if `PETSC_FALSE` vectors will be imported from transferred vectors. 3697 3698 Level: developer 3699 3700 Note: 3701 `TSResizeRegisterOrRetrieve()` is declared PETSC_INTERN since it is 3702 used within time stepping implementations, 3703 so most users would not generally call this routine themselves. 3704 3705 .seealso: [](ch_ts), `TS`, `TSSetResize()` 3706 @*/ 3707 static PetscErrorCode TSResizeRegisterOrRetrieve(TS ts, PetscBool flg) 3708 { 3709 PetscFunctionBegin; 3710 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3711 PetscTryTypeMethod(ts, resizeregister, flg); 3712 /* PetscTryTypeMethod(adapt, resizeregister, flg); */ 3713 PetscFunctionReturn(PETSC_SUCCESS); 3714 } 3715 3716 static PetscErrorCode TSResizeReset(TS ts) 3717 { 3718 PetscFunctionBegin; 3719 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3720 PetscCall(PetscObjectListDestroy(&ts->resizetransferobjs)); 3721 PetscFunctionReturn(PETSC_SUCCESS); 3722 } 3723 3724 static PetscErrorCode TSResizeTransferVecs(TS ts, PetscInt cnt, Vec vecsin[], Vec vecsout[]) 3725 { 3726 PetscFunctionBegin; 3727 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3728 PetscValidLogicalCollectiveInt(ts, cnt, 2); 3729 for (PetscInt i = 0; i < cnt; i++) PetscCall(VecLockReadPush(vecsin[i])); 3730 if (ts->resizetransfer) { 3731 PetscCall(PetscInfo(ts, "Transferring %" PetscInt_FMT " vectors\n", cnt)); 3732 PetscCallBack("TS callback resize transfer", (*ts->resizetransfer)(ts, cnt, vecsin, vecsout, ts->resizectx)); 3733 } 3734 for (PetscInt i = 0; i < cnt; i++) PetscCall(VecLockReadPop(vecsin[i])); 3735 PetscFunctionReturn(PETSC_SUCCESS); 3736 } 3737 3738 /*@C 3739 TSResizeRegisterVec - Register a vector to be transferred with `TSResize()`. 3740 3741 Collective 3742 3743 Input Parameters: 3744 + ts - The `TS` context obtained from `TSCreate()` 3745 . name - A string identifying the vector 3746 - vec - The vector 3747 3748 Level: developer 3749 3750 Note: 3751 `TSResizeRegisterVec()` is typically used within time stepping implementations, 3752 so most users would not generally call this routine themselves. 3753 3754 .seealso: [](ch_ts), `TS`, `TSSetResize()`, `TSResize()`, `TSResizeRetrieveVec()` 3755 @*/ 3756 PetscErrorCode TSResizeRegisterVec(TS ts, const char *name, Vec vec) 3757 { 3758 PetscFunctionBegin; 3759 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3760 PetscAssertPointer(name, 2); 3761 if (vec) PetscValidHeaderSpecific(vec, VEC_CLASSID, 3); 3762 PetscCall(PetscObjectListAdd(&ts->resizetransferobjs, name, (PetscObject)vec)); 3763 PetscFunctionReturn(PETSC_SUCCESS); 3764 } 3765 3766 /*@C 3767 TSResizeRetrieveVec - Retrieve a vector registered with `TSResizeRegisterVec()`. 3768 3769 Collective 3770 3771 Input Parameters: 3772 + ts - The `TS` context obtained from `TSCreate()` 3773 . name - A string identifying the vector 3774 - vec - The vector 3775 3776 Level: developer 3777 3778 Note: 3779 `TSResizeRetrieveVec()` is typically used within time stepping implementations, 3780 so most users would not generally call this routine themselves. 3781 3782 .seealso: [](ch_ts), `TS`, `TSSetResize()`, `TSResize()`, `TSResizeRegisterVec()` 3783 @*/ 3784 PetscErrorCode TSResizeRetrieveVec(TS ts, const char *name, Vec *vec) 3785 { 3786 PetscFunctionBegin; 3787 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3788 PetscAssertPointer(name, 2); 3789 PetscAssertPointer(vec, 3); 3790 PetscCall(PetscObjectListFind(ts->resizetransferobjs, name, (PetscObject *)vec)); 3791 PetscFunctionReturn(PETSC_SUCCESS); 3792 } 3793 3794 static PetscErrorCode TSResizeGetVecArray(TS ts, PetscInt *nv, const char **names[], Vec *vecs[]) 3795 { 3796 PetscInt cnt; 3797 PetscObjectList tmp; 3798 Vec *vecsin = NULL; 3799 const char **namesin = NULL; 3800 3801 PetscFunctionBegin; 3802 for (tmp = ts->resizetransferobjs, cnt = 0; tmp; tmp = tmp->next) 3803 if (tmp->obj && tmp->obj->classid == VEC_CLASSID) cnt++; 3804 if (names) PetscCall(PetscMalloc1(cnt, &namesin)); 3805 if (vecs) PetscCall(PetscMalloc1(cnt, &vecsin)); 3806 for (tmp = ts->resizetransferobjs, cnt = 0; tmp; tmp = tmp->next) { 3807 if (tmp->obj && tmp->obj->classid == VEC_CLASSID) { 3808 if (vecs) vecsin[cnt] = (Vec)tmp->obj; 3809 if (names) namesin[cnt] = tmp->name; 3810 cnt++; 3811 } 3812 } 3813 if (nv) *nv = cnt; 3814 if (names) *names = namesin; 3815 if (vecs) *vecs = vecsin; 3816 PetscFunctionReturn(PETSC_SUCCESS); 3817 } 3818 3819 /*@ 3820 TSResize - Runs the user-defined transfer functions provided with `TSSetResize()` 3821 3822 Collective 3823 3824 Input Parameter: 3825 . ts - The `TS` context obtained from `TSCreate()` 3826 3827 Level: developer 3828 3829 Note: 3830 `TSResize()` is typically used within time stepping implementations, 3831 so most users would not generally call this routine themselves. 3832 3833 .seealso: [](ch_ts), `TS`, `TSSetResize()` 3834 @*/ 3835 PetscErrorCode TSResize(TS ts) 3836 { 3837 PetscInt nv = 0; 3838 const char **names = NULL; 3839 Vec *vecsin = NULL; 3840 const char *solname = "ts:vec_sol"; 3841 3842 PetscFunctionBegin; 3843 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3844 if (ts->resizesetup) { 3845 PetscBool flg = PETSC_FALSE; 3846 3847 PetscCall(VecLockReadPush(ts->vec_sol)); 3848 PetscCallBack("TS callback resize setup", (*ts->resizesetup)(ts, ts->steps, ts->ptime, ts->vec_sol, &flg, ts->resizectx)); 3849 PetscCall(VecLockReadPop(ts->vec_sol)); 3850 if (flg) { 3851 PetscCall(TSResizeRegisterVec(ts, solname, ts->vec_sol)); 3852 PetscCall(TSResizeRegisterOrRetrieve(ts, PETSC_TRUE)); /* specific impls register their own objects */ 3853 } 3854 } 3855 3856 PetscCall(TSResizeGetVecArray(ts, &nv, &names, &vecsin)); 3857 if (nv) { 3858 Vec *vecsout, vecsol; 3859 3860 /* Reset internal objects */ 3861 PetscCall(TSReset(ts)); 3862 3863 /* Transfer needed vectors (users can call SetJacobian, SetDM here) */ 3864 PetscCall(PetscCalloc1(nv, &vecsout)); 3865 PetscCall(TSResizeTransferVecs(ts, nv, vecsin, vecsout)); 3866 for (PetscInt i = 0; i < nv; i++) { 3867 PetscCall(TSResizeRegisterVec(ts, names[i], vecsout[i])); 3868 PetscCall(VecDestroy(&vecsout[i])); 3869 } 3870 PetscCall(PetscFree(vecsout)); 3871 PetscCall(TSResizeRegisterOrRetrieve(ts, PETSC_FALSE)); /* specific impls import the transferred objects */ 3872 3873 PetscCall(TSResizeRetrieveVec(ts, solname, &vecsol)); 3874 if (vecsol) PetscCall(TSSetSolution(ts, vecsol)); 3875 PetscAssert(ts->vec_sol, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_NULL, "Missing TS solution"); 3876 } 3877 3878 PetscCall(PetscFree(names)); 3879 PetscCall(PetscFree(vecsin)); 3880 PetscCall(TSResizeReset(ts)); 3881 PetscFunctionReturn(PETSC_SUCCESS); 3882 } 3883 3884 /*@ 3885 TSSolve - Steps the requested number of timesteps. 3886 3887 Collective 3888 3889 Input Parameters: 3890 + ts - the `TS` context obtained from `TSCreate()` 3891 - u - the solution vector (can be null if `TSSetSolution()` was used and `TSSetExactFinalTime`(ts,`TS_EXACTFINALTIME_MATCHSTEP`) was not used, 3892 otherwise must contain the initial conditions and will contain the solution at the final requested time 3893 3894 Level: beginner 3895 3896 Notes: 3897 The final time returned by this function may be different from the time of the internally 3898 held state accessible by `TSGetSolution()` and `TSGetTime()` because the method may have 3899 stepped over the final time. 3900 3901 .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetSolution()`, `TSStep()`, `TSGetTime()`, `TSGetSolveTime()` 3902 @*/ 3903 PetscErrorCode TSSolve(TS ts, Vec u) 3904 { 3905 Vec solution; 3906 3907 PetscFunctionBegin; 3908 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 3909 if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 2); 3910 3911 PetscCall(TSSetExactFinalTimeDefault(ts)); 3912 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 */ 3913 if (!ts->vec_sol || u == ts->vec_sol) { 3914 PetscCall(VecDuplicate(u, &solution)); 3915 PetscCall(TSSetSolution(ts, solution)); 3916 PetscCall(VecDestroy(&solution)); /* grant ownership */ 3917 } 3918 PetscCall(VecCopy(u, ts->vec_sol)); 3919 PetscCheck(!ts->forward_solve, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE"); 3920 } else if (u) PetscCall(TSSetSolution(ts, u)); 3921 PetscCall(TSSetUp(ts)); 3922 PetscCall(TSTrajectorySetUp(ts->trajectory, ts)); 3923 3924 PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>"); 3925 PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()"); 3926 PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE"); 3927 PetscCheck(!(ts->tspan && ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP), PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "You must use TS_EXACTFINALTIME_MATCHSTEP when using time span"); 3928 3929 if (ts->tspan && PetscIsCloseAtTol(ts->ptime, ts->tspan->span_times[0], ts->tspan->reltol * ts->time_step + ts->tspan->abstol, 0)) { /* starting point in time span */ 3930 PetscCall(VecCopy(ts->vec_sol, ts->tspan->vecs_sol[0])); 3931 ts->tspan->spanctr = 1; 3932 } 3933 3934 if (ts->forward_solve) PetscCall(TSForwardSetUp(ts)); 3935 3936 /* reset number of steps only when the step is not restarted. ARKIMEX 3937 restarts the step after an event. Resetting these counters in such case causes 3938 TSTrajectory to incorrectly save the output files 3939 */ 3940 /* reset time step and iteration counters */ 3941 if (!ts->steps) { 3942 ts->ksp_its = 0; 3943 ts->snes_its = 0; 3944 ts->num_snes_failures = 0; 3945 ts->reject = 0; 3946 ts->steprestart = PETSC_TRUE; 3947 ts->steprollback = PETSC_FALSE; 3948 ts->rhsjacobian.time = PETSC_MIN_REAL; 3949 } 3950 3951 /* make sure initial time step does not overshoot final time or the next point in tspan */ 3952 if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) { 3953 PetscReal maxdt; 3954 PetscReal dt = ts->time_step; 3955 3956 if (ts->tspan) maxdt = ts->tspan->span_times[ts->tspan->spanctr] - ts->ptime; 3957 else maxdt = ts->max_time - ts->ptime; 3958 ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt, maxdt, 10 * PETSC_MACHINE_EPSILON, 0) ? maxdt : dt); 3959 } 3960 ts->reason = TS_CONVERGED_ITERATING; 3961 3962 { 3963 PetscViewer viewer; 3964 PetscViewerFormat format; 3965 PetscBool flg; 3966 static PetscBool incall = PETSC_FALSE; 3967 3968 if (!incall) { 3969 /* Estimate the convergence rate of the time discretization */ 3970 PetscCall(PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts), ((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg)); 3971 if (flg) { 3972 PetscConvEst conv; 3973 DM dm; 3974 PetscReal *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */ 3975 PetscInt Nf; 3976 PetscBool checkTemporal = PETSC_TRUE; 3977 3978 incall = PETSC_TRUE; 3979 PetscCall(PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg)); 3980 PetscCall(TSGetDM(ts, &dm)); 3981 PetscCall(DMGetNumFields(dm, &Nf)); 3982 PetscCall(PetscCalloc1(PetscMax(Nf, 1), &alpha)); 3983 PetscCall(PetscConvEstCreate(PetscObjectComm((PetscObject)ts), &conv)); 3984 PetscCall(PetscConvEstUseTS(conv, checkTemporal)); 3985 PetscCall(PetscConvEstSetSolver(conv, (PetscObject)ts)); 3986 PetscCall(PetscConvEstSetFromOptions(conv)); 3987 PetscCall(PetscConvEstSetUp(conv)); 3988 PetscCall(PetscConvEstGetConvRate(conv, alpha)); 3989 PetscCall(PetscViewerPushFormat(viewer, format)); 3990 PetscCall(PetscConvEstRateView(conv, alpha, viewer)); 3991 PetscCall(PetscViewerPopFormat(viewer)); 3992 PetscCall(PetscOptionsRestoreViewer(&viewer)); 3993 PetscCall(PetscConvEstDestroy(&conv)); 3994 PetscCall(PetscFree(alpha)); 3995 incall = PETSC_FALSE; 3996 } 3997 } 3998 } 3999 4000 PetscCall(TSViewFromOptions(ts, NULL, "-ts_view_pre")); 4001 4002 if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */ 4003 PetscUseTypeMethod(ts, solve); 4004 if (u) PetscCall(VecCopy(ts->vec_sol, u)); 4005 ts->solvetime = ts->ptime; 4006 solution = ts->vec_sol; 4007 } else { /* Step the requested number of timesteps. */ 4008 if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS; 4009 else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME; 4010 4011 if (!ts->steps) { 4012 PetscCall(TSTrajectorySet(ts->trajectory, ts, ts->steps, ts->ptime, ts->vec_sol)); 4013 PetscCall(TSEventInitialize(ts->event, ts, ts->ptime, ts->vec_sol)); 4014 } 4015 4016 while (!ts->reason) { 4017 PetscCall(TSMonitor(ts, ts->steps, ts->ptime, ts->vec_sol)); 4018 if (!ts->steprollback) PetscCall(TSPreStep(ts)); 4019 PetscCall(TSStep(ts)); 4020 if (ts->testjacobian) PetscCall(TSRHSJacobianTest(ts, NULL)); 4021 if (ts->testjacobiantranspose) PetscCall(TSRHSJacobianTestTranspose(ts, NULL)); 4022 if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */ 4023 if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 4024 PetscCall(TSForwardCostIntegral(ts)); 4025 if (ts->reason >= 0) ts->steps++; 4026 } 4027 if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */ 4028 if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */ 4029 PetscCall(TSForwardStep(ts)); 4030 if (ts->reason >= 0) ts->steps++; 4031 } 4032 PetscCall(TSPostEvaluate(ts)); 4033 PetscCall(TSEventHandler(ts)); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */ 4034 if (ts->steprollback) PetscCall(TSPostEvaluate(ts)); 4035 if (!ts->steprollback) { 4036 PetscCall(TSTrajectorySet(ts->trajectory, ts, ts->steps, ts->ptime, ts->vec_sol)); 4037 PetscCall(TSPostStep(ts)); 4038 PetscCall(TSResize(ts)); 4039 4040 if (ts->tspan && ts->tspan->spanctr < ts->tspan->num_span_times) { 4041 PetscCheck(ts->tspan->worktol > 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_PLIB, "Unexpected state !(tspan->worktol > 0) in TSSolve()"); 4042 if (PetscIsCloseAtTol(ts->ptime, ts->tspan->span_times[ts->tspan->spanctr], ts->tspan->worktol, 0)) PetscCall(VecCopy(ts->vec_sol, ts->tspan->vecs_sol[ts->tspan->spanctr++])); 4043 } 4044 } 4045 } 4046 PetscCall(TSMonitor(ts, ts->steps, ts->ptime, ts->vec_sol)); 4047 4048 if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) { 4049 if (!u) u = ts->vec_sol; 4050 PetscCall(TSInterpolate(ts, ts->max_time, u)); 4051 ts->solvetime = ts->max_time; 4052 solution = u; 4053 PetscCall(TSMonitor(ts, -1, ts->solvetime, solution)); 4054 } else { 4055 if (u) PetscCall(VecCopy(ts->vec_sol, u)); 4056 ts->solvetime = ts->ptime; 4057 solution = ts->vec_sol; 4058 } 4059 } 4060 4061 PetscCall(TSViewFromOptions(ts, NULL, "-ts_view")); 4062 PetscCall(VecViewFromOptions(solution, (PetscObject)ts, "-ts_view_solution")); 4063 PetscCall(PetscObjectSAWsBlock((PetscObject)ts)); 4064 if (ts->adjoint_solve) PetscCall(TSAdjointSolve(ts)); 4065 PetscFunctionReturn(PETSC_SUCCESS); 4066 } 4067 4068 /*@ 4069 TSGetTime - Gets the time of the most recently completed step. 4070 4071 Not Collective 4072 4073 Input Parameter: 4074 . ts - the `TS` context obtained from `TSCreate()` 4075 4076 Output Parameter: 4077 . t - the current time. This time may not corresponds to the final time set with `TSSetMaxTime()`, use `TSGetSolveTime()`. 4078 4079 Level: beginner 4080 4081 Note: 4082 When called during time step evaluation (e.g. during residual evaluation or via hooks set using `TSSetPreStep()`, 4083 `TSSetPreStage()`, `TSSetPostStage()`, or `TSSetPostStep()`), the time is the time at the start of the step being evaluated. 4084 4085 .seealso: [](ch_ts), `TS`, ``TSGetSolveTime()`, `TSSetTime()`, `TSGetTimeStep()`, `TSGetStepNumber()` 4086 @*/ 4087 PetscErrorCode TSGetTime(TS ts, PetscReal *t) 4088 { 4089 PetscFunctionBegin; 4090 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4091 PetscAssertPointer(t, 2); 4092 *t = ts->ptime; 4093 PetscFunctionReturn(PETSC_SUCCESS); 4094 } 4095 4096 /*@ 4097 TSGetPrevTime - Gets the starting time of the previously completed step. 4098 4099 Not Collective 4100 4101 Input Parameter: 4102 . ts - the `TS` context obtained from `TSCreate()` 4103 4104 Output Parameter: 4105 . t - the previous time 4106 4107 Level: beginner 4108 4109 .seealso: [](ch_ts), `TS`, ``TSGetTime()`, `TSGetSolveTime()`, `TSGetTimeStep()` 4110 @*/ 4111 PetscErrorCode TSGetPrevTime(TS ts, PetscReal *t) 4112 { 4113 PetscFunctionBegin; 4114 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4115 PetscAssertPointer(t, 2); 4116 *t = ts->ptime_prev; 4117 PetscFunctionReturn(PETSC_SUCCESS); 4118 } 4119 4120 /*@ 4121 TSSetTime - Allows one to reset the time. 4122 4123 Logically Collective 4124 4125 Input Parameters: 4126 + ts - the `TS` context obtained from `TSCreate()` 4127 - t - the time 4128 4129 Level: intermediate 4130 4131 .seealso: [](ch_ts), `TS`, `TSGetTime()`, `TSSetMaxSteps()` 4132 @*/ 4133 PetscErrorCode TSSetTime(TS ts, PetscReal t) 4134 { 4135 PetscFunctionBegin; 4136 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4137 PetscValidLogicalCollectiveReal(ts, t, 2); 4138 ts->ptime = t; 4139 PetscFunctionReturn(PETSC_SUCCESS); 4140 } 4141 4142 /*@C 4143 TSSetOptionsPrefix - Sets the prefix used for searching for all 4144 TS options in the database. 4145 4146 Logically Collective 4147 4148 Input Parameters: 4149 + ts - The `TS` context 4150 - prefix - The prefix to prepend to all option names 4151 4152 Level: advanced 4153 4154 Note: 4155 A hyphen (-) must NOT be given at the beginning of the prefix name. 4156 The first character of all runtime options is AUTOMATICALLY the 4157 hyphen. 4158 4159 .seealso: [](ch_ts), `TS`, `TSSetFromOptions()`, `TSAppendOptionsPrefix()` 4160 @*/ 4161 PetscErrorCode TSSetOptionsPrefix(TS ts, const char prefix[]) 4162 { 4163 SNES snes; 4164 4165 PetscFunctionBegin; 4166 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4167 PetscCall(PetscObjectSetOptionsPrefix((PetscObject)ts, prefix)); 4168 PetscCall(TSGetSNES(ts, &snes)); 4169 PetscCall(SNESSetOptionsPrefix(snes, prefix)); 4170 PetscFunctionReturn(PETSC_SUCCESS); 4171 } 4172 4173 /*@C 4174 TSAppendOptionsPrefix - Appends to the prefix used for searching for all 4175 TS options in the database. 4176 4177 Logically Collective 4178 4179 Input Parameters: 4180 + ts - The `TS` context 4181 - prefix - The prefix to prepend to all option names 4182 4183 Level: advanced 4184 4185 Note: 4186 A hyphen (-) must NOT be given at the beginning of the prefix name. 4187 The first character of all runtime options is AUTOMATICALLY the 4188 hyphen. 4189 4190 .seealso: [](ch_ts), `TS`, `TSGetOptionsPrefix()`, `TSSetOptionsPrefix()`, `TSSetFromOptions()` 4191 @*/ 4192 PetscErrorCode TSAppendOptionsPrefix(TS ts, const char prefix[]) 4193 { 4194 SNES snes; 4195 4196 PetscFunctionBegin; 4197 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4198 PetscCall(PetscObjectAppendOptionsPrefix((PetscObject)ts, prefix)); 4199 PetscCall(TSGetSNES(ts, &snes)); 4200 PetscCall(SNESAppendOptionsPrefix(snes, prefix)); 4201 PetscFunctionReturn(PETSC_SUCCESS); 4202 } 4203 4204 /*@C 4205 TSGetOptionsPrefix - Sets the prefix used for searching for all 4206 `TS` options in the database. 4207 4208 Not Collective 4209 4210 Input Parameter: 4211 . ts - The `TS` context 4212 4213 Output Parameter: 4214 . prefix - A pointer to the prefix string used 4215 4216 Level: intermediate 4217 4218 Fortran Notes: 4219 The user should pass in a string 'prefix' of 4220 sufficient length to hold the prefix. 4221 4222 .seealso: [](ch_ts), `TS`, `TSAppendOptionsPrefix()`, `TSSetFromOptions()` 4223 @*/ 4224 PetscErrorCode TSGetOptionsPrefix(TS ts, const char *prefix[]) 4225 { 4226 PetscFunctionBegin; 4227 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4228 PetscAssertPointer(prefix, 2); 4229 PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ts, prefix)); 4230 PetscFunctionReturn(PETSC_SUCCESS); 4231 } 4232 4233 /*@C 4234 TSGetRHSJacobian - Returns the Jacobian J at the present timestep. 4235 4236 Not Collective, but parallel objects are returned if ts is parallel 4237 4238 Input Parameter: 4239 . ts - The `TS` context obtained from `TSCreate()` 4240 4241 Output Parameters: 4242 + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t) (or `NULL`) 4243 . Pmat - The matrix from which the preconditioner is constructed, usually the same as `Amat` (or `NULL`) 4244 . func - Function to compute the Jacobian of the RHS (or `NULL`) 4245 - ctx - User-defined context for Jacobian evaluation routine (or `NULL`) 4246 4247 Level: intermediate 4248 4249 Note: 4250 You can pass in `NULL` for any return argument you do not need. 4251 4252 .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()` 4253 4254 @*/ 4255 PetscErrorCode TSGetRHSJacobian(TS ts, Mat *Amat, Mat *Pmat, TSRHSJacobianFn **func, void **ctx) 4256 { 4257 DM dm; 4258 4259 PetscFunctionBegin; 4260 if (Amat || Pmat) { 4261 SNES snes; 4262 PetscCall(TSGetSNES(ts, &snes)); 4263 PetscCall(SNESSetUpMatrices(snes)); 4264 PetscCall(SNESGetJacobian(snes, Amat, Pmat, NULL, NULL)); 4265 } 4266 PetscCall(TSGetDM(ts, &dm)); 4267 PetscCall(DMTSGetRHSJacobian(dm, func, ctx)); 4268 PetscFunctionReturn(PETSC_SUCCESS); 4269 } 4270 4271 /*@C 4272 TSGetIJacobian - Returns the implicit Jacobian at the present timestep. 4273 4274 Not Collective, but parallel objects are returned if ts is parallel 4275 4276 Input Parameter: 4277 . ts - The `TS` context obtained from `TSCreate()` 4278 4279 Output Parameters: 4280 + Amat - The (approximate) Jacobian of F(t,U,U_t) 4281 . Pmat - The matrix from which the preconditioner is constructed, often the same as `Amat` 4282 . f - The function to compute the matrices 4283 - ctx - User-defined context for Jacobian evaluation routine 4284 4285 Level: advanced 4286 4287 Note: 4288 You can pass in `NULL` for any return argument you do not need. 4289 4290 .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetRHSJacobian()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()` 4291 @*/ 4292 PetscErrorCode TSGetIJacobian(TS ts, Mat *Amat, Mat *Pmat, TSIJacobianFn **f, void **ctx) 4293 { 4294 DM dm; 4295 4296 PetscFunctionBegin; 4297 if (Amat || Pmat) { 4298 SNES snes; 4299 PetscCall(TSGetSNES(ts, &snes)); 4300 PetscCall(SNESSetUpMatrices(snes)); 4301 PetscCall(SNESGetJacobian(snes, Amat, Pmat, NULL, NULL)); 4302 } 4303 PetscCall(TSGetDM(ts, &dm)); 4304 PetscCall(DMTSGetIJacobian(dm, f, ctx)); 4305 PetscFunctionReturn(PETSC_SUCCESS); 4306 } 4307 4308 #include <petsc/private/dmimpl.h> 4309 /*@ 4310 TSSetDM - Sets the `DM` that may be used by some nonlinear solvers or preconditioners under the `TS` 4311 4312 Logically Collective 4313 4314 Input Parameters: 4315 + ts - the `TS` integrator object 4316 - dm - the dm, cannot be `NULL` 4317 4318 Level: intermediate 4319 4320 Notes: 4321 A `DM` can only be used for solving one problem at a time because information about the problem is stored on the `DM`, 4322 even when not using interfaces like `DMTSSetIFunction()`. Use `DMClone()` to get a distinct `DM` when solving 4323 different problems using the same function space. 4324 4325 .seealso: [](ch_ts), `TS`, `DM`, `TSGetDM()`, `SNESSetDM()`, `SNESGetDM()` 4326 @*/ 4327 PetscErrorCode TSSetDM(TS ts, DM dm) 4328 { 4329 SNES snes; 4330 DMTS tsdm; 4331 4332 PetscFunctionBegin; 4333 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4334 PetscValidHeaderSpecific(dm, DM_CLASSID, 2); 4335 PetscCall(PetscObjectReference((PetscObject)dm)); 4336 if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */ 4337 if (ts->dm->dmts && !dm->dmts) { 4338 PetscCall(DMCopyDMTS(ts->dm, dm)); 4339 PetscCall(DMGetDMTS(ts->dm, &tsdm)); 4340 /* Grant write privileges to the replacement DM */ 4341 if (tsdm->originaldm == ts->dm) tsdm->originaldm = dm; 4342 } 4343 PetscCall(DMDestroy(&ts->dm)); 4344 } 4345 ts->dm = dm; 4346 4347 PetscCall(TSGetSNES(ts, &snes)); 4348 PetscCall(SNESSetDM(snes, dm)); 4349 PetscFunctionReturn(PETSC_SUCCESS); 4350 } 4351 4352 /*@ 4353 TSGetDM - Gets the `DM` that may be used by some preconditioners 4354 4355 Not Collective 4356 4357 Input Parameter: 4358 . ts - the `TS` 4359 4360 Output Parameter: 4361 . dm - the `DM` 4362 4363 Level: intermediate 4364 4365 .seealso: [](ch_ts), `TS`, `DM`, `TSSetDM()`, `SNESSetDM()`, `SNESGetDM()` 4366 @*/ 4367 PetscErrorCode TSGetDM(TS ts, DM *dm) 4368 { 4369 PetscFunctionBegin; 4370 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4371 if (!ts->dm) { 4372 PetscCall(DMShellCreate(PetscObjectComm((PetscObject)ts), &ts->dm)); 4373 if (ts->snes) PetscCall(SNESSetDM(ts->snes, ts->dm)); 4374 } 4375 *dm = ts->dm; 4376 PetscFunctionReturn(PETSC_SUCCESS); 4377 } 4378 4379 /*@ 4380 SNESTSFormFunction - Function to evaluate nonlinear residual 4381 4382 Logically Collective 4383 4384 Input Parameters: 4385 + snes - nonlinear solver 4386 . U - the current state at which to evaluate the residual 4387 - ctx - user context, must be a TS 4388 4389 Output Parameter: 4390 . F - the nonlinear residual 4391 4392 Level: advanced 4393 4394 Note: 4395 This function is not normally called by users and is automatically registered with the `SNES` used by `TS`. 4396 It is most frequently passed to `MatFDColoringSetFunction()`. 4397 4398 .seealso: [](ch_ts), `SNESSetFunction()`, `MatFDColoringSetFunction()` 4399 @*/ 4400 PetscErrorCode SNESTSFormFunction(SNES snes, Vec U, Vec F, void *ctx) 4401 { 4402 TS ts = (TS)ctx; 4403 4404 PetscFunctionBegin; 4405 PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 4406 PetscValidHeaderSpecific(U, VEC_CLASSID, 2); 4407 PetscValidHeaderSpecific(F, VEC_CLASSID, 3); 4408 PetscValidHeaderSpecific(ts, TS_CLASSID, 4); 4409 PetscCheck(ts->ops->snesfunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No method snesfunction for TS of type %s", ((PetscObject)ts)->type_name); 4410 PetscCall((*ts->ops->snesfunction)(snes, U, F, ts)); 4411 PetscFunctionReturn(PETSC_SUCCESS); 4412 } 4413 4414 /*@ 4415 SNESTSFormJacobian - Function to evaluate the Jacobian 4416 4417 Collective 4418 4419 Input Parameters: 4420 + snes - nonlinear solver 4421 . U - the current state at which to evaluate the residual 4422 - ctx - user context, must be a `TS` 4423 4424 Output Parameters: 4425 + A - the Jacobian 4426 - B - the preconditioning matrix (may be the same as A) 4427 4428 Level: developer 4429 4430 Note: 4431 This function is not normally called by users and is automatically registered with the `SNES` used by `TS`. 4432 4433 .seealso: [](ch_ts), `SNESSetJacobian()` 4434 @*/ 4435 PetscErrorCode SNESTSFormJacobian(SNES snes, Vec U, Mat A, Mat B, void *ctx) 4436 { 4437 TS ts = (TS)ctx; 4438 4439 PetscFunctionBegin; 4440 PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 4441 PetscValidHeaderSpecific(U, VEC_CLASSID, 2); 4442 PetscValidHeaderSpecific(A, MAT_CLASSID, 3); 4443 PetscValidHeaderSpecific(B, MAT_CLASSID, 4); 4444 PetscValidHeaderSpecific(ts, TS_CLASSID, 5); 4445 PetscCheck(ts->ops->snesjacobian, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No method snesjacobian for TS of type %s", ((PetscObject)ts)->type_name); 4446 PetscCall((*ts->ops->snesjacobian)(snes, U, A, B, ts)); 4447 PetscFunctionReturn(PETSC_SUCCESS); 4448 } 4449 4450 /*@C 4451 TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only 4452 4453 Collective 4454 4455 Input Parameters: 4456 + ts - time stepping context 4457 . t - time at which to evaluate 4458 . U - state at which to evaluate 4459 - ctx - context 4460 4461 Output Parameter: 4462 . F - right hand side 4463 4464 Level: intermediate 4465 4466 Note: 4467 This function is intended to be passed to `TSSetRHSFunction()` to evaluate the right hand side for linear problems. 4468 The matrix (and optionally the evaluation context) should be passed to `TSSetRHSJacobian()`. 4469 4470 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSSetRHSJacobian()`, `TSComputeRHSJacobianConstant()` 4471 @*/ 4472 PetscErrorCode TSComputeRHSFunctionLinear(TS ts, PetscReal t, Vec U, Vec F, void *ctx) 4473 { 4474 Mat Arhs, Brhs; 4475 4476 PetscFunctionBegin; 4477 PetscCall(TSGetRHSMats_Private(ts, &Arhs, &Brhs)); 4478 /* undo the damage caused by shifting */ 4479 PetscCall(TSRecoverRHSJacobian(ts, Arhs, Brhs)); 4480 PetscCall(TSComputeRHSJacobian(ts, t, U, Arhs, Brhs)); 4481 PetscCall(MatMult(Arhs, U, F)); 4482 PetscFunctionReturn(PETSC_SUCCESS); 4483 } 4484 4485 /*@C 4486 TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent. 4487 4488 Collective 4489 4490 Input Parameters: 4491 + ts - time stepping context 4492 . t - time at which to evaluate 4493 . U - state at which to evaluate 4494 - ctx - context 4495 4496 Output Parameters: 4497 + A - pointer to operator 4498 - B - pointer to preconditioning matrix 4499 4500 Level: intermediate 4501 4502 Note: 4503 This function is intended to be passed to `TSSetRHSJacobian()` to evaluate the Jacobian for linear time-independent problems. 4504 4505 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSSetRHSJacobian()`, `TSComputeRHSFunctionLinear()` 4506 @*/ 4507 PetscErrorCode TSComputeRHSJacobianConstant(TS ts, PetscReal t, Vec U, Mat A, Mat B, void *ctx) 4508 { 4509 PetscFunctionBegin; 4510 PetscFunctionReturn(PETSC_SUCCESS); 4511 } 4512 4513 /*@C 4514 TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only 4515 4516 Collective 4517 4518 Input Parameters: 4519 + ts - time stepping context 4520 . t - time at which to evaluate 4521 . U - state at which to evaluate 4522 . Udot - time derivative of state vector 4523 - ctx - context 4524 4525 Output Parameter: 4526 . F - left hand side 4527 4528 Level: intermediate 4529 4530 Notes: 4531 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 4532 user is required to write their own `TSComputeIFunction()`. 4533 This function is intended to be passed to `TSSetIFunction()` to evaluate the left hand side for linear problems. 4534 The matrix (and optionally the evaluation context) should be passed to `TSSetIJacobian()`. 4535 4536 Note that using this function is NOT equivalent to using `TSComputeRHSFunctionLinear()` since that solves Udot = A U 4537 4538 .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `TSSetIJacobian()`, `TSComputeIJacobianConstant()`, `TSComputeRHSFunctionLinear()` 4539 @*/ 4540 PetscErrorCode TSComputeIFunctionLinear(TS ts, PetscReal t, Vec U, Vec Udot, Vec F, void *ctx) 4541 { 4542 Mat A, B; 4543 4544 PetscFunctionBegin; 4545 PetscCall(TSGetIJacobian(ts, &A, &B, NULL, NULL)); 4546 PetscCall(TSComputeIJacobian(ts, t, U, Udot, 1.0, A, B, PETSC_TRUE)); 4547 PetscCall(MatMult(A, Udot, F)); 4548 PetscFunctionReturn(PETSC_SUCCESS); 4549 } 4550 4551 /*@C 4552 TSComputeIJacobianConstant - Reuses the matrix previously computed with the provided `TSIJacobianFn` for a semi-implicit DAE or ODE 4553 4554 Collective 4555 4556 Input Parameters: 4557 + ts - time stepping context 4558 . t - time at which to evaluate 4559 . U - state at which to evaluate 4560 . Udot - time derivative of state vector 4561 . shift - shift to apply 4562 - ctx - context 4563 4564 Output Parameters: 4565 + A - pointer to operator 4566 - B - pointer to matrix from which the preconditioner is built (often `A`) 4567 4568 Level: advanced 4569 4570 Notes: 4571 This function is intended to be passed to `TSSetIJacobian()` to evaluate the Jacobian for linear time-independent problems. 4572 4573 It is only appropriate for problems of the form 4574 4575 $$ 4576 M \dot{U} = F(U,t) 4577 $$ 4578 4579 where M is constant and F is non-stiff. The user must pass M to `TSSetIJacobian()`. The current implementation only 4580 works with IMEX time integration methods such as `TSROSW` and `TSARKIMEX`, since there is no support for de-constructing 4581 an implicit operator of the form 4582 4583 $$ 4584 shift*M + J 4585 $$ 4586 4587 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 4588 a copy of M or reassemble it when requested. 4589 4590 .seealso: [](ch_ts), `TS`, `TSROSW`, `TSARKIMEX`, `TSSetIFunction()`, `TSSetIJacobian()`, `TSComputeIFunctionLinear()` 4591 @*/ 4592 PetscErrorCode TSComputeIJacobianConstant(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat A, Mat B, void *ctx) 4593 { 4594 PetscFunctionBegin; 4595 PetscCall(MatScale(A, shift / ts->ijacobian.shift)); 4596 ts->ijacobian.shift = shift; 4597 PetscFunctionReturn(PETSC_SUCCESS); 4598 } 4599 4600 /*@ 4601 TSGetEquationType - Gets the type of the equation that `TS` is solving. 4602 4603 Not Collective 4604 4605 Input Parameter: 4606 . ts - the `TS` context 4607 4608 Output Parameter: 4609 . equation_type - see `TSEquationType` 4610 4611 Level: beginner 4612 4613 .seealso: [](ch_ts), `TS`, `TSSetEquationType()`, `TSEquationType` 4614 @*/ 4615 PetscErrorCode TSGetEquationType(TS ts, TSEquationType *equation_type) 4616 { 4617 PetscFunctionBegin; 4618 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4619 PetscAssertPointer(equation_type, 2); 4620 *equation_type = ts->equation_type; 4621 PetscFunctionReturn(PETSC_SUCCESS); 4622 } 4623 4624 /*@ 4625 TSSetEquationType - Sets the type of the equation that `TS` is solving. 4626 4627 Not Collective 4628 4629 Input Parameters: 4630 + ts - the `TS` context 4631 - equation_type - see `TSEquationType` 4632 4633 Level: advanced 4634 4635 .seealso: [](ch_ts), `TS`, `TSGetEquationType()`, `TSEquationType` 4636 @*/ 4637 PetscErrorCode TSSetEquationType(TS ts, TSEquationType equation_type) 4638 { 4639 PetscFunctionBegin; 4640 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4641 ts->equation_type = equation_type; 4642 PetscFunctionReturn(PETSC_SUCCESS); 4643 } 4644 4645 /*@ 4646 TSGetConvergedReason - Gets the reason the `TS` iteration was stopped. 4647 4648 Not Collective 4649 4650 Input Parameter: 4651 . ts - the `TS` context 4652 4653 Output Parameter: 4654 . reason - negative value indicates diverged, positive value converged, see `TSConvergedReason` or the 4655 manual pages for the individual convergence tests for complete lists 4656 4657 Level: beginner 4658 4659 Note: 4660 Can only be called after the call to `TSSolve()` is complete. 4661 4662 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSSetConvergenceTest()`, `TSConvergedReason` 4663 @*/ 4664 PetscErrorCode TSGetConvergedReason(TS ts, TSConvergedReason *reason) 4665 { 4666 PetscFunctionBegin; 4667 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4668 PetscAssertPointer(reason, 2); 4669 *reason = ts->reason; 4670 PetscFunctionReturn(PETSC_SUCCESS); 4671 } 4672 4673 /*@ 4674 TSSetConvergedReason - Sets the reason for handling the convergence of `TSSolve()`. 4675 4676 Logically Collective; reason must contain common value 4677 4678 Input Parameters: 4679 + ts - the `TS` context 4680 - reason - negative value indicates diverged, positive value converged, see `TSConvergedReason` or the 4681 manual pages for the individual convergence tests for complete lists 4682 4683 Level: advanced 4684 4685 Note: 4686 Can only be called while `TSSolve()` is active. 4687 4688 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSConvergedReason` 4689 @*/ 4690 PetscErrorCode TSSetConvergedReason(TS ts, TSConvergedReason reason) 4691 { 4692 PetscFunctionBegin; 4693 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4694 ts->reason = reason; 4695 PetscFunctionReturn(PETSC_SUCCESS); 4696 } 4697 4698 /*@ 4699 TSGetSolveTime - Gets the time after a call to `TSSolve()` 4700 4701 Not Collective 4702 4703 Input Parameter: 4704 . ts - the `TS` context 4705 4706 Output Parameter: 4707 . ftime - the final time. This time corresponds to the final time set with `TSSetMaxTime()` 4708 4709 Level: beginner 4710 4711 Note: 4712 Can only be called after the call to `TSSolve()` is complete. 4713 4714 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSSetConvergenceTest()`, `TSConvergedReason` 4715 @*/ 4716 PetscErrorCode TSGetSolveTime(TS ts, PetscReal *ftime) 4717 { 4718 PetscFunctionBegin; 4719 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4720 PetscAssertPointer(ftime, 2); 4721 *ftime = ts->solvetime; 4722 PetscFunctionReturn(PETSC_SUCCESS); 4723 } 4724 4725 /*@ 4726 TSGetSNESIterations - Gets the total number of nonlinear iterations 4727 used by the time integrator. 4728 4729 Not Collective 4730 4731 Input Parameter: 4732 . ts - `TS` context 4733 4734 Output Parameter: 4735 . nits - number of nonlinear iterations 4736 4737 Level: intermediate 4738 4739 Note: 4740 This counter is reset to zero for each successive call to `TSSolve()`. 4741 4742 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetKSPIterations()` 4743 @*/ 4744 PetscErrorCode TSGetSNESIterations(TS ts, PetscInt *nits) 4745 { 4746 PetscFunctionBegin; 4747 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4748 PetscAssertPointer(nits, 2); 4749 *nits = ts->snes_its; 4750 PetscFunctionReturn(PETSC_SUCCESS); 4751 } 4752 4753 /*@ 4754 TSGetKSPIterations - Gets the total number of linear iterations 4755 used by the time integrator. 4756 4757 Not Collective 4758 4759 Input Parameter: 4760 . ts - `TS` context 4761 4762 Output Parameter: 4763 . lits - number of linear iterations 4764 4765 Level: intermediate 4766 4767 Note: 4768 This counter is reset to zero for each successive call to `TSSolve()`. 4769 4770 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `SNESGetKSPIterations()` 4771 @*/ 4772 PetscErrorCode TSGetKSPIterations(TS ts, PetscInt *lits) 4773 { 4774 PetscFunctionBegin; 4775 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4776 PetscAssertPointer(lits, 2); 4777 *lits = ts->ksp_its; 4778 PetscFunctionReturn(PETSC_SUCCESS); 4779 } 4780 4781 /*@ 4782 TSGetStepRejections - Gets the total number of rejected steps. 4783 4784 Not Collective 4785 4786 Input Parameter: 4787 . ts - `TS` context 4788 4789 Output Parameter: 4790 . rejects - number of steps rejected 4791 4792 Level: intermediate 4793 4794 Note: 4795 This counter is reset to zero for each successive call to `TSSolve()`. 4796 4797 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetSNESFailures()`, `TSSetMaxSNESFailures()`, `TSSetErrorIfStepFails()` 4798 @*/ 4799 PetscErrorCode TSGetStepRejections(TS ts, PetscInt *rejects) 4800 { 4801 PetscFunctionBegin; 4802 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4803 PetscAssertPointer(rejects, 2); 4804 *rejects = ts->reject; 4805 PetscFunctionReturn(PETSC_SUCCESS); 4806 } 4807 4808 /*@ 4809 TSGetSNESFailures - Gets the total number of failed `SNES` solves in a `TS` 4810 4811 Not Collective 4812 4813 Input Parameter: 4814 . ts - `TS` context 4815 4816 Output Parameter: 4817 . fails - number of failed nonlinear solves 4818 4819 Level: intermediate 4820 4821 Note: 4822 This counter is reset to zero for each successive call to `TSSolve()`. 4823 4824 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSSetMaxSNESFailures()` 4825 @*/ 4826 PetscErrorCode TSGetSNESFailures(TS ts, PetscInt *fails) 4827 { 4828 PetscFunctionBegin; 4829 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4830 PetscAssertPointer(fails, 2); 4831 *fails = ts->num_snes_failures; 4832 PetscFunctionReturn(PETSC_SUCCESS); 4833 } 4834 4835 /*@ 4836 TSSetMaxStepRejections - Sets the maximum number of step rejections before a time step fails 4837 4838 Not Collective 4839 4840 Input Parameters: 4841 + ts - `TS` context 4842 - rejects - maximum number of rejected steps, pass -1 for unlimited 4843 4844 Options Database Key: 4845 . -ts_max_reject - Maximum number of step rejections before a step fails 4846 4847 Level: intermediate 4848 4849 .seealso: [](ch_ts), `TS`, `SNES`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxSNESFailures()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `TSSetErrorIfStepFails()`, `TSGetConvergedReason()` 4850 @*/ 4851 PetscErrorCode TSSetMaxStepRejections(TS ts, PetscInt rejects) 4852 { 4853 PetscFunctionBegin; 4854 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4855 ts->max_reject = rejects; 4856 PetscFunctionReturn(PETSC_SUCCESS); 4857 } 4858 4859 /*@ 4860 TSSetMaxSNESFailures - Sets the maximum number of failed `SNES` solves 4861 4862 Not Collective 4863 4864 Input Parameters: 4865 + ts - `TS` context 4866 - fails - maximum number of failed nonlinear solves, pass -1 for unlimited 4867 4868 Options Database Key: 4869 . -ts_max_snes_failures - Maximum number of nonlinear solve failures 4870 4871 Level: intermediate 4872 4873 .seealso: [](ch_ts), `TS`, `SNES`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `SNESGetConvergedReason()`, `TSGetConvergedReason()` 4874 @*/ 4875 PetscErrorCode TSSetMaxSNESFailures(TS ts, PetscInt fails) 4876 { 4877 PetscFunctionBegin; 4878 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4879 ts->max_snes_failures = fails; 4880 PetscFunctionReturn(PETSC_SUCCESS); 4881 } 4882 4883 /*@ 4884 TSSetErrorIfStepFails - Immediately error if no step succeeds during `TSSolve()` 4885 4886 Not Collective 4887 4888 Input Parameters: 4889 + ts - `TS` context 4890 - err - `PETSC_TRUE` to error if no step succeeds, `PETSC_FALSE` to return without failure 4891 4892 Options Database Key: 4893 . -ts_error_if_step_fails - Error if no step succeeds 4894 4895 Level: intermediate 4896 4897 .seealso: [](ch_ts), `TS`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `TSGetConvergedReason()` 4898 @*/ 4899 PetscErrorCode TSSetErrorIfStepFails(TS ts, PetscBool err) 4900 { 4901 PetscFunctionBegin; 4902 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4903 ts->errorifstepfailed = err; 4904 PetscFunctionReturn(PETSC_SUCCESS); 4905 } 4906 4907 /*@ 4908 TSGetAdapt - Get the adaptive controller context for the current method 4909 4910 Collective if controller has not yet been created 4911 4912 Input Parameter: 4913 . ts - time stepping context 4914 4915 Output Parameter: 4916 . adapt - adaptive controller 4917 4918 Level: intermediate 4919 4920 .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSAdaptSetType()`, `TSAdaptChoose()` 4921 @*/ 4922 PetscErrorCode TSGetAdapt(TS ts, TSAdapt *adapt) 4923 { 4924 PetscFunctionBegin; 4925 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 4926 PetscAssertPointer(adapt, 2); 4927 if (!ts->adapt) { 4928 PetscCall(TSAdaptCreate(PetscObjectComm((PetscObject)ts), &ts->adapt)); 4929 PetscCall(PetscObjectIncrementTabLevel((PetscObject)ts->adapt, (PetscObject)ts, 1)); 4930 } 4931 *adapt = ts->adapt; 4932 PetscFunctionReturn(PETSC_SUCCESS); 4933 } 4934 4935 /*@ 4936 TSSetTolerances - Set tolerances for local truncation error when using an adaptive controller 4937 4938 Logically Collective 4939 4940 Input Parameters: 4941 + ts - time integration context 4942 . atol - scalar absolute tolerances, `PETSC_DECIDE` to leave current value 4943 . vatol - vector of absolute tolerances or `NULL`, used in preference to atol if present 4944 . rtol - scalar relative tolerances, `PETSC_DECIDE` to leave current value 4945 - vrtol - vector of relative tolerances or `NULL`, used in preference to atol if present 4946 4947 Options Database Keys: 4948 + -ts_rtol <rtol> - relative tolerance for local truncation error 4949 - -ts_atol <atol> - Absolute tolerance for local truncation error 4950 4951 Level: beginner 4952 4953 Notes: 4954 With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error 4955 (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be 4956 computed only for the differential or the algebraic part then this can be done using the vector of 4957 tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the 4958 differential part and infinity for the algebraic part, the LTE calculation will include only the 4959 differential variables. 4960 4961 .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSErrorWeightedNorm()`, `TSGetTolerances()` 4962 @*/ 4963 PetscErrorCode TSSetTolerances(TS ts, PetscReal atol, Vec vatol, PetscReal rtol, Vec vrtol) 4964 { 4965 PetscFunctionBegin; 4966 if (atol != (PetscReal)PETSC_DECIDE && atol != (PetscReal)PETSC_DEFAULT) ts->atol = atol; 4967 if (vatol) { 4968 PetscCall(PetscObjectReference((PetscObject)vatol)); 4969 PetscCall(VecDestroy(&ts->vatol)); 4970 ts->vatol = vatol; 4971 } 4972 if (rtol != (PetscReal)PETSC_DECIDE && rtol != (PetscReal)PETSC_DEFAULT) ts->rtol = rtol; 4973 if (vrtol) { 4974 PetscCall(PetscObjectReference((PetscObject)vrtol)); 4975 PetscCall(VecDestroy(&ts->vrtol)); 4976 ts->vrtol = vrtol; 4977 } 4978 PetscFunctionReturn(PETSC_SUCCESS); 4979 } 4980 4981 /*@ 4982 TSGetTolerances - Get tolerances for local truncation error when using adaptive controller 4983 4984 Logically Collective 4985 4986 Input Parameter: 4987 . ts - time integration context 4988 4989 Output Parameters: 4990 + atol - scalar absolute tolerances, `NULL` to ignore 4991 . vatol - vector of absolute tolerances, `NULL` to ignore 4992 . rtol - scalar relative tolerances, `NULL` to ignore 4993 - vrtol - vector of relative tolerances, `NULL` to ignore 4994 4995 Level: beginner 4996 4997 .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSErrorWeightedNorm()`, `TSSetTolerances()` 4998 @*/ 4999 PetscErrorCode TSGetTolerances(TS ts, PetscReal *atol, Vec *vatol, PetscReal *rtol, Vec *vrtol) 5000 { 5001 PetscFunctionBegin; 5002 if (atol) *atol = ts->atol; 5003 if (vatol) *vatol = ts->vatol; 5004 if (rtol) *rtol = ts->rtol; 5005 if (vrtol) *vrtol = ts->vrtol; 5006 PetscFunctionReturn(PETSC_SUCCESS); 5007 } 5008 5009 /*@ 5010 TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances 5011 5012 Collective 5013 5014 Input Parameters: 5015 + ts - time stepping context 5016 . U - state vector, usually ts->vec_sol 5017 . Y - state vector to be compared to U 5018 - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY` 5019 5020 Output Parameters: 5021 + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 5022 . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 5023 - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 5024 5025 Options Database Key: 5026 . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5027 5028 Level: developer 5029 5030 .seealso: [](ch_ts), `TS`, `VecErrorWeightedNorms()`, `TSErrorWeightedENorm()` 5031 @*/ 5032 PetscErrorCode TSErrorWeightedNorm(TS ts, Vec U, Vec Y, NormType wnormtype, PetscReal *norm, PetscReal *norma, PetscReal *normr) 5033 { 5034 PetscInt norma_loc, norm_loc, normr_loc; 5035 5036 PetscFunctionBegin; 5037 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5038 PetscCall(VecErrorWeightedNorms(U, Y, NULL, wnormtype, ts->atol, ts->vatol, ts->rtol, ts->vrtol, ts->adapt->ignore_max, norm, &norm_loc, norma, &norma_loc, normr, &normr_loc)); 5039 if (wnormtype == NORM_2) { 5040 if (norm_loc) *norm = PetscSqrtReal(PetscSqr(*norm) / norm_loc); 5041 if (norma_loc) *norma = PetscSqrtReal(PetscSqr(*norma) / norma_loc); 5042 if (normr_loc) *normr = PetscSqrtReal(PetscSqr(*normr) / normr_loc); 5043 } 5044 PetscCheck(!PetscIsInfOrNanScalar(*norm), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norm"); 5045 PetscCheck(!PetscIsInfOrNanScalar(*norma), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norma"); 5046 PetscCheck(!PetscIsInfOrNanScalar(*normr), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in normr"); 5047 PetscFunctionReturn(PETSC_SUCCESS); 5048 } 5049 5050 /*@ 5051 TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances 5052 5053 Collective 5054 5055 Input Parameters: 5056 + ts - time stepping context 5057 . E - error vector 5058 . U - state vector, usually ts->vec_sol 5059 . Y - state vector, previous time step 5060 - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY` 5061 5062 Output Parameters: 5063 + norm - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances 5064 . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user 5065 - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user 5066 5067 Options Database Key: 5068 . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY 5069 5070 Level: developer 5071 5072 .seealso: [](ch_ts), `TS`, `VecErrorWeightedNorms()`, `TSErrorWeightedNorm()` 5073 @*/ 5074 PetscErrorCode TSErrorWeightedENorm(TS ts, Vec E, Vec U, Vec Y, NormType wnormtype, PetscReal *norm, PetscReal *norma, PetscReal *normr) 5075 { 5076 PetscInt norma_loc, norm_loc, normr_loc; 5077 5078 PetscFunctionBegin; 5079 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5080 PetscCall(VecErrorWeightedNorms(U, Y, E, wnormtype, ts->atol, ts->vatol, ts->rtol, ts->vrtol, ts->adapt->ignore_max, norm, &norm_loc, norma, &norma_loc, normr, &normr_loc)); 5081 if (wnormtype == NORM_2) { 5082 if (norm_loc) *norm = PetscSqrtReal(PetscSqr(*norm) / norm_loc); 5083 if (norma_loc) *norma = PetscSqrtReal(PetscSqr(*norma) / norma_loc); 5084 if (normr_loc) *normr = PetscSqrtReal(PetscSqr(*normr) / normr_loc); 5085 } 5086 PetscCheck(!PetscIsInfOrNanScalar(*norm), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norm"); 5087 PetscCheck(!PetscIsInfOrNanScalar(*norma), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norma"); 5088 PetscCheck(!PetscIsInfOrNanScalar(*normr), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in normr"); 5089 PetscFunctionReturn(PETSC_SUCCESS); 5090 } 5091 5092 /*@ 5093 TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler 5094 5095 Logically Collective 5096 5097 Input Parameters: 5098 + ts - time stepping context 5099 - cfltime - maximum stable time step if using forward Euler (value can be different on each process) 5100 5101 Note: 5102 After calling this function, the global CFL time can be obtained by calling TSGetCFLTime() 5103 5104 Level: intermediate 5105 5106 .seealso: [](ch_ts), `TSGetCFLTime()`, `TSADAPTCFL` 5107 @*/ 5108 PetscErrorCode TSSetCFLTimeLocal(TS ts, PetscReal cfltime) 5109 { 5110 PetscFunctionBegin; 5111 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5112 ts->cfltime_local = cfltime; 5113 ts->cfltime = -1.; 5114 PetscFunctionReturn(PETSC_SUCCESS); 5115 } 5116 5117 /*@ 5118 TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler 5119 5120 Collective 5121 5122 Input Parameter: 5123 . ts - time stepping context 5124 5125 Output Parameter: 5126 . cfltime - maximum stable time step for forward Euler 5127 5128 Level: advanced 5129 5130 .seealso: [](ch_ts), `TSSetCFLTimeLocal()` 5131 @*/ 5132 PetscErrorCode TSGetCFLTime(TS ts, PetscReal *cfltime) 5133 { 5134 PetscFunctionBegin; 5135 if (ts->cfltime < 0) PetscCall(MPIU_Allreduce(&ts->cfltime_local, &ts->cfltime, 1, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject)ts))); 5136 *cfltime = ts->cfltime; 5137 PetscFunctionReturn(PETSC_SUCCESS); 5138 } 5139 5140 /*@ 5141 TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu 5142 5143 Input Parameters: 5144 + ts - the `TS` context. 5145 . xl - lower bound. 5146 - xu - upper bound. 5147 5148 Level: advanced 5149 5150 Note: 5151 If this routine is not called then the lower and upper bounds are set to 5152 `PETSC_NINFINITY` and `PETSC_INFINITY` respectively during `SNESSetUp()`. 5153 5154 .seealso: [](ch_ts), `TS` 5155 @*/ 5156 PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu) 5157 { 5158 SNES snes; 5159 5160 PetscFunctionBegin; 5161 PetscCall(TSGetSNES(ts, &snes)); 5162 PetscCall(SNESVISetVariableBounds(snes, xl, xu)); 5163 PetscFunctionReturn(PETSC_SUCCESS); 5164 } 5165 5166 /*@ 5167 TSComputeLinearStability - computes the linear stability function at a point 5168 5169 Collective 5170 5171 Input Parameters: 5172 + ts - the `TS` context 5173 . xr - real part of input argument 5174 - xi - imaginary part of input argument 5175 5176 Output Parameters: 5177 + yr - real part of function value 5178 - yi - imaginary part of function value 5179 5180 Level: developer 5181 5182 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSComputeIFunction()` 5183 @*/ 5184 PetscErrorCode TSComputeLinearStability(TS ts, PetscReal xr, PetscReal xi, PetscReal *yr, PetscReal *yi) 5185 { 5186 PetscFunctionBegin; 5187 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5188 PetscUseTypeMethod(ts, linearstability, xr, xi, yr, yi); 5189 PetscFunctionReturn(PETSC_SUCCESS); 5190 } 5191 5192 /*@ 5193 TSRestartStep - Flags the solver to restart the next step 5194 5195 Collective 5196 5197 Input Parameter: 5198 . ts - the `TS` context obtained from `TSCreate()` 5199 5200 Level: advanced 5201 5202 Notes: 5203 Multistep methods like `TSBDF` or Runge-Kutta methods with FSAL property require restarting the solver in the event of 5204 discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution 5205 vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For 5206 the sake of correctness and maximum safety, users are expected to call `TSRestart()` whenever they introduce 5207 discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with 5208 discontinuous source terms). 5209 5210 .seealso: [](ch_ts), `TS`, `TSBDF`, `TSSolve()`, `TSSetPreStep()`, `TSSetPostStep()` 5211 @*/ 5212 PetscErrorCode TSRestartStep(TS ts) 5213 { 5214 PetscFunctionBegin; 5215 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5216 ts->steprestart = PETSC_TRUE; 5217 PetscFunctionReturn(PETSC_SUCCESS); 5218 } 5219 5220 /*@ 5221 TSRollBack - Rolls back one time step 5222 5223 Collective 5224 5225 Input Parameter: 5226 . ts - the `TS` context obtained from `TSCreate()` 5227 5228 Level: advanced 5229 5230 .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetUp()`, `TSDestroy()`, `TSSolve()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSInterpolate()` 5231 @*/ 5232 PetscErrorCode TSRollBack(TS ts) 5233 { 5234 PetscFunctionBegin; 5235 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5236 PetscCheck(!ts->steprollback, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "TSRollBack already called"); 5237 PetscUseTypeMethod(ts, rollback); 5238 ts->time_step = ts->ptime - ts->ptime_prev; 5239 ts->ptime = ts->ptime_prev; 5240 ts->ptime_prev = ts->ptime_prev_rollback; 5241 ts->steps--; 5242 ts->steprollback = PETSC_TRUE; 5243 PetscFunctionReturn(PETSC_SUCCESS); 5244 } 5245 5246 /*@ 5247 TSGetStages - Get the number of stages and stage values 5248 5249 Input Parameter: 5250 . ts - the `TS` context obtained from `TSCreate()` 5251 5252 Output Parameters: 5253 + ns - the number of stages 5254 - Y - the current stage vectors 5255 5256 Level: advanced 5257 5258 Note: 5259 Both `ns` and `Y` can be `NULL`. 5260 5261 .seealso: [](ch_ts), `TS`, `TSCreate()` 5262 @*/ 5263 PetscErrorCode TSGetStages(TS ts, PetscInt *ns, Vec **Y) 5264 { 5265 PetscFunctionBegin; 5266 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5267 if (ns) PetscAssertPointer(ns, 2); 5268 if (Y) PetscAssertPointer(Y, 3); 5269 if (!ts->ops->getstages) { 5270 if (ns) *ns = 0; 5271 if (Y) *Y = NULL; 5272 } else PetscUseTypeMethod(ts, getstages, ns, Y); 5273 PetscFunctionReturn(PETSC_SUCCESS); 5274 } 5275 5276 /*@C 5277 TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity. 5278 5279 Collective 5280 5281 Input Parameters: 5282 + ts - the `TS` context 5283 . t - current timestep 5284 . U - state vector 5285 . Udot - time derivative of state vector 5286 . shift - shift to apply, see note below 5287 - ctx - an optional user context 5288 5289 Output Parameters: 5290 + J - Jacobian matrix (not altered in this routine) 5291 - B - newly computed Jacobian matrix to use with preconditioner (generally the same as `J`) 5292 5293 Level: intermediate 5294 5295 Notes: 5296 If F(t,U,Udot)=0 is the DAE, the required Jacobian is 5297 5298 dF/dU + shift*dF/dUdot 5299 5300 Most users should not need to explicitly call this routine, as it 5301 is used internally within the nonlinear solvers. 5302 5303 This will first try to get the coloring from the `DM`. If the `DM` type has no coloring 5304 routine, then it will try to get the coloring from the matrix. This requires that the 5305 matrix have nonzero entries precomputed. 5306 5307 .seealso: [](ch_ts), `TS`, `TSSetIJacobian()`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()` 5308 @*/ 5309 PetscErrorCode TSComputeIJacobianDefaultColor(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat J, Mat B, void *ctx) 5310 { 5311 SNES snes; 5312 MatFDColoring color; 5313 PetscBool hascolor, matcolor = PETSC_FALSE; 5314 5315 PetscFunctionBegin; 5316 PetscCall(PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL)); 5317 PetscCall(PetscObjectQuery((PetscObject)B, "TSMatFDColoring", (PetscObject *)&color)); 5318 if (!color) { 5319 DM dm; 5320 ISColoring iscoloring; 5321 5322 PetscCall(TSGetDM(ts, &dm)); 5323 PetscCall(DMHasColoring(dm, &hascolor)); 5324 if (hascolor && !matcolor) { 5325 PetscCall(DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring)); 5326 PetscCall(MatFDColoringCreate(B, iscoloring, &color)); 5327 PetscCall(MatFDColoringSetFunction(color, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts)); 5328 PetscCall(MatFDColoringSetFromOptions(color)); 5329 PetscCall(MatFDColoringSetUp(B, iscoloring, color)); 5330 PetscCall(ISColoringDestroy(&iscoloring)); 5331 } else { 5332 MatColoring mc; 5333 5334 PetscCall(MatColoringCreate(B, &mc)); 5335 PetscCall(MatColoringSetDistance(mc, 2)); 5336 PetscCall(MatColoringSetType(mc, MATCOLORINGSL)); 5337 PetscCall(MatColoringSetFromOptions(mc)); 5338 PetscCall(MatColoringApply(mc, &iscoloring)); 5339 PetscCall(MatColoringDestroy(&mc)); 5340 PetscCall(MatFDColoringCreate(B, iscoloring, &color)); 5341 PetscCall(MatFDColoringSetFunction(color, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts)); 5342 PetscCall(MatFDColoringSetFromOptions(color)); 5343 PetscCall(MatFDColoringSetUp(B, iscoloring, color)); 5344 PetscCall(ISColoringDestroy(&iscoloring)); 5345 } 5346 PetscCall(PetscObjectCompose((PetscObject)B, "TSMatFDColoring", (PetscObject)color)); 5347 PetscCall(PetscObjectDereference((PetscObject)color)); 5348 } 5349 PetscCall(TSGetSNES(ts, &snes)); 5350 PetscCall(MatFDColoringApply(B, color, U, snes)); 5351 if (J != B) { 5352 PetscCall(MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY)); 5353 PetscCall(MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY)); 5354 } 5355 PetscFunctionReturn(PETSC_SUCCESS); 5356 } 5357 5358 /*@C 5359 TSSetFunctionDomainError - Set a function that tests if the current state vector is valid 5360 5361 Input Parameters: 5362 + ts - the `TS` context 5363 - func - function called within `TSFunctionDomainError()` 5364 5365 Calling sequence of `func`: 5366 + ts - the `TS` context 5367 . time - the current time (of the stage) 5368 . state - the state to check if it is valid 5369 - accept - (output parameter) `PETSC_FALSE` if the state is not acceptable, `PETSC_TRUE` if acceptable 5370 5371 Level: intermediate 5372 5373 Notes: 5374 If an implicit ODE solver is being used then, in addition to providing this routine, the 5375 user's code should call `SNESSetFunctionDomainError()` when domain errors occur during 5376 function evaluations where the functions are provided by `TSSetIFunction()` or `TSSetRHSFunction()`. 5377 Use `TSGetSNES()` to obtain the `SNES` object 5378 5379 Developer Notes: 5380 The naming of this function is inconsistent with the `SNESSetFunctionDomainError()` 5381 since one takes a function pointer and the other does not. 5382 5383 .seealso: [](ch_ts), `TSAdaptCheckStage()`, `TSFunctionDomainError()`, `SNESSetFunctionDomainError()`, `TSGetSNES()` 5384 @*/ 5385 PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS ts, PetscReal time, Vec state, PetscBool *accept)) 5386 { 5387 PetscFunctionBegin; 5388 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5389 ts->functiondomainerror = func; 5390 PetscFunctionReturn(PETSC_SUCCESS); 5391 } 5392 5393 /*@ 5394 TSFunctionDomainError - Checks if the current state is valid 5395 5396 Input Parameters: 5397 + ts - the `TS` context 5398 . stagetime - time of the simulation 5399 - Y - state vector to check. 5400 5401 Output Parameter: 5402 . accept - Set to `PETSC_FALSE` if the current state vector is valid. 5403 5404 Level: developer 5405 5406 Note: 5407 This function is called by the `TS` integration routines and calls the user provided function (set with `TSSetFunctionDomainError()`) 5408 to check if the current state is valid. 5409 5410 .seealso: [](ch_ts), `TS`, `TSSetFunctionDomainError()` 5411 @*/ 5412 PetscErrorCode TSFunctionDomainError(TS ts, PetscReal stagetime, Vec Y, PetscBool *accept) 5413 { 5414 PetscFunctionBegin; 5415 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5416 *accept = PETSC_TRUE; 5417 if (ts->functiondomainerror) PetscCall((*ts->functiondomainerror)(ts, stagetime, Y, accept)); 5418 PetscFunctionReturn(PETSC_SUCCESS); 5419 } 5420 5421 /*@C 5422 TSClone - This function clones a time step `TS` object. 5423 5424 Collective 5425 5426 Input Parameter: 5427 . tsin - The input `TS` 5428 5429 Output Parameter: 5430 . tsout - The output `TS` (cloned) 5431 5432 Level: developer 5433 5434 Notes: 5435 This function is used to create a clone of a `TS` object. It is used in `TSARKIMEX` for initializing the slope for first stage explicit methods. 5436 It will likely be replaced in the future with a mechanism of switching methods on the fly. 5437 5438 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 5439 .vb 5440 SNES snes_dup = NULL; 5441 TSGetSNES(ts,&snes_dup); 5442 TSSetSNES(ts,snes_dup); 5443 .ve 5444 5445 .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetType()`, `TSSetUp()`, `TSDestroy()`, `TSSetProblemType()` 5446 @*/ 5447 PetscErrorCode TSClone(TS tsin, TS *tsout) 5448 { 5449 TS t; 5450 SNES snes_start; 5451 DM dm; 5452 TSType type; 5453 5454 PetscFunctionBegin; 5455 PetscAssertPointer(tsin, 1); 5456 *tsout = NULL; 5457 5458 PetscCall(PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView)); 5459 5460 /* General TS description */ 5461 t->numbermonitors = 0; 5462 t->monitorFrequency = 1; 5463 t->setupcalled = 0; 5464 t->ksp_its = 0; 5465 t->snes_its = 0; 5466 t->nwork = 0; 5467 t->rhsjacobian.time = PETSC_MIN_REAL; 5468 t->rhsjacobian.scale = 1.; 5469 t->ijacobian.shift = 1.; 5470 5471 PetscCall(TSGetSNES(tsin, &snes_start)); 5472 PetscCall(TSSetSNES(t, snes_start)); 5473 5474 PetscCall(TSGetDM(tsin, &dm)); 5475 PetscCall(TSSetDM(t, dm)); 5476 5477 t->adapt = tsin->adapt; 5478 PetscCall(PetscObjectReference((PetscObject)t->adapt)); 5479 5480 t->trajectory = tsin->trajectory; 5481 PetscCall(PetscObjectReference((PetscObject)t->trajectory)); 5482 5483 t->event = tsin->event; 5484 if (t->event) t->event->refct++; 5485 5486 t->problem_type = tsin->problem_type; 5487 t->ptime = tsin->ptime; 5488 t->ptime_prev = tsin->ptime_prev; 5489 t->time_step = tsin->time_step; 5490 t->max_time = tsin->max_time; 5491 t->steps = tsin->steps; 5492 t->max_steps = tsin->max_steps; 5493 t->equation_type = tsin->equation_type; 5494 t->atol = tsin->atol; 5495 t->rtol = tsin->rtol; 5496 t->max_snes_failures = tsin->max_snes_failures; 5497 t->max_reject = tsin->max_reject; 5498 t->errorifstepfailed = tsin->errorifstepfailed; 5499 5500 PetscCall(TSGetType(tsin, &type)); 5501 PetscCall(TSSetType(t, type)); 5502 5503 t->vec_sol = NULL; 5504 5505 t->cfltime = tsin->cfltime; 5506 t->cfltime_local = tsin->cfltime_local; 5507 t->exact_final_time = tsin->exact_final_time; 5508 5509 t->ops[0] = tsin->ops[0]; 5510 5511 if (((PetscObject)tsin)->fortran_func_pointers) { 5512 PetscInt i; 5513 PetscCall(PetscMalloc((10) * sizeof(void (*)(void)), &((PetscObject)t)->fortran_func_pointers)); 5514 for (i = 0; i < 10; i++) ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i]; 5515 } 5516 *tsout = t; 5517 PetscFunctionReturn(PETSC_SUCCESS); 5518 } 5519 5520 static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void *ctx, Vec x, Vec y) 5521 { 5522 TS ts = (TS)ctx; 5523 5524 PetscFunctionBegin; 5525 PetscCall(TSComputeRHSFunction(ts, 0, x, y)); 5526 PetscFunctionReturn(PETSC_SUCCESS); 5527 } 5528 5529 /*@ 5530 TSRHSJacobianTest - Compares the multiply routine provided to the `MATSHELL` with differencing on the `TS` given RHS function. 5531 5532 Logically Collective 5533 5534 Input Parameter: 5535 . ts - the time stepping routine 5536 5537 Output Parameter: 5538 . flg - `PETSC_TRUE` if the multiply is likely correct 5539 5540 Options Database Key: 5541 . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator 5542 5543 Level: advanced 5544 5545 Note: 5546 This only works for problems defined using `TSSetRHSFunction()` and Jacobian NOT `TSSetIFunction()` and Jacobian 5547 5548 .seealso: [](ch_ts), `TS`, `Mat`, `MATSHELL`, `MatCreateShell()`, `MatShellGetContext()`, `MatShellGetOperation()`, `MatShellTestMultTranspose()`, `TSRHSJacobianTestTranspose()` 5549 @*/ 5550 PetscErrorCode TSRHSJacobianTest(TS ts, PetscBool *flg) 5551 { 5552 Mat J, B; 5553 TSRHSJacobianFn *func; 5554 void *ctx; 5555 5556 PetscFunctionBegin; 5557 PetscCall(TSGetRHSJacobian(ts, &J, &B, &func, &ctx)); 5558 PetscCall((*func)(ts, 0.0, ts->vec_sol, J, B, ctx)); 5559 PetscCall(MatShellTestMult(J, RHSWrapperFunction_TSRHSJacobianTest, ts->vec_sol, ts, flg)); 5560 PetscFunctionReturn(PETSC_SUCCESS); 5561 } 5562 5563 /*@C 5564 TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the `MATSHELL` with differencing on the `TS` given RHS function. 5565 5566 Logically Collective 5567 5568 Input Parameter: 5569 . ts - the time stepping routine 5570 5571 Output Parameter: 5572 . flg - `PETSC_TRUE` if the multiply is likely correct 5573 5574 Options Database Key: 5575 . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator 5576 5577 Level: advanced 5578 5579 Notes: 5580 This only works for problems defined using `TSSetRHSFunction()` and Jacobian NOT `TSSetIFunction()` and Jacobian 5581 5582 .seealso: [](ch_ts), `TS`, `Mat`, `MatCreateShell()`, `MatShellGetContext()`, `MatShellGetOperation()`, `MatShellTestMultTranspose()`, `TSRHSJacobianTest()` 5583 @*/ 5584 PetscErrorCode TSRHSJacobianTestTranspose(TS ts, PetscBool *flg) 5585 { 5586 Mat J, B; 5587 void *ctx; 5588 TSRHSJacobianFn *func; 5589 5590 PetscFunctionBegin; 5591 PetscCall(TSGetRHSJacobian(ts, &J, &B, &func, &ctx)); 5592 PetscCall((*func)(ts, 0.0, ts->vec_sol, J, B, ctx)); 5593 PetscCall(MatShellTestMultTranspose(J, RHSWrapperFunction_TSRHSJacobianTest, ts->vec_sol, ts, flg)); 5594 PetscFunctionReturn(PETSC_SUCCESS); 5595 } 5596 5597 /*@ 5598 TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used. 5599 5600 Logically Collective 5601 5602 Input Parameters: 5603 + ts - timestepping context 5604 - use_splitrhsfunction - `PETSC_TRUE` indicates that the split RHSFunction will be used 5605 5606 Options Database Key: 5607 . -ts_use_splitrhsfunction - <true,false> 5608 5609 Level: intermediate 5610 5611 Note: 5612 This is only for multirate methods 5613 5614 .seealso: [](ch_ts), `TS`, `TSGetUseSplitRHSFunction()` 5615 @*/ 5616 PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction) 5617 { 5618 PetscFunctionBegin; 5619 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5620 ts->use_splitrhsfunction = use_splitrhsfunction; 5621 PetscFunctionReturn(PETSC_SUCCESS); 5622 } 5623 5624 /*@ 5625 TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used. 5626 5627 Not Collective 5628 5629 Input Parameter: 5630 . ts - timestepping context 5631 5632 Output Parameter: 5633 . use_splitrhsfunction - `PETSC_TRUE` indicates that the split RHSFunction will be used 5634 5635 Level: intermediate 5636 5637 .seealso: [](ch_ts), `TS`, `TSSetUseSplitRHSFunction()` 5638 @*/ 5639 PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction) 5640 { 5641 PetscFunctionBegin; 5642 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5643 *use_splitrhsfunction = ts->use_splitrhsfunction; 5644 PetscFunctionReturn(PETSC_SUCCESS); 5645 } 5646 5647 /*@ 5648 TSSetMatStructure - sets the relationship between the nonzero structure of the RHS Jacobian matrix to the IJacobian matrix. 5649 5650 Logically Collective 5651 5652 Input Parameters: 5653 + ts - the time-stepper 5654 - str - the structure (the default is `UNKNOWN_NONZERO_PATTERN`) 5655 5656 Level: intermediate 5657 5658 Note: 5659 When the relationship between the nonzero structures is known and supplied the solution process can be much faster 5660 5661 .seealso: [](ch_ts), `TS`, `MatAXPY()`, `MatStructure` 5662 @*/ 5663 PetscErrorCode TSSetMatStructure(TS ts, MatStructure str) 5664 { 5665 PetscFunctionBegin; 5666 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5667 ts->axpy_pattern = str; 5668 PetscFunctionReturn(PETSC_SUCCESS); 5669 } 5670 5671 /*@ 5672 TSSetTimeSpan - sets the time span. The solution will be computed and stored for each time requested in the span 5673 5674 Collective 5675 5676 Input Parameters: 5677 + ts - the time-stepper 5678 . n - number of the time points (>=2) 5679 - span_times - array of the time points. The first element and the last element are the initial time and the final time respectively. 5680 5681 Options Database Key: 5682 . -ts_time_span <t0,...tf> - Sets the time span 5683 5684 Level: intermediate 5685 5686 Notes: 5687 The elements in tspan must be all increasing. They correspond to the intermediate points for time integration. 5688 `TS_EXACTFINALTIME_MATCHSTEP` must be used to make the last time step in each sub-interval match the intermediate points specified. 5689 The intermediate solutions are saved in a vector array that can be accessed with `TSGetTimeSpanSolutions()`. Thus using time span may 5690 pressure the memory system when using a large number of span points. 5691 5692 .seealso: [](ch_ts), `TS`, `TSGetTimeSpan()`, `TSGetTimeSpanSolutions()` 5693 @*/ 5694 PetscErrorCode TSSetTimeSpan(TS ts, PetscInt n, PetscReal *span_times) 5695 { 5696 PetscFunctionBegin; 5697 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5698 PetscCheck(n >= 2, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Minimum time span size is 2 but %" PetscInt_FMT " is provided", n); 5699 if (ts->tspan && n != ts->tspan->num_span_times) { 5700 PetscCall(PetscFree(ts->tspan->span_times)); 5701 PetscCall(VecDestroyVecs(ts->tspan->num_span_times, &ts->tspan->vecs_sol)); 5702 PetscCall(PetscMalloc1(n, &ts->tspan->span_times)); 5703 } 5704 if (!ts->tspan) { 5705 TSTimeSpan tspan; 5706 PetscCall(PetscNew(&tspan)); 5707 PetscCall(PetscMalloc1(n, &tspan->span_times)); 5708 tspan->reltol = 1e-6; 5709 tspan->abstol = 10 * PETSC_MACHINE_EPSILON; 5710 tspan->worktol = 0; 5711 ts->tspan = tspan; 5712 } 5713 ts->tspan->num_span_times = n; 5714 PetscCall(PetscArraycpy(ts->tspan->span_times, span_times, n)); 5715 PetscCall(TSSetTime(ts, ts->tspan->span_times[0])); 5716 PetscCall(TSSetMaxTime(ts, ts->tspan->span_times[n - 1])); 5717 PetscFunctionReturn(PETSC_SUCCESS); 5718 } 5719 5720 /*@C 5721 TSGetTimeSpan - gets the time span set with `TSSetTimeSpan()` 5722 5723 Not Collective 5724 5725 Input Parameter: 5726 . ts - the time-stepper 5727 5728 Output Parameters: 5729 + n - number of the time points (>=2) 5730 - span_times - array of the time points. The first element and the last element are the initial time and the final time respectively. 5731 5732 Level: beginner 5733 5734 Note: 5735 The values obtained are valid until the `TS` object is destroyed. 5736 5737 Both `n` and `span_times` can be `NULL`. 5738 5739 .seealso: [](ch_ts), `TS`, `TSSetTimeSpan()`, `TSGetTimeSpanSolutions()` 5740 @*/ 5741 PetscErrorCode TSGetTimeSpan(TS ts, PetscInt *n, const PetscReal **span_times) 5742 { 5743 PetscFunctionBegin; 5744 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5745 if (n) PetscAssertPointer(n, 2); 5746 if (span_times) PetscAssertPointer(span_times, 3); 5747 if (!ts->tspan) { 5748 if (n) *n = 0; 5749 if (span_times) *span_times = NULL; 5750 } else { 5751 if (n) *n = ts->tspan->num_span_times; 5752 if (span_times) *span_times = ts->tspan->span_times; 5753 } 5754 PetscFunctionReturn(PETSC_SUCCESS); 5755 } 5756 5757 /*@ 5758 TSGetTimeSpanSolutions - Get the number of solutions and the solutions at the time points specified by the time span. 5759 5760 Input Parameter: 5761 . ts - the `TS` context obtained from `TSCreate()` 5762 5763 Output Parameters: 5764 + nsol - the number of solutions 5765 - Sols - the solution vectors 5766 5767 Level: intermediate 5768 5769 Notes: 5770 Both `nsol` and `Sols` can be `NULL`. 5771 5772 Some time points in the time span may be skipped by `TS` so that `nsol` is less than the number of points specified by `TSSetTimeSpan()`. 5773 For example, manipulating the step size, especially with a reduced precision, may cause `TS` to step over certain points in the span. 5774 5775 .seealso: [](ch_ts), `TS`, `TSSetTimeSpan()` 5776 @*/ 5777 PetscErrorCode TSGetTimeSpanSolutions(TS ts, PetscInt *nsol, Vec **Sols) 5778 { 5779 PetscFunctionBegin; 5780 PetscValidHeaderSpecific(ts, TS_CLASSID, 1); 5781 if (nsol) PetscAssertPointer(nsol, 2); 5782 if (Sols) PetscAssertPointer(Sols, 3); 5783 if (!ts->tspan) { 5784 if (nsol) *nsol = 0; 5785 if (Sols) *Sols = NULL; 5786 } else { 5787 if (nsol) *nsol = ts->tspan->spanctr; 5788 if (Sols) *Sols = ts->tspan->vecs_sol; 5789 } 5790 PetscFunctionReturn(PETSC_SUCCESS); 5791 } 5792 5793 /*@C 5794 TSPruneIJacobianColor - Remove nondiagonal zeros in the Jacobian matrix and update the `MatMFFD` coloring information. 5795 5796 Collective 5797 5798 Input Parameters: 5799 + ts - the `TS` context 5800 . J - Jacobian matrix (not altered in this routine) 5801 - B - newly computed Jacobian matrix to use with preconditioner 5802 5803 Level: intermediate 5804 5805 Notes: 5806 This function improves the `MatFDColoring` performance when the Jacobian matrix was over-allocated or contains 5807 many constant zeros entries, which is typically the case when the matrix is generated by a `DM` 5808 and multiple fields are involved. 5809 5810 Users need to make sure that the Jacobian matrix is properly filled to reflect the sparsity 5811 structure. For `MatFDColoring`, the values of nonzero entries are not important. So one can 5812 usually call `TSComputeIJacobian()` with randomized input vectors to generate a dummy Jacobian. 5813 `TSComputeIJacobian()` should be called before `TSSolve()` but after `TSSetUp()`. 5814 5815 .seealso: [](ch_ts), `TS`, `MatFDColoring`, `TSComputeIJacobianDefaultColor()`, `MatEliminateZeros()`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()` 5816 @*/ 5817 PetscErrorCode TSPruneIJacobianColor(TS ts, Mat J, Mat B) 5818 { 5819 MatColoring mc = NULL; 5820 ISColoring iscoloring = NULL; 5821 MatFDColoring matfdcoloring = NULL; 5822 5823 PetscFunctionBegin; 5824 /* Generate new coloring after eliminating zeros in the matrix */ 5825 PetscCall(MatEliminateZeros(B, PETSC_TRUE)); 5826 PetscCall(MatColoringCreate(B, &mc)); 5827 PetscCall(MatColoringSetDistance(mc, 2)); 5828 PetscCall(MatColoringSetType(mc, MATCOLORINGSL)); 5829 PetscCall(MatColoringSetFromOptions(mc)); 5830 PetscCall(MatColoringApply(mc, &iscoloring)); 5831 PetscCall(MatColoringDestroy(&mc)); 5832 /* Replace the old coloring with the new one */ 5833 PetscCall(MatFDColoringCreate(B, iscoloring, &matfdcoloring)); 5834 PetscCall(MatFDColoringSetFunction(matfdcoloring, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts)); 5835 PetscCall(MatFDColoringSetFromOptions(matfdcoloring)); 5836 PetscCall(MatFDColoringSetUp(B, iscoloring, matfdcoloring)); 5837 PetscCall(PetscObjectCompose((PetscObject)B, "TSMatFDColoring", (PetscObject)matfdcoloring)); 5838 PetscCall(PetscObjectDereference((PetscObject)matfdcoloring)); 5839 PetscCall(ISColoringDestroy(&iscoloring)); 5840 PetscFunctionReturn(PETSC_SUCCESS); 5841 } 5842